Class AppManager

Manager for apps on Discloud

Hierarchy (view full)

CachedManager<typeof App>
- AppManager

Index

Constructors

Properties

_cache discloudApp holds

Accessors

Methods

_add _addMany _clear _delete _deleteMany backup console create delete fetch profile ram resolve resolveId restart start status stop terminal update valueOf

Constructors

constructor

new AppManager(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): App
Parameters
- data: any
Returns App
Inherited from CachedManager._add
- Defined in packages/discloud.app/src/managers/CachedManager.ts:19

`Protected`_addMany

_addMany(data): 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?): 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): boolean
Parameters
- id: string
Returns boolean
Inherited from CachedManager._delete
- Defined in packages/discloud.app/src/managers/CachedManager.ts:58

`Protected`_deleteMany

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

backup

backup(appID): 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:95
backup(appID?): Promise<Map<string, AppBackup>>
Parameters
- OptionalappID: "all"
Returns Promise<Map<string, AppBackup>>
- Defined in packages/discloud.app/src/managers/AppManager.ts:96

console

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

create

create(options): 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:146

delete

delete(appID): 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:185
delete(appID?): Promise<ApiAppManagerRemovedAll>
Parameters
- OptionalappID: "all"
Returns Promise<ApiAppManagerRemovedAll>
- Defined in packages/discloud.app/src/managers/AppManager.ts:186

fetch

fetch(appID): 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:320
fetch(appID?): Promise<Map<string, App>>
Parameters
- OptionalappID: "all"
Returns Promise<Map<string, App>>
- Defined in packages/discloud.app/src/managers/AppManager.ts:321

profile

profile(appID, options): 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.
  - OptionalavatarURL?: string
  - Optionalname?: string
Returns Promise<RESTApiBaseResult>
- Defined in packages/discloud.app/src/managers/AppManager.ts:212

ram

ram(appID, quantity): 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:122

resolve

resolve(idOrInstance): 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): any
Parameters
- idOrInstance: string | App
Returns any
Inherited from CachedManager.resolveId
- Defined in packages/discloud.app/src/managers/DataManager.ts:39

restart

restart(appID): 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:230
restart(appID?): Promise<ApiAppManagerRestartedAll>
Parameters
- OptionalappID: "all"
Returns Promise<ApiAppManagerRestartedAll>
- Defined in packages/discloud.app/src/managers/AppManager.ts:231

start

start(appID): 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:260
start(appID?): Promise<ApiAppManagerStartedAll>
Parameters
- OptionalappID: "all"
Returns Promise<ApiAppManagerStartedAll>
- Defined in packages/discloud.app/src/managers/AppManager.ts:261

status

status(appID): 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
status(appID?): Promise<Map<string, AppStatus>>
Parameters
- OptionalappID: "all"
Returns Promise<Map<string, AppStatus>>
- Defined in packages/discloud.app/src/managers/AppManager.ts:28

stop

stop(appID): 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:290
stop(appID?): Promise<ApiAppManagerStopedAll>
Parameters
- OptionalappID: "all"
Returns Promise<ApiAppManagerStopedAll>
- Defined in packages/discloud.app/src/managers/AppManager.ts:291

terminal

terminal(appID): 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:69
terminal(appID?): Promise<Map<string, ApiTerminal>>
Parameters
- OptionalappID: "all"
Returns Promise<Map<string, ApiTerminal>>
- Defined in packages/discloud.app/src/managers/AppManager.ts:70

update

update(appID, options): 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:168

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