Class TextChannel

Represents a guild channel where you can chat with others.

Hierarchy (view full)

GuildChannel
- TextChannel

Constructors

constructor

new TextChannel(data, 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
Overrides GuildChannel.constructor
- Defined in lib/structures/TextChannel.ts:43

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.

Type declaration

channelId: string
Channel ID Format: uuid

Description
The ID of the channel
Optionalcontent?: string
Content Format: chat markdown

Description
The content of the message
createdAt: string
Created at Format: date-time

Description
The ISO 8601 timestamp that the message was created at
createdBy: string
Created by

Description
The ID of the user who created this message (Note: If this event has createdByWebhookId present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
OptionalcreatedByWebhookId?: string
Created by Webhook ID

Description
The ID of the webhook who created this message, if it was created by a webhook
Optionalembeds?: {
    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;
}[]
OptionalgroupId?: string
Group ID

Description
The ID of the group
OptionalhiddenLinkPreviewUrls?: string[]
Hidden content link preview URLs

Description
Links in content to prevent unfurling as a link preview when displaying in Guilded
id: string
Message ID Format: uuid

Description
The ID of the message
isPinned: boolean
Is pinned
Default
```
false
```
OptionalisPrivate?: boolean
Is private

Description
If set, this message will only be seen by those mentioned or replied to
isSilent: boolean
Is silent
Description
If set, this message did not notify mention or reply recipients

Default
```
false
```
Optionalmentions?: {
    channels?: {
        id: string;
    }[];
    everyone?: boolean;
    here?: boolean;
    roles?: {
        id: number;
    }[];
    users?: {
        id: string;
    }[];
}
- Optionalchannels?: {
  id: string;
  }[]
  Channels
  
  Description
  Info on mentioned channels
- Optionaleveryone?: boolean
  Everyone
  
  Description
  If
  
  Everyone
  was mentioned
- Optionalhere?: boolean
  Here
  
  Description
  If
  
  Here
  was mentioned
- Optionalroles?: {
  id: number;
  }[]
  Roles
  
  Description
  Info on mentioned roles
- Optionalusers?: {
  id: string;
  }[]
  Users
  
  Description
  Info on mentioned users
OptionalreplyMessageIds?: string[]
Description
Message IDs that were replied to
OptionalserverId?: string
Server ID

Description
The ID of the server
type: ChatMessageType
Type

Description
The type of chat message. "system" messages are generated by Guilded, while "default" messages are user or bot-generated.
OptionalupdatedAt?: string
Updated at Format: date-time

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

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

createMessage

createMessage(options): Promise<Message<TextChannel>>
Create a message in this channel.
Parameters
- options: CreateMessageOptions
  Message options.
Returns Promise<Message<TextChannel>>
- Defined in lib/structures/TextChannel.ts:61

createPermission

createPermission(targetID, options): 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>
- Defined in lib/structures/TextChannel.ts:71

delete

delete(): Promise<void>
Delete the channel.

Returns Promise<void>
Inherited from GuildChannel.delete
- Defined in lib/structures/GuildChannel.ts:135

deleteMessage

deleteMessage(messageID): Promise<void>
Delete a message from this channel.
Parameters
- messageID: string
  ID of the message to delete.
Returns Promise<void>
- Defined in lib/structures/TextChannel.ts:86

deletePermission

deletePermission(targetID): 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>
- Defined in lib/structures/TextChannel.ts:96

edit

edit(options): Promise<Channel>
Edit the channel.
Parameters
- options: EditChannelOptions
Returns Promise<Channel>
Inherited from GuildChannel.edit
- Defined in lib/structures/GuildChannel.ts:139

editMessage

editMessage(messageID, options): Promise<Message<TextChannel>>
Edit a message from this channel.
Parameters
- messageID: string
  ID of the message to edit.
- options: EditMessageOptions
  Message options.
Returns Promise<Message<TextChannel>>
- Defined in lib/structures/TextChannel.ts:108

editPermission

editPermission(targetID, options): 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>
- Defined in lib/structures/TextChannel.ts:126

restore

restore(): Promise<void>
Restore the archived channel

Returns Promise<void>
Inherited from GuildChannel.restore
- Defined in lib/structures/GuildChannel.ts:143

toJSON

toJSON(): JSONTextChannel
Returns JSONTextChannel
Overrides GuildChannel.toJSON
- Defined in lib/structures/TextChannel.ts:138

Class TextChannel

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalarchivedAt?: string

Description

OptionalarchivedBy?: string

Description

OptionalcategoryId?: number

Description

createdAt: string

Description

createdBy: string

Description

groupId: string

Description

id: string

Description

OptionalmessageId?: string

Description

name: string

Description

OptionalparentId?: string

Description

Optionalpriority?: number

Description

OptionalrootId?: string

Description

serverId: string

Description

Optionaltopic?: string

Description

type: ServerChannelType

Description

OptionalupdatedAt?: string

Description

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

Description

Returns TextChannel

Properties

archivedAt

archivedBy

categoryID

client

createdAt

creatorID

description

editedTimestamp

groupID

guildID

id

interactions

isPublic

messages

Type declaration

channelId: string

Description

Optionalcontent?: string

Description

createdAt: string

Description

createdBy: string

Description

OptionalcreatedByWebhookId?: string

Description

OptionalgroupId?: string

Description

OptionalhiddenLinkPreviewUrls?: string[]

Description

id: string

Description

isPinned: boolean

Default

OptionalisPrivate?: boolean

Description

`Optional`archivedAt?: string

`Optional`archivedBy?: string

`Optional`categoryId?: number

`Optional`messageId?: string

`Optional`parentId?: string

`Optional`priority?: number

`Optional`rootId?: string

`Optional`topic?: string

`Optional`updatedAt?: string

`Optional`visibility?: null | "private" | "public"

`Optional`content?: string

`Optional`createdByWebhookId?: string

`Optional`groupId?: string

`Optional`hiddenLinkPreviewUrls?: string[]

`Optional`isPrivate?: boolean

`Optional`mentions?: {
channels?: {
id: string;
}[];
everyone?: boolean;
here?: boolean;
roles?: {
id: number;
}[];
users?: {
id: string;
}[];
}

`Optional`channels?: {
id: string;
}[]

`Optional`everyone?: boolean

`Optional`here?: boolean

`Optional`roles?: {
id: number;
}[]

`Optional`users?: {
id: string;
}[]

`Optional`replyMessageIds?: string[]

`Optional`serverId?: string

`Optional`updatedAt?: string