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 |
Public methods | |
---|---|
Boolean |
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 |
hashCode() |
String |
toString() Returns a string representation of the object. |
Public constructors
DocumentChangeInfo
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
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. |
getChangedDocumentIds
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
fun getDatabaseName(): String
Returns the database in which the documents that was changed reside.
Return | |
---|---|
String |
This value cannot be null . |
getNamespace
fun getNamespace(): String
Returns the namespace of the documents that changed.
Return | |
---|---|
String |
This value cannot be null . |
getPackageName
fun getPackageName(): String
Returns the package name of the app which owns the documents that changed.
Return | |
---|---|
String |
This value cannot be null . |
getSchemaName
fun getSchemaName(): String
Returns the name of the schema type that contains the changed documents.
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 . |