UserAccount

java.lang.Object
- com.salesforce.androidsdk.accounts.UserAccount

```
public class UserAccount
extends java.lang.Object
```
This class represents a single user account that is currently logged in against a Salesforce endpoint. It encapsulates data that is used to uniquely identify a single user account.

Author:

bhariharan

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACCOUNT_NAME`
`static java.lang.String`	`AUTH_TOKEN`
`static java.lang.String`	`CLIENT_ID`
`static java.lang.String`	`COMMUNITY_ID`
`static java.lang.String`	`COMMUNITY_URL`
`static java.lang.String`	`CONTENT_DOMAIN`
`static java.lang.String`	`CONTENT_SID`
`static java.lang.String`	`COOKIE_CLIENT_SRC`
`static java.lang.String`	`COOKIE_SID_CLIENT`
`static java.lang.String`	`CSRF_TOKEN`
`static java.lang.String`	`DISPLAY_NAME`
`static java.lang.String`	`EMAIL`
`static java.lang.String`	`FIRST_NAME`
`static java.lang.String`	`ID_URL`
`static java.lang.String`	`INSTANCE_SERVER`
`static java.lang.String`	`INTERNAL_COMMUNITY_ID`
`static java.lang.String`	`INTERNAL_COMMUNITY_PATH`
`static java.lang.String`	`LANGUAGE`
`static java.lang.String`	`LAST_NAME`
`static java.lang.String`	`LIGHTNING_DOMAIN`
`static java.lang.String`	`LIGHTNING_SID`
`static java.lang.String`	`LOCALE`
`static java.lang.String`	`LOGIN_SERVER`
`static java.lang.String`	`NATIVE_LOGIN`
`static java.lang.String`	`ORG_ID`
`static java.lang.String`	`PHOTO_URL`
`static java.lang.String`	`REFRESH_TOKEN`
`static java.lang.String`	`SID_COOKIE_NAME`
`static java.lang.String`	`THUMBNAIL_URL`
`static java.lang.String`	`USER_ID`
`static java.lang.String`	`USERNAME`
`static java.lang.String`	`VF_DOMAIN`
`static java.lang.String`	`VF_SID`

Constructor Summary

Constructors
Constructor and Description

UserAccount(Bundle bundle)
Construct UserAccount from Bundle

UserAccount(JSONObject object)
Construct UserAccount from JSON.

Constructors
Constructor and Description
`UserAccount(Bundle bundle)` Construct UserAccount from Bundle
`UserAccount(JSONObject object)` Construct UserAccount from JSON.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`downloadProfilePhoto()` Fetches this user's profile photo from the server and stores it in the cache.
`boolean`	`equals(java.lang.Object object)`
`java.lang.String`	`getAccountName()` Returns the account name for this user account.
`java.util.Map<java.lang.String,java.lang.String>`	`getAdditionalOauthValues()` Returns the additional OAuth values for this user.
`java.lang.String`	`getAuthToken()` Returns the auth token for this user account.
`java.lang.String`	`getClientId()` Returns the oauth client id.
`java.lang.String`	`getCommunityId()` Returns the community ID for this user account.
`java.lang.String`	`getCommunityLevelFilenameSuffix()` Returns a unique suffix for this user account, that can be appended to a file to uniquely identify this account, at a community level.
`java.lang.String`	`getCommunityLevelFilenameSuffix(java.lang.String communityId)` Returns a unique suffix for this user account, that can be appended to a file to uniquely identify this account, at a community level.
`java.lang.String`	`getCommunityLevelStoragePath()` Returns the storage path for this user account, relative to the higher level directory of app data.
`java.lang.String`	`getCommunityLevelStoragePath(java.lang.String communityId)` Returns the storage path for this user account, relative to the higher level directory of app data.
`java.lang.String`	`getCommunityUrl()` Returns the community URL for this user account.
`java.lang.String`	`getContentDomain()` Returns the content domain for this user.
`java.lang.String`	`getContentSid()` Returns the content SID for this user.
`java.lang.String`	`getCookieClientSrc()` Returns the cookie client src.
`java.lang.String`	`getCookieSidClient()` Returns the cookie sid client.
`java.lang.String`	`getCSRFToken()` Returns the CSRF token for this user.
`java.lang.String`	`getDisplayName()` Returns the Display name for this user account.
`java.lang.String`	`getEmail()` Returns the email for this user account.
`java.lang.String`	`getFirstName()` Returns the first name for this user account.
`java.lang.String`	`getIdUrl()` Returns the identity URL for this user account.
`java.lang.String`	`getInstanceServer()` Returns the instance server for this user account.
`java.lang.String`	`getLanguage()` Returns the language for this user.
`java.lang.String`	`getLastName()` Returns the last name for this user account.
`java.lang.String`	`getLightningDomain()` Returns the Lightning domain for this user.
`java.lang.String`	`getLightningSid()` Returns the Lightning SID for this user.
`java.lang.String`	`getLocale()` Returns the locale for this user.
`java.lang.String`	`getLoginServer()` Returns the login server for this user account.
`java.lang.Boolean`	`getNativeLogin()` Whether or not the user was added through native headless authentication.
`java.lang.String`	`getOrgId()` Returns the org ID for this user account.
`java.lang.String`	`getOrgLevelFilenameSuffix()` Returns a unique suffix for this user account, that can be appended to a file to uniquely identify this account, at an org level.
`java.lang.String`	`getOrgLevelStoragePath()` Returns the org level storage path for this user account, relative to the higher level directory of app data.
`java.lang.String`	`getPhotoUrl()` Returns the photo url for this user.
`Bitmap`	`getProfilePhoto()` Fetches this user's profile photo from the cache.
`java.lang.String`	`getRefreshToken()` Returns the refresh token for this user account.
`java.lang.String`	`getSidCookieName()` Returns the sid cookie name.
`java.lang.String`	`getThumbnailUrl()` Returns the thumbnail for this user.
`java.lang.String`	`getUserId()` Returns the user ID for this user account.
`java.lang.String`	`getUserLevelFilenameSuffix()` Returns a unique suffix for this user account, that can be appended to a file to uniquely identify this account, at a user level.
`java.lang.String`	`getUserLevelStoragePath()` Returns the user level storage path for this user account, relative to the higher level directory of app data.
`java.lang.String`	`getUsername()` Returns the username for this user account.
`java.lang.String`	`getVFDomain()` Returns the VF domain for this user.
`java.lang.String`	`getVFSid()` Returns the VF SID for this user.
`int`	`hashCode()`
`Bundle`	`toBundle()` Returns a representation of this instance in a bundle.
`JSONObject`	`toJson()` Returns a JSON representation of this instance.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AUTH_TOKEN
```
public static final java.lang.String AUTH_TOKEN
```
    See Also:
    
    Constant Field Values
  - REFRESH_TOKEN
```
public static final java.lang.String REFRESH_TOKEN
```
    See Also:
    
    Constant Field Values
  - LOGIN_SERVER
```
public static final java.lang.String LOGIN_SERVER
```
    See Also:
    
    Constant Field Values
  - ID_URL
```
public static final java.lang.String ID_URL
```
    See Also:
    
    Constant Field Values
  - INSTANCE_SERVER
```
public static final java.lang.String INSTANCE_SERVER
```
    See Also:
    
    Constant Field Values
  - ORG_ID
```
public static final java.lang.String ORG_ID
```
    See Also:
    
    Constant Field Values
  - USER_ID
```
public static final java.lang.String USER_ID
```
    See Also:
    
    Constant Field Values
  - USERNAME
```
public static final java.lang.String USERNAME
```
    See Also:
    
    Constant Field Values
  - ACCOUNT_NAME
```
public static final java.lang.String ACCOUNT_NAME
```
    See Also:
    
    Constant Field Values
  - COMMUNITY_ID
```
public static final java.lang.String COMMUNITY_ID
```
    See Also:
    
    Constant Field Values
  - COMMUNITY_URL
```
public static final java.lang.String COMMUNITY_URL
```
    See Also:
    
    Constant Field Values
  - INTERNAL_COMMUNITY_ID
```
public static final java.lang.String INTERNAL_COMMUNITY_ID
```
    See Also:
    
    Constant Field Values
  - INTERNAL_COMMUNITY_PATH
```
public static final java.lang.String INTERNAL_COMMUNITY_PATH
```
    See Also:
    
    Constant Field Values
  - EMAIL
```
public static final java.lang.String EMAIL
```
    See Also:
    
    Constant Field Values
  - FIRST_NAME
```
public static final java.lang.String FIRST_NAME
```
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME
```
public static final java.lang.String DISPLAY_NAME
```
    See Also:
    
    Constant Field Values
  - LAST_NAME
```
public static final java.lang.String LAST_NAME
```
    See Also:
    
    Constant Field Values
  - PHOTO_URL
```
public static final java.lang.String PHOTO_URL
```
    See Also:
    
    Constant Field Values
  - THUMBNAIL_URL
```
public static final java.lang.String THUMBNAIL_URL
```
    See Also:
    
    Constant Field Values
  - LIGHTNING_DOMAIN
```
public static final java.lang.String LIGHTNING_DOMAIN
```
    See Also:
    
    Constant Field Values
  - LIGHTNING_SID
```
public static final java.lang.String LIGHTNING_SID
```
    See Also:
    
    Constant Field Values
  - VF_DOMAIN
```
public static final java.lang.String VF_DOMAIN
```
    See Also:
    
    Constant Field Values
  - VF_SID
```
public static final java.lang.String VF_SID
```
    See Also:
    
    Constant Field Values
  - CONTENT_DOMAIN
```
public static final java.lang.String CONTENT_DOMAIN
```
    See Also:
    
    Constant Field Values
  - CONTENT_SID
```
public static final java.lang.String CONTENT_SID
```
    See Also:
    
    Constant Field Values
  - CSRF_TOKEN
```
public static final java.lang.String CSRF_TOKEN
```
    See Also:
    
    Constant Field Values
  - NATIVE_LOGIN
```
public static final java.lang.String NATIVE_LOGIN
```
    See Also:
    
    Constant Field Values
  - LANGUAGE
```
public static final java.lang.String LANGUAGE
```
    See Also:
    
    Constant Field Values
  - LOCALE
```
public static final java.lang.String LOCALE
```
    See Also:
    
    Constant Field Values
  - COOKIE_CLIENT_SRC
```
public static final java.lang.String COOKIE_CLIENT_SRC
```
    See Also:
    
    Constant Field Values
  - COOKIE_SID_CLIENT
```
public static final java.lang.String COOKIE_SID_CLIENT
```
    See Also:
    
    Constant Field Values
  - SID_COOKIE_NAME
```
public static final java.lang.String SID_COOKIE_NAME
```
    See Also:
    
    Constant Field Values
  - CLIENT_ID
```
public static final java.lang.String CLIENT_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserAccount
```
public UserAccount(JSONObject object)
```
    Construct UserAccount from JSON.
    
    Parameters:
    
    object -
  - UserAccount
```
public UserAccount(Bundle bundle)
```
    Construct UserAccount from Bundle
    
    Parameters:
    
    bundle -
- Method Detail
  - getAuthToken
```
public java.lang.String getAuthToken()
```
    Returns the auth token for this user account.
    
    Returns:
    
    Auth token.
  - getRefreshToken
```
public java.lang.String getRefreshToken()
```
    Returns the refresh token for this user account.
    
    Returns:
    
    Refresh token.
  - getLoginServer
```
public java.lang.String getLoginServer()
```
    Returns the login server for this user account.
    
    Returns:
    
    Login server.
  - getIdUrl
```
public java.lang.String getIdUrl()
```
    Returns the identity URL for this user account.
    
    Returns:
    
    Identity URL.
  - getInstanceServer
```
public java.lang.String getInstanceServer()
```
    Returns the instance server for this user account.
    
    Returns:
    
    Instance server.
  - getOrgId
```
public java.lang.String getOrgId()
```
    Returns the org ID for this user account.
    
    Returns:
    
    Org ID.
  - getUserId
```
public java.lang.String getUserId()
```
    Returns the user ID for this user account.
    
    Returns:
    
    User ID.
  - getUsername
```
public java.lang.String getUsername()
```
    Returns the username for this user account.
    
    Returns:
    
    Username.
  - getAccountName
```
public java.lang.String getAccountName()
```
    Returns the account name for this user account.
    
    Returns:
    
    Account name.
  - getCommunityId
```
public java.lang.String getCommunityId()
```
    Returns the community ID for this user account.
    
    Returns:
    
    Community ID.
  - getCommunityUrl
```
public java.lang.String getCommunityUrl()
```
    Returns the community URL for this user account.
    
    Returns:
    
    Community URL.
  - getFirstName
```
public java.lang.String getFirstName()
```
    Returns the first name for this user account.
    
    Returns:
    
    First Name.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Returns the Display name for this user account.
    
    Returns:
    
    Display Name.
  - getLastName
```
public java.lang.String getLastName()
```
    Returns the last name for this user account.
    
    Returns:
    
    Last Name.
  - getEmail
```
public java.lang.String getEmail()
```
    Returns the email for this user account.
    
    Returns:
    
    Email.
  - getPhotoUrl
```
public java.lang.String getPhotoUrl()
```
    Returns the photo url for this user.
    
    Returns:
    
    Photo URL.
  - getThumbnailUrl
```
public java.lang.String getThumbnailUrl()
```
    Returns the thumbnail for this user.
    
    Returns:
    
    Thumbnail.
  - getLightningDomain
```
public java.lang.String getLightningDomain()
```
    Returns the Lightning domain for this user.
    
    Returns:
    
    Lightning domain.
  - getLightningSid
```
public java.lang.String getLightningSid()
```
    Returns the Lightning SID for this user.
    
    Returns:
    
    Lightning SID.
  - getVFDomain
```
public java.lang.String getVFDomain()
```
    Returns the VF domain for this user.
    
    Returns:
    
    VF domain.
  - getVFSid
```
public java.lang.String getVFSid()
```
    Returns the VF SID for this user.
    
    Returns:
    
    VF SID.
  - getContentDomain
```
public java.lang.String getContentDomain()
```
    Returns the content domain for this user.
    
    Returns:
    
    Content domain.
  - getContentSid
```
public java.lang.String getContentSid()
```
    Returns the content SID for this user.
    
    Returns:
    
    Content SID.
  - getCSRFToken
```
public java.lang.String getCSRFToken()
```
    Returns the CSRF token for this user.
    
    Returns:
    
    CSRF token.
  - getNativeLogin
```
public java.lang.Boolean getNativeLogin()
```
    Whether or not the user was added through native headless authentication.
    
    Returns:
    
    True if the user was added with native authentication.
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns the language for this user.
    
    Returns:
    
    language.
  - getLocale
```
public java.lang.String getLocale()
```
    Returns the locale for this user.
    
    Returns:
    
    locale.
  - getCookieClientSrc
```
public java.lang.String getCookieClientSrc()
```
    Returns the cookie client src.
    
    Returns:
    
    cookie client src.
  - getCookieSidClient
```
public java.lang.String getCookieSidClient()
```
    Returns the cookie sid client.
    
    Returns:
    
    cookie sid client.
  - getSidCookieName
```
public java.lang.String getSidCookieName()
```
    Returns the sid cookie name.
    
    Returns:
    
    sid cookie name.
  - getClientId
```
public java.lang.String getClientId()
```
    Returns the oauth client id.
    
    Returns:
    
    client id.
  - getAdditionalOauthValues
```
public java.util.Map<java.lang.String,java.lang.String> getAdditionalOauthValues()
```
    Returns the additional OAuth values for this user.
    
    Returns:
    
    Additional OAuth values.
  - getProfilePhoto
```
public Bitmap getProfilePhoto()
```
    Fetches this user's profile photo from the cache.
    
    Returns:
    
    User's profile photo.
  - downloadProfilePhoto
```
public void downloadProfilePhoto()
```
    Fetches this user's profile photo from the server and stores it in the cache.
  - getOrgLevelStoragePath
```
public java.lang.String getOrgLevelStoragePath()
```
    Returns the org level storage path for this user account, relative to the higher level directory of app data. The higher level directory could be 'files'. The output is of the format '/{orgID}/'. This storage path is meant for data that can be shared across multiple users of the same org.
    
    Returns:
    
    File storage path.
  - getUserLevelStoragePath
```
public java.lang.String getUserLevelStoragePath()
```
    Returns the user level storage path for this user account, relative to the higher level directory of app data. The higher level directory could be 'files'. The output is of the format '/{orgID}/{userId}/'. This storage path is meant for data that is unique to a particular user in an org, but common across all the communities that the user is a member of within that org.
    
    Returns:
    
    File storage path.
  - getCommunityLevelStoragePath
```
public java.lang.String getCommunityLevelStoragePath()
```
    Returns the storage path for this user account, relative to the higher level directory of app data. The higher level directory could be 'files'. The output is of the format '/{orgID}/{userID}/{communityID}/'. If 'communityID' is null or the internal community ID, then the output would be '/{orgID}/{userID}/internal/'. This storage path is meant for data that is unique to a particular user in a specific community.
    
    Returns:
    
    File storage path.
  - getCommunityLevelStoragePath
```
public java.lang.String getCommunityLevelStoragePath(java.lang.String communityId)
```
    Returns the storage path for this user account, relative to the higher level directory of app data. The higher level directory could be 'files'. The output is of the format '/{orgID}/{userID}/{communityID}/'. If 'communityID' is null or the internal community ID, then the output would be '/{orgID}/{userID}/internal/'. This storage path is meant for data that is unique to a particular user in a specific community.
    
    Parameters:
    
    communityId - Community ID. Pass 'null' for internal community.
    
    Returns:
    
    File storage path.
  - getOrgLevelFilenameSuffix
```
public java.lang.String getOrgLevelFilenameSuffix()
```
    Returns a unique suffix for this user account, that can be appended to a file to uniquely identify this account, at an org level. The output is of the format '_{orgID}'. This suffix is meant for data that can be shared across multiple users of the same org.
    
    Returns:
    
    Filename suffix.
  - getUserLevelFilenameSuffix
```
public java.lang.String getUserLevelFilenameSuffix()
```
    Returns a unique suffix for this user account, that can be appended to a file to uniquely identify this account, at a user level. The output is of the format '_{orgID}_{userID}'. This suffix is meant for data that is unique to a particular user in an org, but common across all the communities that the user is a member of within that org.
    
    Returns:
    
    Filename suffix.
  - getCommunityLevelFilenameSuffix
```
public java.lang.String getCommunityLevelFilenameSuffix()
```
    Returns a unique suffix for this user account, that can be appended to a file to uniquely identify this account, at a community level. The output is of the format '_{orgID}_{userID}_{communityID}'. If 'communityID' is null or the internal community ID, then the output would be '_{orgID}_{userID}_internal'. This storage path is meant for data that is unique to a particular user in a specific community.
    
    Returns:
    
    Filename suffix.
  - getCommunityLevelFilenameSuffix
```
public java.lang.String getCommunityLevelFilenameSuffix(java.lang.String communityId)
```
    Returns a unique suffix for this user account, that can be appended to a file to uniquely identify this account, at a community level. The output is of the format '_{orgID}_{userID}_{communityID}'. If 'communityID' is null or the internal community ID, then the output would be '_{orgID}_{userID}_internal'. This storage path is meant for data that is unique to a particular user in a specific community.
    
    Parameters:
    
    communityId - Community ID. Pass 'null' for internal community.
    
    Returns:
    
    Filename suffix.
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toJson
```
public JSONObject toJson()
```
    Returns a JSON representation of this instance.
    
    Returns:
    
    JSONObject instance.
  - toBundle
```
public Bundle toBundle()
```
    Returns a representation of this instance in a bundle.
    
    Returns:
    
    Bundle instance.

Class UserAccount

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTH_TOKEN

REFRESH_TOKEN

LOGIN_SERVER

ID_URL

INSTANCE_SERVER

ORG_ID

USER_ID

USERNAME

ACCOUNT_NAME

COMMUNITY_ID

COMMUNITY_URL

INTERNAL_COMMUNITY_ID

INTERNAL_COMMUNITY_PATH

EMAIL

FIRST_NAME

DISPLAY_NAME

LAST_NAME

PHOTO_URL

THUMBNAIL_URL

LIGHTNING_DOMAIN

LIGHTNING_SID

VF_DOMAIN

VF_SID

CONTENT_DOMAIN

CONTENT_SID

CSRF_TOKEN

NATIVE_LOGIN

LANGUAGE

LOCALE

COOKIE_CLIENT_SRC

COOKIE_SID_CLIENT

SID_COOKIE_NAME

CLIENT_ID

Constructor Detail

UserAccount

UserAccount

Method Detail

getAuthToken

getRefreshToken

getLoginServer

getIdUrl

getInstanceServer

getOrgId

getUserId

getUsername

getAccountName

getCommunityId

getCommunityUrl

getFirstName

getDisplayName

getLastName

getEmail

getPhotoUrl

getThumbnailUrl

getLightningDomain

getLightningSid

getVFDomain

getVFSid

getContentDomain

getContentSid

getCSRFToken

getNativeLogin

getLanguage

getLocale

getCookieClientSrc

getCookieSidClient

getSidCookieName

getClientId

getAdditionalOauthValues

getProfilePhoto

downloadProfilePhoto

getOrgLevelStoragePath

getUserLevelStoragePath

getCommunityLevelStoragePath