Class Channel

Channel Class

Hierarchy

Channel

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:30

Properties

`Private` `Optional` #ackLimit

#ackLimit?: number

`Private` `Optional` #ackTimeout

#ackTimeout?: number

`Private` `Readonly` #collection

#collection: ChannelCollection

`Readonly` id

id: string

Accessors

active

get active(): boolean
Whether the conversation is active

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

animatedIconURL

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

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

createdAt

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

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

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:215

description

get description(): undefined | string
Channel description

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

displayName

get displayName(): undefined | string
Display name

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

icon

get icon(): undefined | File
Channel icon

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

iconURL

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

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

lastMessage

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

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

lastMessageAt

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

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

lastMessageId

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

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

mature

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

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

mentions

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

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

name

get name(): string
Channel name

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

owner

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

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

ownerId

get ownerId(): string
Owner ID

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

path

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

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

permission

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

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

permissions

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

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

recipient

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

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

recipientIds

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

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

recipients

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

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

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:222

server

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

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

serverId

get serverId(): string
Server ID

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

smallIconURL

get smallIconURL(): undefined | string
URL to a small variant of the channel icon

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

type

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

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

typing

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

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

typingIds

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

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

unread

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

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

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:259

url

get url(): string
URL to this channel

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

user

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

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

userId

get userId(): string
User ID

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

Methods

ack

ack(message?: string | Message, skipRateLimiter?: boolean): Promise<void>
Mark a channel as read

Requires
SavedMessages, DirectMessage, Group, TextChannel
Parameters
- Optional message: string | Message
  
  Last read message or its ID
- Optional skipRateLimiter: boolean
  
  Whether to skip the internal rate limiter
Returns Promise<void>
- Defined in src/classes/Channel.ts:583

addMember

addMember(user_id: string): Promise<undefined>
Add a user to a group

Requires
Group
Parameters
- user_id: string
  
  ID of the target user
Returns Promise<undefined>
- Defined in src/classes/Channel.ts:385

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

Requires
TextChannel, VoiceChannel

Returns
Newly created invite code

Returns Promise<{
    _id: string;
    channel: string;
    creator: string;
    server: string;
    type: "Server";
} | {
    _id: string;
    channel: string;
    creator: string;
    type: "Group";
}>
- Defined in src/classes/Channel.ts:568

delete

delete(leaveSilently?: boolean): Promise<void>
Delete or leave a channel

Requires
DirectMessage, Group, TextChannel, VoiceChannel
Parameters
- Optional leaveSilently: boolean
  
  Whether to not send a message on leave
Returns Promise<void>
- Defined in src/classes/Channel.ts:367

deleteMessages

deleteMessages(ids: string[]): Promise<void>
Delete many messages by their IDs

Requires
SavedMessages, DirectMessage, Group, TextChannel
Parameters
- ids: string[]
  
  List of message IDs
Returns Promise<void>
- Defined in src/classes/Channel.ts:554

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
  - Optional archived?: null | boolean
    
    Description
    Whether this channel is archived
  - Optional description?: null | string
    
    Description
    Channel description
  - Optional icon?: null | string
    
    Description
    Icon
    
    Provide an Autumn attachment Id.
  - Optional name?: null | string
    
    Description
    Channel name
  - Optional nsfw?: null | boolean
    
    Description
    Whether this channel is age-restricted
  - Optional owner?: null | string
    
    Description
    Group owner
  - Optional remove?: null | ("Description" | "Icon" | "DefaultPermissions")[]
Returns Promise<void>
- Defined in src/classes/Channel.ts:358

fetchMembers

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

Requires
Group

Returns
An array of the channel's members.

Returns Promise<User[]>
- Defined in src/classes/Channel.ts:344

fetchMessage

fetchMessage(messageId: string): Promise<Message>
Fetch a message by its ID

Requires
SavedMessages, DirectMessage, Group, TextChannel

Returns
Message
Parameters
- messageId: string
  
  ID of the target message
Returns Promise<Message>
- Defined in src/classes/Channel.ts:438

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

Requires
SavedMessages, DirectMessage, Group, TextChannel

Returns
Messages
Parameters
- Optional 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">
  
  Message fetching route data
Returns Promise<Message[]>
- Defined in src/classes/Channel.ts:452

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

Requires
SavedMessages, DirectMessage, Group, TextChannel

Returns
Object including messages and users
Parameters
- Optional 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">
  
  Message fetching route data
Returns Promise<{
    members: undefined | ServerMember[];
    messages: Message[];
    users: User[];
}>
- Defined in src/classes/Channel.ts:477

havePermission

havePermission(...permission: ("Masquerade" | "Video" | "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

Returns
Whether we have this permission
Parameters
- Rest ...permission: ("Masquerade" | "Video" | "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
- Defined in src/classes/Channel.ts:332

removeMember

removeMember(user_id: string): Promise<undefined>
Remove a user from a group

Requires
Group
Parameters
- user_id: string
  
  ID of the target user
Returns Promise<undefined>
- Defined in src/classes/Channel.ts:396

search

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

Requires
SavedMessages, DirectMessage, Group, TextChannel

Returns
Messages
Parameters
- params: Omit<{
      after?: null | string;
      before?: null | string;
      include_users?: null | boolean;
      limit?: null | number;
      query: string;
      sort?: "Relevance" | "Latest" | "Oldest";
  }, "include_users">
  
  Message searching route data
Returns Promise<Message[]>
- Defined in src/classes/Channel.ts:510

searchWithUsers

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

Requires
SavedMessages, DirectMessage, Group, TextChannel

Returns
Object including messages and users
Parameters
- params: Omit<{
      after?: null | string;
      before?: null | string;
      include_users?: null | boolean;
      limit?: null | number;
      query: string;
      sort?: "Relevance" | "Latest" | "Oldest";
  }, "include_users">
  
  Message searching route data
Returns Promise<{
    members: undefined | ServerMember[];
    messages: Message[];
    users: User[];
}>
- Defined in src/classes/Channel.ts:527

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;
    }[];
    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

Requires
SavedMessages, DirectMessage, Group, TextChannel

Returns
Sent 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;
      }[];
      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
- idempotencyKey: string = ...
Returns Promise<Message>
- Defined in src/classes/Channel.ts:408

setPermissions

setPermissions(role_id?: string, permissions: {
    allow: number;
    deny: number;
}): Promise<{
    _id: string;
    analytics?: boolean;
    banner?: 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;
    };
    categories?: null | {
        channels: string[];
        id: string;
        title: string;
    }[];
    channels: string[];
    default_permissions: number;
    description?: null | string;
    discoverable?: boolean;
    flags?: null | number;
    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;
    owner: string;
    roles?: {
        [key: string]: components["schemas"]["Role"];
    };
    system_messages?: null | {
        user_banned?: null | string;
        user_joined?: null | string;
        user_kicked?: null | string;
        user_left?: null | string;
    };
}>
Set role permissions

Requires
Group, TextChannel, VoiceChannel
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;
    analytics?: boolean;
    banner?: 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;
    };
    categories?: null | {
        channels: string[];
        id: string;
        title: string;
    }[];
    channels: string[];
    default_permissions: number;
    description?: null | string;
    discoverable?: boolean;
    flags?: null | number;
    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;
    owner: string;
    roles?: {
        [key: string]: components["schemas"]["Role"];
    };
    system_messages?: null | {
        user_banned?: null | string;
        user_joined?: null | string;
        user_kicked?: null | string;
        user_left?: null | string;
    };
}>
- Defined in src/classes/Channel.ts:632

startTyping

startTyping(): void
Start typing in this channel

Requires
DirectMessage, Group, TextChannel

Returns void
- Defined in src/classes/Channel.ts:643

stopTyping

stopTyping(): void
Stop typing in this channel

Requires
DirectMessage, Group, TextChannel

Returns void
- Defined in src/classes/Channel.ts:654

toString

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

Returns
Formatted String

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

Class Channel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

collection: ChannelCollection

id: string

Returns Channel

Properties

Private Optional #ackLimit

Private Optional #ackTimeout

Private Readonly #collection

Readonly id

Accessors

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

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

smallIconURL

Returns undefined | string

type

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

typing

Returns User[]

typingIds

Returns ReactiveSet<string>

unread

Returns boolean

updatedAt

`Private` `Optional` #ackLimit

`Private` `Optional` #ackTimeout

`Private` `Readonly` #collection

`Readonly` id

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

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

`Optional` message: string | Message

`Optional` skipRateLimiter: boolean

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

`Optional` leaveSilently: boolean

data: {
archived?: null | boolean;
description?: null | string;
icon?: null | string;
name?: null | string;
nsfw?: null | boolean;
owner?: null | string;
remove?: null | ("Description" | "Icon" | "DefaultPermissions")[];
}

`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")[]

`Optional` 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">