Class ServerBan

Represents a server ban on Guilded.

Example

new ServerBan(server, rawBan);

Hierarchy

Constructors

constructor

Properties

client createdAt createdBy id raw reason? server user

Accessors

author createdTimestamp isCached

Methods

fetch fetchAuthor remove

Constructors

constructor

  • Parameters

    • server: Server

      The server the ban belongs to.

    • raw: APIServerBan

      The raw data of the server ban.

    • Optional cache: boolean

      Whether to cache the server ban.

    Returns ServerBan

Properties

Readonly client

client: Client

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

Readonly raw

raw: APIServerBan

Optional Readonly reason

reason?: string

The reason of the ban.

Readonly server

server: Server

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

createdTimestamp

  • get createdTimestamp(): number

  • The timestamp the ban was created.

    Returns number

isCached

  • get isCached(): boolean

  • Whether the server ban is cached.

    Returns boolean

Methods

fetch

  • 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>

fetchAuthor

  • 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>

remove

  • Remove the server ban from the server.

    Example

    ban.remove();

    Returns Promise<void>

Settings

Member Visibility

Theme