JFacebookCheckin

class JFacebookCheckin extends JFacebookObject

Facebook API Checkin class for the Joomla Platform.

Methods

__construct( Registry $options = null, JHttp $client = null, JFacebookOAuth $oauth = null)

Constructor.

from JFacebookObject
mixed
sendRequest( string $path, mixed $data = '', array $headers = null, integer $limit, integer $offset, string $until = null, string $since = null)

Method to send the request.

from JFacebookObject
mixed
get( string $object)

Method to get an object.

from JFacebookObject
mixed
getConnection( string $object, string $connection = null, string $extra_fields = '', integer $limit, integer $offset, string $until = null, string $since = null)

Method to get object's connection.

from JFacebookObject
mixed
createConnection( string $object, string $connection = null, array $parameters = null, array $headers = null)

Method to create a connection.

from JFacebookObject
mixed
deleteConnection( string $object, string $connection = null, string $extra_fields = '')

Method to delete a connection.

from JFacebookObject
JFacebookObject
setOAuth( JFacebookOAuth $oauth)

Method used to set the OAuth client.

from JFacebookObject
JFacebookOAuth
getOAuth()

Method used to get the OAuth client.

from JFacebookObject
mixed
getCheckin( string $checkin)

Method to get a checkin. Requires authentication and usercheckins or friendscheckins permission.

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

Method to get a checkin's comments. Requires authentication and usercheckins or friendscheckins permission.

mixed
createComment( string $checkin, string $message)

Method to post a comment to the checkin. Requires authentication and publishstream and usercheckins or friends_checkins permission.

mixed
deleteComment( string $comment)

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

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

Method to get a checkin's likes. Requires authentication and usercheckins or friendscheckins permission.

mixed
createLike( string $checkin)

Method to like a checkin. Requires authentication and publishstream and usercheckins or friends_checkins permission.

mixed
deleteLike( string $checkin)

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

Details

__construct( Registry $options = null, JHttp $client = null, JFacebookOAuth $oauth = null)

Constructor.

Parameters

Registry $options Facebook options object.
JHttp $client The HTTP client object.
JFacebookOAuth $oauth The OAuth client.

mixed sendRequest( string $path, mixed $data = '', array $headers = null, integer $limit, integer $offset, string $until = null, string $since = null)

Method to send the request.

Parameters

string $path The path of the request to make.
mixed $data Either an associative array or a string to be sent with the post request.
array $headers An array of name-value pairs to include in the header of the request
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.

Return Value

mixed The request response.

Exceptions

DomainException

mixed get( string $object)

Method to get an object.

Parameters

string $object The object id.

Return Value

mixed The decoded JSON response or false if the client is not authenticated.

mixed getConnection( string $object, string $connection = null, string $extra_fields = '', integer $limit, integer $offset, string $until = null, string $since = null)

Method to get object's connection.

Parameters

string $object The object id.
string $connection The object's connection name.
string $extra_fields URL fields.
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.

Return Value

mixed The decoded JSON response or false if the client is not authenticated.

mixed createConnection( string $object, string $connection = null, array $parameters = null, array $headers = null)

Method to create a connection.

Parameters

string $object The object id.
string $connection The object's connection name.
array $parameters The POST request parameters.
array $headers An array of name-value pairs to include in the header of the request

Return Value

mixed The decoded JSON response or false if the client is not authenticated.

mixed deleteConnection( string $object, string $connection = null, string $extra_fields = '')

Method to delete a connection.

Parameters

string $object The object id.
string $connection The object's connection name.
string $extra_fields URL fields.

Return Value

mixed The decoded JSON response or false if the client is not authenticated.

JFacebookObject setOAuth( JFacebookOAuth $oauth)

Method used to set the OAuth client.

Parameters

JFacebookOAuth $oauth The OAuth client object.

Return Value

JFacebookObject This object for method chaining.

JFacebookOAuth getOAuth()

Method used to get the OAuth client.

Return Value

JFacebookOAuth The OAuth client

mixed getCheckin( string $checkin)

Method to get a checkin. Requires authentication and usercheckins or friendscheckins permission.

Parameters

string $checkin The checkin id.

Return Value

mixed The decoded JSON response or false if the client is not authenticated.

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

Method to get a checkin's comments. Requires authentication and usercheckins or friendscheckins permission.

Parameters

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.

Return Value

mixed The decoded JSON response or false if the client is not authenticated.

mixed createComment( string $checkin, string $message)

Method to post a comment to the checkin. Requires authentication and publishstream and usercheckins or friends_checkins permission.

Parameters

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

Return Value

mixed The decoded JSON response or false if the client is not authenticated.

mixed deleteComment( string $comment)

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

Parameters

string $comment The comment's id.

Return Value

mixed The decoded JSON response or false if the client is not authenticated.

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

Method to get a checkin's likes. Requires authentication and usercheckins or friendscheckins permission.

Parameters

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.

Return Value

mixed The decoded JSON response or false if the client is not authenticated.

mixed createLike( string $checkin)

Method to like a checkin. Requires authentication and publishstream and usercheckins or friends_checkins permission.

Parameters

string $checkin The checkin id.

Return Value

mixed The decoded JSON response or false if the client is not authenticated.

mixed deleteLike( string $checkin)

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

Parameters

string $checkin The checkin id.

Return Value

mixed The decoded JSON response or false if the client is not authenticated.