Added in API level 36

DefaultAccountAndState


class DefaultAccountAndState
kotlin.Any
   ↳ android.provider.ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState

Represents the state of the default account, and the actual Account if it's a cloud account. If the default account is set to DEFAULT_ACCOUNT_STATE_LOCAL or DEFAULT_ACCOUNT_STATE_CLOUD, new raw contacts requested for insertion without a specified Account will be saved in the default account. The default account can have one of the following four states:

Summary

Constants
static Int

A state indicating that the default account is set as an account that is synced to the cloud.

static Int

A state indicating that default account is set to local device storage.

static Int

A state indicating that default account is not set.

static Int

A state indicating that the default account is set as an account that is associated with one of SimContacts.getSimAccounts(ContentResolver).

Public methods
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

Account?

Int

Int

Returns a hash code value for the object.

static ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState
ofCloud(cloudAccount: Account)

Creates a `DefaultAccountAndState` instance representing a default account that is set to the cloud and associated with the specified cloud account.

static ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState

Creates a `DefaultAccountAndState` instance representing a default account that is set to the local device storage.

static ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState

Creates a `DefaultAccountAndState` instance representing a default account that is not set.

static ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState
ofSim(simAccount: Account)

Creates a `DefaultAccountAndState` instance representing a default account that is set to the sim and associated with the specified sim account.

Constants

DEFAULT_ACCOUNT_STATE_CLOUD

Added in API level 36
static val DEFAULT_ACCOUNT_STATE_CLOUD: Int

A state indicating that the default account is set as an account that is synced to the cloud.

Value: 3

DEFAULT_ACCOUNT_STATE_LOCAL

Added in API level 36
static val DEFAULT_ACCOUNT_STATE_LOCAL: Int

A state indicating that default account is set to local device storage.

Value: 2

DEFAULT_ACCOUNT_STATE_NOT_SET

Added in API level 36
static val DEFAULT_ACCOUNT_STATE_NOT_SET: Int

A state indicating that default account is not set.

Value: 1

DEFAULT_ACCOUNT_STATE_SIM

Added in API level 36
static val DEFAULT_ACCOUNT_STATE_SIM: Int

A state indicating that the default account is set as an account that is associated with one of SimContacts.getSimAccounts(ContentResolver).

Value: 4

Public methods

equals

Added in API level 36
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAccount

Added in API level 36
fun getAccount(): Account?
Return
Account? the cloud account associated with the default account if the state is DEFAULT_ACCOUNT_STATE_CLOUD or DEFAULT_ACCOUNT_STATE_SIM.
This value may be null.

getState

Added in API level 36
fun getState(): Int
Return
Int the state of the default account.
Value is one of the following:

hashCode

Added in API level 36
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

ofCloud

Added in API level 36
static fun ofCloud(cloudAccount: Account): ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState

Creates a `DefaultAccountAndState` instance representing a default account that is set to the cloud and associated with the specified cloud account.

Parameters
cloudAccount Account: The non-null cloud account associated with the default contacts account.
Return
ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState A new `DefaultAccountAndState` instance with state DEFAULT_ACCOUNT_STATE_CLOUD.
This value cannot be null.

ofLocal

Added in API level 36
static fun ofLocal(): ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState

Creates a `DefaultAccountAndState` instance representing a default account that is set to the local device storage.

Return
ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState A new `DefaultAccountAndState` instance with state DEFAULT_ACCOUNT_STATE_LOCAL.
This value cannot be null.

ofNotSet

Added in API level 36
static fun ofNotSet(): ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState

Creates a `DefaultAccountAndState` instance representing a default account that is not set.

Return
ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState A new `DefaultAccountAndState` instance with state DEFAULT_ACCOUNT_STATE_NOT_SET.
This value cannot be null.

ofSim

Added in API level 36
static fun ofSim(simAccount: Account): ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState

Creates a `DefaultAccountAndState` instance representing a default account that is set to the sim and associated with the specified sim account.

Parameters
simAccount Account: The non-null sim account associated with the default contacts account.
Return
ContactsContract.RawContacts.DefaultAccount.DefaultAccountAndState A new `DefaultAccountAndState` instance with state DEFAULT_ACCOUNT_STATE_SIM.
This value cannot be null.