Class CategoryManager

Hierarchy (View Summary)

BaseManager<number, Category>
- CategoryManager

Index

Constructors

Properties

Methods

create delete fetch update

Constructors

constructor

new CategoryManager(client: Client): CategoryManager
Parameters
- client: Client
Returns CategoryManager
Inherited from BaseManager.constructor
- Defined in src/managers/BaseManager.ts:7

Properties

cache

cache: Collection<number, Category> = ...

client

client: Client

Methods

create

create(serverId: string, data: CreateCategoryBody): Promise<Category>
Create a Guilded server's category.
Parameters
- serverId: string
  The ID of the Guilded server.
- data: CreateCategoryBody
  Category data.
Returns Promise<Category>
The category.
- Defined in src/managers/CategoryManager.ts:12

delete

delete(serverId: string, categoryId: number): Promise<void>
Delete a Guilded server's category.
Parameters
- serverId: string
  The ID of the Guilded server.
- categoryId: number
  The ID of the Guilded server's category.
Returns Promise<void>
- Defined in src/managers/CategoryManager.ts:47

fetch

fetch(serverId: string, categoryId: number, forced?: boolean): Promise<Category>
Fetch a Guilded server's category.
Parameters
- serverId: string
  The ID of the Guilded server.
- categoryId: number
  The ID of the Guilded server's category.
- forced: boolean = false
  Whether to forcefully fetch the category from the API, or first attempt to find it in the cache.
Returns Promise<Category>
- Defined in src/managers/CategoryManager.ts:24

update

update(
    serverId: string,
    categoryId: number,
    data: UpdateCategoryBody,
): Promise<Category>
Update a Guilded server's category.
Parameters
- serverId: string
  The ID of the Guilded server.
- categoryId: number
- data: UpdateCategoryBody
  Category data.
Returns Promise<Category>
The category.
- Defined in src/managers/CategoryManager.ts:37