Class Category

Represents a category in a server, which groups multiple channels together.

Hierarchy (View Summary)

Base
- Category

Index

Constructors

Properties

client id name server

Accessors

Methods

_clone _update equals toString

Constructors

constructor

new Category(
server: Server,
data: { channels: string[]; id: string; title: string },
): Category
Creates a new Category instance.
Parameters
- server: Server
  The server this category belongs to.
- data: { channels: string[]; id: string; title: string }
  The raw data for the category from the API.
  - channels: string[]
    Description
    Channels in this category
  - id: string
    Description
    Unique ID for this category
  - title: string
    Description
    Title for this category
Returns Category
Overrides Base.constructor
- Defined in work/revbot.js/revbot.js/src/struct/category.ts:22

Properties

`Readonly`client

client: client

The client instance.

id

id: string

The unique identifier for the object.

name

name: string

The name of the category.

`Readonly`server

server: Server

The server this category belongs to.

Accessors

children

get children(): Map<string, ServerChannel>
Retrieves the channels that belong to this category.

Returns Map<string, ServerChannel>
A map of channel IDs to their corresponding ServerChannel instances.
- Defined in work/revbot.js/revbot.js/src/struct/category.ts:56

Methods

_clone

_clone(): this
Creates a deep clone of the object.

Returns this
A clone of the object.
Inherited from Base._clone
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:84

_update

_update(data: PartialObject, clear?: string[]): this
Updates the object with new data and returns a clone of the object.
Parameters
- data: PartialObject
  The data to update the object with.
- Optionalclear: string[]
  Fields to clear in the object.
Returns this
A clone of the updated object.
Inherited from Base._update
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:56

equals

equals(obj?: null | Category): boolean
Compares this object with another to determine if they are equal.
Parameters
- Optionalobj: null | Category
  The object to compare with.
Returns boolean
true if the objects are equal, otherwise false.
Inherited from Base.equals
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:29

toString

toString(): string
Converts the category to a string representation.

Returns string
The name of the category.
- Defined in work/revbot.js/revbot.js/src/struct/category.ts:72