Class MemberManager

Hierarchy (View Summary)

BaseManager<MemberKey, Member>
- MemberManager

Index

Constructors

Properties

Methods

addRole fetch fetchAll fetchAllRoles kick removeNickname removeRole setNickname

Constructors

constructor

new MemberManager(client: Client): MemberManager
Parameters
- client: Client
Returns MemberManager
Inherited from BaseManager.constructor
- Defined in src/managers/BaseManager.ts:7

Properties

cache

cache: Collection<MemberKey, Member> = ...

client

client: Client

Methods

addRole

addRole(serverId: string, userId: string, roleId: number): Promise<void>
Add a role to a Guilded server's member.
Parameters
- serverId: string
  The ID of the Guilded server.
- userId: string
  The ID of the Guilded user.
- roleId: number
  The ID of the Guilded role.
Returns Promise<void>
- Defined in src/managers/MemberManager.ts:66

fetch

fetch(serverId: string, userId: string, forced?: boolean): Promise<Member>
Fetch a Guilded server's member.
Parameters
- serverId: string
  The ID of the Guilded server.
- userId: string
  The ID of the Guilded user.
- forced: boolean = false
  Whether to forcefully fetch the message from the API, or first attempt to find it in the cache.
Returns Promise<Member>
- Defined in src/managers/MemberManager.ts:35

fetchAll

fetchAll(serverId: string): Promise<ServerMemberSummaryPayload[]>
Fetch all of a Guilded server's members.
Parameters
- serverId: string
  The ID of the Guilded server.
Returns Promise<ServerMemberSummaryPayload[]>
- Defined in src/managers/MemberManager.ts:46

fetchAllRoles

fetchAllRoles(serverId: string, userId: string): Promise<number[]>
Fetch all roles within a Guilded server's member.
Parameters
- serverId: string
  The ID of the Guilded server.
- userId: string
  The ID of the Guilded user.
Returns Promise<number[]>
- Defined in src/managers/MemberManager.ts:85

kick

kick(serverId: string, userId: string): Promise<unknown>
Kick a member from a Guilded server.
Parameters
- serverId: string
  The ID of the Guilded server.
- userId: string
  The ID of the Guilded user.
Returns Promise<unknown>
- Defined in src/managers/MemberManager.ts:56

removeNickname

removeNickname(serverId: string, userId: string): Promise<unknown>
Remove the nickname of a Guilded server's member.
Parameters
- serverId: string
  The ID of the Guilded server.
- userId: string
  The ID of the Guilded user.
Returns Promise<unknown>
- Defined in src/managers/MemberManager.ts:25

removeRole

removeRole(serverId: string, userId: string, roleId: number): Promise<void>
Remove a role from a Guilded server's member.
Parameters
- serverId: string
  The ID of the Guilded server.
- userId: string
  The ID of the Guilded user.
- roleId: number
  The ID of the Guilded role.
Returns Promise<void>
- Defined in src/managers/MemberManager.ts:76

setNickname

setNickname(
    serverId: string,
    userId: string,
    nickname: string,
): Promise<{ nickname: string }>
Set the nickname of a Guilded server's member.
Parameters
- serverId: string
  The ID of the Guilded server.
- userId: string
  The ID of the Guilded user.
- nickname: string
  The nickname.
Returns Promise<{ nickname: string }>
- Defined in src/managers/MemberManager.ts:16