public
mixed
|
#
getUser( mixed $user )
Method to get the specified user's details. Authentication is required only
for some fields.
Method to get the specified user's details. Authentication is required only
for some fields.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getFriends( mixed $user, integer $limit = 0, integer $offset = 0 )
Method to get the specified user's friends. Requires authentication.
Method to get the specified user's friends. Requires authentication.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getFriendRequests( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's incoming friend requests. Requires authentication
and read_requests permission.
Method to get the user's incoming friend requests. Requires authentication
and read_requests permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getFriendLists( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's friend lists. Requires authentication and
read_friendlists permission.
Method to get the user's friend lists. Requires authentication and
read_friendlists permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getFeed( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's wall. Requires authentication and read_stream
permission.
Method to get the user's wall. Requires authentication and read_stream
permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getHome( mixed $user, string $filter = null, boolean $location = false, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's news feed. Requires authentication and read_stream
permission.
Method to get the user's news feed. Requires authentication and read_stream
permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $filter
string - $filter User's stream filter.
- $location
boolean - $location Retreive only posts with a location attached.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
hasFriend( mixed $current_user, mixed $user )
Method to see if a user is a friend of the current user. Requires
authentication.
Method to see if a user is a friend of the current user. Requires
authentication.
Parameters
- $current_user
mixed - $current_user Either an integer containing the user ID or a string containing
the username for the current user.
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username for the user.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getMutualFriends( mixed $current_user, mixed $user, integer $limit = 0, integer $offset = 0 )
Method to get mutual friends of one user and the current user. Requires
authentication.
Method to get mutual friends of one user and the current user. Requires
authentication.
Parameters
- $current_user
mixed - $current_user Either an integer containing the user ID or a string containing
the username for the current user.
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username for the user.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
string
|
#
getPicture( mixed $user, boolean $redirect = true, string $type = null )
Method to get the user's profile picture. Requires authentication.
Method to get the user's profile picture. Requires authentication.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $redirect
boolean - $redirect If false this will return the URL of the profile picture without a 302
redirect.
- $type
string - $type To request a different photo use square | small | normal | large.
Returns
string - The URL to the user's profile picture.
Since
13.1
|
public
mixed
|
#
getFamily( mixed $user, integer $limit = 0, integer $offset = 0 )
Method to get the user's family relationships. Requires authentication and
user_relationships permission..
Method to get the user's family relationships. Requires authentication and
user_relationships permission..
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getNotifications( mixed $user, boolean $read = null, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's notifications. Requires authentication and
manage_notifications permission.
Method to get the user's notifications. Requires authentication and
manage_notifications permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $read
boolean - $read Enables you to see notifications that the user has already read.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
boolean
|
#
updateNotification( string $notification )
Method to mark a notification as read. Requires authentication and
manage_notifications permission.
Method to mark a notification as read. Requires authentication and
manage_notifications permission.
Parameters
- $notification
string - $notification The notification id.
Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
mixed
|
#
getPermissions( mixed $user, integer $limit = 0, integer $offset = 0 )
Method to get the user's permissions. Requires authentication.
Method to get the user's permissions. Requires authentication.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
deletePermission( mixed $user, string $permission = '' )
Method to revoke a specific permission on behalf of a user. Requires
authentication.
Method to revoke a specific permission on behalf of a user. Requires
authentication.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $permission
string - $permission The permission to revoke. If none specified, then this will
de-authorize the application completely.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getAlbums( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's albums. Requires authentication and user_photos or
friends_photos permission.
Method to get the user's albums. Requires authentication and user_photos or
friends_photos permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
createAlbum( mixed $user, string $name, string $description = null, json $privacy = null )
Method to create an album for a user. Requires authentication and
publish_stream permission.
Method to create an album for a user. Requires authentication and
publish_stream permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $name
string - $name Album name.
- $description
string - $description Album description.
- $privacy
json - $privacy A JSON-encoded object that defines the privacy setting for the album.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getCheckins( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's checkins. Requires authentication and user_checkins
or friends_checkins permission
Method to get the user's checkins. Requires authentication and user_checkins
or friends_checkins permission
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
createCheckin( mixed $user, string $place, string $coordinates, string $tags = null, string $message = null, string $link = null, string $picture = null )
Method to create a checkin for a user. Requires authentication and
publish_checkins permission.
Method to create a checkin for a user. Requires authentication and
publish_checkins permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $place
string - $place Id of the Place Page.
- $coordinates
string - $coordinates A JSON-encoded string containing latitute and longitude.
- $tags
string - $tags Comma separated list of USER_IDs.
- $message
string - $message A message to add to the checkin.
- $link
string - $link A link to add to the checkin.
- $picture
string - $picture A picture to add to the checkin.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getLikes( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's likes. Requires authentication and user_likes or
friends_likes permission.
Method to get the user's likes. Requires authentication and user_likes or
friends_likes permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
likesPage( mixed $user, string $page )
Method to see if a user likes a specific Page. Requires authentication.
Method to see if a user likes a specific Page. Requires authentication.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $page
string - $page Facebook ID of the Page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getEvents( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the current user's events. Requires authentication and
user_events or friends_events permission.
Method to get the current user's events. Requires authentication and
user_events or friends_events permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
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 )
Method to create an event for a user. Requires authentication create_event
permission.
Method to create an event for a user. Requires authentication create_event
permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $name
string - $name Event name.
- $start_time
string - $start_time Event start time as UNIX timestamp.
- $end_time
string - $end_time Event end time as UNIX timestamp.
- $description
string - $description Event description.
- $location
string - $location Event location.
- $location_id
string - $location_id Facebook Place ID of the place the Event is taking place.
- $privacy_type
string - $privacy_type Event privacy setting, a string containing 'OPEN' (default),
'CLOSED', or 'SECRET'.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
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 )
Method to edit an event. Requires authentication create_event permission.
Method to edit an event. Requires authentication create_event permission.
Parameters
- $event
mixed - $event Event ID.
- $name
string - $name Event name.
- $start_time
string - $start_time Event start time as UNIX timestamp.
- $end_time
string - $end_time Event end time as UNIX timestamp.
- $description
string - $description Event description.
- $location
string - $location Event location.
- $location_id
string - $location_id Facebook Place ID of the place the Event is taking place.
- $privacy_type
string - $privacy_type Event privacy setting, a string containing 'OPEN' (default),
'CLOSED', or 'SECRET'.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
boolean
|
#
deleteEvent( string $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.
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.
Parameters
- $event
string - $event Event ID.
Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
mixed
|
#
getGroups( mixed $user, integer $limit = 0, integer $offset = 0 )
Method to get the groups that the user belongs to. Requires authentication
and user_groups or friends_groups permission.
Method to get the groups that the user belongs to. Requires authentication
and user_groups or friends_groups permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getLinks( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's posted links. Requires authentication and
user_groups or friends_groups permission.
Method to get the user's posted links. Requires authentication and
user_groups or friends_groups permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
createLink( mixed $user, string $link, strin $message = null )
Method to post a link on user's feed. Requires authentication and
publish_stream permission.
Method to post a link on user's feed. Requires authentication and
publish_stream permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $link
string - $link Link URL.
- $message
strin - $message Link message.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
boolean
|
#
deleteLink( mixed $link )
Method to delete a link. Requires authentication and publish_stream
permission.
Method to delete a link. Requires authentication and publish_stream
permission.
Parameters
- $link
mixed - $link The Link ID.
Returns
boolean - Returns true if successful, and false otherwise.
Since
13.1
|
public
mixed
|
#
getNotes( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's notes. Requires authentication and user_groups or
friends_groups permission.
Method to get the user's notes. Requires authentication and user_groups or
friends_groups permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
createNote( mixed $user, string $subject, string $message )
Method to create a note on the behalf of the user. Requires authentication
and publish_stream permission, user_groups or friends_groups permission.
Method to create a note on the behalf of the user. Requires authentication
and publish_stream permission, user_groups or friends_groups permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $subject
string - $subject The subject of the note.
- $message
string - $message Note content.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getPhotos( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's photos. Requires authentication and user_groups or
friends_groups permission.
Method to get the user's photos. Requires authentication and user_groups or
friends_groups permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
createPhoto( mixed $user, string $source, string $message = null, string $place = null, boolean $no_story = null )
Method to post a photo on user's wall. Requires authentication and
publish_stream permission, user_groups or friends_groups permission.
Method to post a photo on user's wall. Requires authentication and
publish_stream permission, user_groups or friends_groups permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $source
string - $source Path to photo.
- $message
string - $message Photo description.
- $place
string - $place Facebook ID of the place associated with the photo.
- $no_story
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.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getPosts( mixed $user, boolean $location = false, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's posts. Requires authentication and read_stream
permission for non-public posts.
Method to get the user's posts. Requires authentication and read_stream
permission for non-public posts.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $location
boolean - $location Retreive only posts with a location attached.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
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 )
Method to post on a user's wall. Message or link parameter is required.
Requires authentication and publish_stream permission.
Method to post on a user's wall. Message or link parameter is required.
Requires authentication and publish_stream permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $message
string - $message Post message.
- $link
string - $link Post URL.
- $picture
string - $picture Post thumbnail image (can only be used if link is specified)
- $name
string - $name Post name (can only be used if link is specified).
- $caption
string - $caption Post caption (can only be used if link is specified).
- $description
string - $description Post description (can only be used if link is specified).
- $actions
array - $actions Post actions array of objects containing name and link.
- $place
string - $place Facebook Page ID of the location associated with this Post.
- $tags
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.
- $privacy
string - $privacy Post privacy settings (can only be specified if the Timeline being
posted on belongs to the User creating the Post).
- $object_attachment
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.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
deletePost( string $post )
Method to delete a post. Note: you can only delete the post if it was created
by the current user. Requires authentication
Method to delete a post. Note: you can only delete the post if it was created
by the current user. Requires authentication
Parameters
- $post
string - $post The Post ID.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getStatuses( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the user's statuses. Requires authentication read_stream
permission.
Method to get the user's statuses. Requires authentication read_stream
permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
createStatus( mixed $user, string $message )
Method to post a status message on behalf of the user. Requires
authentication publish_stream permission.
Method to post a status message on behalf of the user. Requires
authentication publish_stream permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $message
string - $message Status message content.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
deleteStatus( string $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.
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.
Parameters
- $status
string - $status The Status ID.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getVideos( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the videos the user has been tagged in. Requires authentication
and user_videos or friends_videos permission.
Method to get the videos the user has been tagged in. Requires authentication
and user_videos or friends_videos permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
createVideo( mixed $user, string $source, string $title = null, string $description = null )
Method to post a video on behalf of the user. Requires authentication and
publish_stream permission.
Method to post a video on behalf of the user. Requires authentication and
publish_stream permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $source
string - $source Path to video.
- $title
string - $title Video title.
- $description
string - $description Video description.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getTagged( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the posts the user has been tagged in. Requires authentication
and user_videos or friends_videos permission.
Method to get the posts the user has been tagged in. Requires authentication
and user_videos or friends_videos permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getActivities( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the activities listed on the user's profile. Requires
authentication and user_activities or friends_activities permission.
Method to get the activities listed on the user's profile. Requires
authentication and user_activities or friends_activities permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getBooks( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the books listed on the user's profile. Requires authentication
and user_likes or friends_likes permission.
Method to get the books listed on the user's profile. Requires authentication
and user_likes or friends_likes permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getInterests( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the interests listed on the user's profile. Requires
authentication.
Method to get the interests listed on the user's profile. Requires
authentication.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getMovies( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the movies listed on the user's profile. Requires
authentication and user_likes or friends_likes permission.
Method to get the movies listed on the user's profile. Requires
authentication and user_likes or friends_likes permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getTelevision( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the television listed on the user's profile. Requires
authentication and user_likes or friends_likes permission.
Method to get the television listed on the user's profile. Requires
authentication and user_likes or friends_likes permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getMusic( mixed $user, integer $limit = 0, integer $offset = 0, string $until = null, string $since = null )
Method to get the music listed on the user's profile. Requires authentication
user_likes or friends_likes permission.
Method to get the music listed on the user's profile. Requires authentication
user_likes or friends_likes permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
- $until
string - $until A unix timestamp or any date accepted by strtotime.
- $since
string - $since A unix timestamp or any date accepted by strtotime.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getSubscribers( mixed $user, integer $limit = 0, integer $offset = 0 )
Method to get the user's subscribers. Requires authentication and
user_subscriptions or friends_subscriptions permission.
Method to get the user's subscribers. Requires authentication and
user_subscriptions or friends_subscriptions permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|
public
mixed
|
#
getSubscribedTo( mixed $user, integer $limit = 0, integer $offset = 0 )
Method to get the people the user is subscribed to. Requires authentication
and user_subscriptions or friends_subscriptions permission.
Method to get the people the user is subscribed to. Requires authentication
and user_subscriptions or friends_subscriptions permission.
Parameters
- $user
mixed - $user Either an integer containing the user ID or a string containing the
username.
- $limit
integer - $limit The number of objects per page.
- $offset
integer - $offset The object's number on the page.
Returns
mixed - The decoded JSON response or false if the client is not authenticated.
Since
13.1
|