class PartialGroupDMChannel

extends

BaseChannel
export class PartialGroupDMChannel extends BaseChannel

Represents a Partial Group DM Channel on Discord.

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

readonly
createdAt : Date | null

The time the channel was created at

Inherited from: BaseChannel

readonly
createdTimestamp : number | null

The timestamp the channel was created at

Inherited from: BaseChannel

flags : null

The flags that are applied to the channel. This is only null in a PartialGroupDMChannel. In all other cases, it is not null.

icon : string | null

The hash of the channel icon

id : Snowflake

The channel's id

Inherited from: BaseChannel

readonlyoptional
lastMessage? : Message

The Message object of the last message in the channel, if one was sent

optional
lastMessageId? : Snowflake

The channel's last message id, if one was sent

readonlyoptional
lastPinAt? : Date

The date when the last pinned message was pinned, if there was one

optional
lastPinTimestamp? : number

The timestamp when the last pinned message was pinned, if there was one

messages : PartialGroupDMMessageManager

A manager of the messages belonging to this channel

name : string | null

The name of this Group DM Channel

ownerId : Snowflake | null

The user id of the owner of this Group DM Channel

readonly
partial : false

Whether this Channel is a partial This is always false outside of DM channels.

Inherited from: BaseChannel

recipients : PartialRecipient[]

The recipients of this Group DM Channel.

type : ChannelType.GroupDM

The type of the channel

readonly
url : string

The URL to the channel

Inherited from: BaseChannel

awaitMessageComponent(
options?: AwaitMessageComponentOptions = {}
) : Promise<MessageComponentInteraction>

Collects a single component interaction that passes the filter. The Promise will reject if the time expires.

Examples:
// Collect a message component interaction
const filter = (interaction) => interaction.customId === 'button' && interaction.user.id === 'someId';
channel.awaitMessageComponent({ filter, time: 15_000 })
  .then(interaction => console.log(`${interaction.customId} was clicked!`))
  .catch(console.error);

createMessageComponentCollector(
options?: MessageComponentCollectorOptions = {}
) : InteractionCollector

Creates a component interaction collector.

Examples:
// Create a button interaction collector
const filter = (interaction) => interaction.customId === 'button' && interaction.user.id === 'someId';
const collector = channel.createMessageComponentCollector({ filter, time: 15_000 });
collector.on('collect', interaction => console.log(`Collected ${interaction.customId}`));
collector.on('end', collected => console.log(`Collected ${collected.size} items`));

delete() : Promise<this>

Deletes this channel.

Examples:
// Delete the channel
channel.delete()
  .then(console.log)
  .catch(console.error);

Inherited from: BaseChannel

fetch(
force?: boolean = true
) : Promise<this>

Fetches this channel.

Inherited from: BaseChannel

fetchOwner(
options?: BaseFetchOptions
) : Promise<User>

Fetches the owner of this Group DM Channel.

iconURL(
options?: ImageURLOptions = {}
) : string | null

The URL to this channel's icon.

isDMBased() : this is PartialGroupDMChannel | DMChannel | PartialDMChannel

Indicates whether this channel is DM-based (either a DMChannel or a PartialGroupDMChannel).

Inherited from: BaseChannel

isSendable() : this is SendableChannels

Indicates whether this channel is sendable.

Inherited from: BaseChannel

isTextBased() : this is TextBasedChannel

Indicates whether this channel is text-based.

Inherited from: BaseChannel

isThread() : this is AnyThreadChannel

Indicates whether this channel is a ThreadChannel.

Inherited from: BaseChannel

isThreadOnly() : this is ThreadOnlyChannel

Indicates whether this channel is thread-only.

Inherited from: BaseChannel

isVoiceBased() : this is VoiceBasedChannel

Indicates whether this channel is voice-based.

Inherited from: BaseChannel

toJSON(
...props: Record<string, boolean | string>[]
) : unknown

Inherited from: Base

toString() : ChannelMention

When concatenated with a string, this automatically returns the channel's mention instead of the Channel object.

Examples:
// Logs: Hello from <#123456789012345678>!
console.log(`Hello from ${channel}!`);

valueOf() : string

Inherited from: Base