Graphe d'héritage de JFacebookUser:

Fonctions membres publiques
	getUser ($user)

	getFriends ($user, $limit=0, $offset=0)

	getFriendRequests ($user, $limit=0, $offset=0, $until=null, $since=null)

	getFriendLists ($user, $limit=0, $offset=0, $until=null, $since=null)

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

	getHome ($user, $filter=null, $location=false, $limit=0, $offset=0, $until=null, $since=null)

	hasFriend ($currentUser, $user)

	getMutualFriends ($currentUser, $user, $limit=0, $offset=0)

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

	getFamily ($user, $limit=0, $offset=0)

	getNotifications ($user, $read=null, $limit=0, $offset=0, $until=null, $since=null)

	updateNotification ($notification)

	getPermissions ($user, $limit=0, $offset=0)

	deletePermission ($user, $permission='')

	getAlbums ($user, $limit=0, $offset=0, $until=null, $since=null)

	createAlbum ($user, $name, $description=null, $privacy=null)

	getCheckins ($user, $limit=0, $offset=0, $until=null, $since=null)

	createCheckin ($user, $place, $coordinates, $tags=null, $message=null, $link=null, $picture=null)

	getLikes ($user, $limit=0, $offset=0, $until=null, $since=null)

	likesPage ($user, $page)

	getEvents ($user, $limit=0, $offset=0, $until=null, $since=null)

	createEvent ($user, $name, $startTime, $endTime=null, $description=null, $location=null, $locationId=null, $privacyType=null)

	editEvent ($event, $name=null, $startTime=null, $endTime=null, $description=null, $location=null, $locationId=null, $privacyType=null)

	deleteEvent ($event)

	getGroups ($user, $limit=0, $offset=0)

	getLinks ($user, $limit=0, $offset=0, $until=null, $since=null)

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

	deleteLink ($link)

	getNotes ($user, $limit=0, $offset=0, $until=null, $since=null)

	createNote ($user, $subject, $message)

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

	createPhoto ($user, $source, $message=null, $place=null, $noStory=null)

	getPosts ($user, $location=false, $limit=0, $offset=0, $until=null, $since=null)

	createPost ($user, $message=null, $link=null, $picture=null, $name=null, $caption=null, $description=null, $actions=null, $place=null, $tags=null, $privacy=null, $objectAttachment=null)

	deletePost ($post)

	getStatuses ($user, $limit=0, $offset=0, $until=null, $since=null)

	createStatus ($user, $message)

	deleteStatus ($status)

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

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

	getTagged ($user, $limit=0, $offset=0, $until=null, $since=null)

	getActivities ($user, $limit=0, $offset=0, $until=null, $since=null)

	getBooks ($user, $limit=0, $offset=0, $until=null, $since=null)

	getInterests ($user, $limit=0, $offset=0, $until=null, $since=null)

	getMovies ($user, $limit=0, $offset=0, $until=null, $since=null)

	getTelevision ($user, $limit=0, $offset=0, $until=null, $since=null)

	getMusic ($user, $limit=0, $offset=0, $until=null, $since=null)

	getSubscribers ($user, $limit=0, $offset=0)

	getSubscribedTo ($user, $limit=0, $offset=0)

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 305.

Documentation des fonctions membres

◆ createAlbum()

createAlbum	(	$user,
		$name,
		$description = `null`,
		$privacy = `null`
	)

Method to create an album for a user. Requires authentication and publish_stream permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
string	$name	Album name.
string	$description	Album description.
string	$privacy	A JSON-encoded object that defines the privacy setting for the album.

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

Depuis: 3.2.0

Références $data, $description, $name, et $user.

◆ createCheckin()

createCheckin	(	$user,
		$place,
		$coordinates,
		$tags = `null`,
		$message = `null`,
		$link = `null`,
		$picture = `null`
	)

Method to create a checkin for a user. Requires authentication and publish_checkins permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
string	$place	Id of the Place Page.
string	$coordinates	A JSON-encoded string containing latitute and longitude.
string	$tags	Comma separated list of USER_IDs.
string	$message	A message to add to the checkin.
string	$link	A link to add to the checkin.
string	$picture	A picture to add to the checkin.

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

Depuis: 3.2.0

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

◆ createEvent()

createEvent	(	$user,
		$name,
		$startTime,
		$endTime = `null`,
		$description = `null`,
		$location = `null`,
		$locationId = `null`,
		$privacyType = `null`
	)

Method to create an event for a user. Requires authentication create_event permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
string	$name	Event name.
string	$startTime	Event start time as UNIX timestamp.
string	$endTime	Event end time as UNIX timestamp.
string	$description	Event description.
string	$location	Event location.
string	$locationId	Facebook Place ID of the place the Event is taking place.
string	$privacyType	Event privacy setting, a string containing 'OPEN' (default), 'CLOSED', or 'SECRET'.

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

Depuis: 3.2.0

Références $data, $description, $location, $name, $startTime, et $user.

◆ createLink()

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

Method to post a link on user's feed. Requires authentication and publish_stream permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $message, et $user.

◆ createNote()

createNote	(	$user,
		$subject,
		$message
	)

Method to create a note on the behalf of the user. Requires authentication and publish_stream permission, user_groups or friends_groups permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
string	$subject	The subject of the note.
string	$message	Note content.

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

Depuis: 3.2.0

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

◆ createPhoto()

createPhoto	(	$user,
		$source,
		$message = `null`,
		$place = `null`,
		$noStory = `null`
	)

Method to post a photo on user's wall. Requires authentication and publish_stream permission, user_groups or friends_groups permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
string	$source	Path to photo.
string	$message	Photo description.
string	$place	Facebook ID of the place associated with the photo.
boolean	$noStory	If set to 1, optionally suppresses the feed story that is automatically generated on a user’s profile when they upload a photo using your application.

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

Depuis: 3.2.0

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

◆ createPost()

createPost	(	$user,
		$message = `null`,
		$link = `null`,
		$picture = `null`,
		$name = `null`,
		$caption = `null`,
		$description = `null`,
		$actions = `null`,
		$place = `null`,
		$tags = `null`,
		$privacy = `null`,
		$objectAttachment = `null`
	)

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

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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.
string	$place	Facebook Page ID of the location associated with this Post.
string	$tags	Comma-separated list of Facebook IDs of people tagged in this Post. For example: 1207059,701732. You cannot specify this field without also specifying a place.
string	$privacy	Post privacy settings (can only be specified if the Timeline being posted on belongs to the User creating the Post).
string	$objectAttachment	Facebook ID for an existing picture in the User's photo albums to use as the thumbnail image. The User must be the owner of the photo, and the photo cannot be part of a message attachment.

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, $name, et $user.

◆ createStatus()

createStatus	(	$user,
		$message
	)

Method to post a status message on behalf of the user. Requires authentication publish_stream permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $message, et $user.

◆ createVideo()

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

Method to post a video on behalf of the user. Requires authentication and publish_stream permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
string	$source	Path to video.
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, $title, et $user.

◆ deleteEvent()

deleteEvent ( $event )

Method to delete an event. Note: you can only delete the event if it was created by the same app. Requires authentication create_event permission.

Paramètres

string $event Event ID.

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

Depuis: 3.2.0

◆ 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.

◆ deletePermission()

deletePermission	(	$user,
		$permission = `''`
	)

Method to revoke a specific permission on behalf of a user. Requires authentication.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
string	$permission	The permission to revoke. If none specified, then this will de-authorize the application completely.

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

Depuis: 3.2.0

Références $user.

◆ 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

Paramètres

string $post The Post ID.

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

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 publish_stream permission.

Paramètres

string $status The Status ID.

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

Depuis: 3.2.0

◆ editEvent()

editEvent	(	$event,
		$name = `null`,
		$startTime = `null`,
		$endTime = `null`,
		$description = `null`,
		$location = `null`,
		$locationId = `null`,
		$privacyType = `null`
	)

Method to edit an event. Requires authentication create_event permission.

Paramètres

mixed	$event	Event ID.
string	$name	Event name.
string	$startTime	Event start time as UNIX timestamp.
string	$endTime	Event end time as UNIX timestamp.
string	$description	Event description.
string	$location	Event location.
string	$locationId	Facebook Place ID of the place the Event is taking place.
string	$privacyType	Event privacy setting, a string containing 'OPEN' (default), 'CLOSED', or 'SECRET'.

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

Depuis: 3.2.0

Références $data, $description, $location, $name, $startTime, et null.

◆ getActivities()

getActivities	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the activities listed on the user's profile. Requires authentication and user_activities or friends_activities permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getAlbums()

getAlbums	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the user's albums. Requires authentication and user_photos or friends_photos permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getBooks()

getBooks	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the books listed on the user's profile. Requires authentication and user_likes or friends_likes permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getCheckins()

getCheckins	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the user's checkins. Requires authentication and user_checkins or friends_checkins permission

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getEvents()

getEvents	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the current user's events. Requires authentication and user_events or friends_events permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getFamily()

getFamily	(	$user,
		$limit = `0`,
		$offset = `0`
	)

Method to get the user's family relationships. Requires authentication and user_relationships permission..

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getFeed()

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

Method to get the user's wall. Requires authentication and read_stream permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getFriendLists()

getFriendLists	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the user's friend lists. Requires authentication and read_friendlists permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getFriendRequests()

getFriendRequests	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the user's incoming friend requests. Requires authentication and read_requests permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getFriends()

getFriends	(	$user,
		$limit = `0`,
		$offset = `0`
	)

Method to get the specified user's friends. Requires authentication.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getGroups()

getGroups	(	$user,
		$limit = `0`,
		$offset = `0`
	)

Method to get the groups that the user belongs to. Requires authentication and user_groups or friends_groups permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getHome()

getHome	(	$user,
		$filter = `null`,
		$location = `false`,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the user's news feed. Requires authentication and read_stream permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
string	$filter	User's stream filter.
boolean	$location	Retrieve only posts with a location attached.
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 $filter, $limit, $location, $offset, $user, et null.

◆ getInterests()

getInterests	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the interests listed on the user's profile. Requires authentication.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getLikes()

getLikes	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the user's likes. Requires authentication and user_likes or friends_likes permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getLinks()

getLinks	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the user's posted links. Requires authentication and user_groups or friends_groups permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getMovies()

getMovies	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the movies listed on the user's profile. Requires authentication and user_likes or friends_likes permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getMusic()

getMusic	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the music listed on the user's profile. Requires authentication user_likes or friends_likes permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getMutualFriends()

getMutualFriends	(	$currentUser,
		$user,
		$limit = `0`,
		$offset = `0`
	)

Method to get mutual friends of one user and the current user. Requires authentication.

Paramètres

mixed	$currentUser	Either an integer containing the user ID or a string containing the username for the current user.
mixed	$user	Either an integer containing the user ID or a string containing the username for the user.
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, $offset, et $user.

◆ getNotes()

getNotes	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the user's notes. Requires authentication and user_groups or friends_groups permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getNotifications()

getNotifications	(	$user,
		$read = `null`,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the user's notifications. Requires authentication and manage_notifications permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
boolean	$read	Enables you to see notifications that the user has already read.
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, $offset, et $user.

◆ getPermissions()

getPermissions	(	$user,
		$limit = `0`,
		$offset = `0`
	)

Method to get the user's permissions. Requires authentication.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getPhotos()

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

Method to get the user's photos. Requires authentication and user_groups or friends_groups permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getPicture()

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

Method to get the user's profile picture. Requires authentication.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
boolean	$redirect	If false this will return the URL of the profile picture without a 302 redirect.
string	$type	To request a different photo use square \| small \| normal \| large.

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

Depuis: 3.2.0

Références $type, $user, et null.

◆ getPosts()

getPosts	(	$user,
		$location = `false`,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the user's posts. Requires authentication and read_stream permission for non-public posts.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
boolean	$location	Retrieve only posts with a location attached.
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, $location, $offset, et $user.

◆ getStatuses()

getStatuses	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the user's statuses. Requires authentication read_stream permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getSubscribedTo()

getSubscribedTo	(	$user,
		$limit = `0`,
		$offset = `0`
	)

Method to get the people the user is subscribed to. Requires authentication and user_subscriptions or friends_subscriptions permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getSubscribers()

getSubscribers	(	$user,
		$limit = `0`,
		$offset = `0`
	)

Method to get the user's subscribers. Requires authentication and user_subscriptions or friends_subscriptions permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getTagged()

getTagged	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the posts the user has been tagged in. Requires authentication and user_videos or friends_videos permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getTelevision()

getTelevision	(	$user,
		$limit = `0`,
		$offset = `0`,
		$until = `null`,
		$since = `null`
	)

Method to get the television listed on the user's profile. Requires authentication and user_likes or friends_likes permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ getUser()

getUser ( $user )

Method to get the specified user's details. Authentication is required only for some fields.

Paramètres

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

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

Depuis: 3.2.0

Références $user.

◆ getVideos()

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

Method to get the videos the user has been tagged in. Requires authentication and user_videos or friends_videos permission.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
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, $offset, et $user.

◆ hasFriend()

hasFriend	(	$currentUser,
		$user
	)

Method to see if a user is a friend of the current user. Requires authentication.

Paramètres

mixed	$currentUser	Either an integer containing the user ID or a string containing the username for the current user.
mixed	$user	Either an integer containing the user ID or a string containing the username for the user.

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

Depuis: 3.2.0

Références $user.

◆ likesPage()

likesPage	(	$user,
		$page
	)

Method to see if a user likes a specific Page. Requires authentication.

Paramètres

mixed	$user	Either an integer containing the user ID or a string containing the username.
string	$page	Facebook ID of the Page.

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

Depuis: 3.2.0

Références $user.

◆ updateNotification()

updateNotification ( $notification )

Method to mark a notification as read. Requires authentication and manage_notifications permission.

Paramètres

string $notification The notification id.

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

Depuis: 3.2.0

Références $data, et null.

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

libraries/joomla/facebook/user.php

Fonctions membres publiques

Membres hérités additionnels

Description détaillée

Documentation des fonctions membres

◆ createAlbum()

◆ createCheckin()

◆ createEvent()

◆ createLink()

◆ createNote()

◆ createPhoto()

◆ createPost()

◆ createStatus()

◆ createVideo()

◆ deleteEvent()

◆ deleteLink()

◆ deletePermission()

◆ deletePost()

◆ deleteStatus()

◆ editEvent()

◆ getActivities()

◆ getAlbums()

◆ getBooks()

◆ getCheckins()

◆ getEvents()

◆ getFamily()

◆ getFeed()

◆ getFriendLists()

◆ getFriendRequests()

◆ getFriends()

◆ getGroups()

◆ getHome()

◆ getInterests()

◆ getLikes()

◆ getLinks()

◆ getMovies()

◆ getMusic()

◆ getMutualFriends()

◆ getNotes()

◆ getNotifications()

◆ getPermissions()

◆ getPhotos()

◆ getPicture()

◆ getPosts()

◆ getStatuses()

◆ getSubscribedTo()

◆ getSubscribers()

◆ getTagged()

◆ getTelevision()

◆ getUser()

◆ getVideos()

◆ hasFriend()

◆ likesPage()

◆ updateNotification()