Class ApplicationBinaryService

Hierarchy (view full)

Service<IApplicationBinary>
- ApplicationBinaryService

Index

Constructors

Methods

addPlugin delete downloadArchive getXMLHttpResponse list listPlugins removePlugin updateFiles upload uploadApplicationVersion uploadWithProgressXhr

Constructors

constructor

new ApplicationBinaryService(client, applicationOrId): ApplicationBinaryService
Parameters
- client: IFetchClient
- applicationOrId: string | number | IApplication
Returns ApplicationBinaryService
Overrides Service.constructor
- Defined in packages/client/src/application/ApplicationBinaryService.ts:13

Methods

addPlugin

addPlugin(pluginName, pluginFile): Promise<{
data: any;
res: IFetchResponse;
}>
Parameters
- pluginName: string
- pluginFile: Stream | ArrayBuffer | Buffer
Returns Promise<{
data: any;
res: IFetchResponse;
}>
- Defined in packages/client/src/application/ApplicationBinaryService.ts:123

delete

delete(binaryOrId): Promise<IResult<null>>
Parameters
- binaryOrId: string | number | IApplicationBinary
Returns Promise<IResult<null>>
Overrides Service.delete
- Defined in packages/client/src/application/ApplicationBinaryService.ts:111

downloadArchive

downloadArchive(binaryId): Promise<IFetchResponse>
Parameters
- binaryId: string | number
Returns Promise<IFetchResponse>
- Defined in packages/client/src/application/ApplicationBinaryService.ts:170

getXMLHttpResponse

getXMLHttpResponse(xhr): Promise<IApplication>
Parameters
- xhr: any
Returns Promise<IApplication>
- Defined in packages/client/src/application/ApplicationBinaryService.ts:95

list

list(filter?): Promise<IResultList<IApplicationBinary>>
Parameters
- Optionalfilter: any
Returns Promise<IResultList<IApplicationBinary>>
Overrides Service.list
- Defined in packages/client/src/application/ApplicationBinaryService.ts:107

listPlugins

listPlugins(): Promise<{
data: any;
res: IFetchResponse;
}>
Returns Promise<{
data: any;
res: IFetchResponse;
}>
- Defined in packages/client/src/application/ApplicationBinaryService.ts:115

removePlugin

removePlugin(pluginName): Promise<{
data: any;
res: IFetchResponse;
}>
Parameters
- pluginName: string
Returns Promise<{
data: any;
res: IFetchResponse;
}>
- Defined in packages/client/src/application/ApplicationBinaryService.ts:139

updateFiles

updateFiles(files): Promise<{
data: any;
res: IFetchResponse;
}>
Parameters
- files: {
      contents:
          | string
          | Stream
          | Blob
          | ArrayBuffer
          | Buffer;
      path: string;
  }[]
Returns Promise<{
data: any;
res: IFetchResponse;
}>
- Defined in packages/client/src/application/ApplicationBinaryService.ts:148

upload

upload(binary, fileName?, uploadParamsOverride?): Promise<IResult<IApplicationBinary>>
Parameters
- binary:
      | Stream
      | Blob
      | ArrayBuffer
      | Buffer
      | File
- OptionalfileName: string
- OptionaluploadParamsOverride: IUploadParamsOverride
Returns Promise<IResult<IApplicationBinary>>
- Defined in packages/client/src/application/ApplicationBinaryService.ts:18

uploadApplicationVersion

uploadApplicationVersion(archive, version, tags?): Promise<IResult<IApplicationBinary>>
Parameters
- archive: File
- version: string
- tags: string[] = []
Returns Promise<IResult<IApplicationBinary>>
- Defined in packages/client/src/application/ApplicationBinaryService.ts:41

uploadWithProgressXhr

uploadWithProgressXhr(binary, onProgress, fileName?, uploadParamsOverride?): XMLHttpRequest
Parameters
- binary:
      | Stream
      | Blob
      | ArrayBuffer
      | Buffer
      | File
- onProgress: any
- OptionalfileName: string
- OptionaluploadParamsOverride: IUploadParamsOverride
Returns XMLHttpRequest
- Defined in packages/client/src/application/ApplicationBinaryService.ts:54