Joomla! API

link	http://developers.facebook.com/docs/reference/api/event/
since	3.2.0
deprecated	4.0 Use the `joomla/facebook` package via Composer instead
package	Joomla.Platform

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JHttp $client = null, \JFacebookOAuth $oauth = null)

inherited

since	3.2.0

Arguments

$options: \Joomla\Registry\RegistryFacebook options object.
$client: \JHttpThe HTTP client object.
$oauth: \JFacebookOAuthThe OAuth client.

Method to set the current user as attending. Requires authentication and rsvp_event permission.

createAttending(string $event) : boolean

since	3.2.0

Arguments

$event: stringThe event id.

Response

booleanReturns true if successful, and false otherwise.

Method to create a connection.

createConnection(string $object, string $connection = null, array $parameters = null, array $headers = null) : mixed

inherited

since	3.2.0

Arguments

$object: stringThe object id.
$connection: stringThe object's connection name.
$parameters: arrayThe POST request parameters.
$headers: arrayAn array of name-value pairs to include in the header of the request

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to set the current user as declined. Requires authentication and rscp_event permission.

createDeclined(string $event) : boolean

since	3.2.0

Arguments

$event: stringThe event id.

Response

booleanReturns true if successful, and false otherwise.

Method to invite users to the event. Requires authentication and create_event permission.

createInvite(string $event, string $users) : boolean

since	3.2.0

Arguments

$event: stringThe event id.
$users: stringComma separated list of user ids.

Response

booleanReturns true if successful, and false otherwise.

Method to post a link on event's feed which the current_user is or maybe attending. Requires authentication and publish_stream permission.

createLink(string $event, string $link, string $message = null) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$link: stringLink URL.
$message: stringLink message.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to set the current user as maybe attending. Requires authentication and rscp_event permission.

createMaybe(string $event) : boolean

since	3.2.0

Arguments

$event: stringThe event id.

Response

booleanReturns true if successful, and false otherwise.

Method to post a photo on event's wall. Requires authentication and publish_stream permission.

createPhoto(string $event, string $source, string $message = null) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$source: stringPath to photo.
$message: stringPhoto description.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to post on event's wall. Message or link parameter is required. Requires authentication and publish_stream permission.

createPost(string $event, string $message = null, string $link = null, string $picture = null, string $name = null, string $caption = null, string $description = null, array $actions = null) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$message: stringPost message.
$link: stringPost URL.
$picture: stringPost thumbnail image (can only be used if link is specified)
$name: stringPost name (can only be used if link is specified).
$caption: stringPost caption (can only be used if link is specified).
$description: stringPost description (can only be used if link is specified).
$actions: arrayPost actions array of objects containing name and link.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to post a status message on behalf of the user on the event's wall. Requires authentication and publish_stream permission.

createStatus(string $event, string $message) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$message: stringStatus message content.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to post a video on event's wall. Requires authentication and publish_stream permission.

createVideo(string $event, string $source, string $title = null, string $description = null) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$source: stringPath to photo.
$title: stringVideo title.
$description: stringVideo description.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to delete a connection.

deleteConnection(string $object, string $connection = null, string $extra_fields = '') : mixed

inherited

since	3.2.0

Arguments

$object: stringThe object id.
$connection: stringThe object's connection name.
$extra_fields: stringURL fields.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to delete an invitation. Note: you can only delete the invite if the current user is the event admin.

deleteInvite(string $event, string $user) : boolean

Requires authentication and rsvp_event permission.

since	3.2.0

Arguments

$event: stringThe event id.
$user: stringThe user id.

Response

booleanReturns true if successful, and false otherwise.

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

deleteLink(mixed $link) : boolean

since	3.2.0

Arguments

$link: mixedThe Link ID.

Response

booleanReturns true if successful, and false otherwise.

Method to delete a post. Note: you can only delete the post if it was created by the current user.

deletePost(string $post) : boolean

Requires authentication and publish_stream permission.

since	3.2.0

Arguments

$post: stringThe Post ID.

Response

booleanReturns true if successful, and false otherwise.

Method to delete a status. Note: you can only delete the post if it was created by the current user.

deleteStatus(string $status) : boolean

Requires authentication and publish_stream permission.

since	3.2.0

Arguments

$status: stringThe Status ID.

Response

booleanReturns true if successful, and false otherwise.

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

inherited

since	3.2.0

Arguments

$path: stringURL to inflect.
$limit: integerThe number of objects per page.
$offset: integerThe object's number on the page.
$until: integerA unix timestamp or any date accepted by strtotime.
$since: integerA unix timestamp or any date accepted by strtotime.

Response

stringThe request URL.

Method to get an object.

get(string $object) : mixed

inherited

since	3.2.0

Arguments

$object: stringThe object id.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to get the list of attending users. Requires authentication and user_events or friends_events permission.

getAttending(string $event, integer $limit, integer $offset) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$limit: integerThe number of objects per page.
$offset: integerThe object's number on the page.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to get object's connection.

getConnection(string $object, string $connection = null, string $extra_fields = '', integer $limit, integer $offset, string $until = null, string $since = null) : mixed

inherited

since	3.2.0

Arguments

$object: stringThe object id.
$connection: stringThe object's connection name.
$extra_fields: stringURL fields.
$limit: integerThe number of objects per page.
$offset: integerThe object's number on the page.
$until: stringA unix timestamp or any date accepted by strtotime.
$since: stringA unix timestamp or any date accepted by strtotime.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to get the list of users which declined the event. Requires authentication and user_events or friends_events permission.

getDeclined(string $event, integer $limit, integer $offset) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$limit: integerThe number of objects per page.
$offset: integerThe object's number on the page.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to get information about an event visible to the current user. Requires authentication.

getEvent(string $event) : mixed

since	3.2.0

Arguments

$event: stringThe event id.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to get the event's wall. Requires authentication.

getFeed(string $event, integer $limit, integer $offset, string $until = null, string $since = null) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$limit: integerThe number of objects per page.
$offset: integerThe object's number on the page.
$until: stringA unix timestamp or any date accepted by strtotime.
$since: stringA unix timestamp or any date accepted by strtotime.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to get the list of invitees for the event. Requires authentication and user_events or friends_events permission.

getInvited(string $event, integer $limit, integer $offset) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$limit: integerThe number of objects per page.
$offset: integerThe object's number on the page.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to get the list of maybe attending users. Requires authentication and user_events or friends_events permission.

getMaybe(string $event, integer $limit, integer $offset) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$limit: integerThe number of objects per page.
$offset: integerThe object's number on the page.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to get the list of users which have not replied to the event. Requires authentication and user_events or friends_events permission.

getNoreply(string $event, integer $limit, integer $offset) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$limit: integerThe number of objects per page.
$offset: integerThe object's number on the page.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method used to get the OAuth client.

getOAuth() : \JFacebookOAuth

inherited

since	3.2.0

Response

\JFacebookOAuthThe OAuth client

Method to get photos published on event's wall. Requires authentication.

getPhotos(string $event, integer $limit, integer $offset, string $until = null, string $since = null) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$limit: integerThe number of objects per page.
$offset: integerThe object's number on the page.
$until: stringA unix timestamp or any date accepted by strtotime.
$since: stringA unix timestamp or any date accepted by strtotime.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to get the event's profile picture. Requires authentication and user_events or friends_events permission.

getPicture(string $event, boolean $redirect = true, string $type = null) : string

since	3.2.0

Arguments

$event: stringThe event id.
$redirect: booleanIf false this will return the URL of the picture without a 302 redirect.
$type: stringTo request a different photo use square | small | normal | large.

Response

stringThe URL to the event's profile picture.

Method to get videos published on event's wall. Requires authentication.

getVideos(string $event, integer $limit, integer $offset, string $until = null, string $since = null) : mixed

since	3.2.0

Arguments

$event: stringThe event id.
$limit: integerThe number of objects per page.
$offset: integerThe object's number on the page.
$until: stringA unix timestamp or any date accepted by strtotime.
$since: stringA unix timestamp or any date accepted by strtotime.

Response

mixedThe decoded JSON response or false if the client is not authenticated.

Method to check if a user is attending an event. Requires authentication and user_events or friends_events permission.

isAttending(string $event, mixed $user) : array

since	3.2.0

Arguments

$event: stringThe event id.
$user: mixedEither an integer containing the user ID or a string containing the username.

Response

arrayThe decoded JSON response or an empty array if the user is not invited.

Method to check if a user responded 'no' to the event. Requires authentication and user_events or friends_events permission.

isDeclined(string $event, mixed $user) : array

since	3.2.0

Arguments

$event: stringThe event id.
$user: mixedEither an integer containing the user ID or a string containing the username.

Response

arrayThe decoded JSON response or an empty array if the user is not invited.

Method to check if a user is invited to the event. Requires authentication and user_events or friends_events permission.

isInvited(string $event, mixed $user) : array

since	3.2.0

Arguments

$event: stringThe event id.
$user: mixedEither an integer containing the user ID or a string containing the username.

Response

arrayThe decoded JSON response or an empty array if the user is not invited.

Method to check if a user is maybe attending an event. Requires authentication and user_events or friends_events permission.

isMaybe(string $event, mixed $user) : array

since	3.2.0

Arguments

$event: stringThe event id.
$user: mixedEither an integer containing the user ID or a string containing the username.

Response

arrayThe decoded JSON response or an empty array if the user is not invited.

Method to check if a user has not replied to the event. Requires authentication and user_events or friends_events permission.

isNoreply(string $event, mixed $user) : array

since	3.2.0

Arguments

$event: stringThe event id.
$user: mixedEither an integer containing the user ID or a string containing the username.

Response

arrayThe decoded JSON response or an empty array if the user is not invited.

Method to send the request.

sendRequest(string $path, mixed $data = '', array $headers = null, integer $limit, integer $offset, string $until = null, string $since = null) : mixed

inherited

since	3.2.0
throws	`\DomainException`

Arguments

$path: stringThe path of the request to make.
$data: mixedEither an associative array or a string to be sent with the post request.
$headers: arrayAn array of name-value pairs to include in the header of the request
$limit: integerThe number of objects per page.
$offset: integerThe object's number on the page.
$until: stringA unix timestamp or any date accepted by strtotime.
$since: stringA unix timestamp or any date accepted by strtotime.

Response

mixedThe request response.

Method used to set the OAuth client.

setOAuth(\JFacebookOAuth $oauth) : \JFacebookObject

inherited

since	3.2.0

Arguments

$oauth: \JFacebookOAuthThe OAuth client object.

Response

\JFacebookObjectThis object for method chaining.

Options for the Facebook object.

inherited

since	3.2.0

Type(s)

\Joomla\Registry\Registry

The HTTP client object to use in sending HTTP requests.

inherited

since	3.2.0

Type(s)

\JHttp

The OAuth client.

inherited

since	3.2.0

Type(s)

\JFacebookOAuth

JFacebookEvent

Methods

__construct

Arguments

createAttending

Arguments

Response

createConnection

Arguments

Response

createDeclined

Arguments

Response

createInvite

Arguments

Response

createLink

Arguments

Response

createMaybe

Arguments

Response

createPhoto

Arguments

Response

createPost

Arguments

Response

createStatus

Arguments

Response

createVideo

Arguments

Response

deleteConnection

Arguments

Response

deleteInvite

Arguments

Response

deleteLink

Arguments

Response

deletePost

Arguments

Response

deleteStatus

Arguments

Response

fetchUrl

Arguments

Response

get

Arguments

Response

getAttending

Arguments

Response

getConnection

Arguments

Response

getDeclined

Arguments

Response

getEvent

Arguments

Response

getFeed

Arguments

Response

getInvited

Arguments

Response

getMaybe

Arguments

Response

getNoreply

Arguments

Response

getOAuth