Class CustomdomainsManager

Manager for customdomains on Discloud

Hierarchy (View Summary)

BaseCustomdomainsManager<typeof Customdomain>
- CustomdomainsManager

Index

Constructors

constructor

new CustomdomainsManager(discloudApp: DiscloudApp): CustomdomainsManager
Parameters
- discloudApp: DiscloudApp
Returns CustomdomainsManager
Overrides BaseCustomdomainsManager.constructor
- Defined in packages/discloud.app/src/managers/CustomdomainsManager.ts:13

Properties

`Protected` `Readonly`_cache

_cache: Map<string, Customdomain> = ...

`Readonly`discloudApp

discloudApp: DiscloudApp

`Protected` `Readonly`holds

holds: typeof Customdomain

Accessors

cache

get cache(): Map<K, InstanceType<V>>
Returns Map<K, InstanceType<V>>
Inherited from BaseCustomdomainsManager.cache
- Defined in packages/discloud.app/src/managers/DataManager.ts:15

Methods

`Protected`_add

_add(data: PartialApiCustomdomain): Customdomain
Parameters
- data: PartialApiCustomdomain
Returns Customdomain
Inherited from BaseCustomdomainsManager._add
- Defined in packages/discloud.app/src/managers/BaseCustomdomainsManager.ts:18

`Protected`_addMany

_addMany(data: PartialApiCustomdomain[]): Map<string, Customdomain>
Parameters
- data: PartialApiCustomdomain[]
Returns Map<string, Customdomain>
Inherited from BaseCustomdomainsManager._addMany
- Defined in packages/discloud.app/src/managers/BaseCustomdomainsManager.ts:29

`Protected`_clear

_clear(data?: (string | PartialApiCustomdomain)[]): void
Parameters
- Optionaldata: (string | PartialApiCustomdomain)[]
Returns void
Inherited from BaseCustomdomainsManager._clear
- Defined in packages/discloud.app/src/managers/BaseCustomdomainsManager.ts:40

`Protected`_delete

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

`Protected`_deleteMany

_deleteMany(ids: string[]): void
Parameters
- ids: string[]
Returns void
Inherited from BaseCustomdomainsManager._deleteMany
- Defined in packages/discloud.app/src/managers/BaseCustomdomainsManager.ts:60

`Protected`_patch

_patch(id: string, data: Partial<ApiDomain>): Customdomain | undefined
Parameters
- id: string
- data: Partial<ApiDomain>
Returns Customdomain | undefined
Inherited from BaseCustomdomainsManager._patch
- Defined in packages/discloud.app/src/managers/BaseCustomdomainsManager.ts:65

create

create(appId: string, domain: string): Promise<Customdomain>
Parameters
- appId: string
- domain: string
Returns Promise<Customdomain>
Throws
400

Throws
403

Throws
404 not found

Throws
409 duplicate
- Defined in packages/discloud.app/src/managers/CustomdomainsManager.ts:25

delete

delete(domain: string): Promise<void>
Parameters
- domain: string
  You domain id.
Returns Promise<void>
Throws
400

Throws
403

Throws
404 not found
- Defined in packages/discloud.app/src/managers/CustomdomainsManager.ts:43

edit

edit(domain: string, appId: string): Promise<void>
Parameters
- domain: string
  You domain id.
- appId: string
  You app id.
Returns Promise<void>
Throws
400

Throws
403

Throws
404 not found
- Defined in packages/discloud.app/src/managers/CustomdomainsManager.ts:55

fetch

fetch(id: string): Promise<Customdomain>
Get information of your customdomain on Discloud.
Parameters
- id: string
  You customdomain id.
Returns Promise<Customdomain>
- Defined in packages/discloud.app/src/managers/CustomdomainsManager.ts:88
fetch(id?: "all"): Promise<Map<string, Customdomain>>
Get information of your customdomain on Discloud.
Parameters
- Optionalid: "all"
  You customdomain id.
Returns Promise<Map<string, Customdomain>>
- Defined in packages/discloud.app/src/managers/CustomdomainsManager.ts:89

resolve

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

valueOf

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

Returns Map<string, Customdomain>
Inherited from BaseCustomdomainsManager.valueOf
- Defined in packages/discloud.app/src/managers/DataManager.ts:31

verify

verify(domain: string): Promise<Customdomain>
Parameters
- domain: string
  You domain id.
Returns Promise<Customdomain>
Throws
400

Throws
403

Throws
404 not found

Throws
500 external error
- Defined in packages/discloud.app/src/managers/CustomdomainsManager.ts:77

Class CustomdomainsManager

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CustomdomainsManager

Properties

Protected Readonly_cache

ReadonlydiscloudApp

Protected Readonlyholds

Accessors

cache

Returns Map<K, InstanceType<V>>

Methods

Protected_add

Parameters

Returns Customdomain

Protected_addMany

Parameters

Returns Map<string, Customdomain>

Protected_clear

Parameters

Returns void

Protected_delete

Parameters

Returns boolean

Protected_deleteMany

Parameters

Returns void

Protected_patch

Parameters

Returns Customdomain | undefined

create

Parameters

Returns Promise<Customdomain>

Throws

Throws

Throws

Throws

delete

Parameters

Returns Promise<void>

Throws

Throws

Throws

edit

Parameters

Returns Promise<void>

Throws

Throws

Throws

fetch

Parameters

Returns Promise<Customdomain>

Parameters

Returns Promise<Map<string, Customdomain>>

resolve

Parameters

Returns Customdomain | null

valueOf

Returns Map<string, Customdomain>

verify

Parameters

Returns Promise<Customdomain>

Throws

Throws

Throws

Throws

Settings

On This Page

`Protected` `Readonly`_cache

`Readonly`discloudApp

`Protected` `Readonly`holds

`Protected`_add

`Protected`_addMany

`Protected`_clear

`Protected`_delete

`Protected`_deleteMany

`Protected`_patch