Oauth2Application | Detritus Client

Oauth2 Application Structure

Hierarchy

BaseStructure
- Oauth2Application

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

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

Overrides BaseStructure.constructor
- Defined in src/structures/oauth2application.ts:73
Parameters
- client: ShardClient
- Optional data: BaseStructureData
- Optional isClone: boolean
Returns Oauth2Application

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Optional bot

bot: UserWithToken

botPublic

botPublic: boolean = false

botRequireCodeGrant

botRequireCodeGrant: boolean = false

Readonly client

client: ShardClient

Optional coverImage

coverImage: null | string

description

description: string = ''

flags

flags: number = 0

Optional guildId

guildId: string

icon

icon: null | string = null

id

id: string = ''

name

name: string = ''

owner

owner: UserWithFlags

Optional primarySkuId

primarySkuId: string

Optional redirectUris

redirectUris: string[]

Optional rpcApplicationState

rpcApplicationState: number

Optional rpcOrigins

rpcOrigins: string[]

Optional secret

secret: string

Optional slug

slug: string

Optional storeApplicationState

storeApplicationState: number

summary

summary: string = ''

Optional team

team: Team

verifyKey

verifyKey: string = ''

Accessors

coverImageUrl

get coverImageUrl(): null | string

- Defined in src/structures/oauth2application.ts:84
Returns null | string

createdAt

get createdAt(): Date

- Defined in src/structures/oauth2application.ts:88
Returns Date

createdAtUnix

get createdAtUnix(): number

- Defined in src/structures/oauth2application.ts:92
Returns number

iconUrl

get iconUrl(): null | string

- Defined in src/structures/oauth2application.ts:100
Returns null | string

isClone

get isClone(): boolean

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

isOnDiscord

get isOnDiscord(): boolean

- Defined in src/structures/oauth2application.ts:104
Returns boolean

jumpLink

get jumpLink(): null | string

- Defined in src/structures/oauth2application.ts:96
Returns null | string

oauth2Url

get oauth2Url(): string

- Defined in src/structures/oauth2application.ts:108
Returns string

platformDiscordUrl

get platformDiscordUrl(): null | string

- Defined in src/structures/oauth2application.ts:112
Returns null | string

shardId

get shardId(): number

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

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(): Oauth2Application

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

coverImageUrlFormat

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

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

createAsset

createAsset(options: CreateOauth2ApplicationAsset): Promise<Oauth2ApplicationAsset>

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

createStoreAsset

createStoreAsset(options: CreateStoreApplicationAsset): Promise<StoreApplicationAsset>

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

deleteAsset

deleteAsset(assetId: string): Promise<any>

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

deleteStoreAsset

deleteStoreAsset(assetId: string): Promise<any>

- Defined in src/structures/oauth2application.ts:170
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/oauth2application.ts:174
Returns Promise<BaseCollection<string, Oauth2ApplicationAsset>>

fetchNews

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

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

fetchStoreAssets

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

- Defined in src/structures/oauth2application.ts:182
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/oauth2application.ts:131
Parameters
- Optional format: null | string
- Optional query: UrlQuery
Returns null | string

joinGuild

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

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

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/oauth2application.ts:193
Parameters
- key: string
- value: any
Returns void

oauth2UrlFormat

oauth2UrlFormat(options?: UrlQuery): string

- Defined in src/structures/oauth2application.ts:140
Parameters
- options: UrlQuery = {}
Returns 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

Optional data: BaseStructureData

Optional isClone: boolean

Returns Oauth2Application

Properties

Readonly _keys

Optional bot

botPublic

botRequireCodeGrant

Readonly client

Optional coverImage

description

flags

Optional guildId

icon

id

name

owner

Optional primarySkuId

Optional redirectUris

Optional rpcApplicationState

Optional rpcOrigins

Optional secret

Optional slug

Optional storeApplicationState

summary

Optional team

verifyKey

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

oauth2Url

Returns string

platformDiscordUrl

Returns null | string

shardId

Returns number

Methods

[custom]

Returns object

_getFromSnake

Parameters

key: string

Returns any

_setFromSnake

Parameters

key: string

value: any

Returns any

clone

Returns Oauth2Application

coverImageUrlFormat

Parameters

Optional format: null | string

Optional query: UrlQuery

Returns null | string

createAsset

Parameters

options: CreateOauth2ApplicationAsset