Class GlobalMemberManager

A class representing a manager for Discord server members.

Hierarchy

CacheableStructManager<string, Member>
- GlobalMemberManager

Index

Constructors

constructor

new GlobalMemberManager(client): GlobalMemberManager
Parameters
- client: Client
Returns GlobalMemberManager
Inherited from CacheableStructManager.constructor
- Defined in guilded.js/lib/managers/global/GlobalManager.ts:7

Properties

cache

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

`Readonly` client

client: Client

Accessors

shouldCacheSocialLinks

get shouldCacheSocialLinks(): boolean
Whether or not social links should be cached.

Returns boolean
- Defined in guilded.js/lib/managers/global/MemberManager.ts:17

Methods

ban

ban(serverId, userId): Promise<null | MemberBan>
Bans a member from a server.
Parameters
- serverId: string
  
  The ID of the server to ban the member from.
- userId: string
  
  The ID of the user to ban.
Returns Promise<null | MemberBan>
A Promise that resolves with the banned member, or null if the member was not cached.
- Defined in guilded.js/lib/managers/global/MemberManager.ts:97

fetch

fetch(serverId, userId, force?): Promise<Member>
Fetches a member from a server.
Parameters
- serverId: string
  
  The ID of the server to fetch the member from.
- userId: string
  
  The ID of the member to fetch.
- Optional force: boolean
  
  Whether to force a fetch from the API.
Returns Promise<Member>
A Promise that resolves with the fetched member.
- Defined in guilded.js/lib/managers/global/MemberManager.ts:29

fetchMany

fetchMany(serverId): Promise<Collection<string, PartialMember>>
Fetches all members from a server. Returned objects are partial members.
Parameters
- serverId: string
  
  The ID of the server to fetch members from.
Returns Promise<Collection<string, PartialMember>>
A Promise that resolves with a collection of partial members.
- Defined in guilded.js/lib/managers/global/MemberManager.ts:58

fetchSocialLinks

fetchSocialLinks(serverId, userId, type): Promise<SocialLinkPayload>
Fetch a member's social links.
Parameters
- serverId: string
  
  The ID of the server.
- userId: string
  
  The ID of the member.
- type: "twitch" | "bnet" | "psn" | "xbox" | "steam" | "origin" | "youtube" | "twitter" | "facebook" | "switch" | "patreon" | "roblox" | "epic"
  
  The type of social link to fetch.
Returns Promise<SocialLinkPayload>
A Promise that resolves with the member's social link.
- Defined in guilded.js/lib/managers/global/MemberManager.ts:188

getRoles

getRoles(serverId, userId): Promise<number[]>
Gets a list of the roles assigned to a member using the ID of the member.
Parameters
- serverId: string
  
  The ID of the server to get the member roles from.
- userId: string
  
  The ID of the member to get the roles for.
Returns Promise<number[]>
A Promise that resolves with an array of role IDs.
- Defined in guilded.js/lib/managers/global/MemberManager.ts:120

giveXP

giveXP(serverId, userId, amount): Promise<number>
Awards XP to a member.
Parameters
- serverId: string
  
  The ID of the server to award XP on.
- userId: string
  
  The ID of the member to award XP to.
- amount: number
  
  The amount of XP to award.
Returns Promise<number>
A Promise that resolves with the member's new total XP.
- Defined in guilded.js/lib/managers/global/MemberManager.ts:169

kick

kick(serverId, userId): Promise<null | Member>
Kicks a member from a server.
Parameters
- serverId: string
  
  The ID of the server to kick the member from.
- userId: string
  
  The ID of the member to kick.
Returns Promise<null | Member>
A Promise that resolves with the kicked member, or null if the member was not cached.
- Defined in guilded.js/lib/managers/global/MemberManager.ts:82

resetNickname

resetNickname(serverId, userId): Promise<void>
Deletes a member's nickname.
Parameters
- serverId: string
  
  The ID of the server to delete the member nickname from.
- userId: string
  
  The ID of the member to delete the nickname for.
Returns Promise<void>
A Promise that resolves with no value upon completion.
- Defined in guilded.js/lib/managers/global/MemberManager.ts:154

unban

unban(serverId, userId, removeBanIfCached?): Promise<null | MemberBan>
Unbans a user from a server.
Parameters
- serverId: string
  
  The ID of the server.
- userId: string
  
  The ID of the user.
- removeBanIfCached: boolean = false
  
  Whether to remove the ban from the cache if it exists.
Returns Promise<null | MemberBan>
A Promise that resolves with the unbanned member ban or null if it isn't cached.
- Defined in guilded.js/lib/managers/global/MemberManager.ts:109

updateNickname

updateNickname(serverId, userId, newNickname): Promise<string>
Updates a member's nickname. Returns the new name.
Parameters
- serverId: string
  
  The ID of the server to update the member nickname for.
- userId: string
  
  The ID of the member to update the nickname for.
- newNickname: string
  
  The new nickname for the member.
Returns Promise<string>
A Promise that resolves with the updated nickname.
- Defined in guilded.js/lib/managers/global/MemberManager.ts:136

Class GlobalMemberManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

Returns GlobalMemberManager

Properties

cache

Readonly client

Accessors

shouldCacheSocialLinks

Returns boolean

Methods

ban

Parameters

serverId: string

userId: string

Returns Promise<null | MemberBan>

fetch

Parameters

serverId: string

userId: string

Optional force: boolean

Returns Promise<Member>

fetchMany

Parameters

serverId: string

Returns Promise<Collection<string, PartialMember>>

fetchSocialLinks

Parameters

serverId: string

userId: string

type: "twitch" | "bnet" | "psn" | "xbox" | "steam" | "origin" | "youtube" | "twitter" | "facebook" | "switch" | "patreon" | "roblox" | "epic"

Returns Promise<SocialLinkPayload>

getRoles

Parameters

serverId: string

userId: string

Returns Promise<number[]>

giveXP

Parameters

serverId: string

userId: string

amount: number

Returns Promise<number>

kick

Parameters

serverId: string

userId: string

Returns Promise<null | Member>

resetNickname

Parameters

serverId: string

userId: string

Returns Promise<void>

unban

Parameters

serverId: string

userId: string

removeBanIfCached: boolean = false

Returns Promise<null | MemberBan>

updateNickname

Parameters

serverId: string

userId: string

newNickname: string

Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

`Readonly` client

`Optional` force: boolean