PlatformGroupMethods
Methods attached to group objects returned by the Groups service.
Methods¶
delete()¶
delete():
Promise<void>
Deletes this group.
Returns¶
Promise<void>
Promise resolving when the group has been deleted
getMembers()¶
getMembers<
T>(options?:T):Promise<TextendsHasPaginationOptions<T> ?PaginatedResponse<PlatformGroupMember> :NonPaginatedResponse<PlatformGroupMember>>
Gets the local members of this group.
Type Parameters¶
| Type Parameter | Default type |
|---|---|
T extends PaginationOptions |
PaginationOptions |
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options? |
T |
Pagination options |
Returns¶
Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<PlatformGroupMember> : NonPaginatedResponse<PlatformGroupMember>>
Promise resolving to the group's members
update()¶
update(
update:PlatformGroupUpdateOptions):Promise<PlatformGroupGetResponse>
Updates this group. Only the fields present in update are changed.
Membership is edited incrementally through memberUserIdsToAdd /
memberUserIdsToRemove. The name must be sent on every write, so a
membership-only update (no name) first reads the group's current name; a
rename that lands between that read and the write is overwritten with the
earlier name. Pass name explicitly to skip the read.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
update |
PlatformGroupUpdateOptions |
The fields to change |
Returns¶
Promise<PlatformGroupGetResponse>
Promise resolving to the group as stored after the update