Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JFacebookAlbum
+ Graphe d'héritage de JFacebookAlbum:

Fonctions membres publiques

 getAlbum ($album)
 
 getPhotos ($album, $limit=0, $offset=0, $until=null, $since=null)
 
 createPhoto ($album, $source, $message=null)
 
 getComments ($album, $limit=0, $offset=0, $until=null, $since=null)
 
 createComment ($album, $message)
 
 deleteComment ($comment)
 
 getLikes ($album, $limit=0, $offset=0, $until=null, $since=null)
 
 createLike ($album)
 
 deleteLike ($album)
 
 getPicture ($album, $redirect=true)
 
- 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, $extraFields='', $limit=0, $offset=0, $until=null, $since=null)
 
 createConnection ($object, $connection=null, $parameters=null, array $headers=null)
 
 deleteConnection ($object, $connection=null, $extraFields='')
 
 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 Album class for the Joomla Platform.

3.2.0 deprecated 292.

Documentation des fonctions membres

◆ createComment()

createComment (   $album,
  $message 
)

Method to comment on an album. Requires authentication and publish_stream permission.

Paramètres
string$albumThe album id.
string$messageThe comment's text.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
3.2.0

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

◆ createLike()

createLike (   $album)

Method to like an album. Requires authentication and publish_stream permission.

Paramètres
string$albumThe album id.
Renvoie
boolean Returns true if successful, and false otherwise.
Depuis
3.2.0

◆ createPhoto()

createPhoto (   $album,
  $source,
  $message = null 
)

Method to add photos to an album. Note: check can_upload flag first. Requires authentication and publish_stream permission.

Paramètres
string$albumThe album id.
string$sourcePath to photo.
string$messagePhoto description.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
3.2.0

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

◆ deleteComment()

deleteComment (   $comment)

Method to delete a comment. Requires authentication and publish_stream permission.

Paramètres
string$commentThe comment's id.
Renvoie
boolean Returns true if successful, and false otherwise.
Depuis
3.2.0

◆ deleteLike()

deleteLike (   $album)

Method to unlike an album. Requires authentication and publish_stream permission.

Paramètres
string$albumThe album id.
Renvoie
boolean Returns true if successful, and false otherwise.
Depuis
3.2.0

◆ getAlbum()

getAlbum (   $album)

Method to get an album. Requires authentication and user_photos or friends_photos permission for private photos.

Paramètres
string$albumThe album id.
Renvoie
mixed The decoded JSON response or false if the client is not authenticated.
Depuis
3.2.0

◆ getComments()

getComments (   $album,
  $limit = 0,
  $offset = 0,
  $until = null,
  $since = null 
)

Method to get an album's comments. Requires authentication and user_photos or friends_photos permission for private photos.

Paramètres
string$albumThe album 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
3.2.0

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

◆ getLikes()

getLikes (   $album,
  $limit = 0,
  $offset = 0,
  $until = null,
  $since = null 
)

Method to get album's likes. Requires authentication and user_photos or friends_photos permission for private photos.

Paramètres
string$albumThe album 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
3.2.0

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

◆ getPhotos()

getPhotos (   $album,
  $limit = 0,
  $offset = 0,
  $until = null,
  $since = null 
)

Method to get the photos contained in this album. Requires authentication and user_photos or friends_photos permission for private photos.

Paramètres
string$albumThe album 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
3.2.0

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

◆ getPicture()

getPicture (   $album,
  $redirect = true 
)

Method to get the album's cover photo, the first picture uploaded to an album becomes the cover photo for the album. Requires authentication and user_photos or friends_photos permission for private photos.

Paramètres
string$albumThe album id.
boolean$redirectIf false this will return the URL of the picture without a 302 redirect.
Renvoie
string URL of the picture.
Depuis
3.2.0

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