-
Notifications
You must be signed in to change notification settings - Fork 144
GroupChannel
extends TextChannel
Represents a Discord group channel. Essentially a private channel that may have more than one and up to ten recipients. This class should only be relevant to user-accounts; bots cannot normally join group channels.
Instances of this class should not be constructed by users.
Properties Inherited From TextChannel
| Name | Type | Description |
|---|---|---|
| client | Client | A shortcut to the client object to which this container is visible. |
| createdAt | number | 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. Equivalent to Date.parseSnowflake(Snowflake.id). |
| id | string | 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. |
| mentionString | string | A string that, when included in a message content, may resolve as a link to a channel in the official Discord client. |
| messages | WeakCache | 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. |
| parent | Container/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. |
| timestamp | string | 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 | number | The channel type. See the channelType enumeration for a human-readable representation. |
| Name | Type | Description |
|---|---|---|
| icon | string/nil | The hash for the channel's custom icon, if one is set. |
| iconURL | string/nil | The URL that can be used to view the channel's icon, if one is set. |
| name | string | The name of the channel. |
| owner | User/nil | Equivalent to GroupChannel.recipients:get(GroupChannel.ownerId). |
| ownerId | string | The Snowflake ID of the user that owns (created) the channel. |
| recipients | SecondaryCache | A secondary cache of users that are present in the channel. |
Methods Inherited From TextChannel
Defines the behavior of the == operator. Allows containers to be directly compared according to their type and __hash return values.
Returns: boolean
Returns Snowflake.id
Returns: string
Defines the behavior of the tostring function. All containers follow the format ClassName: hash.
Returns: string
Indicates in the channel that the client's user "is typing".
This method always makes an HTTP request.
Returns: boolean
Returns a unique Date object that represents when the object was created by Discord. Equivalent to Date.fromSnowflake(Snowflake.id)
This method only operates on data in memory.
Returns: Date
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.
This method always makes an HTTP request.
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.
This method always makes an HTTP request.
Returns: Message
| Parameter | Type |
|---|---|
| id | Message-ID-Resolvable |
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.
This method may make an HTTP request.
Returns: Message
| Parameter | Type | Optional |
|---|---|---|
| limit | number | ✔ |
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.
This method always makes an HTTP request.
Returns: SecondaryCache
| Parameter | Type | Optional |
|---|---|---|
| id | Message-ID-Resolvable | |
| limit | number | ✔ |
Returns a newly constructed cache of between 1 and 100 (default = 50) message objects found in the channel after a specific id. While the cache will never automatically gain or lose objects, the objects that it contains may be updated by gateway events.
This method always makes an HTTP request.
Returns: SecondaryCache
| Parameter | Type | Optional |
|---|---|---|
| id | Message-ID-Resolvable | |
| limit | number | ✔ |
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.
This method always makes an HTTP request.
Returns: SecondaryCache
| Parameter | Type | Optional |
|---|---|---|
| id | Message-ID-Resolvable | |
| limit | number | ✔ |
Returns a newly constructed cache of between 1 and 100 (default = 50) message objects found in the channel before a specific id. While the cache will never automatically gain or lose objects, the objects that it contains may be updated by gateway events.
This method always makes an HTTP request.
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.
This method always makes an HTTP request.
Returns: SecondaryCache
| Parameter | Type |
|---|---|
| content | string/table |
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.
This method always makes an HTTP request.
Returns: Message
| Parameter | Type |
|---|---|
| content | string |
| ... | * |
Sends a message to the channel with content formatted with ... via string.format
This method always makes an HTTP request.
Returns: Message
| Parameter | Type |
|---|---|
| id | User-ID-Resolvable |
Adds a user to the channel.
This method always makes an HTTP request.
Returns: boolean
Removes the client's user from the channel. If no users remain, the channel is destroyed.
This method always makes an HTTP request.
Returns: boolean
| Parameter | Type |
|---|---|
| id | User-ID-Resolvable |
Removes a user from the channel.
This method always makes an HTTP request.
Returns: boolean
| Parameter | Type |
|---|---|
| icon | Base64-Resolvable |
Sets the channel's icon. To remove the icon, pass nil.
This method always makes an HTTP request.
Returns: boolean
| Parameter | Type |
|---|---|
| name | string |
Sets the channel's name. This must be between 1 and 100 characters in length.
This method always makes an HTTP request.
Returns: boolean