forgerock-authenticator

4.4.0

forgerock-authenticator/org.forgerock.android.auth/Account

Account

open class Account : ModelObject<T>

Account model represents an identity for the user with an issuer. It is possible for a user to have multiple accounts provided by a single issuer, however it is not possible to have multiple accounts from with same issuer for the same account name.

Constructors

protected constructor(issuer: String, displayIssuer: String, accountName: String, displayAccountName: String, imageURL: String, backgroundColor: String, timeAdded: Calendar, policies: String, lockingPolicy: String, lock: Boolean)

Creates Account object with given information.

Types

open class AccountBuilder

Builder class responsible for producing Accounts.

Properties

val accountName: String

AccountName, or Username of the account for the issuer

backgroundColor

val backgroundColor: String

HEX Color code in String for Account

displayAccountName

open var displayAccountName: String

Alternative AccountName for the issuer

open var displayIssuer: String

Alternative Issuer of the account

Unique identifier of Account

val imageURL: String

URL of Account's logo image

val issuer: String

Issuer of the account

private open var lock: Boolean

Account lock flag

open val lockingPolicy: String

Name of the Policy locking the Account

private open var mechanismList: List<Mechanism>

List of Mechanism objects associated with this account

val policies: String

Authenticator Policies in a JSON String format

val timeAdded: Calendar

Date this object was stored

Functions

open fun builder(): Account.AccountBuilder

Returns a builder for creating an Account.

open fun compareTo(another: Account): Int

open fun deserialize(jsonString: String): Account

Deserializes the specified Json into an object of the Account object.

open fun equals(o: Any): Boolean

open fun getDate(milliSeconds: Long): Calendar

Return date from milliseconds.

open fun getMechanisms(): List<Mechanism>

Get the list of mechanisms associates with this account.

open fun hashCode(): Int

open fun isLocked(): Boolean

Determine whether the this Account should be locked by the app.

open fun lock(@NonNull policy: FRAPolicy)

Lock this Account.

open fun matches(other: Account): Boolean

Returns true if the two objects would conflict if added to a storage system.

open fun serialize(): String

Serializes the T object into its equivalent Json representation.

setMechanismList

open fun setMechanismList(mechanismList: List<Mechanism>)

open fun toJson(): String

Creates a JSON string representation of T object.

open fun unlock()

Unlock this Account.