Docs For Class JFacebookVideo

Description

Facebook API Video class for the Joomla Platform.

see: http://developers.facebook.com/docs/reference/api/video/
since: 13.1

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

JFacebookObject
   |
   --JFacebookVideo

Method Summary

mixed createComment (string $video, string $message)

boolean createLike (string $video)

boolean deleteComment (string $comment)

boolean deleteLike (string $video)

mixed getComments (string $video, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

mixed getLikes (string $video, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

string getPicture (string $video)

mixed getVideo (string $video)

Variables

Inherited Variables

Inherited from JFacebookObject

JFacebookObject::$client
JFacebookObject::$oauth
JFacebookObject::$options

Methods

createComment (line 67)

Method to comment on a video. Requires authentication and publish_stream permission, user_videos or friends_videos permission for private videos.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed createComment (string $video, string $message)

string $video: The video id.
string $message: The comment's text.

createLike (line 117)

Method to like a video. Requires authentication and publish_stream permission, user_videos or friends_videos permission for private videos.

return: Returns true if successful, and false otherwise.
since: 13.1
access: public

boolean createLike (string $video)

string $video: The video id.

deleteComment (line 85)

Method to delete a comment. Requires authentication and publish_stream permission, user_videos or friends_videos permission for private videos.

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 131)

Method to unlike a video. Requires authentication and publish_stream permission, user_videos or friends_videos permission for private videos.

return: Returns true if successful, and false otherwise.
since: 13.1
access: public

boolean deleteLike (string $video)

string $video: The video id.

getComments (line 52)

Method to get a video's comments. Requires authentication and user_videos or friends_videos permission for private videos.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed getComments (string $video, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

string $video: The video 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 103)

Method to get video's likes. Requires authentication and user_videos or friends_videos permission for private videos.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed getLikes (string $video, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])

string $video: The video 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 145)

Method to get the album-sized view of the video. Requires authentication and user_videos or friends_videos permission for private photos.

return: URL of the picture.
since: 13.1
access: public

string getPicture (string $video)

string $video: The video id.

getVideo (line 34)

Method to get a video. Requires authentication and user_videos or friends_videos permission for private videos.

return: The decoded JSON response or false if the client is not authenticated.
since: 13.1
access: public

mixed getVideo (string $video)

string $video: The video id.

Inherited Methods

Inherited From JFacebookObject

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