SilentMode | Agora Chat SDK API Reference

SilentMode contains APIs for silent mode operations.

Index

Functions

clearRemindTypeForConversation

clearRemindTypeForConversation(this: Connection, params: { conversationId: string; type: CONVERSATIONTYPE; error?: any; success?: any }): Promise<AsyncResult<SilentModeConversationType>>

Clear the setting of offline push notification type for the session.
```
connection.clearRemindTypeForConversation({conversationId: '123', type: 'singleChat'})
```
Parameters
- this: Connection
- params: { conversationId: string; type: CONVERSATIONTYPE; error?: any; success?: any }
  - conversationId: string
    
    Conversation id.
  - type: CONVERSATIONTYPE
    
    Conversation type.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<SilentModeConversationType>): void
    - Parameters
      - res: AsyncResult<SilentModeConversationType>
      Returns void
Returns Promise<AsyncResult<SilentModeConversationType>>

getPushPerformLanguage

getPushPerformLanguage(this: Connection, params?: { error?: any; success?: any }): Promise<AsyncResult<TranslationLanguageType>>

Gets the push translation language set by the user.
```
connection.getPushPerformLanguage()
```
Parameters
- this: Connection
- Optional params: { error?: any; success?: any }
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<TranslationLanguageType>): void
    - Parameters
      - res: AsyncResult<TranslationLanguageType>
      Returns void
Returns Promise<AsyncResult<TranslationLanguageType>>

getSilentModeForAll

getSilentModeForAll(this: Connection, params?: { error?: any; success?: any }): Promise<AsyncResult<SilentModeConversationType>>

Get the DND Settings of the current user.
```
connection.getSilentModeForAll()
```
Parameters
- this: Connection
- Optional params: { error?: any; success?: any }
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<SilentModeConversationType>): void
    - Parameters
      - res: AsyncResult<SilentModeConversationType>
      Returns void
Returns Promise<AsyncResult<SilentModeConversationType>>

getSilentModeForConversation

getSilentModeForConversation(this: Connection, params: { conversationId: string; type: CONVERSATIONTYPE; error?: any; success?: any }): Promise<AsyncResult<SilentModeConversationType>>

Gets the DND setting of the session.
```
connection.getSilentModeForConversation({conversationId: 'conversationId', type: 'singleChat'})
```
Parameters
- this: Connection
- params: { conversationId: string; type: CONVERSATIONTYPE; error?: any; success?: any }
  - conversationId: string
    
    Conversation id.
  - type: CONVERSATIONTYPE
    
    Conversation type.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<SilentModeConversationType>): void
    - Parameters
      - res: AsyncResult<SilentModeConversationType>
      Returns void
Returns Promise<AsyncResult<SilentModeConversationType>>

getSilentModeForConversations

getSilentModeForConversations(this: Connection, params: { conversationList: ConversationListType[]; error?: any; success?: any }): Promise<AsyncResult<ConversationSilentModeType>>

Obtain the DND Settings of specified sessions in batches.
```
connection.getSilentModeForConversations({conversationList:[{id: 'userId', type: 'singleChat'}, {id: 'groupId', type: 'groupChat'}]})
```
Parameters
- this: Connection
- params: { conversationList: ConversationListType[]; error?: any; success?: any }
  - conversationList: ConversationListType[]
    
    Conversation list.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<ConversationSilentModeType>): void
    - Parameters
      - res: AsyncResult<ConversationSilentModeType>
      Returns void
Returns Promise<AsyncResult<ConversationSilentModeType>>

getSilentModeRemindTypeConversations

getSilentModeRemindTypeConversations(this: Connection, params: { cursor?: string; pageSize: number }): Promise<AsyncResult<GetSilentModeRemindTypeConversationsResult>>

Get all conversations in silent mode.

Parameters
- this: Connection
- params: { cursor?: string; pageSize: number }
  - Optional cursor?: string
    
    The cursor that specifies where to start to get data. If there will be data on the next page, this method will return the value of this field to indicate the position to start to get data of the next page. If it is null, the data of the first page will be fetched.
  - pageSize: number
    
    The number of data entries per page. The default value is 10.
Returns Promise<AsyncResult<GetSilentModeRemindTypeConversationsResult>>
```
connection.getAllSilentModeConversations({pageSize: 10})
```

setPushPerformLanguage

setPushPerformLanguage(this: Connection, params: { language: string; error?: any; success?: any }): Promise<AsyncResult<TranslationLanguageType>>

Set user push translation language.
```
connection.setPushPerformLanguage({language: 'EU'})
```
Parameters
- this: Connection
- params: { language: string; error?: any; success?: any }
  - language: string
    
    translation language
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<TranslationLanguageType>): void
    - Parameters
      - res: AsyncResult<TranslationLanguageType>
      Returns void
Returns Promise<AsyncResult<TranslationLanguageType>>

setSilentModeForAll

setSilentModeForAll(this: Connection, params: { options: SilentModeParamType; error?: any; success?: any }): Promise<AsyncResult<SilentModeConversationType>>

Set the DND Settings for the current login user.
```
connection.setSilentModeForAll({options: {paramType: 0, remindType: 'ALL'}})
```
Parameters
- this: Connection
- params: { options: SilentModeParamType; error?: any; success?: any }
  - options: SilentModeParamType
    
    Options object include paramType,remindType,duration,startTime,endTime.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<SilentModeConversationType>): void
    - Parameters
      - res: AsyncResult<SilentModeConversationType>
      Returns void
Returns Promise<AsyncResult<SilentModeConversationType>>

setSilentModeForConversation

setSilentModeForConversation(this: Connection, params: { conversationId: string; options: SilentModeParamType; type: CONVERSATIONTYPE; error?: any; success?: any }): Promise<AsyncResult<SilentModeConversationType>>

Set the DND of the session.
```
connection.setSilentModeForConversation({conversationId: '100', type: 'singleChat', params: {paramType: 0, remindType: 'ALL'}})
```
Parameters
- this: Connection
- params: { conversationId: string; options: SilentModeParamType; type: CONVERSATIONTYPE; error?: any; success?: any }
  - conversationId: string
    
    The Conversation id. For one-to-one chat, conversation ID is to chat user's name. For group chat, conversation ID is group ID, different with group name. For chat room, conversation ID is chat room ID, different with chat room name. For help desk, it is same with one-to-one chat, conversation ID is also chat user's name.
  - options: SilentModeParamType
    
    Options object include paramType,remindType,duration,startTime,endTime.
  - type: CONVERSATIONTYPE
    
    Conversation type.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<SilentModeConversationType>): void
    - Parameters
      - res: AsyncResult<SilentModeConversationType>
      Returns void
Returns Promise<AsyncResult<SilentModeConversationType>>

Index

Functions

Functions

clearRemindTypeForConversation

Parameters

this: Connection

params: { conversationId: string; type: CONVERSATIONTYPE; error?: any; success?: any }

conversationId: string

type: CONVERSATIONTYPE

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<SilentModeConversationType>

Returns void

Returns Promise<AsyncResult<SilentModeConversationType>>

getPushPerformLanguage

Parameters

this: Connection

Optional params: { error?: any; success?: any }

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<TranslationLanguageType>

Returns void

Returns Promise<AsyncResult<TranslationLanguageType>>

getSilentModeForAll

Parameters

this: Connection

Optional params: { error?: any; success?: any }

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<SilentModeConversationType>

Returns void

Returns Promise<AsyncResult<SilentModeConversationType>>

getSilentModeForConversation

Parameters

this: Connection

params: { conversationId: string; type: CONVERSATIONTYPE; error?: any; success?: any }

conversationId: string

type: CONVERSATIONTYPE

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<SilentModeConversationType>

Returns void

Returns Promise<AsyncResult<SilentModeConversationType>>

getSilentModeForConversations

Parameters

this: Connection

params: { conversationList: ConversationListType[]; error?: any; success?: any }

conversationList: ConversationListType[]

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<ConversationSilentModeType>

Returns void

Returns Promise<AsyncResult<ConversationSilentModeType>>

getSilentModeRemindTypeConversations

Parameters

this: Connection

params: { cursor?: string; pageSize: number }

Optional cursor?: string

pageSize: number

Returns Promise<AsyncResult<GetSilentModeRemindTypeConversationsResult>>