Interface Config

Device configurations (xConfigs) are typically permanent settings that are set by admins, such as default volume, wallpapers, digital signage, network settings, security policies etc.

Find and read more about them on roomos.cisco.com.

Scopes required: spark-admin:devices_read and spark-admin:devices_write

The module is a wrapper fot for the Device Configurations API.

It is not possible to subscribe to config notifications. Also, unlike device status and events, you do not need to add the specific configs to the manifest.

Hierarchy

  • Config

Properties

get set setMany

Properties

get

get: ((deviceId, path) => Promise<string | number | DataObject>)

Type declaration

    • (deviceId, path): Promise<string | number | DataObject>

    • Parameters

      • deviceId: string
      • path: string

      Returns Promise<string | number | DataObject>

set

set: ((deviceId, path, value) => Promise<DataObject>)

Type declaration

    • (deviceId, path, value): Promise<DataObject>

    • Requires the spark-admin:devices-write scope

      Parameters

      • deviceId: string
      • path: string
      • value: string | number

      Returns Promise<DataObject>

setMany

setMany: ((deviceId, values) => Promise<DataObject>)

Type declaration

    • (deviceId, values): Promise<DataObject>

    • Set multiple configs on a device with a single HTTP call. Requires the spark-admin:devices-write scope.

      Configs are set as key/value pairs in an object. Remember to use apostrophes for the keys too, since they usually contain dots.

      Eg:

      const configs = { 'Audio.DefaultVolume': 60, 'SystemUnit.TimeZone': 'Africa/Abidjan' };
      await integration.xapi.config.setMany(deviceId, configs);

      Parameters

      Returns Promise<DataObject>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc