symbols:
# region models
'ApiAddMemberParams@cs.chat.mod':
id: 'ApiAddMemberParams@cs.chat.mod'
name: 'ApiAddMemberParams'
type: 'model'
fields:
'IsAdmin':
type: 'bool'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ApiAddMemberParams.cs'
'ApiCreateNamespaceTopicParams@cs.chat.mod':
id: 'ApiCreateNamespaceTopicParams@cs.chat.mod'
name: 'ApiCreateNamespaceTopicParams'
type: 'model'
fields:
'Description':
type: 'string'
required: true
'Name':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ApiCreateNamespaceTopicParams.cs'
'ApiCreateTopicParams@cs.chat.mod':
id: 'ApiCreateTopicParams@cs.chat.mod'
name: 'ApiCreateTopicParams'
type: 'model'
fields:
'Admins':
type: 'List<string>'
required: true
'Description':
type: 'string'
required: true
'IsChannel':
type: 'bool'
required: true
'IsJoinable':
type: 'bool'
required: true
'Members':
type: 'List<string>'
required: true
'Name':
type: 'string'
required: true
'Type':
type: 'string'
required: true
'ShardLimit':
type: 'int'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ApiCreateTopicParams.cs'
'ApiCreateTopicResponse@cs.chat.mod':
id: 'ApiCreateTopicResponse@cs.chat.mod'
name: 'ApiCreateTopicResponse'
type: 'model'
fields:
'CreatedAt':
type: 'long'
required: true
'CreatedBy':
type: 'string'
required: true
'Description':
type: 'string'
required: true
'IsChannel':
type: 'bool'
required: true
'IsJoinable':
type: 'bool'
required: true
'Name':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'TopicId':
type: 'string'
required: true
'Type':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ApiCreateTopicResponse.cs'
'ApiMutedTopicResponse@cs.chat.mod':
id: 'ApiMutedTopicResponse@cs.chat.mod'
name: 'ApiMutedTopicResponse'
type: 'model'
fields:
'ExpirationTime':
type: 'long'
required: true
'RemainingTime':
type: 'long'
required: true
'TopicId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ApiMutedTopicResponse.cs'
'ApiMuteUserRequest@cs.chat.mod':
id: 'ApiMuteUserRequest@cs.chat.mod'
name: 'ApiMuteUserRequest'
type: 'model'
fields:
'Duration':
type: 'int'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ApiMuteUserRequest.cs'
'ApiSendChatParams@cs.chat.mod':
id: 'ApiSendChatParams@cs.chat.mod'
name: 'ApiSendChatParams'
type: 'model'
fields:
'Message':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ApiSendChatParams.cs'
'ApiUnmuteUserRequest@cs.chat.mod':
id: 'ApiUnmuteUserRequest@cs.chat.mod'
name: 'ApiUnmuteUserRequest'
type: 'model'
fields:
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ApiUnmuteUserRequest.cs'
'ApiUpdateTopicParams@cs.chat.mod':
id: 'ApiUpdateTopicParams@cs.chat.mod'
name: 'ApiUpdateTopicParams'
type: 'model'
fields:
'Description':
type: 'string'
required: true
'IsJoinable':
type: 'bool'
required: true
'Name':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ApiUpdateTopicParams.cs'
'LogAppMessageDeclaration@cs.chat.mod':
id: 'LogAppMessageDeclaration@cs.chat.mod'
name: 'LogAppMessageDeclaration'
type: 'model'
fields:
'Attributes':
type: 'List<string>'
required: true
'Code':
type: 'string'
required: true
'CodeName':
type: 'string'
required: true
'Section':
type: 'string'
required: true
'Service':
type: 'string'
required: true
'Text':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/LogAppMessageDeclaration.cs'
'LogconfigConfiguration@cs.chat.mod':
id: 'LogconfigConfiguration@cs.chat.mod'
name: 'LogconfigConfiguration'
type: 'model'
fields:
'InternalAccessLogEnabled':
type: 'bool'
required: false
'LogLevel':
type: 'string'
required: false
'LogLevelDB':
type: 'string'
required: false
'SlowQueryThreshold':
type: 'long'
required: false
'SocketLogEnabled':
type: 'bool'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/LogconfigConfiguration.cs'
'MessageActionAddUserToTopicResult@cs.chat.mod':
id: 'MessageActionAddUserToTopicResult@cs.chat.mod'
name: 'MessageActionAddUserToTopicResult'
type: 'model'
fields:
'Processed':
type: 'long'
required: true
'TopicId':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/MessageActionAddUserToTopicResult.cs'
'MessageActionDeleteTopicResult@cs.chat.mod':
id: 'MessageActionDeleteTopicResult@cs.chat.mod'
name: 'MessageActionDeleteTopicResult'
type: 'model'
fields:
'Processed':
type: 'long'
required: true
'TopicId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/MessageActionDeleteTopicResult.cs'
'ModelsAddInboxCategoryRequest@cs.chat.mod':
id: 'ModelsAddInboxCategoryRequest@cs.chat.mod'
name: 'ModelsAddInboxCategoryRequest'
type: 'model'
fields:
'Enabled':
type: 'bool'
required: true
'ExpiresIn':
type: 'long'
required: true
'Name':
type: 'string'
required: true
'SaveInbox':
type: 'bool'
required: true
'SendNotification':
type: 'bool'
required: true
'Hook':
type: 'ModelsCategoryHook'
required: false
'JsonSchema':
type: 'Dictionary<string, object>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsAddInboxCategoryRequest.cs'
'ModelsAddInboxCategoryResponse@cs.chat.mod':
id: 'ModelsAddInboxCategoryResponse@cs.chat.mod'
name: 'ModelsAddInboxCategoryResponse'
type: 'model'
fields:
'Enabled':
type: 'bool'
required: true
'ExpiresIn':
type: 'long'
required: true
'Name':
type: 'string'
required: true
'SaveInbox':
type: 'bool'
required: true
'SendNotification':
type: 'bool'
required: true
'Hook':
type: 'ModelsCategoryHook'
required: false
'JsonSchema':
type: 'Dictionary<string, object>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsAddInboxCategoryResponse.cs'
'ModelsBanTopicMemberParam@cs.chat.mod':
id: 'ModelsBanTopicMemberParam@cs.chat.mod'
name: 'ModelsBanTopicMemberParam'
type: 'model'
fields:
'UserIds':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsBanTopicMemberParam.cs'
'ModelsBanTopicMemberResult@cs.chat.mod':
id: 'ModelsBanTopicMemberResult@cs.chat.mod'
name: 'ModelsBanTopicMemberResult'
type: 'model'
fields:
'UserIds':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsBanTopicMemberResult.cs'
'ModelsCategoryHook@cs.chat.mod':
id: 'ModelsCategoryHook@cs.chat.mod'
name: 'ModelsCategoryHook'
type: 'model'
fields:
'Driver':
type: 'string'
required: false
'Params':
type: 'Dictionary<string, object>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsCategoryHook.cs'
'ModelsChannelTopicResponse@cs.chat.mod':
id: 'ModelsChannelTopicResponse@cs.chat.mod'
name: 'ModelsChannelTopicResponse'
type: 'model'
fields:
'CreatedAt':
type: 'long'
required: true
'CreatedBy':
type: 'string'
required: true
'Description':
type: 'string'
required: true
'IsJoinable':
type: 'bool'
required: true
'MessagePerMinutes':
type: 'double'
required: true
'Name':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'ShardLimit':
type: 'int'
required: true
'ShardNumber':
type: 'int'
required: true
'TopicId':
type: 'string'
required: true
'TotalMember':
type: 'int'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsChannelTopicResponse.cs'
'ModelsChannelTopicSummaryResponse@cs.chat.mod':
id: 'ModelsChannelTopicSummaryResponse@cs.chat.mod'
name: 'ModelsChannelTopicSummaryResponse'
type: 'model'
fields:
'TotalChannel':
type: 'int'
required: true
'TotalShard':
type: 'int'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsChannelTopicSummaryResponse.cs'
'ModelsChannelTopicWithPaginationResponse@cs.chat.mod':
id: 'ModelsChannelTopicWithPaginationResponse@cs.chat.mod'
name: 'ModelsChannelTopicWithPaginationResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsChannelTopicResponse>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
'TotalData':
type: 'int'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsChannelTopicWithPaginationResponse.cs'
'ModelsChatMessageResponse@cs.chat.mod':
id: 'ModelsChatMessageResponse@cs.chat.mod'
name: 'ModelsChatMessageResponse'
type: 'model'
fields:
'From':
type: 'string'
required: true
'Id':
type: 'string'
required: true
'Message':
type: 'string'
required: true
'TopicId':
type: 'string'
required: true
'ReadAt':
type: 'long'
required: false
'ReceivedAt':
type: 'long'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsChatMessageResponse.cs'
'ModelsChatMessageWithPaginationResponse@cs.chat.mod':
id: 'ModelsChatMessageWithPaginationResponse@cs.chat.mod'
name: 'ModelsChatMessageWithPaginationResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsChatMessageResponse>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
'TotalData':
type: 'int'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsChatMessageWithPaginationResponse.cs'
'ModelsChatSnapshotMessage@cs.chat.mod':
id: 'ModelsChatSnapshotMessage@cs.chat.mod'
name: 'ModelsChatSnapshotMessage'
type: 'model'
fields:
'ChatId':
type: 'string'
required: true
'CreatedAt':
type: 'long'
required: true
'Message':
type: 'string'
required: true
'SenderId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsChatSnapshotMessage.cs'
'ModelsChatSnapshots@cs.chat.mod':
id: 'ModelsChatSnapshots@cs.chat.mod'
name: 'ModelsChatSnapshots'
type: 'model'
fields:
'ChatId':
type: 'string'
required: true
'CreatedAt':
type: 'long'
required: true
'JoinedTopics':
type: 'List<string>'
required: true
'Messages':
type: 'List<ModelsChatSnapshotMessage>'
required: true
'Namespace':
type: 'string'
required: true
'SenderId':
type: 'string'
required: true
'TicketId':
type: 'string'
required: true
'TopicId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsChatSnapshots.cs'
'ModelsConfig@cs.chat.mod':
id: 'ModelsConfig@cs.chat.mod'
name: 'ModelsConfig'
type: 'model'
fields:
'ChatRateLimitBurst':
type: 'int'
required: true
'ChatRateLimitDuration':
type: 'long'
required: true
'ConcurrentUsersLimit':
type: 'int'
required: true
'EnableProfanityFilter':
type: 'bool'
required: true
'FilterAppName':
type: 'string'
required: true
'FilterParam':
type: 'string'
required: true
'FilterType':
type: 'string'
required: true
'GeneralRateLimitBurst':
type: 'int'
required: true
'GeneralRateLimitDuration':
type: 'long'
required: true
'Namespace':
type: 'string'
required: true
'ShardCapacityLimit':
type: 'int'
required: true
'ShardDefaultLimit':
type: 'int'
required: true
'ShardHardLimit':
type: 'int'
required: true
'SpamChatBurst':
type: 'int'
required: true
'SpamChatDuration':
type: 'long'
required: true
'SpamMuteDuration':
type: 'long'
required: true
'DefaultDictionaryLoaded':
type: 'bool'
required: false
'EnableClanChat':
type: 'bool'
required: false
'EnableManualTopicCreation':
type: 'bool'
required: false
'EnablePmSendPlatformId':
type: 'bool'
required: false
'MaxChatMessageLength':
type: 'int'
required: false
'UseDefaultDictionary':
type: 'bool'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsConfig.cs'
'ModelsConfigExport@cs.chat.mod':
id: 'ModelsConfigExport@cs.chat.mod'
name: 'ModelsConfigExport'
type: 'model'
fields:
'ChatRateLimitBurst':
type: 'int'
required: true
'ChatRateLimitDuration':
type: 'long'
required: true
'ConcurrentUsersLimit':
type: 'int'
required: true
'GeneralRateLimitBurst':
type: 'int'
required: true
'GeneralRateLimitDuration':
type: 'long'
required: true
'Namespace':
type: 'string'
required: true
'EnableClanChat':
type: 'bool'
required: false
'EnableManualTopicCreation':
type: 'bool'
required: false
'EnablePmSendPlatformId':
type: 'bool'
required: false
'EnableProfanityFilter':
type: 'bool'
required: false
'FilterAppName':
type: 'string'
required: false
'FilterParam':
type: 'string'
required: false
'FilterType':
type: 'string'
required: false
'ShardCapacityLimit':
type: 'int'
required: false
'ShardDefaultLimit':
type: 'int'
required: false
'ShardHardLimit':
type: 'int'
required: false
'SpamChatBurst':
type: 'int'
required: false
'SpamChatDuration':
type: 'long'
required: false
'SpamMuteDuration':
type: 'long'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsConfigExport.cs'
'ModelsConfigList@cs.chat.mod':
id: 'ModelsConfigList@cs.chat.mod'
name: 'ModelsConfigList'
type: 'model'
fields:
'Configs':
type: 'List<ModelsConfig>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsConfigList.cs'
'ModelsConfigResponse@cs.chat.mod':
id: 'ModelsConfigResponse@cs.chat.mod'
name: 'ModelsConfigResponse'
type: 'model'
fields:
'ChatRateLimitBurst':
type: 'int'
required: false
'ChatRateLimitDuration':
type: 'long'
required: false
'ConcurrentUsersLimit':
type: 'int'
required: false
'EnableClanChat':
type: 'bool'
required: false
'EnableManualTopicCreation':
type: 'bool'
required: false
'EnablePmSendPlatformId':
type: 'bool'
required: false
'EnableProfanityFilter':
type: 'bool'
required: false
'FilterAppName':
type: 'string'
required: false
'FilterParam':
type: 'string'
required: false
'FilterType':
type: 'string'
required: false
'GeneralRateLimitBurst':
type: 'int'
required: false
'GeneralRateLimitDuration':
type: 'long'
required: false
'MaxChatMessageLength':
type: 'int'
required: false
'ShardCapacityLimit':
type: 'int'
required: false
'ShardDefaultLimit':
type: 'int'
required: false
'ShardHardLimit':
type: 'int'
required: false
'SpamChatBurst':
type: 'int'
required: false
'SpamChatDuration':
type: 'long'
required: false
'SpamMuteDuration':
type: 'long'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsConfigResponse.cs'
'ModelsDictionary@cs.chat.mod':
id: 'ModelsDictionary@cs.chat.mod'
name: 'ModelsDictionary'
type: 'model'
fields:
'Id':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'Word':
type: 'string'
required: true
'WordType':
type: 'string'
required: true
'ParentId':
type: 'string'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionary.cs'
'ModelsDictionaryChild@cs.chat.mod':
id: 'ModelsDictionaryChild@cs.chat.mod'
name: 'ModelsDictionaryChild'
type: 'model'
fields:
'Id':
type: 'string'
required: true
'Word':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionaryChild.cs'
'ModelsDictionaryExport@cs.chat.mod':
id: 'ModelsDictionaryExport@cs.chat.mod'
name: 'ModelsDictionaryExport'
type: 'model'
fields:
'Dictionaries':
type: 'List<ModelsDictionaryExportItem>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionaryExport.cs'
'ModelsDictionaryExportItem@cs.chat.mod':
id: 'ModelsDictionaryExportItem@cs.chat.mod'
name: 'ModelsDictionaryExportItem'
type: 'model'
fields:
'Word':
type: 'string'
required: true
'FalseNegative':
type: 'List<string>'
required: false
'FalsePositive':
type: 'List<string>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionaryExportItem.cs'
'ModelsDictionaryGroup@cs.chat.mod':
id: 'ModelsDictionaryGroup@cs.chat.mod'
name: 'ModelsDictionaryGroup'
type: 'model'
fields:
'Count':
type: 'int'
required: true
'Name':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionaryGroup.cs'
'ModelsDictionaryImportResult@cs.chat.mod':
id: 'ModelsDictionaryImportResult@cs.chat.mod'
name: 'ModelsDictionaryImportResult'
type: 'model'
fields:
'Words':
type: 'ModelsDictionaryWordChanges'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionaryImportResult.cs'
'ModelsDictionaryInsertBulkRequest@cs.chat.mod':
id: 'ModelsDictionaryInsertBulkRequest@cs.chat.mod'
name: 'ModelsDictionaryInsertBulkRequest'
type: 'model'
fields:
'Dictionaries':
type: 'List<ModelsDictionaryInsertRequest>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionaryInsertBulkRequest.cs'
'ModelsDictionaryInsertRequest@cs.chat.mod':
id: 'ModelsDictionaryInsertRequest@cs.chat.mod'
name: 'ModelsDictionaryInsertRequest'
type: 'model'
fields:
'FalseNegative':
type: 'List<string>'
required: true
'FalsePositive':
type: 'List<string>'
required: true
'Word':
type: 'string'
required: true
'WordType':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionaryInsertRequest.cs'
'ModelsDictionaryQueryResult@cs.chat.mod':
id: 'ModelsDictionaryQueryResult@cs.chat.mod'
name: 'ModelsDictionaryQueryResult'
type: 'model'
fields:
'Data':
type: 'List<ModelsDictionaryWithChildren>'
required: true
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionaryQueryResult.cs'
'ModelsDictionaryUpdateRequest@cs.chat.mod':
id: 'ModelsDictionaryUpdateRequest@cs.chat.mod'
name: 'ModelsDictionaryUpdateRequest'
type: 'model'
fields:
'FalseNegative':
type: 'List<string>'
required: true
'FalsePositive':
type: 'List<string>'
required: true
'Word':
type: 'string'
required: true
'WordType':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionaryUpdateRequest.cs'
'ModelsDictionaryWithChildren@cs.chat.mod':
id: 'ModelsDictionaryWithChildren@cs.chat.mod'
name: 'ModelsDictionaryWithChildren'
type: 'model'
fields:
'Id':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'Word':
type: 'string'
required: true
'WordType':
type: 'string'
required: true
'FalseNegatives':
type: 'List<ModelsDictionaryChild>'
required: false
'FalsePositives':
type: 'List<ModelsDictionaryChild>'
required: false
'ParentId':
type: 'string'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionaryWithChildren.cs'
'ModelsDictionaryWordChanges@cs.chat.mod':
id: 'ModelsDictionaryWordChanges@cs.chat.mod'
name: 'ModelsDictionaryWordChanges'
type: 'model'
fields:
'Added':
type: 'List<string>'
required: true
'Failed':
type: 'List<string>'
required: true
'Ignored':
type: 'List<string>'
required: true
'Replaced':
type: 'List<string>'
required: true
'Unchanged':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsDictionaryWordChanges.cs'
'ModelsGetInboxCategoriesResponseItem@cs.chat.mod':
id: 'ModelsGetInboxCategoriesResponseItem@cs.chat.mod'
name: 'ModelsGetInboxCategoriesResponseItem'
type: 'model'
fields:
'Enabled':
type: 'bool'
required: true
'ExpiresIn':
type: 'long'
required: true
'Name':
type: 'string'
required: true
'SaveInbox':
type: 'bool'
required: true
'SendNotification':
type: 'bool'
required: true
'Hook':
type: 'ModelsCategoryHook'
required: false
'JsonSchema':
type: 'Dictionary<string, object>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsGetInboxCategoriesResponseItem.cs'
'ModelsGetInboxMessagesResponse@cs.chat.mod':
id: 'ModelsGetInboxMessagesResponse@cs.chat.mod'
name: 'ModelsGetInboxMessagesResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsGetInboxMessagesResponseData>'
required: true
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsGetInboxMessagesResponse.cs'
'ModelsGetInboxMessagesResponseData@cs.chat.mod':
id: 'ModelsGetInboxMessagesResponseData@cs.chat.mod'
name: 'ModelsGetInboxMessagesResponseData'
type: 'model'
fields:
'CreatedAt':
type: 'long'
required: true
'ExpiredAt':
type: 'long'
required: true
'Id':
type: 'string'
required: true
'Scope':
type: 'string'
required: true
'SenderId':
type: 'string'
required: true
'Status':
type: 'string'
required: true
'UpdatedAt':
type: 'long'
required: true
'Category':
type: 'string'
required: false
'Message':
type: 'Dictionary<string, object>'
required: false
'UserIds':
type: 'List<string>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsGetInboxMessagesResponseData.cs'
'ModelsGetInboxStatsResponse@cs.chat.mod':
id: 'ModelsGetInboxStatsResponse@cs.chat.mod'
name: 'ModelsGetInboxStatsResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsMessageStats>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsGetInboxStatsResponse.cs'
'ModelsGetInboxUsersResponse@cs.chat.mod':
id: 'ModelsGetInboxUsersResponse@cs.chat.mod'
name: 'ModelsGetInboxUsersResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsUserInbox>'
required: true
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsGetInboxUsersResponse.cs'
'ModelsGetListTopicKafkaResponse@cs.chat.mod':
id: 'ModelsGetListTopicKafkaResponse@cs.chat.mod'
name: 'ModelsGetListTopicKafkaResponse'
type: 'model'
fields:
'TopicName':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsGetListTopicKafkaResponse.cs'
'ModelsImportConfigResponse@cs.chat.mod':
id: 'ModelsImportConfigResponse@cs.chat.mod'
name: 'ModelsImportConfigResponse'
type: 'model'
fields:
'FailedConfigs':
type: 'List<string>'
required: true
'IgnoredConfigs':
type: 'List<string>'
required: true
'NewConfigs':
type: 'List<string>'
required: true
'ReplacedConfigs':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsImportConfigResponse.cs'
'ModelsJSONSchemaType@cs.chat.mod':
id: 'ModelsJSONSchemaType@cs.chat.mod'
name: 'ModelsJSONSchemaType'
type: 'model'
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsJSONSchemaType.cs'
'ModelsMessageRequest@cs.chat.mod':
id: 'ModelsMessageRequest@cs.chat.mod'
name: 'ModelsMessageRequest'
type: 'model'
fields:
'Message':
type: 'string'
required: true
'Timestamp':
type: 'long'
required: false
'TopicId':
type: 'string'
required: false
'TopicType':
type: 'string'
required: false
'UserId':
type: 'string'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsMessageRequest.cs'
'ModelsMessageResultWithAttributes@cs.chat.mod':
id: 'ModelsMessageResultWithAttributes@cs.chat.mod'
name: 'ModelsMessageResultWithAttributes'
type: 'model'
fields:
'Action':
type: 'string'
required: true
'FinalMessage':
type: 'string'
required: true
'Id':
type: 'string'
required: true
'Timestamp':
type: 'long'
required: true
'Attributes':
type: 'Dictionary<string, object>'
required: false
'CencoredWords':
type: 'List<string>'
required: false
'Classifications':
type: 'List<string>'
required: false
'ReferenceId':
type: 'string'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsMessageResultWithAttributes.cs'
'ModelsMessageStats@cs.chat.mod':
id: 'ModelsMessageStats@cs.chat.mod'
name: 'ModelsMessageStats'
type: 'model'
fields:
'Id':
type: 'string'
required: true
'MessageRead':
type: 'int'
required: true
'MessageStored':
type: 'int'
required: true
'NotificationSent':
type: 'int'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsMessageStats.cs'
'ModelsPagination@cs.chat.mod':
id: 'ModelsPagination@cs.chat.mod'
name: 'ModelsPagination'
type: 'model'
fields:
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsPagination.cs'
'ModelsPublicBanTopicMembersRequest@cs.chat.mod':
id: 'ModelsPublicBanTopicMembersRequest@cs.chat.mod'
name: 'ModelsPublicBanTopicMembersRequest'
type: 'model'
fields:
'UserIDs':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsPublicBanTopicMembersRequest.cs'
'ModelsPublicBanTopicMembersResponse@cs.chat.mod':
id: 'ModelsPublicBanTopicMembersResponse@cs.chat.mod'
name: 'ModelsPublicBanTopicMembersResponse'
type: 'model'
fields:
'UserIDs':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsPublicBanTopicMembersResponse.cs'
'ModelsPublicConfigResponse@cs.chat.mod':
id: 'ModelsPublicConfigResponse@cs.chat.mod'
name: 'ModelsPublicConfigResponse'
type: 'model'
fields:
'ChatRateLimitBurst':
type: 'int'
required: true
'ChatRateLimitDuration':
type: 'long'
required: true
'GeneralRateLimitBurst':
type: 'int'
required: true
'GeneralRateLimitDuration':
type: 'long'
required: true
'MaxChatMessageLength':
type: 'int'
required: true
'SpamChatBurst':
type: 'int'
required: true
'SpamChatDuration':
type: 'long'
required: true
'SpamMuteDuration':
type: 'long'
required: true
'EnablePmSendPlatformId':
type: 'bool'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsPublicConfigResponse.cs'
'ModelsPublicUnbanTopicMembersRequest@cs.chat.mod':
id: 'ModelsPublicUnbanTopicMembersRequest@cs.chat.mod'
name: 'ModelsPublicUnbanTopicMembersRequest'
type: 'model'
fields:
'UserIDs':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsPublicUnbanTopicMembersRequest.cs'
'ModelsPublicUnbanTopicMembersResponse@cs.chat.mod':
id: 'ModelsPublicUnbanTopicMembersResponse@cs.chat.mod'
name: 'ModelsPublicUnbanTopicMembersResponse'
type: 'model'
fields:
'UserIDs':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsPublicUnbanTopicMembersResponse.cs'
'ModelsSaveInboxMessageRequest@cs.chat.mod':
id: 'ModelsSaveInboxMessageRequest@cs.chat.mod'
name: 'ModelsSaveInboxMessageRequest'
type: 'model'
fields:
'ExpiredAt':
type: 'long'
required: true
'Message':
type: 'Dictionary<string, object>'
required: true
'Scope':
type: 'string'
required: true
'Status':
type: 'string'
required: true
'UserIds':
type: 'List<string>'
required: true
'Category':
type: 'string'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsSaveInboxMessageRequest.cs'
'ModelsSaveInboxMessageResponse@cs.chat.mod':
id: 'ModelsSaveInboxMessageResponse@cs.chat.mod'
name: 'ModelsSaveInboxMessageResponse'
type: 'model'
fields:
'ExpiredAt':
type: 'long'
required: true
'Id':
type: 'string'
required: true
'Scope':
type: 'string'
required: true
'Status':
type: 'string'
required: true
'Category':
type: 'string'
required: false
'Message':
type: 'Dictionary<string, object>'
required: false
'UserIDs':
type: 'List<string>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsSaveInboxMessageResponse.cs'
'ModelsSendInboxMessageRequest@cs.chat.mod':
id: 'ModelsSendInboxMessageRequest@cs.chat.mod'
name: 'ModelsSendInboxMessageRequest'
type: 'model'
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsSendInboxMessageRequest.cs'
'ModelsSendInboxMessageResponse@cs.chat.mod':
id: 'ModelsSendInboxMessageResponse@cs.chat.mod'
name: 'ModelsSendInboxMessageResponse'
type: 'model'
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsSendInboxMessageResponse.cs'
'ModelsTopicInfo@cs.chat.mod':
id: 'ModelsTopicInfo@cs.chat.mod'
name: 'ModelsTopicInfo'
type: 'model'
fields:
'CreatedAt':
type: 'long'
required: true
'Id':
type: 'string'
required: true
'Name':
type: 'string'
required: true
'SubType':
type: 'string'
required: true
'Type':
type: 'string'
required: true
'DeletedAt':
type: 'long'
required: false
'Members':
type: 'List<TopicInfoMember>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsTopicInfo.cs'
'ModelsTopicLogItem@cs.chat.mod':
id: 'ModelsTopicLogItem@cs.chat.mod'
name: 'ModelsTopicLogItem'
type: 'model'
fields:
'CreatedAt':
type: 'long'
required: true
'Id':
type: 'string'
required: true
'Message':
type: 'string'
required: true
'SenderId':
type: 'string'
required: true
'TopicId':
type: 'string'
required: true
'Type':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsTopicLogItem.cs'
'ModelsTopicLogWithPaginationResponse@cs.chat.mod':
id: 'ModelsTopicLogWithPaginationResponse@cs.chat.mod'
name: 'ModelsTopicLogWithPaginationResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsTopicLogItem>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsTopicLogWithPaginationResponse.cs'
'ModelsTopicMemberResponse@cs.chat.mod':
id: 'ModelsTopicMemberResponse@cs.chat.mod'
name: 'ModelsTopicMemberResponse'
type: 'model'
fields:
'IsAdmin':
type: 'bool'
required: true
'IsBanned':
type: 'bool'
required: true
'ShardId':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsTopicMemberResponse.cs'
'ModelsTopicMemberWithPaginationResponse@cs.chat.mod':
id: 'ModelsTopicMemberWithPaginationResponse@cs.chat.mod'
name: 'ModelsTopicMemberWithPaginationResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsTopicMemberResponse>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
'TotalData':
type: 'int'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsTopicMemberWithPaginationResponse.cs'
'ModelsTopicResponse@cs.chat.mod':
id: 'ModelsTopicResponse@cs.chat.mod'
name: 'ModelsTopicResponse'
type: 'model'
fields:
'CreatedAt':
type: 'long'
required: true
'CreatedBy':
type: 'string'
required: true
'LastMessageAt':
type: 'long'
required: true
'Name':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'TopicId':
type: 'string'
required: true
'Type':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsTopicResponse.cs'
'ModelsUnbanTopicMemberParam@cs.chat.mod':
id: 'ModelsUnbanTopicMemberParam@cs.chat.mod'
name: 'ModelsUnbanTopicMemberParam'
type: 'model'
fields:
'UserIds':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsUnbanTopicMemberParam.cs'
'ModelsUnbanTopicMemberResult@cs.chat.mod':
id: 'ModelsUnbanTopicMemberResult@cs.chat.mod'
name: 'ModelsUnbanTopicMemberResult'
type: 'model'
fields:
'UserIds':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsUnbanTopicMemberResult.cs'
'ModelsUnsendInboxMessageRequest@cs.chat.mod':
id: 'ModelsUnsendInboxMessageRequest@cs.chat.mod'
name: 'ModelsUnsendInboxMessageRequest'
type: 'model'
fields:
'UserIds':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsUnsendInboxMessageRequest.cs'
'ModelsUnsendInboxMessageResponse@cs.chat.mod':
id: 'ModelsUnsendInboxMessageResponse@cs.chat.mod'
name: 'ModelsUnsendInboxMessageResponse'
type: 'model'
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsUnsendInboxMessageResponse.cs'
'ModelsUpdateInboxCategoryRequest@cs.chat.mod':
id: 'ModelsUpdateInboxCategoryRequest@cs.chat.mod'
name: 'ModelsUpdateInboxCategoryRequest'
type: 'model'
fields:
'Enabled':
type: 'bool'
required: true
'ExpiresIn':
type: 'long'
required: true
'Hook':
type: 'ModelsCategoryHook'
required: true
'SaveInbox':
type: 'bool'
required: true
'SendNotification':
type: 'bool'
required: true
'JsonSchema':
type: 'Dictionary<string, object>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsUpdateInboxCategoryRequest.cs'
'ModelsUpdateInboxMessageRequest@cs.chat.mod':
id: 'ModelsUpdateInboxMessageRequest@cs.chat.mod'
name: 'ModelsUpdateInboxMessageRequest'
type: 'model'
fields:
'ExpiredAt':
type: 'long'
required: true
'Message':
type: 'Dictionary<string, object>'
required: true
'Scope':
type: 'string'
required: true
'UserIds':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsUpdateInboxMessageRequest.cs'
'ModelsUserInbox@cs.chat.mod':
id: 'ModelsUserInbox@cs.chat.mod'
name: 'ModelsUserInbox'
type: 'model'
fields:
'Keep':
type: 'bool'
required: true
'ReadAt':
type: 'long'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ModelsUserInbox.cs'
'ResponseError@cs.chat.mod':
id: 'ResponseError@cs.chat.mod'
name: 'ResponseError'
type: 'model'
fields:
'ErrorCode':
type: 'int'
required: true
'ErrorMessage':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/ResponseError.cs'
'RestapiErrorResponseBody@cs.chat.mod':
id: 'RestapiErrorResponseBody@cs.chat.mod'
name: 'RestapiErrorResponseBody'
type: 'model'
fields:
'ErrorCode':
type: 'int'
required: true
'ErrorMessage':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/RestapiErrorResponseBody.cs'
'TopicInfoMember@cs.chat.mod':
id: 'TopicInfoMember@cs.chat.mod'
name: 'TopicInfoMember'
type: 'model'
fields:
'UserId':
type: 'string'
required: true
'LeftAt':
type: 'long'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Model/TopicInfoMember.cs'
# endregion models
# region functions
'AdminAddInboxCategory@cs.chat.fun':
id: 'AdminAddInboxCategory@cs.chat.fun'
name: 'AdminAddInboxCategory'
type: 'function'
description: |-
Add inbox category.
arguments:
'Body':
type: 'ModelsAddInboxCategoryRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsAddInboxCategoryResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminAddInboxCategory.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminAddInboxCategoryOp
.Build();
var response = sdk.Chat.Inbox.AdminAddInboxCategory(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'add'
- 'admin'
- 'category'
- 'inbox'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [CREATE]'
'AdminAddTopicMember@cs.chat.fun':
id: 'AdminAddTopicMember@cs.chat.fun'
name: 'AdminAddTopicMember'
type: 'function'
description: |-
Add new member for topic in a namespace.
arguments:
'Body':
type: 'ApiAddMemberParams'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that will added user to
'UserId':
type: 'string'
required: true
description: |-
user ID that will be added to topic
return_type: 'MessageActionAddUserToTopicResult'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminAddTopicMember.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminAddTopicMemberOp
.Build();
var response = sdk.Chat.Topic.AdminAddTopicMember(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'add'
- 'admin'
- 'member'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'AdminBanTopicMembers@cs.chat.fun':
id: 'AdminBanTopicMembers@cs.chat.fun'
name: 'AdminBanTopicMembers'
type: 'function'
description: |-
Ban users in some topic. banned user not assigned to shard for channel topic, and cannot send and query chat.
arguments:
'Body':
type: 'ModelsBanTopicMemberParam'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
return_type: 'ModelsBanTopicMemberResult'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminBanTopicMembers.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminBanTopicMembersOp
.Build();
var response = sdk.Chat.Topic.AdminBanTopicMembers(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'ban'
- 'members'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'AdminChannelTopicInfo@cs.chat.fun':
id: 'AdminChannelTopicInfo@cs.chat.fun'
name: 'AdminChannelTopicInfo'
type: 'function'
description: |-
Get chat list of topic in a namespace.
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
return_type: 'ModelsChannelTopicResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminChannelTopicInfo.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminChannelTopicInfoOp
.Build();
var response = sdk.Chat.Topic.AdminChannelTopicInfo(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'channel'
- 'info'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminChannelTopicList@cs.chat.fun':
id: 'AdminChannelTopicList@cs.chat.fun'
name: 'AdminChannelTopicList'
type: 'function'
description: |-
Get channel chat list of topic in a namespace.
arguments:
'Limit':
type: 'long'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'TopicName':
type: 'string'
required: false
description: |-
name
return_type: 'ModelsChannelTopicWithPaginationResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminChannelTopicList.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminChannelTopicListOp
.SetLimit(...)
.SetOffset(...)
.SetTopicName(...)
.Build(
namespace_,
);
var response = sdk.Chat.Topic.AdminChannelTopicList(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'channel'
- 'list'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminChannelTopicSummary@cs.chat.fun':
id: 'AdminChannelTopicSummary@cs.chat.fun'
name: 'AdminChannelTopicSummary'
type: 'function'
description: |-
Get chat list of topic in a namespace.
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsChannelTopicSummaryResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminChannelTopicSummary.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminChannelTopicSummaryOp
.Build();
var response = sdk.Chat.Topic.AdminChannelTopicSummary(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'channel'
- 'summary'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminChatHistory@cs.chat.fun':
id: 'AdminChatHistory@cs.chat.fun'
name: 'AdminChatHistory'
type: 'function'
description: |-
Get chat history in a namespace.
arguments:
'ChatId':
type: 'List<string>'
required: false
description: |-
chat ID of chat
'EndCreatedAt':
type: 'long'
required: false
description: |-
end date
'Keyword':
type: 'string'
required: false
description: |-
keyword containing in message
'Limit':
type: 'long'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'Order':
type: 'string'
required: false
description: |-
anyof: createdAt:asc / createdAt:desc
'SenderUserId':
type: 'string'
required: false
description: |-
sender user ID
'ShardId':
type: 'string'
required: false
description: |-
shard id
'StartCreatedAt':
type: 'long'
required: false
description: |-
start date
'Topic':
type: 'List<string>'
required: false
description: |-
topic ID that receive the chat
'Unfiltered':
type: 'bool'
required: false
description: |-
unfiltered chat messages
return_type: 'ModelsChatMessageWithPaginationResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminChatHistory.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminChatHistoryOp
.SetChatId(...)
.SetEndCreatedAt(...)
.SetKeyword(...)
.SetLimit(...)
.SetOffset(...)
.SetOrder(...)
.SetSenderUserId(...)
.SetShardId(...)
.SetStartCreatedAt(...)
.SetTopic(...)
.SetUnfiltered(...)
.Build(
namespace_,
);
var response = sdk.Chat.Topic.AdminChatHistory(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'chat'
- 'history'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminCreateNamespaceTopic@cs.chat.fun':
id: 'AdminCreateNamespaceTopic@cs.chat.fun'
name: 'AdminCreateNamespaceTopic'
type: 'function'
description: |-
Create new namespace group topic in a namespace.
arguments:
'Body':
type: 'ApiCreateNamespaceTopicParams'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ApiCreateTopicResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminCreateNamespaceTopic.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminCreateNamespaceTopicOp
.Build();
var response = sdk.Chat.Topic.AdminCreateNamespaceTopic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'create'
- 'namespace'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [CREATE]'
'AdminCreateTopic@cs.chat.fun':
id: 'AdminCreateTopic@cs.chat.fun'
name: 'AdminCreateTopic'
type: 'function'
description: |-
Create new group topic in a namespace.
arguments:
'Body':
type: 'ApiCreateTopicParams'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ApiCreateTopicResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminCreateTopic.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminCreateTopicOp
.Build();
var response = sdk.Chat.Topic.AdminCreateTopic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'create'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [CREATE]'
'AdminDeleteChat@cs.chat.fun':
id: 'AdminDeleteChat@cs.chat.fun'
name: 'AdminDeleteChat'
type: 'function'
description: |-
Delete chat.
arguments:
'ChatId':
type: 'string'
required: true
description: |-
chat ID od the chat
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID of the chat
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminDeleteChat.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminDeleteChatOp
.Build();
sdk.Chat.Topic.AdminDeleteChat(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'chat'
- 'delete'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [DELETE]'
'AdminDeleteChatSnapshot@cs.chat.fun':
id: 'AdminDeleteChatSnapshot@cs.chat.fun'
name: 'AdminDeleteChatSnapshot'
type: 'function'
description: |-
Delete the chat snapshot
arguments:
'ChatId':
type: 'string'
required: true
description: |-
id of the chat
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Moderation.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Moderation/AdminDeleteChatSnapshot.cs'
example: |-
try
{
var operation = sdk.Chat.Moderation.AdminDeleteChatSnapshotOp
.Build();
sdk.Chat.Moderation.AdminDeleteChatSnapshot(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'chat'
- 'delete'
- 'moderation'
- 'snapshot'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [DELETE]'
'AdminDeleteInboxCategory@cs.chat.fun':
id: 'AdminDeleteInboxCategory@cs.chat.fun'
name: 'AdminDeleteInboxCategory'
type: 'function'
description: |-
Delete inbox category
arguments:
'Category':
type: 'string'
required: true
description: |-
category
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminDeleteInboxCategory.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminDeleteInboxCategoryOp
.Build();
sdk.Chat.Inbox.AdminDeleteInboxCategory(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'category'
- 'delete'
- 'inbox'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [DELETE]'
'AdminDeleteInboxMessage@cs.chat.fun':
id: 'AdminDeleteInboxMessage@cs.chat.fun'
name: 'AdminDeleteInboxMessage'
type: 'function'
description: |-
Delete inbox message
arguments:
'Force':
type: 'bool'
required: false
description: |-
only for testing purposes, to force delete data
'MessageId':
type: 'string'
required: true
description: |-
message
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminDeleteInboxMessage.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminDeleteInboxMessageOp
.SetForce(...)
.Build(
messageId,
namespace_,
);
sdk.Chat.Inbox.AdminDeleteInboxMessage(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'inbox'
- 'message'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [DELETE]'
'AdminDeleteTopic@cs.chat.fun':
id: 'AdminDeleteTopic@cs.chat.fun'
name: 'AdminDeleteTopic'
type: 'function'
description: |-
Delete topic in a namespace.
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
return_type: 'MessageActionDeleteTopicResult'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminDeleteTopic.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminDeleteTopicOp
.Build();
var response = sdk.Chat.Topic.AdminDeleteTopic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [DELETE]'
'AdminFilterChatMessage@cs.chat.fun':
id: 'AdminFilterChatMessage@cs.chat.fun'
name: 'AdminFilterChatMessage'
type: 'function'
description: |-
For testing purpose, doesn't send any message to the topic. Always do filter regardless of enableProfanityFilter configuration.
arguments:
'Body':
type: 'ModelsMessageRequest'
required: true
'Detail':
type: 'bool'
required: false
description: |-
To show what filter driver is used
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsMessageResultWithAttributes'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminFilterChatMessage.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminFilterChatMessageOp
.SetDetail(...)
.Build(
body,
namespace_,
);
var response = sdk.Chat.Topic.AdminFilterChatMessage(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'chat'
- 'filter'
- 'message'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminGetAllConfigV1@cs.chat.fun':
id: 'AdminGetAllConfigV1@cs.chat.fun'
name: 'AdminGetAllConfigV1'
type: 'function'
description: |-
Get chat config of all namespaces.
return_type: 'ModelsConfigList'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Config.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Config/AdminGetAllConfigV1.cs'
example: |-
try
{
var operation = sdk.Chat.Config.AdminGetAllConfigV1Op
.Build();
var response = sdk.Chat.Config.AdminGetAllConfigV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'all'
- 'config'
- 'get'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:*:CHAT:CONFIG [READ]'
'AdminGetCategorySchema@cs.chat.fun':
id: 'AdminGetCategorySchema@cs.chat.fun'
name: 'AdminGetCategorySchema'
type: 'function'
description: |-
Get category schema.
arguments:
'Category':
type: 'string'
required: true
description: |-
category
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsJSONSchemaType'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminGetCategorySchema.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminGetCategorySchemaOp
.Build();
var response = sdk.Chat.Inbox.AdminGetCategorySchema(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'category'
- 'get'
- 'inbox'
- 'schema'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [READ]'
'AdminGetChatSnapshot@cs.chat.fun':
id: 'AdminGetChatSnapshot@cs.chat.fun'
name: 'AdminGetChatSnapshot'
type: 'function'
description: |-
Get the chat snapshot
arguments:
'ChatId':
type: 'string'
required: true
description: |-
id of the chat
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsChatSnapshots'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Moderation.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Moderation/AdminGetChatSnapshot.cs'
example: |-
try
{
var operation = sdk.Chat.Moderation.AdminGetChatSnapshotOp
.Build();
var response = sdk.Chat.Moderation.AdminGetChatSnapshot(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'chat'
- 'get'
- 'moderation'
- 'snapshot'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminGetConfigV1@cs.chat.fun':
id: 'AdminGetConfigV1@cs.chat.fun'
name: 'AdminGetConfigV1'
type: 'function'
description: |-
Get chat config of a namespace.
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsConfigResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Config.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Config/AdminGetConfigV1.cs'
example: |-
try
{
var operation = sdk.Chat.Config.AdminGetConfigV1Op
.Build();
var response = sdk.Chat.Config.AdminGetConfigV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'config'
- 'get'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [READ]'
'AdminGetInboxCategories@cs.chat.fun':
id: 'AdminGetInboxCategories@cs.chat.fun'
name: 'AdminGetInboxCategories'
type: 'function'
description: |-
Get inbox categories
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'List<ModelsGetInboxCategoriesResponseItem>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminGetInboxCategories.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminGetInboxCategoriesOp
.Build();
var response = sdk.Chat.Inbox.AdminGetInboxCategories(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'categories'
- 'get'
- 'inbox'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [READ]'
'AdminGetInboxMessages@cs.chat.fun':
id: 'AdminGetInboxMessages@cs.chat.fun'
name: 'AdminGetInboxMessages'
type: 'function'
description: |-
Get inbox messages
arguments:
'ActiveOnly':
type: 'bool'
required: false
description: |-
active only
'EndCreatedAt':
type: 'long'
required: false
description: |-
end created at
'Limit':
type: 'long'
required: false
description: |-
limit
'MessageId':
type: 'List<string>'
required: false
description: |-
message ids
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'Order':
type: 'string'
required: false
description: |-
anyof: createdAt:asc / createdAt:desc
'Scope':
type: 'string'
required: false
description: |-
message scope
'StartCreatedAt':
type: 'long'
required: false
description: |-
start created at
'Status':
type: 'string'
required: false
description: |-
message status
'Transient':
type: 'bool'
required: false
description: |-
transient message filter
return_type: 'ModelsGetInboxMessagesResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminGetInboxMessages.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminGetInboxMessagesOp
.SetActiveOnly(...)
.SetEndCreatedAt(...)
.SetLimit(...)
.SetMessageId(...)
.SetOffset(...)
.SetOrder(...)
.SetScope(...)
.SetStartCreatedAt(...)
.SetStatus(...)
.SetTransient(...)
.Build(
namespace_,
);
var response = sdk.Chat.Inbox.AdminGetInboxMessages(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'inbox'
- 'messages'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [READ]'
'AdminGetInboxStats@cs.chat.fun':
id: 'AdminGetInboxStats@cs.chat.fun'
name: 'AdminGetInboxStats'
type: 'function'
description: |-
Get inbox stats
arguments:
'MessageId':
type: 'List<string>'
required: false
description: |-
message ids
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGetInboxStatsResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminGetInboxStats.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminGetInboxStatsOp
.SetMessageId(...)
.Build(
namespace_,
);
var response = sdk.Chat.Inbox.AdminGetInboxStats(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'inbox'
- 'stats'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [READ]'
'AdminGetInboxUsers@cs.chat.fun':
id: 'AdminGetInboxUsers@cs.chat.fun'
name: 'AdminGetInboxUsers'
type: 'function'
description: |-
Get inbox users
arguments:
'Inbox':
type: 'string'
required: true
description: |-
message id
'Limit':
type: 'long'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'Status':
type: 'string'
required: false
description: |-
message status
'UserId':
type: 'string'
required: false
description: |-
userId
return_type: 'ModelsGetInboxUsersResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminGetInboxUsers.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminGetInboxUsersOp
.SetLimit(...)
.SetOffset(...)
.SetStatus(...)
.SetUserId(...)
.Build(
inbox,
namespace_,
);
var response = sdk.Chat.Inbox.AdminGetInboxUsers(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'inbox'
- 'users'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [READ]'
'AdminGetLogConfig@cs.chat.fun':
id: 'AdminGetLogConfig@cs.chat.fun'
name: 'AdminGetLogConfig'
type: 'function'
description: |-
Get Log Configuration
logLevel use for logging in service, the value can use is trace|debug|info|warning|error|fatal|panic
socketLogEnabled is use for enable socket log
internalAccessLogEnabled is for enabling access log for internal endpoint
logLevelDB use for logging in DB, the value can use is trace|debug|info|warning|error|fatal|panic
slowQueryThreshold use for logging slow threshold in time measure is nano second
return_type: 'LogconfigConfiguration'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Config.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Config/AdminGetLogConfig.cs'
example: |-
try
{
var operation = sdk.Chat.Config.AdminGetLogConfigOp
.Build();
var response = sdk.Chat.Config.AdminGetLogConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'config'
- 'get'
- 'log'
permissions:
- 'ADMIN:CONFIG:LOG [READ]'
'AdminListKafkaTopic@cs.chat.fun':
id: 'AdminListKafkaTopic@cs.chat.fun'
name: 'AdminListKafkaTopic'
type: 'function'
description: |-
Get list kafka topic. example result chat,sessionNotification
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsGetListTopicKafkaResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminListKafkaTopic.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminListKafkaTopicOp
.Build();
var response = sdk.Chat.Inbox.AdminListKafkaTopic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'inbox'
- 'kafka'
- 'list'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [READ]'
'AdminPatchUpdateLogConfig@cs.chat.fun':
id: 'AdminPatchUpdateLogConfig@cs.chat.fun'
name: 'AdminPatchUpdateLogConfig'
type: 'function'
description: |-
Update Log Configuration
logLevel use for logging in service, the value can use is trace|debug|info|warning|error|fatal|panic
socketLogEnabled is use for enable socket log
internalAccessLogEnabled is for enabling access log for internal endpoint
logLevelDB use for logging in DB, the value can use is trace|debug|info|warning|error|fatal|panic
slowQueryThreshold use for logging slow threshold in time measure is nano second
arguments:
'Body':
type: 'LogconfigConfiguration'
required: true
return_type: 'LogconfigConfiguration'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Config.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Config/AdminPatchUpdateLogConfig.cs'
example: |-
try
{
var operation = sdk.Chat.Config.AdminPatchUpdateLogConfigOp
.Build();
var response = sdk.Chat.Config.AdminPatchUpdateLogConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'config'
- 'log'
- 'patch'
- 'update'
permissions:
- 'ADMIN:CONFIG:LOG [UPDATE]'
'AdminProfanityCreate@cs.chat.fun':
id: 'AdminProfanityCreate@cs.chat.fun'
name: 'AdminProfanityCreate'
type: 'function'
description: |-
Insert new word for profanity censor
arguments:
'Body':
type: 'ModelsDictionaryInsertRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsDictionary'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Profanity.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Profanity/AdminProfanityCreate.cs'
example: |-
try
{
var operation = sdk.Chat.Profanity.AdminProfanityCreateOp
.Build();
var response = sdk.Chat.Profanity.AdminProfanityCreate(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'create'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [CREATE]'
'AdminProfanityCreateBulk@cs.chat.fun':
id: 'AdminProfanityCreateBulk@cs.chat.fun'
name: 'AdminProfanityCreateBulk'
type: 'function'
description: |-
Bulk insert new word for profanity censor
arguments:
'Body':
type: 'ModelsDictionaryInsertBulkRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Profanity.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Profanity/AdminProfanityCreateBulk.cs'
example: |-
try
{
var operation = sdk.Chat.Profanity.AdminProfanityCreateBulkOp
.Build();
sdk.Chat.Profanity.AdminProfanityCreateBulk(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'bulk'
- 'create'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [CREATE]'
'AdminProfanityDelete@cs.chat.fun':
id: 'AdminProfanityDelete@cs.chat.fun'
name: 'AdminProfanityDelete'
type: 'function'
description: |-
Delete profanity words.
arguments:
'Id':
type: 'string'
required: true
description: |-
id of the dictionary
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Profanity.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Profanity/AdminProfanityDelete.cs'
example: |-
try
{
var operation = sdk.Chat.Profanity.AdminProfanityDeleteOp
.Build();
sdk.Chat.Profanity.AdminProfanityDelete(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [DELETE]'
'AdminProfanityExport@cs.chat.fun':
id: 'AdminProfanityExport@cs.chat.fun'
name: 'AdminProfanityExport'
type: 'function'
description: |-
Export profanity words
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsDictionaryExport'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Profanity.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Profanity/AdminProfanityExport.cs'
example: |-
try
{
var operation = sdk.Chat.Profanity.AdminProfanityExportOp
.Build();
var response = sdk.Chat.Profanity.AdminProfanityExport(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'export'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]'
'AdminProfanityGroup@cs.chat.fun':
id: 'AdminProfanityGroup@cs.chat.fun'
name: 'AdminProfanityGroup'
type: 'function'
description: |-
Get profanity words group.
arguments:
'Limit':
type: 'long'
required: false
description: |-
default: 100
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
return_type: 'List<ModelsDictionaryGroup>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Profanity.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Profanity/AdminProfanityGroup.cs'
example: |-
try
{
var operation = sdk.Chat.Profanity.AdminProfanityGroupOp
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Chat.Profanity.AdminProfanityGroup(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'group'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]'
'AdminProfanityImport@cs.chat.fun':
id: 'AdminProfanityImport@cs.chat.fun'
name: 'AdminProfanityImport'
type: 'function'
description: |-
Import profanity words
arguments:
'Action':
type: 'string'
required: false
description: |-
The action when same words already exists</br>
<b>REPLACE</b>: replace all same words with imported false positives and false negatives, existing non-imported words won't be removed</br>
<b>FULLREPLACE</b>: replace all words with imported data and remove existing non-imported words, list words will be exactly same with imported data</br>
<b>LEAVEOUT</b>: ignore imported same words, false positives and false negatives won't be replaced with imported data'
'File':
type: 'Stream'
required: true
description: |-
file to be imported
'Namespace':
type: 'string'
required: true
description: |-
namespace
'ShowResult':
type: 'bool'
required: false
description: |-
When showResult=true, this endpoint with returns imported words result
return_type: 'ModelsDictionaryImportResult'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Profanity.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Profanity/AdminProfanityImport.cs'
example: |-
try
{
var operation = sdk.Chat.Profanity.AdminProfanityImportOp
.SetAction(...)
.SetShowResult(...)
.Build(
file,
namespace_,
);
var response = sdk.Chat.Profanity.AdminProfanityImport(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'import'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [CREATE]'
'AdminProfanityQuery@cs.chat.fun':
id: 'AdminProfanityQuery@cs.chat.fun'
name: 'AdminProfanityQuery'
type: 'function'
description: |-
Query all profanity words.
arguments:
'FilterMask':
type: 'string'
required: false
description: |-
filter mask
'IncludeChildren':
type: 'bool'
required: false
description: |-
include false positives and false negatives
'Limit':
type: 'long'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'ParentId':
type: 'string'
required: false
description: |-
parent ID of the word
'StartWith':
type: 'string'
required: false
description: |-
word start with
'WordType':
type: 'string'
required: false
description: |-
type of the word: PROFANITY, FALSEPOSITIVE, FALSENEGATIVE
return_type: 'ModelsDictionaryQueryResult'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Profanity.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Profanity/AdminProfanityQuery.cs'
example: |-
try
{
var operation = sdk.Chat.Profanity.AdminProfanityQueryOp
.SetFilterMask(...)
.SetIncludeChildren(...)
.SetLimit(...)
.SetOffset(...)
.SetParentId(...)
.SetStartWith(...)
.SetWordType(...)
.Build(
namespace_,
);
var response = sdk.Chat.Profanity.AdminProfanityQuery(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'profanity'
- 'query'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]'
'AdminProfanityUpdate@cs.chat.fun':
id: 'AdminProfanityUpdate@cs.chat.fun'
name: 'AdminProfanityUpdate'
type: 'function'
description: |-
Update profanity word
arguments:
'Body':
type: 'ModelsDictionaryUpdateRequest'
required: true
'Id':
type: 'string'
required: true
description: |-
id of the dictionary
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsDictionary'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Profanity.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Profanity/AdminProfanityUpdate.cs'
example: |-
try
{
var operation = sdk.Chat.Profanity.AdminProfanityUpdateOp
.Build();
var response = sdk.Chat.Profanity.AdminProfanityUpdate(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'profanity'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [UPDATE]'
'AdminQueryTopic@cs.chat.fun':
id: 'AdminQueryTopic@cs.chat.fun'
name: 'AdminQueryTopic'
type: 'function'
description: |-
Get topics in a namespace.
arguments:
'IncludeMembers':
type: 'bool'
required: false
description: |-
include topic's members
'IncludePastMembers':
type: 'bool'
required: false
description: |-
include past members (user that had left topic)
'IncludePastTopics':
type: 'bool'
required: false
description: |-
include topic that has been removed.<br/><b>NOTE:</b> only soft deleted topics are available
'Limit':
type: 'long'
required: false
description: |-
default: 100
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'Topic':
type: 'List<string>'
required: false
description: |-
topic
'TopicSubType':
type: 'string'
required: false
description: |-
topicSubType
'TopicType':
type: 'string'
required: false
description: |-
topicType
'UserId':
type: 'string'
required: false
description: |-
userId
return_type: 'List<ModelsTopicInfo>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminQueryTopic.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminQueryTopicOp
.SetIncludeMembers(...)
.SetIncludePastMembers(...)
.SetIncludePastTopics(...)
.SetLimit(...)
.SetOffset(...)
.SetTopic(...)
.SetTopicSubType(...)
.SetTopicType(...)
.SetUserId(...)
.Build(
namespace_,
);
var response = sdk.Chat.Topic.AdminQueryTopic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'query'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminQueryTopicLog@cs.chat.fun':
id: 'AdminQueryTopicLog@cs.chat.fun'
name: 'AdminQueryTopicLog'
type: 'function'
description: |-
Get chat log of topic in a namespace.
arguments:
'EndCreatedAt':
type: 'long'
required: false
description: |-
end date
'Limit':
type: 'long'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'SenderUserId':
type: 'string'
required: false
description: |-
senderUserId (actor, can be admin or the user itself)
'StartCreatedAt':
type: 'long'
required: false
description: |-
start date
'TopicId':
type: 'string'
required: false
description: |-
topicId
'TopicIds':
type: 'List<string>'
required: false
description: |-
topicIds
'UserId':
type: 'string'
required: false
description: |-
userId
return_type: 'ModelsTopicLogWithPaginationResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminQueryTopicLog.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminQueryTopicLogOp
.SetEndCreatedAt(...)
.SetLimit(...)
.SetOffset(...)
.SetSenderUserId(...)
.SetStartCreatedAt(...)
.SetTopicId(...)
.SetTopicIds(...)
.SetUserId(...)
.Build(
namespace_,
);
var response = sdk.Chat.Topic.AdminQueryTopicLog(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'log'
- 'query'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminQueryUsersTopic@cs.chat.fun':
id: 'AdminQueryUsersTopic@cs.chat.fun'
name: 'AdminQueryUsersTopic'
type: 'function'
description: |-
Get user's topics in a namespace.
arguments:
'IncludePastTopics':
type: 'bool'
required: false
description: |-
when true will include topics that user already left
'Limit':
type: 'long'
required: false
description: |-
default: 100
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'TopicSubType':
type: 'string'
required: false
description: |-
topicSubType
'TopicType':
type: 'string'
required: false
description: |-
topicType
'UserId':
type: 'string'
required: true
description: |-
userId
return_type: 'ModelsTopicLogWithPaginationResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminQueryUsersTopic.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminQueryUsersTopicOp
.SetIncludePastTopics(...)
.SetLimit(...)
.SetOffset(...)
.SetTopicSubType(...)
.SetTopicType(...)
.Build(
namespace_,
userId,
);
var response = sdk.Chat.Topic.AdminQueryUsersTopic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'query'
- 'topic'
- 'users'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminRemoveTopicMember@cs.chat.fun':
id: 'AdminRemoveTopicMember@cs.chat.fun'
name: 'AdminRemoveTopicMember'
type: 'function'
description: |-
Remove member from topic in a namespace.
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that will removed user from
'UserId':
type: 'string'
required: true
description: |-
user ID that will be removed from topic
return_type: 'MessageActionAddUserToTopicResult'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminRemoveTopicMember.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminRemoveTopicMemberOp
.Build();
var response = sdk.Chat.Topic.AdminRemoveTopicMember(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'member'
- 'remove'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'AdminSaveInboxMessage@cs.chat.fun':
id: 'AdminSaveInboxMessage@cs.chat.fun'
name: 'AdminSaveInboxMessage'
type: 'function'
description: |-
Save inbox message
arguments:
'Body':
type: 'ModelsSaveInboxMessageRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsSaveInboxMessageResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminSaveInboxMessage.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminSaveInboxMessageOp
.Build();
var response = sdk.Chat.Inbox.AdminSaveInboxMessage(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'inbox'
- 'message'
- 'save'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [CREATE]'
'AdminSendChat@cs.chat.fun':
id: 'AdminSendChat@cs.chat.fun'
name: 'AdminSendChat'
type: 'function'
description: |-
Send message to chat topic as system.
arguments:
'Body':
type: 'ApiSendChatParams'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
return_type: 'List<ModelsChatMessageResponse>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminSendChat.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminSendChatOp
.Build();
var response = sdk.Chat.Topic.AdminSendChat(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'chat'
- 'send'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'AdminSendInboxMessage@cs.chat.fun':
id: 'AdminSendInboxMessage@cs.chat.fun'
name: 'AdminSendInboxMessage'
type: 'function'
description: |-
Send inbox message
arguments:
'Body':
type: 'ModelsSendInboxMessageRequest'
required: true
'MessageId':
type: 'string'
required: true
description: |-
message
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsSendInboxMessageResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminSendInboxMessage.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminSendInboxMessageOp
.Build();
var response = sdk.Chat.Inbox.AdminSendInboxMessage(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'inbox'
- 'message'
- 'send'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [UPDATE]'
'AdminTopicChatHistory@cs.chat.fun':
id: 'AdminTopicChatHistory@cs.chat.fun'
name: 'AdminTopicChatHistory'
type: 'function'
description: |-
Get chat history in a namespace.
arguments:
'EndCreatedAt':
type: 'long'
required: false
description: |-
end date
'Keyword':
type: 'string'
required: false
description: |-
keyword containing in message
'Limit':
type: 'long'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'Order':
type: 'string'
required: false
description: |-
anyof: createdAt:asc / createdAt:desc
'SenderUserId':
type: 'string'
required: false
description: |-
sender user ID
'ShardId':
type: 'string'
required: false
description: |-
shard id
'StartCreatedAt':
type: 'long'
required: false
description: |-
start date
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
'Unfiltered':
type: 'bool'
required: false
description: |-
unfiltered chat messages
return_type: 'ModelsChatMessageWithPaginationResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminTopicChatHistory.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminTopicChatHistoryOp
.SetEndCreatedAt(...)
.SetKeyword(...)
.SetLimit(...)
.SetOffset(...)
.SetOrder(...)
.SetSenderUserId(...)
.SetShardId(...)
.SetStartCreatedAt(...)
.SetUnfiltered(...)
.Build(
namespace_,
topic,
);
var response = sdk.Chat.Topic.AdminTopicChatHistory(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'chat'
- 'history'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminTopicList@cs.chat.fun':
id: 'AdminTopicList@cs.chat.fun'
name: 'AdminTopicList'
type: 'function'
description: |-
Get chat list of topic in a namespace.
arguments:
'Limit':
type: 'long'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'TopicType':
type: 'string'
required: false
description: |-
PERSONAL or GROUP
return_type: 'List<ModelsTopicResponse>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminTopicList.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminTopicListOp
.SetLimit(...)
.SetOffset(...)
.SetTopicType(...)
.Build(
namespace_,
);
var response = sdk.Chat.Topic.AdminTopicList(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'list'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminTopicMembers@cs.chat.fun':
id: 'AdminTopicMembers@cs.chat.fun'
name: 'AdminTopicMembers'
type: 'function'
description: |-
Get topic members.
arguments:
'IsBanned':
type: 'bool'
required: false
description: |-
only show banned member
'IsModerator':
type: 'bool'
required: false
description: |-
only show moderator member
'Limit':
type: 'long'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'ShardId':
type: 'string'
required: false
description: |-
shard ID
'Topic':
type: 'string'
required: true
description: |-
topic ID
return_type: 'ModelsTopicMemberWithPaginationResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminTopicMembers.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminTopicMembersOp
.SetIsBanned(...)
.SetIsModerator(...)
.SetLimit(...)
.SetOffset(...)
.SetShardId(...)
.Build(
namespace_,
topic,
);
var response = sdk.Chat.Topic.AdminTopicMembers(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'members'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminTopicShards@cs.chat.fun':
id: 'AdminTopicShards@cs.chat.fun'
name: 'AdminTopicShards'
type: 'function'
description: |-
Get shard list from topic.
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
return_type: 'List<string>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminTopicShards.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminTopicShardsOp
.Build();
var response = sdk.Chat.Topic.AdminTopicShards(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'shards'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminUnbanTopicMembers@cs.chat.fun':
id: 'AdminUnbanTopicMembers@cs.chat.fun'
name: 'AdminUnbanTopicMembers'
type: 'function'
description: |-
Unban users in some topic.
arguments:
'Body':
type: 'ModelsUnbanTopicMemberParam'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
return_type: 'ModelsUnbanTopicMemberResult'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminUnbanTopicMembers.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminUnbanTopicMembersOp
.Build();
var response = sdk.Chat.Topic.AdminUnbanTopicMembers(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'members'
- 'topic'
- 'unban'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'AdminUnsendInboxMessage@cs.chat.fun':
id: 'AdminUnsendInboxMessage@cs.chat.fun'
name: 'AdminUnsendInboxMessage'
type: 'function'
description: |-
Unsend inbox message
arguments:
'Body':
type: 'ModelsUnsendInboxMessageRequest'
required: true
'Inbox':
type: 'string'
required: true
description: |-
message
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsUnsendInboxMessageResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminUnsendInboxMessage.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminUnsendInboxMessageOp
.Build();
var response = sdk.Chat.Inbox.AdminUnsendInboxMessage(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'inbox'
- 'message'
- 'unsend'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [UPDATE]'
'AdminUpdateConfigV1@cs.chat.fun':
id: 'AdminUpdateConfigV1@cs.chat.fun'
name: 'AdminUpdateConfigV1'
type: 'function'
description: |-
Update chat config of a namespace.
arguments:
'Body':
type: 'ModelsConfigResponse'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsConfigResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Config.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Config/AdminUpdateConfigV1.cs'
example: |-
try
{
var operation = sdk.Chat.Config.AdminUpdateConfigV1Op
.Build();
var response = sdk.Chat.Config.AdminUpdateConfigV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'config'
- 'update'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [UPDATE]'
'AdminUpdateInboxCategory@cs.chat.fun':
id: 'AdminUpdateInboxCategory@cs.chat.fun'
name: 'AdminUpdateInboxCategory'
type: 'function'
description: |-
Update inbox category
arguments:
'Body':
type: 'ModelsUpdateInboxCategoryRequest'
required: true
'Category':
type: 'string'
required: true
description: |-
category
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminUpdateInboxCategory.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminUpdateInboxCategoryOp
.Build();
sdk.Chat.Inbox.AdminUpdateInboxCategory(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'category'
- 'inbox'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [UPDATE]'
'AdminUpdateInboxMessage@cs.chat.fun':
id: 'AdminUpdateInboxMessage@cs.chat.fun'
name: 'AdminUpdateInboxMessage'
type: 'function'
description: |-
Update inbox message
arguments:
'Body':
type: 'ModelsUpdateInboxMessageRequest'
required: true
'MessageId':
type: 'string'
required: true
description: |-
message
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Inbox.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Inbox/AdminUpdateInboxMessage.cs'
example: |-
try
{
var operation = sdk.Chat.Inbox.AdminUpdateInboxMessageOp
.Build();
sdk.Chat.Inbox.AdminUpdateInboxMessage(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'inbox'
- 'message'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [UPDATE]'
'AdminUpdateTopic@cs.chat.fun':
id: 'AdminUpdateTopic@cs.chat.fun'
name: 'AdminUpdateTopic'
type: 'function'
description: |-
Update group topic in a namespace.
arguments:
'Body':
type: 'ApiUpdateTopicParams'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
return_type: 'ApiCreateTopicResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/AdminUpdateTopic.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.AdminUpdateTopicOp
.Build();
var response = sdk.Chat.Topic.AdminUpdateTopic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'topic'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'ExportConfig@cs.chat.fun':
id: 'ExportConfig@cs.chat.fun'
name: 'ExportConfig'
type: 'function'
description: |-
Export chat configuration to a json file. The file can then be imported from the /import endpoint.
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'List<ModelsConfigExport>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Config.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Config/ExportConfig.cs'
example: |-
try
{
var operation = sdk.Chat.Config.ExportConfigOp
.Build();
var response = sdk.Chat.Config.ExportConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'config'
- 'export'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [READ]'
'ImportConfig@cs.chat.fun':
id: 'ImportConfig@cs.chat.fun'
name: 'ImportConfig'
type: 'function'
description: |-
Import config configuration from file. The existing configuration will be replaced.
The json file to import can be obtained from the /export endpoint.
arguments:
'File':
type: 'Stream'
required: false
description: |-
file to be imported
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsImportConfigResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Config.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Config/ImportConfig.cs'
example: |-
try
{
var operation = sdk.Chat.Config.ImportConfigOp
.SetFile(...)
.Build(
namespace_,
);
var response = sdk.Chat.Config.ImportConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'config'
- 'import'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [UPDATE]'
'PublicBanTopicMembers@cs.chat.fun':
id: 'PublicBanTopicMembers@cs.chat.fun'
name: 'PublicBanTopicMembers'
type: 'function'
description: |-
Ban topic members in a group topic.
arguments:
'Body':
type: 'ModelsPublicBanTopicMembersRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
return_type: 'ModelsPublicBanTopicMembersResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/PublicBanTopicMembers.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.PublicBanTopicMembersOp
.Build();
var response = sdk.Chat.Topic.PublicBanTopicMembers(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'ban'
- 'members'
- 'public'
- 'topic'
'PublicChatHistory@cs.chat.fun':
id: 'PublicChatHistory@cs.chat.fun'
name: 'PublicChatHistory'
type: 'function'
description: |-
get chat history in a namespace.
arguments:
'Limit':
type: 'long'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Order':
type: 'string'
required: false
description: |-
anyof: createdAt:asc / createdAt:desc
'StartCreatedAt':
type: 'long'
required: false
description: |-
lastChatCreatedAt
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
return_type: 'List<ModelsChatMessageResponse>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/PublicChatHistory.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.PublicChatHistoryOp
.SetLimit(...)
.SetOrder(...)
.SetStartCreatedAt(...)
.Build(
namespace_,
topic,
);
var response = sdk.Chat.Topic.PublicChatHistory(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'chat'
- 'history'
- 'public'
- 'topic'
'PublicDeleteChat@cs.chat.fun':
id: 'PublicDeleteChat@cs.chat.fun'
name: 'PublicDeleteChat'
type: 'function'
description: |-
Delete chat.
arguments:
'ChatId':
type: 'string'
required: true
description: |-
chat ID od the chat
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID of the chat
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/PublicDeleteChat.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.PublicDeleteChatOp
.Build();
sdk.Chat.Topic.PublicDeleteChat(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'chat'
- 'delete'
- 'public'
- 'topic'
'PublicGetChatSnapshot@cs.chat.fun':
id: 'PublicGetChatSnapshot@cs.chat.fun'
name: 'PublicGetChatSnapshot'
type: 'function'
description: |-
Get the chat snapshot
arguments:
'ChatId':
type: 'string'
required: true
description: |-
id of the chat
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic
return_type: 'ModelsChatSnapshots'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Moderation.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Moderation/PublicGetChatSnapshot.cs'
example: |-
try
{
var operation = sdk.Chat.Moderation.PublicGetChatSnapshotOp
.Build();
var response = sdk.Chat.Moderation.PublicGetChatSnapshot(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'chat'
- 'get'
- 'moderation'
- 'public'
- 'snapshot'
'PublicGetConfigV1@cs.chat.fun':
id: 'PublicGetConfigV1@cs.chat.fun'
name: 'PublicGetConfigV1'
type: 'function'
description: |-
Get chat config of a namespace.
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'ModelsPublicConfigResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Config.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Config/PublicGetConfigV1.cs'
example: |-
try
{
var operation = sdk.Chat.Config.PublicGetConfigV1Op
.Build();
var response = sdk.Chat.Config.PublicGetConfigV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'config'
- 'get'
- 'public'
- 'v1'
'PublicGetMessages@cs.chat.fun':
id: 'PublicGetMessages@cs.chat.fun'
name: 'PublicGetMessages'
type: 'function'
description: |-
get the list of messages.
return_type: 'List<LogAppMessageDeclaration>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Operations.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Operations/PublicGetMessages.cs'
example: |-
try
{
var operation = sdk.Chat.Operations.PublicGetMessagesOp
.Build();
var response = sdk.Chat.Operations.PublicGetMessages(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'messages'
- 'public'
'PublicGetMutedTopics@cs.chat.fun':
id: 'PublicGetMutedTopics@cs.chat.fun'
name: 'PublicGetMutedTopics'
type: 'function'
description: |-
get chat muted topics in a namespace.
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace
return_type: 'List<ApiMutedTopicResponse>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/PublicGetMutedTopics.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.PublicGetMutedTopicsOp
.Build();
var response = sdk.Chat.Topic.PublicGetMutedTopics(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'muted'
- 'public'
- 'topic'
- 'topics'
'PublicMuteUser@cs.chat.fun':
id: 'PublicMuteUser@cs.chat.fun'
name: 'PublicMuteUser'
type: 'function'
description: |-
Mute user.
arguments:
'Body':
type: 'ApiMuteUserRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/PublicMuteUser.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.PublicMuteUserOp
.Build();
sdk.Chat.Topic.PublicMuteUser(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'mute'
- 'public'
- 'topic'
- 'user'
'PublicTopicList@cs.chat.fun':
id: 'PublicTopicList@cs.chat.fun'
name: 'PublicTopicList'
type: 'function'
description: |-
get chat list of topic in a namespace.
arguments:
'Limit':
type: 'long'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'long'
required: false
description: |-
offset
'TopicType':
type: 'string'
required: false
description: |-
PERSONAL or GROUP
return_type: 'List<ModelsChatMessageResponse>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/PublicTopicList.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.PublicTopicListOp
.SetLimit(...)
.SetOffset(...)
.SetTopicType(...)
.Build(
namespace_,
);
var response = sdk.Chat.Topic.PublicTopicList(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'list'
- 'public'
- 'topic'
'PublicUnbanTopicMembers@cs.chat.fun':
id: 'PublicUnbanTopicMembers@cs.chat.fun'
name: 'PublicUnbanTopicMembers'
type: 'function'
description: |-
Unban topic members in a group topic.
arguments:
'Body':
type: 'ModelsPublicUnbanTopicMembersRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
return_type: 'ModelsPublicUnbanTopicMembersResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/PublicUnbanTopicMembers.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.PublicUnbanTopicMembersOp
.Build();
var response = sdk.Chat.Topic.PublicUnbanTopicMembers(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'members'
- 'public'
- 'topic'
- 'unban'
'PublicUnmuteUser@cs.chat.fun':
id: 'PublicUnmuteUser@cs.chat.fun'
name: 'PublicUnmuteUser'
type: 'function'
description: |-
Unmute user.
arguments:
'Body':
type: 'ApiUnmuteUserRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Chat.Model;'
- 'using AccelByte.Sdk.Api.Chat.Operation;'
- 'using AccelByte.Sdk.Api.Chat.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Wrapper/Topic.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Chat/Operation/Topic/PublicUnmuteUser.cs'
example: |-
try
{
var operation = sdk.Chat.Topic.PublicUnmuteUserOp
.Build();
sdk.Chat.Topic.PublicUnmuteUser(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'public'
- 'topic'
- 'unmute'
- 'user'
# endregion functions
