Class GlobalUserManager

A manager for interacting with users. You can retrieve users from the .cache property. At this point in time, Users cache population is heavily reliant on the Member cache.

Hierarchy

CacheableStructManager<string, User>
- GlobalUserManager

Index

Constructors

Properties

Methods

fetchClient fetchServers

Constructors

constructor

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

Properties

cache

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

`Readonly` client

client: Client

Methods

fetchClient

fetchClient(force?): Promise<User>
Fetches client user.
Parameters
- Optional force: boolean
  
  Whether to force a fetch from the API.
Returns Promise<User>
A Promise that resolves with the fetched user.
- Defined in guilded.js/lib/managers/global/UserManager.ts:19

fetchServers

fetchServers(userId): Promise<Collection<string, Server>>
Fetches a user's servers (atm, only the logged in client is supported)
Parameters
- userId: string
  
  The ID of the user to fetch servers for.
Returns Promise<Collection<string, Server>>
A promise that resolves to a Collection with the returned servers.
- Defined in guilded.js/lib/managers/global/UserManager.ts:37

Generated using TypeDoc