seyfert
    Preparing search index...

    Interface GuildCommandContext<T, M>

    interface GuildCommandContext<
        T extends OptionsRecord = {},
        M extends keyof RegisteredMiddlewares = never,
    > {
        author: User;
        channelId: string;
        client: UsingClient;
        command: Command | SubCommand;
        fullCommandName: string;
        globalMetadata: GlobalMetadata;
        guildId: string;
        interaction: ChatInputCommandInteraction<boolean>;
        member: InteractionGuildMember;
        message: undefined;
        messageResponse?: Message | null;
        metadata: CommandMetadata<UnionToTuple<M, []>>;
        options: ContextOptions<T>;
        proxy: APIRoutes;
        resolver: OptionResolver;
        shardId: number;
        t: __InternalParseLocale<DefaultLocale> & {
            get(locale?: string): DefaultLocale;
        };
        channel(mode?: "rest" | "flow"): Promise<AllChannels>;
        channel(mode: "cache"): ReturnCache<AllChannels>;
        deferReply<WR extends boolean = false>(
            ephemeral?: boolean,
            withResponse?: WR,
        ): Promise<When<WR, WebhookMessage, undefined>>;
        deleteResponse(): Promise<void>;
        editOrReply<WR extends boolean = false>(
            body:
                | Omit<
                    APIInteractionResponseCallbackData,
                    "components"
                    | "content"
                    | "embeds"
                    | "poll",
                > & SendResolverProps
                | InteractionMessageUpdateBodyRequest,
            withResponse?: WR,
        ): Promise<When<WR, WebhookMessage, void | WebhookMessage>>;
        editResponse(
            body: InteractionMessageUpdateBodyRequest,
        ): Promise<WebhookMessage>;
        fetchResponse(): Promise<WebhookMessage>;
        followup(
            body: Omit<
                RESTPostAPIWebhookWithTokenJSONBody,
                "components"
                | "content"
                | "embeds"
                | "poll",
            > & SendResolverProps,
        ): Promise<WebhookMessage>;
        guild(mode?: "rest" | "flow"): Promise<Guild<"cached" | "api">>;
        guild(mode: "cache"): ReturnCache<Guild<"cached"> | undefined>;
        inGuild(): this is GuildCommandContext<T, M>;
        isButton(): this is ComponentContext<"Button", never>;
        isChannelSelectMenu(): this is ComponentContext<"ChannelSelect", never>;
        isChat(): this is CommandContext<T, M>;
        isComponent(): this is ComponentContext<
            keyof ContextComponentCommandInteractionMap,
            never,
        >;
        isEntryPoint(): this is EntryPointContext<never>;
        isMentionableSelectMenu(): this is ComponentContext<
            "MentionableSelect",
            never,
        >;
        isMenu(): this is MenuCommandContext<
            UserCommandInteraction<boolean>
            | MessageCommandInteraction<boolean>,
            never,
        >;
        isMenuMessage(): this is MenuCommandContext<
            MessageCommandInteraction<boolean>,
            never,
        >;
        isMenuUser(): this is MenuCommandContext<
            UserCommandInteraction<boolean>,
            never,
        >;
        isModal(): this is ModalContext<never>;
        isRoleSelectMenu(): this is ComponentContext<"RoleSelect", never>;
        isStringSelectMenu(): this is ComponentContext<"StringSelect", never>;
        isUserSelectMenu(): this is ComponentContext<"UserSelect", never>;
        me(mode?: "rest" | "flow"): Promise<GuildMember>;
        me(mode: "cache"): ReturnCache<GuildMember | undefined>;
        write<WR extends boolean = false>(
            body: Omit<
                APIInteractionResponseCallbackData,
                "components"
                | "content"
                | "embeds"
                | "poll",
            > & SendResolverProps,
            withResponse?: WR,
        ): Promise<When<WR, WebhookMessage, void | WebhookMessage>>;
    }

    Type Parameters

    Hierarchy

    • Omit<MakeRequired<CommandContext<T, M>, "guildId" | "member">, "guild" | "me">
      • GuildCommandContext
    Index

    Properties

    author channelId client command fullCommandName globalMetadata guildId interaction member message messageResponse? metadata options proxy resolver shardId t

    Methods

    channel deferReply deleteResponse editOrReply editResponse fetchResponse followup guild inGuild isButton isChannelSelectMenu isChat isComponent isEntryPoint isMentionableSelectMenu isMenu isMenuMessage isMenuUser isModal isRoleSelectMenu isStringSelectMenu isUserSelectMenu me write

    Properties

    author: User
    channelId: string
    client: UsingClient
    command: Command | SubCommand
    fullCommandName: string
    globalMetadata: GlobalMetadata = {}
    guildId: string
    interaction: ChatInputCommandInteraction<boolean>
    member: InteractionGuildMember
    message: undefined
    messageResponse?: Message | null
    metadata: CommandMetadata<UnionToTuple<M, []>> = ...
    options: ContextOptions<T> = ...
    proxy: APIRoutes
    resolver: OptionResolver
    shardId: number
    t: __InternalParseLocale<DefaultLocale> & {
        get(locale?: string): DefaultLocale;
    }

    Methods

    • Type Parameters

      • WR extends boolean = false

      Parameters

      • body:
            | Omit<
                APIInteractionResponseCallbackData,
                "components"
                | "content"
                | "embeds"
                | "poll",
            > & SendResolverProps
            | InteractionMessageUpdateBodyRequest
      • OptionalwithResponse: WR

      Returns Promise<When<WR, WebhookMessage, void | WebhookMessage>>

    • Parameters

      • body: Omit<
            RESTPostAPIWebhookWithTokenJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps

      Returns Promise<WebhookMessage>

    • Type Parameters

      • WR extends boolean = false

      Parameters

      • body: Omit<
            APIInteractionResponseCallbackData,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps
      • OptionalwithResponse: WR

      Returns Promise<When<WR, WebhookMessage, void | WebhookMessage>>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods