QueryEnumerator

QueryEnumerator

An enumerator for Couchbase Lite View Query results.

Syntax


@interface CBLQueryEnumerator : NSEnumerator <NSCopying>
class CBLQueryEnumerator : NSEnumerator, NSCopying
public class QueryEnumerator
public class QueryEnumerator
public class QueryEnumerator

Summary


Properties
int
count { get; }
Gets the number of rows in the QueryEnumerator.
long
sequenceNumber { get; }
Gets the Database's sequence number at the time the View results were generated.
boolean
stale { get; }
Gets whether the Database has changed since the View results were generated.
Methods
QueryRow
getRow(int index)
Gets the QueryRow at the specified index in the results.
QueryRow
next()
Gets the next QueryRow from the results.
void
reset()
Resets the QueryEnumerator's cursor position so that the next call to next() will return the first row.

Properties


int count { get; }
Gets the number of rows in the QueryEnumerator.

Syntax

@property (readonly) NSUInteger count
var count: UInt { get }
public int getCount()
public int getCount()
public int Count { get; }
long sequenceNumber { get; }
Gets the Database's sequence number at the time the View results were generated.

Syntax

@property (readonly) UInt64 sequenceNumber
var sequenceNumber: UInt64 { get }
public long getSequenceNumber()
public long getSequenceNumber()
public long SequenceNumber { get; }
boolean stale { get; }
Gets whether the Database has changed since the View results were generated.

Syntax

@property (readonly) BOOL stale
var stale: Bool { get }
public boolean isStale()
public boolean isStale()
public Boolean Stale { get; }

Methods


QueryRow getRow(int index)
Gets the QueryRow at the specified index in the results.

Syntax

-(CBLQueryRow *)rowAtIndex:(NSUInteger)index
func rowAtIndex(index: UInt) -> CBLQueryRow!
public QueryRow getRow(int index)
public QueryRow getRow(int index)
public QueryRow GetRow(int index)
QueryRow next()
Gets the next QueryRow from the results.

Syntax

-(CBLQueryRow *)nextRow
func nextRow() -> CBLQueryRow!
public QueryRow next()
public QueryRow next()
public QueryRow Next()
void reset()
Resets the QueryEnumerator's cursor position so that the next call to next() will return the first row.

Syntax

-(void)reset
func reset()
public void reset()
public void reset()
public void Reset()