DMChannel

Extends

ObjectToLower<APIDMChannel>.Omit<MessagesMethods, "edit">.Object

Constructors

new DMChannel(args)

1
new DMChannel(...args: any[]): DMChannel

Parameters

Parameter	Type
…`args`	`any`[]

Returns

DMChannel

Inherited from

ObjectToLower<APIDMChannel>.constructor

Source

seyfert/src/common/types/util.ts:3

Properties

Property	Modifier	Type	Inherited from
`api`	`public`	`APIRoutes`	`Omit.api`
`cache`	`public`	`Cache`	`Omit.cache`
`client`	`readonly`	`UsingClient`	`Omit.client`
`createdAt`	`public`	`Date`	`Omit.createdAt`
`createdTimestamp`	`public`	`number`	`Omit.createdTimestamp`
`flags`	`public`	`undefined` \| `ChannelFlags`	`ObjectToLower.flags`
`id`	`public`	`string`	`ObjectToLower.id`
`lastMessageId`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.lastMessageId`
`lastPinTimestamp`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.lastPinTimestamp`
`messages`	`public`	`Object`	`Omit.messages`
`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`>	-
`name`	`public`	`undefined`	`ObjectToLower.name`
`pins`	`public`	`Object`	`Omit.pins`
`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`	`Omit.reactions`
`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`>	-
`recipients`	`public`	`undefined` \| `Object`[]	`ObjectToLower.recipients`
`rest`	`public`	`ApiHandler`	`Omit.rest`
`type`	`public`	`DM`	`ObjectToLower.type`
`url`	`public`	`string`	`Omit.url`

Methods

delete()

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

Parameters

Parameter	Type
`reason`?	`string`

Returns

Promise<AllChannels>

Inherited from

Omit.delete

Source

seyfert/src/structures/channels.ts:66

fetch()

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

Parameters

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

Returns

Promise<AllChannels>

Inherited from

Omit.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

Omit.is

Source

seyfert/src/structures/channels.ts:133

isCategory()

1
isCategory(): this is CategoryChannel

Returns

this is CategoryChannel

Inherited from

Omit.isCategory

Source

seyfert/src/structures/channels.ts:113

isDM()

1
isDM(): this is DMChannel

Returns

this is DMChannel

Inherited from

Omit.isDM

Source

seyfert/src/structures/channels.ts:89

isDirectory()

1
isDirectory(): this is DirectoryChannel

Returns

this is DirectoryChannel

Inherited from

Omit.isDirectory

Source

seyfert/src/structures/channels.ts:101

isForum()

1
isForum(): this is ForumChannel

Returns

this is ForumChannel

Inherited from

Omit.isForum

Source

seyfert/src/structures/channels.ts:93

isGuildTextable()

1
isGuildTextable(): this is AllGuildTextableChannels

Returns

this is AllGuildTextableChannels

Inherited from

Omit.isGuildTextable

Source

seyfert/src/structures/channels.ts:125

isMedia()

1
isMedia(): this is MediaChannel

Returns

this is MediaChannel

Inherited from

Omit.isMedia

Source

seyfert/src/structures/channels.ts:85

isNews()

1
isNews(): this is NewsChannel

Returns

this is NewsChannel

Inherited from

Omit.isNews

Source

seyfert/src/structures/channels.ts:117

isStage()

1
isStage(): this is StageChannel

Returns

this is StageChannel

Inherited from

Omit.isStage

Source

seyfert/src/structures/channels.ts:81

isTextGuild()

1
isTextGuild(): this is TextGuildChannel

Returns

this is TextGuildChannel

Inherited from

Omit.isTextGuild

Source

seyfert/src/structures/channels.ts:109

isTextable()

1
isTextable(): this is AllTextableChannels

Returns

this is AllTextableChannels

Inherited from

Omit.isTextable

Source

seyfert/src/structures/channels.ts:121

isThread()

1
isThread(): this is ThreadChannel

Returns

this is ThreadChannel

Inherited from

Omit.isThread

Source

seyfert/src/structures/channels.ts:97

isThreadOnly()

1
isThreadOnly(): this is MediaChannel | ForumChannel

Returns

this is MediaChannel | ForumChannel

Inherited from

Omit.isThreadOnly

Source

seyfert/src/structures/channels.ts:129

isVoice()

1
isVoice(): this is VoiceChannel

Returns

this is VoiceChannel

Inherited from

Omit.isVoice

Source

seyfert/src/structures/channels.ts:105

toString()

1
toString(): string

Returns

string

Inherited from

Omit.toString

Source

seyfert/src/structures/channels.ts:77

typing()

1
typing(): Promise<void>

Returns

Promise<void>

Inherited from

Omit.typing

Source

seyfert/src/structures/channels.ts:213