Class Server

Server Class

Hierarchy

  • Server

Constructors

constructor

Properties

#collection #synced id

Accessors

$exists analytics animatedIconURL banner bannerURL categories channelIds channels createdAt defaultChannel defaultPermissions description discoverable flags icon iconURL mature member mentions name orderedChannels orderedRoles owner ownerId permission roles systemMessages unread

Methods

$delete ack banUser createChannel createEmoji createRole delete deleteRole edit editRole fetchBans fetchEmojis fetchInvites fetchMember fetchMembers getMember havePermission kickUser orPermission queryMembersExperimental resetSyncStatus setPermissions syncMembers toString unbanUser

Constructors

constructor

Properties

Private Readonly #collection

#collection: ServerCollection

Private #synced

#synced: undefined | "partial" | "full"

Readonly id

id: string

Accessors

$exists

analytics

animatedIconURL

  • get animatedIconURL(): undefined | string

  • URL to the server's animated icon

    Returns undefined | string

banner

bannerURL

  • get bannerURL(): undefined | string

  • URL to the server's banner

    Returns undefined | string

categories

  • get categories(): undefined | {
        channels: string[];
        id: string;
        title: string;
    }[]

  • Categories

    Returns undefined | {
        channels: string[];
        id: string;
        title: string;
    }[]

channelIds

channels

createdAt

defaultChannel

defaultPermissions

description

discoverable

  • get discoverable(): boolean

  • Whether this server is publicly discoverable

    Returns boolean

flags

icon

iconURL

mature

member

mentions

  • get mentions(): string[]

  • Find all message IDs of unread messages

    Returns

    Array of message IDs which are unread

    Returns string[]

name

orderedChannels

  • get orderedChannels(): (Omit<{
        channels: string[];
        id: string;
        title: string;
    }, "channels"> & {
        channels: Channel[];
    })[]

  • Get an array of ordered categories with their respective channels. Uncategorised channels are returned in id="default" category.

    Returns (Omit<{
        channels: string[];
        id: string;
        title: string;
    }, "channels"> & {
        channels: Channel[];
    })[]

orderedRoles

  • get orderedRoles(): {
        colour?: null | string;
        hoist?: boolean;
        id: string;
        name: string;
        permissions: {
            a: number;
            d: number;
        };
        rank?: number;
    }[]

  • Get an ordered array of roles with their IDs attached. The highest ranking roles will be first followed by lower ranking roles. This is dictated by the "rank" property which is smaller for higher priority roles.

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

owner

ownerId

permission

  • get permission(): number

  • Permission the currently authenticated user has against this server

    Returns number

roles

  • get roles(): ReactiveMap<string, {
        colour?: null | string;
        hoist?: boolean;
        name: string;
        permissions: {
            a: number;
            d: number;
        };
        rank?: number;
    }>

  • Roles

    Returns ReactiveMap<string, {
        colour?: null | string;
        hoist?: boolean;
        name: string;
        permissions: {
            a: number;
            d: number;
        };
        rank?: number;
    }>

systemMessages

  • get systemMessages(): undefined | {
        user_banned?: null | string;
        user_joined?: null | string;
        user_kicked?: null | string;
        user_left?: null | string;
    }

  • System message channels

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

unread

Methods

$delete

  • $delete(leaveEvent?: boolean): void

  • Delete the underlying server

    Parameters

    • Optional leaveEvent: boolean

      Whether we are leaving

    Returns void

ack

banUser

createChannel

  • Create a channel

    Returns

    The newly-created channel

    Parameters

    • data: {
          description?: null | string;
          name: string;
          nsfw?: null | boolean;
          type?: "Text" | "Voice";
      }

      Channel create route data

      • Optional description?: null | string

        Description

        Channel description

      • name: string

        Description

        Channel name

      • Optional nsfw?: null | boolean

        Description

        Whether this channel is age restricted

      • Optional type?: "Text" | "Voice"

        Description

        Channel type

        Default

        Text

    Returns Promise<Channel>

createEmoji

  • Create an emoji on the server

    Parameters

    • autumnId: string

      Autumn Id

    • options: Omit<{
          name: string;
          nsfw?: boolean;
          parent: {
              id: string;
              type: "Server";
          } | {
              type: "Detached";
          };
      }, "parent">

      Options

    Returns Promise<Emoji>

createRole

  • Create role

    Parameters

    • name: string

      Role name

    Returns Promise<{
        id: string;
        role: {
            colour?: null | string;
            hoist?: boolean;
            name: string;
            permissions: {
                a: number;
                d: number;
            };
            rank?: number;
        };
    }>

delete

  • Delete or leave a server

    Parameters

    • Optional leaveSilently: boolean

      Whether to not send a message on leave

    Returns Promise<void>

deleteRole

  • Delete role

    Parameters

    • roleId: string

      Role ID

    Returns Promise<undefined>

edit

  • Edit a server

    Parameters

    • data: {
          analytics?: null | boolean;
          banner?: null | string;
          categories?: null | {
              channels: string[];
              id: string;
              title: string;
          }[];
          description?: null | string;
          discoverable?: null | boolean;
          flags?: null | number;
          icon?: null | string;
          name?: null | string;
          remove?: null | ("Description" | "Icon" | "Categories" | "SystemMessages" | "Banner")[];
          system_messages?: null | {
              user_banned?: null | string;
              user_joined?: null | string;
              user_kicked?: null | string;
              user_left?: null | string;
          };
      }

      Changes

      • Optional analytics?: null | boolean

        Description

        Whether analytics should be collected for this server

        Must be enabled in order to show up on Revolt Discover.

      • Optional banner?: null | string

        Description

        Attachment Id for banner

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

        Description

        Category structure for server

      • Optional description?: null | string

        Description

        Server description

      • Optional discoverable?: null | boolean

        Description

        Whether this server is public and should show up on Revolt Discover

      • Optional flags?: null | number

        Format: int32

        Description

        Bitfield of server flags

      • Optional icon?: null | string

        Description

        Attachment Id for icon

      • Optional name?: null | string

        Description

        Server name

      • Optional remove?: null | ("Description" | "Icon" | "Categories" | "SystemMessages" | "Banner")[]

        Description

        Fields to remove from server object

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

        Description

        System message configuration

    Returns Promise<void>

editRole

  • Edit a role

    Parameters

    • roleId: string

      Role ID

    • data: {
          colour?: null | string;
          hoist?: null | boolean;
          name?: null | string;
          rank?: null | number;
          remove?: null | "Colour"[];
      }

      Role editing route data

      • Optional colour?: null | string

        Description

        Role colour

      • Optional hoist?: null | boolean

        Description

        Whether this role should be displayed separately

      • Optional name?: null | string

        Description

        Role name

      • Optional rank?: null | number

        Format: int64

        Description

        Ranking position

        Smaller values take priority.

      • Optional remove?: null | "Colour"[]

        Description

        Fields to remove from role object

    Returns Promise<{
        colour?: null | string;
        hoist?: boolean;
        name: string;
        permissions: {
            a: number;
            d: number;
        };
        rank?: number;
    }>

fetchBans

fetchEmojis

fetchInvites

fetchMember

fetchMembers

getMember

  • Helper function to retrieve cached server member by their ID in this server

    Returns

    Server Member (if cached)

    Parameters

    • userId: string

      User's ID

    Returns undefined | ServerMember

havePermission

  • Check whether we have a given permission in a server

    Returns

    Whether we have this permission

    Parameters

    • Rest ...permission: ("Video" | "Masquerade" | "ManageChannel" | "ManageServer" | "ManagePermissions" | "ManageRole" | "ManageCustomisation" | "KickMembers" | "BanMembers" | "TimeoutMembers" | "AssignRoles" | "ChangeNickname" | "ManageNicknames" | "ChangeAvatar" | "RemoveAvatars" | "ViewChannel" | "ReadMessageHistory" | "SendMessage" | "ManageMessages" | "ManageWebhooks" | "InviteOthers" | "SendEmbeds" | "UploadFiles" | "React" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "GrantAllSafe")[]

      Permission Names

    Returns boolean

kickUser

orPermission

  • Check whether we have at least one of the given permissions in a server

    Returns

    Whether we have one of the permissions

    Parameters

    • Rest ...permission: ("Video" | "Masquerade" | "ManageChannel" | "ManageServer" | "ManagePermissions" | "ManageRole" | "ManageCustomisation" | "KickMembers" | "BanMembers" | "TimeoutMembers" | "AssignRoles" | "ChangeNickname" | "ManageNicknames" | "ChangeAvatar" | "RemoveAvatars" | "ViewChannel" | "ReadMessageHistory" | "SendMessage" | "ManageMessages" | "ManageWebhooks" | "InviteOthers" | "SendEmbeds" | "UploadFiles" | "React" | "Connect" | "Speak" | "MuteMembers" | "DeafenMembers" | "MoveMembers" | "GrantAllSafe")[]

      Permission Names

    Returns boolean

queryMembersExperimental

  • Query members from a server by name

    Returns

    List of the server's members and their user objects

    Parameters

    • query: string

      Name

    Returns Promise<{
        members: ServerMember[];
        users: User[];
    }>

resetSyncStatus

setPermissions

  • Set role permissions

    Parameters

    • roleId: string = "default"

      Role Id, set to 'default' to affect all users

    • permissions: number | {
          allow: number;
          deny: number;
      }

      Permission value

    Returns Promise<{
        _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]: components["schemas"]["Role"];
        };
        system_messages?: null | {
            user_banned?: null | string;
            user_joined?: null | string;
            user_kicked?: null | string;
            user_left?: null | string;
        };
    }>

syncMembers

  • Optimised member fetch route

    Parameters

    • Optional excludeOffline: boolean

    Returns Promise<void>

toString

unbanUser

  • Pardon user's ban

    Parameters

    • user: string | User

      User

    Returns Promise<undefined>

On This Page

Generated using TypeDoc