Interface PartialMessage

interface PartialMessage {
    activity: null | MessageActivity;
    applicationId: null | string;
    attachments: Collection<string, Attachment>;
    author: null | User;
    bulkDeletable: boolean;
    call: null | MessageCall;
    channel:
        | DMChannel
        | PartialDMChannel
        | PartialGroupDMChannel
        | NewsChannel
        | StageChannel
        | TextChannel
        | PublicThreadChannel<boolean>
        | PrivateThreadChannel
        | VoiceChannel;
    channelId: string;
    cleanContent: null | string;
    client: Client<true>;
    components: TopLevelComponent[];
    content: null | string;
    createdAt: Date;
    createdTimestamp: number;
    crosspostable: boolean;
    deletable: boolean;
    editable: boolean;
    editedAt: null | Date;
    editedTimestamp: null | number;
    embeds: Embed[];
    flags: Readonly<MessageFlagsBitField>;
    groupActivityApplication: null | ClientApplication;
    guild: null | Guild;
    guildId: null | string;
    hasThread: boolean;
    id: string;
    interaction: null | MessageInteraction;
    interactionMetadata: null | MessageInteractionMetadata;
    member: null | GuildMember;
    mentions: MessageMentions<boolean>;
    messageSnapshots: Collection<string, MessageSnapshot>;
    nonce: null | string | number;
    partial: true;
    pinnable: boolean;
    pinned: null;
    poll: null | Poll;
    position: null | number;
    reactions: ReactionManager;
    reference: null | MessageReference;
    resolved: null | CommandInteractionResolvedData<CacheType>;
    roleSubscriptionData: null | RoleSubscriptionData;
    stickers: Collection<string, Sticker>;
    system: null;
    thread: null | AnyThreadChannel;
    tts: null;
    type: null;
    url: string;
    webhookId: null | string;
    awaitMessageComponent<ComponentType extends MessageComponentType>(
        options?: AwaitMessageCollectorOptionsParams<ComponentType, boolean>,
    ): Promise<MappedInteractionTypes<boolean>[ComponentType]>;
    awaitReactions(
        options?: AwaitReactionsOptions,
    ): Promise<Collection<string, MessageReaction>>;
    createMessageComponentCollector<ComponentType extends MessageComponentType>(
        options?: MessageCollectorOptionsParams<ComponentType, boolean>,
    ): InteractionCollector<MappedInteractionTypes<boolean>[ComponentType]>;
    createReactionCollector(
        options?: ReactionCollectorOptions,
    ): ReactionCollector;
    crosspost(): Promise<OmitPartialGroupDMChannel<Message<boolean>>>;
    delete(): Promise<OmitPartialGroupDMChannel<Message<boolean>>>;
    edit(
        content: string | MessagePayload | MessageEditOptions,
    ): Promise<OmitPartialGroupDMChannel<Message<boolean>>>;
    equals(message: Message, rawData: unknown): boolean;
    fetch(
        force?: boolean,
    ): Promise<OmitPartialGroupDMChannel<Message<boolean>>>;
    fetchReference(): Promise<OmitPartialGroupDMChannel<Message<boolean>>>;
    fetchWebhook(): Promise<Webhook<WebhookType>>;
    forward(
        channel:
            | string
            | DMChannel
            | PartialDMChannel
            | NewsChannel
            | StageChannel
            | TextChannel
            | PublicThreadChannel<boolean>
            | PrivateThreadChannel
            | VoiceChannel,
    ): Promise<Message<boolean>>;
    inGuild(): this is Message<true>;
    pin(reason?: string): Promise<OmitPartialGroupDMChannel<Message<boolean>>>;
    react(emoji: EmojiIdentifierResolvable): Promise<MessageReaction>;
    removeAttachments(): Promise<OmitPartialGroupDMChannel<Message<boolean>>>;
    reply(
        options: string | MessagePayload | MessageReplyOptions,
    ): Promise<OmitPartialGroupDMChannel<Message<boolean>>>;
    resolveComponent(customId: string): null | MessageActionRowComponent;
    startThread(
        options: StartThreadOptions,
    ): Promise<PublicThreadChannel<false>>;
    suppressEmbeds(
        suppress?: boolean,
    ): Promise<OmitPartialGroupDMChannel<Message<boolean>>>;
    toJSON(): unknown;
    toString(): string;
    unpin(
        reason?: string,
    ): Promise<OmitPartialGroupDMChannel<Message<boolean>>>;
    valueOf(): string;
}

Hierarchy (View Summary)

  • Partialize<
        Message,
        "type"
        | "system"
        | "pinned"
        | "tts",
        "content" | "cleanContent" | "author",
    >
    • PartialMessage

Properties

activity applicationId attachments author bulkDeletable call channel channelId cleanContent client components content createdAt createdTimestamp crosspostable deletable editable editedAt editedTimestamp embeds flags groupActivityApplication guild guildId hasThread id interaction interactionMetadata member mentions messageSnapshots nonce partial pinnable pinned poll position reactions reference resolved roleSubscriptionData stickers system thread tts type url webhookId

Methods

awaitMessageComponent awaitReactions createMessageComponentCollector createReactionCollector crosspost delete edit equals fetch fetchReference fetchWebhook forward inGuild pin react removeAttachments reply resolveComponent startThread suppressEmbeds toJSON toString unpin valueOf

Properties

activity

activity: null | MessageActivity

applicationId

applicationId: null | string

attachments

attachments: Collection<string, Attachment>

author

author: null | User

bulkDeletable

bulkDeletable: boolean

call

call: null | MessageCall

channel

channel:
    | DMChannel
    | PartialDMChannel
    | PartialGroupDMChannel
    | NewsChannel
    | StageChannel
    | TextChannel
    | PublicThreadChannel<boolean>
    | PrivateThreadChannel
    | VoiceChannel

channelId

channelId: string

cleanContent

cleanContent: null | string

Readonlyclient

client: Client<true>

components

components: TopLevelComponent[]

content

content: null | string

createdAt

createdAt: Date

createdTimestamp

createdTimestamp: number

crosspostable

crosspostable: boolean

deletable

deletable: boolean

editable

editable: boolean

editedAt

editedAt: null | Date

editedTimestamp

editedTimestamp: null | number

embeds

embeds: Embed[]

flags

flags: Readonly<MessageFlagsBitField>

groupActivityApplication

groupActivityApplication: null | ClientApplication

guild

guild: null | Guild

guildId

guildId: null | string

hasThread

hasThread: boolean

id

id: string

interaction

interaction: null | MessageInteraction

Deprecated

Use Message.interactionMetadata instead.

interactionMetadata

interactionMetadata: null | MessageInteractionMetadata

member

member: null | GuildMember

mentions

mentions: MessageMentions<boolean>

messageSnapshots

messageSnapshots: Collection<string, MessageSnapshot>

nonce

nonce: null | string | number

partial

partial: true

pinnable

pinnable: boolean

pinned

pinned: null

poll

poll: null | Poll

position

position: null | number

reactions

reactions: ReactionManager

reference

reference: null | MessageReference

resolved

resolved: null | CommandInteractionResolvedData<CacheType>

roleSubscriptionData

roleSubscriptionData: null | RoleSubscriptionData

stickers

stickers: Collection<string, Sticker>

system

system: null

thread

thread: null | AnyThreadChannel

tts

tts: null

type

type: null

url

url: string

webhookId

webhookId: null | string

Methods

awaitMessageComponent

awaitReactions

createMessageComponentCollector

createReactionCollector

crosspost

delete

edit

equals

  • equals(message: Message, rawData: unknown): boolean

    Parameters

    Returns boolean

fetch

fetchReference

fetchWebhook

forward

inGuild

  • inGuild(): this is Message<true>

    Returns this is Message<true>

pin

react

removeAttachments

reply

resolveComponent

startThread

suppressEmbeds

toJSON

  • toJSON(): unknown

    Returns unknown

toString

  • toString(): string

    Returns a string representation of an object.

    Returns string

unpin

valueOf

  • valueOf(): string

    Returns string

Settings

Member Visibility

On This Page

Properties
Methods