GenericDocument

GenericDocument

protected GenericDocument(document: GenericDocument)

Creates a new GenericDocument from an existing instance.

This method should be only used by constructor of a subclass.

equals

open 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.

getCreationTimestampMillis

open fun getCreationTimestampMillis(): Long

Returns the creation timestamp of the GenericDocument, in milliseconds.

The value is in the System#currentTimeMillis time base.
Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

getId

open fun getId(): String

Returns the unique identifier of the GenericDocument.

getMaxIndexedProperties

open static fun getMaxIndexedProperties(): Int

The maximum number of indexed properties a document can have.

Indexed properties are properties which are strings where the android.app.appsearch.AppSearchSchema.StringPropertyConfig#getIndexingType value is anything other than android.app.appsearch.AppSearchSchema.StringPropertyConfig#INDEXING_TYPE_NONE, as well as long properties where the AppSearchSchema.LongPropertyConfig#getIndexingType value is android.app.appsearch.AppSearchSchema.LongPropertyConfig#INDEXING_TYPE_RANGE.

getNamespace

open fun getNamespace(): String

Returns the namespace of the GenericDocument.

getProperty

open fun getProperty(path: String): Any?

Retrieves the property value with the given path as Object.

A path can be a simple property name, such as those returned by getPropertyNames. It may also be a dot-delimited path through the nested document hierarchy, with nested GenericDocument properties accessed via '.' and repeated properties optionally indexed into via [n].

For example, given the following GenericDocument:

(Message) {
          from: "sender@example.com"
          to: [{
              name: "Albert Einstein"
              email: "einstein@example.com"
            }, {
              name: "Marie Curie"
              email: "curie@example.com"
            }]
          tags: ["important", "inbox"]
          subject: "Hello"
      }
  

Here are some example paths and their results:

• "from" returns "sender@example.com" as a String array with one element
• "to" returns the two nested documents containing contact information as a GenericDocument array with two elements
• "to[1]" returns the second nested document containing Marie Curie's contact information as a GenericDocument array with one element
• "to[1].email" returns "curie@example.com"
• "to[100].email" returns null as this particular document does not have that many elements in its "to" array.
• "to.email" aggregates emails across all nested documents that have them, returning ["einstein@example.com", "curie@example.com"] as a String array with two elements.

If you know the expected type of the property you are retrieving, it is recommended to use one of the typed versions of this method instead, such as getPropertyString or getPropertyStringArray.

If the property was assigned as an empty array using one of the Builder#setProperty functions, this method will return an empty array. If no such property exists at all, this method returns null.

Note: If the property is an empty GenericDocument[] or byte[][], this method will return a null value in versions of Android prior to Android T. Starting in Android T it will return an empty array if the property has been set as an empty array, matching the behavior of other property types.

getPropertyBoolean

open fun getPropertyBoolean(path: String): Boolean

Retrieves a boolean property by path.

See getProperty for a detailed description of the path syntax.

getPropertyBooleanArray

open fun getPropertyBooleanArray(path: String): BooleanArray?

Retrieves a repeated boolean property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via Builder#setPropertyBoolean, this method returns null.

If it has been set via Builder#setPropertyBoolean to an empty boolean[], this method returns an empty boolean[].

getPropertyBytes

open fun getPropertyBytes(path: String): ByteArray?

Retrieves a byte[] property by path.

See getProperty for a detailed description of the path syntax.

getPropertyBytesArray

open fun getPropertyBytesArray(path: String): Array<ByteArray!>?

Retrieves a byte[][] property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via Builder#setPropertyBytes, this method returns null.

If it has been set via Builder#setPropertyBytes to an empty byte[][], this method returns an empty byte[][] starting in Android T and null in earlier versions of Android.

getPropertyDocument

open fun getPropertyDocument(path: String): GenericDocument?

Retrieves a GenericDocument property by path.

See getProperty for a detailed description of the path syntax.

getPropertyDocumentArray

open fun getPropertyDocumentArray(path: String): Array<GenericDocument!>?

Retrieves a repeated GenericDocument property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via Builder#setPropertyDocument, this method returns null.

If it has been set via Builder#setPropertyDocument to an empty GenericDocument[], this method returns an empty GenericDocument[] starting in Android T and null in earlier versions of Android.

getPropertyDouble

open fun getPropertyDouble(path: String): Double

Retrieves a double property by path.

See getProperty for a detailed description of the path syntax.

getPropertyDoubleArray

open fun getPropertyDoubleArray(path: String): DoubleArray?

Retrieves a repeated double property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via Builder#setPropertyDouble, this method returns null.

If it has been set via Builder#setPropertyDouble to an empty double[], this method returns an empty double[].

getPropertyLong

open fun getPropertyLong(path: String): Long

Retrieves a long property by path.

See getProperty for a detailed description of the path syntax.

getPropertyLongArray

open fun getPropertyLongArray(path: String): LongArray?

Retrieves a repeated long[] property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via Builder#setPropertyLong, this method returns null.

If it has been set via Builder#setPropertyLong to an empty long[], this method returns an empty long[].

getPropertyNames

open fun getPropertyNames(): MutableSet<String!>

Returns the names of all properties defined in this document.

getPropertyString

open fun getPropertyString(path: String): String?

Retrieves a String property by path.

See getProperty for a detailed description of the path syntax.

getPropertyStringArray

open fun getPropertyStringArray(path: String): Array<String!>?

Retrieves a repeated String property by path.

See getProperty for a detailed description of the path syntax.

If the property has not been set via Builder#setPropertyString, this method returns null.

If it has been set via Builder#setPropertyString to an empty String[], this method returns an empty String[].

getSchemaType

open fun getSchemaType(): String

Returns the AppSearchSchema type of the GenericDocument.

getScore

open fun getScore(): Int

Returns the score of the GenericDocument.

The score is a query-independent measure of the document's quality, relative to other GenericDocument objects of the same AppSearchSchema type.

Results may be sorted by score using android.app.appsearch.SearchSpec.Builder#setRankingStrategy. Documents with higher scores are considered better than documents with lower scores.

Any non-negative integer can be used a score.

getTtlMillis

open fun getTtlMillis(): Long

Returns the TTL (time-to-live) of the GenericDocument, in milliseconds.

The TTL is measured against getCreationTimestampMillis. At the timestamp of creationTimestampMillis + ttlMillis, measured in the System#currentTimeMillis time base, the document will be auto-deleted.

The default value is 0, which means the document is permanent and won't be auto-deleted until the app is uninstalled or android.app.appsearch.AppSearchSession#remove is called.

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Returns a string representation of the object.