JFacebookGroup
Extends \JFacebookObjectFacebook API Group class for the Joomla Platform.
link | |
---|---|
since |
3.2.0 |
deprecated |
4.0 Use the |
package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JHttp $client = null, \JFacebookOAuth $oauth = null)
since |
3.2.0 |
---|
Arguments
- $options
\Joomla\Registry\Registry
Facebook options object.- $client
\JHttp
The HTTP client object.- $oauth
\JFacebookOAuth
The OAuth client.
createConnection
Method to create a connection.
createConnection(string $object, string $connection = null, array $parameters = null, array $headers = null) : mixed
since |
3.2.0 |
---|
Arguments
- $object
string
The object id.- $connection
string
The object's connection name.- $parameters
array
The POST request parameters.- $headers
array
An array of name-value pairs to include in the header of the request
Response
mixed
The decoded JSON response or false if the client is not authenticated.
createLink
Method to post a link on group's wall. Requires authentication and publish_stream permission.
createLink(string $group, string $link, string $message = null) : mixed
since |
3.2.0 |
---|
Arguments
- $group
string
The group id.- $link
string
Link URL.- $message
string
Link message.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
createPost
Method to post on group's wall. Message or link parameter is required. Requires authentication and publish_stream permission.
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
since |
3.2.0 |
---|
Arguments
- $group
string
The group id.- $message
string
Post message.- $link
string
Post URL.- $picture
string
Post thumbnail image (can only be used if link is specified)- $name
string
Post name (can only be used if link is specified).- $caption
string
Post caption (can only be used if link is specified).- $description
string
Post description (can only be used if link is specified).- $actions
array
Post actions array of objects containing name and link.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
createStatus
Method to post a status message on behalf of the user on the group's wall. Requires authentication and publish_stream permission.
createStatus(string $group, string $message) : mixed
since |
3.2.0 |
---|
Arguments
- $group
string
The group id.- $message
string
Status message content.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
deleteConnection
Method to delete a connection.
deleteConnection(string $object, string $connection = null, string $extraFields = '') : mixed
since |
3.2.0 |
---|
Arguments
- $object
string
The object id.- $connection
string
The object's connection name.- $extraFields
string
URL fields.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
deleteLink
Method to delete a link. Requires authentication.
deleteLink(mixed $link) : boolean
since |
3.2.0 |
---|
Arguments
- $link
mixed
The Link ID.
Response
boolean
Returns true if successful, and false otherwise.
deletePost
Method to delete a post. Note: you can only delete the post if it was created by the current user. Requires authentication.
deletePost(string $post) : boolean
since |
3.2.0 |
---|
Arguments
- $post
string
The Post ID.
Response
boolean
Returns true if successful, and false otherwise.
deleteStatus
Method to delete a status. Note: you can only delete the status if it was created by the current user. Requires authentication.
deleteStatus(string $status) : boolean
since |
3.2.0 |
---|
Arguments
- $status
string
The Status ID.
Response
boolean
Returns true if successful, and false otherwise.
fetchUrl
Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.
fetchUrl(string $path, integer $limit, integer $offset, integer $until = null, integer $since = null) : string
since |
3.2.0 |
---|
Arguments
- $path
string
URL to inflect.- $limit
integer
The number of objects per page.- $offset
integer
The object's number on the page.- $until
integer
A unix timestamp or any date accepted by strtotime.- $since
integer
A unix timestamp or any date accepted by strtotime.
Response
string
The request URL.
get
Method to get an object.
get(string $object) : mixed
since |
3.2.0 |
---|
Arguments
- $object
string
The object id.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
getConnection
Method to get object's connection.
getConnection(string $object, string $connection = null, string $extraFields = '', integer $limit, integer $offset, string $until = null, string $since = null) : mixed
since |
3.2.0 |
---|
Arguments
- $object
string
The object id.- $connection
string
The object's connection name.- $extraFields
string
URL fields.- $limit
integer
The number of objects per page.- $offset
integer
The object's number on the page.- $until
string
A unix timestamp or any date accepted by strtotime.- $since
string
A unix timestamp or any date accepted by strtotime.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
getDocs
Method to get the group's docs. Requires authentication and user_groups or friends_groups permission for non-public groups.
getDocs(string $group, integer $limit, integer $offset, string $until = null, string $since = null) : mixed
since |
3.2.0 |
---|
Arguments
- $group
string
The group id.- $limit
integer
The number of objects per page.- $offset
integer
The object's number on the page.- $until
string
A unix timestamp or any date accepted by strtotime.- $since
string
A unix timestamp or any date accepted by strtotime.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
getFeed
Method to get the group's wall. Requires authentication and user_groups or friends_groups permission for non-public groups.
getFeed(string $group, integer $limit, integer $offset, string $until = null, string $since = null) : mixed
since |
3.2.0 |
---|
Arguments
- $group
string
The group id.- $limit
integer
The number of objects per page.- $offset
integer
The object's number on the page.- $until
string
A unix timestamp or any date accepted by strtotime.- $since
string
A unix timestamp or any date accepted by strtotime.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
getGroup
Method to read a group. Requires authentication and user_groups or friends_groups permission for non-public groups.
getGroup(string $group) : mixed
since |
3.2.0 |
---|
Arguments
- $group
string
The group id.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
getMembers
Method to get the group's members. Requires authentication and user_groups or friends_groups permission for non-public groups.
getMembers(string $group, integer $limit, integer $offset) : mixed
since |
3.2.0 |
---|
Arguments
- $group
string
The group id.- $limit
integer
The number of objects per page.- $offset
integer
The object's number on the page.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
getOAuth
Method used to get the OAuth client.
getOAuth() : \JFacebookOAuth
getPicture
Method to get the groups's picture. Requires authentication and user_groups or friends_groups permission.
getPicture(string $group, string $type = null) : string
since |
3.2.0 |
---|
Arguments
- $group
string
The group id.- $type
string
To request a different photo use square | small | normal | large.
Response
string
The URL to the group's picture.
sendRequest
Method to send the request.
sendRequest(string $path, mixed $data = '', array $headers = null, integer $limit, integer $offset, string $until = null, string $since = null) : mixed
since |
3.2.0 |
---|---|
throws |
|
Arguments
- $path
string
The path of the request to make.- $data
mixed
Either an associative array or a string to be sent with the post request.- $headers
array
An array of name-value pairs to include in the header of the request- $limit
integer
The number of objects per page.- $offset
integer
The object's number on the page.- $until
string
A unix timestamp or any date accepted by strtotime.- $since
string
A unix timestamp or any date accepted by strtotime.
Response
mixed
The request response.
setOAuth
Method used to set the OAuth client.
setOAuth(\JFacebookOAuth $oauth) : \JFacebookObject
since |
3.2.0 |
---|
Arguments
- $oauth
\JFacebookOAuth
The OAuth client object.
Response
\JFacebookObject
This object for method chaining.
Properties
client
The HTTP client object to use in sending HTTP requests.
since |
3.2.0 |
---|
Type(s)
\JHttp