JFacebookVideo
Extends \JFacebookObjectFacebook API Video class for the Joomla Platform.
link | |
---|---|
since |
3.2.0 |
deprecated |
4.0 Use the |
package |
Joomla.Platform |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry $options = null, \JHttp $client = null, \JFacebookOAuth $oauth = null)
since |
3.2.0 |
---|
Arguments
- $options
\Joomla\Registry\Registry
Facebook options object.- $client
\JHttp
The HTTP client object.- $oauth
\JFacebookOAuth
The OAuth client.
createComment
Method to comment on a video. Requires authentication and publish_stream permission, user_videos or friends_videos permission for private videos.
createComment(string $video, string $message) : mixed
since |
3.2.0 |
---|
Arguments
- $video
string
The video id.- $message
string
The comment's text.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
createConnection
Method to create a connection.
createConnection(string $object, string $connection = null, array $parameters = null, array $headers = null) : mixed
since |
3.2.0 |
---|
Arguments
- $object
string
The object id.- $connection
string
The object's connection name.- $parameters
array
The POST request parameters.- $headers
array
An array of name-value pairs to include in the header of the request
Response
mixed
The decoded JSON response or false if the client is not authenticated.
createLike
Method to like a video. Requires authentication and publish_stream permission, user_videos or friends_videos permission for private videos.
createLike(string $video) : boolean
since |
3.2.0 |
---|
Arguments
- $video
string
The video id.
Response
boolean
Returns true if successful, and false otherwise.
deleteComment
Method to delete a comment. Requires authentication and publish_stream permission, user_videos or friends_videos permission for private videos.
deleteComment(string $comment) : boolean
since |
3.2.0 |
---|
Arguments
- $comment
string
The comment's id.
Response
boolean
Returns true if successful, and false otherwise.
deleteConnection
Method to delete a connection.
deleteConnection(string $object, string $connection = null, string $extraFields = '') : mixed
since |
3.2.0 |
---|
Arguments
- $object
string
The object id.- $connection
string
The object's connection name.- $extraFields
string
URL fields.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
deleteLike
Method to unlike a video. Requires authentication and publish_stream permission, user_videos or friends_videos permission for private videos.
deleteLike(string $video) : boolean
since |
3.2.0 |
---|
Arguments
- $video
string
The video id.
Response
boolean
Returns true if successful, and false otherwise.
fetchUrl
Method to build and return a full request URL for the request. This method will add appropriate pagination details if necessary and also prepend the API url to have a complete URL for the request.
fetchUrl(string $path, integer $limit, integer $offset, integer $until = null, integer $since = null) : string
since |
3.2.0 |
---|
Arguments
- $path
string
URL to inflect.- $limit
integer
The number of objects per page.- $offset
integer
The object's number on the page.- $until
integer
A unix timestamp or any date accepted by strtotime.- $since
integer
A unix timestamp or any date accepted by strtotime.
Response
string
The request URL.
get
Method to get an object.
get(string $object) : mixed
since |
3.2.0 |
---|
Arguments
- $object
string
The object id.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
getComments
Method to get a video's comments. Requires authentication and user_videos or friends_videos permission for private videos.
getComments(string $video, integer $limit, integer $offset, string $until = null, string $since = null) : mixed
since |
3.2.0 |
---|
Arguments
- $video
string
The video id.- $limit
integer
The number of objects per page.- $offset
integer
The object's number on the page.- $until
string
A unix timestamp or any date accepted by strtotime.- $since
string
A unix timestamp or any date accepted by strtotime.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
getConnection
Method to get object's connection.
getConnection(string $object, string $connection = null, string $extraFields = '', integer $limit, integer $offset, string $until = null, string $since = null) : mixed
since |
3.2.0 |
---|
Arguments
- $object
string
The object id.- $connection
string
The object's connection name.- $extraFields
string
URL fields.- $limit
integer
The number of objects per page.- $offset
integer
The object's number on the page.- $until
string
A unix timestamp or any date accepted by strtotime.- $since
string
A unix timestamp or any date accepted by strtotime.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
getLikes
Method to get video's likes. Requires authentication and user_videos or friends_videos permission for private videos.
getLikes(string $video, integer $limit, integer $offset, string $until = null, string $since = null) : mixed
since |
3.2.0 |
---|
Arguments
- $video
string
The video id.- $limit
integer
The number of objects per page.- $offset
integer
The object's number on the page.- $until
string
A unix timestamp or any date accepted by strtotime.- $since
string
A unix timestamp or any date accepted by strtotime.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
getOAuth
Method used to get the OAuth client.
getOAuth() : \JFacebookOAuth
getPicture
Method to get the album-sized view of the video. Requires authentication and user_videos or friends_videos permission for private photos.
getPicture(string $video) : string
since |
3.2.0 |
---|
Arguments
- $video
string
The video id.
Response
string
URL of the picture.
getVideo
Method to get a video. Requires authentication and user_videos or friends_videos permission for private videos.
getVideo(string $video) : mixed
since |
3.2.0 |
---|
Arguments
- $video
string
The video id.
Response
mixed
The decoded JSON response or false if the client is not authenticated.
sendRequest
Method to send the request.
sendRequest(string $path, mixed $data = '', array $headers = null, integer $limit, integer $offset, string $until = null, string $since = null) : mixed
since |
3.2.0 |
---|---|
throws |
|
Arguments
- $path
string
The path of the request to make.- $data
mixed
Either an associative array or a string to be sent with the post request.- $headers
array
An array of name-value pairs to include in the header of the request- $limit
integer
The number of objects per page.- $offset
integer
The object's number on the page.- $until
string
A unix timestamp or any date accepted by strtotime.- $since
string
A unix timestamp or any date accepted by strtotime.
Response
mixed
The request response.
setOAuth
Method used to set the OAuth client.
setOAuth(\JFacebookOAuth $oauth) : \JFacebookObject
since |
3.2.0 |
---|
Arguments
- $oauth
\JFacebookOAuth
The OAuth client object.
Response
\JFacebookObject
This object for method chaining.
Properties
client
The HTTP client object to use in sending HTTP requests.
since |
3.2.0 |
---|
Type(s)
\JHttp