Class Server

Server Class

Constructors

constructor

new Server(collection: ServerCollection, id: string): Server
Construct Server
Parameters
- collection: ServerCollection
  Collection
- id: string
  Id
Returns Server
- Defined in src/classes/Server.ts:50

Properties

`Readonly`id

id: string

Accessors

$exists

get $exists(): boolean
Whether this object exists

Returns boolean
- Defined in src/classes/Server.ts:65

analytics

get analytics(): boolean
Whether analytics are enabled for this server

Returns boolean
- Defined in src/classes/Server.ts:185

animatedIconURL

get animatedIconURL(): undefined | string
URL to the server's animated icon

Returns undefined | string
- Defined in src/classes/Server.ts:318

banner

get banner(): undefined | File
Banner

Returns undefined | File
- Defined in src/classes/Server.ts:116

bannerURL

get bannerURL(): undefined | string
URL to the server's banner

Returns undefined | string
- Defined in src/classes/Server.ts:325

channelIds

get channelIds(): ReactiveSet<string>
Channel IDs

Returns ReactiveSet<string>
- Defined in src/classes/Server.ts:123

channels

get channels(): Channel[]
Channels

Returns Channel[]
- Defined in src/classes/Server.ts:130

createdAt

get createdAt(): Date
Time when this server was created

Returns Date
- Defined in src/classes/Server.ts:72

defaultChannel

get defaultChannel(): undefined | Channel
Default channel for this server

Returns undefined | Channel
- Defined in src/classes/Server.ts:262

defaultPermissions

get defaultPermissions(): number
Default permissions

Returns number
- Defined in src/classes/Server.ts:171

description

get description(): undefined | string
Description

Returns undefined | string
- Defined in src/classes/Server.ts:102

discoverable

get discoverable(): boolean
Whether this server is publicly discoverable

Returns boolean
- Defined in src/classes/Server.ts:192

flags

get flags(): ServerFlags
Server flags

Returns ServerFlags
- Defined in src/classes/Server.ts:178

icon

get icon(): undefined | File
Icon

Returns undefined | File
- Defined in src/classes/Server.ts:109

iconURL

get iconURL(): undefined | string
URL to the server's icon

Returns undefined | string
- Defined in src/classes/Server.ts:311

mature

get mature(): boolean
Whether this server is marked as mature

Returns boolean
- Defined in src/classes/Server.ts:199

member

get member(): undefined | ServerMember
Own member object for this server

Returns undefined | ServerMember
- Defined in src/classes/Server.ts:332

mentions

get mentions(): string[]
Find all message IDs of unread messages

Returns string[]
Array of message IDs which are unread
- Defined in src/classes/Server.ts:300

name

get name(): string
Name

Returns string
- Defined in src/classes/Server.ts:95

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[];
    }
)[]
- Defined in src/classes/Server.ts:207

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;
}[]
- Defined in src/classes/Server.ts:272

owner

get owner(): undefined | User
Owner

Returns undefined | User
- Defined in src/classes/Server.ts:86

ownerId

get ownerId(): string
Owner's user ID

Returns string
- Defined in src/classes/Server.ts:79

permission

get permission(): number
Permission the currently authenticated user has against this server

Returns number
- Defined in src/classes/Server.ts:342

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;
    },
>
- Defined in src/classes/Server.ts:155

systemMessages

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

Returns
    | undefined
    | null
    | {
        user_banned?: null
        | string;
        user_joined?: null | string;
        user_kicked?: null | string;
        user_left?: null | string;
    }
- undefined
- null
- {
      user_banned?: null | string;
      user_joined?: null | string;
      user_kicked?: null | string;
      user_left?: null | string;
  }
  - Optionaluser_banned?: null | string
    Description
    ID of channel to send user banned messages in
  - Optionaluser_joined?: null | string
    Description
    ID of channel to send user join messages in
  - Optionaluser_kicked?: null | string
    Description
    ID of channel to send user kicked messages in
  - Optionaluser_left?: null | string
    Description
    ID of channel to send user left messages in
- Defined in src/classes/Server.ts:148

unread

get unread(): boolean
Check whether the server is currently unread

Returns boolean
Whether the server is unread
- Defined in src/classes/Server.ts:292

Methods

$delete

$delete(leaveEvent?: boolean): void
Delete the underlying server
Parameters
- OptionalleaveEvent: boolean
  Whether we are leaving
Returns void
- Defined in src/classes/Server.ts:420

ack

ack(): Promise<void>
Mark a server as read

Returns Promise<void>
- Defined in src/classes/Server.ts:458

banUser

banUser(
user: string | User | ServerMember,
options?: { reason?: null | string },
): Promise<ServerBan>
Ban user from this server
Parameters
- user: string | User | ServerMember
  User
- options: { reason?: null | string } = {}
  Ban options
  - Optionalreason?: null | string
    Description
    Ban reason
Returns Promise<ServerBan>
- Defined in src/classes/Server.ts:473

createChannel

createChannel(
    data: {
        description?: null | string;
        name: string;
        nsfw?: null | boolean;
        type?: "Text" | "Voice";
    },
): Promise<Channel>
Create a channel
Parameters
- data: {
      description?: null | string;
      name: string;
      nsfw?: null | boolean;
      type?: "Text" | "Voice";
  }
  Channel create route data
  - Optionaldescription?: null | string
    Description
    Channel description
  - name: string
    Description
    Channel name
  - Optionalnsfw?: null | boolean
    Description
    Whether this channel is age restricted
  - Optionaltype?: "Text" | "Voice"
    Description
    Channel type
    
    Default
    Text
Returns Promise<Channel>
The newly-created channel
- Defined in src/classes/Server.ts:388

createEmoji

createEmoji(
    autumnId: string,
    options: Omit<
        {
            name: string;
            nsfw?: boolean;
            parent: { id: string; type: "Server" }
            | { type: "Detached" };
        },
        "parent",
    >,
): Promise<Emoji>
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>
- Defined in src/classes/Server.ts:718

createRole

createRole(
    name: string,
): Promise<
    {
        id: string;
        role: {
            colour?: null
            | string;
            hoist?: boolean;
            name: string;
            permissions: { a: number; d: number };
            rank?: number;
        };
    },
>
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;
        };
    },
>
- Defined in src/classes/Server.ts:572

delete

delete(leaveSilently?: boolean): Promise<void>
Delete or leave a server
Parameters
- OptionalleaveSilently: boolean
  Whether to not send a message on leave
Returns Promise<void>
- Defined in src/classes/Server.ts:447

deleteEmoji

deleteEmoji(emojiId: string): Promise<void>
Delete emoji
Parameters
- emojiId: string
  Emoji ID
Returns Promise<void>
- Defined in src/classes/Server.ts:756

deleteRole

deleteRole(roleId: string): Promise<void>
Delete role
Parameters
- roleId: string
  Role ID
Returns Promise<void>
- Defined in src/classes/Server.ts:597

edit

edit(
    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;
            };
    },
): Promise<void>
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
  - Optionalanalytics?: null | boolean
    Description
    Whether analytics should be collected for this server
    
    Must be enabled in order to show up on Revolt Discover.
  - Optionalbanner?: null | string
    Description
    Attachment Id for banner
  - Optionalcategories?: null | { channels: string[]; id: string; title: string }[]
    Description
    Category structure for server
  - Optionaldescription?: null | string
    Description
    Server description
  - Optionaldiscoverable?: null | boolean
    Description
    Whether this server is public and should show up on Revolt Discover
  - Optionalflags?: null | number
    Format: int32
    
    Description
    Bitfield of server flags
  - Optionalicon?: null | string
    Description
    Attachment Id for icon
  - Optionalname?: null | string
    Description
    Server name
  - Optionalremove?: null | ("Description" | "Icon" | "Categories" | "SystemMessages" | "Banner")[]
    Description
    Fields to remove from server object
  - Optionalsystem_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>
- Defined in src/classes/Server.ts:401

editRole

editRole(
    roleId: string,
    data: {
        colour?: null | string;
        hoist?: null | boolean;
        name?: null | string;
        rank?: null | number;
        remove?: null | "Colour"[];
    },
): Promise<
    {
        colour?: null
        | string;
        hoist?: boolean;
        name: string;
        permissions: { a: number; d: number };
        rank?: number;
    },
>
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
  - Optionalcolour?: null | string
    Description
    Role colour
  - Optionalhoist?: null | boolean
    Description
    Whether this role should be displayed separately
  - Optionalname?: null | string
    Description
    Role name
  - Optionalrank?: null | number
    Format: int64
    
    Description
    Ranking position
    
    Smaller values take priority.
  - Optionalremove?: 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;
    },
>
- Defined in src/classes/Server.ts:586

fetchBans

fetchBans(): Promise<ServerBan[]>
Fetch a server's bans

Returns Promise<ServerBan[]>
An array of the server's bans.
- Defined in src/classes/Server.ts:537

fetchEmojis

fetchEmojis(): Promise<Emoji[]>
Fetch a server's emoji

Returns Promise<Emoji[]>
List of server emoji
- Defined in src/classes/Server.ts:740

fetchInvites

fetchInvites(): Promise<ChannelInvite[]>
Fetch a server's invites

Returns Promise<ChannelInvite[]>
An array of the server's invites
- Defined in src/classes/Server.ts:523

fetchMember

fetchMember(user: string | User): Promise<ServerMember>
Fetch a server member
Parameters
- user: string | User
  User
Returns Promise<ServerMember>
Server member object
- Defined in src/classes/Server.ts:608

fetchMembers

fetchMembers(): Promise<{ members: ServerMember[]; users: User[] }>
Fetch a server's members

Returns Promise<{ members: ServerMember[]; users: User[] }>
List of the server's members and their user objects
- Defined in src/classes/Server.ts:671

getMember

getMember(userId: string): undefined | ServerMember
Helper function to retrieve cached server member by their ID in this server
Parameters
- userId: string
  User's ID
Returns undefined | ServerMember
Server Member (if cached)
- Defined in src/classes/Server.ts:376

havePermission

havePermission(
    ...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"
    )[],
): boolean
Check whether we have a given permission in a server
Parameters
- ...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
Whether we have this permission
- Defined in src/classes/Server.ts:351

kickUser

kickUser(user: string | User | ServerMember): Promise<void>
Kick user from this server
Parameters
- user: string | User | ServerMember
  User
Returns Promise<void>
- Defined in src/classes/Server.ts:496

orPermission

orPermission(
    ...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"
    )[],
): boolean
Check whether we have at least one of the given permissions in a server
Parameters
- ...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
Whether we have one of the permissions
- Defined in src/classes/Server.ts:363

queryMembersExperimental

queryMembersExperimental(
query: string,
): Promise<{ members: ServerMember[]; users: User[] }>
Query members from a server by name
Parameters
- query: string
  Name
Returns Promise<{ members: ServerMember[]; users: User[] }>
List of the server's members and their user objects
- Defined in src/classes/Server.ts:692

resetSyncStatus

resetSyncStatus(): void
Reset member sync status

Returns void
- Defined in src/classes/Server.ts:663

setPermissions

setPermissions(
    roleId?: string,
    permissions: number | { allow: number; deny: number },
): 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]: {
                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;
        };
    },
>
Set role permissions
Parameters
- roleId: string = "default"
  Role Id, set to 'default' to affect all users
- permissions: number | { allow: number; deny: number }
  Permission value
  - number
  - { allow: number; deny: number }
    allow: number
    Format: uint64
    
    Description
    Allow bit flags
    
    deny: number
    Format: uint64
    
    Description
    Disallow bit flags
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]: {
                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;
        };
    },
>
- Defined in src/classes/Server.ts:558

syncMembers

syncMembers(excludeOffline?: boolean): Promise<void>
Optimised member fetch route
Parameters
- OptionalexcludeOffline: boolean
Returns Promise<void>
- Defined in src/classes/Server.ts:625

toString

toString(): string
Convert to string

Returns string
String
- Defined in src/classes/Server.ts:58

unbanUser

unbanUser(user: string | User): Promise<void>
Pardon user's ban
Parameters
- user: string | User
  User
Returns Promise<void>
- Defined in src/classes/Server.ts:512

Class Server

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Server

Properties

Readonlyid

Accessors

$exists

Returns boolean

analytics

Returns boolean

animatedIconURL

Returns undefined | string

banner

Returns undefined | File

bannerURL

Returns undefined | string

categories

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

channels: string[]

Description

id: string

Description

title: string

Description

channelIds

Returns ReactiveSet<string>

channels

Returns Channel[]

createdAt

Returns Date

defaultChannel

Returns undefined | Channel

defaultPermissions

Returns number

description

Returns undefined | string

discoverable

Returns boolean

flags

Returns ServerFlags

icon

Returns undefined | File

iconURL

Returns undefined | string

mature

Returns boolean

member

Returns undefined | ServerMember

mentions

Returns string[]

name

Returns string

orderedChannels

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

orderedRoles

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

owner

Returns undefined | User

ownerId

Returns string

permission

Returns number

roles

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

systemMessages

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

Optionaluser_banned?: null | string

Description

Optionaluser_joined?: null | string

Description

Optionaluser_kicked?: null | string

Description

Optionaluser_left?: null | string

`Readonly`id

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

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

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

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

`Optional`user_banned?: null | string

`Optional`user_joined?: null | string

`Optional`user_kicked?: null | string

`Optional`user_left?: null | string

`Optional`reason?: null | string

`Optional`description?: null | string

`Optional`nsfw?: null | boolean

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

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

`Optional`analytics?: null | boolean

`Optional`banner?: null | string

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

`Optional`description?: null | string

`Optional`discoverable?: null | boolean

`Optional`flags?: null | number

`Optional`icon?: null | string

`Optional`name?: null | string

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

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

`Optional`colour?: null | string

`Optional`hoist?: null | boolean