Class JFacebookUser

Description
Description | Vars | Methods (details)

Facebook API User class for the Joomla Platform.

Located in /libraries/joomla/facebook/user.php (line 23) 

JFacebookObject
   |
   --JFacebookUser
Method Summary
Description | Vars | Methods (details)
mixed createAlbum (mixed $user, string $name, [string $description = null], [json $privacy = null])
mixed createCheckin (mixed $user, string $place, string $coordinates, [string $tags = null], [string $message = null], [string $link = null], [string $picture = null])
mixed createEvent (mixed $user, string $name, string $start_time, [string $end_time = null], [string $description = null], [string $location = null], [string $location_id = null], [string $privacy_type = null])
mixed createLink (mixed $user, string $link, [strin $message = null])
mixed createNote (mixed $user, string $subject, string $message)
mixed createPhoto (mixed $user, string $source, [string $message = null], [string $place = null], [boolean $no_story = null])
mixed createPost (mixed $user, [string $message = null], [string $link = null], [string $picture = null], [string $name = null], [string $caption = null], [string $description = null], [array $actions = null], [string $place = null], [string $tags = null], [string $privacy = null], [string $object_attachment = null])
mixed createStatus (mixed $user, string $message)
mixed createVideo (mixed $user, string $source, [string $title = null], [string $description = null])
boolean deleteEvent (string $event)
boolean deleteLink (mixed $link)
mixed deletePermission (mixed $user, [string $permission = ''])
mixed deletePost (string $post)
mixed deleteStatus (string $status)
mixed editEvent (mixed $event, [string $name = null], [string $start_time = null], [string $end_time = null], [string $description = null], [string $location = null], [string $location_id = null], [string $privacy_type = null])
mixed getActivities (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getAlbums (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getBooks (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getCheckins (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getEvents (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getFamily (mixed $user, [integer $limit = 0], [integer $offset = 0])
mixed getFeed (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getFriendLists (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getFriendRequests (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getFriends (mixed $user, [integer $limit = 0], [integer $offset = 0])
mixed getGroups (mixed $user, [integer $limit = 0], [integer $offset = 0])
mixed getHome (mixed $user, [string $filter = null], [boolean $location = false], [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getInterests (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getLikes (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getLinks (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getMovies (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getMusic (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getMutualFriends (mixed $current_user, mixed $user, [integer $limit = 0], [integer $offset = 0])
mixed getNotes (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getNotifications (mixed $user, [boolean $read = null], [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getPermissions (mixed $user, [integer $limit = 0], [integer $offset = 0])
mixed getPhotos (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
string getPicture (mixed $user, [boolean $redirect = true], [string $type = null])
mixed getPosts (mixed $user, [boolean $location = false], [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getStatuses (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getSubscribedTo (mixed $user, [integer $limit = 0], [integer $offset = 0])
mixed getSubscribers (mixed $user, [integer $limit = 0], [integer $offset = 0])
mixed getTagged (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getTelevision (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed getUser (mixed $user)
mixed getVideos (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
mixed hasFriend (mixed $current_user, mixed $user)
mixed likesPage (mixed $user, string $page)
boolean updateNotification (string $notification)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JFacebookObject

JFacebookObject::$client
 JFacebookObject::$oauth
 JFacebookObject::$options
Methods
Description | Vars Methods (details)
createAlbum (line 319)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createAlbum (mixed $user, string $name, [string $description = null], [json $privacy = null])
  • mixed $user: Either an integer containing the user ID or a string containing the username.
  • string $name: Album name.
  • string $description: Album description.
  • json $privacy: A JSON-encoded object that defines the privacy setting for the album.
createCheckin (line 363)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createCheckin (mixed $user, string $place, string $coordinates, [string $tags = null], [string $message = null], [string $link = null], [string $picture = null])
  • 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.
createEvent (line 444)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createEvent (mixed $user, string $name, string $start_time, [string $end_time = null], [string $description = null], [string $location = null], [string $location_id = null], [string $privacy_type = null])
  • mixed $user: Either an integer containing the user ID or a string containing the username.
  • string $name: Event name.
  • string $start_time: Event start time as UNIX timestamp.
  • string $end_time: Event end time as UNIX timestamp.
  • string $description: Event description.
  • string $location: Event location.
  • string $location_id: Facebook Place ID of the place the Event is taking place.
  • string $privacy_type: Event privacy setting, a string containing 'OPEN' (default), 'CLOSED', or 'SECRET'.
createLink (line 551)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createLink (mixed $user, string $link, [strin $message = null])
  • mixed $user: Either an integer containing the user ID or a string containing the username.
  • string $link: Link URL.
  • strin $message: Link message.
createNote (line 605)

Method to create a note on the behalf of the user.

Requires authentication and publish_stream permission, user_groups or friends_groups permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createNote (mixed $user, string $subject, string $message)
  • 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.
createPhoto (line 647)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createPhoto (mixed $user, string $source, [string $message = null], [string $place = null], [boolean $no_story = null])
  • 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 $no_story: 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.
createPost (line 707)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createPost (mixed $user, [string $message = null], [string $link = null], [string $picture = null], [string $name = null], [string $caption = null], [string $description = null], [array $actions = null], [string $place = null], [string $tags = null], [string $privacy = null], [string $object_attachment = null])
  • 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 $object_attachment: 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.
createStatus (line 769)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createStatus (mixed $user, string $message)
  • mixed $user: Either an integer containing the user ID or a string containing the username.
  • string $message: Status message content.
createVideo (line 823)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed createVideo (mixed $user, string $source, [string $title = null], [string $description = null])
  • 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.
deleteEvent (line 501)

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.

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteEvent (string $event)
  • string $event: Event ID.
deleteLink (line 570)

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

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean deleteLink (mixed $link)
  • mixed $link: The Link ID.
deletePermission (line 284)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed deletePermission (mixed $user, [string $permission = ''])
  • 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.
deletePost (line 736)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed deletePost (string $post)
  • string $post: The Post ID.
deleteStatus (line 788)

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.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed deleteStatus (string $status)
  • string $status: The Status ID.
editEvent (line 476)

Method to edit an event. Requires authentication create_event permission.

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed editEvent (mixed $event, [string $name = null], [string $start_time = null], [string $end_time = null], [string $description = null], [string $location = null], [string $location_id = null], [string $privacy_type = null])
  • mixed $event: Event ID.
  • string $name: Event name.
  • string $start_time: Event start time as UNIX timestamp.
  • string $end_time: Event end time as UNIX timestamp.
  • string $description: Event description.
  • string $location: Event location.
  • string $location_id: Facebook Place ID of the place the Event is taking place.
  • string $privacy_type: Event privacy setting, a string containing 'OPEN' (default), 'CLOSED', or 'SECRET'.
getActivities (line 865)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getActivities (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getAlbums (line 302)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getAlbums (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getBooks (line 883)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getBooks (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getCheckins (line 343)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getCheckins (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getEvents (line 423)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getEvents (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getFamily (line 212)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getFamily (mixed $user, [integer $limit = 0], [integer $offset = 0])
  • 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.
getFeed (line 104)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getFeed (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getFriendLists (line 86)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getFriendLists (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getFriendRequests (line 68)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getFriendRequests (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getFriends (line 50)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getFriends (mixed $user, [integer $limit = 0], [integer $offset = 0])
  • 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.
getGroups (line 517)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getGroups (mixed $user, [integer $limit = 0], [integer $offset = 0])
  • 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.
getHome (line 124)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getHome (mixed $user, [string $filter = null], [boolean $location = false], [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • mixed $user: Either an integer containing the user ID or a string containing the username.
  • string $filter: User's stream filter.
  • boolean $location: Retreive 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.
getInterests (line 901)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getInterests (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getLikes (line 390)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getLikes (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getLinks (line 535)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getLinks (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getMovies (line 919)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getMovies (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getMusic (line 955)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getMusic (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getMutualFriends (line 168)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getMutualFriends (mixed $current_user, mixed $user, [integer $limit = 0], [integer $offset = 0])
  • mixed $current_user: 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.
getNotes (line 588)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getNotes (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getNotifications (line 231)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getNotifications (mixed $user, [boolean $read = null], [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getPermissions (line 269)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getPermissions (mixed $user, [integer $limit = 0], [integer $offset = 0])
  • 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.
getPhotos (line 628)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getPhotos (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getPicture (line 184)

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

  • return: The URL to the user's profile picture.
  • since: 13.1
  • access: public
string getPicture (mixed $user, [boolean $redirect = true], [string $type = null])
  • 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.
getPosts (line 673)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getPosts (mixed $user, [boolean $location = false], [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • mixed $user: Either an integer containing the user ID or a string containing the username.
  • boolean $location: Retreive 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.
getStatuses (line 754)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getStatuses (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getSubscribedTo (line 987)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getSubscribedTo (mixed $user, [integer $limit = 0], [integer $offset = 0])
  • 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.
getSubscribers (line 971)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getSubscribers (mixed $user, [integer $limit = 0], [integer $offset = 0])
  • 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.
getTagged (line 847)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getTagged (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getTelevision (line 937)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getTelevision (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
getUser (line 34)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getUser (mixed $user)
  • mixed $user: Either an integer containing the user ID or a string containing the username.
getVideos (line 806)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed getVideos (mixed $user, [integer $limit = 0], [integer $offset = 0], [string $until = null], [string $since = null])
  • 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.
hasFriend (line 151)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed hasFriend (mixed $current_user, mixed $user)
  • mixed $current_user: 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.
likesPage (line 405)

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

  • return: The decoded JSON response or false if the client is not authenticated.
  • since: 13.1
  • access: public
mixed likesPage (mixed $user, string $page)
  • mixed $user: Either an integer containing the user ID or a string containing the username.
  • string $page: Facebook ID of the Page.
updateNotification (line 251)

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

  • return: Returns true if successful, and false otherwise.
  • since: 13.1
  • access: public
boolean updateNotification (string $notification)
  • string $notification: The notification id.

Inherited Methods

Inherited From JFacebookObject

JFacebookObject::__construct()
JFacebookObject::createConnection()
JFacebookObject::deleteConnection()
JFacebookObject::fetchUrl()
JFacebookObject::get()
JFacebookObject::getConnection()
JFacebookObject::getOAuth()
JFacebookObject::sendRequest()
JFacebookObject::setOAuth()

Documentation generated on Tue, 19 Nov 2013 15:16:32 +0100 by phpDocumentor 1.4.3