Class JFacebookGroup
Facebook API Group class for the Joomla Platform.
-
JFacebookObject
-
JFacebookGroup
Methods summary
public
mixed
|
#
getGroup( string $group )
Method to read a group. Requires authentication and user_groups or
friends_groups permission for non-public groups.
Method to read a group. Requires authentication and user_groups or
friends_groups permission for non-public groups.
Parameters
- $group
string - $group The group id. Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getFeed( string $group, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the group's wall. Requires authentication and user_groups or
friends_groups permission for non-public groups.
Method to get the group's wall. Requires authentication and user_groups or
friends_groups permission for non-public groups.
Parameters
- $group
string - $group The group id.- $limit
integer - $limit The number of objects per page.- $offset
integer - $offset The object's number on the page.- $until
string - $until A unix timestamp or any date accepted by strtotime.- $since
string - $since A unix timestamp or any date accepted by strtotime. Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getMembers( string $group, integer $limit = 0, integer $offset = 0 )
Method to get the group's members. Requires authentication and user_groups or
friends_groups permission for non-public groups.
Method to get the group's members. Requires authentication and user_groups or
friends_groups permission for non-public groups.
Parameters
- $group
string - $group The group id.- $limit
integer - $limit The number of objects per page.- $offset
integer - $offset The object's number on the page. Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getDocs( string $group, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the group's docs. Requires authentication and user_groups or
friends_groups permission for non-public groups.
Method to get the group's docs. Requires authentication and user_groups or
friends_groups permission for non-public groups.
Parameters
- $group
string - $group The group id.- $limit
integer - $limit The number of objects per page.- $offset
integer - $offset The object's number on the page.- $until
string - $until A unix timestamp or any date accepted by strtotime.- $since
string - $since A unix timestamp or any date accepted by strtotime. Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
string
|
#
getPicture( string $group, string $type = null )
Method to get the groups's picture. Requires authentication and user_groups
or friends_groups permission.
Method to get the groups's picture. Requires authentication and user_groups
or friends_groups permission.
Parameters
- $group
string - $group The group id.- $type
string - $type To request a different photo use square | small | normal | large. Returns
string - The URL to the group's picture.
Since
13.1
|
public
mixed
|
#
createLink( string $group, string $link, strin $message = null )
Method to post a link on group's wall. Requires authentication and
publish_stream permission.
Method to post a link on group's wall. Requires authentication and
publish_stream permission.
Parameters
- $group
string - $group The group id.- $link
string - $link Link URL.- $message
strin - $message Link message. Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
boolean
|
#
deleteLink( mixed $link )
Method to delete a link. Requires authentication.
Method to delete a link. Requires authentication.
Parameters
- $link
mixed - $link The Link ID. Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
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 )
Method to post on group's wall. Message or link parameter is required.
Requires authentication and publish_stream permission.
Method to post on group's wall. Message or link parameter is required.
Requires authentication and publish_stream permission.
Parameters
- $group
string - $group The group id.- $message
string - $message Post message.- $link
string - $link Post URL.- $picture
string - $picture Post thumbnail image (can only be used if link is specified)- $name
string - $name Post name (can only be used if link is specified).- $caption
string - $caption Post caption (can only be used if link is specified).- $description
string - $description Post description (can only be used if link is specified).- $actions
array - $actions Post actions array of objects containing name and link. Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
boolean
|
#
deletePost( string $post )
Method to delete a post. Note: you can only delete the post if it was created
by the current user. Requires authentication.
Method to delete a post. Note: you can only delete the post if it was created
by the current user. Requires authentication.
Parameters
- $post
string - $post The Post ID. Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
mixed
|
#
createStatus( string $group, string $message )
Method to post a status message on behalf of the user on the group's wall.
Requires authentication and publish_stream permission.
Method to post a status message on behalf of the user on the group's wall.
Requires authentication and publish_stream permission.
Parameters
- $group
string - $group The group id.- $message
string - $message Status message content. Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
boolean
|
#
deleteStatus( string $status )
Method to delete a status. Note: you can only delete the status if it was
created by the current user. Requires authentication.
Method to delete a status. Note: you can only delete the status if it was
created by the current user. Requires authentication.
Parameters
- $status
string - $status The Status ID. Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
__construct(),
createConnection(),
deleteConnection(),
fetchUrl(),
get(),
getConnection(),
getOAuth(),
sendRequest(),
setOAuth()
Magic methods summary
Properties summary
$client,
$oauth,
$options
