Class MessagesMethods

Hierarchy (View Summary)

BaseNoEditableChannel<ChannelType>
DiscordBase
- MessagesMethods
  - TextBaseGuildChannel
  - DMChannel

Index

Constructors

constructor

new MessagesMethods(client: UsingClient, data: { id: string }): MessagesMethods
Parameters
- client: UsingClient
- data: { id: string }
  Unique ID of the object
Returns MessagesMethods
Inherited from BaseNoEditableChannel.constructor
- Defined in src/structures/extra/DiscordBase.ts:7

Properties

`Readonly`client

client: UsingClient

id

id: string

messages

messages: {
    crosspost: (messageId: string, reason?: string) => Promise<Message>;
    delete: (messageId: string, reason?: string) => Promise<void>;
    edit: (
        messageId: string,
        body: Omit<
            RESTPatchAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds",
        > & ResolverProps,
    ) => Promise<Message>;
    fetch: (messageId: string, force?: boolean) => Promise<Message>;
    list: (fetchOptions: RESTGetAPIChannelMessagesQuery) => Promise<Message[]>;
    purge: (messages: string[], reason?: string) => Promise<void | undefined>;
    write: (
        body: Omit<
            RESTPostAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps,
    ) => Promise<Message>;
} = ...

pins

pins: {
    delete: (messageId: string, reason?: string) => Promise<undefined>;
    fetch: (
        query?: RESTGetAPIChannelPinsQuery,
    ) => Promise<
        { hasMore: boolean; items: { message: Message; pinnedAt: string }[] },
    >;
    set: (messageId: string, reason?: string) => Promise<undefined>;
} = ...

reactions

reactions: {
    add: (messageId: string, emoji: EmojiResolvable) => Promise<void>;
    delete: (
        messageId: string,
        emoji: EmojiResolvable,
        userId?: string,
    ) => Promise<void>;
    fetch: (
        messageId: string,
        emoji: EmojiResolvable,
        query?: RESTGetAPIChannelMessageReactionUsersQuery,
    ) => Promise<User[]>;
    purge: (messageId: string, emoji?: EmojiResolvable) => Promise<void>;
} = ...

type

type: ChannelType

Accessors

createdAt

get createdAt(): Date
createdAt gets the creation Date instace of the current object.

Returns Date
Inherited from BaseNoEditableChannel.createdAt
- Defined in src/structures/extra/DiscordBase.ts:27

createdTimestamp

get createdTimestamp(): number
Create a timestamp for the current object.

Returns number
Inherited from BaseNoEditableChannel.createdTimestamp
- Defined in src/structures/extra/DiscordBase.ts:20

url

get url(): string
The URL to the channel

Returns string
Inherited from BaseNoEditableChannel.url
- Defined in src/structures/channels.ts:85

Methods

delete

delete(reason?: string): Promise<AllChannels>
Parameters
- Optionalreason: string
Returns Promise<AllChannels>
Inherited from BaseNoEditableChannel.delete
- Defined in src/structures/channels.ts:103

fetch

fetch(mode?: "rest" | "flow"): Promise<AllChannels>
Parameters
- Optionalmode: "rest" | "flow"
Returns Promise<AllChannels>
Inherited from BaseNoEditableChannel.fetch
- Defined in src/structures/channels.ts:89
fetch(mode: "cache"): ReturnCache<AllChannels | undefined>
Parameters
- mode: "cache"
Returns ReturnCache<AllChannels | undefined>
Inherited from BaseNoEditableChannel.fetch
- Defined in src/structures/channels.ts:90

is

is<T extends (keyof IChannelTypes)[]>(
channelTypes: T,
): this is IChannelTypes[T[number]]
Type Parameters
- T extends (keyof IChannelTypes)[]
Parameters
- channelTypes: T
Returns this is IChannelTypes[T[number]]
Inherited from BaseNoEditableChannel.is
- Defined in src/structures/channels.ts:163

isCategory

isCategory(): this is CategoryChannel
Returns this is CategoryChannel
Inherited from BaseNoEditableChannel.isCategory
- Defined in src/structures/channels.ts:143

isDirectory

isDirectory(): this is DirectoryChannel
Returns this is DirectoryChannel
Inherited from BaseNoEditableChannel.isDirectory
- Defined in src/structures/channels.ts:131

isDM

isDM(): this is DMChannel
Returns this is DMChannel
Inherited from BaseNoEditableChannel.isDM
- Defined in src/structures/channels.ts:119

isForum

isForum(): this is ForumChannel
Returns this is ForumChannel
Inherited from BaseNoEditableChannel.isForum
- Defined in src/structures/channels.ts:123

isGuildTextable

isGuildTextable(): this is AllGuildTextableChannels
Returns this is AllGuildTextableChannels
Inherited from BaseNoEditableChannel.isGuildTextable
- Defined in src/structures/channels.ts:155

isMedia

isMedia(): this is MediaChannel
Returns this is MediaChannel
Inherited from BaseNoEditableChannel.isMedia
- Defined in src/structures/channels.ts:115

isNews

isNews(): this is NewsChannel
Returns this is NewsChannel
Inherited from BaseNoEditableChannel.isNews
- Defined in src/structures/channels.ts:147

isStage

isStage(): this is StageChannel
Returns this is StageChannel
Inherited from BaseNoEditableChannel.isStage
- Defined in src/structures/channels.ts:111

isTextable

isTextable(): this is AllTextableChannels
Returns this is AllTextableChannels
Inherited from BaseNoEditableChannel.isTextable
- Defined in src/structures/channels.ts:151

isTextGuild

isTextGuild(): this is TextGuildChannel
Returns this is TextGuildChannel
Inherited from BaseNoEditableChannel.isTextGuild
- Defined in src/structures/channels.ts:139

isThread

isThread(): this is ThreadChannel
Returns this is ThreadChannel
Inherited from BaseNoEditableChannel.isThread
- Defined in src/structures/channels.ts:127

isThreadOnly

isThreadOnly(): this is MediaChannel | ForumChannel
Returns this is MediaChannel | ForumChannel
Inherited from BaseNoEditableChannel.isThreadOnly
- Defined in src/structures/channels.ts:159

isVoice

isVoice(): this is VoiceChannel
Returns this is VoiceChannel
Inherited from BaseNoEditableChannel.isVoice
- Defined in src/structures/channels.ts:135

toString

toString(): `<#${string}>`
Returns a string representation of an object.

Returns `<#${string}>`
Inherited from BaseNoEditableChannel.toString
- Defined in src/structures/channels.ts:107

typing

typing(): Promise<void>
Returns Promise<void>
- Defined in src/structures/channels.ts:294

`Static`messages

messages(
    ctx: { channelId: string; client: UsingClient },
): {
    crosspost: (messageId: string, reason?: string) => Promise<Message>;
    delete: (messageId: string, reason?: string) => Promise<void>;
    edit: (
        messageId: string,
        body: Omit<
            RESTPatchAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds",
        > & ResolverProps,
    ) => Promise<Message>;
    fetch: (messageId: string, force?: boolean) => Promise<Message>;
    list: (fetchOptions: RESTGetAPIChannelMessagesQuery) => Promise<Message[]>;
    purge: (messages: string[], reason?: string) => Promise<void | undefined>;
    write: (
        body: Omit<
            RESTPostAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps,
    ) => Promise<Message>;
}
Parameters
- ctx: { channelId: string; client: UsingClient }
Returns {
    crosspost: (messageId: string, reason?: string) => Promise<Message>;
    delete: (messageId: string, reason?: string) => Promise<void>;
    edit: (
        messageId: string,
        body: Omit<
            RESTPatchAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds",
        > & ResolverProps,
    ) => Promise<Message>;
    fetch: (messageId: string, force?: boolean) => Promise<Message>;
    list: (fetchOptions: RESTGetAPIChannelMessagesQuery) => Promise<Message[]>;
    purge: (messages: string[], reason?: string) => Promise<void | undefined>;
    write: (
        body: Omit<
            RESTPostAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps,
    ) => Promise<Message>;
}
- Defined in src/structures/channels.ts:308

`Static`pins

pins(
    ctx: { channelId: string; client: UsingClient },
): {
    delete: (messageId: string, reason?: string) => Promise<undefined>;
    fetch: (
        query?: RESTGetAPIChannelPinsQuery,
    ) => Promise<
        { hasMore: boolean; items: { message: Message; pinnedAt: string }[] },
    >;
    set: (messageId: string, reason?: string) => Promise<undefined>;
}
Parameters
- ctx: { channelId: string; client: UsingClient }
Returns {
    delete: (messageId: string, reason?: string) => Promise<undefined>;
    fetch: (
        query?: RESTGetAPIChannelPinsQuery,
    ) => Promise<
        { hasMore: boolean; items: { message: Message; pinnedAt: string }[] },
    >;
    set: (messageId: string, reason?: string) => Promise<undefined>;
}
- Defined in src/structures/channels.ts:340

`Static`reactions

reactions(
    ctx: { channelId: string; client: UsingClient },
): {
    add: (messageId: string, emoji: EmojiResolvable) => Promise<void>;
    delete: (
        messageId: string,
        emoji: EmojiResolvable,
        userId?: string,
    ) => Promise<void>;
    fetch: (
        messageId: string,
        emoji: EmojiResolvable,
        query?: RESTGetAPIChannelMessageReactionUsersQuery,
    ) => Promise<User[]>;
    purge: (messageId: string, emoji?: EmojiResolvable) => Promise<void>;
}
Parameters
- ctx: { channelId: string; client: UsingClient }
Returns {
    add: (messageId: string, emoji: EmojiResolvable) => Promise<void>;
    delete: (
        messageId: string,
        emoji: EmojiResolvable,
        userId?: string,
    ) => Promise<void>;
    fetch: (
        messageId: string,
        emoji: EmojiResolvable,
        query?: RESTGetAPIChannelMessageReactionUsersQuery,
    ) => Promise<User[]>;
    purge: (messageId: string, emoji?: EmojiResolvable) => Promise<void>;
}
- Defined in src/structures/channels.ts:325

`Static`transformMessageBody

transformMessageBody<T>(
    body:
        | Omit<
            RESTPostAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps
        | Omit<
            RESTPatchAPIChannelMessageJSONBody,
            "components"
            | "content"
            | "embeds",
        > & ResolverProps,
    files: RawFile[] | undefined,
    self: UsingClient,
): T
Type Parameters
- T
Parameters
- body:
      | Omit<
          RESTPostAPIChannelMessageJSONBody,
          "components"
          | "content"
          | "embeds"
          | "poll",
      > & SendResolverProps
      | Omit<
          RESTPatchAPIChannelMessageJSONBody,
          "components"
          | "content"
          | "embeds",
      > & ResolverProps
- files: RawFile[] | undefined
- self: UsingClient
Returns T
- Defined in src/structures/channels.ts:348

Class MessagesMethods

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MessagesMethods

Properties

Readonlyclient

id

messages

pins

reactions

type

Accessors

createdAt

Returns Date

createdTimestamp

Returns number

url

Returns string

Methods

delete

Parameters

Returns Promise<AllChannels>

fetch

Parameters

Returns Promise<AllChannels>

Parameters

Returns ReturnCache<AllChannels | undefined>

is

Type Parameters

Parameters

Returns this is IChannelTypes[T[number]]

isCategory

Returns this is CategoryChannel

isDirectory

Returns this is DirectoryChannel

isDM

Returns this is DMChannel

isForum

Returns this is ForumChannel

isGuildTextable

Returns this is AllGuildTextableChannels

isMedia

Returns this is MediaChannel

isNews

Returns this is NewsChannel

isStage

Returns this is StageChannel

isTextable

Returns this is AllTextableChannels

isTextGuild

Returns this is TextGuildChannel

isThread

Returns this is ThreadChannel

isThreadOnly

Returns this is MediaChannel | ForumChannel

isVoice

Returns this is VoiceChannel

toString

Returns `<#${string}>`

typing

Returns Promise<void>

Staticmessages

Parameters

Staticpins

Parameters

Returns { delete: (messageId: string, reason?: string) => Promise<undefined>; fetch: ( query?: RESTGetAPIChannelPinsQuery, ) => Promise< { hasMore: boolean; items: { message: Message; pinnedAt: string }[] }, >; set: (messageId: string, reason?: string) => Promise<undefined>;}

Staticreactions

Parameters

StatictransformMessageBody

Type Parameters

Parameters

Returns T

Settings

`Readonly`client

`Static`messages

`Static`pins

Returns {
delete: (messageId: string, reason?: string) => Promise<undefined>;
fetch: (
query?: RESTGetAPIChannelPinsQuery,
) => Promise<
{ hasMore: boolean; items: { message: Message; pinnedAt: string }[] },
>;
set: (messageId: string, reason?: string) => Promise<undefined>;
}

`Static`reactions

`Static`transformMessageBody