Class ServerMemberRole

Represents a server member role on Guilded.

Example

new ServerMemberRole(member, rawRole);

Hierarchy

ServerRole
- ServerMemberRole

Index

Constructors

constructor

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

Properties

`Readonly` client

client: Client

The client the data model belongs to.

`Readonly` id

id: number

The ID of the structure.

`Readonly` member

member: ServerMember

The server member the role belongs to.

`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
Overrides ServerRole.isCached
- Defined in guilded.ts/src/structures/server/ServerMemberRole.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>
Inherited from ServerRole.awardXp
- Defined in guilded.ts/src/structures/server/ServerRole.ts:33

remove

remove(): Promise<ServerRole>
Remove the role from the server member.

Returns
The removed role.

Example
```
role.remove();
```
Returns Promise<ServerRole>
- Defined in guilded.ts/src/structures/server/ServerMemberRole.ts:33

Class ServerMemberRole

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

member: ServerMember

raw: {
id: number;
}

id: number

cache: boolean = ...

Returns ServerMemberRole

Properties

`Readonly` client

`Readonly` id

`Readonly` member

`Readonly` raw

Type declaration

id: number

`Readonly` server

Accessors

isCached

Returns boolean

Methods

awardXp

Example

Parameters

amount: number

Returns Promise<void>

remove

Returns

Example

Returns Promise<ServerRole>

Settings

Member Visibility

Theme

Class ServerMemberRole

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

member: ServerMember

raw: { id: number; }

id: number

cache: boolean = ...

Returns ServerMemberRole

Properties

Readonly client

Readonly id

Readonly member

Readonly raw

Type declaration

id: number

Readonly server

Accessors

isCached

Returns boolean

Methods

awardXp

Example

Parameters

amount: number

Returns Promise<void>

remove

Returns

Example

Returns Promise<ServerRole>

Settings

Member Visibility

Theme

raw: {
id: number;
}

`Readonly` client

`Readonly` id

`Readonly` member

`Readonly` raw

`Readonly` server