Joomla! API

Download
Launch

JFacebookGroup

Extends \JFacebookObject

Facebook API Group class for the Joomla Platform.

deprecated
link

http://developers.facebook.com/docs/reference/api/group/
since

3.2.0
deprecated

4.0 Use the joomla/facebook package via Composer instead
package

Joomla.Platform

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JHttp $client = null, \JFacebookOAuth $oauth = null)
inherited
since

3.2.0

Arguments

$options

\Joomla\Registry\RegistryFacebook options object.

$client

\JHttpThe HTTP client object.

$oauth

\JFacebookOAuthThe OAuth client.

createConnection

Method to create a connection.

createConnection(string $object, string $connection = null, array $parameters = null, array $headers = null) : mixed
inherited
since

3.2.0

Arguments

$object

stringThe object id.

$connection

stringThe object's connection name.

$parameters

arrayThe POST request parameters.

$headers

arrayAn array of name-value pairs to include in the header of the request

Response

mixedThe 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

stringThe group id.

$link

stringLink URL.

$message

stringLink message.

Response

mixedThe 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

stringThe group id.

$message

stringPost message.

$link

stringPost URL.

$picture

stringPost thumbnail image (can only be used if link is specified)

$name

stringPost name (can only be used if link is specified).

$caption

stringPost caption (can only be used if link is specified).

$description

stringPost description (can only be used if link is specified).

$actions

arrayPost actions array of objects containing name and link.

Response

mixedThe 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

stringThe group id.

$message

stringStatus message content.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

deleteConnection

Method to delete a connection.

deleteConnection(string $object, string $connection = null, string $extra_fields = '') : mixed
inherited
since

3.2.0

Arguments

$object

stringThe object id.

$connection

stringThe object's connection name.

$extra_fields

stringURL fields.

Response

mixedThe 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

mixedThe Link ID.

Response

booleanReturns 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

stringThe Post ID.

Response

booleanReturns 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

stringThe Status ID.

Response

booleanReturns 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
inherited
since

3.2.0

Arguments

$path

stringURL to inflect.

$limit

integerThe number of objects per page.

$offset

integerThe object's number on the page.

$until

integerA unix timestamp or any date accepted by strtotime.

$since

integerA unix timestamp or any date accepted by strtotime.

Response

stringThe request URL.

get

Method to get an object.

get(string $object) : mixed
inherited
since

3.2.0

Arguments

$object

stringThe object id.

Response

mixedThe 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 $extra_fields = '', integer $limit, integer $offset, string $until = null, string $since = null) : mixed
inherited
since

3.2.0

Arguments

$object

stringThe object id.

$connection

stringThe object's connection name.

$extra_fields

stringURL fields.

$limit

integerThe number of objects per page.

$offset

integerThe object's number on the page.

$until

stringA unix timestamp or any date accepted by strtotime.

$since

stringA unix timestamp or any date accepted by strtotime.

Response

mixedThe 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

stringThe group id.

$limit

integerThe number of objects per page.

$offset

integerThe object's number on the page.

$until

stringA unix timestamp or any date accepted by strtotime.

$since

stringA unix timestamp or any date accepted by strtotime.

Response

mixedThe 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

stringThe group id.

$limit

integerThe number of objects per page.

$offset

integerThe object's number on the page.

$until

stringA unix timestamp or any date accepted by strtotime.

$since

stringA unix timestamp or any date accepted by strtotime.

Response

mixedThe 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

stringThe group id.

Response

mixedThe 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

stringThe group id.

$limit

integerThe number of objects per page.

$offset

integerThe object's number on the page.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

getOAuth

Method used to get the OAuth client.

getOAuth() : \JFacebookOAuth
inherited
since

3.2.0

Response

\JFacebookOAuthThe OAuth client

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

stringThe group id.

$type

stringTo request a different photo use square | small | normal | large.

Response

stringThe 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
inherited
since

3.2.0
throws

\DomainException

Arguments

$path

stringThe path of the request to make.

$data

mixedEither an associative array or a string to be sent with the post request.

$headers

arrayAn array of name-value pairs to include in the header of the request

$limit

integerThe number of objects per page.

$offset

integerThe object's number on the page.

$until

stringA unix timestamp or any date accepted by strtotime.

$since

stringA unix timestamp or any date accepted by strtotime.

Response

mixedThe request response.

setOAuth

Method used to set the OAuth client.

setOAuth(\JFacebookOAuth $oauth) : \JFacebookObject
inherited
since

3.2.0

Arguments

$oauth

\JFacebookOAuthThe OAuth client object.

Response

\JFacebookObjectThis object for method chaining.

Properties

options

Options for the Facebook object.

inherited
since

3.2.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

3.2.0

Type(s)

\JHttp

oauth

The OAuth client.

inherited
since

3.2.0

Type(s)

\JFacebookOAuth
  • \ \
  • \ JFacebookGroup