Class Context

Command Context

Hierarchy

Context

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Context(message: Message, typing: null | Typing, commandClient: CommandClient): Context

- Defined in src/command/context.ts:33
Parameters
- message: Message
- typing: null | Typing
- commandClient: CommandClient
Returns Context

Properties

Readonly client

client: ShardClient

Optional command

command: Command<any>

Readonly commandClient

commandClient: CommandClient

Readonly message

message: Message

Optional metadata

metadata: {}

Type declaration

[key: string]: any

Optional prefix

prefix: string

Readonly typing

typing: null | Typing

Optional Readonly typingTimeout

typingTimeout: Timeout

Accessors

application

get application(): null | Oauth2Application

- Defined in src/command/context.ts:55
Returns null | Oauth2Application

applicationId

get applicationId(): string

- Defined in src/command/context.ts:59
Returns string

applications

get applications(): Applications

- Defined in src/command/context.ts:104
Returns Applications

canDelete

get canDelete(): boolean

- Defined in src/command/context.ts:181
Returns boolean

canManage

get canManage(): boolean

- Defined in src/command/context.ts:185
Returns boolean

canReact

get canReact(): boolean

- Defined in src/command/context.ts:189
Returns boolean

canReply

get canReply(): boolean

- Defined in src/command/context.ts:193
Returns boolean

channel

get channel(): null | ChannelTextType

- Defined in src/command/context.ts:197
Returns null | ChannelTextType

channelId

get channelId(): string

- Defined in src/command/context.ts:201
Returns string

channels

get channels(): Channels

- Defined in src/command/context.ts:108
Returns Channels

cluster

get cluster(): null | ClusterClient

- Defined in src/command/context.ts:63
Returns null | ClusterClient

content

get content(): string

- Defined in src/command/context.ts:205
Returns string

emojis

get emojis(): Emojis

- Defined in src/command/context.ts:112
Returns Emojis

fromBot

get fromBot(): boolean

- Defined in src/command/context.ts:209
Returns boolean

fromSystem

get fromSystem(): boolean

- Defined in src/command/context.ts:213
Returns boolean

fromUser

get fromUser(): boolean

- Defined in src/command/context.ts:217
Returns boolean

fromWebhook

get fromWebhook(): boolean

- Defined in src/command/context.ts:221
Returns boolean

gateway

get gateway(): Socket

- Defined in src/command/context.ts:67
Returns Socket

guild

get guild(): null | Guild

- Defined in src/command/context.ts:225
Returns null | Guild

guildId

get guildId(): undefined | string

- Defined in src/command/context.ts:229
Returns undefined | string

guilds

get guilds(): Guilds

- Defined in src/command/context.ts:116
Returns Guilds

inDm

get inDm(): boolean

- Defined in src/command/context.ts:233
Returns boolean

interactionCommandClient

get interactionCommandClient(): null | InteractionCommandClient

- Defined in src/command/context.ts:91
Returns null | InteractionCommandClient

interactions

get interactions(): Interactions

- Defined in src/command/context.ts:120
Returns Interactions

manager

get manager(): null | ClusterProcessChild

- Defined in src/command/context.ts:71
Returns null | ClusterProcessChild

me

get me(): null | Member

- Defined in src/command/context.ts:237
Returns null | Member

member

get member(): undefined | Member

- Defined in src/command/context.ts:245
Returns undefined | Member

members

get members(): Members

- Defined in src/command/context.ts:124
Returns Members

messageId

get messageId(): string

- Defined in src/command/context.ts:249
Returns string

messages

get messages(): Messages

- Defined in src/command/context.ts:128
Returns Messages

notes

get notes(): Notes

- Defined in src/command/context.ts:132
Returns Notes

owners

get owners(): BaseCollection<string, User>

- Defined in src/command/context.ts:75
Returns BaseCollection<string, User>

presences

get presences(): Presences

- Defined in src/command/context.ts:136
Returns Presences

relationships

get relationships(): Relationships

- Defined in src/command/context.ts:140
Returns Relationships

response

get response(): null | Message

- Defined in src/command/context.ts:95
Returns null | Message

rest

get rest(): RestClient

- Defined in src/command/context.ts:79
Returns RestClient

roles

get roles(): Roles

- Defined in src/command/context.ts:144
Returns Roles

sessions

get sessions(): Sessions

- Defined in src/command/context.ts:148
Returns Sessions

shardCount

get shardCount(): number

- Defined in src/command/context.ts:83
Returns number

shardId

get shardId(): number

- Defined in src/command/context.ts:87
Returns number

stageInstances

get stageInstances(): StageInstances

- Defined in src/command/context.ts:152
Returns StageInstances

stickers

get stickers(): Stickers

- Defined in src/command/context.ts:156
Returns Stickers

systemContent

get systemContent(): string

- Defined in src/command/context.ts:253
Returns string

typings

get typings(): TypingCollection

- Defined in src/command/context.ts:160
Returns TypingCollection

user

get user(): User

- Defined in src/command/context.ts:257
Returns User

userId

get userId(): string

- Defined in src/command/context.ts:261
Returns string

users

get users(): Users

- Defined in src/command/context.ts:164
Returns Users

voiceCalls

get voiceCalls(): VoiceCalls

- Defined in src/command/context.ts:168
Returns VoiceCalls

voiceChannel

get voiceChannel(): null | ChannelGuildVoice

- Defined in src/command/context.ts:265
Returns null | ChannelGuildVoice

voiceConnection

get voiceConnection(): undefined | VoiceConnection

- Defined in src/command/context.ts:273
Returns undefined | VoiceConnection

voiceConnections

get voiceConnections(): VoiceConnections

- Defined in src/command/context.ts:172
Returns VoiceConnections

voiceState

get voiceState(): null | VoiceState

- Defined in src/command/context.ts:277
Returns null | VoiceState

voiceStates

get voiceStates(): VoiceStates

- Defined in src/command/context.ts:176
Returns VoiceStates

Methods

editOrReply

editOrReply(options?: string | EditOrReply): Promise<Message>

- Defined in src/command/context.ts:285
Parameters
- options: string | EditOrReply = {}
Returns Promise<Message>

reply

reply(options?: string | CreateMessage): Promise<Message>

- Defined in src/command/context.ts:311
Parameters
- options: string | CreateMessage = {}
Returns Promise<Message>

toJSON

toJSON(): object

- Defined in src/command/context.ts:319
Returns object

toString

toString(): string

- Defined in src/command/context.ts:323
Returns string

triggerTyping

triggerTyping(): Promise<any>

- Defined in src/command/context.ts:315
Returns Promise<any>

Generated using TypeDoc