# Interface ChatroomKVStatusListener

IMLib 聊天室 KV 状态变化监听器

#### Version

1.1.0

interface ChatroomKVStatusListener {
onChatroomKVSync(roomId: string): void;
onChatroomKVUpdate(roomId: string, entries: Map<string, string>): void;
onChatroomKVRemove(roomId: string, entries: Map<string, string>): void;
}

- Defined in chatroom/listener/ChatroomKVStatusListener.ts:5

##### Index

### Methods

onChatroomKVSync
onChatroomKVUpdate
onChatroomKVRemove

## Methods

### onChatroomKVSync

- onChatroomKVSync(roomId: string): void

  IMLib 刚加入聊天室时 KV 同步完成的回调

      触发时机：加入聊天室成功后，SDK 默认从服务端同步 KV 列表，同步完成后触发。

  #### Parameters

  - roomId: string

    聊天室 ID

  #### Returns void

  - Defined in chatroom/listener/ChatroomKVStatusListener.ts:13

### onChatroomKVUpdate

- onChatroomKVUpdate(roomId: string, entries: Map<string, string>): void

  IMLib 聊天室 KV 变化的回调

      触发时机：聊天室 KV 更新时。
      如果刚进入聊天室时存在 KV，会通过此回调将所有 KV 返回，再次回调时为其他人设置或者修改 KV 的增量数据。

  #### Parameters

  - roomId: string

    聊天室 ID

  - entries: Map<string, string>

    发生变化的 KV,返回 KV 变化的增量数据。加入某个聊天室后第一次回调会返回全量 KV

  #### Returns void

  - Defined in chatroom/listener/ChatroomKVStatusListener.ts:24

### onChatroomKVRemove

- onChatroomKVRemove(roomId: string, entries: Map<string, string>): void

  IMLib 聊天室 KV 被删除的回调

      触发时机：KV 被删除时触发。

  #### Parameters

  - roomId: string

    聊天室 ID

  - entries: Map<string, string>

    被删除的 KV

  #### Returns void

  - Defined in chatroom/listener/ChatroomKVStatusListener.ts:34