Class ChannelCollection

Collection of Channels

Hierarchy (View Summary)

ClassCollection<Channel, HydratedChannel>
- ChannelCollection

Index

Constructors

constructor

new ChannelCollection(client: Client): ChannelCollection
Create generic class collection
Parameters
- client: Client
  Client
Returns ChannelCollection
Inherited from ClassCollection.constructor
- Defined in src/collections/Collection.ts:239

Properties

`Readonly`client

client: Client

`Readonly`getUnderlyingObject

getUnderlyingObject: (id: string) => HydratedChannel

`Readonly`updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannel>>

Methods

create

create(
    id: string,
    type:
        | "user"
        | "server"
        | "channel"
        | "bot"
        | "channelUnread"
        | "channelWebhook"
        | "emoji"
        | "message"
        | "serverMember"
        | "session",
    instance: Channel,
    context: unknown,
    data?: unknown,
): void
Create a new instance of an object
Parameters
- id: string
  Id
- type:
      | "user"
      | "server"
      | "channel"
      | "bot"
      | "channelUnread"
      | "channelWebhook"
      | "emoji"
      | "message"
      | "serverMember"
      | "session"
  Type
- instance: Channel
  Instance
- context: unknown
  Context
- Optionaldata: unknown
  Data
Returns void
Inherited from ClassCollection.create
- Defined in src/collections/Collection.ts:167

createGroup

createGroup(name: string, users: (string | User)[]): Promise<Channel>
Create a group
Parameters
- name: string
  Group name
- users: (string | User)[]
  Users to add
Returns Promise<Channel>
The newly-created group
- Defined in src/collections/ChannelCollection.ts:78

delete

delete(id: string): void
Delete an object
Parameters
- id: string
  Id
Returns void
Overrides ClassCollection.delete
- Defined in src/collections/ChannelCollection.ts:20

entries

entries(): IterableIterator<[string, Channel]>
Iterable of key, value pairs in the map

Returns IterableIterator<[string, Channel]>
Iterable
Inherited from ClassCollection.entries
- Defined in src/collections/Collection.ts:215

fetch

fetch(id: string): Promise<Channel>
Fetch channel by ID
Parameters
- id: string
  Id
Returns Promise<Channel>
Channel
- Defined in src/collections/ChannelCollection.ts:31

filter

filter(predicate: (value: Channel, key: string) => boolean): Channel[]
Filter the collection by a given predicate
Parameters
- predicate: (value: Channel, key: string) => boolean
  Predicate to satisfy
Returns Channel[]
Inherited from ClassCollection.filter
- Defined in src/collections/Collection.ts:77

find

find(predicate: (value: Channel, key: string) => boolean): undefined | Channel
Find some value based on a predicate
Parameters
- predicate: (value: Channel, key: string) => boolean
  Predicate to satisfy
Returns undefined | Channel
Inherited from ClassCollection.find
- Defined in src/collections/Collection.ts:105

forEach

forEach(
cb: (value: Channel, key: string, map: Map<string, Channel>) => void,
): void
Execute a provided function over each key, value pair in the map
Parameters
- cb: (value: Channel, key: string, map: Map<string, Channel>) => void
  Callback for each pair
Returns void
Iterable
Inherited from ClassCollection.forEach
- Defined in src/collections/Collection.ts:224

get

get(id: string): undefined | Channel
Get an existing object
Parameters
- id: string
  Id
Returns undefined | Channel
Object
Inherited from ClassCollection.get
- Defined in src/collections/Collection.ts:137

getOrCreate

getOrCreate(
    id: string,
    data:
        | { _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;
        },
    isNew?: boolean,
): Channel
Get or create
Parameters
- id: string
  Id
- data:
      | { _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;
      }
  Data
  - { _id: string; channel_type: "SavedMessages"; user: string }
    _id: string
    Description
    Unique Id
    
    channel_type: "SavedMessages"
    user: string
    Description
    Id of the user this channel belongs to
  - {
        _id: string;
        active: boolean;
        channel_type: "DirectMessage";
        last_message_id?: null | string;
        recipients: string[];
    }
    _id: string
    Description
    Unique Id
    
    active: boolean
    Description
    Whether this direct message channel is currently open on both sides
    
    channel_type: "DirectMessage"
    Optionallast_message_id?: null | string
    Description
    Id of the last message sent in this channel
    
    recipients: string[]
    Description
    2-tuple of user ids participating in direct message
  - {
        _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
    Description
    Unique Id
    
    channel_type: "Group"
    Optionaldescription?: null | string
    Description
    Channel description
    
    Optionalicon?:
        | 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;
        }
    Description
    Custom icon attachment
    
    Optionallast_message_id?: null | string
    Description
    Id of the last message sent in this channel
    
    name: string
    Description
    Display name of the channel
    
    Optionalnsfw?: boolean
    Description
    Whether this group is marked as not safe for work
    
    owner: string
    Description
    User id of the owner of the group
    
    Optionalpermissions?: null | number
    Format: int64
    
    Description
    Permissions assigned to members of this group (does not apply to the owner of the group)
    
    recipients: string[]
    Description
    Array of user ids participating in channel
  - {
        _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
    Description
    Unique Id
    
    channel_type: "TextChannel"
    Optionaldefault_permissions?: null | { a: number; d: number }
    Description
    Default permissions assigned to users in this channel
    
    Optionaldescription?: null | string
    Description
    Channel description
    
    Optionalicon?:
        | 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;
        }
    Description
    Custom icon attachment
    
    Optionallast_message_id?: null | string
    Description
    Id of the last message sent in this channel
    
    name: string
    Description
    Display name of the channel
    
    Optionalnsfw?: boolean
    Description
    Whether this channel is marked as not safe for work
    
    Optionalrole_permissions?: { [key: string]: { a: number; d: number } }
    Description
    Permissions assigned based on role to this channel
    
    server: string
    Description
    Id of the server this channel belongs to
  - {
        _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;
    }
    _id: string
    Description
    Unique Id
    
    channel_type: "VoiceChannel"
    Optionaldefault_permissions?: null | { a: number; d: number }
    Description
    Default permissions assigned to users in this channel
    
    Optionaldescription?: null | string
    Description
    Channel description
    
    Optionalicon?:
        | 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;
        }
    Description
    Custom icon attachment
    
    name: string
    Description
    Display name of the channel
    
    Optionalnsfw?: boolean
    Description
    Whether this channel is marked as not safe for work
    
    Optionalrole_permissions?: { [key: string]: { a: number; d: number } }
    Description
    Permissions assigned based on role to this channel
    
    server: string
    Description
    Id of the server this channel belongs to
- isNew: boolean = false
  Whether this object is new
Returns Channel
- Defined in src/collections/ChannelCollection.ts:44

getOrPartial

getOrPartial(id: string): undefined | Channel
Get or return partial
Parameters
- id: string
  Id
Returns undefined | Channel
- Defined in src/collections/ChannelCollection.ts:59

has

has(id: string): boolean
Check whether an id exists in the Collection
Parameters
- id: string
  Id
Returns boolean
Whether it exists
Inherited from ClassCollection.has
- Defined in src/collections/Collection.ts:146

isPartial

isPartial(id: string): boolean
Check whether an object is partially defined
Parameters
- id: string
  Id
Returns boolean
Whether it is a partial
Inherited from ClassCollection.isPartial
- Defined in src/collections/Collection.ts:183

keys

keys(): IterableIterator<string>
Iterable of keys in the map

Returns IterableIterator<string>
Iterable
Inherited from ClassCollection.keys
- Defined in src/collections/Collection.ts:199

map

map<O>(cb: (value: Channel, key: string) => O): O[]
Map the collection using a given callback
Type Parameters
- O
Parameters
- cb: (value: Channel, key: string) => O
  Callback
Returns O[]
Inherited from ClassCollection.map
- Defined in src/collections/Collection.ts:92

size

size(): number
Number of stored objects

Returns number
Size
Inherited from ClassCollection.size
- Defined in src/collections/Collection.ts:191

toList

toList(): Channel[]
List of values in the map

Returns Channel[]
List
Inherited from ClassCollection.toList
- Defined in src/collections/Collection.ts:69

values

values(): IterableIterator<Channel>
Iterable of values in the map

Returns IterableIterator<Channel>
Iterable
Inherited from ClassCollection.values
- Defined in src/collections/Collection.ts:207

Class ChannelCollection

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ChannelCollection

Properties

Readonlyclient

ReadonlygetUnderlyingObject

ReadonlyupdateUnderlyingObject

Methods

create

Parameters

Returns void

createGroup

Parameters

Returns Promise<Channel>

delete

Parameters

Returns void

entries

Returns IterableIterator<[string, Channel]>

fetch

Parameters

Returns Promise<Channel>

filter

Parameters

Returns Channel[]

find

Parameters

Returns undefined | Channel

forEach

Parameters

Returns void

get

Parameters

Returns undefined | Channel

getOrCreate

Parameters

_id: string

Description

channel_type: "SavedMessages"

user: string

Description

_id: string

Description

active: boolean

Description

channel_type: "DirectMessage"

Optionallast_message_id?: null | string

Description

recipients: string[]

Description

_id: string

Description

channel_type: "Group"

Optionaldescription?: null | string

Description

Description

Optionallast_message_id?: null | string

Description

name: string

Description

Optionalnsfw?: boolean

Description

owner: string

Description

Optionalpermissions?: null | number

Description

recipients: string[]

Description

_id: string

Description

channel_type: "TextChannel"

Optionaldefault_permissions?: null | { a: number; d: number }

Description

`Readonly`client

`Readonly`getUnderlyingObject

`Readonly`updateUnderlyingObject

`Optional`last_message_id?: null | string

`Optional`description?: null | string

`Optional`last_message_id?: null | string

`Optional`nsfw?: boolean

`Optional`permissions?: null | number

`Optional`default_permissions?: null | { a: number; d: number }

`Optional`description?: null | string

`Optional`last_message_id?: null | string

`Optional`nsfw?: boolean

`Optional`role_permissions?: { [key: string]: { a: number; d: number } }

`Optional`default_permissions?: null | { a: number; d: number }

`Optional`description?: null | string

`Optional`nsfw?: boolean

`Optional`role_permissions?: { [key: string]: { a: number; d: number } }