Class ServerBan

Represents a server ban on Guilded.

Example

new ServerBan(server, rawBan);

Hierarchy

Base
- ServerBan

Index

Constructors

constructor

new ServerBan(server: Server, raw: APIServerBan, cache?: boolean): ServerBan
Parameters
- server: Server
  
  The server the ban belongs to.
- raw: APIServerBan
  
  The raw data of the server ban.
- cache: boolean = ...
  
  Whether to cache the server ban.
Returns ServerBan
Overrides Base.constructor
- Defined in guilded.ts/src/structures/server/ServerBan.ts:26

Properties

`Readonly` client

client: Client

The client the data model belongs to.

`Readonly` createdAt

createdAt: Date

The date the ban was created.

`Readonly` createdBy

createdBy: string

The ID of the user that created the ban.

`Readonly` id

id: string

The ID of the structure.

`Readonly` raw

raw: APIServerBan

The raw data of the server ban.

`Optional` `Readonly` reason

reason?: string

The reason of the ban.

`Readonly` server

server: Server

The server the ban belongs to.

`Readonly` user

user: User

The user the ban belongs to.

Accessors

author

get author(): undefined | User
The user that created the server ban.

Returns undefined | User
- Defined in guilded.ts/src/structures/server/ServerBan.ts:45

createdTimestamp

get createdTimestamp(): number
The timestamp the ban was created.

Returns number
- Defined in guilded.ts/src/structures/server/ServerBan.ts:50

isCached

get isCached(): boolean
Whether the server ban is cached.

Returns boolean
- Defined in guilded.ts/src/structures/server/ServerBan.ts:40

Methods

fetch

fetch(options?: FetchOptions): Promise<ServerBan>
Fetch the server ban.

Returns
The fetched server ban.

Example
```
ban.fetch();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server ban with.
Returns Promise<ServerBan>
- Defined in guilded.ts/src/structures/server/ServerBan.ts:60

fetchAuthor

fetchAuthor(options?: FetchOptions): Promise<ServerMember>
Fetch the server member that created the ban.

Returns
The fetched server member.

Example
```
ban.fetchAuthor();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server member with.
Returns Promise<ServerMember>
- Defined in guilded.ts/src/structures/server/ServerBan.ts:70

remove

remove(): Promise<void>
Remove the server ban from the server.

Example
```
ban.remove();
```
Returns Promise<void>
- Defined in guilded.ts/src/structures/server/ServerBan.ts:78

Class ServerBan

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

server: Server

raw: APIServerBan

cache: boolean = ...

Returns ServerBan

Properties

Readonly client

Readonly createdAt

Readonly createdBy

Readonly id

Readonly raw

Optional Readonly reason

Readonly server

Readonly user

Accessors

author

Returns undefined | User

createdTimestamp

Returns number

isCached

Returns boolean

Methods

fetch

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<ServerBan>

fetchAuthor

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<ServerMember>

remove

Example

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` client

`Readonly` createdAt

`Readonly` createdBy

`Readonly` id

`Readonly` raw

`Optional` `Readonly` reason

`Readonly` server

`Readonly` user

`Optional` options: FetchOptions

`Optional` options: FetchOptions