Class Server

Represents a server (guild) in the client.

Hierarchy (View Summary)

Base
- Server

Index

Constructors

Constructors

constructor

new Server(
    client: client,
    data: {
        _id: string;
        analytics?: boolean;
        banner?:
            | 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;
            };
        categories?: null
        | { channels: string[]; id: string; title: string }[];
        channels: string[];
        default_permissions: number;
        description?: null | string;
        discoverable?: boolean;
        flags?: number;
        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;
        owner: string;
        roles?: {
            [key: string]: {
                colour?: null
                | string;
                hoist?: boolean;
                name: string;
                permissions: { a: number; d: number };
                rank?: number;
            };
        };
        system_messages?: | null
        | {
            user_banned?: null
            | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        };
    },
): Server
Creates a new Server instance.
Parameters
- client: client
  The client instance.
- data: {
      _id: string;
      analytics?: boolean;
      banner?:
          | 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;
          };
      categories?: null
      | { channels: string[]; id: string; title: string }[];
      channels: string[];
      default_permissions: number;
      description?: null | string;
      discoverable?: boolean;
      flags?: number;
      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;
      owner: string;
      roles?: {
          [key: string]: {
              colour?: null
              | string;
              hoist?: boolean;
              name: string;
              permissions: { a: number; d: number };
              rank?: number;
          };
      };
      system_messages?: | null
      | {
          user_banned?: null
          | string;
          user_joined?: null | string;
          user_kicked?: null | string;
          user_left?: null | string;
      };
  }
  The raw data for the server from the API.
  - _id: string
    Description
    Unique Id
  - Optionalanalytics?: boolean
    Description
    Whether to enable analytics
  - Optionalbanner?:
        | 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
    Banner attachment
  - Optionalcategories?: null | { channels: string[]; id: string; title: string }[]
    Description
    Categories for this server
  - channels: string[]
    Description
    Channels within this server
  - default_permissions: number
    Format: int64
    
    Description
    Default set of server and channel permissions
  - Optionaldescription?: null | string
    Description
    Description for the server
  - Optionaldiscoverable?: boolean
    Description
    Whether this server should be publicly discoverable
  - Optionalflags?: number
    Format: uint32
    
    Description
    Bitfield of server flags
  - 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
    Icon attachment
  - name: string
    Description
    Name of the server
  - Optionalnsfw?: boolean
    Description
    Whether this server is flagged as not safe for work
  - owner: string
    Description
    User id of the owner
  - Optionalroles?: {
        [key: string]: {
            colour?: null | string;
            hoist?: boolean;
            name: string;
            permissions: { a: number; d: number };
            rank?: number;
        };
    }
    Description
    Roles for this server
  - Optionalsystem_messages?:
        | null
        | {
            user_banned?: null
            | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        }
    Description
    Configuration for sending system event messages
Returns Server
Overrides Base.constructor
- Defined in work/revbot.js/revbot.js/src/struct/server.ts:65

Properties

analytics

analytics: boolean = false

Whether analytics are enabled for the server.

banner: null | Attachment = null

The banner of the server, or null if none is set.

channels

channels: ServerChannelManager = ...

Manages the channels of the server.

`Readonly`client

client: client

The client instance.

description

description: null | string = null

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

discoverable

discoverable: boolean = false

Whether the server is discoverable.

emojis

emojis: Map<string, Emoji> = ...

the emojies associated with the server

icon

icon: null | Attachment = null

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

id

id: string

The unique identifier for the object.

members

members: ServerMemberManager = ...

Manages the members of the server.

name

name: string

The name of the server.

nsfw

nsfw: boolean = false

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

ownerId

ownerId: string

The ID of the user who owns the server.

permissions

permissions: ServerPermissions

The default permissions for the server.

roles

roles: RoleManager = ...

Manages the roles of the server.

Accessors

createdAt

get createdAt(): Date
Gets the creation date of the server.

Returns Date
The date when the server was created.
- Defined in work/revbot.js/revbot.js/src/struct/server.ts:157

createdTimestamp

get createdTimestamp(): number
Gets the creation timestamp of the server in milliseconds.

Returns number
The timestamp of when the server was created.
- Defined in work/revbot.js/revbot.js/src/struct/server.ts:166

me

get me(): null | ServerMember
Retrieves the current user's member instance in the server.

Returns null | ServerMember
The current user's member instance, or null if not found.
- Defined in work/revbot.js/revbot.js/src/struct/server.ts:148

owner

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

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

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 | Server): boolean
Compares this object with another to determine if they are equal.
Parameters
- Optionalobj: null | Server
  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 server to a string representation.

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

Class Server

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_id: string

Description

Optionalanalytics?: boolean

Description

Description

Optionalcategories?: null | { channels: string[]; id: string; title: string }[]

Description

channels: string[]

Description

default_permissions: number

Description

Optionaldescription?: null | string

Description

Optionaldiscoverable?: boolean

Description

Optionalflags?: number

Description

Description

name: string

Description

Optionalnsfw?: boolean

Description

owner: string

Description

Optionalroles?: { [key: string]: { colour?: null | string; hoist?: boolean; name: string; permissions: { a: number; d: number }; rank?: number; };}

Description

Optionalsystem_messages?: | null | { user_banned?: null | string; user_joined?: null | string; user_kicked?: null | string; user_left?: null | string; }

Description

Returns Server

Properties

analytics

banner

categories

channels

Readonlyclient

description

discoverable

emojis

icon

id

members

name

nsfw

ownerId

permissions

roles

Accessors

createdAt

Returns Date

createdTimestamp

Returns number

me

Returns null | ServerMember

owner

Returns null | User

Methods

_clone

Returns this

_update

Parameters

Returns this

equals

Parameters

Returns boolean

toString

Returns string

Settings

On This Page

`Optional`analytics?: boolean

`Optional`categories?: null | { channels: string[]; id: string; title: string }[]

`Optional`description?: null | string

`Optional`discoverable?: boolean

`Optional`flags?: number

`Optional`nsfw?: boolean

`Optional`roles?: {
[key: string]: {
colour?: null | string;
hoist?: boolean;
name: string;
permissions: { a: number; d: number };
rank?: number;
};
}

`Optional`system_messages?:
| null
| {
user_banned?: null
| string;
user_joined?: null | string;
user_kicked?: null | string;
user_left?: null | string;
}

`Readonly`client