Class JFacebookAlbum

Facebook API Album class for the Joomla Platform.

JFacebookAlbum

Package: Joomla\Platform\Facebook
Deprecated: 4.0 Use the joomla/facebook package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 13.1
Link: http://developers.facebook.com/docs/reference/api/album/
Located at joomla/facebook/album.php

Methods summary

`public mixed`	# `getAlbum( string $album )` Method to get an album. Requires authentication and user_photos or friends_photos permission for private photos. Method to get an album. Requires authentication and user_photos or friends_photos permission for private photos. Parameters `$album` `string` - $album The album id. Returns `mixed` - The decoded JSON response or false if the client is not authenticated. Since 13.1
`public mixed`	# `getPhotos( string $album, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )` Method to get the photos contained in this album. Requires authentication and user_photos or friends_photos permission for private photos. Method to get the photos contained in this album. Requires authentication and user_photos or friends_photos permission for private photos. Parameters `$album` `string` - $album The album id. `$limit` `integer` - $limit The number of objects per page. `$offset` `integer` - $offset The object's number on the page. `$until` `string` - $until A unix timestamp or any date accepted by strtotime. `$since` `string` - $since A unix timestamp or any date accepted by strtotime. Returns `mixed` - The decoded JSON response or false if the client is not authenticated. Since 13.1
`public mixed`	# `createPhoto( string $album, string $source, string $message = null )` Method to add photos to an album. Note: check can_upload flag first. Requires authentication and publish_stream permission. Method to add photos to an album. Note: check can_upload flag first. Requires authentication and publish_stream permission. Parameters `$album` `string` - $album The album id. `$source` `string` - $source Path to photo. `$message` `string` - $message Photo description. Returns `mixed` - The decoded JSON response or false if the client is not authenticated. Since 13.1
`public mixed`	# `getComments( string $album, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )` Method to get an album's comments. Requires authentication and user_photos or friends_photos permission for private photos. Method to get an album's comments. Requires authentication and user_photos or friends_photos permission for private photos. Parameters `$album` `string` - $album The album id. `$limit` `integer` - $limit The number of objects per page. `$offset` `integer` - $offset The object's number on the page. `$until` `string` - $until A unix timestamp or any date accepted by strtotime. `$since` `string` - $since A unix timestamp or any date accepted by strtotime. Returns `mixed` - The decoded JSON response or false if the client is not authenticated. Since 13.1
`public mixed`	# `createComment( string $album, string $message )` Method to comment on an album. Requires authentication and publish_stream permission. Method to comment on an album. Requires authentication and publish_stream permission. Parameters `$album` `string` - $album The album id. `$message` `string` - $message The comment's text. Returns `mixed` - The decoded JSON response or false if the client is not authenticated. Since 13.1
`public boolean`	# `deleteComment( string $comment )` Method to delete a comment. Requires authentication and publish_stream permission. Method to delete a comment. Requires authentication and publish_stream permission. Parameters `$comment` `string` - $comment The comment's id. Returns `boolean` - Returns true if successful, and false otherwise. Since 13.1
`public mixed`	# `getLikes( string $album, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )` Method to get album's likes. Requires authentication and user_photos or friends_photos permission for private photos. Method to get album's likes. Requires authentication and user_photos or friends_photos permission for private photos. Parameters `$album` `string` - $album The album id. `$limit` `integer` - $limit The number of objects per page. `$offset` `integer` - $offset The object's number on the page. `$until` `string` - $until A unix timestamp or any date accepted by strtotime. `$since` `string` - $since A unix timestamp or any date accepted by strtotime. Returns `mixed` - The decoded JSON response or false if the client is not authenticated. Since 13.1
`public boolean`	# `createLike( string $album )` Method to like an album. Requires authentication and publish_stream permission. Method to like an album. Requires authentication and publish_stream permission. Parameters `$album` `string` - $album The album id. Returns `boolean` - Returns true if successful, and false otherwise. Since 13.1
`public boolean`	# `deleteLike( string $album )` Method to unlike an album. Requires authentication and publish_stream permission. Method to unlike an album. Requires authentication and publish_stream permission. Parameters `$album` `string` - $album The album id. Returns `boolean` - Returns true if successful, and false otherwise. Since 13.1
`public string`	# `getPicture( string $album, boolean $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. 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. Parameters `$album` `string` - $album The album id. `$redirect` `boolean` - $redirect If false this will return the URL of the picture without a 302 redirect. Returns `string` - URL of the picture. Since 13.1

Methods inherited from JFacebookObject

__construct(), createConnection(), deleteConnection(), fetchUrl(), get(), getConnection(), getOAuth(), sendRequest(), setOAuth()

Magic methods summary

Properties summary

Properties inherited from JFacebookObject

$client, $oauth, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFacebookAlbum

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Methods inherited from JFacebookObject

Magic methods summary

Properties summary

Properties inherited from JFacebookObject