Class Channel

Channel Class

Constructors

constructor

new Channel(collection: ChannelCollection, id: string): Channel
Construct Channel
Parameters
- collection: ChannelCollection
  Collection
- id: string
  Channel Id
Returns Channel
- Defined in src/classes/Channel.ts:45

Properties

`Readonly`id

id: string

Accessors

$exists

get $exists(): boolean
Whether this object exists

Returns boolean
- Defined in src/classes/Channel.ts:61

active

get active(): boolean
Whether the conversation is active

Returns boolean
- Defined in src/classes/Channel.ts:132

animatedIconURL

get animatedIconURL(): undefined | string
URL to the animated channel icon

Returns undefined | string
- Defined in src/classes/Channel.ts:326

createdAt

get createdAt(): Date
Time when this server was created

Returns Date
- Defined in src/classes/Channel.ts:68

defaultPermissions

get defaultPermissions(): undefined | { a: number; d: number }
Default permissions for this server channel

Returns undefined | { a: number; d: number }
- Defined in src/classes/Channel.ts:237

description

get description(): undefined | string
Channel description

Returns undefined | string
- Defined in src/classes/Channel.ts:118

displayName

get displayName(): undefined | string
Display name

Returns undefined | string
- Defined in src/classes/Channel.ts:107

icon

get icon(): undefined | File
Channel icon

Returns undefined | File
- Defined in src/classes/Channel.ts:125

iconURL

get iconURL(): undefined | string
URL to the channel icon

Returns undefined | string
- Defined in src/classes/Channel.ts:319

lastMessage

get lastMessage(): undefined | Message
Last message sent in this channel

Returns undefined | Message
- Defined in src/classes/Channel.ts:265

lastMessageAt

get lastMessageAt(): undefined | Date
Time when the last message was sent

Returns undefined | Date
- Defined in src/classes/Channel.ts:272

lastMessageId

get lastMessageId(): undefined | string
ID of the last message sent in this channel

Returns undefined | string
- Defined in src/classes/Channel.ts:258

mature

get mature(): boolean
Whether this channel is marked as mature

Returns boolean
- Defined in src/classes/Channel.ts:251

mentions

get mentions(): undefined | ReactiveSet<string>
Get mentions in this channel for user.

Returns undefined | ReactiveSet<string>
- Defined in src/classes/Channel.ts:308

name

get name(): string
Channel name

Returns string
- Defined in src/classes/Channel.ts:100

owner

get owner(): undefined | User
Owner of the group

Returns undefined | User
- Defined in src/classes/Channel.ts:205

ownerId

get ownerId(): string
Owner ID

Returns string
- Defined in src/classes/Channel.ts:198

path

get path(): string
Absolute pathname to this channel in the client

Returns string
- Defined in src/classes/Channel.ts:82

permission

get permission(): number
Permission the currently authenticated user has against this channel

Returns number
- Defined in src/classes/Channel.ts:355

permissions

get permissions(): undefined | number
Permissions allowed for users in this group

Returns undefined | number
- Defined in src/classes/Channel.ts:230

potentiallyRestrictedChannel

get potentiallyRestrictedChannel(): undefined | string | boolean
Whether this channel may be hidden to some users

Returns undefined | string | boolean
- Defined in src/classes/Channel.ts:333

recipient

get recipient(): undefined | User
Find recipient of this DM

Returns undefined | User
- Defined in src/classes/Channel.ts:171

recipientIds

get recipientIds(): ReactiveSet<string>
User ids of recipients of the group

Returns ReactiveSet<string>
- Defined in src/classes/Channel.ts:155

recipients

get recipients(): User[]
Recipients of the group

Returns User[]
- Defined in src/classes/Channel.ts:162

rolePermissions

get rolePermissions(): undefined | Record<string, { a: number; d: number }>
Role permissions for this server channel

Returns undefined | Record<string, { a: number; d: number }>
- Defined in src/classes/Channel.ts:244

server

get server(): undefined | Server
Server this channel is in

Returns undefined | Server
- Defined in src/classes/Channel.ts:221

serverId

get serverId(): string
Server ID

Returns string
- Defined in src/classes/Channel.ts:214

type

get type(): | "SavedMessages"
| "DirectMessage"
| "Group"
| "TextChannel"
| "VoiceChannel"
Channel type

Returns "SavedMessages" | "DirectMessage" | "Group" | "TextChannel" | "VoiceChannel"
- Defined in src/classes/Channel.ts:75

typing

get typing(): User[]
Users currently trying in channel

Returns User[]
- Defined in src/classes/Channel.ts:146

typingIds

get typingIds(): ReactiveSet<string>
User ids of people currently typing in channel

Returns ReactiveSet<string>
- Defined in src/classes/Channel.ts:139

unread

get unread(): boolean
Get whether this channel is unread.

Returns boolean
- Defined in src/classes/Channel.ts:288

updatedAt

get updatedAt(): Date
Time when the channel was last updated (either created or a message was sent)

Returns Date
- Defined in src/classes/Channel.ts:281

url

get url(): string
URL to this channel

Returns string
- Defined in src/classes/Channel.ts:93

user

get user(): undefined | User
User this channel belongs to

Returns undefined | User
- Defined in src/classes/Channel.ts:189

userId

get userId(): string
User ID

Returns string
- Defined in src/classes/Channel.ts:182

Methods

ack

ack(
    message?: string | Message,
    skipRateLimiter?: boolean,
    skipRequest?: boolean,
    skipNextMarking?: boolean,
): Promise<void>
Mark a channel as read
Parameters
- Optionalmessage: string | Message
  Last read message or its ID
- OptionalskipRateLimiter: boolean
  Whether to skip the internal rate limiter
- OptionalskipRequest: boolean
  For internal updates only
- OptionalskipNextMarking: boolean
  For internal usage only
Returns Promise<void>
Requires
SavedMessages, DirectMessage, Group, TextChannel
- Defined in src/classes/Channel.ts:682

addMember

addMember(user_id: string): Promise<void>
Add a user to a group
Parameters
- user_id: string
  ID of the target user
Returns Promise<void>
Requires
Group
- Defined in src/classes/Channel.ts:460

createInvite

createInvite(): Promise<
    | {
        _id: string;
        channel: string;
        creator: string;
        server: string;
        type: "Server";
    }
    | { _id: string; channel: string; creator: string; type: "Group" },
>
Create an invite to the channel

Returns Promise<
    | {
        _id: string;
        channel: string;
        creator: string;
        server: string;
        type: "Server";
    }
    | { _id: string; channel: string; creator: string; type: "Group" },
>
Newly created invite code

Requires
TextChannel, VoiceChannel
- Defined in src/classes/Channel.ts:664

delete

delete(leaveSilently?: boolean): Promise<void>
Delete or leave a channel
Parameters
- OptionalleaveSilently: boolean
  Whether to not send a message on leave
Returns Promise<void>
Requires
DirectMessage, Group, TextChannel, VoiceChannel
- Defined in src/classes/Channel.ts:442

deleteMessages

deleteMessages(ids: string[]): Promise<void>
Delete many messages by their IDs
Parameters
- ids: string[]
  List of message IDs
Returns Promise<void>
Requires
SavedMessages, DirectMessage, Group, TextChannel
- Defined in src/classes/Channel.ts:650

edit

edit(
    data: {
        archived?: null | boolean;
        description?: null | string;
        icon?: null | string;
        name?: null | string;
        nsfw?: null | boolean;
        owner?: null | string;
        remove?: null | ("Description" | "Icon" | "DefaultPermissions")[];
    },
): Promise<void>
Edit a channel
Parameters
- data: {
      archived?: null | boolean;
      description?: null | string;
      icon?: null | string;
      name?: null | string;
      nsfw?: null | boolean;
      owner?: null | string;
      remove?: null | ("Description" | "Icon" | "DefaultPermissions")[];
  }
  Changes
  - Optionalarchived?: null | boolean
    Description
    Whether this channel is archived
  - Optionaldescription?: null | string
    Description
    Channel description
  - Optionalicon?: null | string
    Description
    Icon
    
    Provide an Autumn attachment Id.
  - Optionalname?: null | string
    Description
    Channel name
  - Optionalnsfw?: null | boolean
    Description
    Whether this channel is age-restricted
  - Optionalowner?: null | string
    Description
    Group owner
  - Optionalremove?: null | ("Description" | "Icon" | "DefaultPermissions")[]
    Description
    Fields to remove from channel
Returns Promise<void>
- Defined in src/classes/Channel.ts:425

fetchMembers

fetchMembers(): Promise<User[]>
Fetch a channel's members.

Returns Promise<User[]>
An array of the channel's members.

Requires
Group
- Defined in src/classes/Channel.ts:389

fetchMessage

fetchMessage(messageId: string): Promise<Message>
Fetch a message by its ID
Parameters
- messageId: string
  ID of the target message
Returns Promise<Message>
Message

Requires
SavedMessages, DirectMessage, Group, TextChannel
- Defined in src/classes/Channel.ts:520

fetchMessages

fetchMessages(
    params?: Omit<
        | undefined
        | {
            after?: null
            | string;
            before?: null | string;
            include_users?: null | boolean;
            limit?: null | number;
            nearby?: null | string;
            sort?: null | "Relevance" | "Latest" | "Oldest";
        },
        "include_users",
    >,
): Promise<Message[]>
Fetch multiple messages from a channel
Parameters
- Optionalparams: Omit<
      | undefined
      | {
          after?: null
          | string;
          before?: null | string;
          include_users?: null | boolean;
          limit?: null | number;
          nearby?: null | string;
          sort?: null | "Relevance" | "Latest" | "Oldest";
      },
      "include_users",
  >
  Message fetching route data
Returns Promise<Message[]>
Messages

Requires
SavedMessages, DirectMessage, Group, TextChannel
- Defined in src/classes/Channel.ts:534

fetchMessagesWithUsers

fetchMessagesWithUsers(
    params?: Omit<
        | undefined
        | {
            after?: null
            | string;
            before?: null | string;
            include_users?: null | boolean;
            limit?: null | number;
            nearby?: null | string;
            sort?: null | "Relevance" | "Latest" | "Oldest";
        },
        "include_users",
    >,
): Promise<
    {
        members: undefined
        | ServerMember[];
        messages: Message[];
        users: User[];
    },
>
Fetch multiple messages from a channel including the users that sent them
Parameters
- Optionalparams: Omit<
      | undefined
      | {
          after?: null
          | string;
          before?: null | string;
          include_users?: null | boolean;
          limit?: null | number;
          nearby?: null | string;
          sort?: null | "Relevance" | "Latest" | "Oldest";
      },
      "include_users",
  >
  Message fetching route data
Returns Promise<
    {
        members: undefined
        | ServerMember[];
        messages: Message[];
        users: User[];
    },
>
Object including messages and users

Requires
SavedMessages, DirectMessage, Group, TextChannel
- Defined in src/classes/Channel.ts:559

fetchWebhooks

fetchWebhooks(): Promise<ChannelWebhook[]>
Fetch a channel's webhooks

Returns Promise<ChannelWebhook[]>
Webhooks

Requires
TextChannel, Group
- Defined in src/classes/Channel.ts:406

havePermission

havePermission(
    ...permission: (
        | "Video"
        | "Masquerade"
        | "ManageChannel"
        | "ManageServer"
        | "ManagePermissions"
        | "ManageRole"
        | "ManageCustomisation"
        | "KickMembers"
        | "BanMembers"
        | "TimeoutMembers"
        | "AssignRoles"
        | "ChangeNickname"
        | "ManageNicknames"
        | "ChangeAvatar"
        | "RemoveAvatars"
        | "ViewChannel"
        | "ReadMessageHistory"
        | "SendMessage"
        | "ManageMessages"
        | "ManageWebhooks"
        | "InviteOthers"
        | "SendEmbeds"
        | "UploadFiles"
        | "React"
        | "Connect"
        | "Speak"
        | "MuteMembers"
        | "DeafenMembers"
        | "MoveMembers"
        | "GrantAllSafe"
    )[],
): boolean
Check whether we have a given permission in a channel
Parameters
- ...permission: (
      | "Video"
      | "Masquerade"
      | "ManageChannel"
      | "ManageServer"
      | "ManagePermissions"
      | "ManageRole"
      | "ManageCustomisation"
      | "KickMembers"
      | "BanMembers"
      | "TimeoutMembers"
      | "AssignRoles"
      | "ChangeNickname"
      | "ManageNicknames"
      | "ChangeAvatar"
      | "RemoveAvatars"
      | "ViewChannel"
      | "ReadMessageHistory"
      | "SendMessage"
      | "ManageMessages"
      | "ManageWebhooks"
      | "InviteOthers"
      | "SendEmbeds"
      | "UploadFiles"
      | "React"
      | "Connect"
      | "Speak"
      | "MuteMembers"
      | "DeafenMembers"
      | "MoveMembers"
      | "GrantAllSafe"
  )[]
  Permission Names
Returns boolean
Whether we have this permission
- Defined in src/classes/Channel.ts:364

orPermission

orPermission(
    ...permission: (
        | "Video"
        | "Masquerade"
        | "ManageChannel"
        | "ManageServer"
        | "ManagePermissions"
        | "ManageRole"
        | "ManageCustomisation"
        | "KickMembers"
        | "BanMembers"
        | "TimeoutMembers"
        | "AssignRoles"
        | "ChangeNickname"
        | "ManageNicknames"
        | "ChangeAvatar"
        | "RemoveAvatars"
        | "ViewChannel"
        | "ReadMessageHistory"
        | "SendMessage"
        | "ManageMessages"
        | "ManageWebhooks"
        | "InviteOthers"
        | "SendEmbeds"
        | "UploadFiles"
        | "React"
        | "Connect"
        | "Speak"
        | "MuteMembers"
        | "DeafenMembers"
        | "MoveMembers"
        | "GrantAllSafe"
    )[],
): boolean
Check whether we have at least one of the given permissions in a channel
Parameters
- ...permission: (
      | "Video"
      | "Masquerade"
      | "ManageChannel"
      | "ManageServer"
      | "ManagePermissions"
      | "ManageRole"
      | "ManageCustomisation"
      | "KickMembers"
      | "BanMembers"
      | "TimeoutMembers"
      | "AssignRoles"
      | "ChangeNickname"
      | "ManageNicknames"
      | "ChangeAvatar"
      | "RemoveAvatars"
      | "ViewChannel"
      | "ReadMessageHistory"
      | "SendMessage"
      | "ManageMessages"
      | "ManageWebhooks"
      | "InviteOthers"
      | "SendEmbeds"
      | "UploadFiles"
      | "React"
      | "Connect"
      | "Speak"
      | "MuteMembers"
      | "DeafenMembers"
      | "MoveMembers"
      | "GrantAllSafe"
  )[]
  Permission Names
Returns boolean
Whether we have one of the permissions
- Defined in src/classes/Channel.ts:376

removeMember

removeMember(user_id: string): Promise<void>
Remove a user from a group
Parameters
- user_id: string
  ID of the target user
Returns Promise<void>
Requires
Group
- Defined in src/classes/Channel.ts:471

search

search(
    params: Omit<
        {
            after?: null
            | string;
            before?: null | string;
            include_users?: null | boolean;
            limit?: null | number;
            pinned?: null | boolean;
            query?: null | string;
            sort?: "Relevance" | "Latest" | "Oldest";
        },
        "include_users",
    >,
): Promise<Message[]>
Search for messages
Parameters
- params: Omit<
      {
          after?: null
          | string;
          before?: null | string;
          include_users?: null | boolean;
          limit?: null | number;
          pinned?: null | boolean;
          query?: null | string;
          sort?: "Relevance" | "Latest" | "Oldest";
      },
      "include_users",
  >
  Message searching route data
Returns Promise<Message[]>
Messages

Requires
SavedMessages, DirectMessage, Group, TextChannel
- Defined in src/classes/Channel.ts:596

searchWithUsers

searchWithUsers(
    params: Omit<
        {
            after?: null
            | string;
            before?: null | string;
            include_users?: null | boolean;
            limit?: null | number;
            pinned?: null | boolean;
            query?: null | string;
            sort?: "Relevance" | "Latest" | "Oldest";
        },
        "include_users",
    >,
): Promise<
    {
        members: undefined
        | ServerMember[];
        messages: Message[];
        users: User[];
    },
>
Search for messages including the users that sent them
Parameters
- params: Omit<
      {
          after?: null
          | string;
          before?: null | string;
          include_users?: null | boolean;
          limit?: null | number;
          pinned?: null | boolean;
          query?: null | string;
          sort?: "Relevance" | "Latest" | "Oldest";
      },
      "include_users",
  >
  Message searching route data
Returns Promise<
    {
        members: undefined
        | ServerMember[];
        messages: Message[];
        users: User[];
    },
>
Object including messages and users

Requires
SavedMessages, DirectMessage, Group, TextChannel
- Defined in src/classes/Channel.ts:617

sendMessage

sendMessage(
    data:
        | string
        | {
            attachments?: null
            | string[];
            content?: null | string;
            embeds?:
                | null
                | {
                    colour?: null
                    | string;
                    description?: null | string;
                    icon_url?: null | string;
                    media?: null | string;
                    title?: null | string;
                    url?: null | string;
                }[];
            flags?: null
            | number;
            interactions?:
                | null
                | { reactions?: null
                | string[]; restrict_reactions?: boolean };
            masquerade?:
                | null
                | {
                    avatar?: null
                    | string;
                    colour?: null | string;
                    name?: null | string;
                };
            nonce?: null
            | string;
            replies?: null | { id: string; mention: boolean }[];
        },
    idempotencyKey?: string,
): Promise<Message>
Send a message
Parameters
- data:
      | string
      | {
          attachments?: null
          | string[];
          content?: null | string;
          embeds?:
              | null
              | {
                  colour?: null
                  | string;
                  description?: null | string;
                  icon_url?: null | string;
                  media?: null | string;
                  title?: null | string;
                  url?: null | string;
              }[];
          flags?: null
          | number;
          interactions?:
              | null
              | { reactions?: null
              | string[]; restrict_reactions?: boolean };
          masquerade?:
              | null
              | {
                  avatar?: null
                  | string;
                  colour?: null | string;
                  name?: null | string;
              };
          nonce?: null
          | string;
          replies?: null | { id: string; mention: boolean }[];
      }
  Either the message as a string or message sending route data
  - string
  - {
        attachments?: null | string[];
        content?: null | string;
        embeds?:
            | null
            | {
                colour?: null
                | string;
                description?: null | string;
                icon_url?: null | string;
                media?: null | string;
                title?: null | string;
                url?: null | string;
            }[];
        flags?: null
        | number;
        interactions?:
            | null
            | { reactions?: null
            | string[]; restrict_reactions?: boolean };
        masquerade?:
            | null
            | { avatar?: null
            | string; colour?: null | string; name?: null | string };
        nonce?: null | string;
        replies?: null | { id: string; mention: boolean }[];
    }
    Optionalattachments?: null | string[]
    Description
    Attachments to include in message
    
    Optionalcontent?: null | string
    Description
    Message content to send
    
    Optionalembeds?:
        | null
        | {
            colour?: null
            | string;
            description?: null | string;
            icon_url?: null | string;
            media?: null | string;
            title?: null | string;
            url?: null | string;
        }[]
    Description
    Embeds to include in message
    
    Text embed content contributes to the content length cap
    
    Optionalflags?: null | number
    Format: uint32
    
    Description
    Bitfield of message flags
    
    https://docs.rs/revolt-models/latest/revolt_models/v0/enum.MessageFlags.html
    
    Optionalinteractions?: null | { reactions?: null | string[]; restrict_reactions?: boolean }
    Description
    Information about how this message should be interacted with
    
    Optionalmasquerade?: null | { avatar?: null | string; colour?: null | string; name?: null | string }
    Description
    Masquerade to apply to this message
    
    Optionalnonce?: null | string
    Description
    Unique token to prevent duplicate message sending
    
    This is deprecated and replaced by Idempotency-Key!
    
    Optionalreplies?: null | { id: string; mention: boolean }[]
    Description
    Messages to reply to
- idempotencyKey: string = ...
Returns Promise<Message>
Sent message

Requires
SavedMessages, DirectMessage, Group, TextChannel
- Defined in src/classes/Channel.ts:483

setPermissions

setPermissions(
    role_id?: string,
    permissions: { allow: number; deny: number },
): Promise<
    | { _id: string; channel_type: "SavedMessages"; user: string }
    | {
        _id: string;
        active: boolean;
        channel_type: "DirectMessage";
        last_message_id?: null | string;
        recipients: string[];
    }
    | {
        _id: string;
        channel_type: "Group";
        description?: null
        | string;
        icon?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        last_message_id?: null
        | string;
        name: string;
        nsfw?: boolean;
        owner: string;
        permissions?: null | number;
        recipients: string[];
    }
    | {
        _id: string;
        channel_type: "TextChannel";
        default_permissions?: null
        | { a: number; d: number };
        description?: null | string;
        icon?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        last_message_id?: null
        | string;
        name: string;
        nsfw?: boolean;
        role_permissions?: { [key: string]: { a: number; d: number } };
        server: string;
    }
    | {
        _id: string;
        channel_type: "VoiceChannel";
        default_permissions?: null
        | { a: number; d: number };
        description?: null | string;
        icon?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        name: string;
        nsfw?: boolean;
        role_permissions?: { [key: string]: { a: number; d: number } };
        server: string;
    },
>
Set role permissions
Parameters
- role_id: string = "default"
  Role Id, set to 'default' to affect all users
- permissions: { allow: number; deny: number }
  Permission value
  - allow: number
    Format: uint64
    
    Description
    Allow bit flags
  - deny: number
    Format: uint64
    
    Description
    Disallow bit flags
Returns Promise<
    | { _id: string; channel_type: "SavedMessages"; user: string }
    | {
        _id: string;
        active: boolean;
        channel_type: "DirectMessage";
        last_message_id?: null | string;
        recipients: string[];
    }
    | {
        _id: string;
        channel_type: "Group";
        description?: null
        | string;
        icon?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        last_message_id?: null
        | string;
        name: string;
        nsfw?: boolean;
        owner: string;
        permissions?: null | number;
        recipients: string[];
    }
    | {
        _id: string;
        channel_type: "TextChannel";
        default_permissions?: null
        | { a: number; d: number };
        description?: null | string;
        icon?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        last_message_id?: null
        | string;
        name: string;
        nsfw?: boolean;
        role_permissions?: { [key: string]: { a: number; d: number } };
        server: string;
    }
    | {
        _id: string;
        channel_type: "VoiceChannel";
        default_permissions?: null
        | { a: number; d: number };
        description?: null | string;
        icon?:
            | null
            | {
                _id: string;
                content_type: string;
                deleted?: null
                | boolean;
                filename: string;
                message_id?: null | string;
                metadata:
                    | { type: "File" }
                    | { type: "Text" }
                    | { height: number; type: "Image"; width: number }
                    | { height: number; type: "Video"; width: number }
                    | { type: "Audio" };
                object_id?: null | string;
                reported?: null | boolean;
                server_id?: null | string;
                size: number;
                tag: string;
                user_id?: null | string;
            };
        name: string;
        nsfw?: boolean;
        role_permissions?: { [key: string]: { a: number; d: number } };
        server: string;
    },
>
Requires
Group, TextChannel, VoiceChannel
- Defined in src/classes/Channel.ts:748

startTyping

startTyping(): void
Start typing in this channel

Returns void
Requires
DirectMessage, Group, TextChannel
- Defined in src/classes/Channel.ts:762

stopTyping

stopTyping(): void
Stop typing in this channel

Returns void
Requires
DirectMessage, Group, TextChannel
- Defined in src/classes/Channel.ts:773

toString

toString(): string
Write to string as a channel mention

Returns string
Formatted String
- Defined in src/classes/Channel.ts:54

Class Channel

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Channel

Properties

Readonlyid

Accessors

$exists

Returns boolean

active

Returns boolean

animatedIconURL

Returns undefined | string

createdAt

Returns Date

defaultPermissions

Returns undefined | { a: number; d: number }

description

Returns undefined | string

displayName

Returns undefined | string

icon

Returns undefined | File

iconURL

Returns undefined | string

lastMessage

Returns undefined | Message

lastMessageAt

Returns undefined | Date

lastMessageId

Returns undefined | string

mature

Returns boolean

mentions

Returns undefined | ReactiveSet<string>

name

Returns string

owner

Returns undefined | User

ownerId

Returns string

path

Returns string

permission

Returns number

permissions

Returns undefined | number

potentiallyRestrictedChannel

Returns undefined | string | boolean

recipient

Returns undefined | User

recipientIds

Returns ReactiveSet<string>

recipients

Returns User[]

rolePermissions

Returns undefined | Record<string, { a: number; d: number }>

server

Returns undefined | Server

serverId

Returns string

type

Returns "SavedMessages" | "DirectMessage" | "Group" | "TextChannel" | "VoiceChannel"

typing

Returns User[]

typingIds

Returns ReactiveSet<string>

unread

Returns boolean

updatedAt

Returns Date

url

Returns string

user

`Readonly`id

Returns Promise<
| {
_id: string;
channel: string;
creator: string;
server: string;
type: "Server";
}
| { _id: string; channel: string; creator: string; type: "Group" },
>

`Optional`archived?: null | boolean

`Optional`description?: null | string

`Optional`icon?: null | string

`Optional`name?: null | string

`Optional`nsfw?: null | boolean

`Optional`owner?: null | string

`Optional`remove?: null | ("Description" | "Icon" | "DefaultPermissions")[]

Returns Promise<
{
members: undefined
| ServerMember[];
messages: Message[];
users: User[];
},
>