Class User

Base for all structures

Hierarchy (View Summary)

Base
- User

Index

Constructors

Constructors

constructor

new User(discloudApp: DiscloudApp, data: ApiUser): User
Parameters
- discloudApp: DiscloudApp
- data: ApiUser
Returns User
Overrides Base.constructor
- Defined in packages/discloud.app/src/structures/User.ts:51

Properties

`Readonly`appIDs

appIDs: Set<string> = ...

Your applications ID

constructor

constructor: Constructor<User>

`Readonly`customdomains

customdomains: Set<string> = ...

Your custom domains on Discloud

`Readonly`discloudApp

discloudApp: DiscloudApp

id

id: string

Your id

locale

locale: string

Your locale

plan

plan: string

Your plan

planDataEnd

planDataEnd: Date

Date of when will your plan end

planDataEndTimestamp

planDataEndTimestamp: number

Timestamp of when will your plan end

ramUsage

ramUsage: number

ramUsedMb

ramUsedMb: number

Quantity of RAM was used for your applications

`Readonly`subdomains

subdomains: Set<string> = ...

Your subdomains on Discloud

totalRamMb

totalRamMb: number

Your total RAM quantity

Accessors

apps

get apps(): AppManager
Returns AppManager
- Defined in packages/discloud.app/src/structures/User.ts:111

Methods

`Protected`_clone

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

`Protected`_patch

_patch(data: Partial<ApiUser>): this
Parameters
- data: Partial<ApiUser>
Returns this
Overrides Base._patch
- Defined in packages/discloud.app/src/structures/User.ts:57

`Protected`_update

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

fetch

fetch(): Promise<User>
Fetch a user from Discloud API

Returns Promise<User>
- Defined in packages/discloud.app/src/structures/User.ts:133

setLocale

setLocale<L extends LocaleString>(locale: L): Promise<boolean>
Set your locale on Discloud
Type Parameters
- L extends LocaleString
Parameters
- locale: L
  Your locale like "en-US".
Returns Promise<boolean>
See
LocaleString
- Defined in packages/discloud.app/src/structures/User.ts:121

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in packages/discloud.app/src/structures/User.ts:139

Class User

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns User

Properties

ReadonlyappIDs

constructor

Readonlycustomdomains

ReadonlydiscloudApp

id

locale

plan

planDataEnd

planDataEndTimestamp

ramUsage

ramUsedMb

Readonlysubdomains

totalRamMb

Accessors

apps

Returns AppManager

Methods

Protected_clone

Returns this

Protected_patch

Parameters

Returns this

Protected_update

Parameters

Returns this

fetch

Returns Promise<User>

setLocale

Type Parameters

Parameters

Returns Promise<boolean>

See

toString

Returns string

Settings

On This Page

`Readonly`appIDs

`Readonly`customdomains

`Readonly`discloudApp

`Readonly`subdomains

`Protected`_clone

`Protected`_patch

`Protected`_update