Added in API level 37
Also in T Extensions 22

AppSearchAccount

Kotlin |Java

public final class AppSearchAccount
extends GenericDocument

java.lang.Object
↳	android.app.appsearch.GenericDocument
	↳	android.app.appsearch.AppSearchAccount

Encapsulates a GenericDocument representing an Account.

In AppSearch, an Account is used to partition data and manage its lifecycle. By associating indexed documents with an AppSearchAccount, the system can perform automated wipeout documents when an account is removed from the device.

This class provides a standardized way for AppSearch to recognize which data belongs to which user identity in multi-login or synced environments.

This class is a higher level implement of GenericDocument.

Summary

Nested classes
`class`	`AppSearchAccount.Builder` The builder class for `AppSearchAccount`.

Constants
`String`	`SCHEMA_TYPE` The name of the schema type for `AppSearchAccount` documents.

Fields
`public static final AppSearchSchema`	`SCHEMA`

Public constructors
`AppSearchAccount(GenericDocument document)` Creates a new `AppSearchAccount` from the contents of an existing `GenericDocument`.

Public methods
`String`	`getAccountId()` Gets the account id of `AppSearchAccount` or `null` if it's not been set yet.
`String`	`getAccountName()` Gets the name of `AppSearchAccount` or `null` if it's not been set yet.
`String`	`getAccountType()` Gets the type of `AppSearchAccount` or `null` if it's not been set yet.

Inherited methods

From class


        
          android.app.appsearch.GenericDocument

`boolean`	`equals(Object other)` Indicates whether some other object is "equal to" this one.
`long`	`getCreationTimestampMillis()` Returns the creation timestamp of the `GenericDocument`, in milliseconds.
`String`	`getId()` Returns the unique identifier of the `GenericDocument`.
`static int`	`getMaxIndexedProperties()` The maximum number of indexed properties a document can have.
`String`	`getNamespace()` Returns the namespace of the `GenericDocument`.
`Object`	`getProperty(String path)` Retrieves the property value with the given path as `Object`.
`AppSearchBlobHandle`	`getPropertyBlobHandle(String path)` Retrieves an `AppSearchBlobHandle` property by path.
`AppSearchBlobHandle[]`	`getPropertyBlobHandleArray(String path)` Retrieves a repeated `AppSearchBlobHandle[]` property by path.
`boolean`	`getPropertyBoolean(String path)` Retrieves a `boolean` property by path.
`boolean[]`	`getPropertyBooleanArray(String path)` Retrieves a repeated `boolean` property by path.
`byte[]`	`getPropertyBytes(String path)` Retrieves a `byte[]` property by path.
`byte[][]`	`getPropertyBytesArray(String path)` Retrieves a `byte[][]` property by path.
`GenericDocument`	`getPropertyDocument(String path)` Retrieves a `GenericDocument` property by path.
`GenericDocument[]`	`getPropertyDocumentArray(String path)` Retrieves a repeated `GenericDocument` property by path.
`double`	`getPropertyDouble(String path)` Retrieves a `double` property by path.
`double[]`	`getPropertyDoubleArray(String path)` Retrieves a repeated `double` property by path.
`EmbeddingVector`	`getPropertyEmbedding(String path)` Retrieves an `EmbeddingVector` property by path.
`EmbeddingVector[]`	`getPropertyEmbeddingArray(String path)` Retrieves a repeated `EmbeddingVector[]` property by path.
`long`	`getPropertyLong(String path)` Retrieves a `long` property by path.
`long[]`	`getPropertyLongArray(String path)` Retrieves a repeated `long[]` property by path.
`Set<String>`	`getPropertyNames()` Returns the names of all properties defined in this document.
`String`	`getPropertyString(String path)` Retrieves a `String` property by path.
`String[]`	`getPropertyStringArray(String path)` Retrieves a repeated `String` property by path.
`String`	`getSchemaType()` Returns the `AppSearchSchema` type of the `GenericDocument`.
`int`	`getScore()` Returns the score of the `GenericDocument`.
`long`	`getTtlMillis()` Returns the TTL (time-to-live) of the `GenericDocument`, in milliseconds.
`int`	`hashCode()` Returns a hash code value for the object.
`String`	`toString()` Returns a string representation of the object.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

SCHEMA_TYPE

Added in API level 37
Also in T Extensions 22

public static final String SCHEMA_TYPE

The name of the schema type for AppSearchAccount documents.

Constant Value: "builtin:Account"

Fields

SCHEMA

Added in API level 37
Also in T Extensions 22

public static final AppSearchSchema SCHEMA

Public constructors