MessagesMethods

Extends

BaseChannel<ChannelType>.DiscordBase

Constructors

new MessagesMethods(client, data)

1
new MessagesMethods(client: UsingClient, data:     Object): MessagesMethods

Parameters

Parameter	Type	Description
`client`	`UsingClient`	-
`data`	`Object`	Unique ID of the object
`data.id`	`string`	-

Properties

Property	Modifier	Type	Inherited from
`client`	`readonly`	`UsingClient`	`BaseChannel`.`client`
`id`	`public`	`string`	`BaseChannel`.`id`
`messages`	`public`	`Object`	-
`messages.crosspost`	`public`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`Message`>	-
`messages.delete`	`public`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`void`>	-
`messages.edit`	`public`	(`messageId`: `string`, `body`: `Omit`<`RESTPatchAPIChannelMessageJSONBody`, `"components"` \| `"embeds"`> & `ResolverProps`) => `Promise`<`Message`>	-
`messages.fetch`	`public`	(`messageId`: `string`) => `Promise`<`Message`>	-
`messages.purge`	`public`	(`messages`: `string`[], `reason`?: `string`) => `Promise`<`undefined` \| `void`>	-
`messages.write`	`public`	(`body`: `Omit`<`RESTPostAPIChannelMessageJSONBody`, `"components"` \| `"embeds"` \| `"poll"`> & `SendResolverProps`) => `Promise`<`Message`>	-
`pins`	`public`	`Object`	-
`pins.delete`	`public`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`never`>	-
`pins.fetch`	`public`	() => `Promise`<`Message`[]>	-
`pins.set`	`public`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`never`>	-
`reactions`	`public`	`Object`	-
`reactions.add`	`public`	(`messageId`: `string`, `emoji`: `EmojiResolvable`) => `Promise`<`void`>	-
`reactions.delete`	`public`	(`messageId`: `string`, `emoji`: `EmojiResolvable`, `userId`: `string`) => `Promise`<`void`>	-
`reactions.fetch`	`public`	(`messageId`: `string`, `emoji`: `EmojiResolvable`, `query`?: `RESTGetAPIChannelMessageReactionUsersQuery`) => `Promise`<`User`[]>	-
`reactions.purge`	`public`	(`messageId`: `string`, `emoji`?: `EmojiResolvable`) => `Promise`<`void`>	-
`type`	`public`	`ChannelType`	`BaseChannel`.`type`

Accessors

createdAt

1
get createdAt(): Date

createdAt gets the creation Date instace of the current object.

Returns

Date

Source

seyfert/src/structures/extra/DiscordBase.ts:27

createdTimestamp

1
get createdTimestamp(): number

Create a timestamp for the current object.

Returns

number

Source

seyfert/src/structures/extra/DiscordBase.ts:20

url

1
get url(): string

The URL to the channel

Returns

string

Source

seyfert/src/structures/channels.ts:58

Methods

delete()

1
delete(reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`reason`?	`string`

Returns

Promise<AllChannels>

Inherited from

BaseChannel.delete

Source

seyfert/src/structures/channels.ts:66

edit()

1
edit(body: RESTPatchAPIChannelJSONBody, reason?: string): Promise<AllChannels>

Parameters

Parameter	Type
`body`	`RESTPatchAPIChannelJSONBody`
`reason`?	`string`

Returns

Promise<AllChannels>

Inherited from

BaseChannel.edit

Source

seyfert/src/structures/channels.ts:70

fetch()

1
fetch(force: boolean): Promise<AllChannels>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

Promise<AllChannels>

Inherited from

BaseChannel.fetch

Source

seyfert/src/structures/channels.ts:62

is()

1
is<T>(channelTypes: T): this is IChannelTypes[T[number]]

Type parameters

Type parameter
`T` extends keyof `IChannelTypes`[]

Parameters

Parameter	Type
`channelTypes`	`T`

Returns

this is IChannelTypes[T[number]]

Inherited from

BaseChannel.is

Source

seyfert/src/structures/channels.ts:133

isCategory()

1
isCategory(): this is CategoryChannel

Returns

this is CategoryChannel

Inherited from

BaseChannel.isCategory

Source

seyfert/src/structures/channels.ts:113

isDM()

1
isDM(): this is DMChannel

Returns

this is DMChannel

Inherited from

BaseChannel.isDM

Source

seyfert/src/structures/channels.ts:89

isDirectory()

1
isDirectory(): this is DirectoryChannel

Returns

this is DirectoryChannel

Inherited from

BaseChannel.isDirectory

Source

seyfert/src/structures/channels.ts:101

isForum()

1
isForum(): this is ForumChannel

Returns

this is ForumChannel

Inherited from

BaseChannel.isForum

Source

seyfert/src/structures/channels.ts:93

isGuildTextable()

1
isGuildTextable(): this is AllGuildTextableChannels

Returns

this is AllGuildTextableChannels

Inherited from

BaseChannel.isGuildTextable

Source

seyfert/src/structures/channels.ts:125

isMedia()

1
isMedia(): this is MediaChannel

Returns

this is MediaChannel

Inherited from

BaseChannel.isMedia

Source

seyfert/src/structures/channels.ts:85

isNews()

1
isNews(): this is NewsChannel

Returns

this is NewsChannel

Inherited from

BaseChannel.isNews

Source

seyfert/src/structures/channels.ts:117

isStage()

1
isStage(): this is StageChannel

Returns

this is StageChannel

Inherited from

BaseChannel.isStage

Source

seyfert/src/structures/channels.ts:81

isTextGuild()

1
isTextGuild(): this is TextGuildChannel

Returns

this is TextGuildChannel

Inherited from

BaseChannel.isTextGuild

Source

seyfert/src/structures/channels.ts:109

isTextable()

1
isTextable(): this is AllTextableChannels

Returns

this is AllTextableChannels

Inherited from

BaseChannel.isTextable

Source

seyfert/src/structures/channels.ts:121

isThread()

1
isThread(): this is ThreadChannel

Returns

this is ThreadChannel

Inherited from

BaseChannel.isThread

Source

seyfert/src/structures/channels.ts:97

isThreadOnly()

1
isThreadOnly(): this is MediaChannel | ForumChannel

Returns

this is MediaChannel | ForumChannel

Inherited from

BaseChannel.isThreadOnly

Source

seyfert/src/structures/channels.ts:129

isVoice()

1
isVoice(): this is VoiceChannel

Returns

this is VoiceChannel

Inherited from

BaseChannel.isVoice

Source

seyfert/src/structures/channels.ts:105

toString()

1
toString(): string

Returns

string

Inherited from

BaseChannel.toString

Source

seyfert/src/structures/channels.ts:77

typing()

1
typing(): Promise<void>

Returns

Promise<void>

Source

seyfert/src/structures/channels.ts:213

messages()

1
static messages(ctx:     Object): Object

Parameters

Parameter	Type
`ctx`	`Object`
`ctx.channelId`	`string`
`ctx.client`	`UsingClient`

Returns

Object

Member	Type	Value
`crosspost`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`Message`>	-
`delete`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`void`>	-
`edit`	(`messageId`: `string`, `body`: `Omit`<`RESTPatchAPIChannelMessageJSONBody`, `"components"` \| `"embeds"`> & `ResolverProps`) => `Promise`<`Message`>	-
`fetch`	(`messageId`: `string`) => `Promise`<`Message`>	-
`purge`	(`messages`: `string`[], `reason`?: `string`) => `Promise`<`undefined` \| `void`>	-
`write`	(`body`: `Omit`<`RESTPostAPIChannelMessageJSONBody`, `"components"` \| `"embeds"` \| `"poll"`> & `SendResolverProps`) => `Promise`<`Message`>	-

Source

seyfert/src/structures/channels.ts:221

pins()

1
static pins(ctx:     Object): Object

Parameters

Parameter	Type
`ctx`	`Object`
`ctx.channelId`	`string`
`ctx.client`	`UsingClient`

Returns

Object

Member	Type	Value
`delete`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`never`>	-
`fetch`	() => `Promise`<`Message`[]>	-
`set`	(`messageId`: `string`, `reason`?: `string`) => `Promise`<`never`>	-

Source

seyfert/src/structures/channels.ts:245

reactions()

1
static reactions(ctx:     Object): Object

Parameters

Parameter	Type
`ctx`	`Object`
`ctx.channelId`	`string`
`ctx.client`	`UsingClient`

Returns

Object

Member	Type	Value
`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`>	-

Source

seyfert/src/structures/channels.ts:234

transformMessageBody()

1
static transformMessageBody<T>(body: Omit<RESTPostAPIChannelMessageJSONBody, "components" | "embeds" | "poll"> & SendResolverProps | Omit<RESTPatchAPIChannelMessageJSONBody, "components" | "embeds"> & ResolverProps, self: UsingClient): T

Type parameters

Type parameter
`T`

Parameters

Parameter	Type
`body`	`Omit`<`RESTPostAPIChannelMessageJSONBody`, `"components"` \| `"embeds"` \| `"poll"`> & `SendResolverProps` \| `Omit`<`RESTPatchAPIChannelMessageJSONBody`, `"components"` \| `"embeds"`> & `ResolverProps`
`self`	`UsingClient`

Returns

T

Source

seyfert/src/structures/channels.ts:253