Description
This object represents a person who is a friend of the current user. The Friend Object may be retrieved with basic or extended information. getFriendsInfo method retrieves by default only basic information, extended information can be requested by setting the detailLevel parameter.
Note:
Different providers supply different data. Thus, the availability of the data members of the Friend object depends on the specific provider.
Data Members
Basic fields:
| Field Name | Type | Description |
| UID | string | A unique ID for the person represented by this object. The UID is guaranteed to be consistent over time for users who were authenticated on the site by using either login or notifyLogin. Note that if notifyLogin was used then UID will return the same ID provided by the site.
Notes: - This field may be rather long is some cases, if you plan to store it in a DB the recommended field size is 300 characters.
- The UID string must be encoded using the encodeURIComponent() function, before sending it to your server.
|
| isSiteUID | boolean | This field indicates if the UID is a site UID (provided by your site) or an ID generated by Gigya. |
| friendshipSig | string | If the Conf object's "signIDs" field is set to "true", Gigya "signs" the Friend Object (when returned by an API method) with a cryptographic signature, to prevent fraud. This field will hold the signature, that should be used for verification*. |
| timestamp | string | If the Conf object's "signIDs" field is set to "true", Gigya "signs" the Friend Object (when returned by an API method) with a cryptographic signature, to prevent fraud. This field will hold the timestamp, that should be used for verification*. The timestamp is the GMT time of the response in "yyyy-mm-dd HH:mm:ss" format where HH is in 24 hour time format. |
| isSiteUser | boolean | Indicates whether the current user is a user of the site. This is useful for checking which friends of the current user are also users of the same site. |
| identities | dictionary object | A dictionary object where the keys are the names of the providers which the user is connected to (i.e. 'facebook', 'yahoo', etc.) and the values are Identity objects received from that provider.
For example: If the user is connected to myspace then user.identities['myspace'] is the identity object representing his myspace identity and user.identities['myspace'].providerUID is the ID of the user in MySpace. |
| nickname | string | The person's nickname, this may be either the nickname provided by the connected provider or a concatenation of first and last name. |
| photoURL | string | The URL of person's full size photo. |
| thumbnailURL | string | The URL of person's thumbnail photo, when available. |
Extended fields
| Field Name | Type | Description |
| firstName | string | The person's first name. |
| lastName | string | The person's last name. |
| gender | string | The person's gender. |
| age | number | The person's age. |
| birthDay | number | The day in month in which the person was born. |
| birthMonth | number | The month in which the person was born. |
| birthYear | number | The year in which the person was born. |
| email | string | The person's email. |
| country | string | The person's country. |
| state | string | The person's state. |
| city | string | The person's city. |
| zip | string | The person's zip code. |
| profileURL | string | The URL of the person's profile on his primary Provider.
|
