AppletVersionFileManagement | @signageos/sdk

Hierarchy

AppletVersionFileManagement

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AppletVersionFileManagement(options: IOptions): AppletVersionFileManagement

- Defined in src/RestApi/Applet/Version/File/AppletVersionFileManagement.ts:40
Parameters
- options: IOptions
Returns AppletVersionFileManagement

Properties

Private options

options: IOptions

Static Private Readonly RESOURCE

RESOURCE: string = "file"

Methods

create

create(appletUid: string, appletVersion: string, settings: IAppletVersionFileCreatable, options?: IUploadOptions): Promise<void>

- Defined in src/RestApi/Applet/Version/File/AppletVersionFileManagement.ts:71
Parameters
- appletUid: string
- appletVersion: string
- settings: IAppletVersionFileCreatable
- Default value options: IUploadOptions = {}
Returns Promise<void>

get

get(appletUid: string, appletVersion: string, filePath: string): Promise<IAppletVersionFile>

- Defined in src/RestApi/Applet/Version/File/AppletVersionFileManagement.ts:52
Parameters
- appletUid: string
- appletVersion: string
- filePath: string
Returns Promise<IAppletVersionFile>

list

list(appletUid: string, appletVersion: string): Promise<IAppletVersionFile[]>

- Defined in src/RestApi/Applet/Version/File/AppletVersionFileManagement.ts:45
Parameters
- appletUid: string
- appletVersion: string
Returns Promise<IAppletVersionFile[]>

remove

remove(appletUid: string, appletVersion: string, filePath: string, options?: IUploadOptions): Promise<void>

- Defined in src/RestApi/Applet/Version/File/AppletVersionFileManagement.ts:120
Parameters
- appletUid: string
- appletVersion: string
- filePath: string
- Default value options: IUploadOptions = {}
Returns Promise<void>

update

update(appletUid: string, appletVersion: string, filePath: string, settings: IAppletVersionFileUpdatable, options?: IUploadOptions): Promise<void>

- Defined in src/RestApi/Applet/Version/File/AppletVersionFileManagement.ts:95
Parameters
- appletUid: string
- appletVersion: string
- filePath: string
- settings: IAppletVersionFileUpdatable
- Default value options: IUploadOptions = {}
Returns Promise<void>

Static Private getResource

getResource(appletUid: string, appletVersion: string): string

- Defined in src/RestApi/Applet/Version/File/AppletVersionFileManagement.ts:34
Parameters
- appletUid: string
- appletVersion: string
Returns string

Static Private getUrl

getUrl(appletUid: string, appletVersion: string, filePath: string): string

- Defined in src/RestApi/Applet/Version/File/AppletVersionFileManagement.ts:38
Parameters
- appletUid: string
- appletVersion: string
- filePath: string
Returns string

Generated using TypeDoc