Class JFacebookPost

Description

Facebook API Post class for the Joomla Platform.

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

JFacebookObject
   |
   --JFacebookPost
Method Summary
 mixed createComment (string $post, string $message)
 boolean createLike (string $post)
 boolean deleteComment (string $comment)
 boolean deleteLike (string $post)
 boolean deletePost (string $post)
 mixed getComments (string $post, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
 mixed getLikes (string $post, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
 mixed getPost (string $post)
Variables
Methods
createComment (line 81)

Method to comment on a post. 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 createComment (string $post, string $message)
  • string $post: The post id.
  • string $message: The comment's text.
createLike (line 130)

Method to like a post. Requires authentication and publish_stream permission

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

Method to delete a comment. Requires authentication and publish_stream permission

  • 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 144)

Method to unlike a post. Requires authentication and publish_stream permission

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

Method to delete a post if it was created by this application. Requires authentication and publish_stream permission

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

Method to get a post's comments. Requires authentication and read_stream permission.

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

Method to get post's likes. Requires authentication and read_stream permission.

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

Method to get a post. Requires authentication and read_stream permission for all data.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getPost (string $post)
  • string $post: The post 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:11:00 +0100 by phpDocumentor 1.4.3