Class ServerMember

Represents a member of a server.

Hierarchy (View Summary)

Base
- ServerMember

Index

Constructors

constructor

new ServerMember(
    client: client,
    data: {
        _id: { server: string; user: string };
        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;
            };
        joined_at: string;
        nickname?: null
        | string;
        roles?: string[];
        timeout?: null | string;
    },
): ServerMember
Creates a new ServerMember instance.
Parameters
- client: client
  The client instance.
- data: {
      _id: { server: string; user: string };
      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;
          };
      joined_at: string;
      nickname?: null
      | string;
      roles?: string[];
      timeout?: null | string;
  }
  The raw data for the server member from the API.
  - _id: { server: string; user: string }
    Description
    Unique member id
    
    server: string
    Description
    Server Id
    
    user: string
    Description
    User Id
  - 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
    Avatar attachment
  - joined_at: string
    Description
    Time at which this user joined the server
  - Optionalnickname?: null | string
    Description
    Member's nickname
  - Optionalroles?: string[]
    Description
    Member's roles
  - Optionaltimeout?: null | string
    Description
    Timestamp this member is timed out until
Returns ServerMember
Overrides Base.constructor
- Defined in work/revbot.js/revbot.js/src/struct/serverMember.ts:27

Properties

avatar

avatar: null | Attachment = null

The avatar of the member, or null if none is set.

`Readonly`client

client: client

The client instance.

id

id: string

The unique identifier for the object.

nickname

nickname: null | string = null

The nickname of the member, or null if none is set.

serverId

serverId: string

The ID of the server this member belongs to.

Accessors

server

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

Returns Server
The server instance.
- Defined in work/revbot.js/revbot.js/src/struct/serverMember.ts:141

user

get user(): User
Retrieves the user associated with this server member.

Returns User
The user instance.
- Defined in work/revbot.js/revbot.js/src/struct/serverMember.ts:132

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

ban

ban(reason?: string): Promise<void>
Bans the server member.
Parameters
- Optionalreason: string
  The reason for the ban.
Returns Promise<void>
A promise that resolves when the member is banned.
Example
```
await member.ban("Violation of rules");
```
- Defined in work/revbot.js/revbot.js/src/struct/serverMember.ts:91

equals

equals(obj?: null | ServerMember): boolean
Compares this object with another to determine if they are equal.
Parameters
- Optionalobj: null | ServerMember
  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

kick

kick(): Promise<void>
Kicks the server member.

Returns Promise<void>
A promise that resolves when the member is kicked.
Example
```
await member.kick();
```
- Defined in work/revbot.js/revbot.js/src/struct/serverMember.ts:105

leave

leave(): Promise<void>
Leaves the server.

Returns Promise<void>
A promise that resolves when the member leaves the server.
Example
```
await member.leave();
```
- Defined in work/revbot.js/revbot.js/src/struct/serverMember.ts:119

setNickname

setNickname(nickname?: string): Promise<ServerMember>
Sets the nickname of the server member.
Parameters
- Optionalnickname: string
  The new nickname to set, or undefined to clear the nickname.
Returns Promise<ServerMember>
A promise that resolves with the updated server member instance.
Example
```
await member.setNickname("NewNickname");
```
- Defined in work/revbot.js/revbot.js/src/struct/serverMember.ts:75

toString

toString(): string
Converts the server member to a string representation.

Returns string
A string representation of the server member in the format <@userId>.
- Defined in work/revbot.js/revbot.js/src/struct/serverMember.ts:150

Class ServerMember

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_id: { server: string; user: string }

Description

server: string

Description

user: string

Description

Description

joined_at: string

Description

Optionalnickname?: null | string

Description

Optionalroles?: string[]

Description

Optionaltimeout?: null | string

Description

Returns ServerMember

Properties

avatar

Readonlyclient

id

nickname

serverId

Accessors

server

Returns Server

user

Returns User

Methods

_clone

Returns this

_update

Parameters

Returns this

ban

Parameters

Returns Promise<void>

Example

equals

Parameters

Returns boolean

kick

Returns Promise<void>

Example

leave

Returns Promise<void>

Example

setNickname

Parameters

Returns Promise<ServerMember>

Example

toString

Returns string

Settings

On This Page

`Optional`nickname?: null | string

`Optional`roles?: string[]

`Optional`timeout?: null | string

`Readonly`client