DMChannel
channelOn this page
DMChannel is a DiscordLua channel representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.
- DMChannel
- Channel
Inherited properties (45)
appliedTags · inherited from Channelarchived · inherited from ChannelarchiveTimestamp · inherited from ChannelautoArchiveDuration · inherited from ChannelavailableTags · inherited from Channelbitrate · inherited from Channelchildren · inherited from Channelclient · inherited from ChanneldefaultAutoArchiveDuration · inherited from ChanneldefaultForumLayout · inherited from ChanneldefaultReactionEmoji · inherited from ChanneldefaultSortOrder · inherited from ChanneldefaultThreadRateLimitPerUser · inherited from Channelflags · inherited from ChannelguildId · inherited from Channelicon · inherited from Channelid · inherited from Channelinvitable · inherited from Channelinvites · inherited from ChannellastMessageId · inherited from ChannellastPinTimestamp · inherited from Channellocked · inherited from ChannelmemberCount · inherited from Channelmembers · inherited from ChannelmessageCount · inherited from Channelmessages · inherited from Channelname · inherited from Channelnsfw · inherited from ChannelownerId · inherited from ChannelparentId · inherited from ChannelpermissionOverwrites · inherited from Channelposition · inherited from ChannelrateLimitPerUser · inherited from Channelraw · inherited from Channelrecipient · inherited from ChannelrecipientId · inherited from ChannelrecipientIds · inherited from Channelrecipients · inherited from ChannelrtcRegion · inherited from Channelthreads · inherited from Channeltopic · inherited from ChanneltotalMessageSent · inherited from Channeltype · inherited from ChanneluserLimit · inherited from ChannelvideoQualityMode · inherited from ChannelMethods
DMChannel:createMessageComponentCollector()
#Create MessageComponentCollector through REST and cache the result when the request succeeds. Pass function(err, result) to handle failures without raising.
Signature
DMChannel:createMessageComponentCollector(options) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
options |
table |
optional | Lua option table. Field names match the corresponding DiscordLua option type when one exists. |
Returns
DMChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a DMChannel
object:createMessageComponentCollector({})DMChannel:fetchOwner()
#Fetch Owner from REST and update the local cache when the request succeeds.
Signature
DMChannel:fetchOwner(callback) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
callback |
function |
optional | Optional completion callback function(err, result). If omitted, failures raise a DiscordLua error. |
Returns
DMChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a DMChannel
object:fetchOwner(function(err, result)
if err then error(err) end
end)DMChannel:partial()
#Performs partial on this DMChannel. Call it from bot code when you need that operation on the current object.
Signature
DMChannel:partial() Parameters
No parameters.
Returns
DMChannel — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a DMChannel
object:partial()Inherited methods (51)
Channel:addFollowerChannel:awaitMessageComponentChannel:awaitMessagesChannel:bulkDeleteChannel:cloneChannel:createdAtChannel:createdTimestampChannel:createInteractionCollectorChannel:createInviteChannel:createMessageCollectorChannel:createWebhookChannel:deletableChannel:deleteChannel:editChannel:equalsChannel:fetchChannel:fetchInvitesChannel:fetchMessagesChannel:fetchWebhooksChannel:guildChannel:iconURLChannel:isDMBasedChannel:isSendableChannel:isTextBasedChannel:isThreadChannel:isThreadOnlyChannel:isVoiceBasedChannel:lastMessageChannel:lastPinAtChannel:lockPermissionsChannel:manageableChannel:parentChannel:permissionsForChannel:permissionsLockedChannel:rawPositionChannel:sendChannel:sendTypingChannel:setDefaultAutoArchiveDurationChannel:setNameChannel:setNSFWChannel:setParentChannel:setPositionChannel:setRateLimitPerUserChannel:setSlowmodeChannel:setTopicChannel:setTypeChannel:startTypingChannel:toJSONChannel:toStringChannel:urlChannel:viewableExamples
Obtain this object from a manager, wrap helper, or event payload — it is not constructed directly in typical bot code.
Related APIs
BaseGuildTextChannel · BaseGuildVoiceChannel · CategoryChannel · Channel · DirectoryChannel · ForumChannel · GuildChannel · MediaChannel
Version: discord 1.2.4 · runtime 1.0.0