Couchbase Lite
Objective-C API for iOS and Mac OS
CBLQueryRow.h
Go to the documentation of this file.
1 //
2 // CBLQueryRow.h
3 // CouchbaseLite
4 //
5 // Created by Jens Alfke on 2/2/17.
6 // Copyright © 2017 Couchbase. All rights reserved.
7 //
8 
9 #import <Foundation/Foundation.h>
10 @class CBLDocument;
11 
12 NS_ASSUME_NONNULL_BEGIN
13 
14 
17 @interface CBLQueryRow : NSObject
18 
20 @property (readonly, nonatomic) NSString* documentID;
21 
23 @property (readonly, nonatomic) uint64_t sequence;
24 
26 @property (readonly, nonatomic) CBLDocument* document;
27 
29 - (nullable id) valueAtIndex: (NSUInteger)index;
30 
31 - (bool) booleanAtIndex: (NSUInteger)index;
32 - (NSInteger) integerAtIndex: (NSUInteger)index;
33 - (float) floatAtIndex: (NSUInteger)index;
34 - (double) doubleAtIndex: (NSUInteger)index;
35 - (nullable NSString*) stringAtIndex: (NSUInteger)index;
36 - (nullable NSDate*) dateAtIndex: (NSUInteger)index;
37 
38 - (nullable id) objectAtIndexedSubscript: (NSUInteger)subscript;
39 
40 - (instancetype) init NS_UNAVAILABLE;
41 
42 @end
43 
44 
47 
50 @property (readonly, nullable) NSString* fullTextMatched;
51 
54 @property (readonly, nonatomic) NSUInteger matchCount;
55 
57 - (NSRange) textRangeOfMatch: (NSUInteger)matchNumber;
58 
62 - (NSUInteger) termIndexOfMatch: (NSUInteger)matchNumber;
63 
64 @end
65 
66 
67 NS_ASSUME_NONNULL_END
A Couchbase Lite document.
Definition: CBLDocument.h:36
NSString * documentID
The ID of the document that produced this row.
Definition: CBLQueryRow.h:20
CBLDocument * document
The document that produced this row.
Definition: CBLQueryRow.h:26
A single result from a CBLQuery.
Definition: CBLQueryRow.h:17
A single result from a full-text CBLQuery.
Definition: CBLQueryRow.h:46
uint64_t sequence
The sequence number of the document revision that produced this row.
Definition: CBLQueryRow.h:23
instancetype NS_UNAVAILABLE()