Class Message<InGuild>

Type Parameters

  • InGuild extends boolean = boolean

Hierarchy

  • Base
    • Message

Constructors

constructor

Properties

_cacheType activity applicationId attachments author channelId client components content createdTimestamp editedTimestamp embeds flags groupActivityApplication guildId id interaction mentions nonce pinned position reactions reference resolved roleSubscriptionData stickers system tts type webhookId

Accessors

bulkDeletable channel cleanContent createdAt crosspostable deletable editable editedAt guild hasThread member partial pinnable thread url

Methods

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

Constructors

Private constructor

  • Type Parameters

    • InGuild extends boolean = boolean

    Parameters

    • client: Client<true>
    • data: APIMessage

    Returns Message<InGuild>

Properties

Private Readonly _cacheType

_cacheType: InGuild

activity

activity: null | MessageActivity

applicationId

applicationId: null | string

attachments

attachments: Collection<string, Attachment>

author

author: User

channelId

channelId: string

Readonly client

client: Client<true>

components

components: ActionRow<MessageActionRowComponent>[]

content

content: string

createdTimestamp

createdTimestamp: number

editedTimestamp

editedTimestamp: null | number

embeds

embeds: Embed[]

flags

flags: Readonly<MessageFlagsBitField>

groupActivityApplication

groupActivityApplication: null | ClientApplication

guildId

guildId: If<InGuild, string, null>

id

id: string

interaction

interaction: null | MessageInteraction

mentions

mentions: MessageMentions<InGuild>

nonce

nonce: null | string | number

pinned

pinned: boolean

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: boolean

tts

tts: boolean

type

type: MessageType

webhookId

webhookId: null | string

Accessors

bulkDeletable

  • get bulkDeletable(): boolean

  • Returns boolean

channel

  • get channel(): If<InGuild, GuildTextBasedChannel, TextBasedChannel>

  • Returns If<InGuild, GuildTextBasedChannel, TextBasedChannel>

cleanContent

  • get cleanContent(): string

  • Returns string

createdAt

  • get createdAt(): Date

  • Returns Date

crosspostable

  • get crosspostable(): boolean

  • Returns boolean

deletable

  • get deletable(): boolean

  • Returns boolean

editable

  • get editable(): boolean

  • Returns boolean

editedAt

  • get editedAt(): null | Date

  • Returns null | Date

guild

  • get guild(): If<InGuild, Guild, null>

  • Returns If<InGuild, Guild, null>

hasThread

  • get hasThread(): boolean

  • Returns boolean

member

  • get member(): null | GuildMember

  • Returns null | GuildMember

partial

  • get partial(): false

  • Returns false

pinnable

  • get pinnable(): boolean

  • Returns boolean

thread

  • get thread(): null | AnyThreadChannel<boolean>

  • Returns null | AnyThreadChannel<boolean>

url

  • get url(): string

  • Returns string

Methods

Private _patch

  • _patch(data): void

  • Parameters

    • data: APIMessage | GatewayMessageUpdateDispatchData

    Returns void

awaitMessageComponent

  • Type Parameters

    Parameters

    • Optional options: AwaitMessageCollectorOptionsParams<ComponentType, InGuild>

    Returns Promise<MappedInteractionTypes<InGuild>[ComponentType]>

awaitReactions

  • Parameters

    • Optional options: AwaitReactionsOptions

    Returns Promise<Collection<string, MessageReaction>>

createMessageComponentCollector

  • Type Parameters

    Parameters

    • Optional options: MessageCollectorOptionsParams<ComponentType, InGuild>

    Returns InteractionCollector<MappedInteractionTypes<InGuild>[ComponentType]>

createReactionCollector

  • Parameters

    • Optional options: ReactionCollectorOptions

    Returns ReactionCollector

crosspost

  • Returns Promise<Message<InGuild>>

delete

  • Returns Promise<Message<InGuild>>

edit

  • Parameters

    • content: string | MessageEditOptions | MessagePayload

    Returns Promise<Message<InGuild>>

equals

  • Parameters

    • message: Message<boolean>
    • rawData: unknown

    Returns boolean

fetch

  • Parameters

    • Optional force: boolean

    Returns Promise<Message<InGuild>>

fetchReference

  • Returns Promise<Message<InGuild>>

fetchWebhook

  • Returns Promise<Webhook>

inGuild

  • Returns this is Message<true>

pin

  • Parameters

    • Optional reason: string

    Returns Promise<Message<InGuild>>

react

  • Parameters

    • emoji: EmojiIdentifierResolvable

    Returns Promise<MessageReaction>

removeAttachments

  • Returns Promise<Message<InGuild>>

reply

  • Parameters

    • options: string | MessagePayload | MessageReplyOptions

    Returns Promise<Message<InGuild>>

resolveComponent

  • Parameters

    • customId: string

    Returns null | MessageActionRowComponent

startThread

  • Parameters

    • options: StartThreadOptions

    Returns Promise<AnyThreadChannel<boolean>>

suppressEmbeds

  • Parameters

    • Optional suppress: boolean

    Returns Promise<Message<InGuild>>

toJSON

  • Returns unknown

toString

  • Returns string

unpin

  • Parameters

    • Optional reason: string

    Returns Promise<Message<InGuild>>

valueOf

  • Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc