DittoLiveQueryEvent

sealed class DittoLiveQueryEvent
Content copied to clipboard

Describes the different types of event that you can receive when dealing with live queries.

  • Initial: The first event that will be delivered and it will only be delivered once.

  • Update: This event will be delivered each time the results of the provided query change. It contains information about the set of documents that previously matched the query before the update, along with information about what documents have been inserted, deleted, updated, or moved, as part of the set of matching documents.

Types

Initial
Link copied to clipboard
object Initial : DittoLiveQueryEvent
Content copied to clipboard
This type of event is delivered alongside the initial set matching documents for the live query.
Update
Link copied to clipboard
class Update(oldDocuments: List<DittoDocument>, insertions: List<Int>, deletions: List<Int>, updates: List<Int>, moves: List<DittoLiveQueryMove>) : DittoLiveQueryEvent
Content copied to clipboard
Provides information about the changes that have occurred in relation to a live query for a given update event.

Functions

hash
Link copied to clipboard
fun hash(documents: List<DittoDocument>): BigInteger
Content copied to clipboard
Returns a hash that represents the set of matching documents.
hashMnemonic
Link copied to clipboard
fun hashMnemonic(documents: List<DittoDocument>): String
Content copied to clipboard
Returns a pattern of words that together create a mnemonic, which represents the set of matching documents.

Inheritors

DittoLiveQueryEvent
Link copied to clipboard
DittoLiveQueryEvent
Link copied to clipboard