SFStoreCursor Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | SFStoreCursor.h |
cursorId
A unique ID for this cursor.
@property (nonatomic, readonly, strong) NSString *cursorIdDeclared In
SFStoreCursor.h
querySpec
The query spec that generated this cursor.
@property (nonatomic, readonly, strong) SFQuerySpec *querySpecDeclared In
SFStoreCursor.h
currentPageOrderedEntries
The list of current page entries, ordered as requested in the querySpec.
@property (nonatomic, readonly, strong) NSArray *currentPageOrderedEntriesDeclared In
SFStoreCursor.h
pageSize
The maximum number of entries returned per page.
@property (nonatomic, readonly, strong) NSNumber *pageSizeDeclared In
SFStoreCursor.h
totalPages
The total number of pages of results available.
@property (nonatomic, readonly, strong) NSNumber *totalPagesDeclared In
SFStoreCursor.h
totalEntries
The total number of entries.
@property (nonatomic, readonly, strong) NSNumber *totalEntriesDeclared In
SFStoreCursor.h
currentPageIndex
The current page index among totalPages available: writing this value causes currentPageOrderedEntries to be refetched.
@property (nonatomic, readwrite, strong, nullable) NSNumber *currentPageIndexDeclared In
SFStoreCursor.h
– initWithStore:querySpec:
Initializes a new instance of a soup cursor.
- (id)initWithStore:(SFSmartStore *)store querySpec:(SFQuerySpec *)querySpecParameters
store |
The store where the soup is contained. |
|---|---|
querySpec |
The query used to retrieve the data. |
Declared In
SFStoreCursor.h
– getDataSerialized:error:
Run query and resturn JSON serialized representation of the cursor.
- (nullable NSString *)getDataSerialized:(SFSmartStore *)store error:(NSError **)errorReturn Value
JSON serialized representation of this object.
Declared In
SFStoreCursor.h
– getDataDeserialized:error:
Run query and resturn NSDictionary (deserialized) representation of the cursor.
- (nullable NSDictionary *)getDataDeserialized:(SFSmartStore *)store error:(NSError **)errorReturn Value
NSDictionary representation of this object.
Declared In
SFStoreCursor.h