Class ChannelWebhookCollection

Collection of Channel Webhooks

Hierarchy

ClassCollection<ChannelWebhook, HydratedChannelWebhook>
- ChannelWebhookCollection

Index

Constructors

constructor

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

Properties

`Private` #objects

#objects: ReactiveMap<string, ChannelWebhook> = ...

`Private` #storage

#storage: ObjectStorage<HydratedChannelWebhook> = ...

`Readonly` client

client: Client

`Readonly` getUnderlyingObject

getUnderlyingObject: ((id) => HydratedChannelWebhook)

Type declaration

- (id): HydratedChannelWebhook
- Parameters
  - id: string
  Returns HydratedChannelWebhook

`Readonly` updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannelWebhook>>

Methods

create

create(id, type, instance, context, data?): 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: ChannelWebhook
  
  Instance
- context: unknown
  
  Context
- Optional data: unknown
  
  Data
Returns void
Inherited from ClassCollection.create
- Defined in src/collections/Collection.ts:167

delete

delete(id): void
Delete an object
Parameters
- id: string
  
  Id
Returns void
Inherited from ClassCollection.delete
- Defined in src/collections/Collection.ts:154

entries

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

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

fetch

fetch(id): Promise<ChannelWebhook>
Fetch webhook by ID
Parameters
- id: string
  
  Id
Returns Promise<ChannelWebhook>
Webhook
- Defined in src/collections/ChannelWebhookCollection.ts:19

filter

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

find

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

forEach

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

fromToken

fromToken(id, token): Promise<ChannelWebhook>
Create webhook with ID and token
Parameters
- id: string
  
  Id
- token: string
  
  Token
Returns Promise<ChannelWebhook>
Webhook
- Defined in src/collections/ChannelWebhookCollection.ts:34

get

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

getOrCreate

getOrCreate(id, data): ChannelWebhook
Get or create
Parameters
- id: string
  
  Id
- data: {
      avatar?: 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;
      };
      channel_id: string;
      id: string;
      name: string;
      permissions: number;
      token?: null | string;
  }
  
  Data
  - Optional avatar?: 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
    The avatar of the webhook
  - channel_id: string
    
    Description
    The channel this webhook belongs to
  - id: string
    
    Description
    Webhook Id
  - name: string
    
    Description
    The name of the webhook
  - permissions: number
    
    Format: uint64
    
    Description
    The permissions for the webhook
  - Optional token?: null | string
    
    Description
    The private token for the webhook
Returns ChannelWebhook
- Defined in src/collections/ChannelWebhookCollection.ts:50

has

has(id): 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): 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): O[]
Map the collection using a given callback
Type Parameters
- O
Parameters
- cb: ((value, key) => O)
  
  Callback
  - - (value, key): O
    - Parameters
      
      value: ChannelWebhook
      
      key: string
      
      Returns O
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(): ChannelWebhook[]
List of values in the map

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

values

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

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

Class ChannelWebhookCollection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns ChannelWebhookCollection

Properties

Private #objects

Private #storage

Readonly client

Readonly getUnderlyingObject

Type declaration

Parameters

id: string

Returns HydratedChannelWebhook

Readonly updateUnderlyingObject

Methods

create

Parameters

id: string

type: "user" | "server" | "channel" | "bot" | "channelUnread" | "channelWebhook" | "emoji" | "message" | "serverMember" | "session"

instance: ChannelWebhook

context: unknown

Optional data: unknown

Returns void

delete

Parameters

id: string

Returns void

entries

Returns IterableIterator<[string, ChannelWebhook]>

fetch

Parameters

id: string

Returns Promise<ChannelWebhook>

filter

Parameters

predicate: ((value, key) => boolean)

Parameters

value: ChannelWebhook

key: string

Returns boolean

Returns ChannelWebhook[]

find

Parameters

predicate: ((value, key) => boolean)

Parameters

value: ChannelWebhook

key: string

Returns boolean

Returns undefined | ChannelWebhook

forEach

Parameters

cb: ((value, key, map) => void)

Parameters

value: ChannelWebhook

key: string

map: ReactiveMap<string, ChannelWebhook>

Returns void

Returns void

fromToken

Parameters

id: string

token: string

Returns Promise<ChannelWebhook>

get

Parameters

id: string

Returns undefined | ChannelWebhook

getOrCreate

Parameters

id: string

Description

channel_id: string

Description

`Private` #objects

`Private` #storage

`Readonly` client

`Readonly` getUnderlyingObject

`Readonly` updateUnderlyingObject

`Optional` data: unknown

`Optional` token?: null | string