TimingManagement | @signageos/sdk

Hierarchy

TimingManagement

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TimingManagement(options: IOptions): TimingManagement

- Defined in src/RestApi/Timing/TimingManagement.ts:19
Parameters
- options: IOptions
Returns TimingManagement

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

Private timingCommandManagement

timingCommandManagement: TimingCommandManagement = new TimingCommandManagement(this.options)

Static Private Readonly RESOURCE

RESOURCE: string = "timing"

Methods

Private areDataSame

areDataSame(t1: ITimingCreateOnly & ITimingUpdatable, t2: ITimingCreateOnly & ITimingUpdatable): boolean

- Defined in src/RestApi/Timing/TimingManagement.ts:75
Parameters
- t1: ITimingCreateOnly & ITimingUpdatable
- t2: ITimingCreateOnly & ITimingUpdatable
Returns boolean

Private assertV1

assertV1(): void

- Defined in src/RestApi/Timing/TimingManagement.ts:69
Returns void

create

create(data: ITimingCreateOnly & ITimingUpdatable): Promise<Timing>

- Defined in src/RestApi/Timing/TimingManagement.ts:23
Parameters
- data: ITimingCreateOnly & ITimingUpdatable
Returns Promise<Timing>

delete

delete(timingUid: string): Promise<void>

- Defined in src/RestApi/Timing/TimingManagement.ts:52
Parameters
- timingUid: string
Returns Promise<void>

get

get(timingUid: string): Promise<Timing>

- Defined in src/RestApi/Timing/TimingManagement.ts:63
Parameters
- timingUid: string
Returns Promise<Timing>

getList

getList(filter?: ITimingFilter): Promise<Timing[]>

- Defined in src/RestApi/Timing/TimingManagement.ts:56
Parameters
- Default value filter: ITimingFilter = {}
Returns Promise<Timing[]>

update

update(timingUid: string, data: ITimingUpdatable): Promise<Timing>

- Defined in src/RestApi/Timing/TimingManagement.ts:38
Parameters
- timingUid: string
- data: ITimingUpdatable
Returns Promise<Timing>

Generated using TypeDoc