Application | Detritus Client

Application Structure, used for channels, guilds, presences, etc..

Hierarchy

BaseStructure
- Application

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Application(client: ShardClient, data: BaseStructureData, isClone?: boolean): Application

Overrides BaseStructure.constructor
- Defined in src/structures/application.ts:111
Parameters
- client: ShardClient
- data: BaseStructureData
- Optional isClone: boolean
Returns Application

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Optional aliases

aliases: BaseSet<string>

Optional botPublic

botPublic: boolean

Optional botRequireCodeGrant

botRequireCodeGrant: boolean

Readonly client

client: ShardClient

coverImage

coverImage: null | string = null

description

description: string = ''

Optional developers

developers: ApplicationDeveloper[]

Optional eulaId

eulaId: string

Optional executables

executables: ApplicationExecutable[]

Optional guildId

guildId: string

Optional hook

hook: boolean

icon

icon: null | string = null

id

id: string = ''

name

name: string = ''

Optional overlay

overlay: boolean

Optional overlayCompatibilityHook

overlayCompatibilityHook: boolean

Optional primarySkuId

primarySkuId: string

Optional publishers

publishers: ApplicationPublisher[]

Optional rpcOrigins

rpcOrigins: BaseSet<string>

slug

slug: null | string = null

splash

splash: null | string = null

summary

summary: string = ''

Optional thirdPartySkus

thirdPartySkus: BaseCollection<string, ApplicationThirdPartySku>

verifyKey

verifyKey: string = ''

Optional youtubeTrailerVideoId

youtubeTrailerVideoId: string

Accessors

coverImageUrl

get coverImageUrl(): null | string

- Defined in src/structures/application.ts:118
Returns null | string

createdAt

get createdAt(): Date

- Defined in src/structures/application.ts:122
Returns Date

createdAtUnix

get createdAtUnix(): number

- Defined in src/structures/application.ts:126
Returns number

iconUrl

get iconUrl(): null | string

- Defined in src/structures/application.ts:134
Returns null | string

isClone

get isClone(): boolean

- Defined in src/structures/basestructure.ts:317
Returns boolean

isOnDiscord

get isOnDiscord(): boolean

- Defined in src/structures/application.ts:138
Returns boolean

jumpLink

get jumpLink(): null | string

- Defined in src/structures/application.ts:130
Returns null | string

platformDiscordUrl

get platformDiscordUrl(): null | string

- Defined in src/structures/application.ts:142
Returns null | string

shardId

get shardId(): number

- Defined in src/structures/basestructure.ts:321
Returns number

splashUrl

get splashUrl(): null | string

- Defined in src/structures/application.ts:152
Returns null | string

youtubeTrailerUrl

get youtubeTrailerUrl(): null | string

- Defined in src/structures/application.ts:156
Returns null | string

Methods

[custom]

[custom](): object

Inherited from BaseStructure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

clone

clone(): Application

Inherited from BaseStructure.clone
- Defined in src/structures/basestructure.ts:325
Returns Application

coverImageUrlFormat

coverImageUrlFormat(format?: null | string, query?: UrlQuery): null | string

- Defined in src/structures/application.ts:163
Parameters
- Optional format: null | string
- Optional query: UrlQuery
Returns null | string

createAsset

createAsset(options: CreateOauth2ApplicationAsset): Promise<Oauth2ApplicationAsset>

- Defined in src/structures/application.ts:200
Parameters
- options: CreateOauth2ApplicationAsset
Returns Promise<Oauth2ApplicationAsset>

createStoreAsset

createStoreAsset(options: CreateStoreApplicationAsset): Promise<StoreApplicationAsset>

- Defined in src/structures/application.ts:204
Parameters
- options: CreateStoreApplicationAsset
Returns Promise<StoreApplicationAsset>

deleteAsset

deleteAsset(assetId: string): Promise<any>

- Defined in src/structures/application.ts:208
Parameters
- assetId: string
Returns Promise<any>

deleteStoreAsset

deleteStoreAsset(assetId: string): Promise<any>

- Defined in src/structures/application.ts:212
Parameters
- assetId: string
Returns Promise<any>

difference

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from BaseStructure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from BaseStructure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

fetchAssets

fetchAssets(): Promise<BaseCollection<string, Oauth2ApplicationAsset>>

- Defined in src/structures/application.ts:216
Returns Promise<BaseCollection<string, Oauth2ApplicationAsset>>

fetchNews

fetchNews(): Promise<BaseCollection<string, ApplicationNews>>

- Defined in src/structures/application.ts:220
Returns Promise<BaseCollection<string, ApplicationNews>>

fetchStoreAssets

fetchStoreAssets(): Promise<BaseCollection<string, StoreApplicationAsset>>

- Defined in src/structures/application.ts:224
Returns Promise<BaseCollection<string, StoreApplicationAsset>>

hasDifference

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

iconUrlFormat

iconUrlFormat(format?: null | string, query?: UrlQuery): null | string

- Defined in src/structures/application.ts:172
Parameters
- Optional format: null | string
- Optional query: UrlQuery
Returns null | string

joinGuild

joinGuild(options?: JoinGuild): Promise<any>

- Defined in src/structures/application.ts:228
Parameters
- options: JoinGuild = {}
Returns Promise<any>

matches

matches(name: string): boolean

- Defined in src/structures/application.ts:181
Parameters
- name: string
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

mergeValue(key: string, value: any): void

Overrides BaseStructure.mergeValue
- Defined in src/structures/application.ts:235
Parameters
- key: string
- value: any
Returns void

splashUrlFormat

splashUrlFormat(format?: null | string, query?: UrlQuery): null | string

- Defined in src/structures/application.ts:191
Parameters
- Optional format: null | string
- Optional query: UrlQuery
Returns null | string

toJSON

toJSON(): object

Inherited from BaseStructure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: ShardClient

data: BaseStructureData

Optional isClone: boolean

Returns Application

Properties

Readonly _keys

Optional aliases

Optional botPublic

Optional botRequireCodeGrant

Readonly client

coverImage

description

Optional developers

Optional eulaId

Optional executables

Optional guildId

Optional hook

icon

id

name

Optional overlay

Optional overlayCompatibilityHook

Optional primarySkuId

Optional publishers

Optional rpcOrigins

slug

splash

summary

Optional thirdPartySkus

verifyKey

Optional youtubeTrailerVideoId

Accessors

coverImageUrl

Returns null | string

createdAt

Returns Date

createdAtUnix

Returns number

iconUrl

Returns null | string

isClone

Returns boolean

isOnDiscord

Returns boolean

jumpLink

Returns null | string

platformDiscordUrl

Returns null | string

shardId

Returns number

splashUrl

Returns null | string

youtubeTrailerUrl

Returns null | string

Methods

[custom]

Returns object

_getFromSnake

Parameters

key: string

Returns any

_setFromSnake

Parameters

key: string

value: any

Returns any

clone

Returns Application

coverImageUrlFormat

Parameters

Optional format: null | string