Docs For Class JFacebookCheckin

Description

Facebook API Checkin class for the Joomla Platform.

see: http://developers.facebook.com/docs/reference/api/checkin/
since: 13.1

Located in /libraries/joomla/facebook/checkin.php (line 23)

JFacebookObject
   |
   --JFacebookCheckin

Method Summary

mixed createComment (string $checkin, string $message)

mixed createLike (string $checkin)

mixed deleteComment (string $comment)

mixed deleteLike (string $checkin)

mixed getCheckin (string $checkin)

mixed getComments (string $checkin, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

mixed getLikes (string $checkin, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

Variables

Inherited Variables

Inherited from JFacebookObject

JFacebookObject::$client
JFacebookObject::$oauth
JFacebookObject::$options

Methods

createComment (line 67)

Method to post a comment to the checkin. Requires authentication and publish_stream and user_checkins or friends_checkins permission.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed createComment (string $checkin, string $message)

string $checkin: The checkin id.
string $message: The checkin's text.

createLike (line 117)

Method to like a checkin. Requires authentication and publish_stream and user_checkins or friends_checkins permission.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed createLike (string $checkin)

string $checkin: The checkin id.

deleteComment (line 85)

Method to delete a comment. Requires authentication and publish_stream permission.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed deleteComment (string $comment)

string $comment: The comment's id.

deleteLike (line 131)

Method to unlike a checkin. Requires authentication and publish_stream permission.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed deleteLike (string $checkin)

string $checkin: The checkin id.

getCheckin (line 34)

Method to get a checkin. Requires authentication and user_checkins or friends_checkins permission.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed getCheckin (string $checkin)

string $checkin: The checkin id.

getComments (line 52)

Method to get a checkin's comments. Requires authentication and user_checkins or friends_checkins permission.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed getComments (string $checkin, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

string $checkin: The checkin id.
integer $limit: The number of objects per page.
integer $offset: The object's number on the page.
string $until: A unix timestamp or any date accepted by strtotime.
string $since: A unix timestamp or any date accepted by strtotime.

getLikes (line 103)

Method to get a checkin's likes. Requires authentication and user_checkins or friends_checkins permission.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed getLikes (string $checkin, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

string $checkin: The checkin id.
integer $limit: The number of objects per page.
integer $offset: The object's number on the page.
string $until: A unix timestamp or any date accepted by strtotime.
string $since: A unix timestamp or any date accepted by strtotime.

Inherited Methods

Inherited From JFacebookObject

JFacebookObject::__construct()
JFacebookObject::createConnection()
JFacebookObject::deleteConnection()
JFacebookObject::fetchUrl()
JFacebookObject::get()
JFacebookObject::getConnection()
JFacebookObject::getOAuth()
JFacebookObject::sendRequest()
JFacebookObject::setOAuth()