Class JFacebookGroup

Description
Description | Vars | Methods (details)

Facebook API Group class for the Joomla Platform.

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

JFacebookObject
   |
   --JFacebookGroup
Method Summary
Description | Vars | Methods (details)
mixed createLink (string $group, string $link, [strin $message = null])
mixed createPost (string $group, [string $message = null], [string $link = null], [string $picture = null], [string $name = null], [string $caption = null], [string $description = null], [array $actions = null])
mixed createStatus (string $group, string $message)
boolean deleteLink (mixed $link)
boolean deletePost (string $post)
boolean deleteStatus (string $status)
mixed getDocs (string $group, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getFeed (string $group, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getGroup (string $group)
mixed getMembers (string $group, [integer $limit = 0], [integer $offset = 0])
string getPicture (string $group, [string $type = null])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JFacebookObject

JFacebookObject::$client
 JFacebookObject::$oauth
 JFacebookObject::$options
Methods
Description | Vars Methods (details)
createLink (line 122)

Method to post a link on group's wall. 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 createLink (string $group, string $link, [strin $message = null])
  • string $group: The group id.
  • string $link: Link URL.
  • strin $message: Link message.
createPost (line 166)

Method to post on group's wall. Message or link parameter is required. 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 createPost (string $group, [string $message = null], [string $link = null], [string $picture = null], [string $name = null], [string $caption = null], [string $description = null], [array $actions = null])
  • string $group: The group id.
  • string $message: Post message.
  • string $link: Post URL.
  • string $picture: Post thumbnail image (can only be used if link is specified)
  • string $name: Post name (can only be used if link is specified).
  • string $caption: Post caption (can only be used if link is specified).
  • string $description: Post description (can only be used if link is specified).
  • array $actions: Post actions array of objects containing name and link.
createStatus (line 232)

Method to post a status message on behalf of the user on the group's wall. 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 createStatus (string $group, string $message)
  • string $group: The group id.
  • string $message: Status message content.
deleteLink (line 145)

Method to delete a link. Requires authentication.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteLink (mixed $link)
  • mixed $link: The Link ID.
deletePost (line 217)

Method to delete a post. Note: you can only delete the post if it was created by the current user. Requires authentication.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deletePost (string $post)
  • string $post: The Post ID.
deleteStatus (line 250)

Method to delete a status. Note: you can only delete the status if it was created by the current user. Requires authentication.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteStatus (string $status)
  • string $status: The Status ID.
getDocs (line 86)

Method to get the group's docs. Requires authentication and user_groups or friends_groups permission for non-public groups.

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

Method to get the group's wall. Requires authentication and user_groups or friends_groups permission for non-public groups.

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

Method to read a group. Requires authentication and user_groups or friends_groups permission for non-public groups.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getGroup (string $group)
  • string $group: The group id.
getMembers (line 68)

Method to get the group's members. Requires authentication and user_groups or friends_groups permission for non-public groups.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getMembers (string $group, [integer $limit = 0], [integer $offset = 0])
  • string $group: The group id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
getPicture (line 101)

Method to get the groups's picture. Requires authentication and user_groups or friends_groups permission.

  • return: The URL to the group's picture.
  • since: 13.1
  • access: public
string getPicture (string $group, [string $type = null])
  • string $group: The group id.
  • string $type: To request a different photo use square | small | normal | large.

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:04:04 +0100 by phpDocumentor 1.4.3