facebook4j.api.MessageMethods Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of facebook4j-core Show documentation
A Java library for the Facebook Graph API
The newest version!
/*
 * Copyright 2012 Ryuji Yamashita
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package facebook4j.api;

import facebook4j.FacebookException;
import facebook4j.InboxResponseList;
import facebook4j.Message;
import facebook4j.Reading;
import facebook4j.ResponseList;

public interface MessageMethods {
    /**
     * Returns the messages in the current user's inbox.
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - inbox
     */
    InboxResponseList getInbox() throws FacebookException;

    /**
     * Returns the messages in the current user's inbox.
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - inbox
     */
    InboxResponseList getInbox(Reading reading) throws FacebookException;

    /**
     * Returns the messages in a user's inbox.
     * @param userId the ID of a user
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - inbox
     */
    InboxResponseList getInbox(String userId) throws FacebookException;

    /**
     * Returns the messages in a user's inbox.
     * @param userId the ID of a user
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - inbox
     */
    InboxResponseList getInbox(String userId, Reading reading) throws FacebookException;


    /**
     * Returns the messages in the current user's outbox.
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - outbox
     */
    ResponseList getOutbox() throws FacebookException;

    /**
     * Returns the messages in the current user's outbox.
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - outbox
     */
    ResponseList getOutbox(Reading reading) throws FacebookException;

    /**
     * Returns the messages in a user's outbox.
     * @param userId the ID of a user
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - outbox
     */
    ResponseList getOutbox(String userId) throws FacebookException;

    /**
     * Returns the messages in a user's outbox.
     * @param userId the ID of a user
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - outbox
     */
    ResponseList getOutbox(String userId, Reading reading) throws FacebookException;


    /**
     * Returns the updates in the current user's inbox.
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - updates
     */
    ResponseList getUpdates() throws FacebookException;

    /**
     * Returns the updates in the current user's inbox.
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - updates
     */
    ResponseList getUpdates(Reading reading) throws FacebookException;

    /**
     * Returns the updates in a user's inbox.
     * @param userId the ID of a user
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - updates
     */
    ResponseList getUpdates(String userId) throws FacebookException;

    /**
     * Returns the updates in a user's inbox.
     * @param userId the ID of a user
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers
     * @return messages
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User - Facebook Developers - Connections - updates
     */
    ResponseList getUpdates(String userId, Reading reading) throws FacebookException;


    /**
     * Returns a single message.
     * @param messageId the ID of the message
     * @return message
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Message - Facebook Developers
     */
    Message getMessage(String messageId) throws FacebookException;

    /**
     * Returns a single message.
     * @param messageId the ID of the message
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers
     * @return message
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Message - Facebook Developers
     */
    Message getMessage(String messageId, Reading reading) throws FacebookException;
    
}