Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Application

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

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_keys

_keys: BaseSet<string> = keysApplication

Optional aliases

aliases: BaseSet<string>

Optional botPublic

botPublic: undefined | false | true

Optional botRequireCodeGrant

botRequireCodeGrant: undefined | false | true

client

client: ShardClient

coverImage

coverImage: null | string = null

description

description: string = ""

Optional developers

developers: Array<ApplicationDeveloper>

Optional eulaId

eulaId: undefined | string

Optional executables

executables: Array<ApplicationExecutable>

Optional guildId

guildId: undefined | string

Optional hook

hook: undefined | false | true

icon

icon: null | string = null

id

id: string = ""

name

name: string = ""

Optional overlay

overlay: undefined | false | true

Optional overlayCompatibilityHook

overlayCompatibilityHook: undefined | false | true

Optional primarySkuId

primarySkuId: undefined | string

Optional publishers

publishers: Array<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: undefined | string

Accessors

coverImageUrl

  • get coverImageUrl(): null | string

  • Returns null | string

createdAt

  • get createdAt(): Date

  • Returns Date

createdAtUnix

  • get createdAtUnix(): number

  • Returns number

iconUrl

  • get iconUrl(): null | string

  • Returns null | string

isOnDiscord

  • get isOnDiscord(): boolean

  • Returns boolean

jumpLink

  • get jumpLink(): null | string

  • Returns null | string

platformDiscordUrl

  • get platformDiscordUrl(): null | string

  • Returns null | string

shardId

  • get shardId(): number

  • Returns number

splashUrl

  • get splashUrl(): null | string

  • Returns null | string

youtubeTrailerUrl

  • get youtubeTrailerUrl(): null | string

  • Returns null | string

Methods

[inspect.custom]

  • [inspect.custom](): object

_getFromSnake

  • _getFromSnake(key: string): any

  • Parameters

    • key: string

    Returns any

_setFromSnake

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

  • Parameters

    • key: string
    • value: any

    Returns any

coverImageUrlFormat

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

  • Parameters

    • Optional format: null | string
    • Optional query: UrlQuery

    Returns null | string

createAsset

  • Parameters

    • options: CreateOauth2ApplicationAsset

    Returns Promise<Oauth2ApplicationAsset>

createStoreAsset

  • Parameters

    • options: CreateStoreApplicationAsset

    Returns Promise<StoreApplicationAsset>

deleteAsset

  • deleteAsset(assetId: string): Promise<any>

  • Parameters

    • assetId: string

    Returns Promise<any>

deleteStoreAsset

  • deleteStoreAsset(assetId: string): Promise<any>

  • Parameters

    • assetId: string

    Returns Promise<any>

difference

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

  • Parameters

    • key: string
    • value: any

    Returns [boolean, any]

differences

fetchAssets

  • Returns Promise<BaseCollection<string, Oauth2ApplicationAsset>>

fetchNews

  • Returns Promise<BaseCollection<string, ApplicationNews>>

fetchStoreAssets

  • Returns Promise<BaseCollection<string, StoreApplicationAsset>>

iconUrlFormat

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

  • Parameters

    • Optional format: null | string
    • Optional query: UrlQuery

    Returns null | string

joinGuild

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

  • Parameters

    • Default value options: JoinGuild = {}

    Returns Promise<any>

matches

  • matches(name: string): boolean

  • Parameters

    • name: string

    Returns boolean

merge

mergeValue

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

  • Parameters

    • key: string
    • value: any

    Returns void

splashUrlFormat

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

  • Parameters

    • Optional format: null | string
    • Optional query: UrlQuery

    Returns null | string

toJSON

  • toJSON(): object

  • Returns object

Generated using TypeDoc