facebook4j.api
Interface CheckinMethods

All Known Subinterfaces:

Facebook

All Known Implementing Classes:

FacebookImpl

public interface CheckinMethods

Author:

Ryuji Yamashita - roundrop at gmail.com

Method Summary

java.lang.String	checkin(CheckinUpdate checkinUpdate) Deprecated. creating a Post with a location attached
java.lang.String	checkin(java.lang.String userId, CheckinUpdate checkinUpdate) Deprecated. creating a Post with a location attached
java.lang.String	commentCheckin(java.lang.String checkinId, java.lang.String message) Comments on a checkin.
Checkin	getCheckin(java.lang.String checkinId) Returns a single checkin information.
Checkin	getCheckin(java.lang.String checkinId, Reading reading) Returns a single checkin information.
ResponseList<Comment>	getCheckinComments(java.lang.String checkinId) Returns the comments on a checkin.
ResponseList<Comment>	getCheckinComments(java.lang.String checkinId, Reading reading) Returns the comments on a checkin.
ResponseList<Like>	getCheckinLikes(java.lang.String checkinId) Returns the users who like a checkin.
ResponseList<Like>	getCheckinLikes(java.lang.String checkinId, Reading reading) Returns the users who like a checkin.
ResponseList<Checkin>	getCheckins() Returns the places that the current user has checked-into or made to the Place Page by the current user or friends of the current user.
ResponseList<Checkin>	getCheckins(Reading reading) Returns the places that the current user has checked-into or made to the Place Page by the current user or friends of the current user.
ResponseList<Checkin>	getCheckins(java.lang.String id) Returns the places that a user has checked-into or made to the Place Page by the user or friends of the user.
ResponseList<Checkin>	getCheckins(java.lang.String id, Reading reading) Returns the places that a user has checked-into or made to the Place Page by the user or friends of the user.
boolean	likeCheckin(java.lang.String checkinId) Likes the checkin.
boolean	unlikeCheckin(java.lang.String checkinId) Unlikes the checkin.

Method Detail

getCheckins

ResponseList<Checkin> getCheckins()
                                  throws FacebookException

Returns the places that the current user has checked-into or made to the Place Page by the current user or friends of the current user.

Returns:

checkins

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#checkins - Facebook Developers, Page - Facebook Developers

getCheckins

ResponseList<Checkin> getCheckins(Reading reading)
                                  throws FacebookException

Returns the places that the current user has checked-into or made to the Place Page by the current user or friends of the current user.

Parameters:

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Returns:

checkins

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#checkins - Facebook Developers, Page - Facebook Developers

getCheckins

ResponseList<Checkin> getCheckins(java.lang.String id)
                                  throws FacebookException

Returns the places that a user has checked-into or made to the Place Page by the user or friends of the user.

Parameters:

id - the ID of a user/page

Returns:

checkins

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#checkins - Facebook Developers, Page - Facebook Developers

getCheckins

ResponseList<Checkin> getCheckins(java.lang.String id,
                                  Reading reading)
                                  throws FacebookException

Returns the places that a user has checked-into or made to the Place Page by the user or friends of the user.

Parameters:

id - the ID of a user/page

reading - optional reading parameters. see Graph API#reading - Facebook Developers

Returns:

checkins

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#checkins - Facebook Developers, Page - Facebook Developers

checkin

java.lang.String checkin(CheckinUpdate checkinUpdate)
                         throws FacebookException

Deprecated. creating a Post with a location attached

Checkins the place as the current user.

Parameters:

checkinUpdate - the checkin to be created

Returns:

The new checkin ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#checkins - Facebook Developers

checkin

java.lang.String checkin(java.lang.String userId,
                         CheckinUpdate checkinUpdate)
                         throws FacebookException

Deprecated. creating a Post with a location attached

Checkins the place as a user.

Parameters:

userId - the ID of a user

checkinUpdate - the checkin to be created

Returns:

The new checkin ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

User#checkins - Facebook Developers

getCheckin

Checkin getCheckin(java.lang.String checkinId)
                   throws FacebookException

Returns a single checkin information.

Parameters:

checkinId - the ID of a checkin

Returns:

checkin

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Checkin - Facebook Developers

getCheckin

Checkin getCheckin(java.lang.String checkinId,
                   Reading reading)
                   throws FacebookException

Returns a single checkin information.

Parameters:

checkinId - the ID of a checkin

reading - optional reading parameters. see Graph API#reading - Facebook Developers see Graph API#reading - Facebook Developers

Returns:

checkin

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Checkin - Facebook Developers

getCheckinComments

ResponseList<Comment> getCheckinComments(java.lang.String checkinId)
                                         throws FacebookException

Returns the comments on a checkin.

Parameters:

checkinId - the ID of a checkin

Returns:

comments

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Checkin#comments - Facebook Developers

getCheckinComments

ResponseList<Comment> getCheckinComments(java.lang.String checkinId,
                                         Reading reading)
                                         throws FacebookException

Returns the comments on a checkin.

Parameters:

checkinId - the ID of a checkin

reading - optional reading parameters. see Graph API#reading - Facebook Developers see Graph API#reading - Facebook Developers

Returns:

comments

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Checkin#comments - Facebook Developers

commentCheckin

java.lang.String commentCheckin(java.lang.String checkinId,
                                java.lang.String message)
                                throws FacebookException

Comments on a checkin.

Parameters:

checkinId - the ID of a checkin

message - comment text

Returns:

The new comment ID

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Checkin#comments - Facebook Developers

getCheckinLikes

ResponseList<Like> getCheckinLikes(java.lang.String checkinId)
                                   throws FacebookException

Returns the users who like a checkin.

Parameters:

checkinId - the ID of a checkin

Returns:

likes

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Checkin#likes - Facebook Developers

getCheckinLikes

ResponseList<Like> getCheckinLikes(java.lang.String checkinId,
                                   Reading reading)
                                   throws FacebookException

Returns the users who like a checkin.

Parameters:

checkinId - the ID of a checkin

reading - optional reading parameters. see Graph API#reading - Facebook Developers see Graph API#reading - Facebook Developers

Returns:

likes

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Checkin#likes - Facebook Developers

likeCheckin

boolean likeCheckin(java.lang.String checkinId)
                    throws FacebookException

Likes the checkin.

Parameters:

checkinId - the ID of a checkin

Returns:

true if like is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Checkin#likes - Facebook Developers

unlikeCheckin

boolean unlikeCheckin(java.lang.String checkinId)
                      throws FacebookException

Unlikes the checkin.

Parameters:

checkinId - the ID of a checkin

Returns:

true if unlike is successful

Throws:

FacebookException - when Facebook service or network is unavailable

See Also:

Checkin#likes - Facebook Developers