Added in API level 33
Also in T Extensions 3

DocumentChangeInfo

class DocumentChangeInfo
kotlin.Any
   ↳ android.app.appsearch.observer.DocumentChangeInfo

Contains information about an individual change detected by an ObserverCallback.

This class reports information about document changes, that is, when documents were added, updated or removed.

Changes are grouped by package, database, schema type and namespace. Each unique combination of these items will generate a unique DocumentChangeInfo.

Notifications are only sent for documents whose schema type matches an observer's schema filters (as determined by ObserverSpec.getFilterSchemas).

Note that document changes that happen during schema migration from calling android.app.appsearch.AppSearchSession#setSchema are not reported via this class. Such changes are reported through SchemaChangeInfo.

Summary

Public constructors
DocumentChangeInfo(packageName: String, database: String, namespace: String, schemaName: String, changedDocumentIds: MutableSet<String!>)

Constructs a new DocumentChangeInfo.
Public methods
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
MutableSet<String!>

Returns the set of document IDs that have been changed as part of this notification.
String

Returns the database in which the documents that was changed reside.
String

Returns the namespace of the documents that changed.
String

Returns the package name of the app which owns the documents that changed.
String

Returns the name of the schema type that contains the changed documents.
Int

Returns a hash code value for the object.
String

Returns a string representation of the object.

Public constructors

DocumentChangeInfo

Added in API level 33
Also in T Extensions 3
DocumentChangeInfo(
    packageName: String, 
    database: String, 
    namespace: String, 
    schemaName: String, 
    changedDocumentIds: MutableSet<String!>)

Constructs a new DocumentChangeInfo.

Parameters
packageName String: The package name of the app which owns the documents that changed.
This value cannot be null.
database String: The database in which the documents that changed reside.
This value cannot be null.
namespace String: The namespace in which the documents that changed reside.
This value cannot be null.
schemaName String: The name of the schema type that contains the changed documents.
This value cannot be null.
changedDocumentIds MutableSet<String!>: The set of document IDs that have been changed as part of this notification.
This value cannot be null.

Public methods

equals

Added in API level 33
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.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getChangedDocumentIds

Added in API level 33
Also in T Extensions 3
fun getChangedDocumentIds(): MutableSet<String!>

Returns the set of document IDs that have been changed as part of this notification.

This will never be empty.

Return
MutableSet<String!> This value cannot be null.

getDatabaseName

Added in API level 33
Also in T Extensions 3
fun getDatabaseName(): String

Returns the database in which the documents that was changed reside.

Return
String This value cannot be null.

getNamespace

Added in API level 33
Also in T Extensions 3
fun getNamespace(): String

Returns the namespace of the documents that changed.

Return
String This value cannot be null.

getPackageName

Added in API level 33
Also in T Extensions 3
fun getPackageName(): String

Returns the package name of the app which owns the documents that changed.

Return
String This value cannot be null.

getSchemaName

Added in API level 33
Also in T Extensions 3
fun getSchemaName(): String

Returns the name of the schema type that contains the changed documents.

Return
String This value cannot be null.

hashCode

Added in API level 33
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.

toString

Added in API level 33
fun toString(): String

Returns a string representation of the object.

Return
String This value cannot be null.