Ditto 1.1.8
Classes | Public Member Functions | List of all members
DittoSDK.DittoLiveQueryEvent Class Reference

Describes events delivered by a DittoLiveQuery. More...

Inheritance diagram for DittoSDK.DittoLiveQueryEvent:
DittoSDK.DittoLiveQueryEvent.Initial DittoSDK.DittoLiveQueryEvent.Update

Classes

class  Initial
 A type used for the first event delivered for a live query. More...
 
class  Update
 A description of updates that occurred between the current and previous times that the live query handler was fired. More...
 

Public Member Functions

ulong Hash (List< DittoDocument > documents)
 Returns a hash that represents the set of matching documents. More...
 
string HashMnemonic (List< DittoDocument > documents)
 Returns a pattern of words that together create a mnemonic, which represents the set of matching documents. More...
 

Detailed Description

Describes events delivered by a DittoLiveQuery.

Only the first event in a live query's lifetime will be a DittoLiveQueryEvent.Initial event.

Member Function Documentation

◆ Hash()

ulong DittoSDK.DittoLiveQueryEvent.Hash ( List< DittoDocument documents)
inline

Returns a hash that represents the set of matching documents.

Parameters
documentsThe list of matching documents from the live query event.
Returns
A hash that represents the set of matching documents.

◆ HashMnemonic()

string DittoSDK.DittoLiveQueryEvent.HashMnemonic ( List< DittoDocument documents)
inline

Returns a pattern of words that together create a mnemonic, which represents the set of matching documents.

Parameters
documentsThe list of matching documents from the live query event.
Returns
A pattern of words that together create a mnemonic, which represents the set of matching documents.