Returns whether or not each pair of specified users is friends with each other. The first array specifies one half of each pair, the second array the other half; therefore, they must be of equal size.
| Type | Name | Required | Description |
|---|---|---|---|
string
| api_key | ✔ | The application key associated with the calling application. |
string
| community | ✔ | Community system name. Use up.community.getList method to retrieve available communities. |
string
| session_key | ✔ | The session key of the logged in user. |
string
| sig | ✔ | An MD5 hash of the current request and your secret key, as described in the authentication guide. |
string
| format | Desired response format. Either XML (default) or JSON.
| |
array
| uids1 | ✔ | A list of user ids matched with uids2. This is a comma-separated list of user ids.
|
array
| uids2 | ✔ | A list of user ids matched with uids1. This is a comma-separated list of user ids.
|
<?xml version="1.0" encoding="UTF-8"?> <friends_areFriends_response list="true"> <friend_info> <uid1>222332</uid1> <uid2>222333</uid2> <are_friends>1</are_friends> </friend_info> <friend_info> <uid1>1240077</uid1> <uid2>1240079</uid2> <are_friends>0</are_friends> </friend_info> </friends_areFriends_response>
Returns a list of friend_info elements corresponding to the lists passed. The are_friends subelement of each friend_info element will be 0 if the users are not friends, and 1 if they are friends. Note that, for each pair, this function is symmetric (does not matter which user is in uids1 and which is in uids2).
This function is similar to doing the following UPQL query, with the appropriate parameters filled in:
SELECT uid1, uid2 FROM friend WHERE uid1=uid1 AND uid2=uid2
| Code | Description |
|---|---|
| 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. |
| 100 | One of the parameters specified was missing or invalid. |
| 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. |
| 104 | Incorrect signature. |