Graphe d'héritage de JFacebookEvent:

Fonctions membres publiques
	getEvent ($event)

	getFeed ($event, $limit=0, $offset=0, $until=null, $since=null)

	createLink ($event, $link, $message=null)

	deleteLink ($link)

	createPost ($event, $message=null, $link=null, $picture=null, $name=null, $caption=null, $description=null, $actions=null)

	deletePost ($post)

	createStatus ($event, $message)

	deleteStatus ($status)

	getInvited ($event, $limit=0, $offset=0)

	isInvited ($event, $user)

	createInvite ($event, $users)

	deleteInvite ($event, $user)

	getAttending ($event, $limit=0, $offset=0)

	isAttending ($event, $user)

	createAttending ($event)

	getMaybe ($event, $limit=0, $offset=0)

	isMaybe ($event, $user)

	createMaybe ($event)

	getDeclined ($event, $limit=0, $offset=0)

	isDeclined ($event, $user)

	createDeclined ($event)

	getNoreply ($event, $limit=0, $offset=0)

	isNoreply ($event, $user)

	getPicture ($event, $redirect=true, $type=null)

	getPhotos ($event, $limit=0, $offset=0, $until=null, $since=null)

	createPhoto ($event, $source, $message=null)

	getVideos ($event, $limit=0, $offset=0, $until=null, $since=null)

	createVideo ($event, $source, $title=null, $description=null)

Fonctions membres publiques hérités de JFacebookObject
	__construct (Registry $options=null, JHttp $client=null, JFacebookOAuth $oauth=null)

	sendRequest ($path, $data='', array $headers=null, $limit=0, $offset=0, $until=null, $since=null)

	get ($object)

	getConnection ($object, $connection=null, $extraFields='', $limit=0, $offset=0, $until=null, $since=null)

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

	deleteConnection ($object, $connection=null, $extraFields='')

	setOAuth ($oauth)

	getOAuth ()

Membres hérités additionnels
Fonctions membres protégées hérités de JFacebookObject
	fetchUrl ($path, $limit=0, $offset=0, $until=null, $since=null)

Attributs protégés hérités de JFacebookObject
	$options

	$client

	$oauth

Description détaillée

Facebook API User class for the Joomla Platform.

3.2.0 deprecated 295.

Documentation des fonctions membres

◆ createAttending()

createAttending ( $event )

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

Paramètres

string $event The event id.

Renvoie: boolean Returns true if successful, and false otherwise.

Depuis: 3.2.0

◆ createDeclined()

createDeclined ( $event )

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

Paramètres

string $event The event id.

Renvoie: boolean Returns true if successful, and false otherwise.

Depuis: 3.2.0

◆ createInvite()

createInvite	(	$event,
		$users
	)

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

Paramètres

string	$event	The event id.
string	$users	Comma separated list of user ids.

Renvoie: boolean Returns true if successful, and false otherwise.

Depuis: 3.2.0

Références $data, et $users.

◆ createLink()

createLink	(	$event,
		$link,
		$message = `null`
	)

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

Paramètres

string	$event	The event id.
string	$link	Link URL.
string	$message	Link message.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $data, $link, et $message.

◆ createMaybe()

createMaybe ( $event )

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

Paramètres

string $event The event id.

Renvoie: boolean Returns true if successful, and false otherwise.

Depuis: 3.2.0

◆ createPhoto()

createPhoto	(	$event,
		$source,
		$message = `null`
	)

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

Paramètres

string	$event	The event id.
string	$source	Path to photo.
string	$message	Photo description.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $data, et $message.

◆ createPost()

createPost	(	$event,
		$message = `null`,
		$link = `null`,
		$picture = `null`,
		$name = `null`,
		$caption = `null`,
		$description = `null`,
		$actions = `null`
	)

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

Paramètres

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

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $data, $description, $link, $message, et $name.

◆ createStatus()

createStatus	(	$event,
		$message
	)

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

Paramètres

string	$event	The event id.
string	$message	Status message content.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $data, et $message.

◆ createVideo()

createVideo	(	$event,
		$source,
		$title = `null`,
		$description = `null`
	)

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

Paramètres

string	$event	The event id.
string	$source	Path to photo.
string	$title	Video title.
string	$description	Video description.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $data, $description, et $title.

◆ deleteInvite()

deleteInvite	(	$event,
		$user
	)

Method to delete an invitation. Note: you can only delete the invite if the current user is the event admin. Requires authentication and rsvp_event permission.

Paramètres

string	$event	The event id.
string	$user	The user id.

Renvoie: boolean Returns true if successful, and false otherwise.

Depuis: 3.2.0

Références $user.

◆ deleteLink()

deleteLink ( $link )

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

Paramètres

mixed $link The Link ID.

Renvoie: boolean Returns true if successful, and false otherwise.

Depuis: 3.2.0

Références $link.

◆ deletePost()

deletePost ( $post )

Method to delete a post. Note: you can only delete the post if it was created by the current user. Requires authentication and publish_stream permission.

Paramètres

string $post The Post ID.

Renvoie: boolean Returns true if successful, and false otherwise.

Depuis: 3.2.0

◆ deleteStatus()

deleteStatus ( $status )

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

Paramètres

string $status The Status ID.

Renvoie: boolean Returns true if successful, and false otherwise.

Depuis: 3.2.0

◆ getAttending()

getAttending	(	$event,
		$limit = `0`,
		$offset = `0`
	)

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

Paramètres

string	$event	The event id.
integer	$limit	The number of objects per page.
integer	$offset	The object's number on the page.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $limit, et $offset.

◆ getDeclined()

getDeclined	(	$event,
		$limit = `0`,
		$offset = `0`
	)

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

Paramètres

string	$event	The event id.
integer	$limit	The number of objects per page.
integer	$offset	The object's number on the page.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $limit, et $offset.

◆ getEvent()

getEvent ( $event )

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

Paramètres

string $event The event id.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

◆ getFeed()

getFeed	(	$event,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

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

Paramètres

string	$event	The event 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.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $limit, et $offset.

◆ getInvited()

getInvited	(	$event,
		$limit = `0`,
		$offset = `0`
	)

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

Paramètres

string	$event	The event id.
integer	$limit	The number of objects per page.
integer	$offset	The object's number on the page.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $limit, et $offset.

◆ getMaybe()

getMaybe	(	$event,
		$limit = `0`,
		$offset = `0`
	)

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

Paramètres

string	$event	The event id.
integer	$limit	The number of objects per page.
integer	$offset	The object's number on the page.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $limit, et $offset.

◆ getNoreply()

getNoreply	(	$event,
		$limit = `0`,
		$offset = `0`
	)

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

Paramètres

string	$event	The event id.
integer	$limit	The number of objects per page.
integer	$offset	The object's number on the page.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $limit, et $offset.

◆ getPhotos()

getPhotos	(	$event,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

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

Paramètres

string	$event	The event 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.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $limit, et $offset.

◆ getPicture()

getPicture	(	$event,
		$redirect = `true`,
		$type = `null`
	)

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

Paramètres

string	$event	The event id.
boolean	$redirect	If false this will return the URL of the picture without a 302 redirect.
string	$type	To request a different photo use square \| small \| normal \| large.

Renvoie: string The URL to the event's profile picture.

Depuis: 3.2.0

Références $type.

◆ getVideos()

getVideos	(	$event,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

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

Paramètres

string	$event	The event 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.

Renvoie: mixed The decoded JSON response or false if the client is not authenticated.

Depuis: 3.2.0

Références $limit, et $offset.

◆ isAttending()

isAttending	(	$event,
		$user
	)

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

Paramètres

string	$event	The event id.
mixed	$user	Either an integer containing the user ID or a string containing the username.

Renvoie: array The decoded JSON response or an empty array if the user is not invited.

Depuis: 3.2.0

Références $user.

◆ isDeclined()

isDeclined	(	$event,
		$user
	)

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

Paramètres

string	$event	The event id.
mixed	$user	Either an integer containing the user ID or a string containing the username.

Renvoie: array The decoded JSON response or an empty array if the user is not invited.

Depuis: 3.2.0

Références $user.

◆ isInvited()

isInvited	(	$event,
		$user
	)

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

Paramètres

string	$event	The event id.
mixed	$user	Either an integer containing the user ID or a string containing the username.

Renvoie: array The decoded JSON response or an empty array if the user is not invited.

Depuis: 3.2.0

Références $user.

◆ isMaybe()

isMaybe	(	$event,
		$user
	)

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

Paramètres

string	$event	The event id.
mixed	$user	Either an integer containing the user ID or a string containing the username.

Renvoie: array The decoded JSON response or an empty array if the user is not invited.

Depuis: 3.2.0

Références $user.

◆ isNoreply()

isNoreply	(	$event,
		$user
	)

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

Paramètres

string	$event	The event id.
mixed	$user	Either an integer containing the user ID or a string containing the username.

Renvoie: array The decoded JSON response or an empty array if the user is not invited.

Depuis: 3.2.0

Références $user.

La documentation de cette classe a été générée à partir du fichier suivant :

joomla/facebook/event.php

Fonctions membres publiques

Membres hérités additionnels

Description détaillée

Documentation des fonctions membres

◆ createAttending()

◆ createDeclined()

◆ createInvite()

◆ createLink()

◆ createMaybe()

◆ createPhoto()

◆ createPost()

◆ createStatus()

◆ createVideo()

◆ deleteInvite()

◆ deleteLink()

◆ deletePost()

◆ deleteStatus()

◆ getAttending()

◆ getDeclined()

◆ getEvent()

◆ getFeed()

◆ getInvited()

◆ getMaybe()

◆ getNoreply()

◆ getPhotos()

◆ getPicture()

◆ getVideos()

◆ isAttending()

◆ isDeclined()

◆ isInvited()

◆ isMaybe()

◆ isNoreply()