Class GlobalGroupManager

Manager for interacting with Groups on Guilded.

Hierarchy

CacheableStructManager<string, Group>
- GlobalGroupManager

Index

Constructors

Properties

Methods

addMember create delete fetch fetchMany removeMember update

Constructors

constructor

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

Properties

cache

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

`Readonly` client

client: Client

Methods

addMember

addMember(groupId, userId): Promise<void>
Adds a member to a group.
Parameters
- groupId: string
  
  The ID of the group.
- userId: string
  
  The ID of the user to add.
Returns Promise<void>
A Promise that resolves when the operation is complete.
- Defined in guilded.js/lib/managers/global/GroupManager.ts:107

create

create(serverId, options): Promise<Group>
Creates a group.
Parameters
- serverId: string
  
  The ID of the server to create the group in.
- options: {}
  
  The options for the group to create.
Returns Promise<Group>
A Promise that resolves with the created group.
- Defined in guilded.js/lib/managers/global/GroupManager.ts:18

delete

delete(serverId, groupId): Promise<void>
Delete a group
Parameters
- serverId: string
  
  The ID of the server to delete the group from.
- groupId: string
  
  The ID of the group to delete.
Returns Promise<void>
A Promise that resolves when the operation is complete.
- Defined in guilded.js/lib/managers/global/GroupManager.ts:92

fetch

fetch(serverId, groupId): Promise<Group>
Fetch a group
Parameters
- serverId: string
  
  The ID of the server to fetch the group from.
- groupId: string
  
  The ID of the group to fetch.
Returns Promise<Group>
A Promise that resolves with the fetched group.
- Defined in guilded.js/lib/managers/global/GroupManager.ts:35

fetchMany

fetchMany(serverId): Promise<Collection<string, Group>>
Fetch all the groups in a server
Parameters
- serverId: string
  
  The ID of the server to fetch the groups from.
Returns Promise<Collection<string, Group>>
A Promise that resolves a Collection containing the fetched groups.
- Defined in guilded.js/lib/managers/global/GroupManager.ts:51

removeMember

removeMember(groupId, userId): Promise<void>
Removes a member from a group.
Parameters
- groupId: string
  
  The ID of the group.
- userId: string
  
  The ID of the user to remove.
Returns Promise<void>
A Promise that resolves when the operation is complete.
- Defined in guilded.js/lib/managers/global/GroupManager.ts:121

update

update(serverId, groupId, options): Promise<Group>
Update a group
Parameters
- serverId: string
  
  The ID of the server to update the group in.
- groupId: string
  
  The ID of the group to update.
- options: {}
  
  The options to update the group with.
Returns Promise<Group>
A Promise that resolves with the updated group.
- Defined in guilded.js/lib/managers/global/GroupManager.ts:74

Generated using TypeDoc