Files
website/src/content/docs/v4/api/classes/Context.md
Jacob Nguyen 2e769800dd doc update
2024-05-31 00:52:52 -05:00

6.4 KiB

editUrl, next, prev, title
editUrl next prev title
false false false Context

Since

1.0.0 Provides values shared between Message and ChatInputCommandInteraction

Extends

  • CoreContext<Message, ChatInputCommandInteraction>

Accessors

channel

get channel(): null | TextBasedChannel

Returns

null | TextBasedChannel

Source

src/core/structures/context.ts:53


channelId

get channelId(): string

Returns

string

Source

src/core/structures/context.ts:57


client

get client(): Client<boolean>

Returns

Client<boolean>

Source

src/core/structures/context.ts:103


createdTimestamp

get createdTimestamp(): number

Returns

number

Source

src/core/structures/context.ts:77


guild

get guild(): null | Guild

Returns

null | Guild

Source

src/core/structures/context.ts:83


guildId

get guildId(): null | string

Returns

null | string

Source

src/core/structures/context.ts:89


id

get id(): string

Returns

string

Source

src/core/structures/context.ts:47


inGuild

get inGuild(): boolean

Returns

boolean

Source

src/core/structures/context.ts:109


interaction

get interaction(): I

Returns

I

Source

src/core/structures/core-context.ts:15


member

get member(): null | GuildMember | APIInteractionGuildMember

Returns

null | GuildMember | APIInteractionGuildMember

Source

src/core/structures/context.ts:97


message

get message(): M

Returns

M

Source

src/core/structures/core-context.ts:12


options

get options(): Omit<CommandInteractionOptionResolver<CacheType>, "getMessage" | "getFocused">

Returns

Omit<CommandInteractionOptionResolver<CacheType>, "getMessage" | "getFocused">

Source

src/core/structures/context.ts:24


prefix

get prefix(): undefined | string

Returns

undefined | string

Source

src/core/structures/context.ts:44


user

get user(): User

If context is holding a message, message.author else, interaction.user

Returns

User

Source

src/core/structures/context.ts:67


userId

get userId(): string

Returns

string

Source

src/core/structures/context.ts:73

Methods

args()

args(type): string[] | Omit<CommandInteractionOptionResolver<CacheType>, "getMessage" | "getFocused">

Parameters

type: "message" | "interaction"

Returns

string[] | Omit<CommandInteractionOptionResolver<CacheType>, "getMessage" | "getFocused">

Source

src/core/structures/context.ts:28


isMessage()

isMessage(): this is CoreContext<Message<boolean>, never>

Returns

this is CoreContext<Message<boolean>, never>

Inherited from

CoreContext.isMessage

Source

src/core/structures/core-context.ts:19


isSlash()

isSlash(): this is CoreContext<never, ChatInputCommandInteraction<CacheType>>

Returns

this is CoreContext<never, ChatInputCommandInteraction<CacheType>>

Inherited from

CoreContext.isSlash

Source

src/core/structures/core-context.ts:23


reply()

reply(content): Promise<Message<boolean>>

Parameters

content: ReplyOptions

Returns

Promise<Message<boolean>>

Source

src/core/structures/context.ts:115


wrap()

static wrap(wrappable, prefix?): Context

Parameters

wrappable: BaseInteraction<CacheType> | Message<boolean>

prefix?: string

Returns

Context

Source

src/core/structures/context.ts:124