Class AppManager

Manager for apps on Discloud

Hierarchy (View Summary)

CachedManager<typeof App>
- AppManager

Index

Constructors

constructor

new AppManager(discloudApp: DiscloudApp): AppManager
Parameters
- discloudApp: DiscloudApp
Returns AppManager
Overrides CachedManager.constructor
- Defined in packages/discloud.app/src/managers/AppManager.ts:18

Properties

`Protected` `Readonly`_cache

_cache: Map<string, App>

`Readonly`discloudApp

discloudApp: DiscloudApp

`Protected` `Readonly`holds

holds: typeof App

Accessors

cache

get cache(): Map<string, InstanceType<T>>
Returns Map<string, InstanceType<T>>
Inherited from CachedManager.cache
- Defined in packages/discloud.app/src/managers/DataManager.ts:25

Methods

`Protected`_add

_add(data: any): App
Parameters
- data: any
Returns App
Inherited from CachedManager._add
- Defined in packages/discloud.app/src/managers/CachedManager.ts:19

`Protected`_addMany

_addMany(data: any[]): Map<string, App>
Parameters
- data: any[]
Returns Map<string, App>
Inherited from CachedManager._addMany
- Defined in packages/discloud.app/src/managers/CachedManager.ts:33

`Protected`_clear

_clear(data?: (string | { id: string })[]): void
Parameters
- Optionaldata: (string | { id: string })[]
Returns void
Inherited from CachedManager._clear
- Defined in packages/discloud.app/src/managers/CachedManager.ts:45

`Protected`_delete

_delete(id: string): boolean
Parameters
- id: string
Returns boolean
Inherited from CachedManager._delete
- Defined in packages/discloud.app/src/managers/CachedManager.ts:58

`Protected`_deleteMany

_deleteMany(ids: string[]): boolean
Parameters
- ids: string[]
Returns boolean
Inherited from CachedManager._deleteMany
- Defined in packages/discloud.app/src/managers/CachedManager.ts:64

backup

backup(appID: string): Promise<AppBackup>
Get backups of your application on Discloud
Parameters
- appID: string
  Your app id
Returns Promise<AppBackup>
- Defined in packages/discloud.app/src/managers/AppManager.ts:79
backup(appID?: "all"): Promise<Map<string, AppBackup>>
Get backups of your application on Discloud
Parameters
- OptionalappID: "all"
  Your app id
Returns Promise<Map<string, AppBackup>>
- Defined in packages/discloud.app/src/managers/AppManager.ts:80

console

console(appID: string, command: string): Promise<ApiConsoleAppShell>
Send a command to your app's terminal
Parameters
- appID: string
  Your app id
- command: string
  The command
Returns Promise<ApiConsoleAppShell>
- Defined in packages/discloud.app/src/managers/AppManager.ts:40

create

create(
    options: UploadAppOptions,
): Promise<
    | RESTPostApiUploadErrorResult
    | RESTPostApiUploadOkResult & { app: AppUploaded },
>
Upload a new app or site to Discloud
Parameters
- options: UploadAppOptions
  Options for create a new app. A FileResolvable is required.
Returns Promise<
| RESTPostApiUploadErrorResult
| RESTPostApiUploadOkResult & { app: AppUploaded },
>
- Defined in packages/discloud.app/src/managers/AppManager.ts:130

delete

delete(appID: string): Promise<RESTApiBaseResult>
Delete your application from Discloud.
Parameters
- appID: string
  Your app id
Returns Promise<RESTApiBaseResult>
- Defined in packages/discloud.app/src/managers/AppManager.ts:169
delete(appID?: "all"): Promise<ApiAppManagerRemovedAll>
Delete your application from Discloud.
Parameters
- OptionalappID: "all"
  Your app id
Returns Promise<ApiAppManagerRemovedAll>
- Defined in packages/discloud.app/src/managers/AppManager.ts:170

fetch

fetch(appID: string): Promise<App>
Get information of your application on Discloud.
Parameters
- appID: string
  You app id.
Returns Promise<App>
- Defined in packages/discloud.app/src/managers/AppManager.ts:304
fetch(appID?: "all"): Promise<Map<string, App>>
Get information of your application on Discloud.
Parameters
- OptionalappID: "all"
  You app id.
Returns Promise<Map<string, App>>
- Defined in packages/discloud.app/src/managers/AppManager.ts:305

profile

profile(
appID: string,
options: { avatarURL?: string; name?: string },
): Promise<RESTApiBaseResult>
Update the profile of your apps on Discloud.
Parameters
- appID: string
  Your app id
- options: { avatarURL?: string; name?: string }
  Options to update your app.
Returns Promise<RESTApiBaseResult>
- Defined in packages/discloud.app/src/managers/AppManager.ts:196

ram

ram(appID: string, quantity: number): Promise<RESTPutApiAppRamResult>
Set the quantity of ram to your application
Parameters
- appID: string
  Your app id
- quantity: number
  Minimum values is 100 to bot or 512 for site
Returns Promise<RESTPutApiAppRamResult>
- Defined in packages/discloud.app/src/managers/AppManager.ts:106

resolve

resolve(idOrInstance: string | App): null | App
Resolves a data entry to a data Object.
Parameters
- idOrInstance: string | App
  The id or instance of something in this Manager
Returns null | App
Inherited from CachedManager.resolve
- Defined in packages/discloud.app/src/managers/DataManager.ts:33

resolveId

resolveId(idOrInstance: string | App): any
Parameters
- idOrInstance: string | App
Returns any
Inherited from CachedManager.resolveId
- Defined in packages/discloud.app/src/managers/DataManager.ts:39

restart

restart(appID: string): Promise<RESTApiBaseResult>
Restart your application on Discloud
Parameters
- appID: string
  You app id
Returns Promise<RESTApiBaseResult>
- Defined in packages/discloud.app/src/managers/AppManager.ts:214
restart(appID?: "all"): Promise<ApiAppManagerRestartedAll>
Restart your application on Discloud
Parameters
- OptionalappID: "all"
  You app id
Returns Promise<ApiAppManagerRestartedAll>
- Defined in packages/discloud.app/src/managers/AppManager.ts:215

start

start(appID: string): Promise<RESTApiBaseResult>
Start your application on Discloud
Parameters
- appID: string
  You app id
Returns Promise<RESTApiBaseResult>
- Defined in packages/discloud.app/src/managers/AppManager.ts:244
start(appID?: "all"): Promise<ApiAppManagerStartedAll>
Start your application on Discloud
Parameters
- OptionalappID: "all"
  You app id
Returns Promise<ApiAppManagerStartedAll>
- Defined in packages/discloud.app/src/managers/AppManager.ts:245

status

status(appID: string): Promise<AppStatus>
Get the status of your application on Discloud
Parameters
- appID: string
  Your app id
Returns Promise<AppStatus>
- Defined in packages/discloud.app/src/managers/AppManager.ts:27

stop

stop(appID: string): Promise<RESTApiBaseResult>
Stop your application on Discloud
Parameters
- appID: string
  You app id
Returns Promise<RESTApiBaseResult>
- Defined in packages/discloud.app/src/managers/AppManager.ts:274
stop(appID?: "all"): Promise<ApiAppManagerStopedAll>
Stop your application on Discloud
Parameters
- OptionalappID: "all"
  You app id
Returns Promise<ApiAppManagerStopedAll>
- Defined in packages/discloud.app/src/managers/AppManager.ts:275

terminal

terminal(appID: string): Promise<ApiTerminal>
Get logs of your application on Discloud
Parameters
- appID: string
  Your app id
Returns Promise<ApiTerminal>
- Defined in packages/discloud.app/src/managers/AppManager.ts:53
terminal(appID?: "all"): Promise<Map<string, ApiTerminal>>
Get logs of your application on Discloud
Parameters
- OptionalappID: "all"
  Your app id
Returns Promise<Map<string, ApiTerminal>>
- Defined in packages/discloud.app/src/managers/AppManager.ts:54

update

update(
appID: string,
options: UploadAppOptions,
): Promise<RESTPutApiAppCommitResult>
Update an of your apps on Discloud.
Parameters
- appID: string
  Your app id
- options: UploadAppOptions
  Options to update your app.
Returns Promise<RESTPutApiAppCommitResult>
- Defined in packages/discloud.app/src/managers/AppManager.ts:152

valueOf

valueOf(): Map<string, App>
Returns the primitive value of the specified object.

Returns Map<string, App>
Inherited from CachedManager.valueOf
- Defined in packages/discloud.app/src/managers/DataManager.ts:46

Class AppManager

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AppManager

Properties

Protected Readonly_cache

ReadonlydiscloudApp

Protected Readonlyholds

Accessors

cache

Returns Map<string, InstanceType<T>>

Methods

Protected_add

Parameters

Returns App

Protected_addMany

Parameters

Returns Map<string, App>

Protected_clear

Parameters

Returns void

Protected_delete

Parameters

Returns boolean

Protected_deleteMany

Parameters

Returns boolean

backup

Parameters

Returns Promise<AppBackup>

Parameters

Returns Promise<Map<string, AppBackup>>

console

Parameters

Returns Promise<ApiConsoleAppShell>

create

Parameters

Returns Promise< | RESTPostApiUploadErrorResult | RESTPostApiUploadOkResult & { app: AppUploaded },>

delete

Parameters

Returns Promise<RESTApiBaseResult>

Parameters

Returns Promise<ApiAppManagerRemovedAll>

fetch

Parameters

Returns Promise<App>

Parameters

Returns Promise<Map<string, App>>

profile

Parameters

Returns Promise<RESTApiBaseResult>

ram

Parameters

Returns Promise<RESTPutApiAppRamResult>

resolve

Parameters

Returns null | App

resolveId

Parameters

Returns any

restart

Parameters

Returns Promise<RESTApiBaseResult>

Parameters

Returns Promise<ApiAppManagerRestartedAll>

start

Parameters

Returns Promise<RESTApiBaseResult>

Parameters

Returns Promise<ApiAppManagerStartedAll>

status

Parameters

Returns Promise<AppStatus>

`Protected` `Readonly`_cache

`Readonly`discloudApp

`Protected` `Readonly`holds

`Protected`_add

`Protected`_addMany

`Protected`_clear

`Protected`_delete

`Protected`_deleteMany

Returns Promise<
| RESTPostApiUploadErrorResult
| RESTPostApiUploadOkResult & { app: AppUploaded },
>