TextChannel - truemedian/Discordia GitHub Wiki

Inherits Channel

Abstract base class that defines the base methods and/or properties for all Discord text channels.

Methods

getMessage
getFirstMessage
getLastMessage
getMessages
getMessagesAfter
getMessagesBefore
getMessagesAround
getPinnedMessages
broadcastTyping
send
sendf

Properties

messages

Inherited from Container
client
parent

Inherited from Snowflake
id
createdAt
timestamp

Inherited from Channel
type
mentionString

Methods

:getMessage( id )

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

:getFirstMessage( )

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

:getLastMessage( )

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

:getMessages( [ limit ] )

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

:getMessagesAfter( id, [ limit ] )

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

:getMessagesBefore( id, [ limit ] )

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

:getMessagesAround( id, [ limit ] )

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

:getPinnedMessages( )

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

:broadcastTyping( )

Indicates in the channel that the client's user "is typing".

Returns: boolean

:send( content )

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

:sendf( content, ... )

Sends a message to the channel with content being formatted with ... via string.format

Name Type
content string
... *

Returns: Message

Properties

.messages

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

.client

A shortcut to the client object to which this container is visible.

Type: Client

.parent

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

.id

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

.createdAt

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

.timestamp

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

.type

The channel type. See the channelType enumeration for a human-readable representation.

Type: number

.mentionString

A string that, when included in a message content, may resolve as a link to a channel in the official Discord client.

Type: string

⚠️ **GitHub.com Fallback** ⚠️