Class JFacebookAlbum

Description
Description | Vars | Methods (details)

Facebook API Album class for the Joomla Platform.

Located in /libraries/joomla/facebook/album.php (line 23) 

JFacebookObject
   |
   --JFacebookAlbum
Method Summary
Description | Vars | Methods (details)
mixed createComment (string $album, string $message)
boolean createLike (string $album)
mixed createPhoto (string $album, string $source, [string $message = null])
boolean deleteComment (string $comment)
boolean deleteLike (string $album)
mixed getAlbum (string $album)
mixed getComments (string $album, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getLikes (string $album, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getPhotos (string $album, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
string getPicture (string $album, [boolean $redirect = true])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JFacebookObject

JFacebookObject::$client
 JFacebookObject::$oauth
 JFacebookObject::$options
Methods
Description | Vars Methods (details)
createComment (line 110)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createComment (string $album, string $message)
  • string $album: The album id.
  • string $message: The comment's text.
createLike (line 160)

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

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean createLike (string $album)
  • string $album: The album id.
createPhoto (line 68)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createPhoto (string $album, string $source, [string $message = null])
  • string $album: The album id.
  • string $source: Path to photo.
  • string $message: Photo description.
deleteComment (line 128)

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

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteComment (string $comment)
  • string $comment: The comment's id.
deleteLike (line 174)

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

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteLike (string $album)
  • string $album: The album id.
getAlbum (line 34)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getAlbum (string $album)
  • string $album: The album id.
getComments (line 95)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getComments (string $album, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • string $album: The album id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
  • string $until: A unix timestamp or any date accepted by strtotime.
  • string $since: A unix timestamp or any date accepted by strtotime.
getLikes (line 146)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getLikes (string $album, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • string $album: The album id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
  • string $until: A unix timestamp or any date accepted by strtotime.
  • string $since: A unix timestamp or any date accepted by strtotime.
getPhotos (line 52)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getPhotos (string $album, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • string $album: The album id.
  • integer $limit: The number of objects per page.
  • integer $offset: The object's number on the page.
  • string $until: A unix timestamp or any date accepted by strtotime.
  • string $since: A unix timestamp or any date accepted by strtotime.
getPicture (line 190)

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.

  • return: URL of the picture.
  • since: 13.1
  • access: public
string getPicture (string $album, [boolean $redirect = true])
  • string $album: The album id.
  • boolean $redirect: If false this will return the URL of the picture without a 302 redirect.

Inherited Methods

Inherited From JFacebookObject

JFacebookObject::__construct()
JFacebookObject::createConnection()
JFacebookObject::deleteConnection()
JFacebookObject::fetchUrl()
JFacebookObject::get()
JFacebookObject::getConnection()
JFacebookObject::getOAuth()
JFacebookObject::sendRequest()
JFacebookObject::setOAuth()

Documentation generated on Tue, 19 Nov 2013 14:53:41 +0100 by phpDocumentor 1.4.3