AccelByte.Api.Group Class Reference

Provide an API to access Group service. More...

Inheritance diagram for AccelByte.Api.Group:

Public Member Functions
void	CreateGroup (CreateGroupRequest createGroupRequest, ResultCallback< GroupInformation > callback)
	Create new group. It will use the authorization to determine the user ID which will be used as the group admin.
void	CreateGroupV2 (CreateGroupRequest createGroupRequest, ResultCallback< GroupInformation > callback)
	Create new group. It will use the authorization to determine the user ID which will be used as the group admin.
void	SearchGroups (string groupName, string groupRegion, int limit, int offset, ResultCallback< PaginatedGroupListResponse > callback)
	Get list of groups. It will only show OPEN and PUBLIC group type.
void	SearchGroups (string groupName, int limit, int offset, ResultCallback< PaginatedGroupListResponse > callback)
	Get list of groups. It will only show OPEN and PUBLIC group type.
void	SearchGroups (string groupName, string groupRegion, ResultCallback< PaginatedGroupListResponse > callback)
	Get list of groups. It will only show OPEN and PUBLIC group type.
void	SearchGroups (string groupName, ResultCallback< PaginatedGroupListResponse > callback)
	Get list of groups. It will only show OPEN and PUBLIC group type.
void	SearchGroups (int limit, int offset, ResultCallback< PaginatedGroupListResponse > callback)
	Get list of groups. It will only show OPEN and PUBLIC group type.
void	SearchGroups (ResultCallback< PaginatedGroupListResponse > callback)
	Get list of groups. It will only show OPEN and PUBLIC group type.
void	GetGroup (string groupId, ResultCallback< GroupInformation > callback)
	Get single group information based on its id.
void	UpdateGroup (string groupId, UpdateGroupRequest updateGroupRequest, ResultCallback< GroupInformation > callback)
	Update specific single group information.
void	UpdateGroupV2 (string groupId, UpdateGroupRequest updateGroupRequest, ResultCallback< GroupInformation > callback)
	Update specific single group information.
void	UpdateGroupCustomAttributes (string groupId, Dictionary< string, object > customAttributes, ResultCallback< GroupInformation > callback)
	Update specific single group custom attributes information.
void	DeleteGroup (string groupId, ResultCallback callback)
	Delete specific single group.
void	DeleteGroupV2 (string groupId, ResultCallback callback)
	Delete specific single group.
void	UpdateGroupCustomRule (string groupId, Dictionary< string, object > ruleUpdateRequest, ResultCallback< GroupInformation > callback)
	Update group custom rule.
void	UpdateGroupCustomRuleV2 (string groupId, Dictionary< string, object > ruleUpdateRequest, ResultCallback< GroupInformation > callback)
	Update group custom rule.
void	UpdateGroupPredefinedRule (string groupId, AllowedAction allowedAction, UpdateGroupPredefinedRuleRequest ruleUpdateRequest, ResultCallback< GroupInformation > callback)
	Update predefined group rule.
void	UpdateGroupPredefinedRuleV2 (string groupId, AllowedAction allowedAction, UpdateGroupPredefinedRuleRequest ruleUpdateRequest, ResultCallback< GroupInformation > callback)
	Update predefined group rule.
void	DeleteGroupPredefinedRule (string groupId, AllowedAction allowedAction, ResultCallback callback)
	Delete predefined group rule.
void	DeleteGroupPredefinedRuleV2 (string groupId, AllowedAction allowedAction, ResultCallback callback)
	Delete predefined group rule.
void	GetMyGroupInfo (ResultCallback< GroupMemberInformation > callback)
	Get user's group information.
void	GetOtherGroupInfo (string userId, ResultCallback< GroupMemberInformation > callback)
	Get other user's group information.
void	AcceptGroupInvitation (string groupId, ResultCallback< GroupGeneralResponse > callback)
	Accepting group invitation.
void	AcceptGroupInvitationV2 (string groupId, ResultCallback< GroupGeneralResponse > callback)
	Accepting group invitation.
void	RejectGroupInvitation (string groupId, ResultCallback< GroupGeneralResponse > callback)
	Rejecting group invitation.
void	RejectGroupInvitationV2 (string groupId, ResultCallback< GroupGeneralResponse > callback)
	Rejecting group invitation.
void	InviteOtherUserToGroup (string otherUserId, ResultCallback< UserInvitationResponse > callback)
	Invite the other user to your group.
void	InviteOtherUserToGroupV2 (string otherUserId, string groupId, ResultCallback< UserInvitationResponse > callback)
	Invite the other user to your group.
void	JoinGroup (string groupId, ResultCallback< JoinGroupResponse > callback)
	Join into specific group.
void	JoinGroupV2 (string groupId, ResultCallback< JoinGroupResponse > callback)
	Join into specific group.
void	CancelJoinGroupRequest (string groupId, ResultCallback< GroupGeneralResponse > callback)
	Cancel the Join group request.
void	GetGroupMemberList (string groupId, ResultCallback< PaginatedGroupMemberList > callback)
	Get member list of specific group.
void	GetGroupMemberList (string groupId, int limit, int offset, ResultCallback< PaginatedGroupMemberList > callback)
	Get member list of specific group.
void	KickGroupMember (string otherUserId, ResultCallback< KickMemberResponse > callback)
	Kick a member out of group.
void	KickGroupMemberV2 (string otherUserId, string groupId, ResultCallback< KickMemberResponse > callback)
	Kick a member out of group.
void	LeaveGroup (ResultCallback< GroupGeneralResponse > callback)
	Leave the group you're in.
void	LeaveGroupV2 (string groupId, ResultCallback< GroupGeneralResponse > callback)
	Leave the group you're in.
void	GetGroupJoinRequests (string groupId, int limit, int offset, ResultCallback< PaginatedGroupRequestList > callback)
	Get list of join request in group.
void	GetGroupJoinRequests (string groupId, ResultCallback< PaginatedGroupRequestList > callback)
	Get list of join request in group.
void	GetGroupJoinRequestsV2 (string groupId, int limit, int offset, ResultCallback< PaginatedGroupRequestList > callback)
	Get list of join request in group.
void	GetGroupInvitationRequests (int limit, int offset, ResultCallback< PaginatedGroupRequestList > callback)
	Get list of group invitation request.
void	GetGroupInvitationRequests (ResultCallback< PaginatedGroupRequestList > callback)
	Get list of group invitation request.
void	GetGroupInvitationRequestsV2 (string groupId, ResultCallback< PaginatedGroupRequestList > callback)
	Get list of group invitation request.
void	AcceptOtherJoinRequest (string otherUserId, ResultCallback< GroupGeneralResponse > callback)
	Accept other user join group request.
void	AcceptOtherJoinRequestV2 (string otherUserId, string groupId, ResultCallback< GroupGeneralResponse > callback)
	Accept other user join group request.
void	RejectOtherJoinRequest (string otherUserId, ResultCallback< GroupGeneralResponse > callback)
	Reject other user join group request.
void	RejectOtherJoinRequestV2 (string otherUserId, string groupId, ResultCallback< GroupGeneralResponse > callback)
	Reject other user join group request.
void	AssignRoleToMember (string memberRoleId, string userId, ResultCallback< GroupMemberInformation > callback)
	Assign a role to a group member.
void	AssignRoleToMemberV2 (string memberRoleId, string userId, string groupId, ResultCallback< GroupMemberInformation > callback)
	Assign a role to a group member.
void	RemoveRoleFromMember (string memberRoleId, string userId, ResultCallback callback)
	Remove a role from a group member.
void	RemoveRoleFromMemberV2 (string memberRoleId, string userId, string groupId, ResultCallback callback)
	Remove a role from a group member.
void	GetMemberRoles (int limit, int offset, ResultCallback< PaginatedMemberRoles > callback)
	Get list of member role on the namespace.
void	GetMemberRoles (ResultCallback< PaginatedMemberRoles > callback)
	Get list of member role on the namespace.
void	GetGroupsByGroupIds (string[] groupIds, ResultCallback< PaginatedGroupListResponse > callback)
	Get list of groups based on group ids.
void	GetUserJoinedGroups (int limit, int offset, ResultCallback< PaginatedGroupMemberList > callback)
	Get user joined groups information.
void	CancelGroupMemberInvitation (string userId, string groupId, ResultCallback< GroupGeneralResponse > callback)
	Cancel group member invitation.
void	UpdateGroupCustomAttributesV2 (string groupId, Dictionary< string, object > customAttributes, ResultCallback< GroupInformation > callback)
	Update group custom attributes.
void	GetUserGroupStatusInfo (string userId, string groupId, ResultCallback< GroupMemberInformation > callback)
	Get user group status information. This API will check the member and group information, and also the role permission.
void	GetMyJoinRequest (int limit, int offset, ResultCallback< PaginatedGroupRequestList > callback)
	Get My Join Request To The Groups.

Additional Inherited Members
Properties inherited from AccelByte.Core.WrapperBase
Utils.AccelByteIdValidator	IdValidator [get]

Detailed Description

Provide an API to access Group service.

Member Function Documentation

AcceptGroupInvitation()

void AccelByte.Api.Group.AcceptGroupInvitation ( string groupId, ResultCallback< GroupGeneralResponse > callback )

inline

Accepting group invitation.

Parameters

groupId	The group id you want to accept.
callback	Returns a Result that contains GroupGeneralResponse via callback when completed.

AcceptGroupInvitationV2()

void AccelByte.Api.Group.AcceptGroupInvitationV2 ( string groupId, ResultCallback< GroupGeneralResponse > callback )

inline

Accepting group invitation.

Parameters

groupId	The group id who sent you the invitation
callback	Returns a Result that contains GroupGeneralResponse via callback when completed.

AcceptOtherJoinRequest()

void AccelByte.Api.Group.AcceptOtherJoinRequest ( string otherUserId, ResultCallback< GroupGeneralResponse > callback )

inline

Accept other user join group request.

Parameters

otherUserId	The id of the other user who request to join group.
callback	Returns a Result that contains GroupGeneralResponse via callback when completed.

AcceptOtherJoinRequestV2()

void AccelByte.Api.Group.AcceptOtherJoinRequestV2 ( string otherUserId, string groupId, ResultCallback< GroupGeneralResponse > callback )

inline

Accept other user join group request.

Parameters

otherUserId	The id of the other user who request to join group.
groupId	The group id.
callback	Returns a Result that contains GroupGeneralResponse via callback when completed.

AssignRoleToMember()

void AccelByte.Api.Group.AssignRoleToMember ( string memberRoleId, string userId, ResultCallback< GroupMemberInformation > callback )

inline

Assign a role to a group member.

Parameters

memberRoleId	The roleId of the assigned role
userId	The userId of the group member
callback	Returns a Result that contains GroupMemberInformation via callback when completed.

AssignRoleToMemberV2()

void AccelByte.Api.Group.AssignRoleToMemberV2 ( string memberRoleId, string userId, string groupId, ResultCallback< GroupMemberInformation > callback )

inline

Assign a role to a group member.

Parameters

memberRoleId	The roleId of the assigned role
userId	The userId of the group member
groupId	The group id.
callback	Returns a Result that contains GroupMemberInformation via callback when completed.

CancelGroupMemberInvitation()

void AccelByte.Api.Group.CancelGroupMemberInvitation ( string userId, string groupId, ResultCallback< GroupGeneralResponse > callback )

inline

Cancel group member invitation.

Parameters

userId	The user ID who has been invited
groupId	the group ID of the user based on
callback	Returns a Result that contains GroupGeneralResponse via callback when completed

CancelJoinGroupRequest()

void AccelByte.Api.Group.CancelJoinGroupRequest ( string groupId, ResultCallback< GroupGeneralResponse > callback )

inline

Cancel the Join group request.

Parameters

groupId	The expected group id.
callback	Returns a Result that contains JoinGroupResponse via callback when completed.

CreateGroup()

void AccelByte.Api.Group.CreateGroup ( CreateGroupRequest createGroupRequest, ResultCallback< GroupInformation > callback )

inline

Create new group. It will use the authorization to determine the user ID which will be used as the group admin.

Parameters

createGroupRequest	New group detail request.
callback	Returns a Result that contains GroupInformation via callback when completed.

CreateGroupV2()

void AccelByte.Api.Group.CreateGroupV2 ( CreateGroupRequest createGroupRequest, ResultCallback< GroupInformation > callback )

inline

Create new group. It will use the authorization to determine the user ID which will be used as the group admin.

Parameters

createGroupRequest	New group detail request.
callback	Returns a Result that contains GroupInformation via callback when completed.

DeleteGroup()

void AccelByte.Api.Group.DeleteGroup ( string groupId, ResultCallback callback )

inline

Delete specific single group.

Parameters

groupId	The expected group id.
callback	Returns a Result via callback when completed.

DeleteGroupPredefinedRule()

void AccelByte.Api.Group.DeleteGroupPredefinedRule ( string groupId, AllowedAction allowedAction, ResultCallback callback )

inline

Delete predefined group rule.

Parameters

groupId	The group id.
allowedAction	The rule action of the group.
callback	Returns a Result via callback when completed

DeleteGroupPredefinedRuleV2()

void AccelByte.Api.Group.DeleteGroupPredefinedRuleV2 ( string groupId, AllowedAction allowedAction, ResultCallback callback )

inline

Delete predefined group rule.

Parameters

groupId	The group id.
allowedAction	The rule action of the group.
callback	Returns a Result via callback when completed

DeleteGroupV2()

void AccelByte.Api.Group.DeleteGroupV2 ( string groupId, ResultCallback callback )

inline

Delete specific single group.

Parameters

groupId	The expected group id.
callback	Returns a Result via callback when completed.

GetGroup()

void AccelByte.Api.Group.GetGroup ( string groupId, ResultCallback< GroupInformation > callback )

inline

Get single group information based on its id.

Parameters

groupId	The expected group id.
callback	Returns a Result that contains GroupInformation via callback when completed.

GetGroupInvitationRequests() [1/2]

void AccelByte.Api.Group.GetGroupInvitationRequests ( int limit, int offset, ResultCallback< PaginatedGroupRequestList > callback )

inline

Get list of group invitation request.

Parameters

limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
callback	Returns a Result that contains GroupRequestResponse via callback when completed.

GetGroupInvitationRequests() [2/2]

void AccelByte.Api.Group.GetGroupInvitationRequests ( ResultCallback< PaginatedGroupRequestList > callback )

inline

Get list of group invitation request.

Parameters

callback

Returns a Result that contains GroupRequestResponse via callback when completed.

GetGroupInvitationRequestsV2()

void AccelByte.Api.Group.GetGroupInvitationRequestsV2 ( string groupId, ResultCallback< PaginatedGroupRequestList > callback )

inline

Get list of group invitation request.

Parameters

callback

Returns a Result that contains GroupRequestResponse via callback when completed.

GetGroupJoinRequests() [1/2]

void AccelByte.Api.Group.GetGroupJoinRequests ( string groupId, int limit, int offset, ResultCallback< PaginatedGroupRequestList > callback )

inline

Get list of join request in group.

Parameters

groupId	The group id.
limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
callback	Returns a Result that contains GroupRequestResponse via callback when completed.

GetGroupJoinRequests() [2/2]

void AccelByte.Api.Group.GetGroupJoinRequests ( string groupId, ResultCallback< PaginatedGroupRequestList > callback )

inline

Get list of join request in group.

Parameters

groupId	The group id.
callback	Returns a Result that contains GroupRequestResponse via callback when completed.

GetGroupJoinRequestsV2()

void AccelByte.Api.Group.GetGroupJoinRequestsV2 ( string groupId, int limit, int offset, ResultCallback< PaginatedGroupRequestList > callback )

inline

Get list of join request in group.

Parameters

groupId	The group id.
limit
offset
callback	Returns a Result that contains GroupRequestResponse via callback when completed.

GetGroupMemberList() [1/2]

void AccelByte.Api.Group.GetGroupMemberList ( string groupId, int limit, int offset, ResultCallback< PaginatedGroupMemberList > callback )

inline

Get member list of specific group.

Parameters

groupId	The expected group id.
limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
callback	Returns a Result that contains JoinGroupResponse via callback when completed.

GetGroupMemberList() [2/2]

void AccelByte.Api.Group.GetGroupMemberList ( string groupId, ResultCallback< PaginatedGroupMemberList > callback )

inline

Get member list of specific group.

Parameters

groupId	The expected group id.
callback	Returns a Result that contains JoinGroupResponse via callback when completed.

GetGroupsByGroupIds()

void AccelByte.Api.Group.GetGroupsByGroupIds ( string[] groupIds, ResultCallback< PaginatedGroupListResponse > callback )

inline

Get list of groups based on group ids.

Parameters

groupIds	List of group ids
limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
callback	Returns a Result that contains PaginatedGroupList via callback when completed

GetMemberRoles() [1/2]

void AccelByte.Api.Group.GetMemberRoles ( int limit, int offset, ResultCallback< PaginatedMemberRoles > callback )

inline

Get list of member role on the namespace.

Parameters

limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
callback	Returns a Result that contains PaginatedMemberRoles via callback when completed.

GetMemberRoles() [2/2]

void AccelByte.Api.Group.GetMemberRoles ( ResultCallback< PaginatedMemberRoles > callback )

inline

Get list of member role on the namespace.

Parameters

callback

Returns a Result that contains PaginatedMemberRoles via callback when completed.

GetMyGroupInfo()

void AccelByte.Api.Group.GetMyGroupInfo ( ResultCallback< GroupMemberInformation > callback )

inline

Get user's group information.

Parameters

callback

Returns a Result that contains GroupMemberInformation via callback when completed.

GetMyJoinRequest()

void AccelByte.Api.Group.GetMyJoinRequest ( int limit, int offset, ResultCallback< PaginatedGroupRequestList > callback )

inline

Get My Join Request To The Groups.

Parameters

limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
callback	Returns a Result that contains PaginatedGroupRequestList via callback when completed

GetOtherGroupInfo()

void AccelByte.Api.Group.GetOtherGroupInfo ( string userId, ResultCallback< GroupMemberInformation > callback )

inline

Get other user's group information.

Parameters

userId	other user's Id
callback	Returns a Result that contains GroupMemberInformation via callback when completed.

GetUserGroupStatusInfo()

void AccelByte.Api.Group.GetUserGroupStatusInfo ( string userId, string groupId, ResultCallback< GroupMemberInformation > callback )

inline

Get user group status information. This API will check the member and group information, and also the role permission.

Parameters

userId	The user ID of the group member
groupId	the group ID of the user based on
callback	Returns a Result that contains GroupMemberInformation via callback when completed

GetUserJoinedGroups()

void AccelByte.Api.Group.GetUserJoinedGroups ( int limit, int offset, ResultCallback< PaginatedGroupMemberList > callback )

inline

Get user joined groups information.

Parameters

limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
callback	Returns a Result that contains PaginatedGroupMemberList via callback when completed

InviteOtherUserToGroup()

void AccelByte.Api.Group.InviteOtherUserToGroup ( string otherUserId, ResultCallback< UserInvitationResponse > callback )

inline

Invite the other user to your group.

Parameters

otherUserId	The other user id who will be invited into specific group.
callback	Returns a Result that contains UserInvitationResponse via callback when completed.

InviteOtherUserToGroupV2()

void AccelByte.Api.Group.InviteOtherUserToGroupV2 ( string otherUserId, string groupId, ResultCallback< UserInvitationResponse > callback )

inline

Invite the other user to your group.

Parameters

otherUserId	The other user id who will be invited into specific group.
callback	Returns a Result that contains UserInvitationResponse via callback when completed.

JoinGroup()

void AccelByte.Api.Group.JoinGroup ( string groupId, ResultCallback< JoinGroupResponse > callback )

inline

Join into specific group.

Parameters

groupId	The expected group id.
callback	Returns a Result that contains JoinGroupResponse via callback when completed.

JoinGroupV2()

void AccelByte.Api.Group.JoinGroupV2 ( string groupId, ResultCallback< JoinGroupResponse > callback )

inline

Join into specific group.

Parameters

groupId	The expected group id.
callback	Returns a Result that contains JoinGroupResponse via callback when completed.

KickGroupMember()

void AccelByte.Api.Group.KickGroupMember ( string otherUserId, ResultCallback< KickMemberResponse > callback )

inline

Kick a member out of group.

Parameters

otherUserId	The user id of the member who will be kicked out.
callback	Returns a Result that contains KickMemberResponse via callback when completed.

KickGroupMemberV2()

void AccelByte.Api.Group.KickGroupMemberV2 ( string otherUserId, string groupId, ResultCallback< KickMemberResponse > callback )

inline

Kick a member out of group.

Parameters

otherUserId	The user id of the member who will be kicked out.
groupId	The expected group id.
callback	Returns a Result that contains KickMemberResponse via callback when completed.

LeaveGroup()

void AccelByte.Api.Group.LeaveGroup ( ResultCallback< GroupGeneralResponse > callback )

inline

Leave the group you're in.

Parameters

callback

Returns a Result that contains GroupGeneralResponse via callback when completed.

LeaveGroupV2()

void AccelByte.Api.Group.LeaveGroupV2 ( string groupId, ResultCallback< GroupGeneralResponse > callback )

inline

Leave the group you're in.

Parameters

groupId	The expected group id.
callback	Returns a Result that contains GroupGeneralResponse via callback when completed.

RejectGroupInvitation()

void AccelByte.Api.Group.RejectGroupInvitation ( string groupId, ResultCallback< GroupGeneralResponse > callback )

inline

Rejecting group invitation.

Parameters

groupId	The group id you want to reject.
callback	Returns a Result that contains GroupGeneralResponse via callback when completed.

RejectGroupInvitationV2()

void AccelByte.Api.Group.RejectGroupInvitationV2 ( string groupId, ResultCallback< GroupGeneralResponse > callback )

inline

Rejecting group invitation.

Parameters

groupId	The group id you want to reject.
callback	Returns a Result that contains GroupGeneralResponse via callback when completed.

RejectOtherJoinRequest()

void AccelByte.Api.Group.RejectOtherJoinRequest ( string otherUserId, ResultCallback< GroupGeneralResponse > callback )

inline

Reject other user join group request.

Parameters

otherUserId	The id of the other user who request to join group.
callback	Returns a Result that contains GroupGeneralResponse via callback when completed.

RejectOtherJoinRequestV2()

void AccelByte.Api.Group.RejectOtherJoinRequestV2 ( string otherUserId, string groupId, ResultCallback< GroupGeneralResponse > callback )

inline

Reject other user join group request.

Parameters

otherUserId	The id of the other user who request to join group.
groupId	The group id.
callback	Returns a Result that contains GroupGeneralResponse via callback when completed.

RemoveRoleFromMember()

void AccelByte.Api.Group.RemoveRoleFromMember ( string memberRoleId, string userId, ResultCallback callback )

inline

Remove a role from a group member.

Parameters

memberRoleId	The roleId of the removed role
userId	The userId of the group member
callback	Returns a Result via callback when completed

RemoveRoleFromMemberV2()

void AccelByte.Api.Group.RemoveRoleFromMemberV2 ( string memberRoleId, string userId, string groupId, ResultCallback callback )

inline

Remove a role from a group member.

Parameters

memberRoleId	The roleId of the removed role
userId	The userId of the group member
groupId	The groupId the user belongs to
callback	Returns a Result via callback when completed

SearchGroups() [1/6]

void AccelByte.Api.Group.SearchGroups ( int limit, int offset, ResultCallback< PaginatedGroupListResponse > callback )

inline

Get list of groups. It will only show OPEN and PUBLIC group type.

Parameters

limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
callback	Returns a Result that contains PaginatedGroupListResponse via callback when completed.

SearchGroups() [2/6]

void AccelByte.Api.Group.SearchGroups ( ResultCallback< PaginatedGroupListResponse > callback )

inline

Get list of groups. It will only show OPEN and PUBLIC group type.

Parameters

callback

Returns a Result that contains PaginatedGroupListResponse via callback when completed.

SearchGroups() [3/6]

void AccelByte.Api.Group.SearchGroups ( string groupName, int limit, int offset, ResultCallback< PaginatedGroupListResponse > callback )

inline

Get list of groups. It will only show OPEN and PUBLIC group type.

Parameters

groupName	The group name query, leave it blank will fetch all the group list. (optional)
limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
callback	Returns a Result that contains PaginatedGroupListResponse via callback when completed.

SearchGroups() [4/6]

void AccelByte.Api.Group.SearchGroups ( string groupName, ResultCallback< PaginatedGroupListResponse > callback )

inline

Get list of groups. It will only show OPEN and PUBLIC group type.

Parameters

groupName	The group name query, leave it blank will fetch all the group list. (optional)
callback	Returns a Result that contains PaginatedGroupListResponse via callback when completed.

SearchGroups() [5/6]

void AccelByte.Api.Group.SearchGroups ( string groupName, string groupRegion, int limit, int offset, ResultCallback< PaginatedGroupListResponse > callback )

inline

Get list of groups. It will only show OPEN and PUBLIC group type.

Parameters

groupName	The group name query, leave it blank will fetch all the group list. (optional)
groupRegion	The region you want to search, leave it blank will fetch group from all existing region. (optional)
limit	The limit of item on page (optional)
offset	Offset of the list that has been sliced based on Limit parameter (optional, default = 0)
callback	Returns a Result that contains PaginatedGroupListResponse via callback when completed.

SearchGroups() [6/6]

void AccelByte.Api.Group.SearchGroups ( string groupName, string groupRegion, ResultCallback< PaginatedGroupListResponse > callback )

inline

Get list of groups. It will only show OPEN and PUBLIC group type.

Parameters

groupName	The group name query, leave it blank will fetch all the group list. (optional)
groupRegion	The region you want to search, leave it blank will fetch group from all existing region. (optional)
callback	Returns a Result that contains PaginatedGroupListResponse via callback when completed.

UpdateGroup()

void AccelByte.Api.Group.UpdateGroup ( string groupId, UpdateGroupRequest updateGroupRequest, ResultCallback< GroupInformation > callback )

inline

Update specific single group information.

Parameters

groupId	The expected group id.
updateGroupRequest	The new information of the group.
callback	Returns a Result that contains GroupInformation via callback when completed.

UpdateGroupCustomAttributes()

void AccelByte.Api.Group.UpdateGroupCustomAttributes ( string groupId, Dictionary< string, object > customAttributes, ResultCallback< GroupInformation > callback )

inline

Update specific single group custom attributes information.

Parameters

groupId	The expected group id.
customAttributes	The new custom attributes information.
callback	Returns a Result that contains GroupInformation via callback when completed.

UpdateGroupCustomAttributesV2()

void AccelByte.Api.Group.UpdateGroupCustomAttributesV2 ( string groupId, Dictionary< string, object > customAttributes, ResultCallback< GroupInformation > callback )

inline

Update group custom attributes.

Parameters

groupId	the group ID of the user based on
customAttributes	Collection of custom attributes in a key-value fashion
callback	Returns a Result that contains GroupInformation via callback when completed

UpdateGroupCustomRule()

void AccelByte.Api.Group.UpdateGroupCustomRule ( string groupId, Dictionary< string, object > ruleUpdateRequest, ResultCallback< GroupInformation > callback )

inline

Update group custom rule.

Parameters

groupId	The group id.
ruleUpdateRequest	The new custom rule for the group.
callback	Returns a Result that contains GroupInformation via callback when completed.

UpdateGroupCustomRuleV2()

void AccelByte.Api.Group.UpdateGroupCustomRuleV2 ( string groupId, Dictionary< string, object > ruleUpdateRequest, ResultCallback< GroupInformation > callback )

inline

Update group custom rule.

Parameters

groupId	The group id.
ruleUpdateRequest	The new custom rule for the group.
callback	Returns a Result that contains GroupInformation via callback when completed.

UpdateGroupPredefinedRule()

void AccelByte.Api.Group.UpdateGroupPredefinedRule ( string groupId, AllowedAction allowedAction, UpdateGroupPredefinedRuleRequest ruleUpdateRequest, ResultCallback< GroupInformation > callback )

inline

Update predefined group rule.

Parameters

groupId	The group id.
allowedAction	The rule action of the group.
ruleUpdateRequest	The new predefined rule for the group.
callback	Returns a Result that contains GroupInformation via callback when completed

UpdateGroupPredefinedRuleV2()

void AccelByte.Api.Group.UpdateGroupPredefinedRuleV2 ( string groupId, AllowedAction allowedAction, UpdateGroupPredefinedRuleRequest ruleUpdateRequest, ResultCallback< GroupInformation > callback )

inline

Update predefined group rule.

Parameters

groupId	The group id.
allowedAction	The rule action of the group.
ruleUpdateRequest	The new predefined rule for the group.
callback	Returns a Result that contains GroupInformation via callback when completed

UpdateGroupV2()

void AccelByte.Api.Group.UpdateGroupV2 ( string groupId, UpdateGroupRequest updateGroupRequest, ResultCallback< GroupInformation > callback )

inline

Update specific single group information.

Parameters

groupId	The expected group id.
updateGroupRequest	The new information of the group.
callback	Returns a Result that contains GroupInformation via callback when completed.