Class GroupChannel

Represents a group channel, which allows multiple users to communicate.

Hierarchy (View Summary)

Channel
- GroupChannel

Implements

TextBasedChannel

Index

Constructors

constructor

new GroupChannel(
    client: client,
    data: {
        _id: string;
        channel_type: "Group";
        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;
            };
        last_message_id?: null
        | string;
        name: string;
        nsfw?: boolean;
        owner: string;
        permissions?: null | number;
        recipients: string[];
    },
): GroupChannel
Creates a new GroupChannel instance.
Parameters
- client: client
  The client instance.
- data: {
      _id: string;
      channel_type: "Group";
      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;
          };
      last_message_id?: null
      | string;
      name: string;
      nsfw?: boolean;
      owner: string;
      permissions?: null | number;
      recipients: string[];
  }
  The raw data for the group channel from the API.
  - _id: string
    Description
    Unique Id
  - channel_type: "Group"
  - 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
  - Optionallast_message_id?: null | string
    Description
    Id of the last message sent in this channel
  - name: string
    Description
    Display name of the channel
  - Optionalnsfw?: boolean
    Description
    Whether this group is marked as not safe for work
  - owner: string
    Description
    User id of the owner of the group
  - Optionalpermissions?: null | number
    Format: int64
    
    Description
    Permissions assigned to members of this group (does not apply to the owner of the group)
  - recipients: string[]
    Description
    Array of user ids participating in channel
Returns GroupChannel
Overrides Channel.constructor
- Defined in work/revbot.js/revbot.js/src/struct/groupChannel.ts:57

Properties

`Readonly`client

client: client

The client instance.

description

description: null | string = null

The description of the group channel, if any.

icon

icon: null | Attachment = null

The icon of the group channel, if any.

id

id: string

The unique identifier for the object.

lastMessageId

lastMessageId: null | string = null

The ID of the last message sent in this group channel, if any.

messages

messages: MessageManager = ...

Manages the messages in this group channel.

name

name: string

The name of the group channel.

nsfw

nsfw: boolean = false

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

ownerId

ownerId: string

The ID of the user who owns the group channel.

permissions

permissions: Readonly<ChannelPermissions>

The permissions for the group channel.

`Readonly`type

type: GROUP = ChannelTypes.GROUP

The type of the channel, which is always GROUP for group channels.

users

users: Map<string, User> = ...

A map of user IDs to their corresponding User instances in the group channel.

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 Channel.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 Channel.createdTimestamp
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:31

lastMessage

get lastMessage(): null | Message
Retrieves the last message sent in this group channel.

Returns null | Message
The last message, or null if no message exists.
Implementation of TextBasedChannel.lastMessage
- Defined in work/revbot.js/revbot.js/src/struct/groupChannel.ts:112

owner

get owner(): null | User
Retrieves the owner of the group channel.

Returns null | User
The owner of the group channel, or null if not found.
- Defined in work/revbot.js/revbot.js/src/struct/groupChannel.ts:122

Methods

_clone

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

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

add

add(user: UserResolvable): Promise<void>
Adds a user to the group channel.
Parameters
- user: UserResolvable
  The user to add to the group channel.
Returns Promise<void>
A promise that resolves when the user has been successfully added.
Example
```
await groupChannel.add(user);
```
- Defined in work/revbot.js/revbot.js/src/struct/groupChannel.ts:173

bulkDelete

bulkDelete(
messages: number | Map<string, Message> | MessageResolvable[],
): Promise<void>
Deletes multiple messages from this group channel.
Parameters
- messages: number | Map<string, Message> | MessageResolvable[]
  The messages to delete. This can be an array of message resolvables, a map of messages, or a number indicating how many recent messages to delete.
Returns Promise<void>
A promise that resolves when the messages have been successfully deleted.
Example
```
await groupChannel.bulkDelete(10); // Deletes the last 10 messages.
```
Implementation of TextBasedChannel.bulkDelete
- Defined in work/revbot.js/revbot.js/src/struct/groupChannel.ts:137

createInvite

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

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

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 Channel.delete
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:62

equals

equals(obj?: null | GroupChannel): boolean
Compares this object with another to determine if they are equal.
Parameters
- Optionalobj: null | GroupChannel
  The object to compare with.
Returns boolean
true if the objects are equal, otherwise false.
Inherited from Channel.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 Channel.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 Channel.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 Channel.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 Channel.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 Channel.isVoice
- Defined in work/revbot.js/revbot.js/src/struct/channel.ts:80

leave

leave(): Promise<void>
Leaves the group channel.

Returns Promise<void>
A promise that resolves when the group channel has been successfully left.
Example
```
await groupChannel.leave();
```
- Defined in work/revbot.js/revbot.js/src/struct/groupChannel.ts:206

remove

remove(user: UserResolvable): Promise<void>
Removes a user from the group channel.
Parameters
- user: UserResolvable
  The user to remove from the group channel.
Returns Promise<void>
A promise that resolves when the user has been successfully removed.
Example
```
await groupChannel.remove(user);
```
- Defined in work/revbot.js/revbot.js/src/struct/groupChannel.ts:190

send

send(options: string | MessageOptions): Promise<Message>
Sends a message to this group channel.
Parameters
- options: string | MessageOptions
  The message content or options for the message.
Returns Promise<Message>
A promise that resolves with the sent message.
Example
```
await groupChannel.send("Hello, group!");
```
Implementation of TextBasedChannel.send
- Defined in work/revbot.js/revbot.js/src/struct/groupChannel.ts:221

toString

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

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

Class GroupChannel

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_id: string

Description

channel_type: "Group"

Optionaldescription?: null | string

Description

Description

Optionallast_message_id?: null | string

Description

name: string

Description

Optionalnsfw?: boolean

Description

owner: string

Description

Optionalpermissions?: null | number

Description

recipients: string[]

Description

Returns GroupChannel

Properties

Readonlyclient

description

icon

id

lastMessageId

messages

name

nsfw

ownerId

permissions

Readonlytype

users

Accessors

createdAt

Returns Date

createdTimestamp

Returns number

lastMessage

Returns null | Message

owner

Returns null | User

Methods

_clone

Returns this

_update

Parameters

Returns this

add

Parameters

Returns Promise<void>

Example

bulkDelete

Parameters

Returns Promise<void>

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

`Optional`description?: null | string

`Optional`last_message_id?: null | string

`Optional`nsfw?: boolean

`Optional`permissions?: null | number

`Readonly`client

`Readonly`type