This object represents a person who is a friend of the current user. The Friend object may be retrieved with basic or extended information. The getFriendsInfo method retrieves by default only basic information; extended information can be requested by setting the detailLevel parameter.
2. Retrieving friends' data should be requested explicitly by checking the appropriate checkbox in the console's permissions section.
|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. |
|isSiteUID||Boolean||This field indicates if the UID is a site UID (provided by your site) or an ID generated by Gigya.|
|friendshipSignature||string||If the global configuration 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, which should be used for verification*.|
|signatureTimestamp||number||If the global configuration 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, which should be used for verification*. The timestamp is the GMT time of the response in UNIX time format (i.e. the number of seconds since Jan. 1st 1970).|
|oldestDataUpdatedTimestamp||integer||The time when the oldest data of the object was refreshed in Java time format, i.e. milliseconds since Jan. 1st 1970.|
|oldestDataAge||integer||The difference in seconds between the oldestDataUpdatedTimestamp and the current time.|
|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 to which the user is connected (i.e. 'facebook', 'yahoo', etc.) and the values are Identity objects received from that provider. |
For example: If the user is connected to Facebook then user.identities['facebook'] is the identity object representing his Facebook identity and user.identities['facebook'].providerUID is the ID of the user in Facebook.
Note: For User objects returned by getFriendsInfo only identities that are actually friends of the current user will be included here. Suppose User A has a Facebook identity that is a friend of the Facebook identity of User B, and User B also has a Google identity. When asking for the friends of User A you will get User B but only with his Facebook identity.
|nickname||string||The person's nickname, this may be either the nickname provided by the connected provider or a concatenation of the first and last names.|
|photoURL||string||The URL of person's full size photo.|
|thumbnailURL||string||The URL of person's thumbnail photo, when available.|
|friendshipSig||string||Deprecated. Please use the friendshipSignature parameter instead.|
|timestamp||string||Deprecated. Please use the signatureTimestamp parameter instead. |
This field will hold the timestamp in "yyyy-mm-dd HH:mm:ss" format where HH is in 24 hour time format.
|firstName||string||The person's first name.|
|lastName||string||The person's last name.|
|gender||string||The person's gender. The value may be either 'm' or 'f'.|
|age||number||The person's age.|
|birthDay||number||The day in the 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.|
|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.|
Top Providers Friend Data
|*Extracted from other fields|