OMCLocationObjectQueryResult Class Reference

Conforms to *
:
ItemType
OMCLocationObject
OMCLocationObjectQuery
QueryType
__covariant
Declared in OMCLocationObjectQueryResult.h

Overview

A query result represents the results returned from the Location service for a particular query. Query results are immutable.

  query

The query that generated the result.

@property (readonly) QueryType query

Declared In

OMCLocationObjectQueryResult.h

  items

The items (assets, devices, or places) that match the original query’s search arguments.

@property (readonly) NSArray<ItemType> *items

Declared In

OMCLocationObjectQueryResult.h

  properties

The result’s raw properties (corresponding to the JSON payload).

@property (readonly) NSDictionary<NSString*id> *properties

Declared In

OMCLocationObjectQueryResult.h

  totalResults

The total number of items that match the original query’s search arguments, but may not all be returned in the result.

@property (readonly) NSNumber *totalResults

Declared In

OMCLocationObjectQueryResult.h

  offset

The offset of the items contained by the result.

@property (readonly) NSNumber *offset

Declared In

OMCLocationObjectQueryResult.h

  count

The number of items contained by the result.

@property (readonly) NSNumber *count

Declared In

OMCLocationObjectQueryResult.h

  limit

The requested limit of how many items were to be returned by the query.

@property (readonly) NSNumber *limit

Declared In

OMCLocationObjectQueryResult.h

  hasMore

Flag indicating whether there are more items to be fetched from the server that match the original query’s search arguments.

@property (readonly) BOOL hasMore

Declared In

OMCLocationObjectQueryResult.h

  nextQuery

Query that, when executed, will fetch the result’s “next” set of items.

@property (readonly) QueryType nextQuery

Declared In

OMCLocationObjectQueryResult.h

– nextWithCompletionHandler:

Asynchronously fetches the result’s “next” set of items, invoking the specified completion handler block when finished.

- (void)nextWithCompletionHandler:(void ( ^ ) ( OMCLocationObjectQueryResult<QueryType,ItemType> *_Nullable result , NSError *_Nullable error ))completionHandler

Parameters

completionHandler

The block to be invoked when the query has finished executing. The completion block will be invoked on the main dispatch queue.

Declared In

OMCLocationObjectQueryResult.h