https://docs-im.easemob.com/ 2026-04-19T12:53:42+00:00 https://docs-im.easemob.com/ https://docs-im.easemob.com/lib/tpl/bootstrap3_ori/images/favicon.ico text/html 2022-09-19T10:22:06+00:00 https://docs-im.easemob.com/ccim/unity/apireference?rev=1663582926&do=diff Unity SDK API Doc 更新时间：2022-08-12 ---------- * Unity SDK API Doc text/html 2022-07-19T08:15:06+00:00 https://docs-im.easemob.com/ccim/unity/chatroom1?rev=1658218506&do=diff 聊天室概述 更新时间：2022-07-15 功能描述 聊天室是支持多人加入的类似 Twitch 的组织。聊天室中的成员没有固定关系，用户离线后，超过 5 分钟会自动退出聊天室。聊天室成员在离线后，不会收到推送消息。聊天室可以应用于直播、消息广播等。 text/html 2022-08-05T08:33:05+00:00 https://docs-im.easemob.com/ccim/unity/chatroom2?rev=1659688385&do=diff 创建和管理聊天室以及监听器介绍 聊天室是支持多人沟通的即时通讯系统。聊天室中的成员没有固定关系，用户离线后，超过 5 分钟会自动退出聊天室。聊天室成员在离线后，不会收到推送消息。聊天室可以应用于直播、消息广播等。 text/html 2022-08-05T08:32:50+00:00 https://docs-im.easemob.com/ccim/unity/chatroom3?rev=1659688370&do=diff 管理聊天室成员 聊天室是支持多人沟通的即时通讯系统。本文介绍如何使用环信即时通讯 IM SDK 在实时互动 app 中管理聊天室成员，并实现聊天室的相关功能。 技术原理 环信即时通讯 IM SDK 提供 text/html 2022-08-05T08:32:16+00:00 https://docs-im.easemob.com/ccim/unity/chatroom4?rev=1659688336&do=diff 管理聊天室属性 聊天室是支持多人沟通的即时通讯系统。本文介绍如何管理聊天室的属性信息。 技术原理 环信即时通讯 IM SDK 提供 Room、IRoomManager 和 IRoomManagerDelegate 类用于聊天室管理，支持你通过调用 text/html 2022-08-05T08:04:16+00:00 https://docs-im.easemob.com/ccim/unity/errorcode?rev=1659686656&do=diff Unity 常见错误代码 更新时间：2022-06-22 本文主要介绍在调用环信即时通讯 Unity SDK 中的接口过程中，SDK 返回的错误码和错误信息。 你可以根据如下错误码及错误信息了解出错的可能原因，并采取响应措施。 text/html 2022-07-19T08:15:42+00:00 https://docs-im.easemob.com/ccim/unity/group1?rev=1658218542&do=diff 群组 更新时间：2022-07-15 功能描述 群组是支持多人沟通的即时通讯系统，成员关系相对稳定。所有群成员可以收到群中的消息，可以在群中发送消息。群成员离线时可以收到推送消息。群组成员支持多种角色：群主、群管理员和普通成员。群组提供丰富的管理能力，如群组禁言、群公告和群文件等。 text/html 2022-08-05T08:09:58+00:00 https://docs-im.easemob.com/ccim/unity/group2?rev=1659686998&do=diff 群组-创建和管理群组及监听器介绍 群组是支持多人沟通的即时通讯系统，本文介绍如何使用环信即时通讯 IM SDK 在实时互动 app 中创建和管理群组，并实现群组相关功能。 如需查看消息相关内容，参见 text/html 2022-08-05T08:10:45+00:00 https://docs-im.easemob.com/ccim/unity/group3?rev=1659687045&do=diff 群组-管理群组成员 群组是支持多人沟通的即时通讯系统，本文介绍如何使用环信即时通讯 IM SDK 在实时互动 app 中实现群组成员管理相关功能。 技术原理 环信即时通讯 IM SDK 提供 Group、IGroupManager text/html 2022-08-05T08:05:58+00:00 https://docs-im.easemob.com/ccim/unity/group4?rev=1659686758&do=diff 群组-管理群组属性 群组是支持多人沟通的即时通讯系统，本文介绍如何使用环信即时通讯 IM SDK 在实时互动 app 中实现群组属性相关功能。 技术原理 环信即时通讯 IM SDK 提供 Group、IGroupManager text/html 2022-07-29T02:03:50+00:00 https://docs-im.easemob.com/ccim/unity/message1?rev=1659060230&do=diff 消息管理 更新时间：2022-07-19 功能描述 环信即时通讯 IM 支持多种消息类型，开发者可以方便地对本地会话、消息进行管理，可以从服务端获取历史会话和消息，提供送达回执和已读回执能力。 text/html 2022-08-05T08:12:00+00:00 https://docs-im.easemob.com/ccim/unity/message2?rev=1659687120&do=diff 消息管理–发送和接收消息 登录 Chat app 后，用户可以在一对一单聊、群聊、聊天室中发送如下类型的消息： 文字消息，包含超链接和表情消息。 附件消息，包含图片、语音、视频及文件消息。 位置消息。 透传消息。 自定义消息。 text/html 2022-08-05T08:11:11+00:00 https://docs-im.easemob.com/ccim/unity/message3?rev=1659687071&do=diff 消息管理–管理本地消息数据 本文介绍环信即时通讯 IM SDK 如何管理本地消息数据。SDK 内部使用 SQLite 保存本地消息，方便消息处理。 除了发送和接收消息外，环信即时通讯 IM SDK 还支持以会话为单位对本地的消息数据进行管理，如获取与管理未读消息、删除聊天记录、搜索历史消息等。其中，会话是一个单聊、群聊或者聊天室所有消息的集合。用户需在会话中发送消息或查看历史消息，还可进行会话置顶、清空聊天记录等操作。… text/html 2022-08-05T08:11:46+00:00 https://docs-im.easemob.com/ccim/unity/message4?rev=1659687106&do=diff 消息管理–从服务器获取会话和消息（消息漫游） 本文介绍用户如何从消息服务器获取会话和消息，该功能也称为消息漫游，指即时通讯服务将用户的历史消息保存在消息服务器上，用户即使切换终端设备，也能从服务器获取到单聊、群聊的历史消息，保持一致的会话场景。 text/html 2022-08-05T08:11:33+00:00 https://docs-im.easemob.com/ccim/unity/message5?rev=1659687093&do=diff 消息管理–管理消息回执 用户在单聊和群聊中发送信息后，可以查看该信息的送达和已读状态，了解接收方是否及时收到并阅读了信息。 本文介绍如何使用环信即时通讯 IM Unity SDK 的消息已读回执和送达回执在 app 中实现上述功能。 text/html 2022-08-05T08:16:05+00:00 https://docs-im.easemob.com/ccim/unity/moderation?rev=1659687365&do=diff 消息审核 功能描述 新增消息举报接口，SDK 可以调用该接口举报对应消息。当服务器端审核服务收到举报消息后，会将举报消息存储到数据库，并提供接口供 Console 后台搜索展示。审核员可以对举报记录进行相应处理。 text/html 2022-08-05T08:16:25+00:00 https://docs-im.easemob.com/ccim/unity/multidev?rev=1659687385&do=diff 在多个设备上登录 环信即时通讯 IM 支持同一个用户 ID 在多个平台或者多个设备上登录； 客户端支持查询当前账号的已登录设备列表，可强制该账号从其他已登录设备下线； 环信即时通讯 IM SDK 支持在同一账号所有已登录设备上同步在线和离线消息以及对应的回执和已读状态、接收离线推送通知、同步好友、群组以及聊天室相关的操作。 text/html 2022-08-12T10:33:11+00:00 https://docs-im.easemob.com/ccim/unity/overview?rev=1660300391&do=diff 集成概述 更新时间：2022-08-12 介绍 Unity 集成相关内容。 前提条件 开始前，请注册有效的环信即时通讯 IM 开发者账号和取得 App key，见 环信即时通讯云管理后台。 集成环境 集成环境要求具体见 集成环境要求。 SDK 初始化 初始化是使用 SDK 必要的、执行在所有接口方法调用之前的步骤。 如果进行多次初始化操作，只有第一次初始化以及相关的参数生效。 text/html 2022-08-05T09:37:47+00:00 https://docs-im.easemob.com/ccim/unity/presence?rev=1659692267&do=diff 在线状态订阅 用户在线状态（即 Presence）包含用户的在线、离线以及自定义状态。 本文介绍如何在即时通讯应用中发布、订阅和查询用户的在线状态。 技术原理 环信 IM SDK 提供 Presence、 text/html 2022-08-12T10:33:29+00:00 https://docs-im.easemob.com/ccim/unity/quickstart?rev=1660300409&do=diff 环信即时通讯 IM 快速开始 本文介绍如何快速集成环信即时通讯 IM Unity SDK 实现发送和接收单聊文本消息。 技术原理 下图展示在客户端发送和接收单聊文本消息的工作流程。 [img] 如上图所示，发送和接收单聊消息的步骤如下： text/html 2022-08-05T08:37:52+00:00 https://docs-im.easemob.com/ccim/unity/reaction?rev=1659688672&do=diff 消息表情回复 Reaction 环信即时通讯 IM 提供消息表情回复（下文统称 “Reaction”）功能。用户可以在单聊和群聊中对消息添加、删除表情。表情可以直观地表达情绪，利用 Reaction 可以提升用户的使用体验。同时在群组中，利用 Reaction 可以发起投票，根据不同表情的追加数量来确认投票。 text/html 2022-08-05T08:35:09+00:00 https://docs-im.easemob.com/ccim/unity/relationship?rev=1659688509&do=diff 管理用户关系 用户完成登录后，就会进行添加联系人、获取好友列表等操作。 本文介绍如何通过环信即时通讯 IM SDK 管理好友关系，包括添加、同意、拒绝、删除、查询好友，以及管理黑名单，包括添加、移出、查询黑名单。 text/html 2022-08-12T07:14:16+00:00 https://docs-im.easemob.com/ccim/unity/releasenotes?rev=1660288456&do=diff Unity SDK 更新日志 版本 V1.0.5 Dev 2022-08-12 这是环信即时通讯 IM Unity SDK 第一个正式发布的版本，包含以下功能： * 在单聊、群聊、聊天室和子区中发送和接收消息； * 管理会话和消息； * text/html 2022-08-12T08:52:52+00:00 https://docs-im.easemob.com/ccim/unity/sidebar?rev=1660294372&do=diff * 快速开始 Unity（不使用 UIKit） * SDK 集成概述（不使用 UIKit） * SDK 更新日志 * API reference * 消息概述 * 发送和接收消息 * 管理本地消息数据 * 从服务器获取消息（消息漫游） * 获取消息的已读回执和送达回执 * 翻译 * 管理用户属性 * 管理用户关系 * 群组概述 * 创建和管理群组 * 管理群组成员 * 管理群组属性 * 聊天室概述 * 创建和管理聊天室 * 管理聊天室成员 * 管理聊天室属性 * 多设备 * 管理在线状态订阅 * 消息表情回复 * 管理子区 * 管理子区消息 * 消息审核（举报） * 错误码… text/html 2022-08-05T08:33:26+00:00 https://docs-im.easemob.com/ccim/unity/thread?rev=1659688406&do=diff 管理子区消息 子区消息消息类型属于群聊消息类型，与普通群组消息的区别是需要添加 IsThread 标记。本文介绍环信即时通讯 IM Unity SDK 如何发送、接收以及撤回子区消息。 技术原理 环信即时通讯 IM Unity SDK 提供 text/html 2022-08-05T08:34:52+00:00 https://docs-im.easemob.com/ccim/unity/thread2?rev=1659688492&do=diff 管理子区 子区是群组成员的子集，是支持多人沟通的即时通讯系统，本文介绍如何使用环信即时通讯 IM SDK 在实时互动 app 中创建和管理子区，并实现子区相关功能。 如需查看消息相关内容，参见 text/html 2022-08-15T07:40:48+00:00 https://docs-im.easemob.com/ccim/unity/translation?rev=1660549248&do=diff 翻译 为方便用户在聊天过程中对文字消息进行翻译，环信即时通讯 IM SDK 集成了 Microsoft Azure Translation API，支持在发送或接收消息时对文本消息进行按需翻译或自动翻译： * 按需翻译：接收方在收到文本消息后，将消息内容翻译为目标语言。 text/html 2022-08-05T08:35:31+00:00 https://docs-im.easemob.com/ccim/unity/userprofile?rev=1659688531&do=diff 管理用户属性 用户属性指实时消息互动用户的信息，如用户昵称、头像、邮箱、电话、性别、签名、生日等。 例如，在招聘场景下，利用用户属性功能可以存储性别、邮箱、用户类型（面试者）、职位类型（web 研发）等。查看用户信息时，可以直接查询服务器存储的用户属性信息。