User Object



This object represents the current user in the system. The User Object can be retrieved with updated information using the getUserInfo() method.

Data Members

Name

Type

Description

UID

String

A unique ID for the person who this object represents. The UID is guaranteed to be consistent over time for users who were authenticated on the site by using either login() or notifyLogin(). If notifyLogin() is used, UID is the same ID provided by the site. Note: This field can be rather long in some cases. If you plan to store is in a database, the recommended field size is 300 characters.

UIDSig

String

If the Conf object’s signID field is set to true, the User object is signed with a cryptographic signature when returned by an API method, to prevent fraud. This field holds the signature to use for verification.

timestamp

String

If the Conf object’s signID field is set to true, the User object is signed with a cryptographic signature, when returned by an API method, to prevent fraud. This field holds the timestamp to use for verification.

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

isLoggedIn

Boolean

Indicates whether the current user is logged in or not.

isConnected

Boolean

Indicates whether the current user is connected to any available provider. This is true only if isSiteUser=true and it has at least one identity.

loginProvider

String

The name of the provider that the user uses to log in. If this is not an empty string, user.identities[user.loginProvider] is the identity used for the login.

providers

array of strings

Contains the names of the providers to which the user is connected, logged-in.

identities

Dictionary object

A Dictionary object where the keys are the names of the providers to whom the user is connected (for example, “facebook”, “yahoo”, and so on) and the values are Identity objects received from that provider. For example, if the user is connected to MySpace, user.identities[‘myspace’] is the identity object representing the user’s MySpace identity and user.identities['myspace'].providerID is the ID of the user in MySpace.

nickname

String

The person’s nickname, which can be either the nickname provided by the connected provider or a concatenation of first and last name.

photoURL

String

The URL of the person’s full-size photo.

thumbnailURL

String

The URL of the person’s thumbnail photo, when available.

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 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.

email

String

The person’s e-mail.

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 user’s profile on the primary provider’s site.

proxiedEmail

String

A proxied e-mail address is a storable channel through which your application can contact your users. Proxied e-mail is currently supported only by Facebook. (For more information, see Facebook’s proxied e-mail documentation).

You receive the user’s proxied e-mail only if both of the following two conditions are fulfilled:

1. In your Social service site setup process, you have checked the checkbox Enable sending e-mails in Facebook.

2. The user gave your application permission to send e-mails (if condition 1 is fulfilled, while connecting to Facebook, the user is prompted with a dialog to allow your application to send e-mails).

capabilities

object

The capabilities of the user. The capabilities of the user are the unified capabilities of all the providers to which the user is currently connected. The capabilities indicate which operations are available for the current user. The capabilities object has five Boolean fields representing five possible capabilities: login, notifications, actions, friends, and status.

Example:

if (user.capabilities.friends)     fps.services.socialize.showFriendSelectorUI( { APIKey:'Put your API Key here'},{});

Note: To verify the authenticity of a Friend object, follow the instructions in the section Verifying the authenticity of Socialize Response - signature and timestamp.