DeviceManagement | @signageos/sdk

Hierarchy

DeviceManagement

Index

Constructors

constructor

Methods

Constructors

constructor

new DeviceManagement(accountOptions: IOptions, organizationOptions: IOptions): DeviceManagement

- Defined in src/RestApi/Device/DeviceManagement.ts:57
Parameters
- accountOptions: IOptions
- organizationOptions: IOptions
Returns DeviceManagement

Properties

Private accountOptions

accountOptions: IOptions

appVersion

appVersion: DeviceAppVersionManagement

appletTest

appletTest: DeviceAppletTestManagement

audio

audio: DeviceAudioManagement

authentication

authentication: DeviceAuthenticationManagement

autoRecovery

autoRecovery: DeviceAutoRecoveryManagement

brightness

brightness: DeviceBrightnessManagement

dateTime

dateTime: DeviceDateTimeManagement

debug

debug: DeviceDebugManagement

firmware

firmware: DeviceFirmwareManagement

monitoring

monitoring: DeviceMonitoringManagement

Private organizationOptions

organizationOptions: IOptions

package

package: DevicePackageManagement

peerRecovery

peerRecovery: DevicePeerRecoveryManagement

pinCode

pinCode: DevicePinCodeManagement

policy

policy: DevicePolicyManagement

policyStatus

policyStatus: DevicePolicyStatusManagement

powerAction

powerAction: DevicePowerActionManagement

provisioning

provisioning: DeviceProvisioningManagement

remoteControl

remoteControl: DeviceRemoteControlManagement

resolution

resolution: DeviceResolutionManagement

scheduledPowerAction

scheduledPowerAction: DeviceScheduledPowerActionManagement

screenshot

screenshot: DeviceScreenshotManagement

telemetry

telemetry: DeviceTelemetryManagement

timer

timer: DeviceTimerManagement

verification

verification: DeviceVerificationManagement

Methods

get

get(deviceUid: string, filter?: IDeviceFilter): Promise<IDevice>

- Defined in src/RestApi/Device/DeviceManagement.ts:105
deprecated

use api.device.get(deviceUid) from API v2 for general device info use api.device.deviceAlive.get(deviceUid) for device alive status use api.device.telemetry.getLatest(deviceUid) for latest telemetry readings

Parameters
- deviceUid: string
- Default value filter: IDeviceFilter = {}
Returns Promise<IDevice>

list

list(filter?: IDeviceFilter): Promise<IDevice[]>

- Defined in src/RestApi/Device/DeviceManagement.ts:92
deprecated

use api.device.list() from API v2 for general device info use api.device.deviceAlive.list() for device alive status use api.device.telemetry.listLatest() for latest telemetry readings

Parameters
- Default value filter: IDeviceFilter = {}
Returns Promise<IDevice[]>

set

set(deviceUid: string, settings: IDeviceUpdatable): Promise<void>

- Defined in src/RestApi/Device/DeviceManagement.ts:114
deprecated

use API v2 device set method

Parameters
- deviceUid: string
- settings: IDeviceUpdatable
Returns Promise<void>

Generated using TypeDoc