Class VoiceChannel

Represents a voice channel in a server.

Hierarchy (View Summary)

ServerChannel
- VoiceChannel

Index

Constructors

constructor

new VoiceChannel(
    client: client,
    data: {
        _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;
    },
): VoiceChannel
Creates a new VoiceChannel instance.
Parameters
- client: client
  The client instance.
- data: {
      _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;
  }
  The raw data for the voice channel from the API.
  - _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
Returns VoiceChannel
Overrides ServerChannel.constructor
- Defined in work/revbot.js/revbot.js/src/struct/voiceChannels.ts:23

Properties

`Readonly`client

client: client

The client instance.

description

description: null | string = null

The description of the channel, or null if none is set.

icon

icon: null | Attachment = null

The icon of the channel, or null if none is set.

id

id: string

The unique identifier for the object.

name

name: string

The name of the channel.

nsfw

nsfw: boolean = false

Whether the channel is marked as NSFW (Not Safe For Work).

overwrites

overwrites: Map<string, Overwrite> = ...

The permission overwrites for the channel.

serverId

serverId: string

The ID of the server this channel belongs to.

`Readonly`type

type: VOICE = ChannelTypes.VOICE

The type of the channel, which is always VOICE for voice channels.

Accessors

createdAt

get createdAt(): Date
Gets the date and time when the channel was created.

Returns Date
The creation date of the channel.
Inherited from ServerChannel.createdAt
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:40

createdTimestamp

get createdTimestamp(): number
Gets the timestamp (in milliseconds) when the channel was created.

Returns number
The timestamp of the channel's creation.
Inherited from ServerChannel.createdTimestamp
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:31

server

get server(): Server
Retrieves the server this channel belongs to.

Returns Server
The server instance.
Inherited from ServerChannel.server
- Defined in work/revbot.js/revbot.js/src/struct/serverChannel.ts:128

Methods

_clone

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

Returns this
A clone of the object.
Inherited from ServerChannel._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 ServerChannel._update
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:56

ack

ack(): Promise<void>
Acknowledges the voice channel.

Returns Promise<void>
Throws
Throws an error because voice channels cannot be acknowledged.
Example
```
try {
  await voiceChannel.ack();
} catch (error) {
  console.error(error.message); // "Cannot ack voice channel"
}
```
- Defined in work/revbot.js/revbot.js/src/struct/voiceChannels.ts:54

createInvite

createInvite(): Promise<Invite>
Creates an invite for the server channel.

Returns Promise<Invite>
A promise that resolves with the created invite.
Example
```
const invite = await serverChannel.createInvite();
console.log(`Invite created: ${invite}`);
```
Inherited from ServerChannel.createInvite
- Defined in work/revbot.js/revbot.js/src/struct/serverChannel.ts:101

delete

delete(): Promise<void>
Deletes the current channel instance from the client's channel collection.

This method interacts with the client's channel management system to remove the channel. Once deleted, the channel will no longer be accessible through the client.

Returns Promise<void>
A promise that resolves when the channel has been successfully deleted.
Example
```
const channel = client.channels.get('1234567890');
if (channel) {
  await channel.delete();
  console.log('Channel deleted successfully.');
}
```
Inherited from ServerChannel.delete
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:62

equals

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

fetch

fetch(force?: boolean): Promise<Channel>
Fetches the latest data for the channel from the client's channel collection.
Parameters
- Optionalforce: boolean = true
  Whether to force a fetch even if the channel is cached.
Returns Promise<Channel>
A promise that resolves with the updated channel instance.
Inherited from ServerChannel.fetch
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:117

inServer

inServer(): this is ServerChannel
Checks if the channel is part of a server.

Returns this is ServerChannel
True if the channel is a server channel, otherwise false.
Inherited from ServerChannel.inServer
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:98

isGroup

isGroup(): this is GroupChannel
Checks if the channel is a group channel.

Returns this is GroupChannel
True if the channel is a group channel, otherwise false.
Inherited from ServerChannel.isGroup
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:89

isText

isText(): this is DMChannel | TextChannel | GroupChannel
Checks if the channel is a text-based channel.

Returns this is DMChannel | TextChannel | GroupChannel
True if the channel is a text-based channel, otherwise false.
Inherited from ServerChannel.isText
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:71

isVoice

isVoice(): this is VoiceChannel
Checks if the channel is a voice channel.

Returns this is VoiceChannel
True if the channel is a voice channel, otherwise false.
Inherited from ServerChannel.isVoice
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:80

toString

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

Returns string
A string representation of the channel in the format <#channelId>.
Inherited from ServerChannel.toString
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:107

Class VoiceChannel

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_id: string

Description

channel_type: "VoiceChannel"

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

Description

Optionaldescription?: null | string

Description

Description

name: string

Description

Optionalnsfw?: boolean

Description

Optionalrole_permissions?: { [key: string]: { a: number; d: number } }

Description

server: string

Description

Returns VoiceChannel

Properties

Readonlyclient

description

icon

id

name

nsfw

overwrites

serverId

Readonlytype

Accessors

category

Returns null | Category

createdAt

Returns Date

createdTimestamp

Returns number

server

Returns Server

Methods

_clone

Returns this

_update

Parameters

Returns this

ack

Returns Promise<void>

Throws

Example

createInvite

Returns Promise<Invite>

Example

delete

Returns Promise<void>

Example

equals

Parameters

Returns boolean

fetch

Parameters

Returns Promise<Channel>

inServer

Returns this is ServerChannel

isGroup

Returns this is GroupChannel

isText

Returns this is DMChannel | TextChannel | GroupChannel

isVoice

Returns this is VoiceChannel

toString

Returns string

Settings

On This Page

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

`Optional`description?: null | string

`Optional`nsfw?: boolean

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

`Readonly`client

`Readonly`type