TextChannel - truemedian/Discordia GitHub Wiki
Inherits Channel
Abstract base class that defines the base methods and/or properties for all Discord text channels.
getMessage
getFirstMessage
getLastMessage
getMessages
getMessagesAfter
getMessagesBefore
getMessagesAround
getPinnedMessages
broadcastTyping
send
sendf
Inherited from Container
client
parentInherited from Snowflake
id
createdAt
timestampInherited from Channel
type
mentionString
Gets a message object by ID. If the object is already cached, then the cached object will be returned; otherwise, an HTTP request is made.
Name Type id Message ID Resolvable Returns: Message
Returns the first message found in the channel, if any exist. This is not a cache shortcut; an HTTP request is made each time this method is called.
Returns: Message
Returns the last message found in the channel, if any exist. This is not a cache shortcut; an HTTP request is made each time this method is called.
Returns: Message
Returns a newly constructed cache of between 1 and 100 (default = 50) message objects found in the channel. While the cache will never automatically gain or lose objects, the objects that it contains may be updated by gateway events.
Name Type Optional limit number x Returns: SecondaryCache
Returns a newly constructed cache of between 1 and 100 (default = 50) message objects found in the channel after a specific point. While the cache will never automatically gain or lose objects, the objects that it contains may be updated by gateway events.
Name Type Optional id Message ID Resolvable limit number x Returns: SecondaryCache
Returns a newly constructed cache of between 1 and 100 (default = 50) message objects found in the channel before a specific point. While the cache will never automatically gain or lose objects, the objects that it contains may be updated by gateway events.
Name Type Optional id Message ID Resolvable limit number x Returns: SecondaryCache
Returns a newly constructed cache of between 1 and 100 (default = 50) message objects found in the channel around a specific point. While the cache will never automatically gain or lose objects, the objects that it contains may be updated by gateway events.
Name Type Optional id Message ID Resolvable limit number x Returns: SecondaryCache
Returns a newly constructed cache of up to 50 messages that are pinned in the channel. While the cache will never automatically gain or lose objects, the objects that it contains may be updated by gateway events.
Returns: SecondaryCache
Indicates in the channel that the client's user "is typing".
Returns: boolean
Sends a message to the channel. If
content
is a string, then this is simply sent as the message content. If it is a table, more advanced formatting is allowed. See managing messages for more information.
Name Type content string Returns: Message
Sends a message to the channel with content being formatted with
...
viastring.format
Name Type content string ... * Returns: Message
An iterable weak cache of all messages that are visible to the client. Messages that are not referenced elsewhere are eventually garbage collected. To access a message that may exist but is not cached, use
TextChannel:getMessage
.Type: WeakCache
Inherited from Container
A shortcut to the client object to which this container is visible.
Type: Client
The parent object of to which this container is a child. For example, the parent of a role is the guild in which the role exists.
Type: Container|Client
Inherited from Snowflake
The Snowflake ID that can be used to identify the object. This is guaranteed to be unique except in cases where an object shares the ID of its parent.
Type: string
The Unix time in seconds at which this object was created by Discord. Additional decimal points may be present, though only the first 3 (milliseconds) should be considered accurate.
Type: number
The date and time at which this object was created by Discord, represented as an ISO 8601 string plus microseconds when available.
Equivalent to Date.fromSnowflake(Snowflake.id):toISO()
.
Type: string
Inherited from Channel
The channel type. See the
channelType
enumeration for a human-readable representation.Type: number
A string that, when included in a message content, may resolve as a link to a channel in the official Discord client.
Type: string