Class ServerMemberRouter

The server member router for the Guilded REST API.

Example

new ServerMemberRouter(rest);

Hierarchy

BaseRouter
- ServerMemberRouter

Index

Constructors

constructor

new ServerMemberRouter(rest: RESTManager): ServerMemberRouter
Parameters
- rest: RESTManager
  
  The REST API manager the router belongs to.
Returns ServerMemberRouter
Inherited from BaseRouter.constructor
- Defined in rest/dist/routers/BaseRouter.d.ts:9

Properties

`Readonly` rest

rest: RESTManager

Methods

addRole

addRole(serverId: string, memberId: string, roleId: number): Promise<void>
Add a role to a server member on Guilded.

Example
```
serverMembers.addRole('abc', 'abc', 123);
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to add the role to.
- roleId: number
  
  The ID of the role to add to the server member.
Returns Promise<void>
- Defined in rest/dist/routers/server/ServerMemberRouter.d.ts:92

awardXp

awardXp(serverId: string, memberId: string, amount: number): Promise<number>
Award XP to a server member on Guilded.

Returns
The total amount of XP the server member has.

Example
```
serverMembers.awardXp('abc', 'abc', 100);
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to award XP to.
- amount: number
  
  The amount of XP to award to the server member.
Returns Promise<number>
- Defined in rest/dist/routers/server/ServerMemberRouter.d.ts:58

fetch

fetch(serverId: string, memberId: string): Promise<APIServerMember>
Fetch a server member from Guilded.

Returns
The fetched server member.

Example
```
serverMembers.fetch('abc', 'abc');
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to fetch.
Returns Promise<APIServerMember>
- Defined in rest/dist/routers/server/ServerMemberRouter.d.ts:15
fetch(serverId: string): Promise<APIServerMember[]>
Fetch server members from Guilded.

Returns
The fetched server members.

Example
```
serverMembers.fetch('abc');
```
Parameters
- serverId: string
  
  The ID of the server the members belong to.
Returns Promise<APIServerMember[]>
- Defined in rest/dist/routers/server/ServerMemberRouter.d.ts:22

fetchRoles

fetchRoles(serverId: string, memberId: string): Promise<number[]>
Fetch a list of roles that a server member has on Guilded.

Returns
The IDs of roles the server member has.

Example
```
serverMembers.fetchRoles('abc', 'abc');
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to fetch the roles for.
Returns Promise<number[]>
- Defined in rest/dist/routers/server/ServerMemberRouter.d.ts:84

fetchSocialLink

fetchSocialLink(serverId: string, memberId: string, type: string): Promise<APISocialLink>
Fetch a social link for a server member on Guilded.

Returns
The fetched social link.

Example
```
serverMembers.fetchSocialLink('abc', 'abc', 'youtube');
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to fetch the social link for.
- type: string
  
  The type of social link to fetch.
Returns Promise<APISocialLink>
- Defined in rest/dist/routers/server/ServerMemberRouter.d.ts:76

kick

kick(serverId: string, memberId: string): Promise<void>
Kick a server member on Guilded.

Example
```
serverMembers.kick('abc', 'abc');
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to kick.
Returns Promise<void>
- Defined in rest/dist/routers/server/ServerMemberRouter.d.ts:49

removeNickname

removeNickname(serverId: string, memberId: string): Promise<void>
Remove the nickname of a server member on Guilded.

Example
```
serverMembers.removeNickname('abc', 'abc');
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to edit.
Returns Promise<void>
- Defined in rest/dist/routers/server/ServerMemberRouter.d.ts:42

removeRole

removeRole(serverId: string, memberId: string, roleId: number): Promise<void>
Remove a role from a server member on Guilded.

Example
```
serverMembers.removeRole('abc', 'abc', 123);
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to remove the role from.
- roleId: number
  
  The ID of the role to remove from the server member.
Returns Promise<void>
- Defined in rest/dist/routers/server/ServerMemberRouter.d.ts:100

setNickname

setNickname(serverId: string, memberId: string, nickname: string): Promise<string>
Set the nickname of a server member on Guilded.

Returns
The nickname that was set.

Example
```
serverMembers.setNickname('abc', 'abc', 'nickname');
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to edit.
- nickname: string
  
  The nickname of the server member.
Returns Promise<string>
- Defined in rest/dist/routers/server/ServerMemberRouter.d.ts:35

setXp

setXp(serverId: string, memberId: string, amount: number): Promise<number>
Set XP of a server member on Guilded.

Returns
The total amount of XP the server member has.

Example
```
serverMembers.setXp('abc', 'abc', 100);
```
Parameters
- serverId: string
  
  The ID of the server the member belongs to.
- memberId: string
  
  The ID of the server member to set XP for.
- amount: number
  
  The total XP of the server member.
Returns Promise<number>
- Defined in rest/dist/routers/server/ServerMemberRouter.d.ts:67

Class ServerMemberRouter

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rest: RESTManager

Returns ServerMemberRouter

Properties

Readonly rest

Methods

addRole

Example

Parameters

serverId: string

memberId: string

roleId: number

Returns Promise<void>

awardXp

Returns

Example

Parameters

serverId: string

memberId: string

amount: number

Returns Promise<number>

fetch

Returns

Example

Parameters

serverId: string

memberId: string

Returns Promise<APIServerMember>

Returns

Example

Parameters

serverId: string

Returns Promise<APIServerMember[]>

fetchRoles

Returns

Example

Parameters

serverId: string

memberId: string

Returns Promise<number[]>

fetchSocialLink

Returns

Example

Parameters

serverId: string

memberId: string

type: string

Returns Promise<APISocialLink>

kick

Example

Parameters

serverId: string

memberId: string

Returns Promise<void>

removeNickname

Example

Parameters

serverId: string

memberId: string

Returns Promise<void>

removeRole

Example

Parameters

serverId: string

memberId: string

roleId: number

Returns Promise<void>

setNickname

Returns

Example

Parameters

`Readonly` rest