Class FacebookRestClient
Located in /sources/facebook/facebookapi_php5_restlib.php (line 65)
- $sxml
Create the client.
- string $session_key: if you haven't gotten a session key yet, leave this as null and then set it later by just directly accessing the $session_key member variable.
- $api_key
- $secret
Bans a list of users from the app. Banned users can't access the app's canvas page and forums.
- array $uids: an array of user ids
Returns the allocation limit value for a specified integration point name Integration point names are defined in lib/api/karma/constants.php in the limit_map.
- string $integration_point_name: Name of an integration point (see developer wiki for list).
- int $uid: Specific user to check the limit.
Get the properties that you have set for an app.
- properties $properties: List of properties names to fetch
Gets the list of users that have been banned from the application.
$uids is an optional parameter that filters the result with the list of provided user ids. If $uids is provided, only banned user ids that are contained in $uids are returned.
- array $uids: an array of user ids to filter by
Returns values for the specified metrics for the current application, in the given time range. The metrics are collected for fixed-length periods, and the times represent midnight at the end of each period.
- start_time $start_time: unix time for the start of the range
- end_time $end_time: unix time for the end of the range
- period $period: number of seconds in the desired period
- metrics $metrics: list of metrics to look up
Gets application restriction info.
Applications can restrict themselves to only a limited user demographic based on users' age and/or location or based on static predefined types specified by facebook for specifying diff age restriction for diff locations.
Set properties for an app.
- properties $properties: A map from property names to values
Sets application restriction info.
Applications can restrict themselves to only a limited user demographic based on users' age and/or location or based on static predefined types specified by facebook for specifying diff age restriction for diff locations.
- array $restriction_info: The age restriction settings to set.
Unban users that have been previously banned with admin_banUsers().
- array $uids: an array of user ids
Returns public information for an application (as shown in the application directory) by either application ID, API key, or canvas page name.
- int $application_id: (Optional) app id
- string $application_api_key: (Optional) api key
-
string
$application_canvas_name:
(Optional) canvas name
Exactly one argument must be specified, otherwise it is an error.
Creates an authentication token to be used as part of the desktop login flow. For more information, please see http://wiki.developers.facebook.com/index.php/Auth.createToken.
Expires the session that is currently being used. If this call is successful, no further calls to the API (which require a session) can be made until a valid session is created.
Get public key that is needed to verify digital signature an app may pass to other apps. The public key is only used by other apps for verification purposes.
- string $target_app_key: API key of an app
Returns the session information available after current user logs in.
- string $auth_token: the token returned by auth_createToken or passed back to your callback_url.
- bool $generate_session_secret: whether the session returned should include a session secret
Get a structure that can be passed to another app as proof of session. The other app can verify it using public key of this app.
Generates a session-specific secret. This is for integration with client-side API calls, such as the JS library.
Revokes the user's agreement to the Facebook Terms of Service for your
application. If you call this method for one of your users, you will no longer be able to make API requests on their behalf until they again authorize your application. Use with care. Note that if this method is called without a user parameter, then it will revoke access for the current session's user.
- int $uid: (Optional) User to revoke
Revokes the given extended permission that the user granted at some prior time (for instance, offline_access or email). If no user is provided, it will be revoked for the user of the current session.
- string $perm: The permission to revoke
- int $uid: The user for whom to revoke the permission.
Start a batch operation.
- $permissions_apikey
Calls the specified normal POST method with the specified parameters.
- string $method: Name of the Facebook method to invoke
- array $params: A map of param names => param values
Calls the specified file-upload POST method with the specified parameters
- string $method: Name of the Facebook method to invoke
- array $params: A map of param names => param values
- string $file: A path to the file to upload (required)
- $server_addr
Add a comment to a particular xid on behalf of a user. If called without an app_secret (with session secret), this will only work for the session user.
- string $xid: external id associated with the comments
- string $text: text of the comment
- int $uid: user adding the comment (def: session user)
- string $title: optional title for the stream story
- string $url: optional url for the stream story
- bool $publish_to_stream: publish a feed story about this comment? a link will be generated to title/url in the story
Gets the comments for a particular xid. This is essentially a wrapper around the comment FQL table.
- string $xid: external id associated with the comments
Remove a particular comment.
- string $xid: the external id associated with the comments
- string $comment_id: id of the comment to remove (returned by comments.add and comments.get)
Returns the number of unconnected friends that exist in this application.
This number is determined based on the accounts registered through connect.registerUsers() (see below).
This method is used to create an association between an external user account and a Facebook user account, as per Facebook Connect.
This method takes an array of account data, including a required email_hash and optional account data. For each connected account, if the user exists, the information is added to the set of the user's connected accounts. If the user has already authorized the site, the connected account is added in the confirmed state. If the user has not yet authorized the site, the connected account is added in the pending state.
This is designed to help Facebook Connect recognize when two Facebook friends are both members of a external site, but perhaps are not aware of it. The Connect dialog (see fb:connect-form) is used when friends can be identified through these email hashes. See the following url for details:
http://wiki.developers.facebook.com/index.php/Connect.registerUsers
- mixed $accounts: A (JSON-encoded) array of arrays, where each array has three properties: 'email_hash' (req) - public email hash of account 'account_id' (opt) - remote account id; 'account_url' (opt) - url to remote account;
Unregisters a set of accounts registered using connect.registerUsers.
- array $email_hashes: The (JSON-encoded) list of email hashes to be unregistered.
- $data
- $method
- $params
- $xml
- $method
- $params
execute a curl transaction -- this exists mostly so subclasses can add extra options and/or process the response, if they wish.
- resource $ch: a curl handle
Create a new object.
- obj_type $obj_type: object type's name
- properties $properties: (optional) properties to set initially
Create a new object type.
- name $name: object type's name
Define an object association.
- name $name: name of this association
- assoc_type $assoc_type: 1: one-way 2: two-way symmetric 3: two-way asymmetric
- assoc_info1 $assoc_info1: needed info about first object type
- assoc_info2 $assoc_info2: needed info about second object type
- inverse $inverse: (optional) name of reverse association
Add a new property to an object type.
- obj_type $obj_type: object type's name
- prop_name $prop_name: name of the property to add
- prop_type $prop_type: 1: integer; 2: string; 3: text blob
Delete an existing object.
- obj_id $obj_id: object's id
Delete a list of objects.
- obj_ids $obj_ids: objects to delete
Delete an object type.
- obj_type $obj_type: object type's name
Count associated objects.
- name $name: name of association
- obj_id $obj_id: who's association to retrieve
Get a list of associated object counts.
- name $name: name of association
- obj_ids $obj_ids: whose association to retrieve
Retrieve a list of associated objects.
- name $name: name of association
- obj_id $obj_id: who's association to retrieve
- no_data $no_data: only return object ids
Get definition of an object association.
- name $name: name of this association
Get definition of all associations.
Find all associations between two objects.
- obj_id1 $obj_id1: id of first object
- obj_id2 $obj_id2: id of second object
- no_data $no_data: only return association names without data
Returns cookies according to the filters specified.
- int $uid: User for which the cookies are needed.
- string $name: (Optional) A null parameter will get all cookies for the user.
Read hash value by key.
- obj_type $obj_type: object type's name
- key $key: hash key
- prop_name $prop_name: (optional) individual property's name
Get properties of an object.
- obj_id $obj_id: object's id
- prop_names $prop_names: (optional) properties to return; null for all.
Get a single property value of an object.
- obj_id $obj_id: object's id
- prop_name $prop_name: individual property's name
Get properties of a list of objects.
- obj_ids $obj_ids: object ids
- prop_names $prop_names: (optional) properties to return; null for all.
Get definitions of all properties of an object type.
- obj_type $obj_type: object type's name
Retrieve a list of all object types that have defined for the application.
Get a user preference.
- pref_id $pref_id: preference identifier (0-200)
- uid $uid: the user id (defaults to current session user)
Get a user preference.
- uid $uid: the user id (defaults to current session user)
Increase a hash value by specified increment atomically.
- obj_type $obj_type: object type's name
- key $key: hash key
- prop_name $prop_name: individual property's name
- increment $increment: (optional) default is 1
Remove associations between objects by specifying one object id.
- name $name: name of association
- obj_id $obj_id: who's association to remove
Remove an association between two objects.
- name $name: name of association
- obj_id1 $obj_id1: id of first object
- obj_id2 $obj_id2: id of second object
Remove associations between objects by specifying pairs of object ids.
- assocs $assocs: associations to remove
- name $name: (optional) name of association
Remove a hash key and its values.
- obj_type $obj_type: object type's name
- key $key: hash key
Remove hash keys and their values.
- obj_type $obj_type: object type's name
- keys $keys: hash keys
Rename an object association or aliases.
- name $name: name of this association
- new_name $new_name: (optional) new name of this association
- new_alias1 $new_alias1: (optional) new alias for object type 1
- new_alias2 $new_alias2: (optional) new alias for object type 2
Rename a previously defined property of an object type.
- obj_type $obj_type: object type's name
- prop_name $prop_name: name of the property to rename
- new_name $new_name: new name to use
Rename an object type.
- obj_type $obj_type: object type's name
- new_name $new_name: new object type's name
Create or modify an association between two objects.
- name $name: name of association
- obj_id1 $obj_id1: id of first object
- obj_id2 $obj_id2: id of second object
- data $data: (optional) extra string data to store
- assoc_time $assoc_time: (optional) extra time data; default to creation time
Create or modify associations between objects.
- assocs $assocs: associations to set
- name $name: (optional) name of association
Sets cookies according to the params specified.
- int $uid: User for which the cookies are needed.
- string $name: Name of the cookie
- string $value: (Optional) if expires specified and is in the past
- int $expires: (Optional) Expiry time
- string $path: (Optional) Url path to associate with (default is /)
Write hash value by key.
- obj_type $obj_type: object type's name
- key $key: hash key
- value $value: hash value
- prop_name $prop_name: (optional) individual property's name
Set a single property value of an object.
- obj_id $obj_id: object's id
- prop_name $prop_name: individual property's name
- prop_value $prop_value: new value to set
Set a user preference.
- pref_id $pref_id: preference identifier (0-200)
- value $value: preferece's value
- uid $uid: the user id (defaults to current session user)
Set a user's all preferences for this application.
- values $values: preferece values in an associative arrays
- replace $replace: whether to replace all existing preferences or merge into them.
- uid $uid: the user id (defaults to current session user)
Undefine an object association.
- name $name: name of this association
Remove a previously defined property from an object type.
- obj_type $obj_type: object type's name
- prop_name $prop_name: name of the property to remove
Update an existing object.
- obj_id $obj_id: object's id
- properties $properties: new properties
- replace $replace: true for replacing existing properties; false for merging
Cancels an event. Only works for events where application is the admin.
- int $eid: event id
- string $cancel_message: (Optional) message to send to members of the event about why it is cancelled
Creates an event on behalf of the user is there is a session, otherwise on behalf of app. Successful creation guarantees app will be admin.
- string $file: (Optional) filename of picture to set
- assoc $event_info: array $event_info json encoded event information
Edits an existing event. Only works for events where application is admin.
- int $eid: event id
- string $file: (Optional) filename of new picture to set
- assoc $event_info: array $event_info json encoded event information
Returns events according to the filters specified.
- int $uid: (Optional) User associated with events. A null parameter will default to the session user.
- array/string $eids: (Optional) Filter by these event ids. A null parameter will get all events for the user. (A csv list will work but is deprecated)
- int $start_time: (Optional) Filter with this unix time as lower bound. A null or zero parameter indicates no lower bound.
- int $end_time: (Optional) Filter with this UTC as upper bound. A null or zero parameter indicates no upper bound.
- string $rsvp_status: (Optional) Only show events where the given uid has this rsvp status. This only works if you have specified a value for $uid. Values are as in events.getMembers. Null indicates to ignore rsvp status when filtering.
Returns membership list data associated with an event.
- int $eid: event id
RSVPs the current user to this event.
- int $eid: event id
- string $rsvp_status: 'attending', 'unsure', or 'declined'
Delete custom tags the application has registered. If $tag_names is null, all the application's custom tags will be deleted.
IMPORTANT: If your application has registered public tags that other applications may be using, don't delete those tags! Doing so can break the FBML ofapplications that are using them.
- array $tag_names: the names of the tags to delete (optinal)
Get the custom tags for an application. If $app_id is not specified, the calling app's tags are returned.
If $app_id is different from the id of the calling app, only the app's public tags are returned. The return value is an array of the same type as the $tags parameter of fbml_registerCustomTags().
- int $app_id: the application's id (optional)
Fetches and re-caches the image stored at the given URL, for use in images published to non-canvas pages via the API (for example, to user profiles via profile.setFBML, or to News Feed via feed.publishUserAction).
- string $url: The absolute URL from which to refresh the image.
Fetches and re-caches the content stored at the given URL, for use in an fb:ref FBML tag.
- string $url: The absolute URL from which to fetch content. This URL should be used in a fb:ref FBML tag.
Register custom tags for the application. Custom tags can be used to extend the set of tags available to applications in FBML markup.
Before you call this function, make sure you read the full documentation at
http://wiki.developers.facebook.com/index.php/Fbml.RegisterCustomTags
IMPORTANT: This function overwrites the values of existing tags if the names match. Use this function with care because it may break the FBML of any application that is using the existing version of the tags.
- mixed $tags: an array of tag objects (the full description is on the wiki page)
Associates a given "handle" with FBML markup so that the handle can be
used within the fb:ref FBML tag. A handle is unique within an application and allows an application to publish identical FBML to many user profiles and do subsequent updates without having to republish FBML on behalf of each user.
- string $handle: The handle to associate with the given FBML.
- string $fbml: The FBML to associate with the given handle.
Lets you insert text strings in their native language into the Facebook Translations database so they can be translated.
- array $native_strings: An array of maps, where each map has a 'text' field and a 'description' field.
Deactivates a previously registered template bundle.
- string $template_bundle_id: The template bundle id
For the current user, retrieves stories generated by the user's friends while using this application. This can be used to easily create a "News Feed" like experience.
Retrieves information about a specified template bundle previously registered by the requesting application.
- string $template_bundle_id: The template bundle id
Retrieves the full list of active template bundles registered by the requesting application.
This method is deprecated for calls made on behalf of users. This method works only for publishing stories on a Facebook Page that has installed your application. To publish stories to a user's profile, use feed.publishUserAction instead.
For more details on this call, please visit the wiki page:
http://wiki.developers.facebook.com/index.php/Feed.publishTemplatizedAction
- $title_template
- $title_data
- $body_template
- $body_data
- $body_general
- $image_1
- $image_1_link
- $image_2
- $image_2_link
- $image_3
- $image_3_link
- $image_4
- $image_4_link
- $target_ids
- $page_actor_id
Publishes a story on behalf of the user owning the session, using the specified template bundle. This method requires an active session key in order to be called.
The parameters to this method ($templata_data in particular) are somewhat involved. It's recommended you visit the wiki for details:
http://wiki.developers.facebook.com/index.php/Feed.publishUserAction
- int $template_bundle_id: A template bundle id previously registered
- array $template_data: See wiki article for syntax
- array $target_ids: (Optional) An array of friend uids of the user who shared in this action.
- string $body_general: (Optional) Additional markup that extends the body of a short story.
- int $story_size: (Optional) A story size (see above)
- string $user_message: (Optional) A user message for a short story.
Registers a template bundle. Template bundles are somewhat involved, so it's recommended you check out the wiki for more details:
http://wiki.developers.facebook.com/index.php/Feed.registerTemplateBundle
- $one_line_story_templates
- $short_story_templates
- $full_story_template
- $action_links
- $method
- $params
Makes a set of FQL queries in parallel. This method takes a dictionary
of FQL queries where the keys are names for the queries. Results from one query can be used within another query to fetch additional data. More info about FQL queries at http://wiki.developers.facebook.com/index.php/FQL
- string $queries: JSON-encoded dictionary of queries to evaluate
Makes an FQL query. This is a generalized way of accessing all the data in the API, as an alternative to most of the other method calls. More info at http://wiki.developers.facebook.com/index.php/FQL
- string $query: the query to evaluate
Returns whether or not pairs of users are friends.
Note that the Facebook friend relationship is symmetric.
- array/string $uids1: list of ids (id_1, id_2,...) of some length X (csv is deprecated)
- array/string $uids2: list of ids (id_A, id_B,...) of SAME length X (csv is deprecated)
Returns the friends of the current session user.
- int $flid: (Optional) Only return friends on this friend list.
- int $uid: (Optional) Return friends for this user.
Returns the friends of the session user, who are also users of the calling application.
Returns the set of friend lists for the current session user.
Returns the mutual friends between the target uid and a source uid or the current session user.
- int $target_uid: Target uid for which mutual friends will be found.
- int $source_uid: (optional) Source uid for which mutual friends will be found. If no source_uid is specified, source_id will default to the session user.
get the current response serialization format
- $uid
Returns groups according to the filters specified.
- int $uid: (Optional) User associated with groups. A null parameter will default to the session user.
- array/string $gids: (Optional) Array of group ids to query. A null parameter will get all groups for the user. (csv is deprecated)
Returns the membership list of a group.
- int $gid: Group id
Retrieves links posted by the given user.
- int $uid: The user whose links you wish to retrieve
- int $limit: The maximimum number of links to retrieve
- array $link_ids: (Optional) Array of specific link IDs to retrieve by this user
Posts a link on Facebook.
- string $url: URL/link you wish to post
- string $comment: (Optional) A comment about this link
- int $uid: (Optional) User ID that is posting this link; defaults to current session user
Create/modify a Marketplace listing for the loggedinuser.
- int $listing_id: listing_id The id of a listing to be modified, 0 for a new listing.
- show_on_profile $show_on_profile: bool Should we show this listing on the user's profile
- listing_attrs $attrs: array An array of the listing data
- $uid
Get all the marketplace categories.
Get listings by either listing_id or user.
- listing_ids $listing_ids: An array of listing_ids (optional)
- uids $uids: An array of user ids (optional)
Get all the marketplace subcategories for a particular category.
- category $category: The category for which we are pulling subcategories
Remove a listing from Marketplace.
- listing_id $listing_id: The id of the listing to be removed
- status $status: 'SUCCESS', 'NOT_SUCCESS', or 'DEFAULT'
- $uid
Search for Marketplace listings. All arguments are optional, though at least one must be filled out to retrieve results.
- category $category: The category in which to search (optional)
- subcategory $subcategory: The subcategory in which to search (optional)
- query $query: A query string (optional)
Creates a note with the specified title and content.
- string $title: Title of the note.
- string $content: Content of the note.
- int $uid: (Optional) The user for whom you are creating a note; defaults to current session user
Deletes the specified note.
- int $note_id: ID of the note you wish to delete
- int $uid: (Optional) Owner of the note you wish to delete; defaults to current session user
Edits a note, replacing its title and contents with the title and contents specified.
- int $note_id: ID of the note you wish to edit
- string $title: Replacement title for the note
- string $content: Replacement content for the note
- int $uid: (Optional) Owner of the note you wish to edit; defaults to current session user
Retrieves all notes by a user. If note_ids are specified, retrieves only those specific notes by that user.
- int $uid: User whose notes you wish to retrieve
- array $note_ids: (Optional) List of specific note IDs by this user to retrieve
Returns the outstanding notifications for the session user.
Sends a notification to the specified users.
- $to_ids
- $notification
- $type
Sends an email to the specified user of the application.
- array/string $recipients: array of ids of the recipients (csv is deprecated)
- string $subject: subject of the email
- string $text: (plain text) body of the email
- string $fbml: fbml markup for an html version of the email
Returns the requested info fields for the requested set of pages.
- array/string $page_ids: an array of page ids (csv is deprecated)
- array/string $fields: an array of strings describing the info fields desired (csv is deprecated)
- int $uid: (Optional) limit results to pages of which this user is a fan.
- string $type: type limits results to a particular type of page.
Returns true if the given user is an admin for the passed page.
- int $page_id: target page id
- int $uid: (Optional) user id (defaults to the logged-in user)
Returns whether or not the given page has added the application.
- int $page_id: target page id
Returns true if logged in user is a fan for the passed page.
- int $page_id: target page id
- int $uid: user to compare. If empty, the logged in user.
- $order_id
- $status
- $start_time
- $end_time
- $test_mode
Set Payments properties for an app.
- properties $properties: a map from property names to values
- $order_id
- $status
- $params
are we currently queueing up calls for a batch?
Checks API-access granted to self by the specified application.
- string $permissions_apikey: Other application key
Checks API-access granted by self to the specified application.
- string $permissions_apikey: Other application key
Grant API-access to the specified methods/namespaces to the specified application.
- string $permissions_apikey: Other application key
- array(string) $method_arr: (Optional) API methods/namespaces allowed
Revoke API-access granted to the specified application.
- string $permissions_apikey: Other application key
Adds a tag with the given information to a photo. See the wiki for details:
http://wiki.developers.facebook.com/index.php/Photos.addTag
- int $pid: The ID of the photo to be tagged
- int $tag_uid: The ID of the user being tagged. You must specify either the $tag_uid or the $tag_text parameter (unless $tags is specified).
- string $tag_text: Some text identifying the person being tagged. You must specify either the $tag_uid or $tag_text parameter (unless $tags is specified).
- float $x: The horizontal position of the tag, as a percentage from 0 to 100, from the left of the photo.
- float $y: The vertical position of the tag, as a percentage from 0 to 100, from the top of the photo.
- array $tags: (Optional) An array of maps, where each map can contain the tag_uid, tag_text, x, and y parameters defined above. If specified, the individual arguments are ignored.
- int $owner_uid: (Optional) The user ID of the user whose photo you are tagging. If this parameter is not specified, then it defaults to the session user.
Creates and returns a new album owned by the specified user or the current session user.
- string $name: The name of the album.
- string $description: (Optional) A description of the album.
- string $location: (Optional) A description of the location.
- string $visible: (Optional) A privacy setting for the album. One of 'friends', 'friends-of-friends', 'networks', or 'everyone'. Default 'everyone'.
- int $uid: (Optional) User id for creating the album; if not specified, the session user is used.
Returns photos according to the filters specified.
- int $subj_id: (Optional) Filter by uid of user tagged in the photos.
- int $aid: (Optional) Filter by an album, as returned by photos_getAlbums.
-
array/string
$pids:
(Optional) Restrict to an array of pids (csv is deprecated)
Note that at least one of these parameters needs to be specified, or an error is returned.
Returns the albums created by the given user.
- int $uid: (Optional) The uid of the user whose albums you want. A null will return the albums of the session user.
-
string
$aids:
(Optional) An array of aids to restrict the query. (csv is deprecated)
Note that at least one of the (uid, aids) parameters must be specified.
Returns the tags on all photos specified.
- string $pids: A list of pids to query
Uploads a photo.
- string $file: The location of the photo on the local filesystem.
- int $aid: (Optional) The album into which to upload the photo.
- string $caption: (Optional) A caption for the photo.
- int $uid: uid (Optional) The user ID of the user whose photo you are uploading
- $method
- $params
Gets the FBML for the profile box that is currently set for a user's profile (your application set the FBML previously by calling the profile.setFBML method).
- int $uid: (Optional) User id to lookup; defaults to session.
- int $type: (Optional) 1 for original style, 2 for profile_main boxes
Returns the specified user's application info section for the calling application. These info sections have either been set via a previous profile.setInfo call or by the user editing them directly.
- int $uid: (Optional) User id to lookup; defaults to session.
Returns the options associated with the specified info field for an application info section.
- string $field: The title of the field
Sets the FBML for the profile of the user attached to this session.
- string $markup: The FBML that describes the profile presence of this app for the user
- int $uid: The user
- string $profile: Profile FBML
- string $profile_action: Profile action FBML (deprecated)
- string $mobile_profile: Mobile profile FBML
- string $profile_main: Main Tab profile FBML
Configures an application info section that the specified user can install on the Info tab of her profile. For details on the structure of an info field, please see:
http://wiki.developers.facebook.com/index.php/Profile.setInfo
- string $title: Title / header of the info section
-
int
$type:
- for text-only, 5 for thumbnail views
- array $info_fields: An array of info fields. See wiki for details.
- int $uid: (Optional)
Specifies the objects for a field for an application info section. These options populate the typeahead for a thumbnail.
- string $field: The title of the field
- array $options: An array of items for a thumbnail, including 'label', 'link', and optionally 'image', 'description' and 'sublabel'
Change the response format
- string $format: The response format (json, xml)
Set the default user id for methods that allow the caller to pass an uid parameter to identify the target user instead of a session key. This currently applies to the user preferences methods.
- $uid $uid: int the user id
Normally, if the cURL library/PHP extension is available, it is used for HTTP transactions. This allows that behavior to be overridden, falling back to a vanilla-PHP implementation even if cURL is installed.
- $use_curl_if_available $use_curl_if_available: bool whether or not to use cURL if available
- $is_ssl
Add a comment to a stream post
- $post_id $post_id: the post id
- $comment $comment: the comment text
- $uid $uid: the actor (defaults to session user)
Add a like to a stream post
- $post_id $post_id: the post id
- $uid $uid: the actor (defaults to session user)
Gets the stream on behalf of a user using a set of users. This call will return the latest $limit queries between $start_time and $end_time.
- int $viewer_id: user making the call (def: session)
- array $source_ids: users/pages to look at (def: all connections)
- int $start_time: start time to look for stories (def: 1 day ago)
- int $end_time: end time to look for stories (def: now)
- int $limit: number of stories to attempt to fetch (def: 30)
- string $filter_key: key returned by stream.getFilters to fetch
- array $metadata: metadata to include with the return, allows requested metadata to be returned, such as profiles, albums, photo_tags
Gets the full comments given a post_id from stream.get or the stream FQL table. Initially, only a set of preview comments are returned because some posts can have many comments.
- string $post_id: id of the post to get comments for
Gets the filters (with relevant filter keys for stream.get) for a particular user. These filters are typical things like news feed, friend lists, networks. They can be used to filter the stream without complex queries to determine which ids belong in which groups.
- int $uid: user to get filters for
Publish a post to the user's stream.
- $message $message: the user's message
- $attachment $attachment: the post's attachment (optional)
- $action $action_links: links the post's action links (optional)
- $target_id $target_id: the user on whose wall the post will be posted (optional)
- $uid $uid: the actor (defaults to session user)
Remove a post from the user's stream.
Currently, you may only remove stories you application created.
- $post_id $post_id: the post id
- $uid $uid: the actor (defaults to session user)
Remove a comment from a stream post
- $comment_id $comment_id: the comment id
- $uid $uid: the actor (defaults to session user)
Remove a like from a stream post
- $post_id $post_id: the post id
- $uid $uid: the actor (defaults to session user)
Returns the requested info fields for the requested set of users.
- array/string $uids: An array of user ids (csv is deprecated)
- array/string $fields: An array of info field names desired (csv is deprecated)
Returns the user corresponding to the current session object.
Returns the requested info fields for the requested set of users. A session key must not be specified. Only data about users that have authorized your application will be returned.
Check the wiki for fields that can be queried through this API call. Data returned from here should not be used for rendering to application users, use users.getInfo instead, so that proper privacy rules will be applied.
- array/string $uids: An array of user ids (csv is deprecated)
- array/string $fields: An array of info field names desired (csv is deprecated)
Returns 1 if the user has the specified permission, 0 otherwise.
http://wiki.developers.facebook.com/index.php/Users.hasAppPermission
- $ext_perm
- $uid
Returns whether or not the user corresponding to the current session object has the give the app basic authorization.
- $uid
Returns whether or not the user corresponding to the current session object is verified by Facebook. See the documentation for Users.isVerified for details.
Sets the users' current status message. Message does NOT contain the word "is" , so make sure to include a verb.
Example: setStatus("is loving the API!") will produce the status "Luke is loving the API!"
- string $status: text-only message to set
- int $uid: user to set for (defaults to the logged-in user)
- bool $clear: whether or not to clear the status, instead of setting it
- bool $status_includes_verb: if true, the word "is" will *not* be prepended to the status message
Returns an array with the video limitations imposed on the current session's associated user. Maximum length is measured in seconds; maximum size is measured in bytes.
Uploads a video.
- string $file: The location of the video on the local filesystem.
- string $title: (Optional) A title for the video. Titles over 65 characters in length will be truncated.
- string $description: (Optional) A description for the video.
Documentation generated on Sun, 02 Jan 2011 23:14:14 +0000 by phpDocumentor 1.4.3