Friends.getAppUsers

From Facebook Developer Wiki

Jump to: navigation, search

Contents

Description

Returns the user IDs of the current user's Facebook friends who have authorized the specific calling application or who have already connected their Facebook accounts via Facebook Connect. The current user is determined from the session_key parameter. The values returned from this call are not storable.

Parameters

RequiredNameTypeDescription
required api_key string The application key associated with the calling application. If you specify the API key in your client, you don't need to pass it with every call.
session_key string The session key of the logged in user. The session key is automatically included by our PHP client.
call_id float The request's sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP's microtime(true) function. If you specify the call ID in your client, you don't need to pass it with every call.
sig string An MD5 hash of the current request and your secret key, as described in the How Facebook Authenticates Your Application. Facebook computes the signature for you automatically.
v string This must be set to 1.0 to use this version of the API. If you specify the version in your client, you don't need to pass it with every call.
optional format string The desired response format, which can be either XML or JSON. (Default value is XML.)
callback string Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter.

Response

The friend IDs returned are those friends who have authorized the calling application, which is a subset of the friends returned from the friends.get method. If no friends are found, the method returns an empty friends_getAppUsers_response element.

Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <friends_getAppUsers_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd" list="true"> <uid>222333</uid> <uid>1240079</uid> </friends_getAppUsers_response>

FQL Equivalent

FQL queries take the form: SELECT <fields> FROM <table> WHERE <conditions>

This function is similar (but returned in a slightly different format) to doing the following FQL query, with the appropriate parameters filled in:

SELECT uid FROM user WHERE uid IN (SELECT uid2 FROM friend WHERE uid1=loggedInUid) AND is_app_user

Error Codes

CodeDescription
1 An unknown error occurred. Please resubmit the request.
2 The service is not available at this time.
4 The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
5 The request came from a remote address not allowed by this application.
101 The API key submitted is not associated with any known application.
102 The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
103 The submitted call_id was not greater than the previous call_id for this session.
104 Incorrect signature.

Notes

You can call this method using a session secret, and not the application secret (for example, for a Facebook Connect site or desktop application).

Retrieved from "http://wiki.developers.facebook.com/index.php/Friends.getAppUsers"
reference