Class User

Base for all structures

Hierarchy (View Summary)

Base
- User

Index

Constructors

Properties

Accessors

appIDs apps avatar customdomains id loaded locale plan planDataEnd planDataEndTimestamp ramUsedMb subdomains totalRamMb username

Methods

_clone _patch _update fetch setLocale toString

Constructors

constructor

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

Properties

`Readonly`discloudApp

discloudApp: DiscloudApp

Accessors

appIDs

get appIDs(): Set<string>
Your applications ID

Returns Set<string>
- Defined in packages/discloud.app/src/structures/User.ts:34

apps

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

avatar

get avatar(): string | null
Returns string | null
- Defined in packages/discloud.app/src/structures/User.ts:113

customdomains

get customdomains(): Set<string>
Your custom domains on Discloud

Returns Set<string>
- Defined in packages/discloud.app/src/structures/User.ts:42

id

get id(): string
Your id

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

loaded

get loaded(): boolean
Returns boolean
- Defined in packages/discloud.app/src/structures/User.ts:129

locale

get locale(): string
Your locale

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

plan

get plan(): string
Your plan

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

planDataEnd

get planDataEnd(): Date | null
Date of when will your plan end

Returns Date | null
- Defined in packages/discloud.app/src/structures/User.ts:74

planDataEndTimestamp

get planDataEndTimestamp(): number | null
Timestamp of when will your plan end

Returns number | null
- Defined in packages/discloud.app/src/structures/User.ts:82

ramUsedMb

get ramUsedMb(): number
Quantity of RAM was used for your applications

Returns number
- Defined in packages/discloud.app/src/structures/User.ts:90

subdomains

get subdomains(): Set<string>
Your subdomains on Discloud

Returns Set<string>
- Defined in packages/discloud.app/src/structures/User.ts:98

totalRamMb

get totalRamMb(): number
Your total RAM quantity

Returns number
- Defined in packages/discloud.app/src/structures/User.ts:106

username

get username(): string | null
Returns string | null
- Defined in packages/discloud.app/src/structures/User.ts:120

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:131

`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:219

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:207

toString

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

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