OMCLocationObject Class Reference

Inherits from	NSObject
Declared in	OMCLocationObject.h

Overview

A location object is one of the major components of the Location service model. It can represent an asset, device, or place.

`location`

The location object’s location service proxy.

@property (readonly) OMCLocation *location

Declared In

OMCLocationObject.h

`properties`

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

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

Declared In

OMCLocationObject.h

`id_`

The location object’s ID, a unique number generated by the Location service.

@property (readonly) NSNumber *id_

Declared In

OMCLocationObject.h

`name`

The location object’s name.

@property (readonly) NSString *name

Declared In

OMCLocationObject.h

`description_`

The location object’s description.

@property (readonly, nullable) NSString *description_

Declared In

OMCLocationObject.h

`createdBy`

The name of the user who created the location object.

@property (readonly, nullable) NSString *createdBy

Declared In

OMCLocationObject.h

`createdOn`

The date the location object was created.

@property (readonly, nullable) NSDate *createdOn

Declared In

OMCLocationObject.h

`modifiedBy`

The name of the user who last modified the location object.

@property (readonly, nullable) NSString *modifiedBy

Declared In

OMCLocationObject.h

`modifiedOn`

The date the location object was last modified.

@property (readonly, nullable) NSDate *modifiedOn

Declared In

OMCLocationObject.h

`attributes`

A dictionary of user-defined string attributes.

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

Declared In

OMCLocationObject.h

`– attributeForKey:`

Returns the value of the specified attribute.

- (nullable NSString *)attributeForKey:(NSString *)key

Parameters

`key`	The attribute’s user-defined key.

Declared In

OMCLocationObject.h

`– refreshWithCompletionHandler:`

Asynchronously refreshes the object’s state from the Location service and invokes the specified completion handler when complete.

- (void)refreshWithCompletionHandler:(OMCErrorCompletionBlock)completionHandler

Parameters

`completionHandler`	The block invoked when the request to the Location service is finished. The completion block will be invoked on the main dispatch queue.

Declared In

OMCLocationObject.h