Documentation
Chat (BETA)
Agora Chat Web API Reference
Overview
ChatSDK
Chatroom
Connection
Contact
EventHandler
Group
Logger
Message
Presence
SilentMode
StatusCode
Thread
Translation
Types
Index
Functions
clearRemindTypeForConversation
清除会话的离线推送提醒类型设置。
connection.clearRemindTypeForConversation({conversationId: '123', type: 'singleChat'})Parameters
params: { conversationId: string; type: CONVERSATIONTYPE; error?: any; success?: any }
conversation
Id: string 会话 id。
type: CONVERSATIONTYPE
会话类型。
error?:function
Parameters
error: ErrorEvent
Returns void
success?:function
Parameters
Returns void
Returns Promise<AsyncResult<SilentModeConversationType>>
getPushPerformLanguage
获取用户设置的推送翻译语言。
connection.getPushPerformLanguage()Parameters
Optional params: { error?: any; success?: any }
error?:function
Parameters
error: ErrorEvent
Returns void
success?:function
Parameters
Returns void
Returns Promise<AsyncResult<TranslationLanguageType>>
getSilentModeForAll
获取当前用户的免打扰设置。
connection.getSilentModeForAll()Parameters
Optional params: { error?: any; success?: any }
error?:function
Parameters
error: ErrorEvent
Returns void
success?:function
Parameters
Returns void
Returns Promise<AsyncResult<SilentModeConversationType>>
getSilentModeForConversation
获取会话的免打扰设置。
connection.getSilentModeForConversation({conversationId: '3333', type: 'singleChat'})Parameters
params: { conversationId: string; type: CONVERSATIONTYPE; error?: any; success?: any }
conversation
Id: string 会话 id。
type: CONVERSATIONTYPE
会话类型。
error?:function
Parameters
error: ErrorEvent
Returns void
success?:function
Parameters
Returns void
Returns Promise<AsyncResult<SilentModeConversationType>>
getSilentModeForConversations
批量获取指定会话的免打扰设置。
connection.getSilentModeForConversations({conversationList:[{id: 'test', type: 'singleChat'}, {id: '12345', type: 'groupChat'}]})Parameters
params: { conversationList: ConversationListType[]; error?: any; success?: any }
conversation
List: ConversationListType[] Obtain the DND Settings of specified sessions in batches.
connection.getSilentModeForConversations({conversationList:[{id: 'test', type: 'singleChat'}, {id: '12345', type: 'groupChat'}]})error?:function
Parameters
error: ErrorEvent
Returns void
success?:function
Parameters
Returns void
Returns Promise<AsyncResult<ConversationSilentModeType>>
setPushPerformLanguage
设置用户推送翻译语言。
connection.setPushPerformLanguage({language: 'EU'})Parameters
params: { language: string; error?: any; success?: any }
language: string
Set user push translation language.
connection.setPushPerformLanguage({language: 'EU'})error?:function
Parameters
error: ErrorEvent
Returns void
success?:function
Parameters
Returns void
Returns Promise<AsyncResult<TranslationLanguageType>>
setSilentModeForAll
Set the DND Settings for the current login user.
connection.setSilentModeForAll({options: {paramType: 0, remindType: 'ALL'}})Parameters
params: { options: SilentModeParamType; error?: any; success?: any }
options: SilentModeParamType
参数对象，包含paramType、remindType、duration、startTime、endTime。
error?:function
Parameters
error: ErrorEvent
Returns void
success?:function
Parameters
Returns void
Returns Promise<AsyncResult<SilentModeConversationType>>
setSilentModeForConversation
设置会话的免打扰。
connection.setSilentModeForConversation({conversationId: '100', type: 'singleChat', params: {paramType: 0, remindType: 'ALL'}})Parameters
params: { conversationId: string; options: SilentModeParamType; type: CONVERSATIONTYPE; error?: any; success?: any }
conversation
Id: string 会话 id。 对于单聊类型，会话 ID 同时也是对方用户的名称。 对于群聊类型，会话 ID 同时也是对方群组的 ID，并不同于群组的名称。 对于聊天室类型，会话 ID 同时也是聊天室的 ID，并不同于聊天室的名称。 对于Help Desk 类型，会话 ID 与单聊类型相同，是对方用户的名称。
options: SilentModeParamType
参数对象，包含paramType、remindType、duration、startTime、endTime。
type: CONVERSATIONTYPE
会话类型。
error?:function
Parameters
error: ErrorEvent
Returns void
success?:function
Parameters
Returns void
Returns Promise<AsyncResult<SilentModeConversationType>>
SilentMode contains APIs for silent mode operations.