Timing | @signageos/sdk

Hierarchy

Timing

Implements

ITiming

Index

Constructors

constructor

Properties

Methods

Object literals

Constructors

constructor

new Timing(data: ITiming, timingManagement: TimingManagement, timingCommandManagement: TimingCommandManagement): Timing

- Defined in src/RestApi/Timing/Timing.ts:676
Parameters
- data: ITiming
- timingManagement: TimingManagement
- timingCommandManagement: TimingCommandManagement
Returns Timing

Properties

Readonly appletUid

appletUid: ITiming["appletUid"]

Readonly appletVersion

appletVersion: ITiming["appletVersion"]

Readonly configuration

configuration: ITiming["configuration"]

Readonly console

console: IConsole = ['log', 'error', 'warn', 'info', 'debug'].reduce<any>((consoleMemo: IConsole, level: string) => ({...consoleMemo,[level]: {getAll: async (since: Date = this.updatedAt) => {const timingCommands = await this.timingCommandManagement.getList<ConsoleLogged>({deviceUid: this.deviceUid,appletUid: this.appletUid,receivedSince: since.toISOString(),type: ConsoleLogged,});return _.flatMap(timingCommands.filter((timingCommand: TimingCommand<ConsoleLogged>) => timingCommand.commandPayload.level === level),(timingCommand: TimingCommand<ConsoleLogged>) => timingCommand.commandPayload.messages,);},},}),{},)

Readonly createdAt

createdAt: ITiming["createdAt"]

Readonly deviceUid

deviceUid: ITiming["deviceUid"]

Readonly endsAt

endsAt: ITiming["endsAt"]

Readonly finishEvent

finishEvent: ITiming["finishEvent"]

Readonly position

position: ITiming["position"]

Readonly startsAt

startsAt: ITiming["startsAt"]

Private timingCommandManagement

timingCommandManagement: TimingCommandManagement

Private timingManagement

timingManagement: TimingManagement

Readonly uid

uid: ITiming["uid"]

Readonly updatedAt

updatedAt: ITiming["updatedAt"]

Readonly video

video: IVideo = videoStates.reduce<any>((videoMemo: IVideo, state: VideoStateChanged['state']) => ({...videoMemo,[state]: {getAll: async (since: Date = this.updatedAt) => {const videoStateChangedCommands = await this.timingCommandManagement.getList<VideoStateChanged>({deviceUid: this.deviceUid,appletUid: this.appletUid,receivedSince: since.toISOString(),type: VideoStateChanged,});const videosByStateMap = _.groupBy(videoStateChangedCommands,(videoStateChangedCommand: TimingCommand<VideoStateChanged>) => videoStateChangedCommand.commandPayload.state,);const videosOfCurrentState = videosByStateMap[state].map((videoStateChangedCommand: TimingCommand<VideoStateChanged>) => _.pick(videoStateChangedCommand.commandPayload,'uri','x','y','width','height',),);return videosOfCurrentState;},},}),{},)

Methods

delete

delete(): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:714
Returns Promise<void>

disableMonitoring

disableMonitoring(): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:706
Returns Promise<void>

enableMonitoring

enableMonitoring(): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:698
Returns Promise<void>

onLoaded

onLoaded(since?: Date): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:686
Parameters
- Default value since: Date = this.updatedAt
Returns Promise<void>

Object literals

Readonly fileSystem

fileSystem: object

appendFile

appendFile(filePath: IFilePath, content: string): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:335
Parameters
- filePath: IFilePath
- content: string
Returns Promise<void>

copyFile

copyFile(sourceFilePath: IFilePath, destinationFilePath: IFilePath, options: ICopyFileOptions | {}): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:358
Parameters
- sourceFilePath: IFilePath
- destinationFilePath: IFilePath
- options: ICopyFileOptions | {}
Returns Promise<void>

createDirectory

createDirectory(directoryPath: IFilePath): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:382
Parameters
- directoryPath: IFilePath
Returns Promise<void>

deleteFile

deleteFile(filePath: IFilePath, recursive: boolean): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:404
Parameters
- filePath: IFilePath
- recursive: boolean
Returns Promise<void>

downloadFile

downloadFile(filePath: IFilePath, sourceUri: string, headers?: IHeaders): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:427
Parameters
- filePath: IFilePath
- sourceUri: string
- Optional headers: IHeaders
Returns Promise<void>

exists

exists(filePath: IFilePath): Promise<boolean>

- Defined in src/RestApi/Timing/Timing.ts:451
Parameters
- filePath: IFilePath
Returns Promise<boolean>

extractFile

extractFile(archiveFilePath: IFilePath, destinationDirectionPath: IFilePath, method: string): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:473
Parameters
- archiveFilePath: IFilePath
- destinationDirectionPath: IFilePath
- method: string
Returns Promise<void>

getFile

getFile(filePath: IFilePath): Promise<IFileSystemFile | null>

- Defined in src/RestApi/Timing/Timing.ts:497
Parameters
- filePath: IFilePath
Returns Promise<IFileSystemFile | null>

getFileChecksum

getFileChecksum(filePath: IFilePath, hashType: string): Promise<string>

- Defined in src/RestApi/Timing/Timing.ts:519
Parameters
- filePath: IFilePath
- hashType: string
Returns Promise<string>

isDirectory

isDirectory(filePath: IFilePath): Promise<boolean>

- Defined in src/RestApi/Timing/Timing.ts:542
Parameters
- filePath: IFilePath
Returns Promise<boolean>

listFiles

listFiles(directoryPath: IFilePath): Promise<IFilePath[]>

- Defined in src/RestApi/Timing/Timing.ts:564
Parameters
- directoryPath: IFilePath
Returns Promise<IFilePath[]>

listStorageUnits

listStorageUnits(): Promise<IStorageUnit[]>

- Defined in src/RestApi/Timing/Timing.ts:586
Returns Promise<IStorageUnit[]>

moveFile

moveFile(sourceFilePath: IFilePath, destinationFilePath: IFilePath, options: IMoveFileOptions | {}): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:607
Parameters
- sourceFilePath: IFilePath
- destinationFilePath: IFilePath
- options: IMoveFileOptions | {}
Returns Promise<void>

readFile

readFile(filePath: IFilePath): Promise<string>

- Defined in src/RestApi/Timing/Timing.ts:631
Parameters
- filePath: IFilePath
Returns Promise<string>

writeFile

writeFile(filePath: IFilePath, content: string): Promise<void>

- Defined in src/RestApi/Timing/Timing.ts:653
Parameters
- filePath: IFilePath
- content: string
Returns Promise<void>

Readonly html

html: object

getDOMDocument

getDOMDocument(): Promise<Document>

- Defined in src/RestApi/Timing/Timing.ts:142
Returns Promise<Document>

Readonly offline

offline: object

cache

cache: object

getChecksumFile

getChecksumFile(uid: string, hashType: string): Promise<string>

- Defined in src/RestApi/Timing/Timing.ts:230
Parameters
- uid: string
- hashType: string
Returns Promise<string>

listFiles

listFiles(): Promise<string[]>

- Defined in src/RestApi/Timing/Timing.ts:187
Returns Promise<string[]>

loadFile

loadFile(uid: string): Promise<IFile>

- Defined in src/RestApi/Timing/Timing.ts:208
Parameters
- uid: string
Returns Promise<IFile>

loadOrSaveFile

loadOrSaveFile(uid: string, uri: string, headers?: undefined | {}): Promise<IFile>

- Defined in src/RestApi/Timing/Timing.ts:277
Parameters
- uid: string
- uri: string
- Optional headers: undefined | {}
Returns Promise<IFile>

validateChecksumFile

validateChecksumFile(uid: string, hash: string, hashType: string): Promise<boolean>

- Defined in src/RestApi/Timing/Timing.ts:253
Parameters
- uid: string
- hash: string
- hashType: string
Returns Promise<boolean>

Generated using TypeDoc

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

data: ITiming

timingManagement: TimingManagement

timingCommandManagement: TimingCommandManagement

Returns Timing

Properties

Readonly appletUid

Readonly appletVersion

Readonly configuration

Readonly console

Readonly createdAt

Readonly deviceUid

Readonly endsAt

Readonly finishEvent

Readonly position

Readonly startsAt

Private timingCommandManagement

Private timingManagement

Readonly uid

Readonly updatedAt

Readonly video

Methods

delete

Returns Promise<void>

disableMonitoring

Returns Promise<void>

enableMonitoring

Returns Promise<void>

onLoaded

Parameters

Default value since: Date = this.updatedAt

Returns Promise<void>

Object literals

Readonly fileSystem

appendFile

Parameters

filePath: IFilePath

content: string

Returns Promise<void>

copyFile

Parameters

sourceFilePath: IFilePath

destinationFilePath: IFilePath

options: ICopyFileOptions | {}

Returns Promise<void>

createDirectory

Parameters

directoryPath: IFilePath

Returns Promise<void>

deleteFile

Parameters

filePath: IFilePath

recursive: boolean

Returns Promise<void>

downloadFile

Parameters

filePath: IFilePath

sourceUri: string

Optional headers: IHeaders

Returns Promise<void>

exists

Parameters

filePath: IFilePath

Returns Promise<boolean>

extractFile

Parameters

archiveFilePath: IFilePath

destinationDirectionPath: IFilePath

method: string

Returns Promise<void>

getFile