ILiveQuery Interface

An interface for a query which reports any changes in its rows in real time. This API is not yet finalized. It WILL change.

Namespace: Couchbase.Lite.Query
Assembly: Couchbase.Lite (in Couchbase.Lite.dll) Version: 2.0.0-b0154

Syntax

public interface ILiveQuery : IDisposable

The ILiveQuery type exposes the following members.

Properties

	Name	Description
	LastError	If not null, the error of the last execution of the query. Otherwise, the query was sucessful
	Rows	The last retrieved rows from this query
	UpdateInterval	Gets or sets the shortest interval at which the query will update, regardless of how often the database changes. Defaults to 0.2 seconds. Increase this if the query is expensive and the database updates frequently to limit CPU consumption.

Methods

	Name	Description
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	Start	Starts the monitoring process for the live query (to stop, the live query must be disposed). Accessing Rows will automatically call this.
	Stop	Stops observing the database for changes. Calling Start or Rows will restart it.

Events

	Name	Description
	Changed	An event that fires when the query's result set has changed

Remarks

This API is not yet finalized. It WILL change.