symbols:
# region models
'ModelsAssignRoleToMemberRequestV1@cs.group.mod':
id: 'ModelsAssignRoleToMemberRequestV1@cs.group.mod'
name: 'ModelsAssignRoleToMemberRequestV1'
type: 'model'
fields:
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsAssignRoleToMemberRequestV1.cs'
'ModelsCancelInvitationGroupResponseV2@cs.group.mod':
id: 'ModelsCancelInvitationGroupResponseV2@cs.group.mod'
name: 'ModelsCancelInvitationGroupResponseV2'
type: 'model'
fields:
'GroupId':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsCancelInvitationGroupResponseV2.cs'
'ModelsCreateGroupConfigurationRequestV1@cs.group.mod':
id: 'ModelsCreateGroupConfigurationRequestV1@cs.group.mod'
name: 'ModelsCreateGroupConfigurationRequestV1'
type: 'model'
fields:
'AllowMultiple':
type: 'bool'
required: true
'ConfigurationCode':
type: 'string'
required: true
'Description':
type: 'string'
required: true
'GlobalRules':
type: 'List<ModelsRule>'
required: true
'GroupAdminRoleId':
type: 'string'
required: true
'GroupMaxMember':
type: 'int'
required: true
'GroupMemberRoleId':
type: 'string'
required: true
'Name':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsCreateGroupConfigurationRequestV1.cs'
'ModelsCreateGroupConfigurationResponseV1@cs.group.mod':
id: 'ModelsCreateGroupConfigurationResponseV1@cs.group.mod'
name: 'ModelsCreateGroupConfigurationResponseV1'
type: 'model'
fields:
'AllowMultiple':
type: 'bool'
required: true
'ConfigurationCode':
type: 'string'
required: true
'Description':
type: 'string'
required: true
'GlobalRules':
type: 'List<ModelsRuleResponseV1>'
required: true
'GroupAdminRoleId':
type: 'string'
required: true
'GroupMaxMember':
type: 'int'
required: true
'GroupMemberRoleId':
type: 'string'
required: true
'Name':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsCreateGroupConfigurationResponseV1.cs'
'ModelsCreateMemberRoleRequestV1@cs.group.mod':
id: 'ModelsCreateMemberRoleRequestV1@cs.group.mod'
name: 'ModelsCreateMemberRoleRequestV1'
type: 'model'
fields:
'MemberRoleName':
type: 'string'
required: true
'MemberRolePermissions':
type: 'List<ModelsRolePermission>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsCreateMemberRoleRequestV1.cs'
'ModelsGetGroupConfigurationResponseV1@cs.group.mod':
id: 'ModelsGetGroupConfigurationResponseV1@cs.group.mod'
name: 'ModelsGetGroupConfigurationResponseV1'
type: 'model'
fields:
'AllowMultiple':
type: 'bool'
required: true
'ConfigurationCode':
type: 'string'
required: true
'Description':
type: 'string'
required: true
'GlobalRules':
type: 'List<ModelsRuleResponseV1>'
required: true
'GroupAdminRoleId':
type: 'string'
required: true
'GroupMaxMember':
type: 'int'
required: true
'GroupMemberRoleId':
type: 'string'
required: true
'Name':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGetGroupConfigurationResponseV1.cs'
'ModelsGetGroupListRequestV2@cs.group.mod':
id: 'ModelsGetGroupListRequestV2@cs.group.mod'
name: 'ModelsGetGroupListRequestV2'
type: 'model'
fields:
'GroupIDs':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGetGroupListRequestV2.cs'
'ModelsGetGroupMemberListResponseV1@cs.group.mod':
id: 'ModelsGetGroupMemberListResponseV1@cs.group.mod'
name: 'ModelsGetGroupMemberListResponseV1'
type: 'model'
fields:
'Data':
type: 'List<ModelsGetUserGroupInformationResponseV1>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGetGroupMemberListResponseV1.cs'
'ModelsGetGroupsListResponseV1@cs.group.mod':
id: 'ModelsGetGroupsListResponseV1@cs.group.mod'
name: 'ModelsGetGroupsListResponseV1'
type: 'model'
fields:
'Data':
type: 'List<ModelsGroupResponseV1>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGetGroupsListResponseV1.cs'
'ModelsGetGroupsResponseV1@cs.group.mod':
id: 'ModelsGetGroupsResponseV1@cs.group.mod'
name: 'ModelsGetGroupsResponseV1'
type: 'model'
fields:
'Data':
type: 'List<ModelsGroupResponseV1>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGetGroupsResponseV1.cs'
'ModelsGetMemberRequestsListResponseV1@cs.group.mod':
id: 'ModelsGetMemberRequestsListResponseV1@cs.group.mod'
name: 'ModelsGetMemberRequestsListResponseV1'
type: 'model'
fields:
'Data':
type: 'List<ModelsMemberRequestResponseV1>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGetMemberRequestsListResponseV1.cs'
'ModelsGetMemberRolesListResponseV1@cs.group.mod':
id: 'ModelsGetMemberRolesListResponseV1@cs.group.mod'
name: 'ModelsGetMemberRolesListResponseV1'
type: 'model'
fields:
'Data':
type: 'List<ModelsMemberRoleResponseV1>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGetMemberRolesListResponseV1.cs'
'ModelsGetUserGroupInformationResponseV1@cs.group.mod':
id: 'ModelsGetUserGroupInformationResponseV1@cs.group.mod'
name: 'ModelsGetUserGroupInformationResponseV1'
type: 'model'
fields:
'GroupId':
type: 'string'
required: true
'JoinedAt':
type: 'DateTime'
required: true
'MemberRoleId':
type: 'List<string>'
required: true
'UserId':
type: 'string'
required: true
'Status':
type: 'string'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGetUserGroupInformationResponseV1.cs'
'ModelsGroupMember@cs.group.mod':
id: 'ModelsGroupMember@cs.group.mod'
name: 'ModelsGroupMember'
type: 'model'
fields:
'MemberRoleId':
type: 'List<string>'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGroupMember.cs'
'ModelsGroupResponseV1@cs.group.mod':
id: 'ModelsGroupResponseV1@cs.group.mod'
name: 'ModelsGroupResponseV1'
type: 'model'
fields:
'ConfigurationCode':
type: 'string'
required: true
'CreatedAt':
type: 'DateTime'
required: true
'CustomAttributes':
type: 'Dictionary<string, object>'
required: true
'GroupDescription':
type: 'string'
required: true
'GroupIcon':
type: 'string'
required: true
'GroupId':
type: 'string'
required: true
'GroupMaxMember':
type: 'int'
required: true
'GroupMembers':
type: 'List<ModelsGroupMember>'
required: true
'GroupName':
type: 'string'
required: true
'GroupRegion':
type: 'string'
required: true
'GroupRules':
type: 'ModelsGroupRuleResponseV1'
required: true
'GroupType':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGroupResponseV1.cs'
'ModelsGroupRule@cs.group.mod':
id: 'ModelsGroupRule@cs.group.mod'
name: 'ModelsGroupRule'
type: 'model'
fields:
'GroupCustomRule':
type: 'ModelsGroupRuleGroupCustomRule'
required: true
'GroupPredefinedRules':
type: 'List<ModelsRule>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGroupRule.cs'
'ModelsGroupRuleGroupCustomRule@cs.group.mod':
id: 'ModelsGroupRuleGroupCustomRule@cs.group.mod'
name: 'ModelsGroupRuleGroupCustomRule'
type: 'model'
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGroupRuleGroupCustomRule.cs'
'ModelsGroupRuleResponseV1@cs.group.mod':
id: 'ModelsGroupRuleResponseV1@cs.group.mod'
name: 'ModelsGroupRuleResponseV1'
type: 'model'
fields:
'GroupCustomRule':
type: 'ModelsGroupRuleResponseV1GroupCustomRule'
required: true
'GroupPredefinedRules':
type: 'List<ModelsRuleResponseV1>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGroupRuleResponseV1.cs'
'ModelsGroupRuleResponseV1GroupCustomRule@cs.group.mod':
id: 'ModelsGroupRuleResponseV1GroupCustomRule@cs.group.mod'
name: 'ModelsGroupRuleResponseV1GroupCustomRule'
type: 'model'
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsGroupRuleResponseV1GroupCustomRule.cs'
'ModelsJoinGroupResponseV1@cs.group.mod':
id: 'ModelsJoinGroupResponseV1@cs.group.mod'
name: 'ModelsJoinGroupResponseV1'
type: 'model'
fields:
'GroupId':
type: 'string'
required: true
'Status':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsJoinGroupResponseV1.cs'
'ModelsKickGroupMemberResponseV1@cs.group.mod':
id: 'ModelsKickGroupMemberResponseV1@cs.group.mod'
name: 'ModelsKickGroupMemberResponseV1'
type: 'model'
fields:
'GroupId':
type: 'string'
required: true
'KickedUserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsKickGroupMemberResponseV1.cs'
'ModelsLeaveGroupResponseV1@cs.group.mod':
id: 'ModelsLeaveGroupResponseV1@cs.group.mod'
name: 'ModelsLeaveGroupResponseV1'
type: 'model'
fields:
'GroupId':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsLeaveGroupResponseV1.cs'
'ModelsListConfigurationResponseV1@cs.group.mod':
id: 'ModelsListConfigurationResponseV1@cs.group.mod'
name: 'ModelsListConfigurationResponseV1'
type: 'model'
fields:
'Data':
type: 'List<ModelsGetGroupConfigurationResponseV1>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsListConfigurationResponseV1.cs'
'ModelsMemberRequestGroupResponseV1@cs.group.mod':
id: 'ModelsMemberRequestGroupResponseV1@cs.group.mod'
name: 'ModelsMemberRequestGroupResponseV1'
type: 'model'
fields:
'GroupId':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsMemberRequestGroupResponseV1.cs'
'ModelsMemberRequestResponseV1@cs.group.mod':
id: 'ModelsMemberRequestResponseV1@cs.group.mod'
name: 'ModelsMemberRequestResponseV1'
type: 'model'
fields:
'GroupId':
type: 'string'
required: true
'RequestType':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsMemberRequestResponseV1.cs'
'ModelsMemberRoleResponseV1@cs.group.mod':
id: 'ModelsMemberRoleResponseV1@cs.group.mod'
name: 'ModelsMemberRoleResponseV1'
type: 'model'
fields:
'MemberRoleId':
type: 'string'
required: true
'MemberRoleName':
type: 'string'
required: true
'MemberRolePermissions':
type: 'List<ModelsRolePermission>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsMemberRoleResponseV1.cs'
'ModelsPagination@cs.group.mod':
id: 'ModelsPagination@cs.group.mod'
name: 'ModelsPagination'
type: 'model'
fields:
'First':
type: 'string'
required: true
'Last':
type: 'string'
required: true
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsPagination.cs'
'ModelsPublicCreateNewGroupRequestV1@cs.group.mod':
id: 'ModelsPublicCreateNewGroupRequestV1@cs.group.mod'
name: 'ModelsPublicCreateNewGroupRequestV1'
type: 'model'
fields:
'ConfigurationCode':
type: 'string'
required: true
'CustomAttributes':
type: 'Dictionary<string, object>'
required: true
'GroupDescription':
type: 'string'
required: true
'GroupIcon':
type: 'string'
required: true
'GroupMaxMember':
type: 'int'
required: true
'GroupName':
type: 'string'
required: true
'GroupRegion':
type: 'string'
required: true
'GroupRules':
type: 'ModelsGroupRule'
required: true
'GroupType':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsPublicCreateNewGroupRequestV1.cs'
'ModelsRemoveRoleFromMemberRequestV1@cs.group.mod':
id: 'ModelsRemoveRoleFromMemberRequestV1@cs.group.mod'
name: 'ModelsRemoveRoleFromMemberRequestV1'
type: 'model'
fields:
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsRemoveRoleFromMemberRequestV1.cs'
'ModelsRolePermission@cs.group.mod':
id: 'ModelsRolePermission@cs.group.mod'
name: 'ModelsRolePermission'
type: 'model'
fields:
'Action':
type: 'int'
required: true
'ResourceName':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsRolePermission.cs'
'ModelsRule@cs.group.mod':
id: 'ModelsRule@cs.group.mod'
name: 'ModelsRule'
type: 'model'
fields:
'AllowedAction':
type: 'string'
required: true
'RuleDetail':
type: 'List<ModelsRuleInformation>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsRule.cs'
'ModelsRuleInformation@cs.group.mod':
id: 'ModelsRuleInformation@cs.group.mod'
name: 'ModelsRuleInformation'
type: 'model'
fields:
'RuleAttribute':
type: 'string'
required: true
'RuleCriteria':
type: 'string'
required: true
'RuleValue':
type: 'double'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsRuleInformation.cs'
'ModelsRuleResponseV1@cs.group.mod':
id: 'ModelsRuleResponseV1@cs.group.mod'
name: 'ModelsRuleResponseV1'
type: 'model'
fields:
'AllowedAction':
type: 'string'
required: true
'RuleDetail':
type: 'List<ModelsRuleInformation>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsRuleResponseV1.cs'
'ModelsUpdateGroupConfigurationGlobalRulesRequestV1@cs.group.mod':
id: 'ModelsUpdateGroupConfigurationGlobalRulesRequestV1@cs.group.mod'
name: 'ModelsUpdateGroupConfigurationGlobalRulesRequestV1'
type: 'model'
fields:
'RuleDetail':
type: 'List<ModelsRuleInformation>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsUpdateGroupConfigurationGlobalRulesRequestV1.cs'
'ModelsUpdateGroupConfigurationRequestV1@cs.group.mod':
id: 'ModelsUpdateGroupConfigurationRequestV1@cs.group.mod'
name: 'ModelsUpdateGroupConfigurationRequestV1'
type: 'model'
fields:
'Description':
type: 'string'
required: true
'GroupMaxMember':
type: 'int'
required: true
'Name':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsUpdateGroupConfigurationRequestV1.cs'
'ModelsUpdateGroupConfigurationResponseV1@cs.group.mod':
id: 'ModelsUpdateGroupConfigurationResponseV1@cs.group.mod'
name: 'ModelsUpdateGroupConfigurationResponseV1'
type: 'model'
fields:
'AllowMultiple':
type: 'bool'
required: true
'ConfigurationCode':
type: 'string'
required: true
'Description':
type: 'string'
required: true
'GlobalRules':
type: 'List<ModelsRuleResponseV1>'
required: true
'GroupAdminRoleId':
type: 'string'
required: true
'GroupMaxMember':
type: 'int'
required: true
'GroupMemberRoleId':
type: 'string'
required: true
'Name':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsUpdateGroupConfigurationResponseV1.cs'
'ModelsUpdateGroupCustomAttributesRequestV1@cs.group.mod':
id: 'ModelsUpdateGroupCustomAttributesRequestV1@cs.group.mod'
name: 'ModelsUpdateGroupCustomAttributesRequestV1'
type: 'model'
fields:
'CustomAttributes':
type: 'Dictionary<string, object>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsUpdateGroupCustomAttributesRequestV1.cs'
'ModelsUpdateGroupCustomRuleRequestV1@cs.group.mod':
id: 'ModelsUpdateGroupCustomRuleRequestV1@cs.group.mod'
name: 'ModelsUpdateGroupCustomRuleRequestV1'
type: 'model'
fields:
'GroupCustomRule':
type: 'Dictionary<string, object>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsUpdateGroupCustomRuleRequestV1.cs'
'ModelsUpdateGroupPredefinedRuleRequestV1@cs.group.mod':
id: 'ModelsUpdateGroupPredefinedRuleRequestV1@cs.group.mod'
name: 'ModelsUpdateGroupPredefinedRuleRequestV1'
type: 'model'
fields:
'RuleDetail':
type: 'List<ModelsRuleInformation>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsUpdateGroupPredefinedRuleRequestV1.cs'
'ModelsUpdateGroupRequestV1@cs.group.mod':
id: 'ModelsUpdateGroupRequestV1@cs.group.mod'
name: 'ModelsUpdateGroupRequestV1'
type: 'model'
fields:
'CustomAttributes':
type: 'ModelsUpdateGroupRequestV1CustomAttributes'
required: true
'GroupDescription':
type: 'string'
required: true
'GroupIcon':
type: 'string'
required: true
'GroupName':
type: 'string'
required: true
'GroupRegion':
type: 'string'
required: true
'GroupType':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsUpdateGroupRequestV1.cs'
'ModelsUpdateGroupRequestV1CustomAttributes@cs.group.mod':
id: 'ModelsUpdateGroupRequestV1CustomAttributes@cs.group.mod'
name: 'ModelsUpdateGroupRequestV1CustomAttributes'
type: 'model'
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsUpdateGroupRequestV1CustomAttributes.cs'
'ModelsUpdateMemberRolePermissionsRequestV1@cs.group.mod':
id: 'ModelsUpdateMemberRolePermissionsRequestV1@cs.group.mod'
name: 'ModelsUpdateMemberRolePermissionsRequestV1'
type: 'model'
fields:
'MemberRolePermissions':
type: 'List<ModelsRolePermission>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsUpdateMemberRolePermissionsRequestV1.cs'
'ModelsUpdateMemberRoleRequestV1@cs.group.mod':
id: 'ModelsUpdateMemberRoleRequestV1@cs.group.mod'
name: 'ModelsUpdateMemberRoleRequestV1'
type: 'model'
fields:
'MemberRoleName':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsUpdateMemberRoleRequestV1.cs'
'ModelsUserInvitationResponseV1@cs.group.mod':
id: 'ModelsUserInvitationResponseV1@cs.group.mod'
name: 'ModelsUserInvitationResponseV1'
type: 'model'
fields:
'GroupId':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ModelsUserInvitationResponseV1.cs'
'ResponseErrorResponse@cs.group.mod':
id: 'ResponseErrorResponse@cs.group.mod'
name: 'ResponseErrorResponse'
type: 'model'
fields:
'ErrorCode':
type: 'int'
required: true
'ErrorMessage':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Group.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Model/ResponseErrorResponse.cs'
# endregion models
# region functions
'AcceptGroupInvitationPublicV1@cs.group.fun':
id: 'AcceptGroupInvitationPublicV1@cs.group.fun'
name: 'AcceptGroupInvitationPublicV1'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to accept group invitation.
Accept group invitation. If specific user is not invited in the specific group ID, it will show the the error to show if the user is not invited yet.
This endpoint will also check if the user who access this endpoint is already joined to specific group
Accessing this endpoint will make all requests (invite / join request) will be deleted for the user who access this endpoint
Existing members will receive notification of newly accepted member.
Action Code: 73401
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsMemberRequestGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/AcceptGroupInvitationPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.AcceptGroupInvitationPublicV1Op
.Build();
var response = sdk.Group.GroupMember.AcceptGroupInvitationPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'accept'
- 'group'
- 'invitation'
- 'member'
- 'public'
- 'v1'
scopes:
- 'social'
'AcceptGroupInvitationPublicV2@cs.group.fun':
id: 'AcceptGroupInvitationPublicV2@cs.group.fun'
name: 'AcceptGroupInvitationPublicV2'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to accept group invitation.
Accept group invitation. If specific user is not invited in the specific group ID, it will show the the error to show if the user is not invited yet.
This endpoint will also check if the user who access this endpoint is already joined to specific group
Accessing this endpoint will make all requests (invite / join request) will be deleted for the user who access this endpoint
Existing members will receive notification of newly accepted member.
Action Code: 73401
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsMemberRequestGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/AcceptGroupInvitationPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.AcceptGroupInvitationPublicV2Op
.Build();
var response = sdk.Group.GroupMember.AcceptGroupInvitationPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'accept'
- 'group'
- 'invitation'
- 'member'
- 'public'
- 'v2'
scopes:
- 'social'
'AcceptGroupJoinRequestPublicV1@cs.group.fun':
id: 'AcceptGroupJoinRequestPublicV1@cs.group.fun'
name: 'AcceptGroupJoinRequestPublicV1'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:JOIN [CREATE]"
This endpoint is used to accept group join request.
Accept group join request. If specific user is not asked to join the specific group ID, it will show the the error to show if the user is not asked to join yet.
This endpoint will also check if the specific user is already joined to specific group
Action Code: 73407
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsMemberRequestGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/AcceptGroupJoinRequestPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.AcceptGroupJoinRequestPublicV1Op
.Build();
var response = sdk.Group.GroupMember.AcceptGroupJoinRequestPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'accept'
- 'group'
- 'join'
- 'member'
- 'public'
- 'request'
- 'v1'
scopes:
- 'social'
'AcceptGroupJoinRequestPublicV2@cs.group.fun':
id: 'AcceptGroupJoinRequestPublicV2@cs.group.fun'
name: 'AcceptGroupJoinRequestPublicV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:JOIN [CREATE]"
This endpoint is used to accept group join request.
Accept group join request. If specific user is not asked to join the specific group ID, it will show the the error to show if the user is not asked to join yet.
This endpoint will also check if the specific user is already joined to specific group
Action Code: 73407
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsMemberRequestGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/AcceptGroupJoinRequestPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.AcceptGroupJoinRequestPublicV2Op
.Build();
var response = sdk.Group.GroupMember.AcceptGroupJoinRequestPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'accept'
- 'group'
- 'join'
- 'member'
- 'public'
- 'request'
- 'v2'
scopes:
- 'social'
'AdminGetUserGroupStatusInformationV2@cs.group.fun':
id: 'AdminGetUserGroupStatusInformationV2@cs.group.fun'
name: 'AdminGetUserGroupStatusInformationV2'
type: 'function'
description: |-
This endpoint is used to get user group status information.
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsGetUserGroupInformationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/AdminGetUserGroupStatusInformationV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.AdminGetUserGroupStatusInformationV2Op
.Build();
var response = sdk.Group.GroupMember.AdminGetUserGroupStatusInformationV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'group'
- 'information'
- 'member'
- 'status'
- 'user'
- 'v2'
scopes:
- 'social'
'CancelGroupJoinRequestV1@cs.group.fun':
id: 'CancelGroupJoinRequestV1@cs.group.fun'
name: 'CancelGroupJoinRequestV1'
type: 'function'
description: |-
Requires valid user authentication
This endpoint allows user to cancel request to join specific group.
Action Code: 73411
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsMemberRequestGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/CancelGroupJoinRequestV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.CancelGroupJoinRequestV1Op
.Build();
var response = sdk.Group.GroupMember.CancelGroupJoinRequestV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'cancel'
- 'group'
- 'join'
- 'member'
- 'request'
- 'v1'
scopes:
- 'social'
'CancelInvitationGroupMemberV2@cs.group.fun':
id: 'CancelInvitationGroupMemberV2@cs.group.fun'
name: 'CancelInvitationGroupMemberV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:INVITE [DELETE]"
This endpoint is used to cancel invitation group member.
cancel invitation group member. This endpoint will cancel invitation to specific user, and also the role permission of the the user who accesses this endpoint
Action Code: 73409
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsCancelInvitationGroupResponseV2'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/CancelInvitationGroupMemberV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.CancelInvitationGroupMemberV2Op
.Build();
var response = sdk.Group.GroupMember.CancelInvitationGroupMemberV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'cancel'
- 'group'
- 'invitation'
- 'member'
- 'v2'
scopes:
- 'social'
'CreateGroupConfigurationAdminV1@cs.group.fun':
id: 'CreateGroupConfigurationAdminV1@cs.group.fun'
name: 'CreateGroupConfigurationAdminV1'
type: 'function'
description: |-
This endpoint is used to create new configuration. Before creating the configuration, make sure that member role for admin and group member are already created before.
For each of the global rule, it will be the rule detail that consists of these fields:
* **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
Allowed Action can only be filled with any available action in the Group Service. For the configuration, the only value is **"createGroup"**
Action Code: 73103
arguments:
'Body':
type: 'ModelsCreateGroupConfigurationRequestV1'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsCreateGroupConfigurationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Configuration.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Configuration/CreateGroupConfigurationAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.Configuration.CreateGroupConfigurationAdminV1Op
.Build();
var response = sdk.Group.Configuration.CreateGroupConfigurationAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'create'
- 'group'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION [CREATE]'
scopes:
- 'social'
'CreateMemberRoleAdminV1@cs.group.fun':
id: 'CreateMemberRoleAdminV1@cs.group.fun'
name: 'CreateMemberRoleAdminV1'
type: 'function'
description: |-
This endpoint is used to create new member role
Action Code: 73202
memberRolePermissions example value :
"action": 1
"resourceName": "GROUP:ROLE"
The changes will give user with that role have a permission to create a role for new group member
arguments:
'Body':
type: 'ModelsCreateMemberRoleRequestV1'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsMemberRoleResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/CreateMemberRoleAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.CreateMemberRoleAdminV1Op
.Build();
var response = sdk.Group.GroupRoles.CreateMemberRoleAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'create'
- 'group'
- 'member'
- 'role'
- 'roles'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:ROLE [CREATE]'
scopes:
- 'social'
'CreateNewGroupPublicV1@cs.group.fun':
id: 'CreateNewGroupPublicV1@cs.group.fun'
name: 'CreateNewGroupPublicV1'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to create new group
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 createGroup
* **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
arguments:
'Body':
type: 'ModelsPublicCreateNewGroupRequestV1'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/CreateNewGroupPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.CreateNewGroupPublicV1Op
.Build();
var response = sdk.Group.Group.CreateNewGroupPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'group'
- 'new'
- 'public'
- 'v1'
scopes:
- 'social'
'CreateNewGroupPublicV2@cs.group.fun':
id: 'CreateNewGroupPublicV2@cs.group.fun'
name: 'CreateNewGroupPublicV2'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to create new group
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
arguments:
'Body':
type: 'ModelsPublicCreateNewGroupRequestV1'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/CreateNewGroupPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.Group.CreateNewGroupPublicV2Op
.Build();
var response = sdk.Group.Group.CreateNewGroupPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'group'
- 'new'
- 'public'
- 'v2'
scopes:
- 'social'
'DeleteGroupAdminV1@cs.group.fun':
id: 'DeleteGroupAdminV1@cs.group.fun'
name: 'DeleteGroupAdminV1'
type: 'function'
description: |-
Delete existing group. It will check whether the groupID is exist before doing the process to delete the group.
Action Code: 73302
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/DeleteGroupAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.DeleteGroupAdminV1Op
.Build();
sdk.Group.Group.DeleteGroupAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'group'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:{groupId} [DELETE]'
scopes:
- 'social'
'DeleteGroupConfigurationGlobalRuleAdminV1@cs.group.fun':
id: 'DeleteGroupConfigurationGlobalRuleAdminV1@cs.group.fun'
name: 'DeleteGroupConfigurationGlobalRuleAdminV1'
type: 'function'
description: |-
This endpoint is used to delete existing global rule configuration based on the allowed action. It will not give any error if the allowed action is not existed in the global rule
Action Code: 73105
arguments:
'AllowedAction':
type: 'string'
required: true
description: |-
Allowed Action. The value should be any actions in the service
'ConfigurationCode':
type: 'string'
required: true
description: |-
Group Configuration Code
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsUpdateGroupConfigurationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Configuration.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Configuration/DeleteGroupConfigurationGlobalRuleAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.Configuration.DeleteGroupConfigurationGlobalRuleAdminV1Op
.Build();
var response = sdk.Group.Configuration.DeleteGroupConfigurationGlobalRuleAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'delete'
- 'global'
- 'group'
- 'rule'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION [UPDATE]'
scopes:
- 'social'
'DeleteGroupConfigurationV1@cs.group.fun':
id: 'DeleteGroupConfigurationV1@cs.group.fun'
name: 'DeleteGroupConfigurationV1'
type: 'function'
description: |-
This endpoint is used to delete group configuration. This Configuration is used as the main rule of the service. Each namespace will have its own configuration
Action Code: 73101
arguments:
'ConfigurationCode':
type: 'string'
required: true
description: |-
Group Configuration Code
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Configuration.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Configuration/DeleteGroupConfigurationV1.cs'
example: |-
try
{
var operation = sdk.Group.Configuration.DeleteGroupConfigurationV1Op
.Build();
sdk.Group.Configuration.DeleteGroupConfigurationV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'configuration'
- 'delete'
- 'group'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION [DELETE]'
scopes:
- 'social'
'DeleteGroupPredefinedRulePublicV1@cs.group.fun':
id: 'DeleteGroupPredefinedRulePublicV1@cs.group.fun'
name: 'DeleteGroupPredefinedRulePublicV1'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP [UPDATE]"
Delete group predefined rule based on the allowed action. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73309
arguments:
'AllowedAction':
type: 'string'
required: true
description: |-
Allowed action, any available action in service
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/DeleteGroupPredefinedRulePublicV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.DeleteGroupPredefinedRulePublicV1Op
.Build();
sdk.Group.Group.DeleteGroupPredefinedRulePublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'group'
- 'predefined'
- 'public'
- 'rule'
- 'v1'
scopes:
- 'social'
'DeleteGroupPredefinedRulePublicV2@cs.group.fun':
id: 'DeleteGroupPredefinedRulePublicV2@cs.group.fun'
name: 'DeleteGroupPredefinedRulePublicV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP [UPDATE]"
Delete group predefined rule based on the allowed action. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73309
arguments:
'AllowedAction':
type: 'string'
required: true
description: |-
Allowed action, any available action in service
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/DeleteGroupPredefinedRulePublicV2.cs'
example: |-
try
{
var operation = sdk.Group.Group.DeleteGroupPredefinedRulePublicV2Op
.Build();
sdk.Group.Group.DeleteGroupPredefinedRulePublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'group'
- 'predefined'
- 'public'
- 'rule'
- 'v2'
scopes:
- 'social'
'DeleteGroupPublicV1@cs.group.fun':
id: 'DeleteGroupPublicV1@cs.group.fun'
name: 'DeleteGroupPublicV1'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP [DELETE]"
Delete existing group. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73305
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/DeleteGroupPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.DeleteGroupPublicV1Op
.Build();
sdk.Group.Group.DeleteGroupPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'group'
- 'public'
- 'v1'
scopes:
- 'social'
'DeleteGroupPublicV2@cs.group.fun':
id: 'DeleteGroupPublicV2@cs.group.fun'
name: 'DeleteGroupPublicV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP [DELETE]"
Delete existing group. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73305
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/DeleteGroupPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.Group.DeleteGroupPublicV2Op
.Build();
sdk.Group.Group.DeleteGroupPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'group'
- 'public'
- 'v2'
scopes:
- 'social'
'DeleteMemberRoleAdminV1@cs.group.fun':
id: 'DeleteMemberRoleAdminV1@cs.group.fun'
name: 'DeleteMemberRoleAdminV1'
type: 'function'
description: |-
This endpoint is used to delete member role. Any member role can't be deleted if the specific role is applied to the configuration (admin and member role)
Action Code: 73207
arguments:
'MemberRoleId':
type: 'string'
required: true
description: |-
member Role ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/DeleteMemberRoleAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.DeleteMemberRoleAdminV1Op
.Build();
sdk.Group.GroupRoles.DeleteMemberRoleAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'group'
- 'member'
- 'role'
- 'roles'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:ROLE [DELETE]'
scopes:
- 'social'
'DeleteMemberRolePublicV1@cs.group.fun':
id: 'DeleteMemberRolePublicV1@cs.group.fun'
name: 'DeleteMemberRolePublicV1'
type: 'function'
description: |-
Required Member Role Permission: "GROUP:ROLE [UPDATE]"
This endpoint is used to remove role from group member
Action Code: 73204
arguments:
'Body':
type: 'ModelsRemoveRoleFromMemberRequestV1'
required: true
'MemberRoleId':
type: 'string'
required: true
description: |-
member Role ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/DeleteMemberRolePublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.DeleteMemberRolePublicV1Op
.Build();
sdk.Group.GroupRoles.DeleteMemberRolePublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'group'
- 'member'
- 'public'
- 'role'
- 'roles'
- 'v1'
scopes:
- 'social'
'DeleteMemberRolePublicV2@cs.group.fun':
id: 'DeleteMemberRolePublicV2@cs.group.fun'
name: 'DeleteMemberRolePublicV2'
type: 'function'
description: |-
Required Member Role Permission: "GROUP:ROLE [UPDATE]"
This endpoint is used to remove role from group member
Action Code: 73204
arguments:
'Body':
type: 'ModelsRemoveRoleFromMemberRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'MemberRoleId':
type: 'string'
required: true
description: |-
member Role ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/DeleteMemberRolePublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.DeleteMemberRolePublicV2Op
.Build();
sdk.Group.GroupRoles.DeleteMemberRolePublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'group'
- 'member'
- 'public'
- 'role'
- 'roles'
- 'v2'
scopes:
- 'social'
'GetGroupConfigurationAdminV1@cs.group.fun':
id: 'GetGroupConfigurationAdminV1@cs.group.fun'
name: 'GetGroupConfigurationAdminV1'
type: 'function'
description: |-
This endpoint is used to get existing configuration. This Configuration is used as the main rule of the service. Each namespace will have its own configuration
Action Code: 73101
arguments:
'ConfigurationCode':
type: 'string'
required: true
description: |-
Group Configuration Code
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGetGroupConfigurationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Configuration.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Configuration/GetGroupConfigurationAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.Configuration.GetGroupConfigurationAdminV1Op
.Build();
var response = sdk.Group.Configuration.GetGroupConfigurationAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'get'
- 'group'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION [READ]'
scopes:
- 'social'
'GetGroupInvitationRequestPublicV1@cs.group.fun':
id: 'GetGroupInvitationRequestPublicV1@cs.group.fun'
name: 'GetGroupInvitationRequestPublicV1'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to Get Group Invitation Request List
Get Group Invitation Request List for the user calling this endpoint. It will check any group invitation for this user
Action Code: 73502
arguments:
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsGetMemberRequestsListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/MemberRequest.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/MemberRequest/GetGroupInvitationRequestPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.MemberRequest.GetGroupInvitationRequestPublicV1Op
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Group.MemberRequest.GetGroupInvitationRequestPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'invitation'
- 'member'
- 'public'
- 'request'
- 'v1'
scopes:
- 'social'
'GetGroupInviteRequestPublicV2@cs.group.fun':
id: 'GetGroupInviteRequestPublicV2@cs.group.fun'
name: 'GetGroupInviteRequestPublicV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:JOIN [READ]"
This endpoint is used to Get Group Invite Request List
Get Group Invite Request List for specific group. Group members needs to have permission and also belong to the group to access this endpoint
Action Code: 73501
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsGetMemberRequestsListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/MemberRequest.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/MemberRequest/GetGroupInviteRequestPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.MemberRequest.GetGroupInviteRequestPublicV2Op
.SetLimit(...)
.SetOffset(...)
.Build(
groupId,
namespace_,
);
var response = sdk.Group.MemberRequest.GetGroupInviteRequestPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'invite'
- 'member'
- 'public'
- 'request'
- 'v2'
scopes:
- 'social'
'GetGroupJoinRequestPublicV1@cs.group.fun':
id: 'GetGroupJoinRequestPublicV1@cs.group.fun'
name: 'GetGroupJoinRequestPublicV1'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:JOIN [READ]"
This endpoint is used to Get Group Join Request List
Get Group Join Request List for specific group. Group members needs to have permission and also belong to the group to access this endpoint
Action Code: 73501
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsGetMemberRequestsListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/MemberRequest.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/MemberRequest/GetGroupJoinRequestPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.MemberRequest.GetGroupJoinRequestPublicV1Op
.SetLimit(...)
.SetOffset(...)
.Build(
groupId,
namespace_,
);
var response = sdk.Group.MemberRequest.GetGroupJoinRequestPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'join'
- 'member'
- 'public'
- 'request'
- 'v1'
scopes:
- 'social'
'GetGroupJoinRequestPublicV2@cs.group.fun':
id: 'GetGroupJoinRequestPublicV2@cs.group.fun'
name: 'GetGroupJoinRequestPublicV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:JOIN [READ]"
This endpoint is used to Get Group Join Request List
Get Group Join Request List for specific group. Group members needs to have permission and also belong to the group to access this endpoint
Action Code: 73501
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsGetMemberRequestsListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/MemberRequest.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/MemberRequest/GetGroupJoinRequestPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.MemberRequest.GetGroupJoinRequestPublicV2Op
.SetLimit(...)
.SetOffset(...)
.Build(
groupId,
namespace_,
);
var response = sdk.Group.MemberRequest.GetGroupJoinRequestPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'join'
- 'member'
- 'public'
- 'request'
- 'v2'
scopes:
- 'social'
'GetGroupListAdminV1@cs.group.fun':
id: 'GetGroupListAdminV1@cs.group.fun'
name: 'GetGroupListAdminV1'
type: 'function'
description: |-
Get list of groups. This endpoint will show any types of group
Action Code: 73301
arguments:
'ConfigurationCode':
type: 'string'
required: false
description: |-
Query Group Configuration Code
'GroupName':
type: 'string'
required: false
description: |-
Query Group Name
'GroupRegion':
type: 'string'
required: false
description: |-
Query Group Region
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsGetGroupsListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/GetGroupListAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.GetGroupListAdminV1Op
.SetConfigurationCode(...)
.SetGroupName(...)
.SetGroupRegion(...)
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Group.Group.GetGroupListAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'group'
- 'list'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP [READ]'
scopes:
- 'social'
'GetGroupListPublicV1@cs.group.fun':
id: 'GetGroupListPublicV1@cs.group.fun'
name: 'GetGroupListPublicV1'
type: 'function'
description: |-
Required valid user authentication
Get list of groups. This endpoint will only show OPEN and PUBLIC group type. This endpoint can search based on the group name by filling the "groupName" query parameter
Action Code: 73303
arguments:
'GroupName':
type: 'string'
required: false
description: |-
Query Group Name
'GroupRegion':
type: 'string'
required: false
description: |-
Query Group Region
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsGetGroupsListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/GetGroupListPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.GetGroupListPublicV1Op
.SetGroupName(...)
.SetGroupRegion(...)
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Group.Group.GetGroupListPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'list'
- 'public'
- 'v1'
scopes:
- 'social'
'GetGroupMembersListAdminV1@cs.group.fun':
id: 'GetGroupMembersListAdminV1@cs.group.fun'
name: 'GetGroupMembersListAdminV1'
type: 'function'
description: |-
This endpoint is used to get list of group members.
Action Code: 73410
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
'Order':
type: 'string'
required: false
description: |-
Sort group members list by User ID with ascending as default order. Set it 'desc' for descending order
return_type: 'ModelsGetGroupMemberListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/GetGroupMembersListAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.GetGroupMembersListAdminV1Op
.SetLimit(...)
.SetOffset(...)
.SetOrder(...)
.Build(
groupId,
namespace_,
);
var response = sdk.Group.GroupMember.GetGroupMembersListAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'group'
- 'list'
- 'member'
- 'members'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:MEMBER [READ]'
scopes:
- 'social'
'GetGroupMembersListPublicV1@cs.group.fun':
id: 'GetGroupMembersListPublicV1@cs.group.fun'
name: 'GetGroupMembersListPublicV1'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to get list of group members.
Action Code: 73410
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
'Order':
type: 'string'
required: false
description: |-
Sort group members list by User ID with ascending as default order. Set it 'desc' for descending order
return_type: 'ModelsGetGroupMemberListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/GetGroupMembersListPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.GetGroupMembersListPublicV1Op
.SetLimit(...)
.SetOffset(...)
.SetOrder(...)
.Build(
groupId,
namespace_,
);
var response = sdk.Group.GroupMember.GetGroupMembersListPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'list'
- 'member'
- 'members'
- 'public'
- 'v1'
scopes:
- 'social'
'GetListGroupByIDsAdminV2@cs.group.fun':
id: 'GetListGroupByIDsAdminV2@cs.group.fun'
name: 'GetListGroupByIDsAdminV2'
type: 'function'
description: |-
Required valid user authentication
Get list of groups by group Ids.
Action Code: 73303
arguments:
'Body':
type: 'ModelsGetGroupListRequestV2'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGetGroupsResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/GetListGroupByIDsAdminV2.cs'
example: |-
try
{
var operation = sdk.Group.Group.GetListGroupByIDsAdminV2Op
.Build();
var response = sdk.Group.Group.GetListGroupByIDsAdminV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'by'
- 'ds'
- 'get'
- 'group'
- 'i'
- 'list'
- 'v2'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP [READ]'
scopes:
- 'social'
'GetListGroupByIDsV2@cs.group.fun':
id: 'GetListGroupByIDsV2@cs.group.fun'
name: 'GetListGroupByIDsV2'
type: 'function'
description: |-
Required valid user authentication
Get list of groups by group Ids.
Action Code: 73303
arguments:
'Body':
type: 'ModelsGetGroupListRequestV2'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGetGroupsResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/GetListGroupByIDsV2.cs'
example: |-
try
{
var operation = sdk.Group.Group.GetListGroupByIDsV2Op
.Build();
var response = sdk.Group.Group.GetListGroupByIDsV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'by'
- 'ds'
- 'get'
- 'group'
- 'i'
- 'list'
- 'v2'
scopes:
- 'social'
'GetMemberRolesListAdminV1@cs.group.fun':
id: 'GetMemberRolesListAdminV1@cs.group.fun'
name: 'GetMemberRolesListAdminV1'
type: 'function'
description: |-
This endpoint is used to get list of member roles
Action Code: 73201
arguments:
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsGetMemberRolesListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/GetMemberRolesListAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.GetMemberRolesListAdminV1Op
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Group.GroupRoles.GetMemberRolesListAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'group'
- 'list'
- 'member'
- 'roles'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:ROLE [READ]'
scopes:
- 'social'
'GetMemberRolesListPublicV1@cs.group.fun':
id: 'GetMemberRolesListPublicV1@cs.group.fun'
name: 'GetMemberRolesListPublicV1'
type: 'function'
description: |-
Required Member Role Permission: "GROUP:ROLE [READ]"
This endpoint is used to get list of member roles
Action Code: 73201
arguments:
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsGetMemberRolesListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/GetMemberRolesListPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.GetMemberRolesListPublicV1Op
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Group.GroupRoles.GetMemberRolesListPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'list'
- 'member'
- 'public'
- 'roles'
- 'v1'
scopes:
- 'social'
'GetMemberRolesListPublicV2@cs.group.fun':
id: 'GetMemberRolesListPublicV2@cs.group.fun'
name: 'GetMemberRolesListPublicV2'
type: 'function'
description: |-
This endpoint is used to get list of member roles
Action Code: 73201
arguments:
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsGetMemberRolesListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/GetMemberRolesListPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.GetMemberRolesListPublicV2Op
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Group.GroupRoles.GetMemberRolesListPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'list'
- 'member'
- 'public'
- 'roles'
- 'v2'
scopes:
- 'social'
'GetMyGroupJoinRequestV2@cs.group.fun':
id: 'GetMyGroupJoinRequestV2@cs.group.fun'
name: 'GetMyGroupJoinRequestV2'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to Get My Join Request To The Groups
Get My Join Request To The Groups for the user calling this endpoint. It will check any join request group for this user
Action Code: 73502
arguments:
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsGetMemberRequestsListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/MemberRequest.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/MemberRequest/GetMyGroupJoinRequestV2.cs'
example: |-
try
{
var operation = sdk.Group.MemberRequest.GetMyGroupJoinRequestV2Op
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Group.MemberRequest.GetMyGroupJoinRequestV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'join'
- 'member'
- 'my'
- 'request'
- 'v2'
scopes:
- 'social'
'GetSingleGroupAdminV1@cs.group.fun':
id: 'GetSingleGroupAdminV1@cs.group.fun'
name: 'GetSingleGroupAdminV1'
type: 'function'
description: |-
Get single group information. This endpoint will show the group information by the groupId
Action Code: 73306
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/GetSingleGroupAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.GetSingleGroupAdminV1Op
.Build();
var response = sdk.Group.Group.GetSingleGroupAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'group'
- 'single'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP [READ]'
scopes:
- 'social'
'GetSingleGroupPublicV1@cs.group.fun':
id: 'GetSingleGroupPublicV1@cs.group.fun'
name: 'GetSingleGroupPublicV1'
type: 'function'
description: |-
Required valid user authentication
Get single group information. This endpoint will show the group information by the groupId
Action Code: 73306
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/GetSingleGroupPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.GetSingleGroupPublicV1Op
.Build();
var response = sdk.Group.Group.GetSingleGroupPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'public'
- 'single'
- 'v1'
scopes:
- 'social'
'GetSingleMemberRoleAdminV1@cs.group.fun':
id: 'GetSingleMemberRoleAdminV1@cs.group.fun'
name: 'GetSingleMemberRoleAdminV1'
type: 'function'
description: |-
This endpoint is used to get member role based on the role ID
Action Code: 73203
arguments:
'MemberRoleId':
type: 'string'
required: true
description: |-
member Role ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsMemberRoleResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/GetSingleMemberRoleAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.GetSingleMemberRoleAdminV1Op
.Build();
var response = sdk.Group.GroupRoles.GetSingleMemberRoleAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'group'
- 'member'
- 'role'
- 'roles'
- 'single'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:ROLE [READ]'
scopes:
- 'social'
'GetUserGroupInformationPublicV1@cs.group.fun':
id: 'GetUserGroupInformationPublicV1@cs.group.fun'
name: 'GetUserGroupInformationPublicV1'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to get user group information.
Get user group information. If user does not belong to any group, it will return warning to give information about it
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
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsGetUserGroupInformationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/GetUserGroupInformationPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.GetUserGroupInformationPublicV1Op
.Build();
var response = sdk.Group.GroupMember.GetUserGroupInformationPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'information'
- 'member'
- 'public'
- 'user'
- 'v1'
scopes:
- 'social'
'GetUserGroupInformationPublicV2@cs.group.fun':
id: 'GetUserGroupInformationPublicV2@cs.group.fun'
name: 'GetUserGroupInformationPublicV2'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to get user joined group information.
Get user group joined information. If user does not belong to any group, it will return warning to give information about it
Group Member Status:
* JOINED: status of user already joined to a group
Action Code: 73405
arguments:
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsGetGroupMemberListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/GetUserGroupInformationPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.GetUserGroupInformationPublicV2Op
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Group.GroupMember.GetUserGroupInformationPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'information'
- 'member'
- 'public'
- 'user'
- 'v2'
scopes:
- 'social'
'GetUserGroupStatusInformationV2@cs.group.fun':
id: 'GetUserGroupStatusInformationV2@cs.group.fun'
name: 'GetUserGroupStatusInformationV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP [READ]"
This endpoint is used to get user group status information.
get user group status information. This endpoint will check the member and group information, and also the role permission of the the user who accesses this endpoint
Action Code: 73409
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsGetUserGroupInformationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/GetUserGroupStatusInformationV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.GetUserGroupStatusInformationV2Op
.Build();
var response = sdk.Group.GroupMember.GetUserGroupStatusInformationV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'information'
- 'member'
- 'status'
- 'user'
- 'v2'
scopes:
- 'social'
'GetUserJoinedGroupInformationPublicV2@cs.group.fun':
id: 'GetUserJoinedGroupInformationPublicV2@cs.group.fun'
name: 'GetUserJoinedGroupInformationPublicV2'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to get user joined group information.
Get user group joined information. If user does not belong to any group, it will return warning to give information about it
Group Member Status:
* JOINED: status of user already joined to a group
arguments:
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsGetGroupMemberListResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/GetUserJoinedGroupInformationPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.GetUserJoinedGroupInformationPublicV2Op
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
userId,
);
var response = sdk.Group.GroupMember.GetUserJoinedGroupInformationPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'group'
- 'information'
- 'joined'
- 'member'
- 'public'
- 'user'
- 'v2'
scopes:
- 'social'
'InitiateGroupConfigurationAdminV1@cs.group.fun':
id: 'InitiateGroupConfigurationAdminV1@cs.group.fun'
name: 'InitiateGroupConfigurationAdminV1'
type: 'function'
description: |-
This endpoint is used to initiate configuration.
This endpoint will automatically create default configuration and member roles with default permission
Default Permission for admin role will cover these permission:
- Permission to invite user to group
- Permission to accept or reject join request
- Permission to kick group member
Default max member value will be 50 and global rules will be empty
Action Code: 73104
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsCreateGroupConfigurationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Configuration.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Configuration/InitiateGroupConfigurationAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.Configuration.InitiateGroupConfigurationAdminV1Op
.Build();
var response = sdk.Group.Configuration.InitiateGroupConfigurationAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'group'
- 'initiate'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION [CREATE]'
scopes:
- 'social'
'InviteGroupPublicV1@cs.group.fun':
id: 'InviteGroupPublicV1@cs.group.fun'
name: 'InviteGroupPublicV1'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:INVITE [CREATE]"
This endpoint is used to invite specific user to the group.
invite specific user to the group. If specific user is already have the join request to the group, this endpoint will notify if this user already have join request that needs to be accepted / rejected
Invited user will receive notification through lobby.
Action Code: 73406
memberRolePermissions example value :
"action": 1
"resourceName": "GROUP:INVITE"
The invited user will have a permission to invite another user to the group
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsUserInvitationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/InviteGroupPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.InviteGroupPublicV1Op
.Build();
var response = sdk.Group.GroupMember.InviteGroupPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'invite'
- 'member'
- 'public'
- 'v1'
scopes:
- 'social'
'InviteGroupPublicV2@cs.group.fun':
id: 'InviteGroupPublicV2@cs.group.fun'
name: 'InviteGroupPublicV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:INVITE [CREATE]"
This endpoint is used to invite specific user to the group.
invite specific user to the group. If specific user is already have the join request to the group, this endpoint will notify if this user already have join request that needs to be accepted / rejected
Invited user will receive notification through lobby.
Action Code: 73406
memberRolePermissions example value :
"action": 1
"resourceName": "GROUP:INVITE"
The invited user will have a permission to invite another user to the group
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsUserInvitationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/InviteGroupPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.InviteGroupPublicV2Op
.Build();
var response = sdk.Group.GroupMember.InviteGroupPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'invite'
- 'member'
- 'public'
- 'v2'
scopes:
- 'social'
'JoinGroupV1@cs.group.fun':
id: 'JoinGroupV1@cs.group.fun'
name: 'JoinGroupV1'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to join as group member
Join to the group. This endpoint will check the the the type of the group based on the groupID.
Additional Information:
* 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
This endpoint will return status field to give information whether the user is JOINED or REQUESTED to join to the specific group
Action Code: 73403
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsJoinGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/JoinGroupV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.JoinGroupV1Op
.Build();
var response = sdk.Group.GroupMember.JoinGroupV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'join'
- 'member'
- 'v1'
scopes:
- 'social'
'JoinGroupV2@cs.group.fun':
id: 'JoinGroupV2@cs.group.fun'
name: 'JoinGroupV2'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to join as group member
Join to the group. This endpoint will check the the the type of the group based on the groupID.
Additional Information:
* 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
This endpoint will return status field to give information whether the user is JOINED or REQUESTED to join to the specific group
Action Code: 73403
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsJoinGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/JoinGroupV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.JoinGroupV2Op
.Build();
var response = sdk.Group.GroupMember.JoinGroupV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'join'
- 'member'
- 'v2'
scopes:
- 'social'
'KickGroupMemberPublicV1@cs.group.fun':
id: 'KickGroupMemberPublicV1@cs.group.fun'
name: 'KickGroupMemberPublicV1'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:KICK [CREATE]"
This endpoint is used to kick group member.
Kick group member. This endpoint will check the member and group information, and also the role permission of the the user who accesses this endpoint
Action Code: 73409
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsKickGroupMemberResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/KickGroupMemberPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.KickGroupMemberPublicV1Op
.Build();
var response = sdk.Group.GroupMember.KickGroupMemberPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'kick'
- 'member'
- 'public'
- 'v1'
scopes:
- 'social'
'KickGroupMemberPublicV2@cs.group.fun':
id: 'KickGroupMemberPublicV2@cs.group.fun'
name: 'KickGroupMemberPublicV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:KICK [CREATE]"
This endpoint is used to kick group member.
Kick group member. This endpoint will check the member and group information, and also the role permission of the the user who accesses this endpoint
Action Code: 73409
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsKickGroupMemberResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/KickGroupMemberPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.KickGroupMemberPublicV2Op
.Build();
var response = sdk.Group.GroupMember.KickGroupMemberPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'kick'
- 'member'
- 'public'
- 'v2'
scopes:
- 'social'
'LeaveGroupPublicV1@cs.group.fun':
id: 'LeaveGroupPublicV1@cs.group.fun'
name: 'LeaveGroupPublicV1'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to leave from group.
leave from group. Admin is not allowed to leave the group. This endpoint will also give response if the user does not belong to any group.
Action Code: 73404
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsLeaveGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/LeaveGroupPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.LeaveGroupPublicV1Op
.Build();
var response = sdk.Group.GroupMember.LeaveGroupPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'leave'
- 'member'
- 'public'
- 'v1'
scopes:
- 'social'
'LeaveGroupPublicV2@cs.group.fun':
id: 'LeaveGroupPublicV2@cs.group.fun'
name: 'LeaveGroupPublicV2'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to leave from group.
leave from group. Admin is not allowed to leave the group. This endpoint will also give response if the user does not belong to any group.
Action Code: 73404
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsLeaveGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/LeaveGroupPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.LeaveGroupPublicV2Op
.Build();
var response = sdk.Group.GroupMember.LeaveGroupPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'leave'
- 'member'
- 'public'
- 'v2'
scopes:
- 'social'
'ListGroupConfigurationAdminV1@cs.group.fun':
id: 'ListGroupConfigurationAdminV1@cs.group.fun'
name: 'ListGroupConfigurationAdminV1'
type: 'function'
description: |-
This endpoint is used to get existing configuration. This Configuration is used as the main rule of the service. Each namespace will have its own configuration
Action Code: 73101
arguments:
'Limit':
type: 'long'
required: false
description: |-
size of displayed data
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
The start position that points to query data
return_type: 'ModelsListConfigurationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Configuration.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Configuration/ListGroupConfigurationAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.Configuration.ListGroupConfigurationAdminV1Op
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Group.Configuration.ListGroupConfigurationAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'group'
- 'list'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION [READ]'
scopes:
- 'social'
'RejectGroupInvitationPublicV1@cs.group.fun':
id: 'RejectGroupInvitationPublicV1@cs.group.fun'
name: 'RejectGroupInvitationPublicV1'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to reject group invitation.
Reject group invitation. If specific user is not invited in the specific group ID, it will show the the error to show if the user is not invited yet.
Action Code: 73402
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsMemberRequestGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/RejectGroupInvitationPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.RejectGroupInvitationPublicV1Op
.Build();
var response = sdk.Group.GroupMember.RejectGroupInvitationPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'invitation'
- 'member'
- 'public'
- 'reject'
- 'v1'
scopes:
- 'social'
'RejectGroupInvitationPublicV2@cs.group.fun':
id: 'RejectGroupInvitationPublicV2@cs.group.fun'
name: 'RejectGroupInvitationPublicV2'
type: 'function'
description: |-
Required valid user authentication
This endpoint is used to reject group invitation.
Reject group invitation. If specific user is not invited in the specific group ID, it will show the the error to show if the user is not invited yet.
Action Code: 73402
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsMemberRequestGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/RejectGroupInvitationPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.RejectGroupInvitationPublicV2Op
.Build();
var response = sdk.Group.GroupMember.RejectGroupInvitationPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'invitation'
- 'member'
- 'public'
- 'reject'
- 'v2'
scopes:
- 'social'
'RejectGroupJoinRequestPublicV1@cs.group.fun':
id: 'RejectGroupJoinRequestPublicV1@cs.group.fun'
name: 'RejectGroupJoinRequestPublicV1'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:JOIN [CREATE]"
This endpoint is used to reject group join request.
Reject group join request. If specific user is not asked to join the specific group ID, it will show the the error to show if the user is not asked to join yet.
This endpoint will also check if the specific user is already joined to specific group
Action Code: 73408
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsMemberRequestGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/RejectGroupJoinRequestPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.RejectGroupJoinRequestPublicV1Op
.Build();
var response = sdk.Group.GroupMember.RejectGroupJoinRequestPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'join'
- 'member'
- 'public'
- 'reject'
- 'request'
- 'v1'
scopes:
- 'social'
'RejectGroupJoinRequestPublicV2@cs.group.fun':
id: 'RejectGroupJoinRequestPublicV2@cs.group.fun'
name: 'RejectGroupJoinRequestPublicV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP:JOIN [CREATE]"
This endpoint is used to reject group join request.
Reject group join request. If specific user is not asked to join the specific group ID, it will show the the error to show if the user is not asked to join yet.
This endpoint will also check if the specific user is already joined to specific group
Action Code: 73408
arguments:
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
'UserId':
type: 'string'
required: true
description: |-
User ID
return_type: 'ModelsMemberRequestGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupMember.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupMember/RejectGroupJoinRequestPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupMember.RejectGroupJoinRequestPublicV2Op
.Build();
var response = sdk.Group.GroupMember.RejectGroupJoinRequestPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'join'
- 'member'
- 'public'
- 'reject'
- 'request'
- 'v2'
scopes:
- 'social'
'UpdateGroupConfigurationAdminV1@cs.group.fun':
id: 'UpdateGroupConfigurationAdminV1@cs.group.fun'
name: 'UpdateGroupConfigurationAdminV1'
type: 'function'
description: |-
This endpoint is used to update existing configuration. groupAdminRoleId and groupMemberRoleId won't be able to be updated. User can try to change the member role permission instead for each of those member role
Action Code: 73102
arguments:
'Body':
type: 'ModelsUpdateGroupConfigurationRequestV1'
required: true
'ConfigurationCode':
type: 'string'
required: true
description: |-
Group Configuration Code
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsUpdateGroupConfigurationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Configuration.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Configuration/UpdateGroupConfigurationAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.Configuration.UpdateGroupConfigurationAdminV1Op
.Build();
var response = sdk.Group.Configuration.UpdateGroupConfigurationAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'group'
- 'update'
- 'v1'
'UpdateGroupConfigurationGlobalRuleAdminV1@cs.group.fun':
id: 'UpdateGroupConfigurationGlobalRuleAdminV1@cs.group.fun'
name: 'UpdateGroupConfigurationGlobalRuleAdminV1'
type: 'function'
description: |-
This endpoint is used to update existing global rule configuration based on the allowed action. It will replace the permission with the request
Action Code: 73106
arguments:
'AllowedAction':
type: 'string'
required: true
description: |-
Allowed Action. The value should be any actions in the service
'Body':
type: 'ModelsUpdateGroupConfigurationGlobalRulesRequestV1'
required: true
'ConfigurationCode':
type: 'string'
required: true
description: |-
Group Configuration Code
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsUpdateGroupConfigurationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Configuration.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Configuration/UpdateGroupConfigurationGlobalRuleAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.Configuration.UpdateGroupConfigurationGlobalRuleAdminV1Op
.Build();
var response = sdk.Group.Configuration.UpdateGroupConfigurationGlobalRuleAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configuration'
- 'global'
- 'group'
- 'rule'
- 'update'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:CONFIGURATION [UPDATE]'
scopes:
- 'social'
'UpdateGroupCustomAttributesPublicV1@cs.group.fun':
id: 'UpdateGroupCustomAttributesPublicV1@cs.group.fun'
name: 'UpdateGroupCustomAttributesPublicV1'
type: 'function'
description: |-
Requires valid user authentication
Required Member Role Permission: "GROUP [UPDATE]
This endpoint replaces current group custom attributes entirely. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73311
arguments:
'Body':
type: 'ModelsUpdateGroupCustomAttributesRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/UpdateGroupCustomAttributesPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.UpdateGroupCustomAttributesPublicV1Op
.Build();
var response = sdk.Group.Group.UpdateGroupCustomAttributesPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'attributes'
- 'custom'
- 'group'
- 'public'
- 'update'
- 'v1'
scopes:
- 'social'
'UpdateGroupCustomAttributesPublicV2@cs.group.fun':
id: 'UpdateGroupCustomAttributesPublicV2@cs.group.fun'
name: 'UpdateGroupCustomAttributesPublicV2'
type: 'function'
description: |-
Requires valid user authentication
Required Member Role Permission: "GROUP [UPDATE]"
This endpoint replaces current group custom attributes entirely. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73311
arguments:
'Body':
type: 'ModelsUpdateGroupCustomAttributesRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/UpdateGroupCustomAttributesPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.Group.UpdateGroupCustomAttributesPublicV2Op
.Build();
var response = sdk.Group.Group.UpdateGroupCustomAttributesPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'attributes'
- 'custom'
- 'group'
- 'public'
- 'update'
- 'v2'
scopes:
- 'social'
'UpdateGroupCustomRulePublicV1@cs.group.fun':
id: 'UpdateGroupCustomRulePublicV1@cs.group.fun'
name: 'UpdateGroupCustomRulePublicV1'
type: 'function'
description: |-
Required valid user authentication
Update group custom rule. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73308
arguments:
'Body':
type: 'ModelsUpdateGroupCustomRuleRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/UpdateGroupCustomRulePublicV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.UpdateGroupCustomRulePublicV1Op
.Build();
var response = sdk.Group.Group.UpdateGroupCustomRulePublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'custom'
- 'group'
- 'public'
- 'rule'
- 'update'
- 'v1'
scopes:
- 'social'
'UpdateGroupCustomRulePublicV2@cs.group.fun':
id: 'UpdateGroupCustomRulePublicV2@cs.group.fun'
name: 'UpdateGroupCustomRulePublicV2'
type: 'function'
description: |-
Required valid user authentication
Update group custom rule. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73308
arguments:
'Body':
type: 'ModelsUpdateGroupCustomRuleRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/UpdateGroupCustomRulePublicV2.cs'
example: |-
try
{
var operation = sdk.Group.Group.UpdateGroupCustomRulePublicV2Op
.Build();
var response = sdk.Group.Group.UpdateGroupCustomRulePublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'custom'
- 'group'
- 'public'
- 'rule'
- 'update'
- 'v2'
scopes:
- 'social'
'UpdateGroupPredefinedRulePublicV1@cs.group.fun':
id: 'UpdateGroupPredefinedRulePublicV1@cs.group.fun'
name: 'UpdateGroupPredefinedRulePublicV1'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP [UPDATE]"
Update predefined group rule. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
If the rule action is not defined in the group, it will be added immediately to the predefined group rule
Action Code: 73310
arguments:
'AllowedAction':
type: 'string'
required: true
description: |-
Allowed action, any available action in service
'Body':
type: 'ModelsUpdateGroupPredefinedRuleRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/UpdateGroupPredefinedRulePublicV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.UpdateGroupPredefinedRulePublicV1Op
.Build();
var response = sdk.Group.Group.UpdateGroupPredefinedRulePublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'predefined'
- 'public'
- 'rule'
- 'update'
- 'v1'
scopes:
- 'social'
'UpdateGroupPredefinedRulePublicV2@cs.group.fun':
id: 'UpdateGroupPredefinedRulePublicV2@cs.group.fun'
name: 'UpdateGroupPredefinedRulePublicV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP [UPDATE]"
Update predefined group rule. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
If the rule action is not defined in the group, it will be added immediately to the predefined group rule
Action Code: 73310
arguments:
'AllowedAction':
type: 'string'
required: true
description: |-
Allowed action, any available action in service
'Body':
type: 'ModelsUpdateGroupPredefinedRuleRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/UpdateGroupPredefinedRulePublicV2.cs'
example: |-
try
{
var operation = sdk.Group.Group.UpdateGroupPredefinedRulePublicV2Op
.Build();
var response = sdk.Group.Group.UpdateGroupPredefinedRulePublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'predefined'
- 'public'
- 'rule'
- 'update'
- 'v2'
scopes:
- 'social'
'UpdateMemberRoleAdminV1@cs.group.fun':
id: 'UpdateMemberRoleAdminV1@cs.group.fun'
name: 'UpdateMemberRoleAdminV1'
type: 'function'
description: |-
This endpoint is used to update member role
Action Code: 73204
arguments:
'Body':
type: 'ModelsUpdateMemberRoleRequestV1'
required: true
'MemberRoleId':
type: 'string'
required: true
description: |-
member Role ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsMemberRoleResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/UpdateMemberRoleAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.UpdateMemberRoleAdminV1Op
.Build();
var response = sdk.Group.GroupRoles.UpdateMemberRoleAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'group'
- 'member'
- 'role'
- 'roles'
- 'update'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:ROLE [UPDATE]'
scopes:
- 'social'
'UpdateMemberRolePermissionAdminV1@cs.group.fun':
id: 'UpdateMemberRolePermissionAdminV1@cs.group.fun'
name: 'UpdateMemberRolePermissionAdminV1'
type: 'function'
description: |-
This endpoint is used to update member role permission. It will replace the existing permission based on the request from this endpoint
Action Code: 73205
memberRolePermissions example value :
"action": 2
"resourceName": "GROUP:ROLE"
The changes will update user role to be able to read a role of other member
arguments:
'Body':
type: 'ModelsUpdateMemberRolePermissionsRequestV1'
required: true
'MemberRoleId':
type: 'string'
required: true
description: |-
member Role ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsMemberRoleResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/UpdateMemberRolePermissionAdminV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.UpdateMemberRolePermissionAdminV1Op
.Build();
var response = sdk.Group.GroupRoles.UpdateMemberRolePermissionAdminV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'group'
- 'member'
- 'permission'
- 'role'
- 'roles'
- 'update'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:GROUP:ROLE [UPDATE]'
scopes:
- 'social'
'UpdateMemberRolePublicV1@cs.group.fun':
id: 'UpdateMemberRolePublicV1@cs.group.fun'
name: 'UpdateMemberRolePublicV1'
type: 'function'
description: |-
Required Member Role Permission: "GROUP:ROLE [UPDATE]
This endpoint is used to assign role to group member
Action Code: 73204
arguments:
'Body':
type: 'ModelsAssignRoleToMemberRequestV1'
required: true
'MemberRoleId':
type: 'string'
required: true
description: |-
member Role ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGetUserGroupInformationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/UpdateMemberRolePublicV1.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.UpdateMemberRolePublicV1Op
.Build();
var response = sdk.Group.GroupRoles.UpdateMemberRolePublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'member'
- 'public'
- 'role'
- 'roles'
- 'update'
- 'v1'
scopes:
- 'social'
'UpdateMemberRolePublicV2@cs.group.fun':
id: 'UpdateMemberRolePublicV2@cs.group.fun'
name: 'UpdateMemberRolePublicV2'
type: 'function'
description: |-
Required Member Role Permission: "GROUP:ROLE [UPDATE]
This endpoint is used to assign role to group member
Action Code: 73204
arguments:
'Body':
type: 'ModelsAssignRoleToMemberRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'MemberRoleId':
type: 'string'
required: true
description: |-
member Role ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGetUserGroupInformationResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/GroupRoles.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/GroupRoles/UpdateMemberRolePublicV2.cs'
example: |-
try
{
var operation = sdk.Group.GroupRoles.UpdateMemberRolePublicV2Op
.Build();
var response = sdk.Group.GroupRoles.UpdateMemberRolePublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'member'
- 'public'
- 'role'
- 'roles'
- 'update'
- 'v2'
scopes:
- 'social'
'UpdatePatchSingleGroupPublicV1@cs.group.fun':
id: 'UpdatePatchSingleGroupPublicV1@cs.group.fun'
name: 'UpdatePatchSingleGroupPublicV1'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP [UPDATE]"
Update existing group. This endpoint supports partial update. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73307
arguments:
'Body':
type: 'ModelsUpdateGroupRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/UpdatePatchSingleGroupPublicV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.UpdatePatchSingleGroupPublicV1Op
.Build();
var response = sdk.Group.Group.UpdatePatchSingleGroupPublicV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'patch'
- 'public'
- 'single'
- 'update'
- 'v1'
scopes:
- 'social'
'UpdatePatchSingleGroupPublicV2@cs.group.fun':
id: 'UpdatePatchSingleGroupPublicV2@cs.group.fun'
name: 'UpdatePatchSingleGroupPublicV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP [UPDATE]"
Update existing group. This endpoint supports partial update. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73307
arguments:
'Body':
type: 'ModelsUpdateGroupRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/UpdatePatchSingleGroupPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.Group.UpdatePatchSingleGroupPublicV2Op
.Build();
var response = sdk.Group.Group.UpdatePatchSingleGroupPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'patch'
- 'public'
- 'single'
- 'update'
- 'v2'
scopes:
- 'social'
'UpdatePutSingleGroupPublicV2@cs.group.fun':
id: 'UpdatePutSingleGroupPublicV2@cs.group.fun'
name: 'UpdatePutSingleGroupPublicV2'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP [UPDATE]"
Update existing group. This endpoint supports partial update. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73307
arguments:
'Body':
type: 'ModelsUpdateGroupRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/UpdatePutSingleGroupPublicV2.cs'
example: |-
try
{
var operation = sdk.Group.Group.UpdatePutSingleGroupPublicV2Op
.Build();
var response = sdk.Group.Group.UpdatePutSingleGroupPublicV2(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'public'
- 'put'
- 'single'
- 'update'
- 'v2'
scopes:
- 'social'
'UpdateSingleGroupV1@cs.group.fun':
id: 'UpdateSingleGroupV1@cs.group.fun'
name: 'UpdateSingleGroupV1'
type: 'function'
description: |-
Required valid user authentication
Required Member Role Permission: "GROUP [UPDATE]"
Update existing group. This endpoint supports partial update. This endpoint will check the group ID of the user based on the access token and compare it with the group ID in path parameter. It will also check the member role of the user based on the access token
Action Code: 73307
arguments:
'Body':
type: 'ModelsUpdateGroupRequestV1'
required: true
'GroupId':
type: 'string'
required: true
description: |-
Group ID
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGroupResponseV1'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Group.Model;'
- 'using AccelByte.Sdk.Api.Group.Operation;'
- 'using AccelByte.Sdk.Api.Group.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Wrapper/Group.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Group/Operation/Group/UpdateSingleGroupV1.cs'
example: |-
try
{
var operation = sdk.Group.Group.UpdateSingleGroupV1Op
.Build();
var response = sdk.Group.Group.UpdateSingleGroupV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'group'
- 'single'
- 'update'
- 'v1'
scopes:
- 'social'
# endregion functions