Class JFacebookNote

Description

Facebook API Note class for the Joomla Platform.

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

JFacebookObject
   |
   --JFacebookNote
Method Summary
 mixed createComment (string $note, string $message)
 boolean createLike (string $note)
 boolean deleteComment (string $comment)
 boolean deleteLike (string $note)
 mixed getComments (string $note, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
 mixed getLikes (string $note, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
 mixed getNote (string $note)
Variables
Methods
createComment (line 67)

Method to comment on a note. Requires authentication and publish_stream and user_notes or friends_notes permissions.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createComment (string $note, string $message)
  • string $note: The note id.
  • string $message: The comment's text.
createLike (line 117)

Method to like a note. Requires authentication and publish_stream and user_notes or friends_notes permissions.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean createLike (string $note)
  • string $note: The note id.
deleteComment (line 85)

Method to delete a comment. Requires authentication and publish_stream and user_notes or friends_notes permissions.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteComment (string $comment)
  • string $comment: The comment's id.
deleteLike (line 131)

Method to unlike a note. Requires authentication and publish_stream and user_notes or friends_notes permissions.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteLike (string $note)
  • string $note: The note id.
getComments (line 52)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getComments (string $note, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getLikes (line 103)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getLikes (string $note, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getNote (line 34)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getNote (string $note)
  • string $note: The note id.

Inherited Methods

Inherited From JFacebookObject

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

Documentation generated on Tue, 19 Nov 2013 15:09:35 +0100 by phpDocumentor 1.4.3