symbols:
# region models
'ApiAddMemberParams@jv.chat.mod':
id: 'ApiAddMemberParams@jv.chat.mod'
name: 'ApiAddMemberParams'
type: 'model'
fields:
'isAdmin':
type: 'Boolean'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ApiAddMemberParams.java'
'ApiCreateNamespaceTopicParams@jv.chat.mod':
id: 'ApiCreateNamespaceTopicParams@jv.chat.mod'
name: 'ApiCreateNamespaceTopicParams'
type: 'model'
fields:
'description':
type: 'String'
required: true
'name':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ApiCreateNamespaceTopicParams.java'
'ApiCreateTopicParams@jv.chat.mod':
id: 'ApiCreateTopicParams@jv.chat.mod'
name: 'ApiCreateTopicParams'
type: 'model'
fields:
'admins':
type: 'List<String>'
required: true
'description':
type: 'String'
required: true
'isChannel':
type: 'Boolean'
required: true
'isJoinable':
type: 'Boolean'
required: true
'members':
type: 'List<String>'
required: true
'name':
type: 'String'
required: true
'type':
type: 'String'
required: true
'shardLimit':
type: 'Integer'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ApiCreateTopicParams.java'
'ApiCreateTopicResponse@jv.chat.mod':
id: 'ApiCreateTopicResponse@jv.chat.mod'
name: 'ApiCreateTopicResponse'
type: 'model'
fields:
'createdAt':
type: 'Long'
required: true
'createdBy':
type: 'String'
required: true
'description':
type: 'String'
required: true
'isChannel':
type: 'Boolean'
required: true
'isJoinable':
type: 'Boolean'
required: true
'name':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'topicId':
type: 'String'
required: true
'type':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ApiCreateTopicResponse.java'
'ApiMutedTopicResponse@jv.chat.mod':
id: 'ApiMutedTopicResponse@jv.chat.mod'
name: 'ApiMutedTopicResponse'
type: 'model'
fields:
'expirationTime':
type: 'Long'
required: true
'remainingTime':
type: 'Long'
required: true
'topicId':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ApiMutedTopicResponse.java'
'ApiMuteUserRequest@jv.chat.mod':
id: 'ApiMuteUserRequest@jv.chat.mod'
name: 'ApiMuteUserRequest'
type: 'model'
fields:
'duration':
type: 'Integer'
required: true
'userId':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ApiMuteUserRequest.java'
'ApiSendChatParams@jv.chat.mod':
id: 'ApiSendChatParams@jv.chat.mod'
name: 'ApiSendChatParams'
type: 'model'
fields:
'message':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ApiSendChatParams.java'
'ApiUnmuteUserRequest@jv.chat.mod':
id: 'ApiUnmuteUserRequest@jv.chat.mod'
name: 'ApiUnmuteUserRequest'
type: 'model'
fields:
'userId':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ApiUnmuteUserRequest.java'
'ApiUpdateTopicParams@jv.chat.mod':
id: 'ApiUpdateTopicParams@jv.chat.mod'
name: 'ApiUpdateTopicParams'
type: 'model'
fields:
'description':
type: 'String'
required: true
'isJoinable':
type: 'Boolean'
required: true
'name':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ApiUpdateTopicParams.java'
'LogAppMessageDeclaration@jv.chat.mod':
id: 'LogAppMessageDeclaration@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/LogAppMessageDeclaration.java'
'LogconfigConfiguration@jv.chat.mod':
id: 'LogconfigConfiguration@jv.chat.mod'
name: 'LogconfigConfiguration'
type: 'model'
fields:
'internalAccessLogEnabled':
type: 'Boolean'
required: false
'logLevel':
type: 'String'
required: false
'logLevelDB':
type: 'String'
required: false
'slowQueryThreshold':
type: 'Long'
required: false
'socketLogEnabled':
type: 'Boolean'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/LogconfigConfiguration.java'
'MessageActionAddUserToTopicResult@jv.chat.mod':
id: 'MessageActionAddUserToTopicResult@jv.chat.mod'
name: 'MessageActionAddUserToTopicResult'
type: 'model'
fields:
'processed':
type: 'Long'
required: true
'topicId':
type: 'String'
required: true
'userId':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/MessageActionAddUserToTopicResult.java'
'MessageActionDeleteTopicResult@jv.chat.mod':
id: 'MessageActionDeleteTopicResult@jv.chat.mod'
name: 'MessageActionDeleteTopicResult'
type: 'model'
fields:
'processed':
type: 'Long'
required: true
'topicId':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/MessageActionDeleteTopicResult.java'
'ModelsAddInboxCategoryRequest@jv.chat.mod':
id: 'ModelsAddInboxCategoryRequest@jv.chat.mod'
name: 'ModelsAddInboxCategoryRequest'
type: 'model'
fields:
'enabled':
type: 'Boolean'
required: true
'expiresIn':
type: 'Long'
required: true
'name':
type: 'String'
required: true
'saveInbox':
type: 'Boolean'
required: true
'sendNotification':
type: 'Boolean'
required: true
'hook':
type: 'ModelsCategoryHook'
required: false
'jsonSchema':
type: 'Map<String, ?>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsAddInboxCategoryRequest.java'
'ModelsAddInboxCategoryResponse@jv.chat.mod':
id: 'ModelsAddInboxCategoryResponse@jv.chat.mod'
name: 'ModelsAddInboxCategoryResponse'
type: 'model'
fields:
'enabled':
type: 'Boolean'
required: true
'expiresIn':
type: 'Long'
required: true
'name':
type: 'String'
required: true
'saveInbox':
type: 'Boolean'
required: true
'sendNotification':
type: 'Boolean'
required: true
'hook':
type: 'ModelsCategoryHook'
required: false
'jsonSchema':
type: 'Map<String, ?>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsAddInboxCategoryResponse.java'
'ModelsBanTopicMemberParam@jv.chat.mod':
id: 'ModelsBanTopicMemberParam@jv.chat.mod'
name: 'ModelsBanTopicMemberParam'
type: 'model'
fields:
'userIds':
type: 'List<String>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsBanTopicMemberParam.java'
'ModelsBanTopicMemberResult@jv.chat.mod':
id: 'ModelsBanTopicMemberResult@jv.chat.mod'
name: 'ModelsBanTopicMemberResult'
type: 'model'
fields:
'userIds':
type: 'List<String>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsBanTopicMemberResult.java'
'ModelsCategoryHook@jv.chat.mod':
id: 'ModelsCategoryHook@jv.chat.mod'
name: 'ModelsCategoryHook'
type: 'model'
fields:
'driver':
type: 'String'
required: false
'params':
type: 'Map<String, ?>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsCategoryHook.java'
'ModelsChannelTopicResponse@jv.chat.mod':
id: 'ModelsChannelTopicResponse@jv.chat.mod'
name: 'ModelsChannelTopicResponse'
type: 'model'
fields:
'createdAt':
type: 'Long'
required: true
'createdBy':
type: 'String'
required: true
'description':
type: 'String'
required: true
'isJoinable':
type: 'Boolean'
required: true
'messagePerMinutes':
type: 'Float'
required: true
'name':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'shardLimit':
type: 'Integer'
required: true
'shardNumber':
type: 'Integer'
required: true
'topicId':
type: 'String'
required: true
'totalMember':
type: 'Integer'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsChannelTopicResponse.java'
'ModelsChannelTopicSummaryResponse@jv.chat.mod':
id: 'ModelsChannelTopicSummaryResponse@jv.chat.mod'
name: 'ModelsChannelTopicSummaryResponse'
type: 'model'
fields:
'totalChannel':
type: 'Integer'
required: true
'totalShard':
type: 'Integer'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsChannelTopicSummaryResponse.java'
'ModelsChannelTopicWithPaginationResponse@jv.chat.mod':
id: 'ModelsChannelTopicWithPaginationResponse@jv.chat.mod'
name: 'ModelsChannelTopicWithPaginationResponse'
type: 'model'
fields:
'data':
type: 'List<ModelsChannelTopicResponse>'
required: true
'paging':
type: 'ModelsPagination'
required: true
'totalData':
type: 'Integer'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsChannelTopicWithPaginationResponse.java'
'ModelsChatMessageResponse@jv.chat.mod':
id: 'ModelsChatMessageResponse@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsChatMessageResponse.java'
'ModelsChatMessageWithPaginationResponse@jv.chat.mod':
id: 'ModelsChatMessageWithPaginationResponse@jv.chat.mod'
name: 'ModelsChatMessageWithPaginationResponse'
type: 'model'
fields:
'data':
type: 'List<ModelsChatMessageResponse>'
required: true
'paging':
type: 'ModelsPagination'
required: true
'totalData':
type: 'Integer'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsChatMessageWithPaginationResponse.java'
'ModelsChatSnapshotMessage@jv.chat.mod':
id: 'ModelsChatSnapshotMessage@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsChatSnapshotMessage.java'
'ModelsChatSnapshots@jv.chat.mod':
id: 'ModelsChatSnapshots@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsChatSnapshots.java'
'ModelsConfig@jv.chat.mod':
id: 'ModelsConfig@jv.chat.mod'
name: 'ModelsConfig'
type: 'model'
fields:
'chatRateLimitBurst':
type: 'Integer'
required: true
'chatRateLimitDuration':
type: 'Long'
required: true
'concurrentUsersLimit':
type: 'Integer'
required: true
'enableProfanityFilter':
type: 'Boolean'
required: true
'filterAppName':
type: 'String'
required: true
'filterParam':
type: 'String'
required: true
'filterType':
type: 'String'
required: true
'generalRateLimitBurst':
type: 'Integer'
required: true
'generalRateLimitDuration':
type: 'Long'
required: true
'namespace':
type: 'String'
required: true
'shardCapacityLimit':
type: 'Integer'
required: true
'shardDefaultLimit':
type: 'Integer'
required: true
'shardHardLimit':
type: 'Integer'
required: true
'spamChatBurst':
type: 'Integer'
required: true
'spamChatDuration':
type: 'Long'
required: true
'spamMuteDuration':
type: 'Long'
required: true
'defaultDictionaryLoaded':
type: 'Boolean'
required: false
'enableClanChat':
type: 'Boolean'
required: false
'enableManualTopicCreation':
type: 'Boolean'
required: false
'enablePmSendPlatformId':
type: 'Boolean'
required: false
'maxChatMessageLength':
type: 'Integer'
required: false
'useDefaultDictionary':
type: 'Boolean'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsConfig.java'
'ModelsConfigExport@jv.chat.mod':
id: 'ModelsConfigExport@jv.chat.mod'
name: 'ModelsConfigExport'
type: 'model'
fields:
'chatRateLimitBurst':
type: 'Integer'
required: true
'chatRateLimitDuration':
type: 'Long'
required: true
'concurrentUsersLimit':
type: 'Integer'
required: true
'generalRateLimitBurst':
type: 'Integer'
required: true
'generalRateLimitDuration':
type: 'Long'
required: true
'namespace':
type: 'String'
required: true
'enableClanChat':
type: 'Boolean'
required: false
'enableManualTopicCreation':
type: 'Boolean'
required: false
'enablePmSendPlatformId':
type: 'Boolean'
required: false
'enableProfanityFilter':
type: 'Boolean'
required: false
'filterAppName':
type: 'String'
required: false
'filterParam':
type: 'String'
required: false
'filterType':
type: 'String'
required: false
'shardCapacityLimit':
type: 'Integer'
required: false
'shardDefaultLimit':
type: 'Integer'
required: false
'shardHardLimit':
type: 'Integer'
required: false
'spamChatBurst':
type: 'Integer'
required: false
'spamChatDuration':
type: 'Long'
required: false
'spamMuteDuration':
type: 'Long'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsConfigExport.java'
'ModelsConfigList@jv.chat.mod':
id: 'ModelsConfigList@jv.chat.mod'
name: 'ModelsConfigList'
type: 'model'
fields:
'configs':
type: 'List<ModelsConfig>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsConfigList.java'
'ModelsConfigResponse@jv.chat.mod':
id: 'ModelsConfigResponse@jv.chat.mod'
name: 'ModelsConfigResponse'
type: 'model'
fields:
'chatRateLimitBurst':
type: 'Integer'
required: false
'chatRateLimitDuration':
type: 'Long'
required: false
'concurrentUsersLimit':
type: 'Integer'
required: false
'enableClanChat':
type: 'Boolean'
required: false
'enableManualTopicCreation':
type: 'Boolean'
required: false
'enablePmSendPlatformId':
type: 'Boolean'
required: false
'enableProfanityFilter':
type: 'Boolean'
required: false
'filterAppName':
type: 'String'
required: false
'filterParam':
type: 'String'
required: false
'filterType':
type: 'String'
required: false
'generalRateLimitBurst':
type: 'Integer'
required: false
'generalRateLimitDuration':
type: 'Long'
required: false
'maxChatMessageLength':
type: 'Integer'
required: false
'shardCapacityLimit':
type: 'Integer'
required: false
'shardDefaultLimit':
type: 'Integer'
required: false
'shardHardLimit':
type: 'Integer'
required: false
'spamChatBurst':
type: 'Integer'
required: false
'spamChatDuration':
type: 'Long'
required: false
'spamMuteDuration':
type: 'Long'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsConfigResponse.java'
'ModelsDictionary@jv.chat.mod':
id: 'ModelsDictionary@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionary.java'
'ModelsDictionaryChild@jv.chat.mod':
id: 'ModelsDictionaryChild@jv.chat.mod'
name: 'ModelsDictionaryChild'
type: 'model'
fields:
'id':
type: 'String'
required: true
'word':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionaryChild.java'
'ModelsDictionaryExport@jv.chat.mod':
id: 'ModelsDictionaryExport@jv.chat.mod'
name: 'ModelsDictionaryExport'
type: 'model'
fields:
'dictionaries':
type: 'List<ModelsDictionaryExportItem>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionaryExport.java'
'ModelsDictionaryExportItem@jv.chat.mod':
id: 'ModelsDictionaryExportItem@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionaryExportItem.java'
'ModelsDictionaryGroup@jv.chat.mod':
id: 'ModelsDictionaryGroup@jv.chat.mod'
name: 'ModelsDictionaryGroup'
type: 'model'
fields:
'count':
type: 'Integer'
required: true
'name':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionaryGroup.java'
'ModelsDictionaryImportResult@jv.chat.mod':
id: 'ModelsDictionaryImportResult@jv.chat.mod'
name: 'ModelsDictionaryImportResult'
type: 'model'
fields:
'words':
type: 'ModelsDictionaryWordChanges'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionaryImportResult.java'
'ModelsDictionaryInsertBulkRequest@jv.chat.mod':
id: 'ModelsDictionaryInsertBulkRequest@jv.chat.mod'
name: 'ModelsDictionaryInsertBulkRequest'
type: 'model'
fields:
'dictionaries':
type: 'List<ModelsDictionaryInsertRequest>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionaryInsertBulkRequest.java'
'ModelsDictionaryInsertRequest@jv.chat.mod':
id: 'ModelsDictionaryInsertRequest@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionaryInsertRequest.java'
'ModelsDictionaryQueryResult@jv.chat.mod':
id: 'ModelsDictionaryQueryResult@jv.chat.mod'
name: 'ModelsDictionaryQueryResult'
type: 'model'
fields:
'data':
type: 'List<ModelsDictionaryWithChildren>'
required: true
'next':
type: 'String'
required: true
'previous':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionaryQueryResult.java'
'ModelsDictionaryUpdateRequest@jv.chat.mod':
id: 'ModelsDictionaryUpdateRequest@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionaryUpdateRequest.java'
'ModelsDictionaryWithChildren@jv.chat.mod':
id: 'ModelsDictionaryWithChildren@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionaryWithChildren.java'
'ModelsDictionaryWordChanges@jv.chat.mod':
id: 'ModelsDictionaryWordChanges@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsDictionaryWordChanges.java'
'ModelsGetInboxCategoriesResponseItem@jv.chat.mod':
id: 'ModelsGetInboxCategoriesResponseItem@jv.chat.mod'
name: 'ModelsGetInboxCategoriesResponseItem'
type: 'model'
fields:
'enabled':
type: 'Boolean'
required: true
'expiresIn':
type: 'Long'
required: true
'name':
type: 'String'
required: true
'saveInbox':
type: 'Boolean'
required: true
'sendNotification':
type: 'Boolean'
required: true
'hook':
type: 'ModelsCategoryHook'
required: false
'jsonSchema':
type: 'Map<String, ?>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsGetInboxCategoriesResponseItem.java'
'ModelsGetInboxMessagesResponse@jv.chat.mod':
id: 'ModelsGetInboxMessagesResponse@jv.chat.mod'
name: 'ModelsGetInboxMessagesResponse'
type: 'model'
fields:
'data':
type: 'List<ModelsGetInboxMessagesResponseData>'
required: true
'next':
type: 'String'
required: true
'previous':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsGetInboxMessagesResponse.java'
'ModelsGetInboxMessagesResponseData@jv.chat.mod':
id: 'ModelsGetInboxMessagesResponseData@jv.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: 'Map<String, ?>'
required: false
'userIds':
type: 'List<String>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsGetInboxMessagesResponseData.java'
'ModelsGetInboxStatsResponse@jv.chat.mod':
id: 'ModelsGetInboxStatsResponse@jv.chat.mod'
name: 'ModelsGetInboxStatsResponse'
type: 'model'
fields:
'data':
type: 'List<ModelsMessageStats>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsGetInboxStatsResponse.java'
'ModelsGetInboxUsersResponse@jv.chat.mod':
id: 'ModelsGetInboxUsersResponse@jv.chat.mod'
name: 'ModelsGetInboxUsersResponse'
type: 'model'
fields:
'data':
type: 'List<ModelsUserInbox>'
required: true
'next':
type: 'String'
required: true
'previous':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsGetInboxUsersResponse.java'
'ModelsGetListTopicKafkaResponse@jv.chat.mod':
id: 'ModelsGetListTopicKafkaResponse@jv.chat.mod'
name: 'ModelsGetListTopicKafkaResponse'
type: 'model'
fields:
'topicName':
type: 'List<String>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsGetListTopicKafkaResponse.java'
'ModelsImportConfigResponse@jv.chat.mod':
id: 'ModelsImportConfigResponse@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsImportConfigResponse.java'
'ModelsJSONSchemaType@jv.chat.mod':
id: 'ModelsJSONSchemaType@jv.chat.mod'
name: 'ModelsJSONSchemaType'
type: 'model'
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsJSONSchemaType.java'
'ModelsMessageRequest@jv.chat.mod':
id: 'ModelsMessageRequest@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsMessageRequest.java'
'ModelsMessageResultWithAttributes@jv.chat.mod':
id: 'ModelsMessageResultWithAttributes@jv.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: 'Map<String, ?>'
required: false
'cencoredWords':
type: 'List<String>'
required: false
'classifications':
type: 'List<String>'
required: false
'referenceId':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsMessageResultWithAttributes.java'
'ModelsMessageStats@jv.chat.mod':
id: 'ModelsMessageStats@jv.chat.mod'
name: 'ModelsMessageStats'
type: 'model'
fields:
'id':
type: 'String'
required: true
'messageRead':
type: 'Integer'
required: true
'messageStored':
type: 'Integer'
required: true
'notificationSent':
type: 'Integer'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsMessageStats.java'
'ModelsPagination@jv.chat.mod':
id: 'ModelsPagination@jv.chat.mod'
name: 'ModelsPagination'
type: 'model'
fields:
'next':
type: 'String'
required: true
'previous':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsPagination.java'
'ModelsPublicBanTopicMembersRequest@jv.chat.mod':
id: 'ModelsPublicBanTopicMembersRequest@jv.chat.mod'
name: 'ModelsPublicBanTopicMembersRequest'
type: 'model'
fields:
'userIDs':
type: 'List<String>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsPublicBanTopicMembersRequest.java'
'ModelsPublicBanTopicMembersResponse@jv.chat.mod':
id: 'ModelsPublicBanTopicMembersResponse@jv.chat.mod'
name: 'ModelsPublicBanTopicMembersResponse'
type: 'model'
fields:
'userIDs':
type: 'List<String>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsPublicBanTopicMembersResponse.java'
'ModelsPublicConfigResponse@jv.chat.mod':
id: 'ModelsPublicConfigResponse@jv.chat.mod'
name: 'ModelsPublicConfigResponse'
type: 'model'
fields:
'chatRateLimitBurst':
type: 'Integer'
required: true
'chatRateLimitDuration':
type: 'Long'
required: true
'generalRateLimitBurst':
type: 'Integer'
required: true
'generalRateLimitDuration':
type: 'Long'
required: true
'maxChatMessageLength':
type: 'Integer'
required: true
'spamChatBurst':
type: 'Integer'
required: true
'spamChatDuration':
type: 'Long'
required: true
'spamMuteDuration':
type: 'Long'
required: true
'enablePmSendPlatformId':
type: 'Boolean'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsPublicConfigResponse.java'
'ModelsPublicUnbanTopicMembersRequest@jv.chat.mod':
id: 'ModelsPublicUnbanTopicMembersRequest@jv.chat.mod'
name: 'ModelsPublicUnbanTopicMembersRequest'
type: 'model'
fields:
'userIDs':
type: 'List<String>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsPublicUnbanTopicMembersRequest.java'
'ModelsPublicUnbanTopicMembersResponse@jv.chat.mod':
id: 'ModelsPublicUnbanTopicMembersResponse@jv.chat.mod'
name: 'ModelsPublicUnbanTopicMembersResponse'
type: 'model'
fields:
'userIDs':
type: 'List<String>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsPublicUnbanTopicMembersResponse.java'
'ModelsSaveInboxMessageRequest@jv.chat.mod':
id: 'ModelsSaveInboxMessageRequest@jv.chat.mod'
name: 'ModelsSaveInboxMessageRequest'
type: 'model'
fields:
'expiredAt':
type: 'Long'
required: true
'message':
type: 'Map<String, ?>'
required: true
'scope':
type: 'String'
required: true
'status':
type: 'String'
required: true
'userIds':
type: 'List<String>'
required: true
'category':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsSaveInboxMessageRequest.java'
'ModelsSaveInboxMessageResponse@jv.chat.mod':
id: 'ModelsSaveInboxMessageResponse@jv.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: 'Map<String, ?>'
required: false
'userIDs':
type: 'List<String>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsSaveInboxMessageResponse.java'
'ModelsSendInboxMessageRequest@jv.chat.mod':
id: 'ModelsSendInboxMessageRequest@jv.chat.mod'
name: 'ModelsSendInboxMessageRequest'
type: 'model'
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsSendInboxMessageRequest.java'
'ModelsSendInboxMessageResponse@jv.chat.mod':
id: 'ModelsSendInboxMessageResponse@jv.chat.mod'
name: 'ModelsSendInboxMessageResponse'
type: 'model'
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsSendInboxMessageResponse.java'
'ModelsTopicInfo@jv.chat.mod':
id: 'ModelsTopicInfo@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsTopicInfo.java'
'ModelsTopicLogItem@jv.chat.mod':
id: 'ModelsTopicLogItem@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsTopicLogItem.java'
'ModelsTopicLogWithPaginationResponse@jv.chat.mod':
id: 'ModelsTopicLogWithPaginationResponse@jv.chat.mod'
name: 'ModelsTopicLogWithPaginationResponse'
type: 'model'
fields:
'data':
type: 'List<ModelsTopicLogItem>'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsTopicLogWithPaginationResponse.java'
'ModelsTopicMemberResponse@jv.chat.mod':
id: 'ModelsTopicMemberResponse@jv.chat.mod'
name: 'ModelsTopicMemberResponse'
type: 'model'
fields:
'isAdmin':
type: 'Boolean'
required: true
'isBanned':
type: 'Boolean'
required: true
'shardId':
type: 'String'
required: true
'userId':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsTopicMemberResponse.java'
'ModelsTopicMemberWithPaginationResponse@jv.chat.mod':
id: 'ModelsTopicMemberWithPaginationResponse@jv.chat.mod'
name: 'ModelsTopicMemberWithPaginationResponse'
type: 'model'
fields:
'data':
type: 'List<ModelsTopicMemberResponse>'
required: true
'paging':
type: 'ModelsPagination'
required: true
'totalData':
type: 'Integer'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsTopicMemberWithPaginationResponse.java'
'ModelsTopicResponse@jv.chat.mod':
id: 'ModelsTopicResponse@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsTopicResponse.java'
'ModelsUnbanTopicMemberParam@jv.chat.mod':
id: 'ModelsUnbanTopicMemberParam@jv.chat.mod'
name: 'ModelsUnbanTopicMemberParam'
type: 'model'
fields:
'userIds':
type: 'List<String>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsUnbanTopicMemberParam.java'
'ModelsUnbanTopicMemberResult@jv.chat.mod':
id: 'ModelsUnbanTopicMemberResult@jv.chat.mod'
name: 'ModelsUnbanTopicMemberResult'
type: 'model'
fields:
'userIds':
type: 'List<String>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsUnbanTopicMemberResult.java'
'ModelsUnsendInboxMessageRequest@jv.chat.mod':
id: 'ModelsUnsendInboxMessageRequest@jv.chat.mod'
name: 'ModelsUnsendInboxMessageRequest'
type: 'model'
fields:
'userIds':
type: 'List<String>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsUnsendInboxMessageRequest.java'
'ModelsUnsendInboxMessageResponse@jv.chat.mod':
id: 'ModelsUnsendInboxMessageResponse@jv.chat.mod'
name: 'ModelsUnsendInboxMessageResponse'
type: 'model'
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsUnsendInboxMessageResponse.java'
'ModelsUpdateInboxCategoryRequest@jv.chat.mod':
id: 'ModelsUpdateInboxCategoryRequest@jv.chat.mod'
name: 'ModelsUpdateInboxCategoryRequest'
type: 'model'
fields:
'enabled':
type: 'Boolean'
required: true
'expiresIn':
type: 'Long'
required: true
'hook':
type: 'ModelsCategoryHook'
required: true
'saveInbox':
type: 'Boolean'
required: true
'sendNotification':
type: 'Boolean'
required: true
'jsonSchema':
type: 'Map<String, ?>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsUpdateInboxCategoryRequest.java'
'ModelsUpdateInboxMessageRequest@jv.chat.mod':
id: 'ModelsUpdateInboxMessageRequest@jv.chat.mod'
name: 'ModelsUpdateInboxMessageRequest'
type: 'model'
fields:
'expiredAt':
type: 'Long'
required: true
'message':
type: 'Map<String, ?>'
required: true
'scope':
type: 'String'
required: true
'userIds':
type: 'List<String>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsUpdateInboxMessageRequest.java'
'ModelsUserInbox@jv.chat.mod':
id: 'ModelsUserInbox@jv.chat.mod'
name: 'ModelsUserInbox'
type: 'model'
fields:
'keep':
type: 'Boolean'
required: true
'readAt':
type: 'Long'
required: true
'userId':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ModelsUserInbox.java'
'ResponseError@jv.chat.mod':
id: 'ResponseError@jv.chat.mod'
name: 'ResponseError'
type: 'model'
fields:
'errorCode':
type: 'Integer'
required: true
'errorMessage':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/ResponseError.java'
'RestapiErrorResponseBody@jv.chat.mod':
id: 'RestapiErrorResponseBody@jv.chat.mod'
name: 'RestapiErrorResponseBody'
type: 'model'
fields:
'errorCode':
type: 'Integer'
required: true
'errorMessage':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/RestapiErrorResponseBody.java'
'TopicInfoMember@jv.chat.mod':
id: 'TopicInfoMember@jv.chat.mod'
name: 'TopicInfoMember'
type: 'model'
fields:
'userId':
type: 'String'
required: true
'leftAt':
type: 'Long'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/models/TopicInfoMember.java'
# endregion models
# region functions
'AdminAddInboxCategory@jv.chat.fun':
id: 'AdminAddInboxCategory@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminAddInboxCategory.java'
example: |-
try {
final AdminAddInboxCategory operation = AdminAddInboxCategory.builder()
.build(
body,
namespace,
);
final Inbox wrapper = new Inbox(sdk);
final ModelsAddInboxCategoryResponse response = wrapper.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@jv.chat.fun':
id: 'AdminAddTopicMember@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminAddTopicMember.java'
example: |-
try {
final AdminAddTopicMember operation = AdminAddTopicMember.builder()
.build(
body,
namespace,
topic,
userId,
);
final Topic wrapper = new Topic(sdk);
final MessageActionAddUserToTopicResult response = wrapper.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@jv.chat.fun':
id: 'AdminBanTopicMembers@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminBanTopicMembers.java'
example: |-
try {
final AdminBanTopicMembers operation = AdminBanTopicMembers.builder()
.build(
body,
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final ModelsBanTopicMemberResult response = wrapper.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@jv.chat.fun':
id: 'AdminChannelTopicInfo@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminChannelTopicInfo.java'
example: |-
try {
final AdminChannelTopicInfo operation = AdminChannelTopicInfo.builder()
.build(
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final ModelsChannelTopicResponse response = wrapper.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@jv.chat.fun':
id: 'AdminChannelTopicList@jv.chat.fun'
name: 'AdminChannelTopicList'
type: 'function'
description: |-
Get channel chat list of topic in a namespace.
arguments:
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
required: false
description: |-
offset
'topicName':
type: 'String'
required: false
description: |-
name
return_type: 'ModelsChannelTopicWithPaginationResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminChannelTopicList.java'
example: |-
try {
final AdminChannelTopicList operation = AdminChannelTopicList.builder()
.limit(...)
.offset(...)
.topicName(...)
.build(
namespace,
);
final Topic wrapper = new Topic(sdk);
final ModelsChannelTopicWithPaginationResponse response = wrapper.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@jv.chat.fun':
id: 'AdminChannelTopicSummary@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminChannelTopicSummary.java'
example: |-
try {
final AdminChannelTopicSummary operation = AdminChannelTopicSummary.builder()
.build(
namespace,
);
final Topic wrapper = new Topic(sdk);
final ModelsChannelTopicSummaryResponse response = wrapper.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@jv.chat.fun':
id: 'AdminChatHistory@jv.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: 'Integer'
required: false
description: |-
end date
'keyword':
type: 'String'
required: false
description: |-
keyword containing in message
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
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: 'Integer'
required: false
description: |-
start date
'topic':
type: 'List<String>'
required: false
description: |-
topic ID that receive the chat
'unfiltered':
type: 'Boolean'
required: false
description: |-
unfiltered chat messages
return_type: 'ModelsChatMessageWithPaginationResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminChatHistory.java'
example: |-
try {
final AdminChatHistory operation = AdminChatHistory.builder()
.chatId(...)
.endCreatedAt(...)
.keyword(...)
.limit(...)
.offset(...)
.order(...)
.senderUserId(...)
.shardId(...)
.startCreatedAt(...)
.topic(...)
.unfiltered(...)
.build(
namespace,
);
final Topic wrapper = new Topic(sdk);
final ModelsChatMessageWithPaginationResponse response = wrapper.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@jv.chat.fun':
id: 'AdminCreateNamespaceTopic@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminCreateNamespaceTopic.java'
example: |-
try {
final AdminCreateNamespaceTopic operation = AdminCreateNamespaceTopic.builder()
.build(
body,
namespace,
);
final Topic wrapper = new Topic(sdk);
final ApiCreateTopicResponse response = wrapper.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@jv.chat.fun':
id: 'AdminCreateTopic@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminCreateTopic.java'
example: |-
try {
final AdminCreateTopic operation = AdminCreateTopic.builder()
.build(
body,
namespace,
);
final Topic wrapper = new Topic(sdk);
final ApiCreateTopicResponse response = wrapper.adminCreateTopic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'create'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [CREATE]'
'AdminDeleteChat@jv.chat.fun':
id: 'AdminDeleteChat@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminDeleteChat.java'
example: |-
try {
final AdminDeleteChat operation = AdminDeleteChat.builder()
.build(
chatId,
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
wrapper.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@jv.chat.fun':
id: 'AdminDeleteChatSnapshot@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.moderation.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Moderation.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/moderation/AdminDeleteChatSnapshot.java'
example: |-
try {
final AdminDeleteChatSnapshot operation = AdminDeleteChatSnapshot.builder()
.build(
chatId,
namespace,
);
final Moderation wrapper = new Moderation(sdk);
wrapper.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@jv.chat.fun':
id: 'AdminDeleteInboxCategory@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminDeleteInboxCategory.java'
example: |-
try {
final AdminDeleteInboxCategory operation = AdminDeleteInboxCategory.builder()
.build(
category,
namespace,
);
final Inbox wrapper = new Inbox(sdk);
wrapper.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@jv.chat.fun':
id: 'AdminDeleteInboxMessage@jv.chat.fun'
name: 'AdminDeleteInboxMessage'
type: 'function'
description: |-
Delete inbox message
arguments:
'force':
type: 'Boolean'
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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminDeleteInboxMessage.java'
example: |-
try {
final AdminDeleteInboxMessage operation = AdminDeleteInboxMessage.builder()
.force(...)
.build(
messageId,
namespace,
);
final Inbox wrapper = new Inbox(sdk);
wrapper.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@jv.chat.fun':
id: 'AdminDeleteTopic@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminDeleteTopic.java'
example: |-
try {
final AdminDeleteTopic operation = AdminDeleteTopic.builder()
.build(
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final MessageActionDeleteTopicResult response = wrapper.adminDeleteTopic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [DELETE]'
'AdminFilterChatMessage@jv.chat.fun':
id: 'AdminFilterChatMessage@jv.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: 'Boolean'
required: false
description: |-
To show what filter driver is used
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'ModelsMessageResultWithAttributes'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminFilterChatMessage.java'
example: |-
try {
final AdminFilterChatMessage operation = AdminFilterChatMessage.builder()
.detail(...)
.build(
body,
namespace,
);
final Topic wrapper = new Topic(sdk);
final ModelsMessageResultWithAttributes response = wrapper.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@jv.chat.fun':
id: 'AdminGetAllConfigV1@jv.chat.fun'
name: 'AdminGetAllConfigV1'
type: 'function'
description: |-
Get chat config of all namespaces.
return_type: 'ModelsConfigList'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.config.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/config/AdminGetAllConfigV1.java'
example: |-
try {
final AdminGetAllConfigV1 operation = AdminGetAllConfigV1.builder()
.build();
final Config wrapper = new Config(sdk);
final ModelsConfigList response = wrapper.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@jv.chat.fun':
id: 'AdminGetCategorySchema@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminGetCategorySchema.java'
example: |-
try {
final AdminGetCategorySchema operation = AdminGetCategorySchema.builder()
.build(
category,
namespace,
);
final Inbox wrapper = new Inbox(sdk);
final ModelsJSONSchemaType response = wrapper.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@jv.chat.fun':
id: 'AdminGetChatSnapshot@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.moderation.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Moderation.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/moderation/AdminGetChatSnapshot.java'
example: |-
try {
final AdminGetChatSnapshot operation = AdminGetChatSnapshot.builder()
.build(
chatId,
namespace,
);
final Moderation wrapper = new Moderation(sdk);
final ModelsChatSnapshots response = wrapper.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@jv.chat.fun':
id: 'AdminGetConfigV1@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.config.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/config/AdminGetConfigV1.java'
example: |-
try {
final AdminGetConfigV1 operation = AdminGetConfigV1.builder()
.build(
namespace,
);
final Config wrapper = new Config(sdk);
final ModelsConfigResponse response = wrapper.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@jv.chat.fun':
id: 'AdminGetInboxCategories@jv.chat.fun'
name: 'AdminGetInboxCategories'
type: 'function'
description: |-
Get inbox categories
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'List<ModelsGetInboxCategoriesResponseItem>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminGetInboxCategories.java'
example: |-
try {
final AdminGetInboxCategories operation = AdminGetInboxCategories.builder()
.build(
namespace,
);
final Inbox wrapper = new Inbox(sdk);
final List<ModelsGetInboxCategoriesResponseItem> response = wrapper.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@jv.chat.fun':
id: 'AdminGetInboxMessages@jv.chat.fun'
name: 'AdminGetInboxMessages'
type: 'function'
description: |-
Get inbox messages
arguments:
'activeOnly':
type: 'Boolean'
required: false
description: |-
active only
'endCreatedAt':
type: 'Integer'
required: false
description: |-
end created at
'limit':
type: 'Integer'
required: false
description: |-
limit
'messageId':
type: 'List<String>'
required: false
description: |-
message ids
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
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: 'Integer'
required: false
description: |-
start created at
'status':
type: 'String'
required: false
description: |-
message status
'transient_':
type: 'Boolean'
required: false
description: |-
transient message filter
return_type: 'ModelsGetInboxMessagesResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminGetInboxMessages.java'
example: |-
try {
final AdminGetInboxMessages operation = AdminGetInboxMessages.builder()
.activeOnly(...)
.endCreatedAt(...)
.limit(...)
.messageId(...)
.offset(...)
.order(...)
.scope(...)
.startCreatedAt(...)
.status(...)
.transient_(...)
.build(
namespace,
);
final Inbox wrapper = new Inbox(sdk);
final ModelsGetInboxMessagesResponse response = wrapper.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@jv.chat.fun':
id: 'AdminGetInboxStats@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminGetInboxStats.java'
example: |-
try {
final AdminGetInboxStats operation = AdminGetInboxStats.builder()
.messageId(...)
.build(
namespace,
);
final Inbox wrapper = new Inbox(sdk);
final ModelsGetInboxStatsResponse response = wrapper.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@jv.chat.fun':
id: 'AdminGetInboxUsers@jv.chat.fun'
name: 'AdminGetInboxUsers'
type: 'function'
description: |-
Get inbox users
arguments:
'inbox':
type: 'String'
required: true
description: |-
message id
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
required: false
description: |-
offset
'status':
type: 'String'
required: false
description: |-
message status
'userId':
type: 'String'
required: false
description: |-
userId
return_type: 'ModelsGetInboxUsersResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminGetInboxUsers.java'
example: |-
try {
final AdminGetInboxUsers operation = AdminGetInboxUsers.builder()
.limit(...)
.offset(...)
.status(...)
.userId(...)
.build(
inbox,
namespace,
);
final Inbox wrapper = new Inbox(sdk);
final ModelsGetInboxUsersResponse response = wrapper.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@jv.chat.fun':
id: 'AdminGetLogConfig@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.config.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/config/AdminGetLogConfig.java'
example: |-
try {
final AdminGetLogConfig operation = AdminGetLogConfig.builder()
.build();
final Config wrapper = new Config(sdk);
final LogconfigConfiguration response = wrapper.adminGetLogConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'config'
- 'get'
- 'log'
permissions:
- 'ADMIN:CONFIG:LOG [READ]'
'AdminListKafkaTopic@jv.chat.fun':
id: 'AdminListKafkaTopic@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminListKafkaTopic.java'
example: |-
try {
final AdminListKafkaTopic operation = AdminListKafkaTopic.builder()
.build(
namespace,
);
final Inbox wrapper = new Inbox(sdk);
final ModelsGetListTopicKafkaResponse response = wrapper.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@jv.chat.fun':
id: 'AdminPatchUpdateLogConfig@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.config.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/config/AdminPatchUpdateLogConfig.java'
example: |-
try {
final AdminPatchUpdateLogConfig operation = AdminPatchUpdateLogConfig.builder()
.build(
body,
);
final Config wrapper = new Config(sdk);
final LogconfigConfiguration response = wrapper.adminPatchUpdateLogConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'config'
- 'log'
- 'patch'
- 'update'
permissions:
- 'ADMIN:CONFIG:LOG [UPDATE]'
'AdminProfanityCreate@jv.chat.fun':
id: 'AdminProfanityCreate@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.profanity.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Profanity.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/profanity/AdminProfanityCreate.java'
example: |-
try {
final AdminProfanityCreate operation = AdminProfanityCreate.builder()
.build(
body,
namespace,
);
final Profanity wrapper = new Profanity(sdk);
final ModelsDictionary response = wrapper.adminProfanityCreate(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'create'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [CREATE]'
'AdminProfanityCreateBulk@jv.chat.fun':
id: 'AdminProfanityCreateBulk@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.profanity.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Profanity.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/profanity/AdminProfanityCreateBulk.java'
example: |-
try {
final AdminProfanityCreateBulk operation = AdminProfanityCreateBulk.builder()
.build(
body,
namespace,
);
final Profanity wrapper = new Profanity(sdk);
wrapper.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@jv.chat.fun':
id: 'AdminProfanityDelete@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.profanity.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Profanity.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/profanity/AdminProfanityDelete.java'
example: |-
try {
final AdminProfanityDelete operation = AdminProfanityDelete.builder()
.build(
id,
namespace,
);
final Profanity wrapper = new Profanity(sdk);
wrapper.adminProfanityDelete(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [DELETE]'
'AdminProfanityExport@jv.chat.fun':
id: 'AdminProfanityExport@jv.chat.fun'
name: 'AdminProfanityExport'
type: 'function'
description: |-
Export profanity words
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'ModelsDictionaryExport'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.profanity.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Profanity.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/profanity/AdminProfanityExport.java'
example: |-
try {
final AdminProfanityExport operation = AdminProfanityExport.builder()
.build(
namespace,
);
final Profanity wrapper = new Profanity(sdk);
final ModelsDictionaryExport response = wrapper.adminProfanityExport(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'export'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]'
'AdminProfanityGroup@jv.chat.fun':
id: 'AdminProfanityGroup@jv.chat.fun'
name: 'AdminProfanityGroup'
type: 'function'
description: |-
Get profanity words group.
arguments:
'limit':
type: 'Integer'
required: false
description: |-
default: 100
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
required: false
description: |-
offset
return_type: 'List<ModelsDictionaryGroup>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.profanity.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Profanity.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/profanity/AdminProfanityGroup.java'
example: |-
try {
final AdminProfanityGroup operation = AdminProfanityGroup.builder()
.limit(...)
.offset(...)
.build(
namespace,
);
final Profanity wrapper = new Profanity(sdk);
final List<ModelsDictionaryGroup> response = wrapper.adminProfanityGroup(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'group'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]'
'AdminProfanityImport@jv.chat.fun':
id: 'AdminProfanityImport@jv.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: 'File'
required: true
description: |-
file to be imported
'namespace':
type: 'String'
required: true
description: |-
namespace
'showResult':
type: 'Boolean'
required: false
description: |-
When showResult=true, this endpoint with returns imported words result
return_type: 'ModelsDictionaryImportResult'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.profanity.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Profanity.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/profanity/AdminProfanityImport.java'
example: |-
try {
final AdminProfanityImport operation = AdminProfanityImport.builder()
.action(...)
.showResult(...)
.build(
file,
namespace,
);
final Profanity wrapper = new Profanity(sdk);
final ModelsDictionaryImportResult response = wrapper.adminProfanityImport(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'import'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [CREATE]'
'AdminProfanityQuery@jv.chat.fun':
id: 'AdminProfanityQuery@jv.chat.fun'
name: 'AdminProfanityQuery'
type: 'function'
description: |-
Query all profanity words.
arguments:
'filterMask':
type: 'String'
required: false
description: |-
filter mask
'includeChildren':
type: 'Boolean'
required: false
description: |-
include false positives and false negatives
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.profanity.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Profanity.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/profanity/AdminProfanityQuery.java'
example: |-
try {
final AdminProfanityQuery operation = AdminProfanityQuery.builder()
.filterMask(...)
.includeChildren(...)
.limit(...)
.offset(...)
.parentId(...)
.startWith(...)
.wordType(...)
.build(
namespace,
);
final Profanity wrapper = new Profanity(sdk);
final ModelsDictionaryQueryResult response = wrapper.adminProfanityQuery(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'profanity'
- 'query'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]'
'AdminProfanityUpdate@jv.chat.fun':
id: 'AdminProfanityUpdate@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.profanity.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Profanity.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/profanity/AdminProfanityUpdate.java'
example: |-
try {
final AdminProfanityUpdate operation = AdminProfanityUpdate.builder()
.build(
body,
id,
namespace,
);
final Profanity wrapper = new Profanity(sdk);
final ModelsDictionary response = wrapper.adminProfanityUpdate(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'profanity'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [UPDATE]'
'AdminQueryTopic@jv.chat.fun':
id: 'AdminQueryTopic@jv.chat.fun'
name: 'AdminQueryTopic'
type: 'function'
description: |-
Get topics in a namespace.
arguments:
'includeMembers':
type: 'Boolean'
required: false
description: |-
include topic's members
'includePastMembers':
type: 'Boolean'
required: false
description: |-
include past members (user that had left topic)
'includePastTopics':
type: 'Boolean'
required: false
description: |-
include topic that has been removed.<br/><b>NOTE:</b> only soft deleted topics are available
'limit':
type: 'Integer'
required: false
description: |-
default: 100
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminQueryTopic.java'
example: |-
try {
final AdminQueryTopic operation = AdminQueryTopic.builder()
.includeMembers(...)
.includePastMembers(...)
.includePastTopics(...)
.limit(...)
.offset(...)
.topic(...)
.topicSubType(...)
.topicType(...)
.userId(...)
.build(
namespace,
);
final Topic wrapper = new Topic(sdk);
final List<ModelsTopicInfo> response = wrapper.adminQueryTopic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'query'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminQueryTopicLog@jv.chat.fun':
id: 'AdminQueryTopicLog@jv.chat.fun'
name: 'AdminQueryTopicLog'
type: 'function'
description: |-
Get chat log of topic in a namespace.
arguments:
'endCreatedAt':
type: 'Integer'
required: false
description: |-
end date
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
required: false
description: |-
offset
'senderUserId':
type: 'String'
required: false
description: |-
senderUserId (actor, can be admin or the user itself)
'startCreatedAt':
type: 'Integer'
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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminQueryTopicLog.java'
example: |-
try {
final AdminQueryTopicLog operation = AdminQueryTopicLog.builder()
.endCreatedAt(...)
.limit(...)
.offset(...)
.senderUserId(...)
.startCreatedAt(...)
.topicId(...)
.topicIds(...)
.userId(...)
.build(
namespace,
);
final Topic wrapper = new Topic(sdk);
final ModelsTopicLogWithPaginationResponse response = wrapper.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@jv.chat.fun':
id: 'AdminQueryUsersTopic@jv.chat.fun'
name: 'AdminQueryUsersTopic'
type: 'function'
description: |-
Get user's topics in a namespace.
arguments:
'includePastTopics':
type: 'Boolean'
required: false
description: |-
when true will include topics that user already left
'limit':
type: 'Integer'
required: false
description: |-
default: 100
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminQueryUsersTopic.java'
example: |-
try {
final AdminQueryUsersTopic operation = AdminQueryUsersTopic.builder()
.includePastTopics(...)
.limit(...)
.offset(...)
.topicSubType(...)
.topicType(...)
.build(
namespace,
userId,
);
final Topic wrapper = new Topic(sdk);
final ModelsTopicLogWithPaginationResponse response = wrapper.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@jv.chat.fun':
id: 'AdminRemoveTopicMember@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminRemoveTopicMember.java'
example: |-
try {
final AdminRemoveTopicMember operation = AdminRemoveTopicMember.builder()
.build(
namespace,
topic,
userId,
);
final Topic wrapper = new Topic(sdk);
final MessageActionAddUserToTopicResult response = wrapper.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@jv.chat.fun':
id: 'AdminSaveInboxMessage@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminSaveInboxMessage.java'
example: |-
try {
final AdminSaveInboxMessage operation = AdminSaveInboxMessage.builder()
.build(
body,
namespace,
);
final Inbox wrapper = new Inbox(sdk);
final ModelsSaveInboxMessageResponse response = wrapper.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@jv.chat.fun':
id: 'AdminSendChat@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminSendChat.java'
example: |-
try {
final AdminSendChat operation = AdminSendChat.builder()
.build(
body,
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final List<ModelsChatMessageResponse> response = wrapper.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@jv.chat.fun':
id: 'AdminSendInboxMessage@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminSendInboxMessage.java'
example: |-
try {
final AdminSendInboxMessage operation = AdminSendInboxMessage.builder()
.build(
body,
messageId,
namespace,
);
final Inbox wrapper = new Inbox(sdk);
final ModelsSendInboxMessageResponse response = wrapper.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@jv.chat.fun':
id: 'AdminTopicChatHistory@jv.chat.fun'
name: 'AdminTopicChatHistory'
type: 'function'
description: |-
Get chat history in a namespace.
arguments:
'endCreatedAt':
type: 'Integer'
required: false
description: |-
end date
'keyword':
type: 'String'
required: false
description: |-
keyword containing in message
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
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: 'Integer'
required: false
description: |-
start date
'topic':
type: 'String'
required: true
description: |-
topic ID that receive the chat
'unfiltered':
type: 'Boolean'
required: false
description: |-
unfiltered chat messages
return_type: 'ModelsChatMessageWithPaginationResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminTopicChatHistory.java'
example: |-
try {
final AdminTopicChatHistory operation = AdminTopicChatHistory.builder()
.endCreatedAt(...)
.keyword(...)
.limit(...)
.offset(...)
.order(...)
.senderUserId(...)
.shardId(...)
.startCreatedAt(...)
.unfiltered(...)
.build(
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final ModelsChatMessageWithPaginationResponse response = wrapper.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@jv.chat.fun':
id: 'AdminTopicList@jv.chat.fun'
name: 'AdminTopicList'
type: 'function'
description: |-
Get chat list of topic in a namespace.
arguments:
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
required: false
description: |-
offset
'topicType':
type: 'String'
required: false
description: |-
PERSONAL or GROUP
return_type: 'List<ModelsTopicResponse>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminTopicList.java'
example: |-
try {
final AdminTopicList operation = AdminTopicList.builder()
.limit(...)
.offset(...)
.topicType(...)
.build(
namespace,
);
final Topic wrapper = new Topic(sdk);
final List<ModelsTopicResponse> response = wrapper.adminTopicList(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'list'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminTopicMembers@jv.chat.fun':
id: 'AdminTopicMembers@jv.chat.fun'
name: 'AdminTopicMembers'
type: 'function'
description: |-
Get topic members.
arguments:
'isBanned':
type: 'Boolean'
required: false
description: |-
only show banned member
'isModerator':
type: 'Boolean'
required: false
description: |-
only show moderator member
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
required: false
description: |-
offset
'shardId':
type: 'String'
required: false
description: |-
shard ID
'topic':
type: 'String'
required: true
description: |-
topic ID
return_type: 'ModelsTopicMemberWithPaginationResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminTopicMembers.java'
example: |-
try {
final AdminTopicMembers operation = AdminTopicMembers.builder()
.isBanned(...)
.isModerator(...)
.limit(...)
.offset(...)
.shardId(...)
.build(
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final ModelsTopicMemberWithPaginationResponse response = wrapper.adminTopicMembers(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'members'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminTopicShards@jv.chat.fun':
id: 'AdminTopicShards@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminTopicShards.java'
example: |-
try {
final AdminTopicShards operation = AdminTopicShards.builder()
.build(
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final List<String> response = wrapper.adminTopicShards(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'shards'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminUnbanTopicMembers@jv.chat.fun':
id: 'AdminUnbanTopicMembers@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminUnbanTopicMembers.java'
example: |-
try {
final AdminUnbanTopicMembers operation = AdminUnbanTopicMembers.builder()
.build(
body,
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final ModelsUnbanTopicMemberResult response = wrapper.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@jv.chat.fun':
id: 'AdminUnsendInboxMessage@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminUnsendInboxMessage.java'
example: |-
try {
final AdminUnsendInboxMessage operation = AdminUnsendInboxMessage.builder()
.build(
body,
inbox,
namespace,
);
final Inbox wrapper = new Inbox(sdk);
final ModelsUnsendInboxMessageResponse response = wrapper.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@jv.chat.fun':
id: 'AdminUpdateConfigV1@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.config.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/config/AdminUpdateConfigV1.java'
example: |-
try {
final AdminUpdateConfigV1 operation = AdminUpdateConfigV1.builder()
.build(
body,
namespace,
);
final Config wrapper = new Config(sdk);
final ModelsConfigResponse response = wrapper.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@jv.chat.fun':
id: 'AdminUpdateInboxCategory@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminUpdateInboxCategory.java'
example: |-
try {
final AdminUpdateInboxCategory operation = AdminUpdateInboxCategory.builder()
.build(
body,
category,
namespace,
);
final Inbox wrapper = new Inbox(sdk);
wrapper.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@jv.chat.fun':
id: 'AdminUpdateInboxMessage@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.inbox.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Inbox.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/inbox/AdminUpdateInboxMessage.java'
example: |-
try {
final AdminUpdateInboxMessage operation = AdminUpdateInboxMessage.builder()
.build(
body,
messageId,
namespace,
);
final Inbox wrapper = new Inbox(sdk);
wrapper.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@jv.chat.fun':
id: 'AdminUpdateTopic@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/AdminUpdateTopic.java'
example: |-
try {
final AdminUpdateTopic operation = AdminUpdateTopic.builder()
.build(
body,
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final ApiCreateTopicResponse response = wrapper.adminUpdateTopic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'topic'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'ExportConfig@jv.chat.fun':
id: 'ExportConfig@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.config.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/config/ExportConfig.java'
example: |-
try {
final ExportConfig operation = ExportConfig.builder()
.build(
namespace,
);
final Config wrapper = new Config(sdk);
final List<ModelsConfigExport> response = wrapper.exportConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'config'
- 'export'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [READ]'
'ImportConfig@jv.chat.fun':
id: 'ImportConfig@jv.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: 'File'
required: false
description: |-
file to be imported
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'ModelsImportConfigResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.config.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/config/ImportConfig.java'
example: |-
try {
final ImportConfig operation = ImportConfig.builder()
.file(...)
.build(
namespace,
);
final Config wrapper = new Config(sdk);
final ModelsImportConfigResponse response = wrapper.importConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'config'
- 'import'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [UPDATE]'
'PublicBanTopicMembers@jv.chat.fun':
id: 'PublicBanTopicMembers@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/PublicBanTopicMembers.java'
example: |-
try {
final PublicBanTopicMembers operation = PublicBanTopicMembers.builder()
.build(
body,
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final ModelsPublicBanTopicMembersResponse response = wrapper.publicBanTopicMembers(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'ban'
- 'members'
- 'public'
- 'topic'
'PublicChatHistory@jv.chat.fun':
id: 'PublicChatHistory@jv.chat.fun'
name: 'PublicChatHistory'
type: 'function'
description: |-
get chat history in a namespace.
arguments:
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
namespace
'order':
type: 'String'
required: false
description: |-
anyof: createdAt:asc / createdAt:desc
'startCreatedAt':
type: 'Integer'
required: false
description: |-
lastChatCreatedAt
'topic':
type: 'String'
required: true
description: |-
topic ID that receive the chat
return_type: 'List<ModelsChatMessageResponse>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/PublicChatHistory.java'
example: |-
try {
final PublicChatHistory operation = PublicChatHistory.builder()
.limit(...)
.order(...)
.startCreatedAt(...)
.build(
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final List<ModelsChatMessageResponse> response = wrapper.publicChatHistory(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'chat'
- 'history'
- 'public'
- 'topic'
'PublicDeleteChat@jv.chat.fun':
id: 'PublicDeleteChat@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/PublicDeleteChat.java'
example: |-
try {
final PublicDeleteChat operation = PublicDeleteChat.builder()
.build(
chatId,
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
wrapper.publicDeleteChat(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'chat'
- 'delete'
- 'public'
- 'topic'
'PublicGetChatSnapshot@jv.chat.fun':
id: 'PublicGetChatSnapshot@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.moderation.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Moderation.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/moderation/PublicGetChatSnapshot.java'
example: |-
try {
final PublicGetChatSnapshot operation = PublicGetChatSnapshot.builder()
.build(
chatId,
namespace,
topic,
);
final Moderation wrapper = new Moderation(sdk);
final ModelsChatSnapshots response = wrapper.publicGetChatSnapshot(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'chat'
- 'get'
- 'moderation'
- 'public'
- 'snapshot'
'PublicGetConfigV1@jv.chat.fun':
id: 'PublicGetConfigV1@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.config.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/config/PublicGetConfigV1.java'
example: |-
try {
final PublicGetConfigV1 operation = PublicGetConfigV1.builder()
.build(
namespace,
);
final Config wrapper = new Config(sdk);
final ModelsPublicConfigResponse response = wrapper.publicGetConfigV1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'config'
- 'get'
- 'public'
- 'v1'
'PublicGetMessages@jv.chat.fun':
id: 'PublicGetMessages@jv.chat.fun'
name: 'PublicGetMessages'
type: 'function'
description: |-
get the list of messages.
return_type: 'List<LogAppMessageDeclaration>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.operations.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Operations.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/operations/PublicGetMessages.java'
example: |-
try {
final PublicGetMessages operation = PublicGetMessages.builder()
.build();
final Operations wrapper = new Operations(sdk);
final List<LogAppMessageDeclaration> response = wrapper.publicGetMessages(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'messages'
- 'public'
'PublicGetMutedTopics@jv.chat.fun':
id: 'PublicGetMutedTopics@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/PublicGetMutedTopics.java'
example: |-
try {
final PublicGetMutedTopics operation = PublicGetMutedTopics.builder()
.build(
namespace,
);
final Topic wrapper = new Topic(sdk);
final List<ApiMutedTopicResponse> response = wrapper.publicGetMutedTopics(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'muted'
- 'public'
- 'topic'
- 'topics'
'PublicMuteUser@jv.chat.fun':
id: 'PublicMuteUser@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/PublicMuteUser.java'
example: |-
try {
final PublicMuteUser operation = PublicMuteUser.builder()
.build(
body,
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
wrapper.publicMuteUser(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'mute'
- 'public'
- 'topic'
- 'user'
'PublicTopicList@jv.chat.fun':
id: 'PublicTopicList@jv.chat.fun'
name: 'PublicTopicList'
type: 'function'
description: |-
get chat list of topic in a namespace.
arguments:
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
namespace
'offset':
type: 'Integer'
required: false
description: |-
offset
'topicType':
type: 'String'
required: false
description: |-
PERSONAL or GROUP
return_type: 'List<ModelsChatMessageResponse>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/PublicTopicList.java'
example: |-
try {
final PublicTopicList operation = PublicTopicList.builder()
.limit(...)
.offset(...)
.topicType(...)
.build(
namespace,
);
final Topic wrapper = new Topic(sdk);
final List<ModelsChatMessageResponse> response = wrapper.publicTopicList(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'list'
- 'public'
- 'topic'
'PublicUnbanTopicMembers@jv.chat.fun':
id: 'PublicUnbanTopicMembers@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/PublicUnbanTopicMembers.java'
example: |-
try {
final PublicUnbanTopicMembers operation = PublicUnbanTopicMembers.builder()
.build(
body,
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
final ModelsPublicUnbanTopicMembersResponse response = wrapper.publicUnbanTopicMembers(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'members'
- 'public'
- 'topic'
- 'unban'
'PublicUnmuteUser@jv.chat.fun':
id: 'PublicUnmuteUser@jv.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:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.chat.models.*;'
- 'import net.accelbyte.sdk.api.chat.operations.topic.*;'
- 'import net.accelbyte.sdk.api.chat.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/wrappers/Topic.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/chat/operations/topic/PublicUnmuteUser.java'
example: |-
try {
final PublicUnmuteUser operation = PublicUnmuteUser.builder()
.build(
body,
namespace,
topic,
);
final Topic wrapper = new Topic(sdk);
wrapper.publicUnmuteUser(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'public'
- 'topic'
- 'unmute'
- 'user'
# endregion functions