Control

class Control

Created by liutao7 on 2023/5/30

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

监听app进入前台、后台状态变化

Link copied to clipboard

监听 sdk 调用connect之后的连接成功状态

Link copied to clipboard

监听退登状态,包括调用logout退登及异常退登

Link copied to clipboard
Link copied to clipboard

监听退登状态,包括调用autoLogin及异常退登

Link copied to clipboard

web socket连接状态监听器

Link copied to clipboard
class Session

Properties

Link copied to clipboard

设置收到音频消息时是否自动下载

Link copied to clipboard

ws连接状态;

---

Link copied to clipboard

自定义会话摘要转换器

Link copied to clipboard
var customContextMenuManager: <Error class: unknown class>?

消息长按上下文菜单

Link copied to clipboard
var customMediaDownloadUrlFetcher: <Error class: unknown class>

自定义媒体资源链接获取

Link copied to clipboard

是否显示消息已读未读状态

Link copied to clipboard

是否显示快捷回复

Link copied to clipboard

SDK 的字体缩放、语言配置,若接入方自行进行了整体控制,没必要再修改此配置 此配置只影响 com.kingsoft.kim.kit.ui.KIMBaseActivity 字体缩放,不配置默认跟随系统 若希望字体缩放不跟随系统,可设置 fontScale = 1.0f 切换后重启app

Link copied to clipboard
var infoProvider: <Error class: unknown class>?

app 提供给 SDK 的数据接口 app 实现 KIMInfoProvider 并通过该接口注入 app 层实现

Link copied to clipboard
val languageCtrl: <Error class: unknown class>

语言配置入口,配置后会影响全局,切换语言后需要重启app

Link copied to clipboard
Link copied to clipboard
var messageTextTransformer: <Error class: unknown class>

自定义消息文字处理器,当收到消息后对消息进行渲染前,用户可以 对消息内容进行处理,比如对部分文字进行高亮处理,文字加粗等。

Link copied to clipboard

app 下载页面地址,如未支持的消息可点击跳转到app下载页面

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun active(appId: String, authCode: String, callback: KIMCore.ActiveCallback)

sso登录,激活

Link copied to clipboard
fun addCacheCommonSettingListener(lifecycleOwner: LifecycleOwner? = null, listener: <Error class: unknown class>)
Link copied to clipboard

设置自定义会话摘要转换器, SDK 提供了默认实现

Link copied to clipboard

增加自定义的消息媒体资源解析器

Link copied to clipboard
fun addCustomTransparentMessageListener(owner: LifecycleOwner?, listener: OnReceiveCustomTransparentMessageListener)

添加自定义透传消息监听器

Link copied to clipboard

消息列表底部输入框事件监听 可监听文字输入,粘贴及发送按钮点击事件

Link copied to clipboard

注册自定义的消息高亮数据处理及转换,SDK内置了at人的高亮梳理,处理数据 message-ext-highlights 参考com.kingsoft.kim.kit.ui.span.data.KHighlight数据定义 用户可通过此方式实现文本高亮,也可通过其他方式自行处理 kit内置了@高亮处理,如需自定义颜色等可继承com.kingsoft.kim.kit.ui.span.at.KAtNameHighlightHandler 实现自定义处理后重新加入自定义处理器

Link copied to clipboard

添加消息列表后处理 使用场景:拉取历史消息完成后,需要对消息列表进行批量处理并显示

Link copied to clipboard

添加 app 进入前台、后台状态变化监听

Link copied to clipboard

添加调用 connect 连接成功时监听

Link copied to clipboard

机器人聚合企业配置相关变化及处理通知 注意:不是实时的

Link copied to clipboard

添加调用 logout 或者异常退出登录监听

Link copied to clipboard

添加异常退出登录监听 监听退登状态,包括调用autoLogin及异常退登

Link copied to clipboard

添加 web socket状态变化监听

Link copied to clipboard

设置撤回消息转换器

Link copied to clipboard

添加未读数监听数据源

Link copied to clipboard
fun asyncCropSetting(callback: WResult.Callback<Boolean>?)

更新企业配置信息

Link copied to clipboard
fun autoLogin()

自动登录

Link copied to clipboard
fun connect(callback: KIMCore.ConnectCallback)

sso登录,链接

fun connect(kimSid: String?, callback: KIMCore.ConnectWithKimSidCallback?)

通过 sid 进行连接

Link copied to clipboard

本地缓存是否包含指定key

Link copied to clipboard
fun createNewConfigurationContext(newBase: Context, language: <Error class: unknown class>, customFontScale: Float?): Context

根据新的语言、字体缩放配置创建新的 Context

Link copied to clipboard
fun forceLogout(callback: IOperationCallback?)

强制退出登录

Link copied to clipboard
fun <V> getCacheCommonSetting(followUser: Boolean = false, key: String, defaultValue: V): V

获取本地缓存

Link copied to clipboard
fun <V> getCacheCropSetting(key: String, defaultValue: V): V

获取当前缓存的企业配置信息,本地无数据或数据转换异常时将返回默认值

Link copied to clipboard
Link copied to clipboard
fun getLoginDeviceList(callback: (LoginDeviceResult?) -> Unit? = null)

获取已经登录的设备列表信息

Link copied to clipboard
Link copied to clipboard
fun initPushSdk(context: Context)

初始化Push SDK

Link copied to clipboard
fun isNightMode(context: Context): Boolean

是否为夜间模式

Link copied to clipboard
fun kickLoginDevice(deviceId: String, callback: (KickLoginDeviceResult?) -> Unit? = null)

下线指定设备

Link copied to clipboard
fun login(appId: String, authCode: String, callback: KIMCore.ActiveCallback)

授权码登录 授权码登录需要开发者完成账号认证配置,完成配置后调用该方法 传入授权码及应用Id进行登录会话的建立。建立登录会话后,才能使用SDK的服务功能。

Link copied to clipboard
fun logout(callback: IOperationCallback?)

退出后完全断开,不再收到离线推送, 同时清理内存缓存

Link copied to clipboard
fun removeCacheCommonSettingListener(listener: <Error class: unknown class>)
Link copied to clipboard
fun removeCustomTransparentMessageListener(listener: OnReceiveCustomTransparentMessageListener)

移除自定义透传消息监听器

移除 app 进入前台、后台状态变化监听

Link copied to clipboard

移除调用 connect 连接成功时监听

Link copied to clipboard

移除调用 logout 或者异常退出登录监听

Link copied to clipboard

移除异常退出登录监听

Link copied to clipboard
Link copied to clipboard

会话列表滚动到顶部

Link copied to clipboard

会话列表滚动到下一个未读消息位置

Link copied to clipboard
fun setNightMode(mode: Int)

设置夜间模式

fun setNightMode(activity: Activity, mode: Int)

设置夜间模式, 兼容Activity, FragmentActivity, AppCompatActivity 若入口 Activity为 Activity 或者 FragmentActivity, 建议这样使用: override fun onCreate(savedInstanceState: Bundle?) { KIMKit.instance.setNightMode(this, mode) super.onCreate(savedInstanceState) }

Link copied to clipboard

通知栏点击事件监听

Link copied to clipboard
fun setPushToken(pushType: String, token: String)

假如没有使用sdk提供的推送包,那么请将获取的对应厂商的token设置进来

Link copied to clipboard
fun <V> updateCacheCommonSetting(followUser: Boolean = false, key: String, value: V)

更新本地缓存