Class ChannelWebhookCollection

Collection of Channel Webhooks

Hierarchy (View Summary)

ClassCollection<ChannelWebhook, HydratedChannelWebhook>
- ChannelWebhookCollection

Index

Constructors

constructor

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

Properties

`Readonly`client

client: Client

`Readonly`getUnderlyingObject

getUnderlyingObject: (id: string) => HydratedChannelWebhook

`Readonly`updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannelWebhook>>

Methods

create

create(
    id: string,
    type:
        | "user"
        | "server"
        | "channel"
        | "bot"
        | "channelUnread"
        | "channelWebhook"
        | "emoji"
        | "message"
        | "serverMember"
        | "session",
    instance: ChannelWebhook,
    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: ChannelWebhook
  Instance
- context: unknown
  Context
- Optionaldata: unknown
  Data
Returns void
Inherited from ClassCollection.create
- Defined in src/collections/Collection.ts:167

delete

delete(id: string): 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: string): Promise<ChannelWebhook>
Fetch webhook by ID
Parameters
- id: string
  Id
Returns Promise<ChannelWebhook>
Webhook
- Defined in src/collections/ChannelWebhookCollection.ts:20

filter

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

find

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

forEach

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

fromToken

fromToken(id: string, token: string): 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:35

get

get(id: string): 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: string,
    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;
        creator_id: string;
        id: string;
        name: string;
        permissions: number;
        token?: null
        | string;
    },
): 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;
      creator_id: string;
      id: string;
      name: string;
      permissions: number;
      token?: null
      | string;
  }
  Data
  - Optionalavatar?:
        | 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
  - creator_id: string
    Description
    User that created this webhook
  - id: string
    Description
    Webhook Id
  - name: string
    Description
    The name of the webhook
  - permissions: number
    Format: uint64
    
    Description
    The permissions for the webhook
  - Optionaltoken?: null | string
    Description
    The private token for the webhook
Returns ChannelWebhook
- Defined in src/collections/ChannelWebhookCollection.ts:51

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: ChannelWebhook, key: string) => O): O[]
Map the collection using a given callback
Type Parameters
- O
Parameters
- cb: (value: ChannelWebhook, 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(): 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 (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ChannelWebhookCollection

Properties

Readonlyclient

ReadonlygetUnderlyingObject

ReadonlyupdateUnderlyingObject

Methods

create

Parameters

Returns void

delete

Parameters

Returns void

entries

Returns IterableIterator<[string, ChannelWebhook]>

fetch

Parameters

Returns Promise<ChannelWebhook>

filter

Parameters

Returns ChannelWebhook[]

find

Parameters

Returns undefined | ChannelWebhook

forEach

Parameters

Returns void

fromToken

Parameters

Returns Promise<ChannelWebhook>

get

Parameters

Returns undefined | ChannelWebhook

getOrCreate

Parameters

Description

channel_id: string

Description

creator_id: string

Description

id: string

Description

name: string

Description

permissions: number

Description

Optionaltoken?: null | string

Description

Returns ChannelWebhook

has

Parameters

Returns boolean

isPartial

Parameters

Returns boolean

keys

Returns IterableIterator<string>

map

Type Parameters

Parameters

Returns O[]

size

Returns number

toList

Returns ChannelWebhook[]

values

Returns IterableIterator<ChannelWebhook>

On This Page

`Readonly`client

`Readonly`getUnderlyingObject

`Readonly`updateUnderlyingObject

`Optional`token?: null | string