Appearition Platform JS

Namespace: Manage

Appearition.Location.Manage

Use the functions under this module to manage AR Locations

Version:
  • 1.0.0
Author:
  • Appearition Pty Ltd
Copyright:
  • Copyright (c) 2019. All rights reserved

Methods

Appearition.Location.Manage.AddProperty (arLocationId, arLocationProperty, requestOptions) static

Adds a new key value property to the location

Name Type Description
arLocationId number

identifies the location record
arLocationProperty Appearition.Location.Manage.ArLocationProperty

Data structure containing the property to add
requestOptions Appearition.RequestOptions

Configure the request and callbacks

Appearition.Location.Manage.DeleteProperty (arLocationId, propertyKey, requestOptions) static

Deletes an existing property on the location

Name Type Description
arLocationId number

identifies the location record
propertyKey string

identifies the property to delete
requestOptions Appearition.RequestOptions

Configure the request and callbacks

Appearition.Location.Manage.GetProperties (arLocationId, requestOptions)Array.<Appearition.Location.Manage.ArLocationProperty> static

Retrieves all of the locations for a given channel Id

Name Type Description
arLocationId number

identifies the location record
requestOptions Appearition.RequestOptions

Configure the request and callbacks
Returns:
Type Description
Array.<Appearition.Location.Manage.ArLocationProperty> Collection of key value pairs

Appearition.Location.Manage.UpdateProperty (arLocationId, arLocationProperty, requestOptions) static

Updates the value of an existing property on the location

Name Type Description
arLocationId number

identifies the location record
arLocationProperty Appearition.Location.Manage.ArLocationProperty

Data structure containing the property to update
requestOptions Appearition.RequestOptions

Configure the request and callbacks

Type Definitions

Appearition.Location.Manage.ArLocationProperty

This is the data structure that represents a key/value property

Properties:
Name Type Description
propertyKey string

identifies the key
propertyValue string

the value set as the property