Class ManagerApps

Hierarchy

ApiConnection
- ManagerApps

Index

Constructors

Properties

_jwt _onAuthFailed? _requestFunc?

Accessors

jwt onAuthFailed requestFunc

Methods

_request delete get install list listUpdatable post put uninstall update updateAll

Constructors

constructor

new ManagerApps(baseUrl: string): ManagerApps
Parameters
- baseUrl: string
Returns ManagerApps
Overrides ApiConnection.constructor
- Defined in manager/apps.ts:6

Properties

`Protected` _jwt

_jwt: string = ''

`Protected` `Optional` _onAuthFailed

_onAuthFailed?: ((url: string) => void)

Type declaration

- (url: string): void
- Callback to run when a request returns status 401 (optional)
  Parameters
  - url: string
  Returns void

`Protected` `Optional` _requestFunc

_requestFunc?: RequestFunction

Custom request function (optional)

Accessors

jwt

set jwt(jwt: string): void
Parameters
- jwt: string
Returns void
Inherited from ApiConnection.jwt
- Defined in common/connection.ts:13

onAuthFailed

set onAuthFailed(callback: ((url: string) => void)): void
Parameters
- callback: ((url: string) => void)
  - - (url: string): void
    - Parameters
      
      url: string
      
      Returns void
Returns void
Inherited from ApiConnection.onAuthFailed
- Defined in common/connection.ts:29

requestFunc

set requestFunc(requestFunc: RequestFunction): void
Parameters
- requestFunc: RequestFunction
Returns void
Inherited from ApiConnection.requestFunc
- Defined in common/connection.ts:21

Methods

_request

_request<ResponseType>(url: string, method?: "GET" | "POST" | "PUT" | "DELETE", body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- method: "GET" | "POST" | "PUT" | "DELETE" = 'GET'
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection._request
- Defined in common/connection.ts:33

`Protected` delete

delete<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.delete
- Defined in common/connection.ts:125

`Protected` get

get<ResponseType>(url: string, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.get
- Defined in common/connection.ts:99

install

install(id: string): Promise<void>
Install an app
Parameters
- id: string
  
  The id of the app
Returns Promise<void>
- Defined in manager/apps.ts:34

list

list(installed?: boolean): Promise<{ apps: MetadataV4[]; jwt: string }>
List all apps

Returns
A list of apps with metadata
Parameters
- installed: boolean = false
  
  Set this to true if you only want a list of installed apps
Returns Promise<{ apps: MetadataV4[]; jwt: string }>
- Defined in manager/apps.ts:16

listUpdatable

listUpdatable(): Promise<Record<string, { updateFrom: string; updateTo: string }>>
Get a list of all apps which can be updates

Returns Promise<Record<string, { updateFrom: string; updateTo: string }>>
- Defined in manager/apps.ts:66

`Protected` post

post<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.post
- Defined in common/connection.ts:107

`Protected` put

put<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.put
- Defined in common/connection.ts:116

uninstall

uninstall(id: string): Promise<void>
Uninstall an app
Parameters
- id: string
  
  The id of the app
Returns Promise<void>
- Defined in manager/apps.ts:43

update

update(id: string): Promise<void>
Update an app
Parameters
- id: string
  
  The id of the app
Returns Promise<void>
- Defined in manager/apps.ts:52

updateAll

updateAll(): Promise<void>
Update all apps

Returns Promise<void>
- Defined in manager/apps.ts:59

Generated using TypeDoc