Class Group

Index

Constructors

Properties

Methods

getGroup getGroups getMembers

Constructors

constructor

new Group(client): Server.Group
Parameters
- client: Client
Returns Server.Group
- Defined in server/group.ts:9

Properties

`Private` client

client: Client

Methods

getGroup

getGroup<T>(parameters, callback): Promise<void>
Get the user group with the group name
Type Parameters
- T = ServerModels.Group
Parameters
- parameters: ServerParameters.GetGroup
- callback: Callback<T>
Returns Promise<void>
- Defined in server/group.ts:36
getGroup<T>(parameters, callback?): Promise<T>
Get the user group with the group name
Type Parameters
- T = ServerModels.Group
Parameters
- parameters: ServerParameters.GetGroup
- Optional callback: undefined
Returns Promise<T>
- Defined in server/group.ts:38

getGroups

getGroups<T>(parameters, callback): Promise<void>
Get a paginated collection of user groups
Type Parameters
- T = Pagination<ServerModels.Group>
Parameters
- parameters: undefined | ServerParameters.GetGroups
- callback: Callback<T>
Returns Promise<void>
- Defined in server/group.ts:12
getGroups<T>(parameters?, callback?): Promise<T>
Get a paginated collection of user groups
Type Parameters
- T = Pagination<ServerModels.Group>
Parameters
- Optional parameters: ServerParameters.GetGroups
- Optional callback: undefined
Returns Promise<T>
- Defined in server/group.ts:17

getMembers

getMembers<T>(parameters, callback): Promise<void>
Get a paginated collection of users in the given group
Type Parameters
- T = Pagination<ServerModels.User>
Parameters
- parameters: GetMembers
- callback: Callback<T>
Returns Promise<void>
- Defined in server/group.ts:52
getMembers<T>(parameters, callback?): Promise<T>
Get a paginated collection of users in the given group
Type Parameters
- T = Pagination<ServerModels.User>
Parameters
- parameters: GetMembers
- Optional callback: undefined
Returns Promise<T>
- Defined in server/group.ts:57

Generated using TypeDoc v0.25.12