Class Channel

Hierarchy

BaseObject<API.Channel>
- Channel

Constructors

constructor

new Channel(client: Client, data: {
    _id: string;
    channel_type: "SavedMessages";
    user: string;
} | {
    _id: string;
    active: boolean;
    channel_type: "DirectMessage";
    last_message_id?: string;
    recipients: string[];
} | {
    _id: string;
    channel_type: "Group";
    description?: string;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    last_message_id?: string;
    name: string;
    nsfw?: boolean;
    owner: string;
    permissions?: number;
    recipients: string[];
} | {
    _id: string;
    channel_type: "TextChannel";
    default_permissions?: {
        a: number;
        d: number;
    };
    description?: string;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    last_message_id?: string;
    name: string;
    nsfw?: boolean;
    role_permissions?: {
        [key: string]: components["schemas"]["OverrideField"];
    };
    server: string;
} | {
    _id: string;
    channel_type: "VoiceChannel";
    default_permissions?: {
        a: number;
        d: number;
    };
    description?: string;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    name: string;
    nsfw?: boolean;
    role_permissions?: {
        [key: string]: components["schemas"]["OverrideField"];
    };
    server: string;
}): Channel
Parameters
- client: Client
- data: {
      _id: string;
      channel_type: "SavedMessages";
      user: string;
  } | {
      _id: string;
      active: boolean;
      channel_type: "DirectMessage";
      last_message_id?: string;
      recipients: string[];
  } | {
      _id: string;
      channel_type: "Group";
      description?: string;
      icon?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      last_message_id?: string;
      name: string;
      nsfw?: boolean;
      owner: string;
      permissions?: number;
      recipients: string[];
  } | {
      _id: string;
      channel_type: "TextChannel";
      default_permissions?: {
          a: number;
          d: number;
      };
      description?: string;
      icon?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      last_message_id?: string;
      name: string;
      nsfw?: boolean;
      role_permissions?: {
          [key: string]: components["schemas"]["OverrideField"];
      };
      server: string;
  } | {
      _id: string;
      channel_type: "VoiceChannel";
      default_permissions?: {
          a: number;
          d: number;
      };
      description?: string;
      icon?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      name: string;
      nsfw?: boolean;
      role_permissions?: {
          [key: string]: components["schemas"]["OverrideField"];
      };
      server: string;
  }
Returns Channel
Overrides BaseObject.constructor
- Defined in core/src/objects/Channel.ts:40

Properties

client

client: Client

deleted

deleted: boolean = false

messages

messages: MessageManager

typingIDs

typingIDs: Set<string> = ...

Can include your own user ID.

Accessors

`Protected` _id

get _id(): ""
Returns ""
Inherited from BaseObject._id
- Defined in core/src/objects/BaseObject.ts:10

createdAt

get createdAt(): number
Returns number
Inherited from BaseObject.createdAt
- Defined in core/src/objects/BaseObject.ts:19

description

get description(): string
Returns string
- Defined in core/src/objects/Channel.ts:77

icon

get icon(): Attachment
Returns Attachment
- Defined in core/src/objects/Channel.ts:88

id

get id(): string
Returns string
Inherited from BaseObject.id
- Defined in core/src/objects/BaseObject.ts:16

lastMessage

get lastMessage(): BaseMessage
Returns BaseMessage
- Defined in core/src/objects/Channel.ts:125

lastMessageID

get lastMessageID(): string
Returns string
- Defined in core/src/objects/Channel.ts:120

mentions

get mentions(): string[]
Returns string[]
- Defined in core/src/objects/Channel.ts:169

name

get name(): string
Returns string
- Defined in core/src/objects/Channel.ts:71

nsfw

get nsfw(): boolean
Returns boolean
- Defined in core/src/objects/Channel.ts:82

permissions

get permissions(): PermissionFlags
Returns PermissionFlags
- Defined in core/src/objects/Channel.ts:107

source

get source(): APIType
Original API object.

Returns APIType
Inherited from BaseObject.source
- Defined in core/src/objects/BaseObject.ts:7

type

get type(): ChannelType
Returns ChannelType
- Defined in core/src/objects/Channel.ts:35

typing

get typing(): User[]
Will not include your user.

Returns User[]
- Defined in core/src/objects/Channel.ts:142

unread

get unread(): boolean
Returns boolean
- Defined in core/src/objects/Channel.ts:159

Methods

ack

ack(message?: string | BaseMessage): Promise<void>
Mark a specific message as read/unread.
Parameters
- Optional message: string | BaseMessage
Returns Promise<void>
- Defined in core/src/objects/Channel.ts:174

checkUnread

checkUnread(valid: ChannelUnreadChecker): any
Parameters
- valid: ChannelUnreadChecker
Returns any
- Defined in core/src/objects/Channel.ts:155

createInvite

createInvite(): Promise<ServerInvite>
Returns Promise<ServerInvite>
- Defined in core/src/objects/Channel.ts:113

delete

delete(silent?: boolean): Promise<void>
Delete or leave this channel.
Parameters
- Optional silent: boolean
Returns Promise<void>
- Defined in core/src/objects/Channel.ts:219

edit

edit(data: {
    archived?: boolean;
    description?: string;
    icon?: string;
    name?: string;
    nsfw?: boolean;
    owner?: string;
    remove?: ("Description" | "Icon" | "DefaultPermissions")[];
}): Promise<Channel>
Parameters
- data: {
      archived?: boolean;
      description?: string;
      icon?: string;
      name?: string;
      nsfw?: boolean;
      owner?: string;
      remove?: ("Description" | "Icon" | "DefaultPermissions")[];
  }
  - Optional archived?: boolean
    
    Description
    Whether this channel is archived
  - Optional description?: string
    
    Description
    Channel description
  - Optional icon?: string
    
    Description
    Icon
    
    Provide an Autumn attachment Id.
  - Optional name?: string
    
    Description
    Channel name
  - Optional nsfw?: boolean
    
    Description
    Whether this channel is age-restricted
  - Optional owner?: string
    
    Description
    Group owner
  - Optional remove?: ("Description" | "Icon" | "DefaultPermissions")[]
Returns Promise<Channel>
- Defined in core/src/objects/Channel.ts:215

fetchLastMessage

fetchLastMessage(): Promise<BaseMessage>
Returns Promise<BaseMessage>
- Defined in core/src/objects/Channel.ts:128

fetchMessage

fetchMessage(id: string): Promise<BaseMessage>
Parameters
- id: string
Returns Promise<BaseMessage>
- Defined in core/src/objects/Channel.ts:211

fireUpdate

fireUpdate(updated?: any[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: any[]
  
  The objects that caused this update.
Returns void
Inherited from BaseObject.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:33

generateIconURL

generateIconURL(...args: AttachmentArgs): any
Parameters
- Rest ...args: AttachmentArgs
Returns any
- Defined in core/src/objects/Channel.ts:94

getMentions

getMentions(valid: ChannelUnreadChecker): any
Parameters
- valid: ChannelUnreadChecker
Returns any
- Defined in core/src/objects/Channel.ts:165

lastMessageBy

lastMessageBy(user: User): Message
Parameters
- user: User
Returns Message
- Defined in core/src/objects/Channel.ts:132

markRead

markRead(useSeparate?: boolean): Promise<void>
Syncs unreads from server and marks channel as read if unread.
Parameters
- useSeparate: boolean = false
  
  If true, will create a new unread object to avoid 'unread flashing'.
Returns Promise<void>
- Defined in core/src/objects/Channel.ts:183

offUpdate

offUpdate(callback: MiniEmitterCallback<any>): Channel
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to stop listening for updates on.
Returns Channel
Inherited from BaseObject.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:24

onUpdate

onUpdate(callback: MiniEmitterCallback<any>): Channel
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to run when an update occurs.
Returns Channel
Inherited from BaseObject.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:15

permissionsFor

permissionsFor(member: Member): PermissionFlags
Parameters
- member: Member
Returns PermissionFlags
- Defined in core/src/objects/Channel.ts:110

send

send(data: MessagePayload): Promise<Message>
Set expandMentions to automatically turn plaintext user mentions into 'real' ones. Set expandEmojis to do the same for emojis (using uniqueName).
Parameters
- data: MessagePayload
Returns Promise<Message>
- Defined in core/src/objects/Channel.ts:201

setPermissions

setPermissions(role: Role | "default", permissions: {
allow: number;
deny: number;
}): Promise<void>
Set permissions for a role or 'default' for everyone.
Parameters
- role: Role | "default"
- permissions: {
  allow: number;
  deny: number;
  }
  - allow: number
    
    Format: uint64
    
    Description
    Allow bit flags
  - deny: number
    
    Format: uint64
    
    Description
    Disallow bit flags
Returns Promise<void>
- Defined in core/src/objects/Channel.ts:99

startTyping

startTyping(): void
Returns void
- Defined in core/src/objects/Channel.ts:148

stopTyping

stopTyping(): void
Returns void
- Defined in core/src/objects/Channel.ts:151

toString

toString(): string
Returns
The channel formatted for markdown. <#id>

Returns string
Overrides BaseObject.toString
- Defined in core/src/objects/Channel.ts:228

update

update(data?: Partial<{
    _id: string;
    channel_type: "SavedMessages";
    user: string;
} | {
    _id: string;
    active: boolean;
    channel_type: "DirectMessage";
    last_message_id?: string;
    recipients: string[];
} | {
    _id: string;
    channel_type: "Group";
    description?: string;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    last_message_id?: string;
    name: string;
    nsfw?: boolean;
    owner: string;
    permissions?: number;
    recipients: string[];
} | {
    _id: string;
    channel_type: "TextChannel";
    default_permissions?: {
        a: number;
        d: number;
    };
    description?: string;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    last_message_id?: string;
    name: string;
    nsfw?: boolean;
    role_permissions?: {
        [key: string]: components["schemas"]["OverrideField"];
    };
    server: string;
} | {
    _id: string;
    channel_type: "VoiceChannel";
    default_permissions?: {
        a: number;
        d: number;
    };
    description?: string;
    icon?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    name: string;
    nsfw?: boolean;
    role_permissions?: {
        [key: string]: components["schemas"]["OverrideField"];
    };
    server: string;
}>): Channel
Update this object with new API data.
Parameters
- data: Partial<{
      _id: string;
      channel_type: "SavedMessages";
      user: string;
  } | {
      _id: string;
      active: boolean;
      channel_type: "DirectMessage";
      last_message_id?: string;
      recipients: string[];
  } | {
      _id: string;
      channel_type: "Group";
      description?: string;
      icon?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      last_message_id?: string;
      name: string;
      nsfw?: boolean;
      owner: string;
      permissions?: number;
      recipients: string[];
  } | {
      _id: string;
      channel_type: "TextChannel";
      default_permissions?: {
          a: number;
          d: number;
      };
      description?: string;
      icon?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      last_message_id?: string;
      name: string;
      nsfw?: boolean;
      role_permissions?: {
          [key: string]: components["schemas"]["OverrideField"];
      };
      server: string;
  } | {
      _id: string;
      channel_type: "VoiceChannel";
      default_permissions?: {
          a: number;
          d: number;
      };
      description?: string;
      icon?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      name: string;
      nsfw?: boolean;
      role_permissions?: {
          [key: string]: components["schemas"]["OverrideField"];
      };
      server: string;
  }> = {}
Returns Channel
Inherited from BaseObject.update
- Defined in core/src/objects/BaseObject.ts:24

Class Channel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

Returns Channel

Properties

client

deleted

messages

typingIDs

Accessors

Protected _id

Returns ""

createdAt

Returns number

description

Returns string

icon

Returns Attachment

id

Returns string

lastMessage

Returns BaseMessage

lastMessageID

Returns string

mentions

Returns string[]

name

Returns string

nsfw

Returns boolean

permissions

Returns PermissionFlags

source

Returns APIType

type

Returns ChannelType

typing

Returns User[]

unread

Returns boolean

Methods

ack

Parameters

Optional message: string | BaseMessage

Returns Promise<void>

checkUnread

Parameters

valid: ChannelUnreadChecker

Returns any

createInvite

Returns Promise<ServerInvite>

delete

Parameters

Optional silent: boolean

Returns Promise<void>

edit

Parameters

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

Optional archived?: boolean

Description

Optional description?: string

Description

Optional icon?: string

Description

Optional name?: string

Description

Optional nsfw?: boolean

Description

Optional owner?: string

Description

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

Returns Promise<Channel>

`Protected` _id

`Optional` message: string | BaseMessage

`Optional` silent: boolean

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

`Optional` archived?: boolean

`Optional` description?: string

`Optional` icon?: string

`Optional` name?: string

`Optional` nsfw?: boolean

`Optional` owner?: string

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

`Optional` updated: any[]

`Rest` ...args: AttachmentArgs

permissions: {
allow: number;
deny: number;
}