symbols:
'NewChatClient@go.chat.fun':
id: 'NewChatClient@go.chat.fun'
name: 'NewChatClient'
type: 'function'
arguments:
configRepository:
type: 'repository.ConfigRepository'
return_type: '*chatclient.JusticeChatService'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-modular-sdk/chat-sdk/pkg/chatclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/justice_chat_service_client.go'
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/factory/chatclientfactory.go'
example: |-
chatClient := factory.NewChatClient(configRepo)
# region wrappers
'EmptyService@go.chat.mod':
id: 'EmptyService@go.chat.mod'
name: 'EmptyService'
type: 'model'
fields:
Client:
type: '*chatclient.JusticeChatService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/.go'
example: |-
chatClient := factory.NewChatClient(configRepo) // re-use if it exists already
Service := EmptyService{
Client: chatClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'ConfigService@go.chat.mod':
id: 'ConfigService@go.chat.mod'
name: 'ConfigService'
type: 'model'
fields:
Client:
type: '*chatclient.JusticeChatService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/config.go'
example: |-
chatClient := factory.NewChatClient(configRepo) // re-use if it exists already
configService := ConfigService{
Client: chatClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'InboxService@go.chat.mod':
id: 'InboxService@go.chat.mod'
name: 'InboxService'
type: 'model'
fields:
Client:
type: '*chatclient.JusticeChatService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
chatClient := factory.NewChatClient(configRepo) // re-use if it exists already
inboxService := InboxService{
Client: chatClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'ModerationService@go.chat.mod':
id: 'ModerationService@go.chat.mod'
name: 'ModerationService'
type: 'model'
fields:
Client:
type: '*chatclient.JusticeChatService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/moderation.go'
example: |-
chatClient := factory.NewChatClient(configRepo) // re-use if it exists already
moderationService := ModerationService{
Client: chatClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'ProfanityService@go.chat.mod':
id: 'ProfanityService@go.chat.mod'
name: 'ProfanityService'
type: 'model'
fields:
Client:
type: '*chatclient.JusticeChatService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/profanity.go'
example: |-
chatClient := factory.NewChatClient(configRepo) // re-use if it exists already
profanityService := ProfanityService{
Client: chatClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'TopicService@go.chat.mod':
id: 'TopicService@go.chat.mod'
name: 'TopicService'
type: 'model'
fields:
Client:
type: '*chatclient.JusticeChatService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
chatClient := factory.NewChatClient(configRepo) // re-use if it exists already
topicService := TopicService{
Client: chatClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
# endregion wrappers
# region params
'AdminAddInboxCategoryParams@go.chat.mod':
id: 'AdminAddInboxCategoryParams@go.chat.mod'
name: 'AdminAddInboxCategoryParams'
type: 'model'
fields:
'Body':
type: '*ModelsAddInboxCategoryRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_add_inbox_category_parameters.go'
'AdminAddTopicMemberParams@go.chat.mod':
id: 'AdminAddTopicMemberParams@go.chat.mod'
name: 'AdminAddTopicMemberParams'
type: 'model'
fields:
'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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_add_topic_member_parameters.go'
'AdminBanTopicMembersParams@go.chat.mod':
id: 'AdminBanTopicMembersParams@go.chat.mod'
name: 'AdminBanTopicMembersParams'
type: 'model'
fields:
'Body':
type: '*ModelsBanTopicMemberParam'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_ban_topic_members_parameters.go'
'AdminChannelTopicInfoParams@go.chat.mod':
id: 'AdminChannelTopicInfoParams@go.chat.mod'
name: 'AdminChannelTopicInfoParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_channel_topic_info_parameters.go'
'AdminChannelTopicListParams@go.chat.mod':
id: 'AdminChannelTopicListParams@go.chat.mod'
name: 'AdminChannelTopicListParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
offset
'TopicName':
type: 'string'
required: false
description: |-
name
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_channel_topic_list_parameters.go'
'AdminChannelTopicSummaryParams@go.chat.mod':
id: 'AdminChannelTopicSummaryParams@go.chat.mod'
name: 'AdminChannelTopicSummaryParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_channel_topic_summary_parameters.go'
'AdminChatHistoryParams@go.chat.mod':
id: 'AdminChatHistoryParams@go.chat.mod'
name: 'AdminChatHistoryParams'
type: 'model'
fields:
'ChatID':
type: '[]string'
required: false
description: |-
chat ID of chat
'EndCreatedAt':
type: 'int64'
required: false
description: |-
end date
'Keyword':
type: 'string'
required: false
description: |-
keyword containing in message
'Limit':
type: 'int64'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
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: 'int64'
required: false
description: |-
start date
'Topic':
type: '[]string'
required: false
description: |-
topic ID that receive the chat
'Unfiltered':
type: 'bool'
required: false
description: |-
unfiltered chat messages
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_chat_history_parameters.go'
'AdminCreateNamespaceTopicParams@go.chat.mod':
id: 'AdminCreateNamespaceTopicParams@go.chat.mod'
name: 'AdminCreateNamespaceTopicParams'
type: 'model'
fields:
'Body':
type: '*APICreateNamespaceTopicParams'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_create_namespace_topic_parameters.go'
'AdminCreateTopicParams@go.chat.mod':
id: 'AdminCreateTopicParams@go.chat.mod'
name: 'AdminCreateTopicParams'
type: 'model'
fields:
'Body':
type: '*APICreateTopicParams'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_create_topic_parameters.go'
'AdminDeleteChatParams@go.chat.mod':
id: 'AdminDeleteChatParams@go.chat.mod'
name: 'AdminDeleteChatParams'
type: 'model'
fields:
'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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_delete_chat_parameters.go'
'AdminDeleteChatSnapshotParams@go.chat.mod':
id: 'AdminDeleteChatSnapshotParams@go.chat.mod'
name: 'AdminDeleteChatSnapshotParams'
type: 'model'
fields:
'ChatID':
type: 'string'
required: true
description: |-
id of the chat
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/moderation'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/moderation/admin_delete_chat_snapshot_parameters.go'
'AdminDeleteInboxCategoryParams@go.chat.mod':
id: 'AdminDeleteInboxCategoryParams@go.chat.mod'
name: 'AdminDeleteInboxCategoryParams'
type: 'model'
fields:
'Category':
type: 'string'
required: true
description: |-
category
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_delete_inbox_category_parameters.go'
'AdminDeleteInboxMessageParams@go.chat.mod':
id: 'AdminDeleteInboxMessageParams@go.chat.mod'
name: 'AdminDeleteInboxMessageParams'
type: 'model'
fields:
'Force':
type: 'bool'
required: false
description: |-
only for testing purposes, to force delete data
'MessageID':
type: 'string'
required: true
description: |-
message
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_delete_inbox_message_parameters.go'
'AdminDeleteTopicParams@go.chat.mod':
id: 'AdminDeleteTopicParams@go.chat.mod'
name: 'AdminDeleteTopicParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_delete_topic_parameters.go'
'AdminFilterChatMessageParams@go.chat.mod':
id: 'AdminFilterChatMessageParams@go.chat.mod'
name: 'AdminFilterChatMessageParams'
type: 'model'
fields:
'Body':
type: '*ModelsMessageRequest'
required: true
'Detail':
type: 'bool'
required: false
description: |-
To show what filter driver is used
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_filter_chat_message_parameters.go'
'AdminGetAllConfigV1Params@go.chat.mod':
id: 'AdminGetAllConfigV1Params@go.chat.mod'
name: 'AdminGetAllConfigV1Params'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/config/admin_get_all_config_v1_parameters.go'
'AdminGetCategorySchemaParams@go.chat.mod':
id: 'AdminGetCategorySchemaParams@go.chat.mod'
name: 'AdminGetCategorySchemaParams'
type: 'model'
fields:
'Category':
type: 'string'
required: true
description: |-
category
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_get_category_schema_parameters.go'
'AdminGetChatSnapshotParams@go.chat.mod':
id: 'AdminGetChatSnapshotParams@go.chat.mod'
name: 'AdminGetChatSnapshotParams'
type: 'model'
fields:
'ChatID':
type: 'string'
required: true
description: |-
id of the chat
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/moderation'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/moderation/admin_get_chat_snapshot_parameters.go'
'AdminGetConfigV1Params@go.chat.mod':
id: 'AdminGetConfigV1Params@go.chat.mod'
name: 'AdminGetConfigV1Params'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/config/admin_get_config_v1_parameters.go'
'AdminGetInboxCategoriesParams@go.chat.mod':
id: 'AdminGetInboxCategoriesParams@go.chat.mod'
name: 'AdminGetInboxCategoriesParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_get_inbox_categories_parameters.go'
'AdminGetInboxMessagesParams@go.chat.mod':
id: 'AdminGetInboxMessagesParams@go.chat.mod'
name: 'AdminGetInboxMessagesParams'
type: 'model'
fields:
'ActiveOnly':
type: 'bool'
required: false
description: |-
active only
'EndCreatedAt':
type: 'int64'
required: false
description: |-
end created at
'Limit':
type: 'int64'
required: false
description: |-
limit
'MessageID':
type: '[]string'
required: false
description: |-
message ids
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
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: 'int64'
required: false
description: |-
start created at
'Status':
type: 'string'
required: false
description: |-
message status
'Transient':
type: 'bool'
required: false
description: |-
transient message filter
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_get_inbox_messages_parameters.go'
'AdminGetInboxStatsParams@go.chat.mod':
id: 'AdminGetInboxStatsParams@go.chat.mod'
name: 'AdminGetInboxStatsParams'
type: 'model'
fields:
'MessageID':
type: '[]string'
required: false
description: |-
message ids
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_get_inbox_stats_parameters.go'
'AdminGetInboxUsersParams@go.chat.mod':
id: 'AdminGetInboxUsersParams@go.chat.mod'
name: 'AdminGetInboxUsersParams'
type: 'model'
fields:
'Inbox':
type: 'string'
required: true
description: |-
message id
'Limit':
type: 'int64'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
offset
'Status':
type: 'string'
required: false
description: |-
message status
'UserID':
type: 'string'
required: false
description: |-
userId
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_get_inbox_users_parameters.go'
'AdminGetLogConfigParams@go.chat.mod':
id: 'AdminGetLogConfigParams@go.chat.mod'
name: 'AdminGetLogConfigParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/config/admin_get_log_config_parameters.go'
'AdminListKafkaTopicParams@go.chat.mod':
id: 'AdminListKafkaTopicParams@go.chat.mod'
name: 'AdminListKafkaTopicParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_list_kafka_topic_parameters.go'
'AdminPatchUpdateLogConfigParams@go.chat.mod':
id: 'AdminPatchUpdateLogConfigParams@go.chat.mod'
name: 'AdminPatchUpdateLogConfigParams'
type: 'model'
fields:
'Body':
type: '*LogconfigConfiguration'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/config/admin_patch_update_log_config_parameters.go'
'AdminProfanityCreateParams@go.chat.mod':
id: 'AdminProfanityCreateParams@go.chat.mod'
name: 'AdminProfanityCreateParams'
type: 'model'
fields:
'Body':
type: '*ModelsDictionaryInsertRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/profanity/admin_profanity_create_parameters.go'
'AdminProfanityCreateBulkParams@go.chat.mod':
id: 'AdminProfanityCreateBulkParams@go.chat.mod'
name: 'AdminProfanityCreateBulkParams'
type: 'model'
fields:
'Body':
type: '*ModelsDictionaryInsertBulkRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/profanity/admin_profanity_create_bulk_parameters.go'
'AdminProfanityDeleteParams@go.chat.mod':
id: 'AdminProfanityDeleteParams@go.chat.mod'
name: 'AdminProfanityDeleteParams'
type: 'model'
fields:
'ID':
type: 'string'
required: true
description: |-
id of the dictionary
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/profanity/admin_profanity_delete_parameters.go'
'AdminProfanityExportParams@go.chat.mod':
id: 'AdminProfanityExportParams@go.chat.mod'
name: 'AdminProfanityExportParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/profanity/admin_profanity_export_parameters.go'
'AdminProfanityGroupParams@go.chat.mod':
id: 'AdminProfanityGroupParams@go.chat.mod'
name: 'AdminProfanityGroupParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
default: 100
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
offset
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/profanity/admin_profanity_group_parameters.go'
'AdminProfanityImportParams@go.chat.mod':
id: 'AdminProfanityImportParams@go.chat.mod'
name: 'AdminProfanityImportParams'
type: 'model'
fields:
'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: '[]byte'
required: true
description: |-
file to be imported
'Namespace':
type: 'string'
required: true
description: |-
namespace
'ShowResult':
type: 'bool'
required: false
description: |-
When showResult=true, this endpoint with returns imported words result
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/profanity/admin_profanity_import_parameters.go'
'AdminProfanityQueryParams@go.chat.mod':
id: 'AdminProfanityQueryParams@go.chat.mod'
name: 'AdminProfanityQueryParams'
type: 'model'
fields:
'FilterMask':
type: 'string'
required: false
description: |-
filter mask
'IncludeChildren':
type: 'bool'
required: false
description: |-
include false positives and false negatives
'Limit':
type: 'int64'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/profanity/admin_profanity_query_parameters.go'
'AdminProfanityUpdateParams@go.chat.mod':
id: 'AdminProfanityUpdateParams@go.chat.mod'
name: 'AdminProfanityUpdateParams'
type: 'model'
fields:
'Body':
type: '*ModelsDictionaryUpdateRequest'
required: true
'ID':
type: 'string'
required: true
description: |-
id of the dictionary
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/profanity/admin_profanity_update_parameters.go'
'AdminQueryTopicParams@go.chat.mod':
id: 'AdminQueryTopicParams@go.chat.mod'
name: 'AdminQueryTopicParams'
type: 'model'
fields:
'IncludeMembers':
type: 'bool'
required: false
description: |-
include topic's members
'IncludePastMembers':
type: 'bool'
required: false
description: |-
include past members (user that had left topic)
'IncludePastTopics':
type: 'bool'
required: false
description: |-
include topic that has been removed.<br/><b>NOTE:</b> only soft deleted topics are available
'Limit':
type: 'int64'
required: false
description: |-
default: 100
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
offset
'Topic':
type: '[]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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_query_topic_parameters.go'
'AdminQueryTopicLogParams@go.chat.mod':
id: 'AdminQueryTopicLogParams@go.chat.mod'
name: 'AdminQueryTopicLogParams'
type: 'model'
fields:
'EndCreatedAt':
type: 'int64'
required: false
description: |-
end date
'Limit':
type: 'int64'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
offset
'SenderUserID':
type: 'string'
required: false
description: |-
senderUserId (actor, can be admin or the user itself)
'StartCreatedAt':
type: 'int64'
required: false
description: |-
start date
'TopicID':
type: 'string'
required: false
description: |-
topicId
'TopicIds':
type: '[]string'
required: false
description: |-
topicIds
'UserID':
type: 'string'
required: false
description: |-
userId
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_query_topic_log_parameters.go'
'AdminQueryUsersTopicParams@go.chat.mod':
id: 'AdminQueryUsersTopicParams@go.chat.mod'
name: 'AdminQueryUsersTopicParams'
type: 'model'
fields:
'IncludePastTopics':
type: 'bool'
required: false
description: |-
when true will include topics that user already left
'Limit':
type: 'int64'
required: false
description: |-
default: 100
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_query_users_topic_parameters.go'
'AdminRemoveTopicMemberParams@go.chat.mod':
id: 'AdminRemoveTopicMemberParams@go.chat.mod'
name: 'AdminRemoveTopicMemberParams'
type: 'model'
fields:
'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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_remove_topic_member_parameters.go'
'AdminSaveInboxMessageParams@go.chat.mod':
id: 'AdminSaveInboxMessageParams@go.chat.mod'
name: 'AdminSaveInboxMessageParams'
type: 'model'
fields:
'Body':
type: '*ModelsSaveInboxMessageRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_save_inbox_message_parameters.go'
'AdminSendChatParams@go.chat.mod':
id: 'AdminSendChatParams@go.chat.mod'
name: 'AdminSendChatParams'
type: 'model'
fields:
'Body':
type: '*APISendChatParams'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_send_chat_parameters.go'
'AdminSendInboxMessageParams@go.chat.mod':
id: 'AdminSendInboxMessageParams@go.chat.mod'
name: 'AdminSendInboxMessageParams'
type: 'model'
fields:
'Body':
type: 'ModelsSendInboxMessageRequest'
required: true
'MessageID':
type: 'string'
required: true
description: |-
message
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_send_inbox_message_parameters.go'
'AdminTopicChatHistoryParams@go.chat.mod':
id: 'AdminTopicChatHistoryParams@go.chat.mod'
name: 'AdminTopicChatHistoryParams'
type: 'model'
fields:
'EndCreatedAt':
type: 'int64'
required: false
description: |-
end date
'Keyword':
type: 'string'
required: false
description: |-
keyword containing in message
'Limit':
type: 'int64'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
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: 'int64'
required: false
description: |-
start date
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
'Unfiltered':
type: 'bool'
required: false
description: |-
unfiltered chat messages
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_topic_chat_history_parameters.go'
'AdminTopicListParams@go.chat.mod':
id: 'AdminTopicListParams@go.chat.mod'
name: 'AdminTopicListParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
offset
'TopicType':
type: 'string'
required: false
description: |-
PERSONAL or GROUP
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_topic_list_parameters.go'
'AdminTopicMembersParams@go.chat.mod':
id: 'AdminTopicMembersParams@go.chat.mod'
name: 'AdminTopicMembersParams'
type: 'model'
fields:
'IsBanned':
type: 'bool'
required: false
description: |-
only show banned member
'IsModerator':
type: 'bool'
required: false
description: |-
only show moderator member
'Limit':
type: 'int64'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
offset
'ShardID':
type: 'string'
required: false
description: |-
shard ID
'Topic':
type: 'string'
required: true
description: |-
topic ID
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_topic_members_parameters.go'
'AdminTopicShardsParams@go.chat.mod':
id: 'AdminTopicShardsParams@go.chat.mod'
name: 'AdminTopicShardsParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_topic_shards_parameters.go'
'AdminUnbanTopicMembersParams@go.chat.mod':
id: 'AdminUnbanTopicMembersParams@go.chat.mod'
name: 'AdminUnbanTopicMembersParams'
type: 'model'
fields:
'Body':
type: '*ModelsUnbanTopicMemberParam'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_unban_topic_members_parameters.go'
'AdminUnsendInboxMessageParams@go.chat.mod':
id: 'AdminUnsendInboxMessageParams@go.chat.mod'
name: 'AdminUnsendInboxMessageParams'
type: 'model'
fields:
'Body':
type: '*ModelsUnsendInboxMessageRequest'
required: true
'Inbox':
type: 'string'
required: true
description: |-
message
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_unsend_inbox_message_parameters.go'
'AdminUpdateConfigV1Params@go.chat.mod':
id: 'AdminUpdateConfigV1Params@go.chat.mod'
name: 'AdminUpdateConfigV1Params'
type: 'model'
fields:
'Body':
type: '*ModelsConfigResponse'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/config/admin_update_config_v1_parameters.go'
'AdminUpdateInboxCategoryParams@go.chat.mod':
id: 'AdminUpdateInboxCategoryParams@go.chat.mod'
name: 'AdminUpdateInboxCategoryParams'
type: 'model'
fields:
'Body':
type: '*ModelsUpdateInboxCategoryRequest'
required: true
'Category':
type: 'string'
required: true
description: |-
category
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_update_inbox_category_parameters.go'
'AdminUpdateInboxMessageParams@go.chat.mod':
id: 'AdminUpdateInboxMessageParams@go.chat.mod'
name: 'AdminUpdateInboxMessageParams'
type: 'model'
fields:
'Body':
type: '*ModelsUpdateInboxMessageRequest'
required: true
'MessageID':
type: 'string'
required: true
description: |-
message
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/inbox/admin_update_inbox_message_parameters.go'
'AdminUpdateTopicParams@go.chat.mod':
id: 'AdminUpdateTopicParams@go.chat.mod'
name: 'AdminUpdateTopicParams'
type: 'model'
fields:
'Body':
type: '*APIUpdateTopicParams'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/admin_update_topic_parameters.go'
'ExportConfigParams@go.chat.mod':
id: 'ExportConfigParams@go.chat.mod'
name: 'ExportConfigParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/config/export_config_parameters.go'
'ImportConfigParams@go.chat.mod':
id: 'ImportConfigParams@go.chat.mod'
name: 'ImportConfigParams'
type: 'model'
fields:
'File':
type: '[]byte'
required: false
description: |-
file to be imported
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/config/import_config_parameters.go'
'PublicBanTopicMembersParams@go.chat.mod':
id: 'PublicBanTopicMembersParams@go.chat.mod'
name: 'PublicBanTopicMembersParams'
type: 'model'
fields:
'Body':
type: '*ModelsPublicBanTopicMembersRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/public_ban_topic_members_parameters.go'
'PublicChatHistoryParams@go.chat.mod':
id: 'PublicChatHistoryParams@go.chat.mod'
name: 'PublicChatHistoryParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Order':
type: 'string'
required: false
description: |-
anyof: createdAt:asc / createdAt:desc
'StartCreatedAt':
type: 'int64'
required: false
description: |-
lastChatCreatedAt
'Topic':
type: 'string'
required: true
description: |-
topic ID that receive the chat
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/public_chat_history_parameters.go'
'PublicDeleteChatParams@go.chat.mod':
id: 'PublicDeleteChatParams@go.chat.mod'
name: 'PublicDeleteChatParams'
type: 'model'
fields:
'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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/public_delete_chat_parameters.go'
'PublicGetChatSnapshotParams@go.chat.mod':
id: 'PublicGetChatSnapshotParams@go.chat.mod'
name: 'PublicGetChatSnapshotParams'
type: 'model'
fields:
'ChatID':
type: 'string'
required: true
description: |-
id of the chat
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/moderation'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/moderation/public_get_chat_snapshot_parameters.go'
'PublicGetConfigV1Params@go.chat.mod':
id: 'PublicGetConfigV1Params@go.chat.mod'
name: 'PublicGetConfigV1Params'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/config/public_get_config_v1_parameters.go'
'PublicGetMessagesParams@go.chat.mod':
id: 'PublicGetMessagesParams@go.chat.mod'
name: 'PublicGetMessagesParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient//public_get_messages_parameters.go'
'PublicGetMutedTopicsParams@go.chat.mod':
id: 'PublicGetMutedTopicsParams@go.chat.mod'
name: 'PublicGetMutedTopicsParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
description: |-
namespace
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/public_get_muted_topics_parameters.go'
'PublicMuteUserParams@go.chat.mod':
id: 'PublicMuteUserParams@go.chat.mod'
name: 'PublicMuteUserParams'
type: 'model'
fields:
'Body':
type: '*APIMuteUserRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/public_mute_user_parameters.go'
'PublicTopicListParams@go.chat.mod':
id: 'PublicTopicListParams@go.chat.mod'
name: 'PublicTopicListParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Offset':
type: 'int64'
required: false
description: |-
offset
'TopicType':
type: 'string'
required: false
description: |-
PERSONAL or GROUP
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/public_topic_list_parameters.go'
'PublicUnbanTopicMembersParams@go.chat.mod':
id: 'PublicUnbanTopicMembersParams@go.chat.mod'
name: 'PublicUnbanTopicMembersParams'
type: 'model'
fields:
'Body':
type: '*ModelsPublicUnbanTopicMembersRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/public_unban_topic_members_parameters.go'
'PublicUnmuteUserParams@go.chat.mod':
id: 'PublicUnmuteUserParams@go.chat.mod'
name: 'PublicUnmuteUserParams'
type: 'model'
fields:
'Body':
type: '*APIUnmuteUserRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace
'Topic':
type: 'string'
required: true
description: |-
topic ID
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclient/topic/public_unmute_user_parameters.go'
# endregion params
# region models
'APIAddMemberParams@go.chat.mod':
id: 'APIAddMemberParams@go.chat.mod'
name: 'APIAddMemberParams'
type: 'model'
fields:
'IsAdmin':
type: 'bool'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/api_add_member_params.go'
'APICreateNamespaceTopicParams@go.chat.mod':
id: 'APICreateNamespaceTopicParams@go.chat.mod'
name: 'APICreateNamespaceTopicParams'
type: 'model'
fields:
'Description':
type: 'string'
required: true
'Name':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/api_create_namespace_topic_params.go'
'APICreateTopicParams@go.chat.mod':
id: 'APICreateTopicParams@go.chat.mod'
name: 'APICreateTopicParams'
type: 'model'
fields:
'Admins':
type: '[]string'
required: true
'Description':
type: 'string'
required: true
'IsChannel':
type: 'bool'
required: true
'IsJoinable':
type: 'bool'
required: true
'Members':
type: '[]string'
required: true
'Name':
type: 'string'
required: true
'ShardLimit':
type: 'int32'
required: false
'Type':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/api_create_topic_params.go'
'APICreateTopicResponse@go.chat.mod':
id: 'APICreateTopicResponse@go.chat.mod'
name: 'APICreateTopicResponse'
type: 'model'
fields:
'CreatedAt':
type: 'int64'
required: true
'CreatedBy':
type: 'string'
required: true
'Description':
type: 'string'
required: true
'IsChannel':
type: 'bool'
required: true
'IsJoinable':
type: 'bool'
required: true
'Name':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'TopicID':
type: 'string'
required: true
'Type':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/api_create_topic_response.go'
'APIMutedTopicResponse@go.chat.mod':
id: 'APIMutedTopicResponse@go.chat.mod'
name: 'APIMutedTopicResponse'
type: 'model'
fields:
'ExpirationTime':
type: 'int64'
required: true
'RemainingTime':
type: 'int64'
required: true
'TopicID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/api_muted_topic_response.go'
'APIMuteUserRequest@go.chat.mod':
id: 'APIMuteUserRequest@go.chat.mod'
name: 'APIMuteUserRequest'
type: 'model'
fields:
'Duration':
type: 'int32'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/api_mute_user_request.go'
'APISendChatParams@go.chat.mod':
id: 'APISendChatParams@go.chat.mod'
name: 'APISendChatParams'
type: 'model'
fields:
'Message':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/api_send_chat_params.go'
'APIUnmuteUserRequest@go.chat.mod':
id: 'APIUnmuteUserRequest@go.chat.mod'
name: 'APIUnmuteUserRequest'
type: 'model'
fields:
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/api_unmute_user_request.go'
'APIUpdateTopicParams@go.chat.mod':
id: 'APIUpdateTopicParams@go.chat.mod'
name: 'APIUpdateTopicParams'
type: 'model'
fields:
'Description':
type: 'string'
required: true
'IsJoinable':
type: 'bool'
required: true
'Name':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/api_update_topic_params.go'
'LogAppMessageDeclaration@go.chat.mod':
id: 'LogAppMessageDeclaration@go.chat.mod'
name: 'LogAppMessageDeclaration'
type: 'model'
fields:
'Attributes':
type: '[]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:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/log_app_message_declaration.go'
'LogconfigConfiguration@go.chat.mod':
id: 'LogconfigConfiguration@go.chat.mod'
name: 'LogconfigConfiguration'
type: 'model'
fields:
'InternalAccessLogEnabled':
type: 'bool'
required: false
'LogLevel':
type: 'string'
required: false
'LogLevelDB':
type: 'string'
required: false
'SlowQueryThreshold':
type: 'int64'
required: false
'SocketLogEnabled':
type: 'bool'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/logconfig_configuration.go'
'MessageActionAddUserToTopicResult@go.chat.mod':
id: 'MessageActionAddUserToTopicResult@go.chat.mod'
name: 'MessageActionAddUserToTopicResult'
type: 'model'
fields:
'Processed':
type: 'int64'
required: true
'TopicID':
type: 'string'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/message_action_add_user_to_topic_result.go'
'MessageActionDeleteTopicResult@go.chat.mod':
id: 'MessageActionDeleteTopicResult@go.chat.mod'
name: 'MessageActionDeleteTopicResult'
type: 'model'
fields:
'Processed':
type: 'int64'
required: true
'TopicID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/message_action_delete_topic_result.go'
'ModelsAddInboxCategoryRequest@go.chat.mod':
id: 'ModelsAddInboxCategoryRequest@go.chat.mod'
name: 'ModelsAddInboxCategoryRequest'
type: 'model'
fields:
'Enabled':
type: 'bool'
required: true
'ExpiresIn':
type: 'int64'
required: true
'Hook':
type: '*ModelsCategoryHook'
required: false
'JSONSchema':
type: 'interface{}'
required: false
'Name':
type: 'string'
required: true
'SaveInbox':
type: 'bool'
required: true
'SendNotification':
type: 'bool'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_add_inbox_category_request.go'
'ModelsAddInboxCategoryResponse@go.chat.mod':
id: 'ModelsAddInboxCategoryResponse@go.chat.mod'
name: 'ModelsAddInboxCategoryResponse'
type: 'model'
fields:
'Enabled':
type: 'bool'
required: true
'ExpiresIn':
type: 'int64'
required: true
'Hook':
type: '*ModelsCategoryHook'
required: false
'JSONSchema':
type: 'interface{}'
required: false
'Name':
type: 'string'
required: true
'SaveInbox':
type: 'bool'
required: true
'SendNotification':
type: 'bool'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_add_inbox_category_response.go'
'ModelsBanTopicMemberParam@go.chat.mod':
id: 'ModelsBanTopicMemberParam@go.chat.mod'
name: 'ModelsBanTopicMemberParam'
type: 'model'
fields:
'UserIds':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_ban_topic_member_param.go'
'ModelsBanTopicMemberResult@go.chat.mod':
id: 'ModelsBanTopicMemberResult@go.chat.mod'
name: 'ModelsBanTopicMemberResult'
type: 'model'
fields:
'UserIds':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_ban_topic_member_result.go'
'ModelsCategoryHook@go.chat.mod':
id: 'ModelsCategoryHook@go.chat.mod'
name: 'ModelsCategoryHook'
type: 'model'
fields:
'Driver':
type: 'string'
required: false
'Params':
type: 'interface{}'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_category_hook.go'
'ModelsChannelTopicResponse@go.chat.mod':
id: 'ModelsChannelTopicResponse@go.chat.mod'
name: 'ModelsChannelTopicResponse'
type: 'model'
fields:
'CreatedAt':
type: 'int64'
required: true
'CreatedBy':
type: 'string'
required: true
'Description':
type: 'string'
required: true
'IsJoinable':
type: 'bool'
required: true
'MessagePerMinutes':
type: 'float64'
required: true
'Name':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'ShardLimit':
type: 'int32'
required: true
'ShardNumber':
type: 'int32'
required: true
'TopicID':
type: 'string'
required: true
'TotalMember':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_channel_topic_response.go'
'ModelsChannelTopicSummaryResponse@go.chat.mod':
id: 'ModelsChannelTopicSummaryResponse@go.chat.mod'
name: 'ModelsChannelTopicSummaryResponse'
type: 'model'
fields:
'TotalChannel':
type: 'int32'
required: true
'TotalShard':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_channel_topic_summary_response.go'
'ModelsChannelTopicWithPaginationResponse@go.chat.mod':
id: 'ModelsChannelTopicWithPaginationResponse@go.chat.mod'
name: 'ModelsChannelTopicWithPaginationResponse'
type: 'model'
fields:
'Data':
type: '[]*ModelsChannelTopicResponse'
required: true
'Paging':
type: '*ModelsPagination'
required: true
'TotalData':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_channel_topic_with_pagination_response.go'
'ModelsChatMessageResponse@go.chat.mod':
id: 'ModelsChatMessageResponse@go.chat.mod'
name: 'ModelsChatMessageResponse'
type: 'model'
fields:
'From':
type: 'string'
required: true
'ID':
type: 'string'
required: true
'Message':
type: 'string'
required: true
'ReadAt':
type: 'int64'
required: false
'ReceivedAt':
type: 'int64'
required: false
'TopicID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_chat_message_response.go'
'ModelsChatMessageWithPaginationResponse@go.chat.mod':
id: 'ModelsChatMessageWithPaginationResponse@go.chat.mod'
name: 'ModelsChatMessageWithPaginationResponse'
type: 'model'
fields:
'Data':
type: '[]*ModelsChatMessageResponse'
required: true
'Paging':
type: '*ModelsPagination'
required: true
'TotalData':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_chat_message_with_pagination_response.go'
'ModelsChatSnapshotMessage@go.chat.mod':
id: 'ModelsChatSnapshotMessage@go.chat.mod'
name: 'ModelsChatSnapshotMessage'
type: 'model'
fields:
'ChatID':
type: 'string'
required: true
'CreatedAt':
type: 'int64'
required: true
'Message':
type: 'string'
required: true
'SenderID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_chat_snapshot_message.go'
'ModelsChatSnapshots@go.chat.mod':
id: 'ModelsChatSnapshots@go.chat.mod'
name: 'ModelsChatSnapshots'
type: 'model'
fields:
'ChatID':
type: 'string'
required: true
'CreatedAt':
type: 'int64'
required: true
'JoinedTopics':
type: '[]string'
required: true
'Messages':
type: '[]*ModelsChatSnapshotMessage'
required: true
'Namespace':
type: 'string'
required: true
'SenderID':
type: 'string'
required: true
'TicketID':
type: 'string'
required: true
'TopicID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_chat_snapshots.go'
'ModelsConfig@go.chat.mod':
id: 'ModelsConfig@go.chat.mod'
name: 'ModelsConfig'
type: 'model'
fields:
'ChatRateLimitBurst':
type: 'int32'
required: true
'ChatRateLimitDuration':
type: 'int64'
required: true
'ConcurrentUsersLimit':
type: 'int32'
required: true
'DefaultDictionaryLoaded':
type: 'bool'
required: false
'EnableClanChat':
type: 'bool'
required: false
'EnableManualTopicCreation':
type: 'bool'
required: false
'EnablePmSendPlatformID':
type: 'bool'
required: false
'EnableProfanityFilter':
type: 'bool'
required: true
'FilterAppName':
type: 'string'
required: true
'FilterParam':
type: 'string'
required: true
'FilterType':
type: 'string'
required: true
'GeneralRateLimitBurst':
type: 'int32'
required: true
'GeneralRateLimitDuration':
type: 'int64'
required: true
'MaxChatMessageLength':
type: 'int32'
required: false
'Namespace':
type: 'string'
required: true
'ShardCapacityLimit':
type: 'int32'
required: true
'ShardDefaultLimit':
type: 'int32'
required: true
'ShardHardLimit':
type: 'int32'
required: true
'SpamChatBurst':
type: 'int32'
required: true
'SpamChatDuration':
type: 'int64'
required: true
'SpamMuteDuration':
type: 'int64'
required: true
'UseDefaultDictionary':
type: 'bool'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_config.go'
'ModelsConfigExport@go.chat.mod':
id: 'ModelsConfigExport@go.chat.mod'
name: 'ModelsConfigExport'
type: 'model'
fields:
'ChatRateLimitBurst':
type: 'int32'
required: true
'ChatRateLimitDuration':
type: 'int64'
required: true
'ConcurrentUsersLimit':
type: 'int32'
required: true
'EnableClanChat':
type: 'bool'
required: false
'EnableManualTopicCreation':
type: 'bool'
required: false
'EnablePmSendPlatformID':
type: 'bool'
required: false
'EnableProfanityFilter':
type: 'bool'
required: false
'FilterAppName':
type: 'string'
required: false
'FilterParam':
type: 'string'
required: false
'FilterType':
type: 'string'
required: false
'GeneralRateLimitBurst':
type: 'int32'
required: true
'GeneralRateLimitDuration':
type: 'int64'
required: true
'Namespace':
type: 'string'
required: true
'ShardCapacityLimit':
type: 'int32'
required: false
'ShardDefaultLimit':
type: 'int32'
required: false
'ShardHardLimit':
type: 'int32'
required: false
'SpamChatBurst':
type: 'int32'
required: false
'SpamChatDuration':
type: 'int64'
required: false
'SpamMuteDuration':
type: 'int64'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_config_export.go'
'ModelsConfigList@go.chat.mod':
id: 'ModelsConfigList@go.chat.mod'
name: 'ModelsConfigList'
type: 'model'
fields:
'Configs':
type: '[]*ModelsConfig'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_config_list.go'
'ModelsConfigResponse@go.chat.mod':
id: 'ModelsConfigResponse@go.chat.mod'
name: 'ModelsConfigResponse'
type: 'model'
fields:
'ChatRateLimitBurst':
type: 'int32'
required: false
'ChatRateLimitDuration':
type: 'int64'
required: false
'ConcurrentUsersLimit':
type: 'int32'
required: false
'EnableClanChat':
type: 'bool'
required: false
'EnableManualTopicCreation':
type: 'bool'
required: false
'EnablePmSendPlatformID':
type: 'bool'
required: false
'EnableProfanityFilter':
type: 'bool'
required: false
'FilterAppName':
type: 'string'
required: false
'FilterParam':
type: 'string'
required: false
'FilterType':
type: 'string'
required: false
'GeneralRateLimitBurst':
type: 'int32'
required: false
'GeneralRateLimitDuration':
type: 'int64'
required: false
'MaxChatMessageLength':
type: 'int32'
required: false
'ShardCapacityLimit':
type: 'int32'
required: false
'ShardDefaultLimit':
type: 'int32'
required: false
'ShardHardLimit':
type: 'int32'
required: false
'SpamChatBurst':
type: 'int32'
required: false
'SpamChatDuration':
type: 'int64'
required: false
'SpamMuteDuration':
type: 'int64'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_config_response.go'
'ModelsDictionary@go.chat.mod':
id: 'ModelsDictionary@go.chat.mod'
name: 'ModelsDictionary'
type: 'model'
fields:
'ID':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'ParentID':
type: 'string'
required: false
'Word':
type: 'string'
required: true
'WordType':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary.go'
'ModelsDictionaryChild@go.chat.mod':
id: 'ModelsDictionaryChild@go.chat.mod'
name: 'ModelsDictionaryChild'
type: 'model'
fields:
'ID':
type: 'string'
required: true
'Word':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary_child.go'
'ModelsDictionaryExport@go.chat.mod':
id: 'ModelsDictionaryExport@go.chat.mod'
name: 'ModelsDictionaryExport'
type: 'model'
fields:
'Dictionaries':
type: '[]*ModelsDictionaryExportItem'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary_export.go'
'ModelsDictionaryExportItem@go.chat.mod':
id: 'ModelsDictionaryExportItem@go.chat.mod'
name: 'ModelsDictionaryExportItem'
type: 'model'
fields:
'FalseNegative':
type: '[]string'
required: false
'FalsePositive':
type: '[]string'
required: false
'Word':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary_export_item.go'
'ModelsDictionaryGroup@go.chat.mod':
id: 'ModelsDictionaryGroup@go.chat.mod'
name: 'ModelsDictionaryGroup'
type: 'model'
fields:
'Count':
type: 'int32'
required: true
'Name':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary_group.go'
'ModelsDictionaryImportResult@go.chat.mod':
id: 'ModelsDictionaryImportResult@go.chat.mod'
name: 'ModelsDictionaryImportResult'
type: 'model'
fields:
'Words':
type: '*ModelsDictionaryWordChanges'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary_import_result.go'
'ModelsDictionaryInsertBulkRequest@go.chat.mod':
id: 'ModelsDictionaryInsertBulkRequest@go.chat.mod'
name: 'ModelsDictionaryInsertBulkRequest'
type: 'model'
fields:
'Dictionaries':
type: '[]*ModelsDictionaryInsertRequest'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary_insert_bulk_request.go'
'ModelsDictionaryInsertRequest@go.chat.mod':
id: 'ModelsDictionaryInsertRequest@go.chat.mod'
name: 'ModelsDictionaryInsertRequest'
type: 'model'
fields:
'FalseNegative':
type: '[]string'
required: true
'FalsePositive':
type: '[]string'
required: true
'Word':
type: 'string'
required: true
'WordType':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary_insert_request.go'
'ModelsDictionaryQueryResult@go.chat.mod':
id: 'ModelsDictionaryQueryResult@go.chat.mod'
name: 'ModelsDictionaryQueryResult'
type: 'model'
fields:
'Data':
type: '[]*ModelsDictionaryWithChildren'
required: true
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary_query_result.go'
'ModelsDictionaryUpdateRequest@go.chat.mod':
id: 'ModelsDictionaryUpdateRequest@go.chat.mod'
name: 'ModelsDictionaryUpdateRequest'
type: 'model'
fields:
'FalseNegative':
type: '[]string'
required: true
'FalsePositive':
type: '[]string'
required: true
'Word':
type: 'string'
required: true
'WordType':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary_update_request.go'
'ModelsDictionaryWithChildren@go.chat.mod':
id: 'ModelsDictionaryWithChildren@go.chat.mod'
name: 'ModelsDictionaryWithChildren'
type: 'model'
fields:
'FalseNegatives':
type: '[]*ModelsDictionaryChild'
required: false
'FalsePositives':
type: '[]*ModelsDictionaryChild'
required: false
'ID':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'ParentID':
type: 'string'
required: false
'Word':
type: 'string'
required: true
'WordType':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary_with_children.go'
'ModelsDictionaryWordChanges@go.chat.mod':
id: 'ModelsDictionaryWordChanges@go.chat.mod'
name: 'ModelsDictionaryWordChanges'
type: 'model'
fields:
'Added':
type: '[]string'
required: true
'Failed':
type: '[]string'
required: true
'Ignored':
type: '[]string'
required: true
'Replaced':
type: '[]string'
required: true
'Unchanged':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_dictionary_word_changes.go'
'ModelsGetInboxCategoriesResponseItem@go.chat.mod':
id: 'ModelsGetInboxCategoriesResponseItem@go.chat.mod'
name: 'ModelsGetInboxCategoriesResponseItem'
type: 'model'
fields:
'Enabled':
type: 'bool'
required: true
'ExpiresIn':
type: 'int64'
required: true
'Hook':
type: '*ModelsCategoryHook'
required: false
'JSONSchema':
type: 'interface{}'
required: false
'Name':
type: 'string'
required: true
'SaveInbox':
type: 'bool'
required: true
'SendNotification':
type: 'bool'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_get_inbox_categories_response_item.go'
'ModelsGetInboxMessagesResponse@go.chat.mod':
id: 'ModelsGetInboxMessagesResponse@go.chat.mod'
name: 'ModelsGetInboxMessagesResponse'
type: 'model'
fields:
'Data':
type: '[]*ModelsGetInboxMessagesResponseData'
required: true
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_get_inbox_messages_response.go'
'ModelsGetInboxMessagesResponseData@go.chat.mod':
id: 'ModelsGetInboxMessagesResponseData@go.chat.mod'
name: 'ModelsGetInboxMessagesResponseData'
type: 'model'
fields:
'Category':
type: 'string'
required: false
'CreatedAt':
type: 'int64'
required: true
'ExpiredAt':
type: 'int64'
required: true
'ID':
type: 'string'
required: true
'Message':
type: 'interface{}'
required: false
'Scope':
type: 'string'
required: true
'SenderID':
type: 'string'
required: true
'Status':
type: 'string'
required: true
'UpdatedAt':
type: 'int64'
required: true
'UserIds':
type: '[]string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_get_inbox_messages_response_data.go'
'ModelsGetInboxStatsResponse@go.chat.mod':
id: 'ModelsGetInboxStatsResponse@go.chat.mod'
name: 'ModelsGetInboxStatsResponse'
type: 'model'
fields:
'Data':
type: '[]*ModelsMessageStats'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_get_inbox_stats_response.go'
'ModelsGetInboxUsersResponse@go.chat.mod':
id: 'ModelsGetInboxUsersResponse@go.chat.mod'
name: 'ModelsGetInboxUsersResponse'
type: 'model'
fields:
'Data':
type: '[]*ModelsUserInbox'
required: true
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_get_inbox_users_response.go'
'ModelsGetListTopicKafkaResponse@go.chat.mod':
id: 'ModelsGetListTopicKafkaResponse@go.chat.mod'
name: 'ModelsGetListTopicKafkaResponse'
type: 'model'
fields:
'TopicName':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_get_list_topic_kafka_response.go'
'ModelsImportConfigResponse@go.chat.mod':
id: 'ModelsImportConfigResponse@go.chat.mod'
name: 'ModelsImportConfigResponse'
type: 'model'
fields:
'FailedConfigs':
type: '[]string'
required: true
'IgnoredConfigs':
type: '[]string'
required: true
'NewConfigs':
type: '[]string'
required: true
'ReplacedConfigs':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_import_config_response.go'
'ModelsJSONSchemaType@go.chat.mod':
id: 'ModelsJSONSchemaType@go.chat.mod'
name: 'ModelsJSONSchemaType'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_json_schema_type.go'
'ModelsMessageRequest@go.chat.mod':
id: 'ModelsMessageRequest@go.chat.mod'
name: 'ModelsMessageRequest'
type: 'model'
fields:
'Message':
type: 'string'
required: true
'Timestamp':
type: 'int64'
required: false
'TopicID':
type: 'string'
required: false
'TopicType':
type: 'string'
required: false
'UserID':
type: 'string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_message_request.go'
'ModelsMessageResultWithAttributes@go.chat.mod':
id: 'ModelsMessageResultWithAttributes@go.chat.mod'
name: 'ModelsMessageResultWithAttributes'
type: 'model'
fields:
'Action':
type: 'string'
required: true
'Attributes':
type: 'interface{}'
required: false
'CencoredWords':
type: '[]string'
required: false
'Classifications':
type: '[]string'
required: false
'FinalMessage':
type: 'string'
required: true
'ID':
type: 'string'
required: true
'ReferenceID':
type: 'string'
required: false
'Timestamp':
type: 'int64'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_message_result_with_attributes.go'
'ModelsMessageStats@go.chat.mod':
id: 'ModelsMessageStats@go.chat.mod'
name: 'ModelsMessageStats'
type: 'model'
fields:
'ID':
type: 'string'
required: true
'MessageRead':
type: 'int32'
required: true
'MessageStored':
type: 'int32'
required: true
'NotificationSent':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_message_stats.go'
'ModelsPagination@go.chat.mod':
id: 'ModelsPagination@go.chat.mod'
name: 'ModelsPagination'
type: 'model'
fields:
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_pagination.go'
'ModelsPublicBanTopicMembersRequest@go.chat.mod':
id: 'ModelsPublicBanTopicMembersRequest@go.chat.mod'
name: 'ModelsPublicBanTopicMembersRequest'
type: 'model'
fields:
'UserIDs':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_public_ban_topic_members_request.go'
'ModelsPublicBanTopicMembersResponse@go.chat.mod':
id: 'ModelsPublicBanTopicMembersResponse@go.chat.mod'
name: 'ModelsPublicBanTopicMembersResponse'
type: 'model'
fields:
'UserIDs':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_public_ban_topic_members_response.go'
'ModelsPublicConfigResponse@go.chat.mod':
id: 'ModelsPublicConfigResponse@go.chat.mod'
name: 'ModelsPublicConfigResponse'
type: 'model'
fields:
'ChatRateLimitBurst':
type: 'int32'
required: true
'ChatRateLimitDuration':
type: 'int64'
required: true
'EnablePmSendPlatformID':
type: 'bool'
required: false
'GeneralRateLimitBurst':
type: 'int32'
required: true
'GeneralRateLimitDuration':
type: 'int64'
required: true
'MaxChatMessageLength':
type: 'int32'
required: true
'SpamChatBurst':
type: 'int32'
required: true
'SpamChatDuration':
type: 'int64'
required: true
'SpamMuteDuration':
type: 'int64'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_public_config_response.go'
'ModelsPublicUnbanTopicMembersRequest@go.chat.mod':
id: 'ModelsPublicUnbanTopicMembersRequest@go.chat.mod'
name: 'ModelsPublicUnbanTopicMembersRequest'
type: 'model'
fields:
'UserIDs':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_public_unban_topic_members_request.go'
'ModelsPublicUnbanTopicMembersResponse@go.chat.mod':
id: 'ModelsPublicUnbanTopicMembersResponse@go.chat.mod'
name: 'ModelsPublicUnbanTopicMembersResponse'
type: 'model'
fields:
'UserIDs':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_public_unban_topic_members_response.go'
'ModelsSaveInboxMessageRequest@go.chat.mod':
id: 'ModelsSaveInboxMessageRequest@go.chat.mod'
name: 'ModelsSaveInboxMessageRequest'
type: 'model'
fields:
'Category':
type: 'string'
required: false
'ExpiredAt':
type: 'int64'
required: true
'Message':
type: 'interface{}'
required: true
'Scope':
type: 'string'
required: true
'Status':
type: 'string'
required: true
'UserIds':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_save_inbox_message_request.go'
'ModelsSaveInboxMessageResponse@go.chat.mod':
id: 'ModelsSaveInboxMessageResponse@go.chat.mod'
name: 'ModelsSaveInboxMessageResponse'
type: 'model'
fields:
'Category':
type: 'string'
required: false
'ExpiredAt':
type: 'int64'
required: true
'ID':
type: 'string'
required: true
'Message':
type: 'interface{}'
required: false
'Scope':
type: 'string'
required: true
'Status':
type: 'string'
required: true
'UserIDs':
type: '[]string'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_save_inbox_message_response.go'
'ModelsSendInboxMessageRequest@go.chat.mod':
id: 'ModelsSendInboxMessageRequest@go.chat.mod'
name: 'ModelsSendInboxMessageRequest'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_send_inbox_message_request.go'
'ModelsSendInboxMessageResponse@go.chat.mod':
id: 'ModelsSendInboxMessageResponse@go.chat.mod'
name: 'ModelsSendInboxMessageResponse'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_send_inbox_message_response.go'
'ModelsTopicInfo@go.chat.mod':
id: 'ModelsTopicInfo@go.chat.mod'
name: 'ModelsTopicInfo'
type: 'model'
fields:
'CreatedAt':
type: 'int64'
required: true
'DeletedAt':
type: 'int64'
required: false
'ID':
type: 'string'
required: true
'Members':
type: '[]*TopicInfoMember'
required: false
'Name':
type: 'string'
required: true
'SubType':
type: 'string'
required: true
'Type':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_topic_info.go'
'ModelsTopicLogItem@go.chat.mod':
id: 'ModelsTopicLogItem@go.chat.mod'
name: 'ModelsTopicLogItem'
type: 'model'
fields:
'CreatedAt':
type: 'int64'
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:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_topic_log_item.go'
'ModelsTopicLogWithPaginationResponse@go.chat.mod':
id: 'ModelsTopicLogWithPaginationResponse@go.chat.mod'
name: 'ModelsTopicLogWithPaginationResponse'
type: 'model'
fields:
'Data':
type: '[]*ModelsTopicLogItem'
required: true
'Paging':
type: '*ModelsPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_topic_log_with_pagination_response.go'
'ModelsTopicMemberResponse@go.chat.mod':
id: 'ModelsTopicMemberResponse@go.chat.mod'
name: 'ModelsTopicMemberResponse'
type: 'model'
fields:
'IsAdmin':
type: 'bool'
required: true
'IsBanned':
type: 'bool'
required: true
'ShardID':
type: 'string'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_topic_member_response.go'
'ModelsTopicMemberWithPaginationResponse@go.chat.mod':
id: 'ModelsTopicMemberWithPaginationResponse@go.chat.mod'
name: 'ModelsTopicMemberWithPaginationResponse'
type: 'model'
fields:
'Data':
type: '[]*ModelsTopicMemberResponse'
required: true
'Paging':
type: '*ModelsPagination'
required: true
'TotalData':
type: 'int32'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_topic_member_with_pagination_response.go'
'ModelsTopicResponse@go.chat.mod':
id: 'ModelsTopicResponse@go.chat.mod'
name: 'ModelsTopicResponse'
type: 'model'
fields:
'CreatedAt':
type: 'int64'
required: true
'CreatedBy':
type: 'string'
required: true
'LastMessageAt':
type: 'int64'
required: true
'Name':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'TopicID':
type: 'string'
required: true
'Type':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_topic_response.go'
'ModelsUnbanTopicMemberParam@go.chat.mod':
id: 'ModelsUnbanTopicMemberParam@go.chat.mod'
name: 'ModelsUnbanTopicMemberParam'
type: 'model'
fields:
'UserIds':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_unban_topic_member_param.go'
'ModelsUnbanTopicMemberResult@go.chat.mod':
id: 'ModelsUnbanTopicMemberResult@go.chat.mod'
name: 'ModelsUnbanTopicMemberResult'
type: 'model'
fields:
'UserIds':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_unban_topic_member_result.go'
'ModelsUnsendInboxMessageRequest@go.chat.mod':
id: 'ModelsUnsendInboxMessageRequest@go.chat.mod'
name: 'ModelsUnsendInboxMessageRequest'
type: 'model'
fields:
'UserIds':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_unsend_inbox_message_request.go'
'ModelsUnsendInboxMessageResponse@go.chat.mod':
id: 'ModelsUnsendInboxMessageResponse@go.chat.mod'
name: 'ModelsUnsendInboxMessageResponse'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_unsend_inbox_message_response.go'
'ModelsUpdateInboxCategoryRequest@go.chat.mod':
id: 'ModelsUpdateInboxCategoryRequest@go.chat.mod'
name: 'ModelsUpdateInboxCategoryRequest'
type: 'model'
fields:
'Enabled':
type: 'bool'
required: true
'ExpiresIn':
type: 'int64'
required: true
'Hook':
type: '*ModelsCategoryHook'
required: true
'JSONSchema':
type: 'interface{}'
required: false
'SaveInbox':
type: 'bool'
required: true
'SendNotification':
type: 'bool'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_update_inbox_category_request.go'
'ModelsUpdateInboxMessageRequest@go.chat.mod':
id: 'ModelsUpdateInboxMessageRequest@go.chat.mod'
name: 'ModelsUpdateInboxMessageRequest'
type: 'model'
fields:
'ExpiredAt':
type: 'int64'
required: true
'Message':
type: 'interface{}'
required: true
'Scope':
type: 'string'
required: true
'UserIds':
type: '[]string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_update_inbox_message_request.go'
'ModelsUserInbox@go.chat.mod':
id: 'ModelsUserInbox@go.chat.mod'
name: 'ModelsUserInbox'
type: 'model'
fields:
'Keep':
type: 'bool'
required: true
'ReadAt':
type: 'int64'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/models_user_inbox.go'
'ResponseError@go.chat.mod':
id: 'ResponseError@go.chat.mod'
name: 'ResponseError'
type: 'model'
fields:
'ErrorCode':
type: 'int32'
required: true
'ErrorMessage':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/response_error.go'
'RestapiErrorResponseBody@go.chat.mod':
id: 'RestapiErrorResponseBody@go.chat.mod'
name: 'RestapiErrorResponseBody'
type: 'model'
fields:
'ErrorCode':
type: 'int32'
required: true
'ErrorMessage':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/restapi_error_response_body.go'
'TopicInfoMember@go.chat.mod':
id: 'TopicInfoMember@go.chat.mod'
name: 'TopicInfoMember'
type: 'model'
fields:
'LeftAt':
type: 'int64'
required: false
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/chat-sdk/pkg/chatclientmodels/topic_info_member.go'
# endregion models
# region functions
'AdminAddInboxCategoryShort@go.chat.fun':
id: 'AdminAddInboxCategoryShort@go.chat.fun'
name: 'AdminAddInboxCategoryShort'
type: 'function'
description: |-
Add inbox category.
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminAddInboxCategoryParams'
required: true
return_type: '(*inbox.AdminAddInboxCategoryResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminAddInboxCategoryParams{ ... }
res, err := inboxService.AdminAddInboxCategoryShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'add'
- 'admin'
- 'category'
- 'inbox'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [CREATE]'
'AdminAddTopicMemberShort@go.chat.fun':
id: 'AdminAddTopicMemberShort@go.chat.fun'
name: 'AdminAddTopicMemberShort'
type: 'function'
description: |-
Add new member for topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminAddTopicMemberParams'
required: true
return_type: '(*topic.AdminAddTopicMemberResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminAddTopicMemberParams{ ... }
res, err := topicService.AdminAddTopicMemberShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'add'
- 'admin'
- 'member'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'AdminBanTopicMembersShort@go.chat.fun':
id: 'AdminBanTopicMembersShort@go.chat.fun'
name: 'AdminBanTopicMembersShort'
type: 'function'
description: |-
Ban users in some topic. banned user not assigned to shard for channel topic, and cannot send and query chat.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminBanTopicMembersParams'
required: true
return_type: '(*topic.AdminBanTopicMembersResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminBanTopicMembersParams{ ... }
res, err := topicService.AdminBanTopicMembersShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'ban'
- 'members'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'AdminChannelTopicInfoShort@go.chat.fun':
id: 'AdminChannelTopicInfoShort@go.chat.fun'
name: 'AdminChannelTopicInfoShort'
type: 'function'
description: |-
Get chat list of topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminChannelTopicInfoParams'
required: true
return_type: '(*topic.AdminChannelTopicInfoResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminChannelTopicInfoParams{ ... }
res, err := topicService.AdminChannelTopicInfoShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'channel'
- 'info'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminChannelTopicListShort@go.chat.fun':
id: 'AdminChannelTopicListShort@go.chat.fun'
name: 'AdminChannelTopicListShort'
type: 'function'
description: |-
Get channel chat list of topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminChannelTopicListParams'
required: true
return_type: '(*topic.AdminChannelTopicListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminChannelTopicListParams{ ... }
res, err := topicService.AdminChannelTopicListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'channel'
- 'list'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminChannelTopicSummaryShort@go.chat.fun':
id: 'AdminChannelTopicSummaryShort@go.chat.fun'
name: 'AdminChannelTopicSummaryShort'
type: 'function'
description: |-
Get chat list of topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminChannelTopicSummaryParams'
required: true
return_type: '(*topic.AdminChannelTopicSummaryResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminChannelTopicSummaryParams{ ... }
res, err := topicService.AdminChannelTopicSummaryShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'channel'
- 'summary'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminChatHistoryShort@go.chat.fun':
id: 'AdminChatHistoryShort@go.chat.fun'
name: 'AdminChatHistoryShort'
type: 'function'
description: |-
Get chat history in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminChatHistoryParams'
required: true
return_type: '(*topic.AdminChatHistoryResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminChatHistoryParams{ ... }
res, err := topicService.AdminChatHistoryShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'chat'
- 'history'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminCreateNamespaceTopicShort@go.chat.fun':
id: 'AdminCreateNamespaceTopicShort@go.chat.fun'
name: 'AdminCreateNamespaceTopicShort'
type: 'function'
description: |-
Create new namespace group topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminCreateNamespaceTopicParams'
required: true
return_type: '(*topic.AdminCreateNamespaceTopicResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminCreateNamespaceTopicParams{ ... }
res, err := topicService.AdminCreateNamespaceTopicShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'create'
- 'namespace'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [CREATE]'
'AdminCreateTopicShort@go.chat.fun':
id: 'AdminCreateTopicShort@go.chat.fun'
name: 'AdminCreateTopicShort'
type: 'function'
description: |-
Create new group topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminCreateTopicParams'
required: true
return_type: '(*topic.AdminCreateTopicResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminCreateTopicParams{ ... }
res, err := topicService.AdminCreateTopicShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'create'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [CREATE]'
'AdminDeleteChatShort@go.chat.fun':
id: 'AdminDeleteChatShort@go.chat.fun'
name: 'AdminDeleteChatShort'
type: 'function'
description: |-
Delete chat.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminDeleteChatParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminDeleteChatParams{ ... }
res, err := topicService.AdminDeleteChatShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'chat'
- 'delete'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [DELETE]'
'AdminDeleteChatSnapshotShort@go.chat.fun':
id: 'AdminDeleteChatSnapshotShort@go.chat.fun'
name: 'AdminDeleteChatSnapshotShort'
type: 'function'
description: |-
Delete the chat snapshot
struct: 'ModerationService'
arguments:
params:
type: '*moderation.AdminDeleteChatSnapshotParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/moderation'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/moderation.go'
example: |-
moderationService := chat.ModerationService{ ... }
params := moderation.AdminDeleteChatSnapshotParams{ ... }
res, err := moderationService.AdminDeleteChatSnapshotShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'chat'
- 'delete'
- 'moderation'
- 'snapshot'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [DELETE]'
'AdminDeleteInboxCategoryShort@go.chat.fun':
id: 'AdminDeleteInboxCategoryShort@go.chat.fun'
name: 'AdminDeleteInboxCategoryShort'
type: 'function'
description: |-
Delete inbox category
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminDeleteInboxCategoryParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminDeleteInboxCategoryParams{ ... }
res, err := inboxService.AdminDeleteInboxCategoryShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'category'
- 'delete'
- 'inbox'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [DELETE]'
'AdminDeleteInboxMessageShort@go.chat.fun':
id: 'AdminDeleteInboxMessageShort@go.chat.fun'
name: 'AdminDeleteInboxMessageShort'
type: 'function'
description: |-
Delete inbox message
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminDeleteInboxMessageParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminDeleteInboxMessageParams{ ... }
res, err := inboxService.AdminDeleteInboxMessageShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'delete'
- 'inbox'
- 'message'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [DELETE]'
'AdminDeleteTopicShort@go.chat.fun':
id: 'AdminDeleteTopicShort@go.chat.fun'
name: 'AdminDeleteTopicShort'
type: 'function'
description: |-
Delete topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminDeleteTopicParams'
required: true
return_type: '(*topic.AdminDeleteTopicResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminDeleteTopicParams{ ... }
res, err := topicService.AdminDeleteTopicShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'delete'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [DELETE]'
'AdminFilterChatMessageShort@go.chat.fun':
id: 'AdminFilterChatMessageShort@go.chat.fun'
name: 'AdminFilterChatMessageShort'
type: 'function'
description: |-
For testing purpose, doesn't send any message to the topic. Always do filter regardless of enableProfanityFilter configuration.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminFilterChatMessageParams'
required: true
return_type: '(*topic.AdminFilterChatMessageResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminFilterChatMessageParams{ ... }
res, err := topicService.AdminFilterChatMessageShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'chat'
- 'filter'
- 'message'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminGetAllConfigV1Short@go.chat.fun':
id: 'AdminGetAllConfigV1Short@go.chat.fun'
name: 'AdminGetAllConfigV1Short'
type: 'function'
description: |-
Get chat config of all namespaces.
struct: 'ConfigService'
arguments:
params:
type: '*config.AdminGetAllConfigV1Params'
required: true
return_type: '(*config.AdminGetAllConfigV1Response, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/config.go'
example: |-
configService := chat.ConfigService{ ... }
params := config.AdminGetAllConfigV1Params{ ... }
res, err := configService.AdminGetAllConfigV1Short(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'all'
- 'config'
- 'get'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:*:CHAT:CONFIG [READ]'
'AdminGetCategorySchemaShort@go.chat.fun':
id: 'AdminGetCategorySchemaShort@go.chat.fun'
name: 'AdminGetCategorySchemaShort'
type: 'function'
description: |-
Get category schema.
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminGetCategorySchemaParams'
required: true
return_type: '(*inbox.AdminGetCategorySchemaResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminGetCategorySchemaParams{ ... }
res, err := inboxService.AdminGetCategorySchemaShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'category'
- 'get'
- 'inbox'
- 'schema'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [READ]'
'AdminGetChatSnapshotShort@go.chat.fun':
id: 'AdminGetChatSnapshotShort@go.chat.fun'
name: 'AdminGetChatSnapshotShort'
type: 'function'
description: |-
Get the chat snapshot
struct: 'ModerationService'
arguments:
params:
type: '*moderation.AdminGetChatSnapshotParams'
required: true
return_type: '(*moderation.AdminGetChatSnapshotResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/moderation'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/moderation.go'
example: |-
moderationService := chat.ModerationService{ ... }
params := moderation.AdminGetChatSnapshotParams{ ... }
res, err := moderationService.AdminGetChatSnapshotShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'chat'
- 'get'
- 'moderation'
- 'snapshot'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminGetConfigV1Short@go.chat.fun':
id: 'AdminGetConfigV1Short@go.chat.fun'
name: 'AdminGetConfigV1Short'
type: 'function'
description: |-
Get chat config of a namespace.
struct: 'ConfigService'
arguments:
params:
type: '*config.AdminGetConfigV1Params'
required: true
return_type: '(*config.AdminGetConfigV1Response, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/config.go'
example: |-
configService := chat.ConfigService{ ... }
params := config.AdminGetConfigV1Params{ ... }
res, err := configService.AdminGetConfigV1Short(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'config'
- 'get'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [READ]'
'AdminGetInboxCategoriesShort@go.chat.fun':
id: 'AdminGetInboxCategoriesShort@go.chat.fun'
name: 'AdminGetInboxCategoriesShort'
type: 'function'
description: |-
Get inbox categories
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminGetInboxCategoriesParams'
required: true
return_type: '(*inbox.AdminGetInboxCategoriesResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminGetInboxCategoriesParams{ ... }
res, err := inboxService.AdminGetInboxCategoriesShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'categories'
- 'get'
- 'inbox'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [READ]'
'AdminGetInboxMessagesShort@go.chat.fun':
id: 'AdminGetInboxMessagesShort@go.chat.fun'
name: 'AdminGetInboxMessagesShort'
type: 'function'
description: |-
Get inbox messages
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminGetInboxMessagesParams'
required: true
return_type: '(*inbox.AdminGetInboxMessagesResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminGetInboxMessagesParams{ ... }
res, err := inboxService.AdminGetInboxMessagesShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'get'
- 'inbox'
- 'messages'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [READ]'
'AdminGetInboxStatsShort@go.chat.fun':
id: 'AdminGetInboxStatsShort@go.chat.fun'
name: 'AdminGetInboxStatsShort'
type: 'function'
description: |-
Get inbox stats
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminGetInboxStatsParams'
required: true
return_type: '(*inbox.AdminGetInboxStatsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminGetInboxStatsParams{ ... }
res, err := inboxService.AdminGetInboxStatsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'get'
- 'inbox'
- 'stats'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [READ]'
'AdminGetInboxUsersShort@go.chat.fun':
id: 'AdminGetInboxUsersShort@go.chat.fun'
name: 'AdminGetInboxUsersShort'
type: 'function'
description: |-
Get inbox users
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminGetInboxUsersParams'
required: true
return_type: '(*inbox.AdminGetInboxUsersResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminGetInboxUsersParams{ ... }
res, err := inboxService.AdminGetInboxUsersShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'get'
- 'inbox'
- 'users'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [READ]'
'AdminGetLogConfigShort@go.chat.fun':
id: 'AdminGetLogConfigShort@go.chat.fun'
name: 'AdminGetLogConfigShort'
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
struct: 'ConfigService'
arguments:
params:
type: '*config.AdminGetLogConfigParams'
required: true
return_type: '(*config.AdminGetLogConfigResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/config.go'
example: |-
configService := chat.ConfigService{ ... }
params := config.AdminGetLogConfigParams{ ... }
res, err := configService.AdminGetLogConfigShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'config'
- 'get'
- 'log'
permissions:
- 'ADMIN:CONFIG:LOG [READ]'
'AdminListKafkaTopicShort@go.chat.fun':
id: 'AdminListKafkaTopicShort@go.chat.fun'
name: 'AdminListKafkaTopicShort'
type: 'function'
description: |-
Get list kafka topic. example result chat,sessionNotification
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminListKafkaTopicParams'
required: true
return_type: '(*inbox.AdminListKafkaTopicResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminListKafkaTopicParams{ ... }
res, err := inboxService.AdminListKafkaTopicShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'inbox'
- 'kafka'
- 'list'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [READ]'
'AdminPatchUpdateLogConfigShort@go.chat.fun':
id: 'AdminPatchUpdateLogConfigShort@go.chat.fun'
name: 'AdminPatchUpdateLogConfigShort'
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
struct: 'ConfigService'
arguments:
params:
type: '*config.AdminPatchUpdateLogConfigParams'
required: true
return_type: '(*config.AdminPatchUpdateLogConfigResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/config.go'
example: |-
configService := chat.ConfigService{ ... }
params := config.AdminPatchUpdateLogConfigParams{ ... }
res, err := configService.AdminPatchUpdateLogConfigShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'config'
- 'log'
- 'patch'
- 'update'
permissions:
- 'ADMIN:CONFIG:LOG [UPDATE]'
'AdminProfanityCreateShort@go.chat.fun':
id: 'AdminProfanityCreateShort@go.chat.fun'
name: 'AdminProfanityCreateShort'
type: 'function'
description: |-
Insert new word for profanity censor
struct: 'ProfanityService'
arguments:
params:
type: '*profanity.AdminProfanityCreateParams'
required: true
return_type: '(*profanity.AdminProfanityCreateResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/profanity.go'
example: |-
profanityService := chat.ProfanityService{ ... }
params := profanity.AdminProfanityCreateParams{ ... }
res, err := profanityService.AdminProfanityCreateShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'create'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [CREATE]'
'AdminProfanityCreateBulkShort@go.chat.fun':
id: 'AdminProfanityCreateBulkShort@go.chat.fun'
name: 'AdminProfanityCreateBulkShort'
type: 'function'
description: |-
Bulk insert new word for profanity censor
struct: 'ProfanityService'
arguments:
params:
type: '*profanity.AdminProfanityCreateBulkParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/profanity.go'
example: |-
profanityService := chat.ProfanityService{ ... }
params := profanity.AdminProfanityCreateBulkParams{ ... }
res, err := profanityService.AdminProfanityCreateBulkShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'bulk'
- 'create'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [CREATE]'
'AdminProfanityDeleteShort@go.chat.fun':
id: 'AdminProfanityDeleteShort@go.chat.fun'
name: 'AdminProfanityDeleteShort'
type: 'function'
description: |-
Delete profanity words.
struct: 'ProfanityService'
arguments:
params:
type: '*profanity.AdminProfanityDeleteParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/profanity.go'
example: |-
profanityService := chat.ProfanityService{ ... }
params := profanity.AdminProfanityDeleteParams{ ... }
res, err := profanityService.AdminProfanityDeleteShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'delete'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [DELETE]'
'AdminProfanityExportShort@go.chat.fun':
id: 'AdminProfanityExportShort@go.chat.fun'
name: 'AdminProfanityExportShort'
type: 'function'
description: |-
Export profanity words
struct: 'ProfanityService'
arguments:
params:
type: '*profanity.AdminProfanityExportParams'
required: true
return_type: '(*profanity.AdminProfanityExportResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/profanity.go'
example: |-
profanityService := chat.ProfanityService{ ... }
params := profanity.AdminProfanityExportParams{ ... }
res, err := profanityService.AdminProfanityExportShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'export'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]'
'AdminProfanityGroupShort@go.chat.fun':
id: 'AdminProfanityGroupShort@go.chat.fun'
name: 'AdminProfanityGroupShort'
type: 'function'
description: |-
Get profanity words group.
struct: 'ProfanityService'
arguments:
params:
type: '*profanity.AdminProfanityGroupParams'
required: true
return_type: '(*profanity.AdminProfanityGroupResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/profanity.go'
example: |-
profanityService := chat.ProfanityService{ ... }
params := profanity.AdminProfanityGroupParams{ ... }
res, err := profanityService.AdminProfanityGroupShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'group'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]'
'AdminProfanityImportShort@go.chat.fun':
id: 'AdminProfanityImportShort@go.chat.fun'
name: 'AdminProfanityImportShort'
type: 'function'
description: |-
Import profanity words
struct: 'ProfanityService'
arguments:
params:
type: '*profanity.AdminProfanityImportParams'
required: true
return_type: '(*profanity.AdminProfanityImportResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/profanity.go'
example: |-
profanityService := chat.ProfanityService{ ... }
params := profanity.AdminProfanityImportParams{ ... }
res, err := profanityService.AdminProfanityImportShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'import'
- 'profanity'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [CREATE]'
'AdminProfanityQueryShort@go.chat.fun':
id: 'AdminProfanityQueryShort@go.chat.fun'
name: 'AdminProfanityQueryShort'
type: 'function'
description: |-
Query all profanity words.
struct: 'ProfanityService'
arguments:
params:
type: '*profanity.AdminProfanityQueryParams'
required: true
return_type: '(*profanity.AdminProfanityQueryResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/profanity.go'
example: |-
profanityService := chat.ProfanityService{ ... }
params := profanity.AdminProfanityQueryParams{ ... }
res, err := profanityService.AdminProfanityQueryShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'profanity'
- 'query'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]'
'AdminProfanityUpdateShort@go.chat.fun':
id: 'AdminProfanityUpdateShort@go.chat.fun'
name: 'AdminProfanityUpdateShort'
type: 'function'
description: |-
Update profanity word
struct: 'ProfanityService'
arguments:
params:
type: '*profanity.AdminProfanityUpdateParams'
required: true
return_type: '(*profanity.AdminProfanityUpdateResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/profanity'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/profanity.go'
example: |-
profanityService := chat.ProfanityService{ ... }
params := profanity.AdminProfanityUpdateParams{ ... }
res, err := profanityService.AdminProfanityUpdateShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'profanity'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [UPDATE]'
'AdminQueryTopicShort@go.chat.fun':
id: 'AdminQueryTopicShort@go.chat.fun'
name: 'AdminQueryTopicShort'
type: 'function'
description: |-
Get topics in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminQueryTopicParams'
required: true
return_type: '(*topic.AdminQueryTopicResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminQueryTopicParams{ ... }
res, err := topicService.AdminQueryTopicShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'query'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminQueryTopicLogShort@go.chat.fun':
id: 'AdminQueryTopicLogShort@go.chat.fun'
name: 'AdminQueryTopicLogShort'
type: 'function'
description: |-
Get chat log of topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminQueryTopicLogParams'
required: true
return_type: '(*topic.AdminQueryTopicLogResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminQueryTopicLogParams{ ... }
res, err := topicService.AdminQueryTopicLogShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'log'
- 'query'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminQueryUsersTopicShort@go.chat.fun':
id: 'AdminQueryUsersTopicShort@go.chat.fun'
name: 'AdminQueryUsersTopicShort'
type: 'function'
description: |-
Get user's topics in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminQueryUsersTopicParams'
required: true
return_type: '(*topic.AdminQueryUsersTopicResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminQueryUsersTopicParams{ ... }
res, err := topicService.AdminQueryUsersTopicShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'query'
- 'topic'
- 'users'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminRemoveTopicMemberShort@go.chat.fun':
id: 'AdminRemoveTopicMemberShort@go.chat.fun'
name: 'AdminRemoveTopicMemberShort'
type: 'function'
description: |-
Remove member from topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminRemoveTopicMemberParams'
required: true
return_type: '(*topic.AdminRemoveTopicMemberResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminRemoveTopicMemberParams{ ... }
res, err := topicService.AdminRemoveTopicMemberShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'member'
- 'remove'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'AdminSaveInboxMessageShort@go.chat.fun':
id: 'AdminSaveInboxMessageShort@go.chat.fun'
name: 'AdminSaveInboxMessageShort'
type: 'function'
description: |-
Save inbox message
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminSaveInboxMessageParams'
required: true
return_type: '(*inbox.AdminSaveInboxMessageResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminSaveInboxMessageParams{ ... }
res, err := inboxService.AdminSaveInboxMessageShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'inbox'
- 'message'
- 'save'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [CREATE]'
'AdminSendChatShort@go.chat.fun':
id: 'AdminSendChatShort@go.chat.fun'
name: 'AdminSendChatShort'
type: 'function'
description: |-
Send message to chat topic as system.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminSendChatParams'
required: true
return_type: '(*topic.AdminSendChatResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminSendChatParams{ ... }
res, err := topicService.AdminSendChatShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'chat'
- 'send'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'AdminSendInboxMessageShort@go.chat.fun':
id: 'AdminSendInboxMessageShort@go.chat.fun'
name: 'AdminSendInboxMessageShort'
type: 'function'
description: |-
Send inbox message
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminSendInboxMessageParams'
required: true
return_type: '(*inbox.AdminSendInboxMessageResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminSendInboxMessageParams{ ... }
res, err := inboxService.AdminSendInboxMessageShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'inbox'
- 'message'
- 'send'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [UPDATE]'
'AdminTopicChatHistoryShort@go.chat.fun':
id: 'AdminTopicChatHistoryShort@go.chat.fun'
name: 'AdminTopicChatHistoryShort'
type: 'function'
description: |-
Get chat history in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminTopicChatHistoryParams'
required: true
return_type: '(*topic.AdminTopicChatHistoryResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminTopicChatHistoryParams{ ... }
res, err := topicService.AdminTopicChatHistoryShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'chat'
- 'history'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminTopicListShort@go.chat.fun':
id: 'AdminTopicListShort@go.chat.fun'
name: 'AdminTopicListShort'
type: 'function'
description: |-
Get chat list of topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminTopicListParams'
required: true
return_type: '(*topic.AdminTopicListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminTopicListParams{ ... }
res, err := topicService.AdminTopicListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'list'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminTopicMembersShort@go.chat.fun':
id: 'AdminTopicMembersShort@go.chat.fun'
name: 'AdminTopicMembersShort'
type: 'function'
description: |-
Get topic members.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminTopicMembersParams'
required: true
return_type: '(*topic.AdminTopicMembersResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminTopicMembersParams{ ... }
res, err := topicService.AdminTopicMembersShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'members'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminTopicShardsShort@go.chat.fun':
id: 'AdminTopicShardsShort@go.chat.fun'
name: 'AdminTopicShardsShort'
type: 'function'
description: |-
Get shard list from topic.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminTopicShardsParams'
required: true
return_type: '(*topic.AdminTopicShardsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminTopicShardsParams{ ... }
res, err := topicService.AdminTopicShardsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'shards'
- 'topic'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]'
'AdminUnbanTopicMembersShort@go.chat.fun':
id: 'AdminUnbanTopicMembersShort@go.chat.fun'
name: 'AdminUnbanTopicMembersShort'
type: 'function'
description: |-
Unban users in some topic.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminUnbanTopicMembersParams'
required: true
return_type: '(*topic.AdminUnbanTopicMembersResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminUnbanTopicMembersParams{ ... }
res, err := topicService.AdminUnbanTopicMembersShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'members'
- 'topic'
- 'unban'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'AdminUnsendInboxMessageShort@go.chat.fun':
id: 'AdminUnsendInboxMessageShort@go.chat.fun'
name: 'AdminUnsendInboxMessageShort'
type: 'function'
description: |-
Unsend inbox message
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminUnsendInboxMessageParams'
required: true
return_type: '(*inbox.AdminUnsendInboxMessageResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminUnsendInboxMessageParams{ ... }
res, err := inboxService.AdminUnsendInboxMessageShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'inbox'
- 'message'
- 'unsend'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [UPDATE]'
'AdminUpdateConfigV1Short@go.chat.fun':
id: 'AdminUpdateConfigV1Short@go.chat.fun'
name: 'AdminUpdateConfigV1Short'
type: 'function'
description: |-
Update chat config of a namespace.
struct: 'ConfigService'
arguments:
params:
type: '*config.AdminUpdateConfigV1Params'
required: true
return_type: '(*config.AdminUpdateConfigV1Response, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/config.go'
example: |-
configService := chat.ConfigService{ ... }
params := config.AdminUpdateConfigV1Params{ ... }
res, err := configService.AdminUpdateConfigV1Short(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'config'
- 'update'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [UPDATE]'
'AdminUpdateInboxCategoryShort@go.chat.fun':
id: 'AdminUpdateInboxCategoryShort@go.chat.fun'
name: 'AdminUpdateInboxCategoryShort'
type: 'function'
description: |-
Update inbox category
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminUpdateInboxCategoryParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminUpdateInboxCategoryParams{ ... }
res, err := inboxService.AdminUpdateInboxCategoryShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'category'
- 'inbox'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [UPDATE]'
'AdminUpdateInboxMessageShort@go.chat.fun':
id: 'AdminUpdateInboxMessageShort@go.chat.fun'
name: 'AdminUpdateInboxMessageShort'
type: 'function'
description: |-
Update inbox message
struct: 'InboxService'
arguments:
params:
type: '*inbox.AdminUpdateInboxMessageParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/inbox'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/inbox.go'
example: |-
inboxService := chat.InboxService{ ... }
params := inbox.AdminUpdateInboxMessageParams{ ... }
res, err := inboxService.AdminUpdateInboxMessageShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'inbox'
- 'message'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [UPDATE]'
'AdminUpdateTopicShort@go.chat.fun':
id: 'AdminUpdateTopicShort@go.chat.fun'
name: 'AdminUpdateTopicShort'
type: 'function'
description: |-
Update group topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.AdminUpdateTopicParams'
required: true
return_type: '(*topic.AdminUpdateTopicResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.AdminUpdateTopicParams{ ... }
res, err := topicService.AdminUpdateTopicShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'topic'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]'
'ExportConfigShort@go.chat.fun':
id: 'ExportConfigShort@go.chat.fun'
name: 'ExportConfigShort'
type: 'function'
description: |-
Export chat configuration to a json file. The file can then be imported from the /import endpoint.
struct: 'ConfigService'
arguments:
params:
type: '*config.ExportConfigParams'
required: true
return_type: '(*config.ExportConfigResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/config.go'
example: |-
configService := chat.ConfigService{ ... }
params := config.ExportConfigParams{ ... }
res, err := configService.ExportConfigShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'config'
- 'export'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [READ]'
'ImportConfigShort@go.chat.fun':
id: 'ImportConfigShort@go.chat.fun'
name: 'ImportConfigShort'
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.
struct: 'ConfigService'
arguments:
params:
type: '*config.ImportConfigParams'
required: true
return_type: '(*config.ImportConfigResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/config.go'
example: |-
configService := chat.ConfigService{ ... }
params := config.ImportConfigParams{ ... }
res, err := configService.ImportConfigShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'config'
- 'import'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [UPDATE]'
'PublicBanTopicMembersShort@go.chat.fun':
id: 'PublicBanTopicMembersShort@go.chat.fun'
name: 'PublicBanTopicMembersShort'
type: 'function'
description: |-
Ban topic members in a group topic.
struct: 'TopicService'
arguments:
params:
type: '*topic.PublicBanTopicMembersParams'
required: true
return_type: '(*topic.PublicBanTopicMembersResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.PublicBanTopicMembersParams{ ... }
res, err := topicService.PublicBanTopicMembersShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'ban'
- 'members'
- 'public'
- 'topic'
'PublicChatHistoryShort@go.chat.fun':
id: 'PublicChatHistoryShort@go.chat.fun'
name: 'PublicChatHistoryShort'
type: 'function'
description: |-
get chat history in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.PublicChatHistoryParams'
required: true
return_type: '(*topic.PublicChatHistoryResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.PublicChatHistoryParams{ ... }
res, err := topicService.PublicChatHistoryShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'chat'
- 'history'
- 'public'
- 'topic'
'PublicDeleteChatShort@go.chat.fun':
id: 'PublicDeleteChatShort@go.chat.fun'
name: 'PublicDeleteChatShort'
type: 'function'
description: |-
Delete chat.
struct: 'TopicService'
arguments:
params:
type: '*topic.PublicDeleteChatParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.PublicDeleteChatParams{ ... }
res, err := topicService.PublicDeleteChatShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'chat'
- 'delete'
- 'public'
- 'topic'
'PublicGetChatSnapshotShort@go.chat.fun':
id: 'PublicGetChatSnapshotShort@go.chat.fun'
name: 'PublicGetChatSnapshotShort'
type: 'function'
description: |-
Get the chat snapshot
struct: 'ModerationService'
arguments:
params:
type: '*moderation.PublicGetChatSnapshotParams'
required: true
return_type: '(*moderation.PublicGetChatSnapshotResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/moderation'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/moderation.go'
example: |-
moderationService := chat.ModerationService{ ... }
params := moderation.PublicGetChatSnapshotParams{ ... }
res, err := moderationService.PublicGetChatSnapshotShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'chat'
- 'get'
- 'moderation'
- 'public'
- 'snapshot'
'PublicGetConfigV1Short@go.chat.fun':
id: 'PublicGetConfigV1Short@go.chat.fun'
name: 'PublicGetConfigV1Short'
type: 'function'
description: |-
Get chat config of a namespace.
struct: 'ConfigService'
arguments:
params:
type: '*config.PublicGetConfigV1Params'
required: true
return_type: '(*config.PublicGetConfigV1Response, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/config'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/config.go'
example: |-
configService := chat.ConfigService{ ... }
params := config.PublicGetConfigV1Params{ ... }
res, err := configService.PublicGetConfigV1Short(params)
if err != nil {
// handleError(err)
}
tags:
- 'config'
- 'get'
- 'public'
- 'v1'
'PublicGetMessagesShort@go.chat.fun':
id: 'PublicGetMessagesShort@go.chat.fun'
name: 'PublicGetMessagesShort'
type: 'function'
description: |-
get the list of messages.
struct: 'EmptyService'
arguments:
params:
type: '*.PublicGetMessagesParams'
required: true
return_type: '(*.PublicGetMessagesResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/.go'
example: |-
emptyService := chat.EmptyService{ ... }
params := .PublicGetMessagesParams{ ... }
res, err := emptyService.PublicGetMessagesShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'get'
- 'messages'
- 'public'
'PublicGetMutedTopicsShort@go.chat.fun':
id: 'PublicGetMutedTopicsShort@go.chat.fun'
name: 'PublicGetMutedTopicsShort'
type: 'function'
description: |-
get chat muted topics in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.PublicGetMutedTopicsParams'
required: true
return_type: '(*topic.PublicGetMutedTopicsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.PublicGetMutedTopicsParams{ ... }
res, err := topicService.PublicGetMutedTopicsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'get'
- 'muted'
- 'public'
- 'topic'
- 'topics'
'PublicMuteUserShort@go.chat.fun':
id: 'PublicMuteUserShort@go.chat.fun'
name: 'PublicMuteUserShort'
type: 'function'
description: |-
Mute user.
struct: 'TopicService'
arguments:
params:
type: '*topic.PublicMuteUserParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.PublicMuteUserParams{ ... }
res, err := topicService.PublicMuteUserShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'mute'
- 'public'
- 'topic'
- 'user'
'PublicTopicListShort@go.chat.fun':
id: 'PublicTopicListShort@go.chat.fun'
name: 'PublicTopicListShort'
type: 'function'
description: |-
get chat list of topic in a namespace.
struct: 'TopicService'
arguments:
params:
type: '*topic.PublicTopicListParams'
required: true
return_type: '(*topic.PublicTopicListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.PublicTopicListParams{ ... }
res, err := topicService.PublicTopicListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'list'
- 'public'
- 'topic'
'PublicUnbanTopicMembersShort@go.chat.fun':
id: 'PublicUnbanTopicMembersShort@go.chat.fun'
name: 'PublicUnbanTopicMembersShort'
type: 'function'
description: |-
Unban topic members in a group topic.
struct: 'TopicService'
arguments:
params:
type: '*topic.PublicUnbanTopicMembersParams'
required: true
return_type: '(*topic.PublicUnbanTopicMembersResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.PublicUnbanTopicMembersParams{ ... }
res, err := topicService.PublicUnbanTopicMembersShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'members'
- 'public'
- 'topic'
- 'unban'
'PublicUnmuteUserShort@go.chat.fun':
id: 'PublicUnmuteUserShort@go.chat.fun'
name: 'PublicUnmuteUserShort'
type: 'function'
description: |-
Unmute user.
struct: 'TopicService'
arguments:
params:
type: '*topic.PublicUnmuteUserParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/chat-sdk/pkg/chatclient/topic'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/chat'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/chat/topic.go'
example: |-
topicService := chat.TopicService{ ... }
params := topic.PublicUnmuteUserParams{ ... }
res, err := topicService.PublicUnmuteUserShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'public'
- 'topic'
- 'unmute'
- 'user'
# endregion functions