Added in API level 33
Also in T Extensions 3

SchemaChangeInfo

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

Contains information about a schema change detected by an ObserverCallback.

This object will be sent when a schema type having a name matching an observer's schema filters (as determined by ObserverSpec.getFilterSchemas) has been added, updated, or removed.

Note that schema changes may cause documents to be migrated or removed. When this happens, individual document updates will NOT be dispatched via DocumentChangeInfo. The only notification will be of the schema type change via SchemaChangeInfo. Depending on your use case, you may need to re-query the whole schema type when this happens.

Summary

Public constructors
SchemaChangeInfo(packageName: String, databaseName: String, changedSchemaNames: MutableSet<String!>)

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

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

Returns the names of schema types affected by this change notification.
String

Returns the database in which the schema that was changed resides.
String

Returns the package name of the app which owns the schema that changed.
Int

String

Returns a string representation of the object.

Public constructors

SchemaChangeInfo

Added in API level 33
Also in T Extensions 3
SchemaChangeInfo(
    packageName: String, 
    databaseName: String, 
    changedSchemaNames: MutableSet<String!>)

Constructs a new SchemaChangeInfo.

Parameters
packageName String: The package name of the app which owns the schema that changed. This value cannot be null.
databaseName String: The database in which the schema that changed resides. This value cannot be null.
changedSchemaNames MutableSet<String!>: Names of schemas that have 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.

getChangedSchemaNames

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

Returns the names of schema types affected by this change 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 schema that was changed resides.

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 schema that changed.

Return
String This value cannot be null.

hashCode

Added in API level 33
fun hashCode(): Int
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.