Class GroupManager

Hierarchy (View Summary)

BaseManager<string, Group>
- GroupManager

Index

Constructors

Properties

Methods

addMember create delete fetch fetchAll removeMember update

Constructors

constructor

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

Properties

cache

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

client

client: Client

Methods

addMember

addMember(groupId: string, userId: string): Promise<void>
Add a Guilded member to a Guilded group.
Parameters
- groupId: string
  The ID of the Guilded group.
- userId: string
  The ID of the Guilded user.
Returns Promise<void>
- Defined in src/managers/GroupManager.ts:68

create

create(serverId: string, data: CreateGroupBody): Promise<Group>
Create a Guilded server group.
Parameters
- serverId: string
  The ID of the Guilded server to create the group in.
- data: CreateGroupBody
  Group data.
Returns Promise<Group>
The group.
- Defined in src/managers/GroupManager.ts:12

delete

delete(serverId: string, groupId: string): Promise<void>
Delete a Guilded server's group.
Parameters
- serverId: string
  The ID of the Guilded server.
- groupId: string
  The ID of the Guilded server's group.
Returns Promise<void>
- Defined in src/managers/GroupManager.ts:59

fetch

fetch(serverId: string, groupId: string, forced?: boolean): Promise<Group>
Fetch a Guilded server's group.
Parameters
- serverId: string
  The ID of the Guilded server.
- groupId: string
  The ID of the Guilded server's group.
- forced: boolean = false
  Whether to forcefully fetch the server from the API, or first attempt to find it in the cache.
Returns Promise<Group>
The group.
- Defined in src/managers/GroupManager.ts:34

fetchAll

fetchAll(serverId: string): Promise<Group[]>
Fetch all groups in a Guilded server.
Parameters
- serverId: string
  The ID of the Guilded server.
Returns Promise<Group[]>
The groups.
- Defined in src/managers/GroupManager.ts:22

removeMember

removeMember(groupId: string, userId: string): Promise<void>
Remove a member from a Guilded group.
Parameters
- groupId: string
  The ID of the Guilded group.
- userId: string
  The ID of the Guilded user.
Returns Promise<void>
- Defined in src/managers/GroupManager.ts:77

update

update(serverId: string, groupId: string, data: UpdateGroupBody): Promise<Group>
Update a Guilded server's group.
Parameters
- serverId: string
  The ID of the Guilded server.
- groupId: string
  The ID of the Guilded server's group.
- data: UpdateGroupBody
  Group data.
Returns Promise<Group>
The updated Guilded group.;
- Defined in src/managers/GroupManager.ts:48