Skip to content
v1
文档/Android SDK/开发指南

Android SDK API 参考

本文档以当前 Android imsdk 模块的公开源码为准。SDK 通过单例 BimImManager 暴露核心 Service 和 Manager:

kotlin
val im = BimImManager.getInstance()
val chat = im.chatService
val conversations = im.conversationService
val discussions = im.discussionService
val friends = im.friendService
val users = im.userService

调用约定

  • 新代码优先使用 suspend 方法,并在自己的 CoroutineScope 中调用。
  • 旧的 suspend + BimResultCallback / BimSendCallback 重载仍保留用于兼容,但已标记为 deprecated。
  • callback 成功或失败只回调一次;业务 callback 和 listener 默认由 Android 主线程派发,可通过 BimImConfig.Builder.setCallbackExecutor(Executor) 指定串行 executor。
  • listener 使用稳定 key 注册;同 key 注册会替换旧 listener。移除页面或业务模块时,应按 listener 或 key 移除。
  • BimError 是 suspend API 的失败类型,包含稳定 codemessage。同步 getter、参数校验和未初始化调用仍可能直接抛出 IllegalStateExceptionIllegalArgumentException

模块

导入

核心公开类型位于以下包:

kotlin
import com.foreveross.imsdk_android.api.BimImConfig
import com.foreveross.imsdk_android.api.BimImManager
import com.foreveross.imsdk_android.api.model.*
import com.foreveross.imsdk_android.api.listener.*

imsdk-rtc 是独立的可选模块,不属于本文核心消息 API;其接入方式见 Android 项目的 RTC 说明。