Class ServerManager

Hierarchy (View Summary)

BaseManager<string, Server>
- ServerManager

Index

Constructors

Properties

Methods

ban fetch getAllBans getBan unban

Constructors

constructor

new ServerManager(client: Client): ServerManager
Parameters
- client: Client
Returns ServerManager
Inherited from BaseManager.constructor
- Defined in src/managers/BaseManager.ts:7

Properties

cache

cache: Collection<string, Server> = ...

client

client: Client

Methods

ban

ban(serverId: string, userId: string, reason?: string): Promise<Ban>
Ban a Guilded member from a Guilded server.
Parameters
- serverId: string
  The ID of the Guilded server.
- userId: string
  The ID of the Guilded user.
- Optionalreason: string
  The reason.
Returns Promise<Ban>
The ban.
- Defined in src/managers/ServerManager.ts:26

fetch

fetch(serverId: string, forced?: boolean): Promise<Server>
Fetch a Guilded server.
Parameters
- serverId: string
  The ID of the Guilded server.
- forced: boolean = false
  Whether to forcefully fetch the server from the API, or first attempt to find it in the cache.
Returns Promise<Server>
The server.
- Defined in src/managers/ServerManager.ts:12

getAllBans

getAllBans(serverId: string): Promise<Ban[]>
Parameters
- serverId: string
Returns Promise<Ban[]>
- Defined in src/managers/ServerManager.ts:45

getBan

getBan(serverId: string, userId: string): Promise<Ban>
Parameters
- serverId: string
- userId: string
Returns Promise<Ban>
- Defined in src/managers/ServerManager.ts:40

unban

unban(serverId: string, userId: string): Promise<void>
Unban a Guilded member from a Guilded server.
Parameters
- serverId: string
  The ID of the Guilded server.
- userId: string
  The ID of the Guilded user.
Returns Promise<void>
- Defined in src/managers/ServerManager.ts:36