OMCLocationObjectQuery Class Reference

Inherits from NSObject
Declared in OMCLocationObjectQuery.h

Overview

A location object query can be configured to search for the various location objects (assets, devices, or places).

  location

The location service against which the query will execute.

@property (readonly) OMCLocation *location

Declared In

OMCLocationObjectQuery.h

  properties

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

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

Declared In

OMCLocationObjectQuery.h

  name

The query’s results will be filtered on a case-insensitive partial match of this string with the location object’s user-defined name.

@property (nonatomic, nullable) NSString *name

See Also

Declared In

OMCLocationObjectQuery.h

  description_

The query’s results will be filtered on a case-insensitive partial match of this string with the location object’s user-defined description.

@property (nonatomic, nullable) NSString *description_

See Also

Declared In

OMCLocationObjectQuery.h

  search

The query’s results will be filtered on a case-insensitive partial match of this string with the location object’s user-defined name or description.

@property (nonatomic, nullable) NSString *search

See Also

Declared In

OMCLocationObjectQuery.h

  attributes

The query’s results will be filtered on a match of these attribute values with the location object’s user-defined attribute values.

@property (readonly) NSDictionary<NSString*NSString*> *attributes

See Also

Declared In

OMCLocationObjectQuery.h

– setAttribute:forKey:

Set the specified attribute’s value.

- (void)setAttribute:(NSString *)value forKey:(NSString *)key

Parameters

value

The attribute’s user-defined value.
key

The attribute’s user-defined key.

See Also

Declared In

OMCLocationObjectQuery.h

– removeAttributeForKey:

Remove the specified attribute’s value.

- (void)removeAttributeForKey:(NSString *)key

Parameters

key

The attribute’s user-defined key.

See Also

Declared In

OMCLocationObjectQuery.h

– setAttributes:

Set all the query’s attributes to the specified attributes.

- (void)setAttributes:(NSDictionary<NSString*,NSString*> *)attributes

Parameters

attributes

The query’s new set of attributes.

See Also

Declared In

OMCLocationObjectQuery.h

– addAttributes:

Add to the query’s attributes the specified set of attributes.

- (void)addAttributes:(NSDictionary<NSString*,NSString*> *)attributes

Parameters

attributes

The set of attributes to be added to the query’s current set of attributes.

See Also

Declared In

OMCLocationObjectQuery.h

– clearAttributes

Remove all the attribute values.

- (void)clearAttributes

See Also

Declared In

OMCLocationObjectQuery.h

  ids

The query’s results will be filtered to match this list of location object IDs.

@property (readonly) NSArray<NSNumber*> *ids

See Also

Declared In

OMCLocationObjectQuery.h

– addID:

Add the specified ID to the list of IDs the query will search for.

- (void)addID:(NSNumber *)id_

Parameters

id_

The ID to add to the query’s list of IDs.

See Also

Declared In

OMCLocationObjectQuery.h

– insertID:atIndex:

Insert the specified ID at the specified index of the list of IDs the query will search for.

- (void)insertID:(NSNumber *)id_ atIndex:(NSUInteger)index

Parameters

id_

The ID to add to the query’s list of IDs.
index

The index at which to insert the new ID.

See Also

Declared In

OMCLocationObjectQuery.h

– removeID:

Remove the specified ID from the list of IDs the query will search for.

- (void)removeID:(NSNumber *)id_

Parameters

id_

The ID to remove from the query’s list of IDs.

See Also

Declared In

OMCLocationObjectQuery.h

– removeIDAtIndex:

Remove the ID at the specified index from the list of IDs the query will search for.

- (void)removeIDAtIndex:(NSUInteger)index

Parameters

index

The index of the ID to remove from the query’s list of IDs.

See Also

Declared In

OMCLocationObjectQuery.h

– setIDs:

Set all the query’s IDs to the specified IDs.

- (void)setIDs:(NSArray<NSNumber*> *)ids

Parameters

ids

The query’s new list of IDs.

See Also

Declared In

OMCLocationObjectQuery.h

– addIDs:

Add to the query’s IDs the specified list of IDs.

- (void)addIDs:(NSArray<NSNumber*> *)ids

Parameters

ids

The set of IDs to be added to the query’s current list of IDs.

See Also

Declared In

OMCLocationObjectQuery.h

– clearIDs

Remove all the IDs.

- (void)clearIDs

See Also

Declared In

OMCLocationObjectQuery.h

  format

The format of the results returned by the query, which can be "long" or "short". When the requested format is "short", only a subset of the properties of each object will be populated. The 'id', 'name', and 'description' will be populated, along with any subclass-specific properties.

@property (nonatomic) OMCLocationObjectQueryFormatType format

Discussion

The default value is OMCLocationObjectQueryFormatTypeLong.

Declared In

OMCLocationObjectQuery.h

  orderByOrder

The order (ascending or descending) in which the query result’s items will be sorted. This property determines only the order of the query result’s items. The specific property by which the result’s items will be sorted is determined by the value of orderByAttribute, which is defined by OMCLocationDeviceContainerQuery or OMCLocationDeviceQuery.

@property (nonatomic) OMCLocationObjectQueryOrderByOrderType orderByOrder

Discussion

The default value is OMCLocationObjectQueryOrderByOrderTypeAscending.

See Also

Declared In

OMCLocationObjectQuery.h

  offset

Zero-based index of the first item to return in the results.

@property (nonatomic, nullable) NSNumber *offset

Discussion

The default value is 0.

Declared In

OMCLocationObjectQuery.h

  limit

The maximum number of items to return (in the range 0 to 100). If the requested limit is greater than 100, then 100 is substituted.

@property (nonatomic, nullable) NSNumber *limit

Discussion

The default value is determined by server.

Declared In

OMCLocationObjectQuery.h