Class ServerBanRouter

The server ban router for the Guilded REST API.

Example

new ServerBanRouter(rest);

Hierarchy

BaseRouter
- ServerBanRouter

Index

Constructors

constructor

new ServerBanRouter(rest: RESTManager): ServerBanRouter
Parameters
- rest: RESTManager
  
  The REST API manager the router belongs to.
Returns ServerBanRouter
Inherited from BaseRouter.constructor
- Defined in rest/dist/routers/BaseRouter.d.ts:9

Properties

`Readonly` rest

rest: RESTManager

Methods

create

create(serverId: string, memberId: string, reason?: string): Promise<APIServerBan>
Create a server ban on Guilded.

Returns
The created server ban.

Example
```
serverBans.create('abc', 'abc', 'Spamming');
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to ban.
- Optional reason: string
  
  The reason of the server ban.
Returns Promise<APIServerBan>
- Defined in rest/dist/routers/server/ServerBanRouter.d.ts:35

delete

delete(serverId: string, memberId: string): Promise<void>
Delete a server ban from Guilded.

Example
```
serverBans.delete('abc', 'abc');
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to unban.
Returns Promise<void>
- Defined in rest/dist/routers/server/ServerBanRouter.d.ts:42

fetch

fetch(serverId: string, banId: string): Promise<APIServerBan>
Fetch a server ban from Guilded.

Returns
The fetched server ban.

Example
```
serverBans.fetch('abc', 'abc');
```
Parameters
- serverId: string
  
  The ID of the server the ban belong to.
- banId: string
  
  The ID of the server ban to fetch.
Returns Promise<APIServerBan>
- Defined in rest/dist/routers/server/ServerBanRouter.d.ts:15
fetch(serverId: string): Promise<APIServerBan[]>
Fetch server bans from Guilded.

Returns
The fetched server bans.

Example
```
serverBans.fetch('abc');
```
Parameters
- serverId: string
  
  The ID of the server the bans belong to.
Returns Promise<APIServerBan[]>
- Defined in rest/dist/routers/server/ServerBanRouter.d.ts:22

Class ServerBanRouter

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rest: RESTManager

Returns ServerBanRouter

Properties

Readonly rest

Methods

create

Returns

Example

Parameters

serverId: string

memberId: string

Optional reason: string

Returns Promise<APIServerBan>

delete

Example

Parameters

serverId: string

memberId: string

Returns Promise<void>

fetch

Returns

Example

Parameters

serverId: string

banId: string

Returns Promise<APIServerBan>

Returns

Example

Parameters

serverId: string

Returns Promise<APIServerBan[]>

Settings

Member Visibility

Theme

`Readonly` rest

`Optional` reason: string