Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JFacebookGroup
+ Graphe d'héritage de JFacebookGroup:

Fonctions membres publiques

 getGroup ($group)
 
 getFeed ($group, $limit=0, $offset=0, $until=null, $since=null)
 
 getMembers ($group, $limit=0, $offset=0)
 
 getDocs ($group, $limit=0, $offset=0, $until=null, $since=null)
 
 getPicture ($group, $type=null)
 
 createLink ($group, $link, $message=null)
 
 deleteLink ($link)
 
 createPost ($group, $message=null, $link=null, $picture=null, $name=null, $caption=null, $description=null, $actions=null)
 
 deletePost ($post)
 
 createStatus ($group, $message)
 
 deleteStatus ($status)
 
- Fonctions membres publiques hérités de JFacebookObject
 __construct (Registry $options=null, JHttp $client=null, JFacebookOAuth $oauth=null)
 
 sendRequest ($path, $data='', array $headers=null, $limit=0, $offset=0, $until=null, $since=null)
 
 get ($object)
 
 getConnection ($object, $connection=null, $extra_fields='', $limit=0, $offset=0, $until=null, $since=null)
 
 createConnection ($object, $connection=null, $parameters=null, array $headers=null)
 
 deleteConnection ($object, $connection=null, $extra_fields='')
 
 setOAuth ($oauth)
 
 getOAuth ()
 

Membres hérités additionnels

- Fonctions membres protégées hérités de JFacebookObject
 fetchUrl ($path, $limit=0, $offset=0, $until=null, $since=null)
 
- Attributs protégés hérités de JFacebookObject
 $options
 
 $client
 
 $oauth
 

Description détaillée

Facebook API Group class for the Joomla Platform.

13.1 deprecated 260.

Documentation des fonctions membres

◆ createLink()

createLink (   $group,
  $link,
  $message = null 
)

Method to post a link on group's wall. Requires authentication and publish_stream permission.

Paramètres
string$groupThe group id.
string$linkLink URL.
string$messageLink message.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
13.1

Références $data, $link, et $message.

◆ createPost()

createPost (   $group,
  $message = null,
  $link = null,
  $picture = null,
  $name = null,
  $caption = null,
  $description = null,
  $actions = null 
)

Method to post on group's wall. Message or link parameter is required. Requires authentication and publish_stream permission.

Paramètres
string$groupThe group id.
string$messagePost message.
string$linkPost URL.
string$picturePost thumbnail image (can only be used if link is specified)
string$namePost name (can only be used if link is specified).
string$captionPost caption (can only be used if link is specified).
string$descriptionPost description (can only be used if link is specified).
array$actionsPost actions array of objects containing name and link.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
13.1

Références $data, $description, $link, $message, et $name.

◆ createStatus()

createStatus (   $group,
  $message 
)

Method to post a status message on behalf of the user on the group's wall. Requires authentication and publish_stream permission.

Paramètres
string$groupThe group id.
string$messageStatus message content.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
13.1

Références $data, et $message.

◆ deleteLink()

deleteLink (   $link)

Method to delete a link. Requires authentication.

Paramètres
mixed$linkThe Link ID.
Renvoie
boolean Returns true if successful, and false otherwise.
Depuis
13.1

Références $link.

◆ deletePost()

deletePost (   $post)

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

Paramètres
string$postThe Post ID.
Renvoie
boolean Returns true if successful, and false otherwise.
Depuis
13.1

◆ deleteStatus()

deleteStatus (   $status)

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

Paramètres
string$statusThe Status ID.
Renvoie
boolean Returns true if successful, and false otherwise.
Depuis
13.1

◆ getDocs()

getDocs (   $group,
  $limit = 0,
  $offset = 0,
  $until = null,
  $since = null 
)

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

Paramètres
string$groupThe group id.
integer$limitThe number of objects per page.
integer$offsetThe object's number on the page.
string$untilA unix timestamp or any date accepted by strtotime.
string$sinceA unix timestamp or any date accepted by strtotime.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
13.1

Références $limit, et $offset.

◆ getFeed()

getFeed (   $group,
  $limit = 0,
  $offset = 0,
  $until = null,
  $since = null 
)

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

Paramètres
string$groupThe group id.
integer$limitThe number of objects per page.
integer$offsetThe object's number on the page.
string$untilA unix timestamp or any date accepted by strtotime.
string$sinceA unix timestamp or any date accepted by strtotime.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
13.1

Références $limit, et $offset.

◆ getGroup()

getGroup (   $group)

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

Paramètres
string$groupThe group id.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
13.1

◆ getMembers()

getMembers (   $group,
  $limit = 0,
  $offset = 0 
)

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

Paramètres
string$groupThe group id.
integer$limitThe number of objects per page.
integer$offsetThe object's number on the page.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
13.1

Références $limit, et $offset.

◆ getPicture()

getPicture (   $group,
  $type = null 
)

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

Paramètres
string$groupThe group id.
string$typeTo request a different photo use square | small | normal | large.
Renvoie
string The URL to the group's picture.
Depuis
13.1

Références $type.


La documentation de cette classe a été générée à partir du fichier suivant :