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 |
Public methods | |
---|---|
Boolean |
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 |
hashCode() |
String |
toString() Returns a string representation of the object. |
Public constructors
SchemaChangeInfo
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
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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
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
fun getDatabaseName(): String
Returns the database in which the schema that was changed resides.
Return | |
---|---|
String |
This value cannot be null . |
getPackageName
fun getPackageName(): String
Returns the package name of the app which owns the schema that changed.
Return | |
---|---|
String |
This value cannot be null . |
toString
fun toString(): String
Returns a string representation of the object.
Return | |
---|---|
String |
This value cannot be null . |