GroupService | @rivet-gg/group

Hierarchy

GroupServiceClient
GroupServiceClient
- GroupService

Implements

Client<ServiceInputTypes, ServiceOutputTypes, GroupServiceClientResolvedConfig>
Client<ServiceInputTypes, ServiceOutputTypes, GroupServiceClientResolvedConfig>

Constructors

constructor

new GroupService(configuration: GroupServiceClientConfig): GroupService

Inherited from GroupServiceClient.constructor

Overrides Client.__constructor
- Defined in clients/client/src/GroupServiceClient.ts:301
Parameters
- configuration: GroupServiceClientConfig
Returns GroupService

Properties

Readonly config

config: GroupServiceClientResolvedConfig

The resolved configuration of GroupServiceClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

middlewareStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>

Methods

completeGroupAvatarUpload

completeGroupAvatarUpload(args: CompleteGroupAvatarUploadCommandInput, options?: __HttpHandlerOptions): Promise<CompleteGroupAvatarUploadCommandOutput>
completeGroupAvatarUpload(args: CompleteGroupAvatarUploadCommandInput, cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void): void
completeGroupAvatarUpload(args: CompleteGroupAvatarUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void): void
completeGroupAvatarUpload(args: CompleteGroupAvatarUploadCommandInput, options?: __HttpHandlerOptions): Promise<CompleteGroupAvatarUploadCommandOutput>
completeGroupAvatarUpload(args: CompleteGroupAvatarUploadCommandInput, cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void): void
completeGroupAvatarUpload(args: CompleteGroupAvatarUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:97
Completes an avatar image upload. Must be called after the file upload process completes.

Call rivet.api.group#PrepareGroupAvatarUpload first.

Parameters
- args: CompleteGroupAvatarUploadCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CompleteGroupAvatarUploadCommandOutput>
- Defined in clients/client/src/GroupService.ts:101
Completes an avatar image upload. Must be called after the file upload process completes. Call rivet.api.group#PrepareGroupAvatarUpload first.

Parameters
- args: CompleteGroupAvatarUploadCommandInput
- cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void
  - - (err: any, data?: CompleteGroupAvatarUploadCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CompleteGroupAvatarUploadCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:105
Completes an avatar image upload. Must be called after the file upload process completes. Call rivet.api.group#PrepareGroupAvatarUpload first.

Parameters
- args: CompleteGroupAvatarUploadCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void
  - - (err: any, data?: CompleteGroupAvatarUploadCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CompleteGroupAvatarUploadCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:27
Completes an avatar image upload. Must be called after the file upload process completes.

Call rivet.api.group#PrepareGroupAvatarUpload first.

Parameters
- args: CompleteGroupAvatarUploadCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CompleteGroupAvatarUploadCommandOutput>
- Defined in dist-types/GroupService.d.ts:28
Completes an avatar image upload. Must be called after the file upload process completes. Call rivet.api.group#PrepareGroupAvatarUpload first.

Parameters
- args: CompleteGroupAvatarUploadCommandInput
- cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void
  - - (err: any, data?: CompleteGroupAvatarUploadCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CompleteGroupAvatarUploadCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:29
Completes an avatar image upload. Must be called after the file upload process completes. Call rivet.api.group#PrepareGroupAvatarUpload first.

Parameters
- args: CompleteGroupAvatarUploadCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void
  - - (err: any, data?: CompleteGroupAvatarUploadCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CompleteGroupAvatarUploadCommandOutput
      Returns void
Returns void

consumeGroupInvite

consumeGroupInvite(args: ConsumeGroupInviteCommandInput, options?: __HttpHandlerOptions): Promise<ConsumeGroupInviteCommandOutput>
consumeGroupInvite(args: ConsumeGroupInviteCommandInput, cb: (err: any, data?: ConsumeGroupInviteCommandOutput) => void): void
consumeGroupInvite(args: ConsumeGroupInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConsumeGroupInviteCommandOutput) => void): void
consumeGroupInvite(args: ConsumeGroupInviteCommandInput, options?: __HttpHandlerOptions): Promise<ConsumeGroupInviteCommandOutput>
consumeGroupInvite(args: ConsumeGroupInviteCommandInput, cb: (err: any, data?: ConsumeGroupInviteCommandOutput) => void): void
consumeGroupInvite(args: ConsumeGroupInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConsumeGroupInviteCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:130
Consumes a group invite to join a group.

Parameters
- args: ConsumeGroupInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ConsumeGroupInviteCommandOutput>
- Defined in clients/client/src/GroupService.ts:134
Consumes a group invite to join a group.

Parameters
- args: ConsumeGroupInviteCommandInput
- cb: (err: any, data?: ConsumeGroupInviteCommandOutput) => void
  - - (err: any, data?: ConsumeGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ConsumeGroupInviteCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:138
Consumes a group invite to join a group.

Parameters
- args: ConsumeGroupInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ConsumeGroupInviteCommandOutput) => void
  - - (err: any, data?: ConsumeGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ConsumeGroupInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:33
Consumes a group invite to join a group.

Parameters
- args: ConsumeGroupInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ConsumeGroupInviteCommandOutput>
- Defined in dist-types/GroupService.d.ts:34
Consumes a group invite to join a group.

Parameters
- args: ConsumeGroupInviteCommandInput
- cb: (err: any, data?: ConsumeGroupInviteCommandOutput) => void
  - - (err: any, data?: ConsumeGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ConsumeGroupInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:35
Consumes a group invite to join a group.

Parameters
- args: ConsumeGroupInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ConsumeGroupInviteCommandOutput) => void
  - - (err: any, data?: ConsumeGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ConsumeGroupInviteCommandOutput
      Returns void
Returns void

createGroup

createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupCommandOutput>
createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void
createGroup(args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void): void
createGroup(args: CreateGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupCommandOutput>
createGroup(args: CreateGroupCommandInput, cb: (err: any, data?: CreateGroupCommandOutput) => void): void
createGroup(args: CreateGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:163
Creates a new group.

Parameters
- args: CreateGroupCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreateGroupCommandOutput>
- Defined in clients/client/src/GroupService.ts:167
Creates a new group.

Parameters
- args: CreateGroupCommandInput
- cb: (err: any, data?: CreateGroupCommandOutput) => void
  - - (err: any, data?: CreateGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:171
Creates a new group.

Parameters
- args: CreateGroupCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreateGroupCommandOutput) => void
  - - (err: any, data?: CreateGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:39
Creates a new group.

Parameters
- args: CreateGroupCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreateGroupCommandOutput>
- Defined in dist-types/GroupService.d.ts:40
Creates a new group.

Parameters
- args: CreateGroupCommandInput
- cb: (err: any, data?: CreateGroupCommandOutput) => void
  - - (err: any, data?: CreateGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:41
Creates a new group.

Parameters
- args: CreateGroupCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreateGroupCommandOutput) => void
  - - (err: any, data?: CreateGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupCommandOutput
      Returns void
Returns void

createGroupInvite

createGroupInvite(args: CreateGroupInviteCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupInviteCommandOutput>
createGroupInvite(args: CreateGroupInviteCommandInput, cb: (err: any, data?: CreateGroupInviteCommandOutput) => void): void
createGroupInvite(args: CreateGroupInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupInviteCommandOutput) => void): void
createGroupInvite(args: CreateGroupInviteCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupInviteCommandOutput>
createGroupInvite(args: CreateGroupInviteCommandInput, cb: (err: any, data?: CreateGroupInviteCommandOutput) => void): void
createGroupInvite(args: CreateGroupInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupInviteCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:197
Creates a group invite. Can be shared with other identities to let them join this group.

Parameters
- args: CreateGroupInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreateGroupInviteCommandOutput>
- Defined in clients/client/src/GroupService.ts:201
Creates a group invite. Can be shared with other identities to let them join this group.

Parameters
- args: CreateGroupInviteCommandInput
- cb: (err: any, data?: CreateGroupInviteCommandOutput) => void
  - - (err: any, data?: CreateGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupInviteCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:205
Creates a group invite. Can be shared with other identities to let them join this group.

Parameters
- args: CreateGroupInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreateGroupInviteCommandOutput) => void
  - - (err: any, data?: CreateGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:46
Creates a group invite. Can be shared with other identities to let them join this group.

Parameters
- args: CreateGroupInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreateGroupInviteCommandOutput>
- Defined in dist-types/GroupService.d.ts:47
Creates a group invite. Can be shared with other identities to let them join this group.

Parameters
- args: CreateGroupInviteCommandInput
- cb: (err: any, data?: CreateGroupInviteCommandOutput) => void
  - - (err: any, data?: CreateGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:48
Creates a group invite. Can be shared with other identities to let them join this group.

Parameters
- args: CreateGroupInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreateGroupInviteCommandOutput) => void
  - - (err: any, data?: CreateGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupInviteCommandOutput
      Returns void
Returns void

createGroupJoinRequest

createGroupJoinRequest(args: CreateGroupJoinRequestCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupJoinRequestCommandOutput>
createGroupJoinRequest(args: CreateGroupJoinRequestCommandInput, cb: (err: any, data?: CreateGroupJoinRequestCommandOutput) => void): void
createGroupJoinRequest(args: CreateGroupJoinRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupJoinRequestCommandOutput) => void): void
createGroupJoinRequest(args: CreateGroupJoinRequestCommandInput, options?: __HttpHandlerOptions): Promise<CreateGroupJoinRequestCommandOutput>
createGroupJoinRequest(args: CreateGroupJoinRequestCommandInput, cb: (err: any, data?: CreateGroupJoinRequestCommandOutput) => void): void
createGroupJoinRequest(args: CreateGroupJoinRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGroupJoinRequestCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:230
Requests to join a group.

Parameters
- args: CreateGroupJoinRequestCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreateGroupJoinRequestCommandOutput>
- Defined in clients/client/src/GroupService.ts:234
Requests to join a group.

Parameters
- args: CreateGroupJoinRequestCommandInput
- cb: (err: any, data?: CreateGroupJoinRequestCommandOutput) => void
  - - (err: any, data?: CreateGroupJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupJoinRequestCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:238
Requests to join a group.

Parameters
- args: CreateGroupJoinRequestCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreateGroupJoinRequestCommandOutput) => void
  - - (err: any, data?: CreateGroupJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupJoinRequestCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:52
Requests to join a group.

Parameters
- args: CreateGroupJoinRequestCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreateGroupJoinRequestCommandOutput>
- Defined in dist-types/GroupService.d.ts:53
Requests to join a group.

Parameters
- args: CreateGroupJoinRequestCommandInput
- cb: (err: any, data?: CreateGroupJoinRequestCommandOutput) => void
  - - (err: any, data?: CreateGroupJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupJoinRequestCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:54
Requests to join a group.

Parameters
- args: CreateGroupJoinRequestCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreateGroupJoinRequestCommandOutput) => void
  - - (err: any, data?: CreateGroupJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateGroupJoinRequestCommandOutput
      Returns void
Returns void

destroy

destroy(): void

Inherited from GroupServiceClient.destroy

Overrides Client.destroy
- Defined in clients/client/src/GroupServiceClient.ts:364
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void

getGroupInvite

getGroupInvite(args: GetGroupInviteCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupInviteCommandOutput>
getGroupInvite(args: GetGroupInviteCommandInput, cb: (err: any, data?: GetGroupInviteCommandOutput) => void): void
getGroupInvite(args: GetGroupInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupInviteCommandOutput) => void): void
getGroupInvite(args: GetGroupInviteCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupInviteCommandOutput>
getGroupInvite(args: GetGroupInviteCommandInput, cb: (err: any, data?: GetGroupInviteCommandOutput) => void): void
getGroupInvite(args: GetGroupInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupInviteCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:263
Inspects a group invite returning information about the team that created it.

Parameters
- args: GetGroupInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetGroupInviteCommandOutput>
- Defined in clients/client/src/GroupService.ts:267
Inspects a group invite returning information about the team that created it.

Parameters
- args: GetGroupInviteCommandInput
- cb: (err: any, data?: GetGroupInviteCommandOutput) => void
  - - (err: any, data?: GetGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupInviteCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:271
Inspects a group invite returning information about the team that created it.

Parameters
- args: GetGroupInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetGroupInviteCommandOutput) => void
  - - (err: any, data?: GetGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:58
Inspects a group invite returning information about the team that created it.

Parameters
- args: GetGroupInviteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetGroupInviteCommandOutput>
- Defined in dist-types/GroupService.d.ts:59
Inspects a group invite returning information about the team that created it.

Parameters
- args: GetGroupInviteCommandInput
- cb: (err: any, data?: GetGroupInviteCommandOutput) => void
  - - (err: any, data?: GetGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupInviteCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:60
Inspects a group invite returning information about the team that created it.

Parameters
- args: GetGroupInviteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetGroupInviteCommandOutput) => void
  - - (err: any, data?: GetGroupInviteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupInviteCommandOutput
      Returns void
Returns void

getGroupProfile

getGroupProfile(args: GetGroupProfileCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupProfileCommandOutput>
getGroupProfile(args: GetGroupProfileCommandInput, cb: (err: any, data?: GetGroupProfileCommandOutput) => void): void
getGroupProfile(args: GetGroupProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupProfileCommandOutput) => void): void
getGroupProfile(args: GetGroupProfileCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupProfileCommandOutput>
getGroupProfile(args: GetGroupProfileCommandInput, cb: (err: any, data?: GetGroupProfileCommandOutput) => void): void
getGroupProfile(args: GetGroupProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupProfileCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:296
Returns a group profile.

Parameters
- args: GetGroupProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetGroupProfileCommandOutput>
- Defined in clients/client/src/GroupService.ts:300
Returns a group profile.

Parameters
- args: GetGroupProfileCommandInput
- cb: (err: any, data?: GetGroupProfileCommandOutput) => void
  - - (err: any, data?: GetGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupProfileCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:304
Returns a group profile.

Parameters
- args: GetGroupProfileCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetGroupProfileCommandOutput) => void
  - - (err: any, data?: GetGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupProfileCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:64
Returns a group profile.

Parameters
- args: GetGroupProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetGroupProfileCommandOutput>
- Defined in dist-types/GroupService.d.ts:65
Returns a group profile.

Parameters
- args: GetGroupProfileCommandInput
- cb: (err: any, data?: GetGroupProfileCommandOutput) => void
  - - (err: any, data?: GetGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupProfileCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:66
Returns a group profile.

Parameters
- args: GetGroupProfileCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetGroupProfileCommandOutput) => void
  - - (err: any, data?: GetGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupProfileCommandOutput
      Returns void
Returns void

getGroupSummary

getGroupSummary(args: GetGroupSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupSummaryCommandOutput>
getGroupSummary(args: GetGroupSummaryCommandInput, cb: (err: any, data?: GetGroupSummaryCommandOutput) => void): void
getGroupSummary(args: GetGroupSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupSummaryCommandOutput) => void): void
getGroupSummary(args: GetGroupSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetGroupSummaryCommandOutput>
getGroupSummary(args: GetGroupSummaryCommandInput, cb: (err: any, data?: GetGroupSummaryCommandOutput) => void): void
getGroupSummary(args: GetGroupSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupSummaryCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:326
Parameters
- args: GetGroupSummaryCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetGroupSummaryCommandOutput>
- Defined in clients/client/src/GroupService.ts:330
Parameters
- args: GetGroupSummaryCommandInput
- cb: (err: any, data?: GetGroupSummaryCommandOutput) => void
  - - (err: any, data?: GetGroupSummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupSummaryCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:334
Parameters
- args: GetGroupSummaryCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetGroupSummaryCommandOutput) => void
  - - (err: any, data?: GetGroupSummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupSummaryCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:67
Parameters
- args: GetGroupSummaryCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetGroupSummaryCommandOutput>
- Defined in dist-types/GroupService.d.ts:68
Parameters
- args: GetGroupSummaryCommandInput
- cb: (err: any, data?: GetGroupSummaryCommandOutput) => void
  - - (err: any, data?: GetGroupSummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupSummaryCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:69
Parameters
- args: GetGroupSummaryCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetGroupSummaryCommandOutput) => void
  - - (err: any, data?: GetGroupSummaryCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetGroupSummaryCommandOutput
      Returns void
Returns void

joinGroup

joinGroup(args: JoinGroupCommandInput, options?: __HttpHandlerOptions): Promise<JoinGroupCommandOutput>
joinGroup(args: JoinGroupCommandInput, cb: (err: any, data?: JoinGroupCommandOutput) => void): void
joinGroup(args: JoinGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JoinGroupCommandOutput) => void): void
joinGroup(args: JoinGroupCommandInput, options?: __HttpHandlerOptions): Promise<JoinGroupCommandOutput>
joinGroup(args: JoinGroupCommandInput, cb: (err: any, data?: JoinGroupCommandOutput) => void): void
joinGroup(args: JoinGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: JoinGroupCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:359
Parameters
- args: JoinGroupCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<JoinGroupCommandOutput>
- Defined in clients/client/src/GroupService.ts:363
Parameters
- args: JoinGroupCommandInput
- cb: (err: any, data?: JoinGroupCommandOutput) => void
  - - (err: any, data?: JoinGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinGroupCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:367
Parameters
- args: JoinGroupCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: JoinGroupCommandOutput) => void
  - - (err: any, data?: JoinGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinGroupCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:73
Parameters
- args: JoinGroupCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<JoinGroupCommandOutput>
- Defined in dist-types/GroupService.d.ts:74
Parameters
- args: JoinGroupCommandInput
- cb: (err: any, data?: JoinGroupCommandOutput) => void
  - - (err: any, data?: JoinGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinGroupCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:75
Parameters
- args: JoinGroupCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: JoinGroupCommandOutput) => void
  - - (err: any, data?: JoinGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: JoinGroupCommandOutput
      Returns void
Returns void

leaveGroup

leaveGroup(args: LeaveGroupCommandInput, options?: __HttpHandlerOptions): Promise<LeaveGroupCommandOutput>
leaveGroup(args: LeaveGroupCommandInput, cb: (err: any, data?: LeaveGroupCommandOutput) => void): void
leaveGroup(args: LeaveGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LeaveGroupCommandOutput) => void): void
leaveGroup(args: LeaveGroupCommandInput, options?: __HttpHandlerOptions): Promise<LeaveGroupCommandOutput>
leaveGroup(args: LeaveGroupCommandInput, cb: (err: any, data?: LeaveGroupCommandOutput) => void): void
leaveGroup(args: LeaveGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LeaveGroupCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:392
Leaves a group.

Parameters
- args: LeaveGroupCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<LeaveGroupCommandOutput>
- Defined in clients/client/src/GroupService.ts:396
Leaves a group.

Parameters
- args: LeaveGroupCommandInput
- cb: (err: any, data?: LeaveGroupCommandOutput) => void
  - - (err: any, data?: LeaveGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: LeaveGroupCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:400
Leaves a group.

Parameters
- args: LeaveGroupCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: LeaveGroupCommandOutput) => void
  - - (err: any, data?: LeaveGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: LeaveGroupCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:79
Leaves a group.

Parameters
- args: LeaveGroupCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<LeaveGroupCommandOutput>
- Defined in dist-types/GroupService.d.ts:80
Leaves a group.

Parameters
- args: LeaveGroupCommandInput
- cb: (err: any, data?: LeaveGroupCommandOutput) => void
  - - (err: any, data?: LeaveGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: LeaveGroupCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:81
Leaves a group.

Parameters
- args: LeaveGroupCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: LeaveGroupCommandOutput) => void
  - - (err: any, data?: LeaveGroupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: LeaveGroupCommandOutput
      Returns void
Returns void

listSuggestedGroups

listSuggestedGroups(args: ListSuggestedGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListSuggestedGroupsCommandOutput>
listSuggestedGroups(args: ListSuggestedGroupsCommandInput, cb: (err: any, data?: ListSuggestedGroupsCommandOutput) => void): void
listSuggestedGroups(args: ListSuggestedGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSuggestedGroupsCommandOutput) => void): void
listSuggestedGroups(args: ListSuggestedGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListSuggestedGroupsCommandOutput>
listSuggestedGroups(args: ListSuggestedGroupsCommandInput, cb: (err: any, data?: ListSuggestedGroupsCommandOutput) => void): void
listSuggestedGroups(args: ListSuggestedGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSuggestedGroupsCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:425
Returns a list of suggested groups.

Parameters
- args: ListSuggestedGroupsCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ListSuggestedGroupsCommandOutput>
- Defined in clients/client/src/GroupService.ts:429
Returns a list of suggested groups.

Parameters
- args: ListSuggestedGroupsCommandInput
- cb: (err: any, data?: ListSuggestedGroupsCommandOutput) => void
  - - (err: any, data?: ListSuggestedGroupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListSuggestedGroupsCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:433
Returns a list of suggested groups.

Parameters
- args: ListSuggestedGroupsCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ListSuggestedGroupsCommandOutput) => void
  - - (err: any, data?: ListSuggestedGroupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListSuggestedGroupsCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:85
Returns a list of suggested groups.

Parameters
- args: ListSuggestedGroupsCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ListSuggestedGroupsCommandOutput>
- Defined in dist-types/GroupService.d.ts:86
Returns a list of suggested groups.

Parameters
- args: ListSuggestedGroupsCommandInput
- cb: (err: any, data?: ListSuggestedGroupsCommandOutput) => void
  - - (err: any, data?: ListSuggestedGroupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListSuggestedGroupsCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:87
Returns a list of suggested groups.

Parameters
- args: ListSuggestedGroupsCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ListSuggestedGroupsCommandOutput) => void
  - - (err: any, data?: ListSuggestedGroupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListSuggestedGroupsCommandOutput
      Returns void
Returns void

prepareGroupAvatarUpload

prepareGroupAvatarUpload(args: PrepareGroupAvatarUploadCommandInput, options?: __HttpHandlerOptions): Promise<PrepareGroupAvatarUploadCommandOutput>
prepareGroupAvatarUpload(args: PrepareGroupAvatarUploadCommandInput, cb: (err: any, data?: PrepareGroupAvatarUploadCommandOutput) => void): void
prepareGroupAvatarUpload(args: PrepareGroupAvatarUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PrepareGroupAvatarUploadCommandOutput) => void): void
prepareGroupAvatarUpload(args: PrepareGroupAvatarUploadCommandInput, options?: __HttpHandlerOptions): Promise<PrepareGroupAvatarUploadCommandOutput>
prepareGroupAvatarUpload(args: PrepareGroupAvatarUploadCommandInput, cb: (err: any, data?: PrepareGroupAvatarUploadCommandOutput) => void): void
prepareGroupAvatarUpload(args: PrepareGroupAvatarUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PrepareGroupAvatarUploadCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:460
Prepares an avatar image upload.

Complete upload with rivet.api.group#CompleteGroupAvatarUpload.

Parameters
- args: PrepareGroupAvatarUploadCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<PrepareGroupAvatarUploadCommandOutput>
- Defined in clients/client/src/GroupService.ts:464
Prepares an avatar image upload. Complete upload with rivet.api.group#CompleteGroupAvatarUpload.

Parameters
- args: PrepareGroupAvatarUploadCommandInput
- cb: (err: any, data?: PrepareGroupAvatarUploadCommandOutput) => void
  - - (err: any, data?: PrepareGroupAvatarUploadCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PrepareGroupAvatarUploadCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:468
Prepares an avatar image upload. Complete upload with rivet.api.group#CompleteGroupAvatarUpload.

Parameters
- args: PrepareGroupAvatarUploadCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: PrepareGroupAvatarUploadCommandOutput) => void
  - - (err: any, data?: PrepareGroupAvatarUploadCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PrepareGroupAvatarUploadCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:93
Prepares an avatar image upload.

Complete upload with rivet.api.group#CompleteGroupAvatarUpload.

Parameters
- args: PrepareGroupAvatarUploadCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<PrepareGroupAvatarUploadCommandOutput>
- Defined in dist-types/GroupService.d.ts:94
Prepares an avatar image upload. Complete upload with rivet.api.group#CompleteGroupAvatarUpload.

Parameters
- args: PrepareGroupAvatarUploadCommandInput
- cb: (err: any, data?: PrepareGroupAvatarUploadCommandOutput) => void
  - - (err: any, data?: PrepareGroupAvatarUploadCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PrepareGroupAvatarUploadCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:95
Prepares an avatar image upload. Complete upload with rivet.api.group#CompleteGroupAvatarUpload.

Parameters
- args: PrepareGroupAvatarUploadCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: PrepareGroupAvatarUploadCommandOutput) => void
  - - (err: any, data?: PrepareGroupAvatarUploadCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PrepareGroupAvatarUploadCommandOutput
      Returns void
Returns void

resolveGroupJoinRequest

resolveGroupJoinRequest(args: ResolveGroupJoinRequestCommandInput, options?: __HttpHandlerOptions): Promise<ResolveGroupJoinRequestCommandOutput>
resolveGroupJoinRequest(args: ResolveGroupJoinRequestCommandInput, cb: (err: any, data?: ResolveGroupJoinRequestCommandOutput) => void): void
resolveGroupJoinRequest(args: ResolveGroupJoinRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResolveGroupJoinRequestCommandOutput) => void): void
resolveGroupJoinRequest(args: ResolveGroupJoinRequestCommandInput, options?: __HttpHandlerOptions): Promise<ResolveGroupJoinRequestCommandOutput>
resolveGroupJoinRequest(args: ResolveGroupJoinRequestCommandInput, cb: (err: any, data?: ResolveGroupJoinRequestCommandOutput) => void): void
resolveGroupJoinRequest(args: ResolveGroupJoinRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResolveGroupJoinRequestCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:493
Resolves a join request for a given group.

Parameters
- args: ResolveGroupJoinRequestCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ResolveGroupJoinRequestCommandOutput>
- Defined in clients/client/src/GroupService.ts:497
Resolves a join request for a given group.

Parameters
- args: ResolveGroupJoinRequestCommandInput
- cb: (err: any, data?: ResolveGroupJoinRequestCommandOutput) => void
  - - (err: any, data?: ResolveGroupJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ResolveGroupJoinRequestCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:501
Resolves a join request for a given group.

Parameters
- args: ResolveGroupJoinRequestCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ResolveGroupJoinRequestCommandOutput) => void
  - - (err: any, data?: ResolveGroupJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ResolveGroupJoinRequestCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:99
Resolves a join request for a given group.

Parameters
- args: ResolveGroupJoinRequestCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ResolveGroupJoinRequestCommandOutput>
- Defined in dist-types/GroupService.d.ts:100
Resolves a join request for a given group.

Parameters
- args: ResolveGroupJoinRequestCommandInput
- cb: (err: any, data?: ResolveGroupJoinRequestCommandOutput) => void
  - - (err: any, data?: ResolveGroupJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ResolveGroupJoinRequestCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:101
Resolves a join request for a given group.

Parameters
- args: ResolveGroupJoinRequestCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ResolveGroupJoinRequestCommandOutput) => void
  - - (err: any, data?: ResolveGroupJoinRequestCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ResolveGroupJoinRequestCommandOutput
      Returns void
Returns void

searchGroups

searchGroups(args: SearchGroupsCommandInput, options?: __HttpHandlerOptions): Promise<SearchGroupsCommandOutput>
searchGroups(args: SearchGroupsCommandInput, cb: (err: any, data?: SearchGroupsCommandOutput) => void): void
searchGroups(args: SearchGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchGroupsCommandOutput) => void): void
searchGroups(args: SearchGroupsCommandInput, options?: __HttpHandlerOptions): Promise<SearchGroupsCommandOutput>
searchGroups(args: SearchGroupsCommandInput, cb: (err: any, data?: SearchGroupsCommandOutput) => void): void
searchGroups(args: SearchGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchGroupsCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:526
Fuzzy search for groups.

Parameters
- args: SearchGroupsCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SearchGroupsCommandOutput>
- Defined in clients/client/src/GroupService.ts:530
Fuzzy search for groups.

Parameters
- args: SearchGroupsCommandInput
- cb: (err: any, data?: SearchGroupsCommandOutput) => void
  - - (err: any, data?: SearchGroupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SearchGroupsCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:534
Fuzzy search for groups.

Parameters
- args: SearchGroupsCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: SearchGroupsCommandOutput) => void
  - - (err: any, data?: SearchGroupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SearchGroupsCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:105
Fuzzy search for groups.

Parameters
- args: SearchGroupsCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<SearchGroupsCommandOutput>
- Defined in dist-types/GroupService.d.ts:106
Fuzzy search for groups.

Parameters
- args: SearchGroupsCommandInput
- cb: (err: any, data?: SearchGroupsCommandOutput) => void
  - - (err: any, data?: SearchGroupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SearchGroupsCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:107
Fuzzy search for groups.

Parameters
- args: SearchGroupsCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: SearchGroupsCommandOutput) => void
  - - (err: any, data?: SearchGroupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: SearchGroupsCommandOutput
      Returns void
Returns void

send

send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options?: HandlerOptions): Promise<OutputType>
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, cb: (err: any, data?: OutputType) => void): void
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options: __HttpHandlerOptions, cb: (err: any, data?: OutputType) => void): void

Inherited from GroupServiceClient.send

Overrides GroupServiceClient.send
- Defined in node_modules/@aws-sdk/smithy-client/dist-types/client.d.ts:16
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- Optional options: HandlerOptions
Returns Promise<OutputType>
Inherited from GroupServiceClient.send

Overrides GroupServiceClient.send
- Defined in node_modules/@aws-sdk/smithy-client/dist-types/client.d.ts:17
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void
Inherited from GroupServiceClient.send

Overrides GroupServiceClient.send
- Defined in node_modules/@aws-sdk/smithy-client/dist-types/client.d.ts:18
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- options: __HttpHandlerOptions
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void

transferGroupOwnership

transferGroupOwnership(args: TransferGroupOwnershipCommandInput, options?: __HttpHandlerOptions): Promise<TransferGroupOwnershipCommandOutput>
transferGroupOwnership(args: TransferGroupOwnershipCommandInput, cb: (err: any, data?: TransferGroupOwnershipCommandOutput) => void): void
transferGroupOwnership(args: TransferGroupOwnershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransferGroupOwnershipCommandOutput) => void): void
transferGroupOwnership(args: TransferGroupOwnershipCommandInput, options?: __HttpHandlerOptions): Promise<TransferGroupOwnershipCommandOutput>
transferGroupOwnership(args: TransferGroupOwnershipCommandInput, cb: (err: any, data?: TransferGroupOwnershipCommandOutput) => void): void
transferGroupOwnership(args: TransferGroupOwnershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TransferGroupOwnershipCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:559
Transfers ownership of a group to another identity.

Parameters
- args: TransferGroupOwnershipCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<TransferGroupOwnershipCommandOutput>
- Defined in clients/client/src/GroupService.ts:563
Transfers ownership of a group to another identity.

Parameters
- args: TransferGroupOwnershipCommandInput
- cb: (err: any, data?: TransferGroupOwnershipCommandOutput) => void
  - - (err: any, data?: TransferGroupOwnershipCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TransferGroupOwnershipCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:567
Transfers ownership of a group to another identity.

Parameters
- args: TransferGroupOwnershipCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: TransferGroupOwnershipCommandOutput) => void
  - - (err: any, data?: TransferGroupOwnershipCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TransferGroupOwnershipCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:111
Transfers ownership of a group to another identity.

Parameters
- args: TransferGroupOwnershipCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<TransferGroupOwnershipCommandOutput>
- Defined in dist-types/GroupService.d.ts:112
Transfers ownership of a group to another identity.

Parameters
- args: TransferGroupOwnershipCommandInput
- cb: (err: any, data?: TransferGroupOwnershipCommandOutput) => void
  - - (err: any, data?: TransferGroupOwnershipCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TransferGroupOwnershipCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:113
Transfers ownership of a group to another identity.

Parameters
- args: TransferGroupOwnershipCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: TransferGroupOwnershipCommandOutput) => void
  - - (err: any, data?: TransferGroupOwnershipCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TransferGroupOwnershipCommandOutput
      Returns void
Returns void

updateGroupProfile

updateGroupProfile(args: UpdateGroupProfileCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGroupProfileCommandOutput>
updateGroupProfile(args: UpdateGroupProfileCommandInput, cb: (err: any, data?: UpdateGroupProfileCommandOutput) => void): void
updateGroupProfile(args: UpdateGroupProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupProfileCommandOutput) => void): void
updateGroupProfile(args: UpdateGroupProfileCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGroupProfileCommandOutput>
updateGroupProfile(args: UpdateGroupProfileCommandInput, cb: (err: any, data?: UpdateGroupProfileCommandOutput) => void): void
updateGroupProfile(args: UpdateGroupProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGroupProfileCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:589
Parameters
- args: UpdateGroupProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<UpdateGroupProfileCommandOutput>
- Defined in clients/client/src/GroupService.ts:593
Parameters
- args: UpdateGroupProfileCommandInput
- cb: (err: any, data?: UpdateGroupProfileCommandOutput) => void
  - - (err: any, data?: UpdateGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: UpdateGroupProfileCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:597
Parameters
- args: UpdateGroupProfileCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: UpdateGroupProfileCommandOutput) => void
  - - (err: any, data?: UpdateGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: UpdateGroupProfileCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:114
Parameters
- args: UpdateGroupProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<UpdateGroupProfileCommandOutput>
- Defined in dist-types/GroupService.d.ts:115
Parameters
- args: UpdateGroupProfileCommandInput
- cb: (err: any, data?: UpdateGroupProfileCommandOutput) => void
  - - (err: any, data?: UpdateGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: UpdateGroupProfileCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:116
Parameters
- args: UpdateGroupProfileCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: UpdateGroupProfileCommandOutput) => void
  - - (err: any, data?: UpdateGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: UpdateGroupProfileCommandOutput
      Returns void
Returns void

validateGroupProfile

validateGroupProfile(args: ValidateGroupProfileCommandInput, options?: __HttpHandlerOptions): Promise<ValidateGroupProfileCommandOutput>
validateGroupProfile(args: ValidateGroupProfileCommandInput, cb: (err: any, data?: ValidateGroupProfileCommandOutput) => void): void
validateGroupProfile(args: ValidateGroupProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateGroupProfileCommandOutput) => void): void
validateGroupProfile(args: ValidateGroupProfileCommandInput, options?: __HttpHandlerOptions): Promise<ValidateGroupProfileCommandOutput>
validateGroupProfile(args: ValidateGroupProfileCommandInput, cb: (err: any, data?: ValidateGroupProfileCommandOutput) => void): void
validateGroupProfile(args: ValidateGroupProfileCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateGroupProfileCommandOutput) => void): void

- Defined in clients/client/src/GroupService.ts:624
Validate contents of group profile.

Use to provide immediate feedback on profile changes before committing them.

Parameters
- args: ValidateGroupProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ValidateGroupProfileCommandOutput>
- Defined in clients/client/src/GroupService.ts:628
Validate contents of group profile. Use to provide immediate feedback on profile changes before committing them.

Parameters
- args: ValidateGroupProfileCommandInput
- cb: (err: any, data?: ValidateGroupProfileCommandOutput) => void
  - - (err: any, data?: ValidateGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ValidateGroupProfileCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/GroupService.ts:632
Validate contents of group profile. Use to provide immediate feedback on profile changes before committing them.

Parameters
- args: ValidateGroupProfileCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ValidateGroupProfileCommandOutput) => void
  - - (err: any, data?: ValidateGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ValidateGroupProfileCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:122
Validate contents of group profile.

Use to provide immediate feedback on profile changes before committing them.

Parameters
- args: ValidateGroupProfileCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ValidateGroupProfileCommandOutput>
- Defined in dist-types/GroupService.d.ts:123
Validate contents of group profile. Use to provide immediate feedback on profile changes before committing them.

Parameters
- args: ValidateGroupProfileCommandInput
- cb: (err: any, data?: ValidateGroupProfileCommandOutput) => void
  - - (err: any, data?: ValidateGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ValidateGroupProfileCommandOutput
      Returns void
Returns void
- Defined in dist-types/GroupService.d.ts:124
Validate contents of group profile. Use to provide immediate feedback on profile changes before committing them.

Parameters
- args: ValidateGroupProfileCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ValidateGroupProfileCommandOutput) => void
  - - (err: any, data?: ValidateGroupProfileCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ValidateGroupProfileCommandOutput
      Returns void
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: GroupServiceClientConfig

Returns GroupService

Properties

Readonly config

middlewareStack

Methods

completeGroupAvatarUpload

Parameters

args: CompleteGroupAvatarUploadCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<CompleteGroupAvatarUploadCommandOutput>

Parameters

args: CompleteGroupAvatarUploadCommandInput

cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void

Parameters

err: any

Optional data: CompleteGroupAvatarUploadCommandOutput

Returns void

Returns void

Parameters

args: CompleteGroupAvatarUploadCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void

Parameters

err: any

Optional data: CompleteGroupAvatarUploadCommandOutput

Returns void

Returns void

Parameters

args: CompleteGroupAvatarUploadCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<CompleteGroupAvatarUploadCommandOutput>

Parameters

args: CompleteGroupAvatarUploadCommandInput

cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void

Parameters

err: any

Optional data: CompleteGroupAvatarUploadCommandOutput

Returns void

Returns void

Parameters

args: CompleteGroupAvatarUploadCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: CompleteGroupAvatarUploadCommandOutput) => void

Parameters

err: any

Optional data: CompleteGroupAvatarUploadCommandOutput

Returns void

Returns void

consumeGroupInvite

Parameters

args: ConsumeGroupInviteCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<ConsumeGroupInviteCommandOutput>

Parameters

args: ConsumeGroupInviteCommandInput

cb: (err: any, data?: ConsumeGroupInviteCommandOutput) => void

Parameters

err: any

Optional data: ConsumeGroupInviteCommandOutput

Returns void

Returns void

Parameters

args: ConsumeGroupInviteCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: ConsumeGroupInviteCommandOutput) => void

Parameters

err: any

Optional data: ConsumeGroupInviteCommandOutput

Returns void

Returns void