Class ServerRole

Represents a server role on Guilded.

Example

new ServerRole(server, rawRole);

Hierarchy

Base<number>
- ServerRole
  - ServerMemberRole

Index

Constructors

constructor

new ServerRole(server: Server, raw: {
id: number;
}, cache?: boolean): ServerRole
Parameters
- server: Server
  
  The server the role belongs to.
- raw: {
  id: number;
  }
  
  The raw data of the role.
  - id: number
- cache: boolean = ...
  
  Whether to cache the server role.
Returns ServerRole
Overrides Base.constructor
- Defined in guilded.ts/src/structures/server/ServerRole.ts:14

Properties

`Readonly` client

client: Client

The client the data model belongs to.

`Readonly` id

id: number

The ID of the structure.

`Readonly` raw

raw: {
id: number;
}

The raw data of the role.

Type declaration

id: number

`Readonly` server

server: Server

The server the role belongs to.

Accessors

isCached

get isCached(): boolean
Whether the role is cached.

Returns boolean
- Defined in guilded.ts/src/structures/server/ServerRole.ts:24

Methods

awardXp

awardXp(amount: number): Promise<void>
Award XP to the role.

Example
```
role.awardXp(100);
```
Parameters
- amount: number
  
  The amount of XP to award to the role.
Returns Promise<void>
- Defined in guilded.ts/src/structures/server/ServerRole.ts:33

Class ServerRole

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

server: Server

raw: {
id: number;
}

id: number

cache: boolean = ...

Returns ServerRole

Properties

`Readonly` client

`Readonly` id

`Readonly` raw

Type declaration

id: number

`Readonly` server

Accessors

isCached

Returns boolean

Methods

awardXp

Example

Parameters

amount: number

Returns Promise<void>

Settings

Member Visibility

Theme

Class ServerRole

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

server: Server

raw: { id: number; }

id: number

cache: boolean = ...

Returns ServerRole

Properties

Readonly client

Readonly id

Readonly raw

Type declaration

id: number

Readonly server

Accessors

isCached

Returns boolean

Methods

awardXp

Example

Parameters

amount: number

Returns Promise<void>

Settings

Member Visibility

Theme

raw: {
id: number;
}

`Readonly` client

`Readonly` id

`Readonly` raw

`Readonly` server