Class ServerGroup

constructor

• new ServerGroup(query: Query, data: RawServerGroup): ServerGroup

  Parameters

  • query: Query
  • data: RawServerGroup

  Returns ServerGroup

iconId

memberAddPower

memberRemovePower

modifyPower

name

nameMode

saveDb

sortId

type

partial

• get partial(): boolean

  Checks if the server group is partially filled.

  Returns boolean

  Whether the server group is partially filled.

_patch

• _patch(data: Partial<RawServerGroup>): void

  Patches the server group with new data.

  Parameters

  • data: Partial<RawServerGroup>

    The new data to patch the server group with.

  Returns void

addClient

• addClient(client: ClientResolvable): Promise<void>

  Adds a client to the server group.

  Parameters

  • client: ClientResolvable

    The client to add.

  Returns Promise<void>

  A promise that resolves when the client has been added.

addPermission

• addPermission(options: ServerGroupAddPermissionOptions): Promise<void>

  Adds a permission to this server group. You can also edit the permission using this method.

  Parameters

  • options: ServerGroupAddPermissionOptions

    The options for adding or editing the permission.

  Returns Promise<void>

  A promise that resolves when the permission has been added or edited.

copy

• copy(options: ServerGroupCopyOptions_Create): Promise<ServerGroup>

  Copies this server group into a new server group.

  Parameters

  • options: ServerGroupCopyOptions_Create

    The options for copying the server group.

  Returns Promise<ServerGroup>

  The created server group.

• copy(options: ServerGroupCopyOptions_Target): Promise<null>

  Copies this server group into an existing server group.

  Parameters

  • options: ServerGroupCopyOptions_Target

    The options for copying the server group.

  Returns Promise<null>

  A promise that resolves when the server group has been copied.

delete

• delete(force?: boolean): Promise<void>

  Deletes the server group.

  Parameters

  • Optionalforce: boolean = false

    Whether to force the deletion. Force deletion will remove the server group from all clients.

  Returns Promise<void>

  A promise that resolves when the server group has been deleted.

fetchClientDatabaseIds

• fetchClientDatabaseIds(): Promise<number[]>

  Fetches the client database IDs from this server group.

  Returns Promise<number[]>

  A promise that resolves with the client database IDs.

fetchPermissions

• fetchPermissions(): Promise<Collection<number, Permission>>

  Fetches the permissions from this server group.

  Returns Promise<Collection<number, Permission>>

  A promise that resolves with the permissions.

removeClient

• removeClient(client: ClientResolvable): Promise<void>

  Removes a client from the server group.

  Parameters

  • client: ClientResolvable

    The client to remove.

  Returns Promise<void>

  A promise that resolves when the client has been removed.

removePermission

• removePermission(permission: string | PermissionResolvable): Promise<void>

  Removes a permission from this server group.

  Parameters

  • permission: string | PermissionResolvable

    The permission to remove. This can be a permission object, a permission ID (number), or a permission server ID (string, such as "i_channel_modify_power").

  Returns Promise<void>

  A promise that resolves when the permission has been removed.

rename

• rename(name: string): Promise<ServerGroup>

  Renames the server group.

  Parameters

  • name: string

    The new name for the server group.

  Returns Promise<ServerGroup>

  The updated server group.