Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JFacebookGroup
+ Graphe d'héritage de JFacebookGroup:
+ Graphe de collaboration de JFacebookGroup:

Liste de tous les membres

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 inherited from JFacebookObject
 __construct (JRegistry $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 ()

Additional Inherited Members

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

Description détaillée

Définition à la ligne 23 du fichier group.php.


Documentation des fonctions membres

JFacebookGroup::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.
strin$messageLink message.
Renvoie:
mixed The decoded JSON response or false if the client is not authenticated.
Depuis:
13.1

Définition à la ligne 122 du fichier group.php.

{
// Set POST request parameters.
$data = array();
$data['link'] = $link;
if ($message)
{
$data['message'] = $message;
}
return $this->createConnection($group, 'feed', $data);
}
JFacebookGroup::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

Définition à la ligne 166 du fichier group.php.

{
// Set POST request parameters.
if ($message)
{
$data['message'] = $message;
}
if ($link)
{
$data['link'] = $link;
}
if ($name)
{
$data['name'] = $name;
}
if ($caption)
{
$data['caption'] = $caption;
}
if ($description)
{
$data['description'] = $description;
}
if ($actions)
{
$data['actions'] = $actions;
}
if ($picture)
{
$data['picture'] = $picture;
}
return $this->createConnection($group, 'feed', $data);
}
JFacebookGroup::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

Définition à la ligne 232 du fichier group.php.

{
// Set POST request parameters.
$data = array();
$data['message'] = $message;
return $this->createConnection($group, 'feed', $data);
}
JFacebookGroup::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

Définition à la ligne 145 du fichier group.php.

{
return $this->deleteConnection($link);
}
JFacebookGroup::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

Définition à la ligne 217 du fichier group.php.

{
return $this->deleteConnection($post);
}
JFacebookGroup::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

Définition à la ligne 250 du fichier group.php.

{
return $this->deleteConnection($status);
}
JFacebookGroup::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

Définition à la ligne 86 du fichier group.php.

{
return $this->getConnection($group, 'docs', '', $limit, $offset, $until, $since);
}
JFacebookGroup::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

Définition à la ligne 52 du fichier group.php.

{
return $this->getConnection($group, 'feed', '', $limit, $offset, $until, $since);
}
JFacebookGroup::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

Définition à la ligne 34 du fichier group.php.

{
return $this->get($group);
}
JFacebookGroup::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

Définition à la ligne 68 du fichier group.php.

{
return $this->getConnection($group, 'members', '', $limit, $offset);
}
JFacebookGroup::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

Définition à la ligne 101 du fichier group.php.

{
if ($type)
{
$type = '?type=' . $type;
}
return $this->getConnection($group, 'picture', $type);
}

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