IM 即时通讯
Android
新手接入指南
产品介绍
简介
主要功能
产品优势
海外数据中心
接口及业务限制
功能介绍
帐号集成与登录
群组功能
聊天室功能
聊天室标签功能
圈组功能
多端登录与互踢策略
质量数据监控台
更新日志
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能列表
快速集成 IM UIKit
组件导入
初始化
界面跳转
自定义用户信息
全局配置
IM UIKit API 概览
会话列表相关
集成会话列表界面
会话列表事件监听
自定义会话列表界面 UI
会话列表 API 概览
会话消息相关
集成会话界面
会话界面事件监听
实现自定义消息发送(含 UI)
自定义会话界面 UI
会话消息 API 概览
通讯录相关
集成通讯录界面
自定义通讯录界面 UI
通讯录界面事件监听
通讯录 API 概览
不含 UI 集成
使用说明
集成与初始化
登录管理
消息相关
消息概述
消息收发
自定义消息收发
消息配置选项
多媒体资源存储场景
广播消息收发
消息已读回执
消息撤回
消息重发与转发
消息更新
消息过滤
语音消息处理
插入本地消息
历史消息
最近会话
服务端会话服务
用户资料
用户关系
在线状态订阅
系统通知
离线推送与消息提醒
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
聊天室
圈组功能
登录管理
服务器相关
服务器概述
服务器管理
服务器成员管理
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
频道未读数管理
实时互动频道
频道分组
频道分组黑白名单
搜索服务器和频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
用户定制权限
频道分组身份组
自定义权限
成员权限查询与判定
身份组相关查询
圈组订阅机制
消息相关
图解圈组消息流转
圈组消息收发
圈组消息撤回
圈组消息更新
圈组消息删除
会话消息回复(Thread)
圈组快捷评论
消息正在输入
获取频道最后一条消息
查询历史消息
圈组消息缓存
圈组消息搜索
系统通知
圈组离线推送
圈组内容审核
圈组相关抄送
圈组第三方回调
反垃圾
聊天扩展
其他
最佳实践
IM 应用隐私合规
聊天室重要消息投递
API 参考
Android API 参考
Android 端状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
常见问题
FAQ
错题集
Android 端推送问题排查
服务协议

初始化

更新时间: 2022/09/01 09:40:05

在使用 IM UIKit 功能前,必须先对其进行初始化,但不需要对 IM SDK 单独初始化。

IM UIKit 的核心类IMKitClient,提供初始化、登录、获取当前账号信息等能力。

前提条件

进行初始化之前,请确保您已完成组件导入

初始化(简化方式)

IM UIKit 的初始化,最简单的实现方式为:在应用启动时,调用IMKitClient.init方法。

初始化必须在应用的生命周期内进行,且只可进行一次。

  • 方法原型

    IMKitClient.init(Context context,LoginInfo info,SDKOptions options)
    
  • 参数说明

    参数 类型 说明
    context Context 应用上下文
    info LoginInfo 登录信息可为空,LoginInfo 内需要传入账号ID 和 token,同时登录模式可在 LoginInfo 中设置
    options SDKOptions 初始化配置信息,必填。必须要设置 App Key,其他按照需求设置
  • 示例代码

    public class IMApplication extends MultiDexApplication {
    
        private static final String TAG = "IMApplication";
    
        @Override
        public void onCreate() {
            SDKOptions options = new SDKOptions();
            options.appKey = "App Key";
            LoginInfo loginInfo = LoginInfo.LoginInfoBuilder.loginInfoDefault("id","token").build();
            IMKitClient.init(this,loginInfo,options);
        }
    
    }
    
    

初始化最佳实践

用户首次打开应用,需要接受应用的隐私协议,以保证业务隐私合规。因此建议在用户接受隐私协议之后再进行初始化。

参考流程如下:

  1. 在 Application 中进行初始化和隐私协议判断。

    public class IMApplication extends MultiDexApplication {
    
        @Override
        public void onCreate() {
        
            //获取用户是否同意隐私协议,getPrivacyStatus()需要自己实现,在用户同意的时候本地保存,然后这里进行读取。
            bool agreePrivacy = getPrivacyStatus();
            SDKOptions options = new SDKOptions();
            //填入App Key
            options.appKey = "App Key";
            //如果有account和token信息可以填入登录信息直接进行登录
            LoginInfo loginInfo = LoginInfo.LoginInfoBuilder.loginInfoDefault("account","token").build(); 
            if(agreePrivacy){
              IMKitClient.init(this,loginInfo,options);
            }else {
              //采用config方式,仅仅是配置,不影响性能
              IMKitClient.config(this,loginInfo,options);
            }
        
        }
        
    }
    
    
  2. 如果用户没有同意隐私协议,则自行实现相关页面跳转逻辑和目标页面,例如跳转到隐私协议授权页面PrivacyActivity

    public class PrivacyActivity extends Activity {
    
          private void agreePrivacy(){
          //当用户同意隐私协议,则调用初始化接口
            IMKitClient.initSDK();
            
          }
    }
    

    上述示例代码中PrivacyActivityagreePrivacy()仅为示例名称,相应的逻辑需要开发者自行实现。

此文档是否对你有帮助?
有帮助
我要吐槽
  • 前提条件
  • 初始化(简化方式)
  • 初始化最佳实践