class PartialGroupDMChannel
extends
BaseChannelexport class PartialGroupDMChannel extends BaseChannelRepresents a Partial Group DM Channel on Discord.
appPermissions : Readonly<PermissionsBitField> | null
The computed permissions of the application in this channel, including overwrites. This is only present on channels received through an interaction's resolved data, and only when the application's bot user is in the guild.
Inherited from: BaseChannel
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.
readonlyoptionallastMessage? : Message
The Message object of the last message in the channel, if one was sent
optionallastMessageId? : Snowflake
The channel's last message id, if one was sent
readonlyoptionallastPinAt? : Date
The date when the last pinned message was pinned, if there was one
optionallastPinTimestamp? : 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
Whether this Channel is a partial This is always false outside of DM channels.
Inherited from: BaseChannel
permissions : Readonly<PermissionsBitField> | null
The computed permissions of the user who invoked the interaction in this channel, including overwrites. This is only present on channels received through an interaction's resolved data.
Inherited from: BaseChannel
recipients : PartialRecipient[]
The recipients of this Group DM Channel.
type : ChannelType.GroupDM
The type of the channel
awaitMessageComponent(options?: AwaitMessageComponentOptions = {}) : Promise<MessageComponentInteraction>
Collects a single component interaction that passes the filter. The Promise will reject if the time expires.
// 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.
// 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.
// Delete the channel
channel.delete()
.then(console.log)
.catch(console.error);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 DMChannel | PartialDMChannel | PartialGroupDMChannel
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
toString() : ChannelMention
When concatenated with a string, this automatically returns the channel's mention instead of the Channel object.
// Logs: Hello from <#123456789012345678>!
console.log(`Hello from ${channel}!`);