Provide APIs to access Group [Management] service. More...

#include <AccelByteGroupApi.h>

Inheritance diagram for AccelByte::Api::Group:

Public Member Functions
	Group (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient=nullptr)
	Group (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
FAccelByteTaskWPtr	GetGroupList (FAccelByteModelsGetGroupListRequest const &RequestContent, THandler< FAccelByteModelsGetGroupListResponse > const &OnSuccess, FErrorHandler const &OnError)
	AKA "SearchGroups"; get list of groups.
FAccelByteTaskWPtr	CreateGroup (FAccelByteModelsCreateGroupRequest const &RequestContent, THandler< FAccelByteModelsGroupInformation > const &OnSuccess, FErrorHandler const &OnError)
	Creates a new group.
FAccelByteTaskWPtr	GetGroup (FString const &GroupId, THandler< FAccelByteModelsGroupInformation > const &OnSuccess, FErrorHandler const &OnError)
	Get single single group info (by groupId).
FAccelByteTaskWPtr	UpdateGroup (FString const &GroupId, bool bCompletelyReplace, FAccelByteModelsGroupUpdatable const &RequestContent, THandler< FAccelByteModelsGroupInformation > const &OnSuccess, FErrorHandler const &OnError)
	Update existing group.
FAccelByteTaskWPtr	DeleteGroup (FString const &GroupId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete existing group.
FAccelByteTaskWPtr	UpdateGroupCustomAttributes (FString const &GroupId, FAccelByteModelsUpdateGroupCustomAttributesRequest const &RequestContent, THandler< FAccelByteModelsGroupInformation > const &OnSuccess, FErrorHandler const &OnError)
	Replaces current group custom attributes entirely.
FAccelByteTaskWPtr	UpdateGroupCustomRule (FString const &GroupId, FAccelByteModelsUpdateCustomRulesRequest const &RequestContent, THandler< FAccelByteModelsGroupInformation > const &OnSuccess, FErrorHandler const &OnError)
	Update custom (arbitrary) group rule.
FAccelByteTaskWPtr	UpdateGroupPredefinedRule (FString const &GroupId, EAccelByteAllowedAction AllowedAction, FAccelByteModelsUpdateGroupPredefinedRuleRequest const &RequestContent, THandler< FAccelByteModelsGroupInformation > const &OnSuccess, FErrorHandler const &OnError)
	Update predefined group rule.
FAccelByteTaskWPtr	DeleteGroupPredefinedRule (FString const &GroupId, EAccelByteAllowedAction AllowedAction, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete predefined group rule, based on the allowed action.
FAccelByteTaskWPtr	AcceptGroupInvitation (FString const &GroupId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Accepts an invitation from a 3rd-party group's group member to group up.
FAccelByteTaskWPtr	RejectGroupInvitation (FString const &GroupId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Rejects an invitation from a 3rd-party group's group member to group up.
FAccelByteTaskWPtr	JoinGroup (FString const &GroupId, THandler< FAccelByteModelsJoinGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Join into specific group and become a group member.
FAccelByteTaskWPtr	CancelJoinGroupRequest (FString const &GroupId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Cancel the Join group request.
FAccelByteTaskWPtr	GetGroupMembersListByGroupId (FString const &GroupId, FAccelByteModelsGetGroupMembersListByGroupIdRequest const &RequestContent, THandler< FAccelByteModelsGetGroupMemberListResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get list of group members (by GroupId).
FAccelByteTaskWPtr	LeaveGroup (THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Leave the group you're currently in.
FAccelByteTaskWPtr	GetUserGroupInfoByUserId (FString const &UserId, THandler< FAccelByteModelsGetUserGroupInfoResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get list of group members by group id.
FAccelByteTaskWPtr	InviteUserToGroup (FString const &UserId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Invite the other user to your group.
FAccelByteTaskWPtr	AcceptGroupJoinRequest (FString const &UserId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Accept [other] user's group join request.
FAccelByteTaskWPtr	RejectGroupJoinRequest (FString const &UserId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Reject [other] user's group join request.
FAccelByteTaskWPtr	KickGroupMember (FString const &UserId, THandler< FAccelByteModelsKickGroupMemberResponse > const &OnSuccess, FErrorHandler const &OnError)
	Kick a group member out of the group.
FAccelByteTaskWPtr	GetMemberRoles (FAccelByteModelsLimitOffsetRequest const &RequestContent, THandler< FAccelByteModelsGetMemberRolesListResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get list of [group] member roles.
FAccelByteTaskWPtr	AssignMemberRole (FString const &MemberRoleId, FAccelByteModelsUserIdWrapper const &RequestContent, THandler< FAccelByteModelsGetUserGroupInfoResponse > const &OnSuccess, FErrorHandler const &OnError)
	Assign a role to a group member.
FAccelByteTaskWPtr	DeleteMemberRole (FString const &MemberRoleId, FAccelByteModelsUserIdWrapper const &RequestContent, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Remove a role from a group member.
FAccelByteTaskWPtr	GetGroupJoinRequests (FString const &GroupId, FAccelByteModelsLimitOffsetRequest const &RequestContent, THandler< FAccelByteModelsGetMemberRequestsListResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get list of join requests in a specific group.
FAccelByteTaskWPtr	GetGroupInvitationRequests (FAccelByteModelsLimitOffsetRequest const &RequestContent, THandler< FAccelByteModelsGetMemberRequestsListResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get group invitation request list for the user calling this endpoint.
FAccelByteTaskWPtr	CreateV2Group (FAccelByteModelsCreateGroupRequest const &RequestContent, THandler< FAccelByteModelsGroupInformation > const &OnSuccess, FErrorHandler const &OnError)
	Creates a new group.
FAccelByteTaskWPtr	GetGroupsByGroupIds (TArray< FString > const &GroupIds, THandler< FAccelByteModelsGetGroupListResponse > const &OnSuccess, FErrorHandler const &OnError)
	Gets a collection of group information.
FAccelByteTaskWPtr	UpdateV2Group (FString const &GroupId, FAccelByteModelsUpdateGroupRequest const &RequestContent, THandler< FAccelByteModelsGroupInformation > const &OnSuccess, FErrorHandler const &OnError)
	Update existing group.
FAccelByteTaskWPtr	DeleteV2Group (FString const &GroupId, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete existing group.
FAccelByteTaskWPtr	UpdateV2GroupCustomAttributes (FString const &GroupId, FAccelByteModelsUpdateGroupCustomAttributesRequest const &RequestContent, THandler< FAccelByteModelsGroupInformation > const &OnSuccess, FErrorHandler const &OnError)
	Replaces current group custom attributes entirely.
FAccelByteTaskWPtr	UpdateV2GroupCustomRule (FString const &GroupId, FAccelByteModelsUpdateCustomRulesRequest const &RequestContent, THandler< FAccelByteModelsGroupInformation > const &OnSuccess, FErrorHandler const &OnError)
	Update custom (arbitrary) group rule.
FAccelByteTaskWPtr	UpdateV2GroupPredefinedRule (FString const &GroupId, EAccelByteAllowedAction AllowedAction, FAccelByteModelsUpdateGroupPredefinedRuleRequest const &RequestContent, THandler< FAccelByteModelsGroupInformation > const &OnSuccess, FErrorHandler const &OnError)
	Update predefined group rule.
FAccelByteTaskWPtr	DeleteV2GroupPredefinedRule (FString const &GroupId, EAccelByteAllowedAction AllowedAction, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Delete predefined group rule, based on the allowed action.
FAccelByteTaskWPtr	GetUserGroupStatusInfo (FString const &UserId, FString const &GroupId, THandler< FAccelByteModelsGetUserGroupInfoResponse > const &OnSuccess, FErrorHandler const &OnError)
	Gets user group status information.
FAccelByteTaskWPtr	GetGroupInviteRequestList (FString const &GroupId, FAccelByteModelsLimitOffsetRequest const &RequestContent, THandler< FAccelByteModelsGetMemberRequestsListResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get Group Invite Request List for specific group. Group members needs to have permission and also belong to the group to access this endpoint.
FAccelByteTaskWPtr	GetGroupJoinRequestList (FString const &GroupId, FAccelByteModelsLimitOffsetRequest const &RequestContent, THandler< FAccelByteModelsGetMemberRequestsListResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get Group Join Request List for specific group. Group members needs to have permission and also belong to the group to access this endpoint.
FAccelByteTaskWPtr	CancelGroupMemberInvitation (FString const &UserId, FString const &GroupId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Cancel invitation to specific user.
FAccelByteTaskWPtr	AcceptV2GroupInvitation (FString const &GroupId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Accepts an invitation from a 3rd-party group's group member to group up.
FAccelByteTaskWPtr	RejectV2GroupInvitation (FString const &GroupId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Rejects an invitation from a 3rd-party group's group member to group up.
FAccelByteTaskWPtr	JoinV2Group (FString const &GroupId, THandler< FAccelByteModelsJoinGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Join into specific group and become a group member.
FAccelByteTaskWPtr	LeaveV2Group (FString const &GroupId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Leave the group you're currently in.
FAccelByteTaskWPtr	InviteUserToV2Group (FString const &UserId, FString const &GroupId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Invite the other user to your group.
FAccelByteTaskWPtr	AcceptV2GroupJoinRequest (FString const &UserId, FString const &GroupId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Accept [other] user's group join request.
FAccelByteTaskWPtr	RejectV2GroupJoinRequest (FString const &UserId, FString const &GroupId, THandler< FAccelByteModelsMemberRequestGroupResponse > const &OnSuccess, FErrorHandler const &OnError)
	Reject [other] user's group join request.
FAccelByteTaskWPtr	KickV2GroupMember (FString const &UserId, FString const &GroupId, THandler< FAccelByteModelsKickGroupMemberResponse > const &OnSuccess, FErrorHandler const &OnError)
	Kick a group member out of the group.
FAccelByteTaskWPtr	GetMyJoinedGroupInfo (FAccelByteModelsLimitOffsetRequest const &RequestContent, THandler< FAccelByteModelsGetGroupMemberListResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get user group joined information. If user does not belong to any group, it will return warning to give information about it.
FAccelByteTaskWPtr	GetMyJoinGroupRequest (FAccelByteModelsLimitOffsetRequest const &RequestContent, THandler< FAccelByteModelsGetMemberRequestsListResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get My Join Request To The Groups. It will check any join request group for this user.
FAccelByteTaskWPtr	AssignV2MemberRole (FString const &MemberRoleId, FString const &GroupId, FAccelByteModelsUserIdWrapper const &RequestContent, THandler< FAccelByteModelsGetUserGroupInfoResponse > const &OnSuccess, FErrorHandler const &OnError)
	Assign a role to a group member.
FAccelByteTaskWPtr	DeleteV2MemberRole (FString const &MemberRoleId, FString const &GroupId, FAccelByteModelsUserIdWrapper const &RequestContent, FVoidHandler const &OnSuccess, FErrorHandler const &OnError)
	Remove a role from a group member.
FAccelByteTaskWPtr	GetAllMemberRoles (FAccelByteModelsLimitOffsetRequest const &RequestContent, THandler< FAccelByteModelsGetMemberRolesListResponse > const &OnSuccess, FErrorHandler const &OnError)
	Get list of member roles.
Public Member Functions inherited from AccelByte::FApiBase
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)
	FApiBase (Credentials const &InCredentialsRef, Settings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef, FAccelBytePlatformPtr const &InAccelBytePlatform)
void	SetApiClient (TSharedPtr< AccelByte::FApiClient, ESPMode::ThreadSafe > const &InApiClient)

Additional Inherited Members
Protected Member Functions inherited from AccelByte::FApiBase
template<typename T>
bool	ValidateAccelByteId (FString const &Id, EAccelByteIdHypensRule HypenRule, FString const &ErrorMessage, T const &OnError)
Protected Attributes inherited from AccelByte::FApiBase
TSharedRef< Credentials const, ESPMode::ThreadSafe >	CredentialsRef
Settings const &	SettingsRef
FHttpRetrySchedulerBase &	HttpRef
FHttpClient	HttpClient
FAccelBytePlatformPtr	AccelBytePlatformPtr

Detailed Description

Provide APIs to access Group [Management] service.

While authed, Namespace is automatically passed to all Requests.

Member Function Documentation

◆ AcceptGroupInvitation()

FAccelByteTaskWPtr AccelByte::Api::Group::AcceptGroupInvitation	(	FString const &	GroupId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Accepts an invitation from a 3rd-party group's group member to group up.

Required valid user authentication.
If specific user is !invited in the specific group ID, throw errorif the user !invited yet.
Checks if the user who access this endpoint already joined the specific group.
Deletes all requests (invite / join request) for the user who accesses this endpoint.
Existing members will receive notification of the newly-accepted member.

Action code: 73401

Parameters

GroupId	of the group that invited you, that you are accepting the invite to.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ AcceptGroupJoinRequest()

FAccelByteTaskWPtr AccelByte::Api::Group::AcceptGroupJoinRequest	(	FString const &	UserId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Accept [other] user's group join request.

Required valid user auth.
Required Member Role Permission: "GROUP:JOIN [CREATE]".
If specific user was not asked to join this specific group, response will return error that they "need a join request".
Will also check if specific user already joined the specific group.
This also works when a user invites themselves (JoinGroup) to join a PUBLIC group.
- Rather than an OPEN group (where players can just join without permission).

Action code: 73407

Parameters

UserId	of the user who wants to join your group.
OnSuccess	Called upon successful op. Returns { GroupId, UserId }
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ AcceptV2GroupInvitation()

FAccelByteTaskWPtr AccelByte::Api::Group::AcceptV2GroupInvitation	(	FString const &	GroupId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Accepts an invitation from a 3rd-party group's group member to group up.

Required valid user authentication.
If specific user is !invited in the specific group ID, throw errorif the user !invited yet.
Checks if the user who access this endpoint already joined the specific group.
Deletes all requests (invite / join request) for the user who accesses this endpoint.
Existing members will receive notification of the newly-accepted member.

Parameters

GroupId	of the group that invited you, that you are accepting the invite to.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ AcceptV2GroupJoinRequest()

FAccelByteTaskWPtr AccelByte::Api::Group::AcceptV2GroupJoinRequest	(	FString const &	UserId,
		FString const &	GroupId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Accept [other] user's group join request.

Required valid user auth.
Required Member Role Permission: "GROUP:JOIN [CREATE]".
If specific user was not asked to join this specific group, response will return error that they "need a join request".
Will also check if specific user already joined the specific group.
This also works when a user invites themselves (JoinGroup) to join a PUBLIC group.
- Rather than an OPEN group (where players can just join without permission).

Parameters

UserId	of the user who wants to join your group.
GroupId	of the group.
OnSuccess	Called upon successful op. Returns { GroupId, UserId }
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ AssignMemberRole()

FAccelByteTaskWPtr AccelByte::Api::Group::AssignMemberRole	(	FString const &	MemberRoleId,
		FAccelByteModelsUserIdWrapper const &	RequestContent,
		THandler< FAccelByteModelsGetUserGroupInfoResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Assign a role to a group member.

AKA AddMemberRole.
Required Member Role Permission: "GROUP:ROLE [UPDATE]".

Action code: 73204

Parameters

MemberRoleId	of the role you want to assign.
RequestContent	{ UserId } of the user you want to assign the role to.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ AssignV2MemberRole()

FAccelByteTaskWPtr AccelByte::Api::Group::AssignV2MemberRole	(	FString const &	MemberRoleId,
		FString const &	GroupId,
		FAccelByteModelsUserIdWrapper const &	RequestContent,
		THandler< FAccelByteModelsGetUserGroupInfoResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Assign a role to a group member.

AKA AddMemberRole.
Required Member Role Permission: "GROUP:ROLE [UPDATE]".

Parameters

MemberRoleId	of the role you want to assign.
GroupId	of the member.
RequestContent	{ UserId } of the user and group you want to assign the role to.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ CancelGroupMemberInvitation()

FAccelByteTaskWPtr AccelByte::Api::Group::CancelGroupMemberInvitation	(	FString const &	UserId,
		FString const &	GroupId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Cancel invitation to specific user.

Required valid user authentication
Required Member Role Permission: "GROUP:INVITE [DELETE]"

Parameters

UserId	user id to which the invitation will be cancelled.
GroupId	group id which sent the invitation.
OnSuccess	This will be called when the operation succeeded. Result is FAccelByteModelsMemberRequestGroupResponse
OnError	This will be called when the operation fail.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ CancelJoinGroupRequest()

FAccelByteTaskWPtr AccelByte::Api::Group::CancelJoinGroupRequest	(	FString const &	GroupId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Cancel the Join group request.

Required valid user authentication.

Action code: 73411

Parameters

GroupId	of the !Open group type you asked to join, but now want to cancel.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ CreateGroup()

FAccelByteTaskWPtr AccelByte::Api::Group::CreateGroup	(	FAccelByteModelsCreateGroupRequest const &	RequestContent,
		THandler< FAccelByteModelsGroupInformation > const &	OnSuccess,
		FErrorHandler const &	OnError )

Creates a new group.

Requires valid user authentication.
There are some fields that needs to be fulfilled.
- groupDescription: the description of the group (optional).
- groupIcon: group icon URL link (optional).
- groupName: name of the group.
- groupRegion: region of the group.
- groupRules: rules for specific group. It consists of groupCustomRule that can be used to save custom rule, and groupPredefinedRules that has similar usage with configuration, but this rule only works in specific group.
- allowedAction: available action in group service. It consist of joinGroup and inviteGroup.
- ruleAttribute: attribute of the player that needs to be checked.
- ruleCriteria: criteria of the value. The value will be in enum of EQUAL, MINIMUM, MAXIMUM.
- ruleValue: value that needs to be checked.
- customAttributes: additional custom group attributes (optional).

Action code:: 73304

Parameters

RequestContent	New group detail request.
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ CreateV2Group()

FAccelByteTaskWPtr AccelByte::Api::Group::CreateV2Group	(	FAccelByteModelsCreateGroupRequest const &	RequestContent,
		THandler< FAccelByteModelsGroupInformation > const &	OnSuccess,
		FErrorHandler const &	OnError )

Creates a new group.

Requires valid user authentication.

Parameters

RequestContent	New group detail request.
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteGroup()

FAccelByteTaskWPtr AccelByte::Api::Group::DeleteGroup	(	FString const &	GroupId,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete existing group.

Checks if groupID exists before deleting.
Required Member Role Permission: "GROUP [DELETE]".

Action code:: 73305

Parameters

GroupId
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteGroupPredefinedRule()

FAccelByteTaskWPtr AccelByte::Api::Group::DeleteGroupPredefinedRule	(	FString const &	GroupId,
		EAccelByteAllowedAction	AllowedAction,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete predefined group rule, based on the allowed action.

Required valid user authentication.
Required Member Role Permission: "GROUP [UPDATE]".
Checks the group ID of the user based on the access token, then compares it with the group ID in path parameter.
Checks the member role of the user based on the access token.

Action code:: 73309

Parameters

GroupId
AllowedAction	eg: createGroup, joinedGroup.
OnSuccess	This will be called when the operation succeeded. Void Result
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteMemberRole()

FAccelByteTaskWPtr AccelByte::Api::Group::DeleteMemberRole	(	FString const &	MemberRoleId,
		FAccelByteModelsUserIdWrapper const &	RequestContent,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Remove a role from a group member.

AKA RevokeMemberRole, RemoveMemberRole.
Required Member Role Permission: "GROUP:ROLE [UPDATE]".

Action code: 73204

Parameters

MemberRoleId	of the role you want to delete.
RequestContent	{ UserId } of the user you want to delete the role from.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteV2Group()

FAccelByteTaskWPtr AccelByte::Api::Group::DeleteV2Group	(	FString const &	GroupId,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete existing group.

Checks if groupID exists before deleting.
Required Member Role Permission: "GROUP [DELETE]".

Parameters

GroupId
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteV2GroupPredefinedRule()

FAccelByteTaskWPtr AccelByte::Api::Group::DeleteV2GroupPredefinedRule	(	FString const &	GroupId,
		EAccelByteAllowedAction	AllowedAction,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Delete predefined group rule, based on the allowed action.

Required valid user authentication.
Required Member Role Permission: "GROUP [UPDATE]".
Checks the group ID of the user based on the access token, then compares it with the group ID in path parameter.
Checks the member role of the user based on the access token.

Parameters

GroupId
AllowedAction	eg: createGroup, joinedGroup.
OnSuccess	This will be called when the operation succeeded. Void Result
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ DeleteV2MemberRole()

FAccelByteTaskWPtr AccelByte::Api::Group::DeleteV2MemberRole	(	FString const &	MemberRoleId,
		FString const &	GroupId,
		FAccelByteModelsUserIdWrapper const &	RequestContent,
		FVoidHandler const &	OnSuccess,
		FErrorHandler const &	OnError )

Remove a role from a group member.

AKA RevokeMemberRole, RemoveMemberRole.
Required Member Role Permission: "GROUP:ROLE [UPDATE]".

Parameters

MemberRoleId	of the role you want to delete.
GroupId	of the member.
RequestContent	{ UserId } of the user you want to delete the role from.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetAllMemberRoles()

FAccelByteTaskWPtr AccelByte::Api::Group::GetAllMemberRoles	(	FAccelByteModelsLimitOffsetRequest const &	RequestContent,
		THandler< FAccelByteModelsGetMemberRolesListResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get list of member roles.

Parameters

RequestContent	{ Limit=1, Offset=0 } for pagination.
OnSuccess	This will be called when the operation is succeeded. Result is FAccelByteModelsGetMemberRolesListResponse
OnError	This will be called when the operation is fail.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetGroup()

FAccelByteTaskWPtr AccelByte::Api::Group::GetGroup	(	FString const &	GroupId,
		THandler< FAccelByteModelsGroupInformation > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get single single group info (by groupId).

Required valid user authentication.
Gets single group information.

Action code: 73306

Parameters

GroupId
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetGroupInvitationRequests()

FAccelByteTaskWPtr AccelByte::Api::Group::GetGroupInvitationRequests	(	FAccelByteModelsLimitOffsetRequest const &	RequestContent,
		THandler< FAccelByteModelsGetMemberRequestsListResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get group invitation request list for the user calling this endpoint.

Required valid user authentication.
Checks any group invitation for this user.

Action code:: 73502

Parameters

RequestContent	{ Limit=1, Offset=0 } for pagination.
OnSuccess	Paginated.
OnError

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetGroupInviteRequestList()

FAccelByteTaskWPtr AccelByte::Api::Group::GetGroupInviteRequestList	(	FString const &	GroupId,
		FAccelByteModelsLimitOffsetRequest const &	RequestContent,
		THandler< FAccelByteModelsGetMemberRequestsListResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get Group Invite Request List for specific group. Group members needs to have permission and also belong to the group to access this endpoint.

Required valid user authentication
Required Member Role Permission: "GROUP:JOIN [READ]"

Parameters

GroupId
RequestContent	{ Limit=1, Offset=0 } for pagination.
OnSuccess	This will be called when the operation succeeded. Result is FAccelByteModelsGetMemberRequestsListResponse.
OnError	This will be called when the operation fail.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetGroupJoinRequestList()

FAccelByteTaskWPtr AccelByte::Api::Group::GetGroupJoinRequestList	(	FString const &	GroupId,
		FAccelByteModelsLimitOffsetRequest const &	RequestContent,
		THandler< FAccelByteModelsGetMemberRequestsListResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get Group Join Request List for specific group. Group members needs to have permission and also belong to the group to access this endpoint.

Required valid user authentication
Required Member Role Permission: "GROUP:JOIN [READ]"

Parameters

GroupId
RequestContent	{ Limit=1, Offset=0 } for pagination.
OnSuccess	This will be called when the operation succeeded. Result is FAccelByteModelsGetMemberRequestsListResponse
OnError	This will be called when the operation fail.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetGroupJoinRequests()

FAccelByteTaskWPtr AccelByte::Api::Group::GetGroupJoinRequests	(	FString const &	GroupId,
		FAccelByteModelsLimitOffsetRequest const &	RequestContent,
		THandler< FAccelByteModelsGetMemberRequestsListResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get list of join requests in a specific group.

Required valid user authentication.
Required Member Role Permission: "GROUP:JOIN [READ]".
Group members needs to have permission (+belong to the group) to access this endpoint.

Action code:: 73501

Parameters

GroupId	of the group you want to see the join requests from.
RequestContent	{ Limit=1, Offset=0 } for pagination.
OnSuccess	Paginated.
OnError

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetGroupList()

FAccelByteTaskWPtr AccelByte::Api::Group::GetGroupList	(	FAccelByteModelsGetGroupListRequest const &	RequestContent,
		THandler< FAccelByteModelsGetGroupListResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

AKA "SearchGroups"; get list of groups.

Required valid user authentication.
Only shows OPEN and PUBLIC group types.
Can search based on the group name by filling the "groupName" query param.

Action code:: 73303

Parameters

RequestContent
OnSuccess	This will be called when the operation succeeded. Result is const FGetGroupConfigListResponse&. Result is simply a FAccelByteModelsGroupInformationResponse + pagination info.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetGroupMembersListByGroupId()

FAccelByteTaskWPtr AccelByte::Api::Group::GetGroupMembersListByGroupId	(	FString const &	GroupId,
		FAccelByteModelsGetGroupMembersListByGroupIdRequest const &	RequestContent,
		THandler< FAccelByteModelsGetGroupMemberListResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get list of group members (by GroupId).

Required valid user authentication.

Action code: 73410

Parameters

GroupId	of the group you want to get a members list from.
RequestContent
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetGroupsByGroupIds()

FAccelByteTaskWPtr AccelByte::Api::Group::GetGroupsByGroupIds	(	TArray< FString > const &	GroupIds,
		THandler< FAccelByteModelsGetGroupListResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Gets a collection of group information.

Requires valid user authentication

Parameters

GroupIds	A list of group ids to get the group information from.
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGetGroupListResponse&. Support paging.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetMemberRoles()

FAccelByteTaskWPtr AccelByte::Api::Group::GetMemberRoles	(	FAccelByteModelsLimitOffsetRequest const &	RequestContent,
		THandler< FAccelByteModelsGetMemberRolesListResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get list of [group] member roles.

Required Member Role Permission: "GROUP:ROLE [READ]".

Action code: 73201

Parameters

RequestContent	{ Limit=1, Offset=0 }
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetMyJoinedGroupInfo()

FAccelByteTaskWPtr AccelByte::Api::Group::GetMyJoinedGroupInfo	(	FAccelByteModelsLimitOffsetRequest const &	RequestContent,
		THandler< FAccelByteModelsGetGroupMemberListResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get user group joined information. If user does not belong to any group, it will return warning to give information about it.

Required valid user authentication

Parameters

RequestContent	{ Limit=1, Offset=0 } for pagination.
OnSuccess	This will be called when the operation is succeeded.
OnError	This will be called when the operation is fail.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetMyJoinGroupRequest()

FAccelByteTaskWPtr AccelByte::Api::Group::GetMyJoinGroupRequest	(	FAccelByteModelsLimitOffsetRequest const &	RequestContent,
		THandler< FAccelByteModelsGetMemberRequestsListResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get My Join Request To The Groups. It will check any join request group for this user.

Required valid user authentication

Parameters

RequestContent	{ Limit=1, Offset=0 } for pagination.
OnSuccess	This will be called when the operation is succeeded. Result is FAccelByteModelsGetGroupMemberListResponse
OnError	This will be called when the operation is fail.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserGroupInfoByUserId()

FAccelByteTaskWPtr AccelByte::Api::Group::GetUserGroupInfoByUserId	(	FString const &	UserId,
		THandler< FAccelByteModelsGetUserGroupInfoResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Get list of group members by group id.

Required valid user auth.
get user group information by UserId.
If user !belongs to any group, a warning will return.
Group Member Status:
- JOIN: status of user requested to join group.
- INVITE: status of user invited to a group.
- JOINED: status of user already joined to a group.

Action code:: 73405

Parameters

UserId	of the selected user; you want want to get this user's list of group members.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ GetUserGroupStatusInfo()

FAccelByteTaskWPtr AccelByte::Api::Group::GetUserGroupStatusInfo	(	FString const &	UserId,
		FString const &	GroupId,
		THandler< FAccelByteModelsGetUserGroupInfoResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Gets user group status information.

Required valid user authentication
Required Member Role Permission: "GROUP [READ]"

Parameters

UserId
GroupId	The group id the user belongs to.
OnSuccess	This will be called when the operation succeeded. Result is FAccelByteModelsGetUserGroupInfoResponse&.
OnError	This will be called when the operation fail.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ InviteUserToGroup()

FAccelByteTaskWPtr AccelByte::Api::Group::InviteUserToGroup	(	FString const &	UserId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Invite the other user to your group.

Required valid user auth.
Required Member Role Permission: "GROUP:INVITE [CREATE]".
If specific user already has the join request, response will notify they have a pending accept / reject.
Invited user will receive notification through lobby.

Action code:: 73406

Parameters

UserId	of the user you want to invite to your group.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ InviteUserToV2Group()

FAccelByteTaskWPtr AccelByte::Api::Group::InviteUserToV2Group	(	FString const &	UserId,
		FString const &	GroupId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Invite the other user to your group.

Required valid user auth.
Required Member Role Permission: "GROUP:INVITE [CREATE]".
If specific user already has the join request, response will notify they have a pending accept / reject.
Invited user will receive notification through lobby.

Parameters

UserId	of the user you want to invite to your group.
GroupId	of the group.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ JoinGroup()

FAccelByteTaskWPtr AccelByte::Api::Group::JoinGroup	(	FString const &	GroupId,
		THandler< FAccelByteModelsJoinGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Join into specific group and become a group member.

Required valid user authentication.
Checks the the the group type based on the groupID.
Checks if the user who access this endpoint already joined the specific group.
Returns status field, for whether the user JOINED or REQUESTED to join the specific group.
More Info:
- User cannot join to the group with PRIVATE type.
- Joining PUBLIC group type will create join request and need approval. from the privileged group member to accept the request to become the member.
- Joining OPEN group type will make this user become member of that group immediately.

Action code: 73403

Parameters

GroupId	of the group you want to join.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ JoinV2Group()

FAccelByteTaskWPtr AccelByte::Api::Group::JoinV2Group	(	FString const &	GroupId,
		THandler< FAccelByteModelsJoinGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Join into specific group and become a group member.

Required valid user authentication.
Checks the the the group type based on the groupID.
Checks if the user who access this endpoint already joined the specific group.
Returns status field, for whether the user JOINED or REQUESTED to join the specific group.
More Info:
- User cannot join to the group with PRIVATE type.
- Joining PUBLIC group type will create join request and need approval. from the privileged group member to accept the request to become the member.
- Joining OPEN group type will make this user become member of that group immediately.

Parameters

GroupId	of the group you want to join.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ KickGroupMember()

FAccelByteTaskWPtr AccelByte::Api::Group::KickGroupMember	(	FString const &	UserId,
		THandler< FAccelByteModelsKickGroupMemberResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Kick a group member out of the group.

Required valid user auth.
Required Member Role Permission: "GROUP:KICK [CREATE]".
Validates the kicker's: member, group info and role perms.

Action code: 73409

Parameters

UserId	of the user you want to kick from your group.
OnSuccess	Called upon successful op. Returns { GroupId, KickedUserId }
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ KickV2GroupMember()

FAccelByteTaskWPtr AccelByte::Api::Group::KickV2GroupMember	(	FString const &	UserId,
		FString const &	GroupId,
		THandler< FAccelByteModelsKickGroupMemberResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Kick a group member out of the group.

Required valid user auth.
Required Member Role Permission: "GROUP:KICK [CREATE]".
Validates the kicker's: member, group info and role perms.

Parameters

UserId	of the user you want to kick from your group.
OnSuccess	Called upon successful op. Returns { GroupId, KickedUserId }
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ LeaveGroup()

FAccelByteTaskWPtr AccelByte::Api::Group::LeaveGroup	(	THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Leave the group you're currently in.

Required valid user authentication.
Admin is not allowed to leave the group.
Will also give response if user does not belong to any group.
Admin is not allowed to leave the group.
- If an Admin wants to leave the group, see DeleteGroup.
Still gives response if the user does not belong to any group.

Action code: 73404

Parameters

OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ LeaveV2Group()

FAccelByteTaskWPtr AccelByte::Api::Group::LeaveV2Group	(	FString const &	GroupId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Leave the group you're currently in.

Required valid user authentication.
Admin is not allowed to leave the group.
Will also give response if user does not belong to any group.
Admin is not allowed to leave the group.
- If an Admin wants to leave the group, see DeleteGroup.
Still gives response if the user does not belong to any group.

Parameters

GroupId	of the group you want to leave.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ RejectGroupInvitation()

FAccelByteTaskWPtr AccelByte::Api::Group::RejectGroupInvitation	(	FString const &	GroupId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Rejects an invitation from a 3rd-party group's group member to group up.

Required valid user authentication.
If specific user is !invited in the specific group ID, throw errorif the user !invited yet.
Checks if the user who access this endpoint already joined the specific group.

Action code: 73402

Parameters

GroupId	of the group that invited you, that you are rejecting the invite from.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ RejectGroupJoinRequest()

FAccelByteTaskWPtr AccelByte::Api::Group::RejectGroupJoinRequest	(	FString const &	UserId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Reject [other] user's group join request.

Required valid user auth.
Required Member Role Permission: "GROUP:JOIN [CREATE]".
If specific user was not asked to join this specific group, response will return error that they "need a join request".
Will also check if specific user already joined the specific group.
This also works when a user invites themselves (JoinGroup) to join a PUBLIC group.
- Rrather than an OPEN group players can just join.

Action code: 73408

Parameters

UserId	of the user you do NOT want to join your group.
OnSuccess	Called upon successful op. Returns { GroupId, UserId }
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ RejectV2GroupInvitation()

FAccelByteTaskWPtr AccelByte::Api::Group::RejectV2GroupInvitation	(	FString const &	GroupId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Rejects an invitation from a 3rd-party group's group member to group up.

Required valid user authentication.
If specific user is !invited in the specific group ID, throw errorif the user !invited yet.
Checks if the user who access this endpoint already joined the specific group.

Parameters

GroupId	of the group that invited you, that you are rejecting the invite from.
OnSuccess	Called upon successful op.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ RejectV2GroupJoinRequest()

FAccelByteTaskWPtr AccelByte::Api::Group::RejectV2GroupJoinRequest	(	FString const &	UserId,
		FString const &	GroupId,
		THandler< FAccelByteModelsMemberRequestGroupResponse > const &	OnSuccess,
		FErrorHandler const &	OnError )

Reject [other] user's group join request.

Required valid user auth.
Required Member Role Permission: "GROUP:JOIN [CREATE]".
If specific user was not asked to join this specific group, response will return error that they "need a join request".
Will also check if specific user already joined the specific group.
This also works when a user invites themselves (JoinGroup) to join a PUBLIC group.
- Rrather than an OPEN group players can just join.

Parameters

UserId	of the user you do NOT want to join your group.
GroupId	of the group.
OnSuccess	Called upon successful op. Returns { GroupId, UserId }
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateGroup()

FAccelByteTaskWPtr AccelByte::Api::Group::UpdateGroup	(	FString const &	GroupId,
		bool	bCompletelyReplace,
		FAccelByteModelsGroupUpdatable const &	RequestContent,
		THandler< FAccelByteModelsGroupInformation > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update existing group.

Required valid user authentication.
Required Member Role Permission: "GROUP [UPDATE]".
Checks the group ID of the user based on the access token and compares it with the group ID in path parameter.
Checks the member role of the user based on the access token.
Supports partial update (empty elements will convert to null)

Action Code: 73307

Parameters

GroupId
bCompletelyReplace	Instead of partially-update, do you want to completely replace ALL info?
RequestContent
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateGroupCustomAttributes()

FAccelByteTaskWPtr AccelByte::Api::Group::UpdateGroupCustomAttributes	(	FString const &	GroupId,
		FAccelByteModelsUpdateGroupCustomAttributesRequest const &	RequestContent,
		THandler< FAccelByteModelsGroupInformation > const &	OnSuccess,
		FErrorHandler const &	OnError )

Replaces current group custom attributes entirely.

Requires valid user authentication.
Required Member Role Permission: "GROUP [UPDATE]".
Checks group ID of the user based on the access token and compares with group ID in path param.
Checks the member role of the user based on the access token.

Action code:: 73311

Parameters

GroupId
RequestContent	Arbitrary {}.
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateGroupCustomRule()

FAccelByteTaskWPtr AccelByte::Api::Group::UpdateGroupCustomRule	(	FString const &	GroupId,
		FAccelByteModelsUpdateCustomRulesRequest const &	RequestContent,
		THandler< FAccelByteModelsGroupInformation > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update custom (arbitrary) group rule.

Required valid user authentication.
Checks group ID of the user (via access token) and compares with group ID in path param.
Checks member role of the user based on access token.

Action code:: 73308

Parameters

GroupId
RequestContent	Arbitrary {}.
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateGroupPredefinedRule()

FAccelByteTaskWPtr AccelByte::Api::Group::UpdateGroupPredefinedRule	(	FString const &	GroupId,
		EAccelByteAllowedAction	AllowedAction,
		FAccelByteModelsUpdateGroupPredefinedRuleRequest const &	RequestContent,
		THandler< FAccelByteModelsGroupInformation > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update predefined group rule.

Required valid user authentication.
Required Member Role Permission: "GROUP [UPDATE]".
Checks group ID of the user (via access token) and compares with group ID in path param.
Checks member role of the user based on access token.
If rule action is not defined in the group, it will be added immediately.

Action code:: 73310

Parameters

GroupId
AllowedAction	eg: createGroup, joinedGroup.
RequestContent	RuleDetail { RuleAttribute, RuleCriteria, RuleValue }.
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateV2Group()

FAccelByteTaskWPtr AccelByte::Api::Group::UpdateV2Group	(	FString const &	GroupId,
		FAccelByteModelsUpdateGroupRequest const &	RequestContent,
		THandler< FAccelByteModelsGroupInformation > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update existing group.

Required valid user authentication.
Required Member Role Permission: "GROUP [UPDATE]".
Checks the group ID of the user based on the access token and compares it with the group ID in path parameter.
Checks the member role of the user based on the access token.
Supports partial update (empty elements will convert to null)

Parameters

GroupId
RequestContent
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateV2GroupCustomAttributes()

FAccelByteTaskWPtr AccelByte::Api::Group::UpdateV2GroupCustomAttributes	(	FString const &	GroupId,
		FAccelByteModelsUpdateGroupCustomAttributesRequest const &	RequestContent,
		THandler< FAccelByteModelsGroupInformation > const &	OnSuccess,
		FErrorHandler const &	OnError )

Replaces current group custom attributes entirely.

Requires valid user authentication.
Required Member Role Permission: "GROUP [UPDATE]".
Checks group ID of the user based on the access token and compares with group ID in path param.
Checks the member role of the user based on the access token.

Parameters

GroupId
RequestContent	Arbitrary {}.
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	This will be called when the operation failed.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateV2GroupCustomRule()

FAccelByteTaskWPtr AccelByte::Api::Group::UpdateV2GroupCustomRule	(	FString const &	GroupId,
		FAccelByteModelsUpdateCustomRulesRequest const &	RequestContent,
		THandler< FAccelByteModelsGroupInformation > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update custom (arbitrary) group rule.

Required valid user authentication.
Checks group ID of the user (via access token) and compares with group ID in path param.
Checks member role of the user based on access token.

Parameters

GroupId
RequestContent	Arbitrary {}.
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

◆ UpdateV2GroupPredefinedRule()

FAccelByteTaskWPtr AccelByte::Api::Group::UpdateV2GroupPredefinedRule	(	FString const &	GroupId,
		EAccelByteAllowedAction	AllowedAction,
		FAccelByteModelsUpdateGroupPredefinedRuleRequest const &	RequestContent,
		THandler< FAccelByteModelsGroupInformation > const &	OnSuccess,
		FErrorHandler const &	OnError )

Update predefined group rule.

Required valid user authentication.
Required Member Role Permission: "GROUP [UPDATE]".
Checks group ID of the user (via access token) and compares with group ID in path param.
Checks member role of the user based on access token.
If rule action is not defined in the group, it will be added immediately.

Parameters

GroupId
AllowedAction	eg: createGroup, joinedGroup.
RequestContent	RuleDetail { RuleAttribute, RuleCriteria, RuleValue }.
OnSuccess	This will be called when the operation succeeded. Result is const FAccelByteModelsGroupInformationResponse&.
OnError	Called upon failed op.

Returns: AccelByteTask object to track and cancel the ongoing API operation.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AcceptGroupInvitation()

◆ AcceptGroupJoinRequest()

◆ AcceptV2GroupInvitation()

◆ AcceptV2GroupJoinRequest()

◆ AssignMemberRole()

◆ AssignV2MemberRole()

◆ CancelGroupMemberInvitation()

◆ CancelJoinGroupRequest()

◆ CreateGroup()

◆ CreateV2Group()

◆ DeleteGroup()

◆ DeleteGroupPredefinedRule()

◆ DeleteMemberRole()

◆ DeleteV2Group()

◆ DeleteV2GroupPredefinedRule()

◆ DeleteV2MemberRole()

◆ GetAllMemberRoles()

◆ GetGroup()

◆ GetGroupInvitationRequests()

◆ GetGroupInviteRequestList()

◆ GetGroupJoinRequestList()

◆ GetGroupJoinRequests()

◆ GetGroupList()

◆ GetGroupMembersListByGroupId()

◆ GetGroupsByGroupIds()

◆ GetMemberRoles()

◆ GetMyJoinedGroupInfo()

◆ GetMyJoinGroupRequest()

◆ GetUserGroupInfoByUserId()

◆ GetUserGroupStatusInfo()

◆ InviteUserToGroup()

◆ InviteUserToV2Group()

◆ JoinGroup()

◆ JoinV2Group()

◆ KickGroupMember()

◆ KickV2GroupMember()

◆ LeaveGroup()

◆ LeaveV2Group()

◆ RejectGroupInvitation()

◆ RejectGroupJoinRequest()

◆ RejectV2GroupInvitation()

◆ RejectV2GroupJoinRequest()

◆ UpdateGroup()

◆ UpdateGroupCustomAttributes()

◆ UpdateGroupCustomRule()

◆ UpdateGroupPredefinedRule()

◆ UpdateV2Group()

◆ UpdateV2GroupCustomAttributes()

◆ UpdateV2GroupCustomRule()

◆ UpdateV2GroupPredefinedRule()