class JFacebookNote extends JFacebookObject

Facebook API Note class for the Joomla Platform.

Methods

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

Constructor.

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

Method to send the request.

mixed
get( string $object)

Method to get an object.

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.

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

Method to create a connection.

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

Method to delete a connection.

setOAuth( JFacebookOAuth $oauth)

Method used to set the OAuth client.

getOAuth()

Method used to get the OAuth client.

mixed
getNote( string $note)

Method to get a note. Requires authentication and usernotes or friendsnotes permission for non-public notes.

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

Method to get a note's comments. Requires authentication and usernotes or friendsnotes permission for non-public notes.

mixed
createComment( string $note, string $message)

Method to comment on a note. Requires authentication and publishstream and usernotes or friends_notes permissions.

boolean
deleteComment( string $comment)

Method to delete a comment. Requires authentication and publishstream and usernotes or friends_notes permissions.

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

Method to get note's likes. Requires authentication and usernotes or friendsnotes for non-public notes.

boolean
createLike( string $note)

Method to like a note. Requires authentication and publishstream and usernotes or friends_notes permissions.

boolean
deleteLike( string $note)

Method to unlike a note. Requires authentication and publishstream and usernotes or friends_notes permissions.

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 getNote( string $note)

Method to get a note. Requires authentication and usernotes or friendsnotes permission for non-public notes.

Parameters

string $note The note id.

Return Value

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

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

Method to get a note's comments. Requires authentication and usernotes or friendsnotes permission for non-public notes.

Parameters

string $note The note 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 $note, string $message)

Method to comment on a note. Requires authentication and publishstream and usernotes or friends_notes permissions.

Parameters

string $note The note id.
string $message The comment's text.

Return Value

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

boolean deleteComment( string $comment)

Method to delete a comment. Requires authentication and publishstream and usernotes or friends_notes permissions.

Parameters

string $comment The comment's id.

Return Value

boolean Returns true if successful, and false otherwise.

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

Method to get note's likes. Requires authentication and usernotes or friendsnotes for non-public notes.

Parameters

string $note The note 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.

boolean createLike( string $note)

Method to like a note. Requires authentication and publishstream and usernotes or friends_notes permissions.

Parameters

string $note The note id.

Return Value

boolean Returns true if successful, and false otherwise.

boolean deleteLike( string $note)

Method to unlike a note. Requires authentication and publishstream and usernotes or friends_notes permissions.

Parameters

string $note The note id.

Return Value

boolean Returns true if successful, and false otherwise.