LocalCache | Agora Chat SDK API Reference

LocalCache contains APIs for local operations.

Index

Functions

clearConversationUnreadCount

clearConversationUnreadCount(this: Connection, params: SessionParams): Promise<void>

Resets the number of unread messages in a conversation to 0.

connection.localCache.clearConversationUnreadCount({conversationId: 'conversationId', conversationType: 'singleChat' })

Parameters

this: Connection
params: SessionParams

Returns Promise<void>

getLocalConversation

getLocalConversation(this: Connection, params: SessionParams): Promise<AsyncResult<LocalCacheType.ConversationItem | undefined>>

Gets a local conversation.
```
connection.localCache.getLocalConversation({conversationId: 'conversationId', conversationType: 'singleChat' })
```
Parameters
- this: Connection
- params: SessionParams
Returns Promise<AsyncResult<LocalCacheType.ConversationItem | undefined>>

getLocalConversations

getLocalConversations(this: Connection): Promise<AsyncResult<LocalCacheType.ConversationItem[]>>

Gets the local conversation list.
```
connection.localCache.getLocalConversations()
```
Parameters
- this: Connection
Returns Promise<AsyncResult<LocalCacheType.ConversationItem[]>>

removeLocalConversation

removeLocalConversation(this: Connection, params: RemoveLocalConversationParams): Promise<void>

Removes a local conversation.

connection.localCache.removeLocalConversation({conversationId: 'conversationId', conversationType: 'singleChat' })

Parameters

this: Connection
params: RemoveLocalConversationParams

Returns Promise<void>

setLocalConversationCustomField

setLocalConversationCustomField(this: Connection, params: UpdateConversationParams): Promise<void>

Sets the local conversation custom field.

connection.localCache.setLocalConversationCustomField({conversationId: 'conversationId', conversationType: 'singleChat', customField: {key:'value'} })

Parameters

this: Connection
params: UpdateConversationParams

Index

Functions

Functions

clearConversationUnreadCount

Parameters

this: Connection

params: SessionParams

Returns Promise<void>

getLocalConversation

Parameters

this: Connection

params: SessionParams

Returns Promise<AsyncResult<LocalCacheType.ConversationItem | undefined>>

getLocalConversations

Parameters

this: Connection

Returns Promise<AsyncResult<LocalCacheType.ConversationItem[]>>

removeLocalConversation

Parameters

this: Connection

params: RemoveLocalConversationParams

Returns Promise<void>

setLocalConversationCustomField

Parameters

this: Connection

params: UpdateConversationParams

Returns Promise<void>