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

#include <ABGroup.h>

Inheritance diagram for UABGroup:

Public Member Functions
void	SetApiClient (AccelByte::FApiClientPtr const &NewApiClientPtr)
void	GetGroupList (const FAccelByteModelsGetGroupListRequest &RequestContent, const FSearchGroupsSuccess &OnSuccess, const FDErrorHandler &OnError)
	AKA "SearchGroups"; get list of groups.
void	CreateGroup (const FAccelByteModelsCreateGroupRequest &RequestContent, const FCreateGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Creates a new group.
void	GetGroup (const FString &GroupId, const FGetGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Get single single group info (by groupId).
void	UpdateGroup (const FString &GroupId, const bool bCompletelyReplace, const FAccelByteModelsGroupUpdatable &RequestContent, const FUpdateGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Update existing group.
void	DeleteGroup (const FString &GroupId, const FDeleteGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Delete existing group.
void	UpdateGroupCustomAttributes (const FString &GroupId, const FAccelByteModelsUpdateGroupCustomAttributesRequest &RequestContent, const FUpdateGroupCustomAttributesSuccess &OnSuccess, const FDErrorHandler &OnError)
	Replaces current group custom attributes entirely.
void	UpdateGroupCustomRule (const FString &GroupId, const FAccelByteModelsUpdateCustomRulesRequest &RequestContent, const FUpdateGroupCustomRuleSuccess &OnSuccess, const FDErrorHandler &OnError)
	Update custom (arbitrary) group rule.
void	UpdateGroupPredefinedRule (const FString &GroupId, const EAccelByteAllowedAction &AllowedAction, const FAccelByteModelsUpdateGroupPredefinedRuleRequest &RequestContent, const FUpdateGroupPredefinedRuleSuccess &OnSuccess, const FDErrorHandler &OnError)
	Update predefined group rule.
void	DeleteGroupPredefinedRule (const FString &GroupId, const EAccelByteAllowedAction &AllowedAction, const FDeleteGroupPredefinedRuleSuccess &OnSuccess, const FDErrorHandler &OnError)
	Delete predefined group rule, based on the allowed action.
void	AcceptGroupInvitation (const FString &GroupId, const FAcceptGroupInvitationSuccess &OnSuccess, const FDErrorHandler &OnError)
	Accepts an invitation from a 3rd-party group's group member to group up.
void	RejectGroupInvitation (const FString &GroupId, const FRejectGroupInvitationSuccess &OnSuccess, const FDErrorHandler &OnError)
	Rejects an invitation from a 3rd-party group's group member to group up.
void	JoinGroup (const FString &GroupId, const FJoinGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Join into specific group and become a group member.
void	CancelJoinGroupRequest (const FString &GroupId, const FCancelJoinGroupRequestSuccess &OnSuccess, const FDErrorHandler &OnError)
	Cancel the Join group request.
void	GetGroupMembersListByGroupId (const FString &GroupId, const FAccelByteModelsGetGroupMembersListByGroupIdRequest &RequestContent, const FGetGroupMembersListByGroupIdSuccess &OnSuccess, const FDErrorHandler &OnError)
	Get list of group members (by GroupId).
void	LeaveGroup (const FLeaveGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Leave the group you're currently in.
void	GetUserGroupInfoByUserId (const FString &UserId, const FGetUserGroupInfoByUserIdSuccess &OnSuccess, const FDErrorHandler &OnError)
	Get list of group members by group id.
void	InviteUserToGroup (const FString &UserId, const FInviteUserToGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Invite the other user to your group.
void	AcceptGroupJoinRequest (const FString &UserId, const FAcceptGroupJoinRequestSuccess &OnSuccess, const FDErrorHandler &OnError)
	Accept [other] user's group join request.
void	RejectGroupJoinRequest (const FString &UserId, const FRejectGroupJoinRequestSuccess &OnSuccess, const FDErrorHandler &OnError)
	Reject [other] user's group join request.
void	KickGroupMember (const FString &UserId, const FKickGroupMemberSuccess &OnSuccess, const FDErrorHandler &OnError)
	Kick a group member out of the group.
void	GetMemberRoles (const FAccelByteModelsLimitOffsetRequest &RequestContent, const FGetMemberRolesSuccess &OnSuccess, const FDErrorHandler &OnError)
	Get list of [group] member roles.
void	AssignMemberRole (const FString &MemberRoleId, const FAccelByteModelsUserIdWrapper &RequestContent, const FAssignMemberRoleSuccess &OnSuccess, const FDErrorHandler &OnError)
	Assign a role to a group member.
void	DeleteMemberRole (const FString &MemberRoleId, const FAccelByteModelsUserIdWrapper &RequestContent, const FDeleteMemberRoleSuccess &OnSuccess, const FDErrorHandler &OnError)
	Remove a role from a group member.
void	GetGroupJoinRequests (const FString &GroupId, const FAccelByteModelsLimitOffsetRequest &RequestContent, const FGetGroupJoinRequestsSuccess &OnSuccess, const FDErrorHandler &OnError)
	Get list of join requests in a specific group.
void	GetGroupInvitationRequests (const FAccelByteModelsLimitOffsetRequest &RequestContent, const FGetGroupInvitationRequestsSuccess &OnSuccess, const FDErrorHandler &OnError)
	Get group invitation request list for the user calling this endpoint.
void	CreateV2Group (const FAccelByteModelsCreateGroupRequest &RequestContent, const FCreateGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Creates a new group.
void	GetGroupsByGroupIds (const TArray< FString > &GroupIds, const FGetGroupsByGroupIdsSuccess &OnSuccess, const FDErrorHandler &OnError)
	Gets a collection of group information.
void	UpdateV2Group (const FString &GroupId, const FAccelByteModelsUpdateGroupRequest &RequestContent, const FUpdateGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Update existing group.
void	DeleteV2Group (const FString &GroupId, const FDeleteGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Delete existing group.
void	UpdateV2GroupCustomAttributes (const FString &GroupId, const FAccelByteModelsUpdateGroupCustomAttributesRequest &RequestContent, const FUpdateGroupCustomAttributesSuccess &OnSuccess, const FDErrorHandler &OnError)
	Replaces current group custom attributes entirely.
void	UpdateV2GroupCustomRule (const FString &GroupId, const FAccelByteModelsUpdateCustomRulesRequest &RequestContent, const FUpdateGroupCustomRuleSuccess &OnSuccess, const FDErrorHandler &OnError)
	Update custom (arbitrary) group rule.
void	UpdateV2GroupPredefinedRule (const FString &GroupId, const EAccelByteAllowedAction &AllowedAction, const FAccelByteModelsUpdateGroupPredefinedRuleRequest &RequestContent, const FUpdateGroupPredefinedRuleSuccess &OnSuccess, const FDErrorHandler &OnError)
	Update predefined group rule.
void	DeleteV2GroupPredefinedRule (const FString &GroupId, const EAccelByteAllowedAction &AllowedAction, const FDeleteGroupPredefinedRuleSuccess &OnSuccess, const FDErrorHandler &OnError)
	Delete predefined group rule, based on the allowed action.
void	GetUserGroupStatusInfo (const FString &UserId, const FString &GroupId, const FGetUserGroupInfoSuccess &OnSuccess, const FDErrorHandler OnError)
	Gets user group status information.
void	GetGroupInviteRequestList (const FString &GroupId, const FAccelByteModelsLimitOffsetRequest &RequestContent, const FGetGroupInvitationRequestsSuccess &OnSuccess, const FDErrorHandler &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.
void	GetGroupJoinRequestList (const FString &GroupId, const FAccelByteModelsLimitOffsetRequest &RequestContent, const FGetGroupJoinRequestsSuccess &OnSuccess, const FDErrorHandler &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.
void	CancelGroupMemberInvitation (const FString &UserId, const FString &GroupId, const FCanceGroupInviteRequestSuccess &OnSuccess, const FDErrorHandler &OnError)
	Cancel invitation to specific user.
void	AcceptV2GroupInvitation (const FString &GroupId, const FAcceptGroupInvitationSuccess &OnSuccess, const FDErrorHandler &OnError)
	Accepts an invitation from a 3rd-party group's group member to group up.
void	RejectV2GroupInvitation (const FString &GroupId, const FRejectGroupInvitationSuccess &OnSuccess, const FDErrorHandler &OnError)
	Rejects an invitation from a 3rd-party group's group member to group up.
void	JoinV2Group (const FString &GroupId, const FJoinGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Join into specific group and become a group member.
void	LeaveV2Group (const FString &GroupId, const FLeaveGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Leave the group you're currently in.
void	InviteUserToV2Group (const FString &UserId, const FString &GroupId, const FInviteUserToGroupSuccess &OnSuccess, const FDErrorHandler &OnError)
	Invite the other user to your group.
void	AcceptV2GroupJoinRequest (const FString &UserId, const FString &GroupId, const FAcceptGroupJoinRequestSuccess &OnSuccess, const FDErrorHandler &OnError)
	Accept [other] user's group join request.
void	RejectV2GroupJoinRequest (const FString &UserId, const FString &GroupId, const FRejectGroupJoinRequestSuccess &OnSuccess, const FDErrorHandler &OnError)
	Reject [other] user's group join request.
void	KickV2GroupMember (const FString &UserId, const FString &GroupId, const FKickGroupMemberSuccess &OnSuccess, const FDErrorHandler &OnError)
	Kick a group member out of the group.
void	GetMyJoinedGroupInfo (const FAccelByteModelsLimitOffsetRequest &RequestContent, const FGetMyJoinedGroupInfoSuccess &OnSuccess, const FDErrorHandler &OnError)
	Get user group joined information. If user does not belong to any group, it will return warning to give information about it.
void	GetMyJoinGroupRequest (const FAccelByteModelsLimitOffsetRequest &RequestContent, const FGetMyJoinGroupRequestSuccess &OnSuccess, const FDErrorHandler &OnError)
	Get My Join Request To The Groups. It will check any join request group for this user.
void	AssignV2MemberRole (const FString &MemberRoleId, const FString &GroupId, const FAccelByteModelsUserIdWrapper &RequestContent, const FAssignMemberRoleSuccess &OnSuccess, const FDErrorHandler &OnError)
	Assign a role to a group member.
void	DeleteV2MemberRole (const FString &MemberRoleId, const FString &GroupId, const FAccelByteModelsUserIdWrapper &RequestContent, const FDeleteMemberRoleSuccess &OnSuccess, const FDErrorHandler &OnError)
	Remove a role from a group member.
void	GetAllMemberRoles (const FAccelByteModelsLimitOffsetRequest &RequestContent, const FGetMemberRolesSuccess &OnSuccess, const FDErrorHandler &OnError)
	Get list of member roles.

Detailed Description

Provide APIs to access Group [Management] service.

While authed, Namespace is automatically passed to all Requests.

Member Function Documentation

◆ AcceptGroupInvitation()

void UABGroup::AcceptGroupInvitation	(	const FString &	GroupId,
		const FAcceptGroupInvitationSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ AcceptGroupJoinRequest()

void UABGroup::AcceptGroupJoinRequest	(	const FString &	UserId,
		const FAcceptGroupJoinRequestSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ AcceptV2GroupInvitation()

void UABGroup::AcceptV2GroupInvitation	(	const FString &	GroupId,
		const FAcceptGroupInvitationSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ AcceptV2GroupJoinRequest()

void UABGroup::AcceptV2GroupJoinRequest	(	const FString &	UserId,
		const FString &	GroupId,
		const FAcceptGroupJoinRequestSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ AssignMemberRole()

void UABGroup::AssignMemberRole	(	const FString &	MemberRoleId,
		const FAccelByteModelsUserIdWrapper &	RequestContent,
		const FAssignMemberRoleSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ AssignV2MemberRole()

void UABGroup::AssignV2MemberRole	(	const FString &	MemberRoleId,
		const FString &	GroupId,
		const FAccelByteModelsUserIdWrapper &	RequestContent,
		const FAssignMemberRoleSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ CancelGroupMemberInvitation()

void UABGroup::CancelGroupMemberInvitation	(	const FString &	UserId,
		const FString &	GroupId,
		const FCanceGroupInviteRequestSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ CancelJoinGroupRequest()

void UABGroup::CancelJoinGroupRequest	(	const FString &	GroupId,
		const FCancelJoinGroupRequestSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ CreateGroup()

void UABGroup::CreateGroup	(	const FAccelByteModelsCreateGroupRequest &	RequestContent,
		const FCreateGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ CreateV2Group()

void UABGroup::CreateV2Group	(	const FAccelByteModelsCreateGroupRequest &	RequestContent,
		const FCreateGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ DeleteGroup()

void UABGroup::DeleteGroup	(	const FString &	GroupId,
		const FDeleteGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ DeleteGroupPredefinedRule()

void UABGroup::DeleteGroupPredefinedRule	(	const FString &	GroupId,
		const EAccelByteAllowedAction &	AllowedAction,
		const FDeleteGroupPredefinedRuleSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ DeleteMemberRole()

void UABGroup::DeleteMemberRole	(	const FString &	MemberRoleId,
		const FAccelByteModelsUserIdWrapper &	RequestContent,
		const FDeleteMemberRoleSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ DeleteV2Group()

void UABGroup::DeleteV2Group	(	const FString &	GroupId,
		const FDeleteGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ DeleteV2GroupPredefinedRule()

void UABGroup::DeleteV2GroupPredefinedRule	(	const FString &	GroupId,
		const EAccelByteAllowedAction &	AllowedAction,
		const FDeleteGroupPredefinedRuleSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ DeleteV2MemberRole()

void UABGroup::DeleteV2MemberRole	(	const FString &	MemberRoleId,
		const FString &	GroupId,
		const FAccelByteModelsUserIdWrapper &	RequestContent,
		const FDeleteMemberRoleSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetAllMemberRoles()

void UABGroup::GetAllMemberRoles	(	const FAccelByteModelsLimitOffsetRequest &	RequestContent,
		const FGetMemberRolesSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetGroup()

void UABGroup::GetGroup	(	const FString &	GroupId,
		const FGetGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetGroupInvitationRequests()

void UABGroup::GetGroupInvitationRequests	(	const FAccelByteModelsLimitOffsetRequest &	RequestContent,
		const FGetGroupInvitationRequestsSuccess &	OnSuccess,
		const FDErrorHandler &	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

◆ GetGroupInviteRequestList()

void UABGroup::GetGroupInviteRequestList	(	const FString &	GroupId,
		const FAccelByteModelsLimitOffsetRequest &	RequestContent,
		const FGetGroupInvitationRequestsSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetGroupJoinRequestList()

void UABGroup::GetGroupJoinRequestList	(	const FString &	GroupId,
		const FAccelByteModelsLimitOffsetRequest &	RequestContent,
		const FGetGroupJoinRequestsSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetGroupJoinRequests()

void UABGroup::GetGroupJoinRequests	(	const FString &	GroupId,
		const FAccelByteModelsLimitOffsetRequest &	RequestContent,
		const FGetGroupJoinRequestsSuccess &	OnSuccess,
		const FDErrorHandler &	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

◆ GetGroupList()

void UABGroup::GetGroupList	(	const FAccelByteModelsGetGroupListRequest &	RequestContent,
		const FSearchGroupsSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetGroupMembersListByGroupId()

void UABGroup::GetGroupMembersListByGroupId	(	const FString &	GroupId,
		const FAccelByteModelsGetGroupMembersListByGroupIdRequest &	RequestContent,
		const FGetGroupMembersListByGroupIdSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetGroupsByGroupIds()

void UABGroup::GetGroupsByGroupIds	(	const TArray< FString > &	GroupIds,
		const FGetGroupsByGroupIdsSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetMemberRoles()

void UABGroup::GetMemberRoles	(	const FAccelByteModelsLimitOffsetRequest &	RequestContent,
		const FGetMemberRolesSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetMyJoinedGroupInfo()

void UABGroup::GetMyJoinedGroupInfo	(	const FAccelByteModelsLimitOffsetRequest &	RequestContent,
		const FGetMyJoinedGroupInfoSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetMyJoinGroupRequest()

void UABGroup::GetMyJoinGroupRequest	(	const FAccelByteModelsLimitOffsetRequest &	RequestContent,
		const FGetMyJoinGroupRequestSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetUserGroupInfoByUserId()

void UABGroup::GetUserGroupInfoByUserId	(	const FString &	UserId,
		const FGetUserGroupInfoByUserIdSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ GetUserGroupStatusInfo()

void UABGroup::GetUserGroupStatusInfo	(	const FString &	UserId,
		const FString &	GroupId,
		const FGetUserGroupInfoSuccess &	OnSuccess,
		const FDErrorHandler	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.

◆ InviteUserToGroup()

void UABGroup::InviteUserToGroup	(	const FString &	UserId,
		const FInviteUserToGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ InviteUserToV2Group()

void UABGroup::InviteUserToV2Group	(	const FString &	UserId,
		const FString &	GroupId,
		const FInviteUserToGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ JoinGroup()

void UABGroup::JoinGroup	(	const FString &	GroupId,
		const FJoinGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ JoinV2Group()

void UABGroup::JoinV2Group	(	const FString &	GroupId,
		const FJoinGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ KickGroupMember()

void UABGroup::KickGroupMember	(	const FString &	UserId,
		const FKickGroupMemberSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ KickV2GroupMember()

void UABGroup::KickV2GroupMember	(	const FString &	UserId,
		const FString &	GroupId,
		const FKickGroupMemberSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ LeaveGroup()

void UABGroup::LeaveGroup	(	const FLeaveGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ LeaveV2Group()

void UABGroup::LeaveV2Group	(	const FString &	GroupId,
		const FLeaveGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ RejectGroupInvitation()

void UABGroup::RejectGroupInvitation	(	const FString &	GroupId,
		const FRejectGroupInvitationSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ RejectGroupJoinRequest()

void UABGroup::RejectGroupJoinRequest	(	const FString &	UserId,
		const FRejectGroupJoinRequestSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ RejectV2GroupInvitation()

void UABGroup::RejectV2GroupInvitation	(	const FString &	GroupId,
		const FRejectGroupInvitationSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ RejectV2GroupJoinRequest()

void UABGroup::RejectV2GroupJoinRequest	(	const FString &	UserId,
		const FString &	GroupId,
		const FRejectGroupJoinRequestSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ UpdateGroup()

void UABGroup::UpdateGroup	(	const FString &	GroupId,
		const bool	bCompletelyReplace,
		const FAccelByteModelsGroupUpdatable &	RequestContent,
		const FUpdateGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ UpdateGroupCustomAttributes()

void UABGroup::UpdateGroupCustomAttributes	(	const FString &	GroupId,
		const FAccelByteModelsUpdateGroupCustomAttributesRequest &	RequestContent,
		const FUpdateGroupCustomAttributesSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ UpdateGroupCustomRule()

void UABGroup::UpdateGroupCustomRule	(	const FString &	GroupId,
		const FAccelByteModelsUpdateCustomRulesRequest &	RequestContent,
		const FUpdateGroupCustomRuleSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ UpdateGroupPredefinedRule()

void UABGroup::UpdateGroupPredefinedRule	(	const FString &	GroupId,
		const EAccelByteAllowedAction &	AllowedAction,
		const FAccelByteModelsUpdateGroupPredefinedRuleRequest &	RequestContent,
		const FUpdateGroupPredefinedRuleSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ UpdateV2Group()

void UABGroup::UpdateV2Group	(	const FString &	GroupId,
		const FAccelByteModelsUpdateGroupRequest &	RequestContent,
		const FUpdateGroupSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ UpdateV2GroupCustomAttributes()

void UABGroup::UpdateV2GroupCustomAttributes	(	const FString &	GroupId,
		const FAccelByteModelsUpdateGroupCustomAttributesRequest &	RequestContent,
		const FUpdateGroupCustomAttributesSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ UpdateV2GroupCustomRule()

void UABGroup::UpdateV2GroupCustomRule	(	const FString &	GroupId,
		const FAccelByteModelsUpdateCustomRulesRequest &	RequestContent,
		const FUpdateGroupCustomRuleSuccess &	OnSuccess,
		const FDErrorHandler &	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.

◆ UpdateV2GroupPredefinedRule()

void UABGroup::UpdateV2GroupPredefinedRule	(	const FString &	GroupId,
		const EAccelByteAllowedAction &	AllowedAction,
		const FAccelByteModelsUpdateGroupPredefinedRuleRequest &	RequestContent,
		const FUpdateGroupPredefinedRuleSuccess &	OnSuccess,
		const FDErrorHandler &	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.

Public Member Functions

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()