TimingCommandManagement | @signageos/sdk

Hierarchy

TimingCommandManagement

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TimingCommandManagement(options: IOptions): TimingCommandManagement

- Defined in src/RestApi/Timing/Command/TimingCommandManagement.ts:17
Parameters
- options: IOptions
Returns TimingCommandManagement

Properties

Readonly DURATION

DURATION: string = "DURATION"

Readonly IDLE_TIMEOUT

IDLE_TIMEOUT: string = "IDLE_TIMEOUT"

Readonly SCREEN_TAP

SCREEN_TAP: string = "SCREEN_TAP"

Private options

options: IOptions

Static Private Readonly RESOURCE

RESOURCE: string[] = ['device', 'applet', 'command']

Methods

create

create<TCommandPayload>(timingCommandData: ITimingCommandCreateOnly<TCommandPayload>): Promise<TimingCommand<TCommandPayload>>

- Defined in src/RestApi/Timing/Command/TimingCommandManagement.ts:62
Type parameters
- TCommandPayload: ITimingCommandPayload
Parameters
- timingCommandData: ITimingCommandCreateOnly<TCommandPayload>
Returns Promise<TimingCommand<TCommandPayload>>

get

get<TCommandPayload>(deviceUid: string, appletUid: string, timingCommandUid: string): Promise<TimingCommand<TCommandPayload>>

- Defined in src/RestApi/Timing/Command/TimingCommandManagement.ts:40
Type parameters
- TCommandPayload: ITimingCommandPayload
Parameters
- deviceUid: string
- appletUid: string
- timingCommandUid: string
Returns Promise<TimingCommand<TCommandPayload>>

getList

getList<TCommandPayload>(filter: ITimingCommandFilter): Promise<TimingCommand<TCommandPayload>[]>

- Defined in src/RestApi/Timing/Command/TimingCommandManagement.ts:21
Type parameters
- TCommandPayload: ITimingCommandPayload
Parameters
- filter: ITimingCommandFilter
Returns Promise<TimingCommand<TCommandPayload>[]>

Generated using TypeDoc