Class ServerMemberRole

Represents a server member role on Guilded.

Example

new ServerMemberRole(member, rawRole);

Hierarchy

Constructors

constructor

Properties

client id member raw server

Accessors

isCached

Methods

awardXp remove

Constructors

constructor

  • Parameters

    • member: ServerMember

      The server member the role belongs to.

    • raw: {
          id: number;
      }

      The raw data of the role.

      • id: number
    • Optional cache: boolean

      Whether to cache the server member role.

    Returns ServerMemberRole

Properties

Readonly client

client: Client

Readonly id

id: number

Readonly member

member: ServerMember

Readonly raw

raw: {
    id: number;
}

Type declaration

  • id: number

Readonly server

server: Server

Accessors

isCached

  • get isCached(): boolean

  • Whether the role is cached.

    Returns boolean

Methods

awardXp

  • Award XP to the role.

    Example

    role.awardXp(100);

    Parameters

    • amount: number

      The amount of XP to award to the role.

    Returns Promise<void>

remove

  • Remove the role from the server member.

    Returns

    The removed role.

    Example

    role.remove();

    Returns Promise<ServerRole>

Settings

Member Visibility

Theme