facebook4j.api.LinkMethods Maven / Gradle / Ivy

Go to download
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
There is a newer version: 2.4.13
/*
 * 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.Comment;
import facebook4j.CommentUpdate;
import facebook4j.FacebookException;
import facebook4j.Like;
import facebook4j.Link;
import facebook4j.Reading;
import facebook4j.ResponseList;

public interface LinkMethods {
    /**
     * Returns the current user's/page's/event's posted links.
     * @return links
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User#links - Facebook Developers
     */
    ResponseList getLinks() throws FacebookException;

    /**
     * Returns the current user's/page's/event's posted links.
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers
     * @return links
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User#links - Facebook Developers
     */
    ResponseList getLinks(Reading reading) throws FacebookException;

    /**
     * Returns a user's/page's/event's posted links.
     * @param id the ID of a user/page/event
     * @return links
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User#links - Facebook Developers
     */
    ResponseList getLinks(String id) throws FacebookException;

    /**
     * Returns a user's/page's/event's posted links.
     * @param id the ID of a user/page/event
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers
     * @return links
     * @throws FacebookException when Facebook service or network is unavailable
     * @see User#links - Facebook Developers
     */
    ResponseList getLinks(String id, Reading reading) throws FacebookException;


    /**
     * Returns the link shared on a user's wall.
     * @param linkId the ID of the link
     * @return link
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Link - Facebook Developers
     */
    Link getLink(String linkId) throws FacebookException;

    /**
     * Returns the link shared on a user's wall.
     * @param linkId the ID of the link
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers
     * @return link
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Link - Facebook Developers
     */
    Link getLink(String linkId, Reading reading) throws FacebookException;


    /**
     * Returns all of the comments on a link.
     * @param linkId the ID of a link
     * @return comments
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Link#comments - Facebook Developers
     */
    ResponseList getLinkComments(String linkId) throws FacebookException;

    /**
     * Returns all of the comments on a link.
     * @param linkId the ID of a link
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers
     * @return comments
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Link#comments - Facebook Developers
     */
    ResponseList getLinkComments(String linkId, Reading reading) throws FacebookException;

    /**
     * Comments on the link.
     * @param linkId the ID of the link
     * @param message comment text
     * @return The new comment ID
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Link#comments - Facebook Developers
     */
    String commentLink(String linkId, String message) throws FacebookException;

    /**
     * Comments on the link.
     * @param linkId the ID of the link
     * @param commentUpdate comment content
     * @return The new comment ID
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Link#comments - Facebook Developers
     */
    String commentLink(String linkId, CommentUpdate commentUpdate) throws FacebookException;


    /**
     * Returns the likes on a link.
     * @param linkId the ID of a link
     * @return likes
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Link#likes - Facebook Developers
     */
    ResponseList getLinkLikes(String linkId) throws FacebookException;

    /**
     * Returns the likes on a link.
     * @param linkId the ID of a link
     * @param reading optional reading parameters. see Graph API#reading - Facebook Developers see Graph API#reading - Facebook Developers
     * @return likes
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Link#likes - Facebook Developers
     */
    ResponseList getLinkLikes(String linkId, Reading reading) throws FacebookException;

    /**
     * Likes the link.
     * @param linkId the ID of the link
     * @return true if like is successful
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Link#likes - Facebook Developers
     */
    boolean likeLink(String linkId) throws FacebookException;

    /**
     * Unlikes the link.
     * @param linkId the ID of the link
     * @return true if unlike is successful
     * @throws FacebookException when Facebook service or network is unavailable
     * @see Link#likes - Facebook Developers
     */
    boolean unlikeLink(String linkId) throws FacebookException;

}