Class TextChannel

Represents a guild channel where you can chat with others.

Hierarchy (View Summary)

Constructors

constructor

Properties

archivedAt archivedBy categoryID client createdAt creatorID description editedTimestamp groupID guildID id interactions isPublic messages name parentID type visibility

Methods

archive createMessage createPermission delete deleteMessage deletePermission edit editMessage editPermission restore toJSON

Constructors

constructor

  • new TextChannel(
        data: {
            archivedAt?: string;
            archivedBy?: string;
            categoryId?: number;
            createdAt: string;
            createdBy: string;
            groupId: string;
            id: string;
            messageId?: string;
            name: string;
            parentId?: string;
            priority?: number;
            rootId?: string;
            serverId: string;
            topic?: string;
            type: ServerChannelType;
            updatedAt?: string;
            visibility?: null | "private" | "public";
        },
        client: Client,
    ): TextChannel

    Parameters

    • data: {
          archivedAt?: string;
          archivedBy?: string;
          categoryId?: number;
          createdAt: string;
          createdBy: string;
          groupId: string;
          id: string;
          messageId?: string;
          name: string;
          parentId?: string;
          priority?: number;
          rootId?: string;
          serverId: string;
          topic?: string;
          type: ServerChannelType;
          updatedAt?: string;
          visibility?: null | "private" | "public";
      }

      raw data

      • OptionalarchivedAt?: string

        Archived at Format: date-time

        Description

        The ISO 8601 timestamp that the channel was archived at, if relevant

      • OptionalarchivedBy?: string

        Archived by

        Description

        The ID of the user who archived this channel

      • OptionalcategoryId?: number

        Description

        The category that the channel exists in. Only relevant for server channels

      • createdAt: string

        Created at Format: date-time

        Description

        The ISO 8601 timestamp that the channel was created at

      • createdBy: string

        Created by

        Description

        The ID of the user who created this channel

      • groupId: string

        Group ID

        Description

        The ID of the group

      • id: string

        Channel ID Format: uuid

        Description

        The ID of the channel

      • OptionalmessageId?: string

        Message ID Format: uuid

        Description

        The ID of the message that this channel was created off of. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present

      • name: string

        Description

        The name of the channel

      • OptionalparentId?: string

        Channel ID Format: uuid

        Description

        ID of the immediate parent channel or thread in the channel hierarchy. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present

      • Optionalpriority?: number

        Priority

        Description

        The priority of the channel will determine its position relative to other categories in the group. The higher the value, the higher up it will be displayed in the UI. Returned values can be null, in which case sorting will be done by createdAt in ascending order. Due to legacy issues, sending a null value is not possible

      • OptionalrootId?: string

        Channel ID Format: uuid

        Description

        ID of the root channel or thread in the channel hierarchy. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present

      • serverId: string

        Server ID

        Description

        The ID of the server

      • Optionaltopic?: string

        Description

        The topic of the channel. Not applicable to threads

      • type: ServerChannelType

        Description

        The type of channel. This will determine what routes to use for creating content in a channel. For example, if this "chat", then one must use the routes for creating channel messages

      • OptionalupdatedAt?: string

        Updated at Format: date-time

        Description

        The ISO 8601 timestamp that the channel was updated at, if relevant

      • Optionalvisibility?: null | "private" | "public"

        Description

        What users can access the channel. Only applicable to server channels. If not present, this channel will respect normal permissions. public is accessible to everyone, even those who aren't of the server. private is only accessible to explicitly mentioned users. Currently, threads cannot be public and other channels cannot be private. Additionally, private threads can only exist with an associated messageId that is for a private message

    • client: Client

      client

    Returns TextChannel

Properties

archivedAt

archivedAt: null | Date

When the channel was last archived.

archivedBy

archivedBy: null | string

ID of the member that archived the channel (if archived)

categoryID

categoryID: null | number

ID of the category the channel is in.

client

client: Client

App's client.

createdAt

createdAt: Date

When this channel was created.

creatorID

creatorID: string

ID of the member who created this channel.

description

description: null | string

Channel description

editedTimestamp

editedTimestamp: null | Date

Timestamp at which this channel was last edited.

groupID

groupID: string

ID of the group the channel is in.

guildID

guildID: string

Guild ID

id

id: string

Item ID

interactions

interactions: typedCollection<
    string,
    CommandInteractionData,
    CommandInteraction<TextChannel>,
    [params?: InteractionConstructorParams],
>

Cached interactions.

isPublic

isPublic: boolean

If the channel is public, this boolean is set to true.

messages

messages: typedCollection<
    string,
    {
        channelId: string;
        content?: string;
        createdAt: string;
        createdBy: string;
        createdByWebhookId?: string;
        embeds?: {
            author?: { icon_url?: string; name?: string; url?: string };
            color?: number;
            description?: string;
            fields?: { inline: boolean; name: string; value: string }[];
            footer?: { icon_url?: string; text: string };
            image?: { url?: string };
            thumbnail?: { url?: string };
            timestamp?: string;
            title?: string;
            url?: string;
        }[];
        groupId?: string;
        hiddenLinkPreviewUrls?: string[];
        id: string;
        isPinned: boolean;
        isPrivate?: boolean;
        isSilent: boolean;
        mentions?: {
            channels?: { id: string }[];
            everyone?: boolean;
            here?: boolean;
            roles?: { id: number }[];
            users?: { id: string }[];
        };
        replyMessageIds?: string[];
        serverId?: string;
        type: ChatMessageType;
        updatedAt?: string;
    },
    Message<TextChannel>,
    [params?: MessageConstructorParams],
>

Cached messages.

name

name: string

Channel name

parentID

parentID: null | string

ID of the parent category.

type

type: string

Channel type

visibility

visibility: string

Channel visibility

Methods

archive

createMessage

createPermission

  • createPermission(
        targetID: string | number,
        options: { permissions: Record<string, never> },
    ): Promise<Permission>

    Create Channel Role Permissions

    Parameters

    • targetID: string | number

      ID of the target object (role or user) to assign the permission to.

    • options: { permissions: Record<string, never> }

      Create options.

      Warning: targetID must have the correct type (number=role, string=user).

      • permissions: Record<string, never>

        Description

        A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type

    Returns Promise<Permission>

delete

deleteMessage

  • deleteMessage(messageID: string): Promise<void>

    Delete a message from this channel.

    Parameters

    • messageID: string

      ID of the message to delete.

    Returns Promise<void>

deletePermission

  • deletePermission(targetID: string | number): Promise<void>

    Delete an existing permission set on this channel.

    Parameters

    • targetID: string | number

      ID of the target object (role or user) the permission is assigned to.

      Warning: targetID must have the correct type (number=role, string=user).

    Returns Promise<void>

edit

editMessage

editPermission

  • editPermission(
        targetID: string | number,
        options: { permissions: Record<string, never> },
    ): Promise<Permission>

    Edit a channel permission.

    Parameters

    • targetID: string | number

      ID of the target object (role or user) the permission is assigned to.

    • options: { permissions: Record<string, never> }

      Edit options

      Warning: targetID must have the correct type (number=role, string=user).

      • permissions: Record<string, never>

        Description

        A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type

    Returns Promise<Permission>

restore

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Methods