SalesforceSDK/com.salesforce.androidsdk.accounts/UserAccount

UserAccount

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

Constructors

UserAccount

constructor(object: JSONObject)

Construct UserAccount from JSON.

constructor(bundle: Bundle)

Construct UserAccount from Bundle

Properties

ACCOUNT_NAME

val ACCOUNT_NAME: String = "accountName"

accountName

open val accountName: String

additionalOauthValues

open val additionalOauthValues: Map<String, String>

API_INSTANCE_SERVER

val API_INSTANCE_SERVER: String = "apiInstanceServer"

apiInstanceServer

open val apiInstanceServer: String

AUTH_TOKEN

val AUTH_TOKEN: String = "authToken"

authToken

open val authToken: String

BEACON_CHILD_CONSUMER_KEY

val BEACON_CHILD_CONSUMER_KEY: String = "auto_installed_app_org_consumer_key"

BEACON_CHILD_CONSUMER_SECRET

val BEACON_CHILD_CONSUMER_SECRET: String = "auto_installed_app_org_consumer_secret"

beaconChildConsumerKey

open val beaconChildConsumerKey: String

beaconChildConsumerSecret

open val beaconChildConsumerSecret: String

CLIENT_ID

val CLIENT_ID: String = "clientId"

clientId

open val clientId: String

COMMUNITY_ID

val COMMUNITY_ID: String = "communityId"

COMMUNITY_URL

val COMMUNITY_URL: String = "communityUrl"

communityId

@get:Nullable

open val communityId: String

communityUrl

open val communityUrl: String

CONTENT_DOMAIN

val CONTENT_DOMAIN: String = "contentDomain"

CONTENT_SID

val CONTENT_SID: String = "contentSid"

contentDomain

open val contentDomain: String

contentSid

open val contentSid: String

COOKIE_CLIENT_SRC

val COOKIE_CLIENT_SRC: String = "cookie-clientSrc"

COOKIE_SID_CLIENT

val COOKIE_SID_CLIENT: String = "cookie-sid_Client"

cookieClientSrc

open val cookieClientSrc: String

cookieSidClient

open val cookieSidClient: String

CREDENTIALS_IDENTIFIER

val CREDENTIALS_IDENTIFIER: String = "credentialsIdentifier"

credentialsIdentifier

open var credentialsIdentifier: String

CSRF_TOKEN

val CSRF_TOKEN: String = "csrfToken"

csrfToken

open val csrfToken: String

DISPLAY_NAME

val DISPLAY_NAME: String = "display_name"

displayName

open val displayName: String

val EMAIL: String = "email"

open val email: String

FEATURE_FLAGS

val FEATURE_FLAGS: String = "feature_flags"

featureFlags

open var featureFlags: Set<String>

FIRST_NAME

val FIRST_NAME: String = "first_name"

firstName

open val firstName: String

ID_URL

val ID_URL: String = "idUrl"

idUrl

open val idUrl: String

INSTANCE_SERVER

val INSTANCE_SERVER: String = "instanceServer"

instanceServer

open val instanceServer: String

INTERNAL_COMMUNITY_ID

val INTERNAL_COMMUNITY_ID: String = "000000000000000AAA"

INTERNAL_COMMUNITY_PATH

val INTERNAL_COMMUNITY_PATH: String = "internal"

LANGUAGE

val LANGUAGE: String = "language"

language

open val language: String

LAST_NAME

val LAST_NAME: String = "last_name"

LAST_TOKEN_ROTATION_TIME

val LAST_TOKEN_ROTATION_TIME: String = "lastTokenRotationTime"

lastName

open val lastName: String

lastTokenRotationTime

open var lastTokenRotationTime: String

LIGHTNING_DOMAIN

val LIGHTNING_DOMAIN: String = "lightningDomain"

LIGHTNING_SID

val LIGHTNING_SID: String = "lightningSid"

lightningDomain

open val lightningDomain: String

lightningSid

open val lightningSid: String

LOCALE

val LOCALE: String = "locale"

locale

open val locale: String

LOGIN_SERVER

val LOGIN_SERVER: String = "loginServer"

loginServer

open val loginServer: String

NATIVE_LOGIN

val NATIVE_LOGIN: String = "native_login"

nativeLogin

open val nativeLogin: Boolean

ORG_ID

val ORG_ID: String = "orgId"

orgId

open val orgId: String

PARENT_SID

val PARENT_SID: String = "parentSid"

parentSid

open val parentSid: String

PHOTO_URL

val PHOTO_URL: String = "photoUrl"

photoUrl

open val photoUrl: String

REDIRECT_URI

val REDIRECT_URI: String = "redirectUri"

redirectUri

open val redirectUri: String

REFRESH_TOKEN

val REFRESH_TOKEN: String = "refreshToken"

refreshToken

open val refreshToken: String

SCOPE

val SCOPE: String = "scope"

scope

open val scope: String

SID_COOKIE_NAME

val SID_COOKIE_NAME: String = "sidCookieName"

sidCookieName

open val sidCookieName: String

THUMBNAIL_URL

val THUMBNAIL_URL: String = "thumbnailUrl"

thumbnailUrl

open val thumbnailUrl: String

TOKEN_FORMAT

val TOKEN_FORMAT: String = "tokenFormat"

TOKEN_TYPE

val TOKEN_TYPE: String = "tokenType"

tokenFormat

open val tokenFormat: String

tokenType

open var tokenType: String

USER_ID

val USER_ID: String = "userId"

userId

open val userId: String

USERNAME

val USERNAME: String = "username"

username

open val username: String

VF_DOMAIN

val VF_DOMAIN: String = "vfDomain"

VF_SID

val VF_SID: String = "vfSid"

vfDomain

open val vfDomain: String

vfSid

open val vfSid: String

Functions

downloadProfilePhoto

open fun downloadProfilePhoto()

Fetches this user's profile photo from the server and stores it in the cache.

equals

open fun equals(object: Any): Boolean

getClientIdForRefresh

open fun getClientIdForRefresh(): String

Returns the oauth client id to use for refresh In the case of beacon app, the beacon child consumer key returned during login should be used instead of the configured consumer key

getCommunityLevelFilenameSuffix

open fun getCommunityLevelFilenameSuffix(): String

open fun getCommunityLevelFilenameSuffix(communityId: String): String

Returns a unique suffix for this user account, that can be appended to a file to uniquely identify this account, at a community level.

getCommunityLevelStoragePath

open fun getCommunityLevelStoragePath(): String

open fun getCommunityLevelStoragePath(communityId: String): String

Returns the storage path for this user account, relative to the higher level directory of app data.

getOrgLevelFilenameSuffix

open fun getOrgLevelFilenameSuffix(): String

Returns a unique suffix for this user account, that can be appended to a file to uniquely identify this account, at an org level.

getOrgLevelStoragePath

open fun getOrgLevelStoragePath(): String

Returns the org level storage path for this user account, relative to the higher level directory of app data.

getProfilePhoto

open fun getProfilePhoto(): Bitmap

Fetches this user's profile photo from the cache.

getRefreshTokenForPersistence

open fun getRefreshTokenForPersistence(): String

Returns the in-memory refresh token snapshot, without consulting AccountManager.

getUserLevelFilenameSuffix

open fun getUserLevelFilenameSuffix(): String

Returns a unique suffix for this user account, that can be appended to a file to uniquely identify this account, at a user level.

getUserLevelStoragePath

open fun getUserLevelStoragePath(): String

Returns the user level storage path for this user account, relative to the higher level directory of app data.

hashCode

open fun hashCode(): Int

hasScope

open fun hasScope(scopeToCheck: String): Boolean

Checks whether the provided scope exists in this account's scope list.

isSameUser

fun UserAccount?.isSameUser(clientInfo: RestClient.ClientInfo?): Boolean

Returns whether this account and an authenticated REST client represent the same Salesforce user.

toBundle

open fun toBundle(): Bundle

Returns a representation of this instance in a bundle.

toJson

open fun toJson(): JSONObject

Returns a JSON representation of this instance.