TypeScriptexport interface NIMEBaseServiceInterface<I extends NIMEBaseListener> {
  /**
   * 继承自 eventEmitter3 的监听事件方法
   */
  on<T extends keyof I>(eventName: T, fn: (...args: I[T]) => void): void
  /**
   * 继承自 eventEmitter3 的监听事件方法
   */
  once<T extends keyof I>(eventName: T, fn: (...args: I[T]) => void): void
}

TypeScriptnim.localConversationService.on("onSyncStarted", () => {})
nim.localConversationService.on("onSyncFinished", () => {})
nim.localConversationService.on("onSyncFailed", (err) => {})
nim.localConversationService.on("onConversationCreated", (conversation: V2NIMLocalConversation) => {})
nim.localConversationService.on("onConversationDeleted", (conversationIds: string[]) => {})
nim.localConversationService.on("onConversationChanged", (conversationList: V2NIMLocalConversation[]) => {})
nim.localConversationService.on("onTotalUnreadCountChanged", (unreadCount: number) => {})
nim.localConversationService.on("onUnreadCountChangedByFilter", (filter: V2NIMLocalConversationUnreadCountChangedFilter, unreadCount: number) => {
nim.localConversationService.on("onConversationReadTimeUpdated", (conversationId: string, readTime: number) => {})

TypeScriptexport interface NIMEBaseServiceInterface<I extends NIMEBaseListener> {
  /**
   * 继承自 EventEmitter3 的取消监听方法。
   */
  off<T extends keyof I>(eventName: T, fn: (...args: I[T]) => void): void
  /**
   * 继承自 eventEmitter3 的移除事件方法
   */
  removeAllListeners<T extends keyof I>(eventName?: T): void
}

TypeScriptnim.localConversationService.off("onSyncStarted", theListner)
nim.localConversationService.off("onSyncFinished", theListner)
nim.localConversationService.off("onSyncFailed", theListner)
nim.localConversationService.off("onConversationCreated", theListner)
nim.localConversationService.off("onConversationDeleted", theListner)
nim.localConversationService.off("onConversationChanged", theListner)
nim.localConversationService.off("onTotalUnreadCountChanged", theListner)
nim.localConversationService.off("onUnreadCountChangedByFilter", theListner)
nim.localConversationService.off("onConversationReadTimeUpdated", theListner)
// remove all listeners
nim.localConversationService.removeAllListeners()

TypeScriptcreateConversation(conversationId: string): Promise<V2NIMLocalConversation>

TypeScriptlet conversationId: string = "cjl|1|cjl1";
try {
  let conv = await this.localConversationService.createConversation(conversationId)
  // success
} catch (e) {
  // fail
}

Promise<V2NIMLocalConversation> 本地会话对象

创建成功，返回 onConversationCreated 回调。

TypeScriptdeleteConversation(conversationId: string, clearMessage?: boolean): Promise<void>

TypeScriptlet conversationId: string = "cjl|1|cjl1";
let clearMessage: boolean = true;
try {
  await this.localConversationService.deleteConversation(conversationId, clearMessage)
  // success
} catch (e) {
  // fail
}

Promise<void>

删除成功，返回 onConversationDeleted 回调。可能返回 onTotalUnreadCountChanged 和 onUnreadCountChangedByFilter 回调。

TypeScriptdeleteConversationListByIds(conversationIds: string[], clearMessage?: boolean): Promise<V2NIMLocalConversationOperationResult[]>

TypeScriptlet conversationIds: string[] = ["cjl|1|cjl1", "cjl|2|cjl2"];
let clearMessage: boolean = true;
try {
  let deleteFailedConversationList: V2NIMLocalConversationOperationResult[] = await this.localConversationService.deleteConversationListByIds(conversationIds, clearMessage)
  if (deleteFailedConversationList && deleteFailedConversationList.length > 0) {
    // partial success
  } else {
    // all success
  }
} catch (e) {
  // fail
}

Promise<V2NIMLocalConversationOperationResult[]> 每个本地会话操作的返回对象

每一条本地会话删除成功，均返回 onConversationDeleted 回调。可能返回 onTotalUnreadCountChanged 和 onUnreadCountChangedByFilter 回调。

TypeScriptgetConversation(conversationId: string): Promise<V2NIMLocalConversation>

TypeScriptlet conversationId: string = "cjl|1|cjl1";
try {
  let conv = await this.localConversationService.getConversation(conversationId)
  // success
} catch (e) {
  // fail
}

Promise<V2NIMLocalConversation> 本地会话对象

无

TypeScriptgetConversationList(offset: number, limit: number): Promise<V2NIMLocalConversationResult>

TypeScripttry {
  const result = await nim.localConversationService.getConversationList(0, 100)
  // success
} catch (err) {
  // fail
}

Promise<V2NIMLocalConversationResult> 分页查询本地会话列表结果

无

TypeScriptgetConversationListByOption(offset: number, limit: number, option: V2NIMLocalConversationOption): Promise<V2NIMLocalConversationResult>

TypeScriptlet offset: number = 0;
let limit: number = 100;
let option: V2NIMLocalConversationOption = {
  conversationTypes: [V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P]
}

try {
  let result = await this.localConversationService.getConversationListByOption(offset, limit, option)
  // success
} catch (e) {
  // fail
}

Promise<V2NIMLocalConversationResult> 分页查询本地会话列表结果

无

TypeScriptgetConversationListByIds(conversationIds: string[]): Promise<V2NIMLocalConversation[]>

TypeScriptlet conversationIds: string[] = ["cjl|1|cjl1", "cjl|2|cjl2"];
try {
  let result = await this.localConversationService.getConversationListByIds(conversationIds)
  // success
} catch (e) {
  // fail
}

Promise<V2NIMLocalConversation[]> 本地会话列表

无

TypeScriptupdateConversationLocalExtension(conversationId: string, localExtension: string): Promise<void>

TypeScriptlet conversationId: string = "cjl|1|cjl1"
let localExtension: string = "localExtension"
try {
  await this.localConversationService.updateConversationLocalExtension(conversationId, localExtension)
  // success
} catch (e) {
  // fail
}

Promise<void>

更新成功，返回 onConversationChanged 回调。

TypeScriptstickTopConversation(conversationId: string, stickTop: boolean): Promise<void>

TypeScriptlet conversationId: string = "cjl|1|cjl1"
let stickTop: boolean = true;
try {
  await this.localConversationService.stickTopConversation(conversationId, stickTop)
  // success
} catch (e) {
  // fail
}

Promise<void>

置顶成功，返回 onConversationChanged 回调。

TypeScriptgetTotalUnreadCount(): number

无参数

TypeScriptconst unreadCount: number = this.localConversationService.getTotalUnreadCount()

当消息未读数有任何变更，返回 onTotalUnreadCountChanged 回调。

TypeScriptgetUnreadCountByIds(conversationIds: string[]): Promise<number>

TypeScriptlet conversationIds: string[] = ["cjl|1|cjl1", "cjl|2|cjl2"];
try {
  const unreadCount: number = await this.localConversationService.getUnreadCountByIds(conversationIds)
  // success
} catch (e) {
  // fail
}

Promise<number> 指定的本地会话列表的消息总未读数

无

TypeScriptgetUnreadCountByFilter(filter: V2NIMLocalConversationFilter): Promise<number>

TypeScriptlet filter: V2NIMLocalConversationFilter = {
  conversationTypes: [V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P]
}
try {
  let unreadCount: number = await this.localConversationService.getUnreadCountByFilter(filter)
  // success
} catch (e) {
  // fail
}

Promise<number> 过滤后的本地会话列表的消息总未读数

无

TypeScriptclearTotalUnreadCount(): Promise<void>

无参数

TypeScripttry {
  await this.localConversationService.clearTotalUnreadCount()
  // success
} catch (e) {
  // fail
}

Promise<void>

清零成功，返回 onTotalUnreadCountChanged、onConversationChanged 和 onUnreadCountChangedByFilter 回调。

TypeScriptclearUnreadCountByIds(conversationIds: string[]): Promise<V2NIMLocalConversationOperationResult[]>

TypeScriptlet conversationIds: string[] = ["cjl|1|cjl1", "cjl|2|cjl2"];
try {
  const deleteFailedConversationList: V2NIMLocalConversationOperationResult[] = await this.localConversationService.clearUnreadCountByIds(conversationIds)
  if (deleteFailedConversationList && deleteFailedConversationList.length > 0) {
    // partial success
  } else {
    // all success
  }
} catch (e) {
  // fail
}

Promise<V2NIMLocalConversationOperationResult []> 每个本地会话操作的返回对象

清零成功，返回 onTotalUnreadCountChanged、onConversationChanged 和 onUnreadCountChangedByFilter 回调。

TypeScriptclearUnreadCountByTypes(types: V2NIMConversationType[]): Promise<void>

TypeScriptlet conversationTypes:V2NIMConversationType[] = [V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P]
try {
  await this.localConversationService.clearUnreadCountByTypes(conversationTypes)
  // success
} catch (e) {
  // fail
}

Promise<void>

清零成功，返回 onTotalUnreadCountChanged、onConversationChanged 和 onUnreadCountChangedByFilter 回调。

TypeScriptsubscribeUnreadCountByFilter(filter: V2NIMLocalConversationFilter): void

TypeScriptconst filter: V2NIMLocalConversationFilter = {
  conversationTypes: [V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P]
}
try {
  this.localConversationService.subscribeUnreadCountByFilter(filter)
  // success
} catch (e) {
  // fail
}

订阅成功后，当订阅的本地会话消息未读数发生变更，返回 onUnreadCountChangedByFilter 回调。

TypeScriptunsubscribeUnreadCountByFilter(filter: V2NIMLocalConversationFilter): void

TypeScriptconst filter: V2NIMLocalConversationFilter = {
  conversationTypes: [V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P]
}
try {
  this.localConversationService.unsubscribeUnreadCountByFilter(filter)
  // success
} catch (e) {
  // fail
}

无

TypeScriptmarkConversationRead(conversationId: string): Promise<void>

TypeScriptawait this.localConversationService.markConversationRead('me|1|you')

Promise<void>

无

TypeScriptgetConversationReadTime(conversationId: string): Promise<number>

TypeScriptawait this.localConversationService.getConversationReadTime('me|1|you')

Promise<number> 本地会话已读时间戳

无