Class TeamApp

Base for app structures

Hierarchy (view full)

BaseTeamApp
- TeamApp

Index

Constructors

Properties

constructor discloudApp exitCode id lang name online perms ramKilled status

Methods

_clone _patch _update backup restart setRam start stop terminal toString update

Constructors

constructor

new TeamApp(discloudApp, data): TeamApp
Parameters
- discloudApp: DiscloudApp
- data: BaseApiApp
Returns TeamApp
Overrides BaseTeamApp.constructor
- Defined in packages/discloud.app/src/structures/TeamApp.ts:35

Properties

constructor

constructor: Constructor<TeamApp>

`Readonly`discloudApp

discloudApp: DiscloudApp

exitCode

exitCode: number

Your team's app exit code on stop

`Readonly`id

id: string

Your app id

lang

lang: string

Your team's app programming language

name

name: string

Your team application name

online

online: boolean

If your team application is online

`Readonly`perms

perms: Set<
    | "backup_app"
    | "commit_app"
    | "edit_ram"
    | "logs_app"
    | "restart_app"
    | "start_app"
    | "status_app"
    | "stop_app"> = ...

Your permissions to manage this application.

ramKilled

ramKilled: boolean

If your team's app stopped due to low RAM

`Readonly`status

status: TeamAppStatus

Methods

`Protected`_clone

_clone(): this
Returns this
Inherited from BaseTeamApp._clone
- Defined in packages/discloud.app/src/structures/Base.ts:18

`Protected`_patch

_patch(data): this
Parameters
- data: Partial<ApiStatusApp | ApiTeamApps>
Returns this
Overrides BaseTeamApp._patch
- Defined in packages/discloud.app/src/structures/TeamApp.ts:43

`Protected`_update

_update(data): this
Parameters
- data: unknown
Returns this
Inherited from BaseTeamApp._update
- Defined in packages/discloud.app/src/structures/Base.ts:26

backup

backup(): Promise<AppBackup>
Get backups for the app of your team on Discloud

Returns Promise<AppBackup>
Inherited from BaseTeamApp.backup
- Defined in packages/discloud.app/src/structures/BaseTeamApp.ts:31

restart

restart(): Promise<RESTApiBaseResult>
Restart your team application on Discloud

Returns Promise<RESTApiBaseResult>
Inherited from BaseTeamApp.restart
- Defined in packages/discloud.app/src/structures/BaseTeamApp.ts:63

setRam

setRam(quantity): Promise<RESTPutApiAppRamResult>
Set the quantity of ram to application of your team
Parameters
- quantity: number
  Minimum values is 100 to bot or 512 for site
Returns Promise<RESTPutApiAppRamResult>
Inherited from BaseTeamApp.setRam
- Defined in packages/discloud.app/src/structures/BaseTeamApp.ts:40

start

start(): Promise<RESTApiBaseResult>
Start your team application on Discloud

Returns Promise<RESTApiBaseResult>
Inherited from BaseTeamApp.start
- Defined in packages/discloud.app/src/structures/BaseTeamApp.ts:70

stop

stop(): Promise<RESTApiBaseResult>
Stop your team application on Discloud

Returns Promise<RESTApiBaseResult>
Inherited from BaseTeamApp.stop
- Defined in packages/discloud.app/src/structures/BaseTeamApp.ts:77

terminal

terminal(): Promise<ApiTerminal>
Get logs for the app of your team on Discloud

Returns Promise<ApiTerminal>
Inherited from BaseTeamApp.terminal
- Defined in packages/discloud.app/src/structures/BaseTeamApp.ts:47

toString

toString(): string
Returns string
Inherited from BaseTeamApp.toString
- Defined in packages/discloud.app/src/structures/BaseTeamApp.ts:83

update

update(options): Promise<RESTPutApiAppCommitResult>
Update an of your team apps on Discloud
Parameters
- options: UploadAppOptions
  Options to update your app.
Returns Promise<RESTPutApiAppCommitResult>
Inherited from BaseTeamApp.update
- Defined in packages/discloud.app/src/structures/BaseTeamApp.ts:56