Graphe d'héritage de JFacebookEvent:

Graphe de collaboration 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 inherited from JFacebookObject
	__construct (JRegistry $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, $extra_fields= '', $limit=0, $offset=0, $until=null, $since=null)
	createConnection ($object, $connection=null, $parameters=null, array $headers=null)
	deleteConnection ($object, $connection=null, $extra_fields= '')
	setOAuth ($oauth)
	getOAuth ()

Additional Inherited Members
Fonctions membres protégées inherited from JFacebookObject
	fetchUrl ($path, $limit=0, $offset=0, $until=null, $since=null)
Attributs protégés inherited from JFacebookObject
	$options
	$client
	$oauth

Description détaillée

Définition à la ligne 22 du fichier event.php.

Documentation des fonctions membres

JFacebookEvent::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:: 13.1

Définition à la ligne 278 du fichier event.php.

        {
                return $this->createConnection($event, 'attending');
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 368 du fichier event.php.

        {
                return $this->createConnection($event, 'declined');
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 213 du fichier event.php.

        {
                // Set POST request parameters.
                $data = array();
                $data['users'] = $users;
                return $this->createConnection($event, 'invited', $data);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 67 du fichier event.php.

        {
                // Set POST request parameters.
                $data = array();
                $data['link'] = $link;
                $data['message'] = $message;
                return $this->createConnection($event, 'feed', $data);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 323 du fichier event.php.

        {
                return $this->createConnection($event, 'maybe');
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 461 du fichier event.php.

        {
                // Set POST request parameters.
                $data = array();
                $data[basename($source)] = '@' . realpath($source);
                if ($message)
                {
                        $data['message'] = $message;
                }
                return $this->createConnection($event, 'photos', $data, array('Content-Type' => 'multipart/form-data'));
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 107 du fichier event.php.

        {
                // Set POST request parameters.
                $data = array();
                $data['message'] = $message;
                $data['link'] = $link;
                $data['name'] = $name;
                $data['caption'] = $caption;
                $data['description'] = $description;
                $data['actions'] = $actions;
                $data['picture'] = $picture;
                return $this->createConnection($event, 'feed', $data);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 148 du fichier event.php.

        {
                // Set POST request parameters.
                $data = array();
                $data['message'] = $message;
                return $this->createConnection($event, 'feed', $data);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 505 du fichier event.php.

        {
                // Set POST request parameters.
                $data = array();
                $data[basename($source)] = '@' . realpath($source);
                if ($title)
                {
                        $data['title'] = $title;
                }
                if ($description)
                {
                        $data['description'] = $description;
                }
                return $this->createConnection($event, 'videos', $data, array('Content-Type' => 'multipart/form-data'));
        }

JFacebookEvent::deleteInvite	(	$event,
		$user
	)

Method to delete a 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:: 13.1

Définition à la ligne 233 du fichier event.php.

        {
                return $this->deleteConnection($event, 'invited/' . $user);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 86 du fichier event.php.

        {
                return $this->deleteConnection($link);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 133 du fichier event.php.

        {
                return $this->deleteConnection($post);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 167 du fichier event.php.

        {
                return $this->deleteConnection($status);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 249 du fichier event.php.

        {
                return $this->getConnection($event, 'attending', '', $limit, $offset);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 339 du fichier event.php.

        {
                return $this->getConnection($event, 'declined', '', $limit, $offset);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 33 du fichier event.php.

        {
                return $this->get($event);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 51 du fichier event.php.

        {
                return $this->getConnection($event, 'feed', '', $limit, $offset, $until, $since);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 183 du fichier event.php.

        {
                return $this->getConnection($event, 'invited', '', $limit, $offset);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 294 du fichier event.php.

        {
                return $this->getConnection($event, 'maybe', '', $limit, $offset);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 384 du fichier event.php.

        {
                return $this->getConnection($event, 'noreply', '', $limit, $offset);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 445 du fichier event.php.

        {
                return $this->getConnection($event, 'photos', '', $limit, $offset, $until, $since);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 415 du fichier event.php.

        {
                $extra_fields = '';
                if ($redirect == false)
                {
                        $extra_fields = '?redirect=false';
                }
                if ($type)
                {
                        $extra_fields .= (strpos($extra_fields, '?') === false) ? '?type=' . $type : '&type=' . $type;
                }
                return $this->getConnection($event, 'picture', $extra_fields);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 488 du fichier event.php.

        {
                return $this->getConnection($event, 'videos', '', $limit, $offset, $until, $since);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 264 du fichier event.php.

        {
                return $this->getConnection($event, 'attending/' . $user);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 354 du fichier event.php.

        {
                return $this->getConnection($event, 'declined/' . $user);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 198 du fichier event.php.

        {
                return $this->getConnection($event, 'invited/' . $user);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 309 du fichier event.php.

        {
                return $this->getConnection($event, 'maybe/' . $user);
        }

JFacebookEvent::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:: 13.1

Définition à la ligne 399 du fichier event.php.

        {
                return $this->getConnection($event, 'noreply/' . $user);
        }

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

jplatform-13.1/joomla/facebook/event.php

Fonctions membres publiques

Additional Inherited Members

Description détaillée

Documentation des fonctions membres