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 端推送问题排查
服务协议

跑通 IM Demo 源码

更新时间: 2022/10/17 14:46:45

网易云信在 Github 上提供开源的 IM Demo 源码。您可参考 Demo 源码,在您的本地项目中快速构建即时通讯应用。

本文介绍如何快速跑通 Demo 源码。

主要模块

主要模块.png

前提条件

在开始运行示例项目之前,请确保您已:

  • 云信控制台完成以下操作。


    创建应用并获取 App Key 和 App Secret 1. 在左侧导航栏中找到“应用”,并单击“创建”。
    创建应用
    2. 填写应用的基本信息后,单击“创建”。
    创建应用
    3. 创建应用后,可以在左侧导航栏中查看该应用,并单击 “App Key 管理”,并获取 App Key 和 App Secret。
    查看应用的AppKey
    注册云信 IM 账号,获取 accid 和 token

    注册云信 IM 账号,获取 accid 和 token。accid 和 token 将用于登录云信服务端。

    1. 在左侧导航栏中单击指定应用名称,进入该应用的详情页面。
    2. 在“功能管理”中单击“账号管理”。
    账号管理
    3. 在测试页面,单击“新建账号”,并填写账号(即accid)、昵称(即 name)、密码(即 Token)后,单击“确定”。
    确定
  • 准备如下开发环境:

    环境要求 说明
    JDK 版本 1.8.0 及以上版本
    Android API 版本 API 21、Android 5.0 及以上版本
    CPU架构 ARM 64、ARM V7
    IDE Android Studio 4.0及以上
    其他 依赖 Androidx,不支持 support 库。请使用 Android 系统 5.0 或以上版本的移动设备。

跑通流程

  1. 前往 GitHub 下载 Demo 源码

    示例项目结构如下:

    目录 说明
    app 应用主入口,包含外部界面框架
    chatkit-ui 聊天功能界面相关代码
    contactkit-ui 通讯录功能界面相关代码
    conversationkit-ui 会话功能界面相关代码
    qchatkit-ui 圈组功能(类 Discord 场景)界面相关代码
    • 如未开通圈组试用权限,请勿引入圈组组件,否则将无法跑通 Demo 源码。
    • 如需体验圈组,请先通过云信官网首页提供的微信、电话等方式联系商务经理开通圈组试用权限。
    searchkit-ui 搜索功能界面相关代码
    teamkit-ui 群组功能界面相关代码
  2. 将示例项目导入 Android Studio。

  3. 在 Android Studio 里找到工程目录 app/src/main/AndroidManifest.xml 文件,将文件里如下代码中的your app key替换成您的 App Key。

    <meta-data
            android:name="com.netease.nim.appKey"
            android:value="your app key" />
    
    
  4. 在 Android Studio 里找到工程目录 app/src/main/java/com.netease.yunxin.app.im.welcome.WelcomeActivity.java 文件,将文件里找到方法startLogin设置云信 IM 账号和 Token。

    private void startLogin() {
            //将您的云信IM账号(accid)和Token设置在这里即可
            String account = "";
            String token = "";
            .....
    }
    
  5. 将源码运行在您的 Android 设备上,即可进入如下界面,开始体验 IM Demo。

此文档是否对你有帮助?
有帮助
我要吐槽
  • 主要模块
  • 前提条件
  • 跑通流程