备案控制台
探索云世界
开发者社区 开发与运维 文章 正文

MobIM-API说明

2018-09-28 1320
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：

一、MobIM类API说明

  1. 获取当前用户信息
/**
 获取当前用户信息
 
 @return 当前用户
 */
+ (MIMUser * _Nullable)getCurrentUser;
  1. 获取用户管理者对象
/**
 获取用户管理对象
 
 @return 用户管理对象
 */
+ (MIMUserManager *_Nonnull)getUserManager;
  1. 获取聊天管理者对象
/**
 获取聊天管理对象
 
 @return 聊天管理对象
 */
+ (MIMChatManager *_Nonnull)getChatManager;
  1. 获取群组管理者对象
/**
 获取群组管理对象
 
 @return 群组管理对象
 */
+ (MIMGroupManager *_Nonnull)getGroupManager;
  1. 相关连接监听
/**
 正在连接服务器
 
 @param connectingHandler 进行连接时回调
 */
+ (void)onConnecting:(void (^_Nullable)(MIMUser * _Nonnull currentUser))connectingHandler;
 
/**
 连接服务器成功
 
 @param connectedHandler 连接成功时回调
 */
+ (void)onConnected:(void (^_Nullable)(MIMUser * _Nonnull currentUser))connectedHandler;
 
/**
 断开连接
 
 @param disconnectedHandler 断开连接时回调
 */
+ (void)onDisConnected:(void (^_Nullable)(MIMError * _Nullable error))disconnectedHandler;

二、用户管理类（MIMUserManager）

  1. 获取本地提醒号列表
/**
 获取本地提醒号列表
 
 @return 提醒号列表
 */
- (NSArray<MIMUser *> *)getLocalNoticers;
  1. 获取用户名片，个人名片主要用于免打扰功能
/**
 获取用户名片
 
 @param userId 用户id
 @return 名片
 */
- (MIMVCard *)getVCardWithUserId:(NSString *)userId;
  1. 设置用户是否免打扰
/**
 设置用户是否免打扰
 
 @param userId 用户id
 @param isDisturb 是否免打扰
 @return 是否设置成功
 */
- (BOOL)setUserToDisturbWithUserId:(NSString *)userId isDisturb:(BOOL)isDisturb;
  1. 添加、删除黑名单
/**
 添加到黑名单
 
 @param userId 要添加的人的appUserId
 @param resultHandler 回调,添加成功则返回被添加到黑名单的用户信息
 */
- (void)addToBlackListWithUserId:(NSString *)userId resultHandler:(void (^)(MIMUser *user, MIMError *error))resultHandler;
 
/**
 删除黑名单
 
 @param userId 要删除的人的appUserId
 @param resultHandler 回调,删除成功则返回从黑名单中删除的用户信息
 */
- (void)deleteBlackListWithUserId:(NSString *)userId resultHandler:(void (^)(MIMUser *user, MIMError *error))resultHandler;
  1. 获取黑名单列表
/**
 获取当前用户的黑名单列表
 
 @param resultHandler 回调
 */
- (void)getBlackListWithResultHandler:(void (^)(NSArray<MIMUser *> *blackList, MIMError *error))resultHandler;

三、聊天管理类（MIMChatManager）

  1. 从网络获取所有会话列表，获取完成后会缓存到MobIM本地，该接口一般只在首次启动时调用
/**
 获取所有创建过的会话列表
 
 @param completionHandler 完成回调
 */
- (void)getConversationListOnCompletion:(void (^)(NSArray<MIMConversation *> *conversationList, MIMError *error))completionHandler;
  1. 获取本地会话列表，用户app启动时调用展示会话列表页
/**
 获取本地会话列表
 
 @param resultHandler 会话列表回调
 */
- (void)getLocalConversationList:(void (^)(NSArray<MIMConversation *> *conversationList))resultHandler;
  1. 监听本地会话列表变更，此接口与上述两个接口配合使用
/**
 监听本地会话列表变更,当本地会话列表变化时通过block回调
 
 @param resultHandler 会话列表变更回调,通过changeType判断变更方式
 */
- (void)onLocalConversationListResultChanged:(void (^)(MIMConversation *changedConversation, NSFetchedResultsChangeType changeType))resultHandler;
  1. 获取总未读消息数并监听变更
/**
 获取当前所有未读消息并监听变更,该方法会直接返回本地消息表中所有未读消息,并且当本地消息表中的未读消息变化时通过block回调实时总的未读消息数
 
 @param resultHandler 未读消息变更回调
 @return 未读消息列表
 */
- (NSInteger)getAllUnreadMessagesOnResultChanged:(void (^)(NSInteger totalUnreadCount))resultHandler;
  1. 发送消息
/**
 发送消息
 
 @param msg 消息对象
 @param completionHandler 发送完成回调
 */
- (void)sendMessage:(MIMMessage *)msg completion:(void (^)(MIMMessage *message, MIMError *error))completionHandler;
  1. 接收消息
/**
 接收消息
 
 @param handlerIdentifier 接收消息回调的唯一标识符,该标识不能为空或空字符串
 @param messageHandler 处理接收到的消息block
 */
- (void)onMessageReceivedWithIdentifier:(NSString *)handlerIdentifier messageHandler:(void (^)(MIMMessage *message))messageHandler;
  1. 移除消息监听，此接口配合上面接收消息的接口使用
/**
 移除接收到消息的监听block
 
 @param handlerIdentifier block标识符
 */
- (void)removeMessageHandlerForIdentifier:(NSString *)handlerIdentifier;
  1. 删除消息
/**
 删除一条或多条消息
 
 @param messages 消息对象集合
 @return 是否删除成功
 */
- (BOOL)deleteMessages:(NSArray<MIMMessage *> *)messages;
 
/**
 根据会话删除某个会话所有消息
 
 @param conversation 会话
 @return 是否删除成功
 */
- (BOOL)deleteAllMessagesInConversation:(MIMConversation *)conversation;
  1. 删除会话
/**
 删除本地会话
 
 @param conversations 要删除的会话集合
 @return 是否删除成功
 */
- (BOOL)deleteLocalConversations:(NSArray<MIMConversation *> *)conversations;
 
/**
 删除本地会话
 
 @param conversationIds 要删除的会话id集合
 @return 是否删除成功
 */
- (BOOL)deleteLocalConversationsByIds:(NSArray<NSString *> *)conversationIds;
  1. 更新消息状态
/**
 更新Message为已读状态
 
 @param message 消息
 @return 是否更新成功
 */
- (BOOL)updateMessageToReaded:(MIMMessage *)message;
 
/**
 根据Conversation更新所有Message为已读状态
 
 @param conversation 会话
 @return 是否更新成功
 */
- (BOOL)updateMessagesToReadedInConversation:(MIMConversation *)conversation;
 
/**
 更新语音消息为已听取状态
 
 @param aVoiceMessage 语音消息
 @return 是否更新成功
 */
- (BOOL)updateVoiceMessageToListened:(MIMMessage *)aVoiceMessage;
 
/**
 更新附件消息下载状态
 
 @param newStatus 新下载状态
 @param message 附件消息
 @return 是否更新成功
 */
- (BOOL)updateAttachDownloadStatus:(MIMDownloadStatus)newStatus withMessage:(MIMMessage *)message;
  1. 查询消息
/**
 根据对方id查询两个人单聊的所有本地消息
 
 @param otherId 对方AppUid
 @param lastMessage 最后一条消息
 @param pageSize 每次查询多少条,若传小于等于0时,默认每次查询10条,若传大于等于50时,默认只查50条
 @return 消息列表
 */
- (NSArray<MIMMessage *> *)fetchSingleChatMessagesByOtherId:(NSString *)otherId
                                                lastMessage:(MIMMessage *)lastMessage
                                                   pageSize:(NSInteger)pageSize;
 
/**
 根据群组id查询群组会话的所有本地消息
 
 @param groupId 群组id
 @param lastMessage 最后一条消息
 @param pageSize 每次查询多少条,若传小于等于0时,默认每次查询10条,若传大于等于50时,默认只查50条
 @return 消息列表
 */
- (NSArray<MIMMessage *> *)fetchGroupChatMessagesByGroupId:(NSString *)groupId
                                                lastMessage:(MIMMessage *)lastMessage
                                                   pageSize:(NSInteger)pageSize;
 
 
/**
 根据会话ID查询该会话的最后一条消息
 
 @param conversationId 会话id
 @return 该会话的最后一条消息
 */
- (MIMMessage*)fetchLastMessageByConversationId:(NSString *)conversationId;
 
/**
 根据会话ID查询该会话所有消息
 
 @param conversationId 会话id
 @param lastMessage 最后一条消息
 @param pageSize 每次查询多少条,若传小于等于0时,默认每次查询10条,若传大于等于50时,默认只查50条
 @return 消息列表
 */
- (NSArray<MIMMessage *> *)fetchAllMessagesByConversationId:(NSString *)conversationId
                                                lastMessage:(MIMMessage *)lastMessage
                                                   pageSize:(NSInteger)pageSize;

四、群组管理类（MIMGroupManager）

  1. 创建群组
/**
 创建群组
 
 @param groupName 群组名称
 @param groupDesc 群组简介
 @param groupNoti 群组公告
 @param groupMembers 群成员
 @param resultHandler 回调处理
 */
- (void)createGroupWithGroupName:(NSString *)groupName
                       groupDesc:(NSString *)groupDesc
                       groupNoti:(NSString *)groupNoti
                    groupMembers:(NSArray<NSString *> *)groupMembers
                   resultHandler:(void (^)(MIMGroup *group, MIMError *error))resultHandler;
  1. 修改群信息
/**
 修改群名称
 
 @param groupName 群名称
 @param groupId 群id
 @param resultHandler 回调
 */
- (void)updateGroupName:(NSString *)groupName
            withGroupId:(NSString *)groupId
          resultHandler:(void (^)(MIMGroup *group, MIMError *error))resultHandler;
 
/**
 修改群简介
 
 @param groupDesc 群简介
 @param groupId 群id
 @param resultHandler 回调
 */
- (void)updateGroupDesc:(NSString *)groupDesc
            withGroupId:(NSString *)groupId
          resultHandler:(void (^)(MIMGroup *group, MIMError *error))resultHandler;
 
/**
 修改群公告
 
 @param groupNoti 群公告
 @param groupId 群id
 @param resultHandler 回调
 */
- (void)updateGroupNotice:(NSString *)groupNoti
              withGroupId:(NSString *)groupId
            resultHandler:(void (^)(MIMGroup *group, MIMError *error))resultHandler;
  1. 修改群昵称
/**
 修改群昵称
 
 @param nickname 要修改的昵称
 @param groupId 群组ID
 @param resultHandler 回调处理
 */
- (void)updateGroupNickname:(NSString *)nickname
                    inGroup:(NSString *)groupId
              resultHandler:(void (^)(MIMVCard *card, MIMError *error))resultHandler;
  1. 增加、删除群成员
/**
 增加群成员
 
 @param members 被添加人的id集合
 @param groupId 要添加到的群组ID
 @param resultHandler 回调处理
 */
- (void)addGroupMembers:(NSArray<NSString *> *)members
                toGroup:(NSString *)groupId
          resultHandler:(void (^)(MIMGroup *group, MIMError *error))resultHandler;
 
/**
 删除群成员
 
 @param members 要删除的群成员MobUserId集合
 @param groupId 群组id
 @param resultHandler 回调处理
 */
- (void)deleteGroupMembers:(NSArray<NSString *> *)members
                   inGroup:(NSString *)groupId
             resultHandler:(void (^)(MIMGroup *group, MIMError *error))resultHandler;
  1. 退出群组
/**
 退出群组
 
 @param groupId 要退出的群组ID
 @param resultHandler 回调处理
 */
- (void)exitGroupWithGroupId:(NSString *)groupId resultHandler:(void (^)(MIMGroup *group, MIMError *error))resultHandler;
  1. 转让群组
/**
 转让群组
 
 @param groupId 要转让的群组ID
 @param toId 被转让人(群成员)的appUid
 @param resultHandler 回调处理
 */
- (void)transferGroup:(NSString *)groupId
                   to:(NSString *)toId
        resultHandler:(void (^)(MIMGroup *group, MIMError *error))resultHandler;
  1. 获取群组信息
/**
 获取群组信息
 
 @param options 选项,可以选择群组信息,群成员列表,或者群信息+群成员
 @param groupId 群组ID
 @param resultHandler 回调处理
 */
- (void)getGroupInfoWithGroupId:(NSString *)groupId
                        options:(MIMGroupInfoOption)options
                  resultHandler:(void (^)(MIMGroup *group, MIMError *error))resultHandler;
  1. 加入群组
/**
 加入群组
 
 @param groupId 群组id
 @param resultHandler 回调处理
 */
- (void)joinToGroup:(NSString *)groupId resultHandler:(void (^)(MIMGroup *group, MIMError *error))resultHandler;
  1. 获取当前用户的群组列表
/**
 获取当前用户的群组列表
 
 @param resultHandler 回调
 */
- (void)getUserGroupsWithResultHandler:(void (^)(NSArray<MIMGroup *> *groupList, MIMError *error))resultHandler;
  1. 查找群组
/**
 查找群组
 
 @param groupId 群组id
 @param resultHandler 回调
 */
- (void)findGroupBy:(NSString *)groupId resultHandler:(void (^)(MIMGroup *group, MIMError *error))resultHandler;

五、错误码说明
错误信息都有错误码 errorCode 和错误描述 errorDescription，根据错误描述了解具体错误情况，错误码详情请参阅：MIMErrorCode.h

/**
 错误码
 */
@property (nonatomic, assign) MIMErrorCode errorCode;
 
/**
 错误描述
 */
@property (nonatomic, copy) NSString *errorDescription;
文章标签：
API
皮皮酱ye
目录
相关文章
技术交流18179014480
|
17天前
|
缓存 前端开发 API
API接口封装系列
API（Application Programming Interface）接口封装是将系统内部的功能封装成可复用的程序接口并向外部提供，以便其他系统调用和使用这些功能，通过这种方式实现系统之间的通信和协作。下面将介绍API接口封装的一些关键步骤和注意事项。
技术交流18179014480
33 2
WBKJ_Noah18870292986
|
24天前
|
监控 前端开发 JavaScript
实战篇：商品API接口在跨平台销售中的有效运用与案例解析
随着电子商务的蓬勃发展，企业为了扩大市场覆盖面，经常需要在多个在线平台上展示和销售产品。然而，手工管理多个平台的库存、价格、商品描述等信息既耗时又容易出错。商品API接口在这一背景下显得尤为重要，它能够帮助企业在不同的销售平台之间实现商品信息的高效同步和管理。本文将通过具体的淘宝API接口使用案例，展示如何在跨平台销售中有效利用商品API接口，以及如何通过代码实现数据的统一管理。
WBKJ_Noah18870292986
59 4
WBKJ_Noah18870292986
|
1月前
|
安全 算法 API
产品经理必备知识——API接口
前言 在古代，我们的传输信息的方式有很多，比如写信、飞鸽传书，以及在战争中使用的烽烟，才有了著名的烽火戏诸侯，但这些方式传输信息的效率终究还是无法满足高速发展的社会需要。如今万物互联的时代，我通过一部手机就可以实现衣食住行的方方面面，比如：在家购物、远程控制家电、自动驾驶等等，背后都离不开我们今天要聊的API接口。
WBKJ_Noah18870292986
66 1
金牛座Tina15579030501
|
1月前
|
数据采集 JSON API
如何实现高效率超简洁的实时数据采集？——Python实战电商数据采集API接口
你是否曾为获取重要数据而感到困扰？是否因为数据封锁而无法获取所需信息？是否因为数据格式混乱而头疼？现在，所有这些问题都可以迎刃而解。让我为大家介绍一款强大的数据采集API接口。
金牛座Tina15579030501
27 1
WBKJ_Noah18870292986
|
1月前
|
安全 API 数据安全/隐私保护
API接口知识小结
应用程序接口API（Application Programming Interface），是提供特定业务输出能力、连接不同系统的一种约定。这里包括外部系统与提供服务的系统（中后台系统）或后台不同系统之间的交互点。包括外部接口、内部接口，内部接口又包括：上层服务与下层服务接口、同级接口。
WBKJ_Noah18870292986
62 2
AokSend接口-API
|
1天前
|
API 开发者
邮件API接口使用的方法和步骤
AOKSEND指南：了解和使用邮件API接口，包括选择适合的接口（如AOKSEND、Mailgun、SMTP），获取访问权限，配置发件人、收件人及邮件内容，调用接口发送邮件，并处理返回结果，以高效集成邮件功能。
AokSend接口-API
8 2
一歲抬頭
|
4天前
|
Java API Android开发
[NDK/JNI系列04] JNI接口方法表、基础API与异常API
[NDK/JNI系列04] JNI接口方法表、基础API与异常API
一歲抬頭
11 0
Onebound19970109110
|
7天前
|
XML JSON API
快速淘宝商品详情页面API接口传输 php
PI（Application Programming Interface，应用程序接口）是一组预定义的函数、协议和工具，用于构建软件应用程序之间的交互。它允许不同的软件系统和应用通过统一的接口进行数据交换和通信
Onebound19970109110
10 0
修己xj
|
11天前
|
人工智能 API 开发者
免费使用Kimi的API接口，kimi-free-api真香
今年AI应用兴起，各类智能体涌现，但API免费额度有限。为解决这一问题，GitHub上的[kimi-free-api](https://github.com/LLM-Red-Team/kimi-free-api)项目提供了方便，支持高速流式输出、多轮对话等，与ChatGPT接口兼容。此外，还有其他大模型的免费API转换项目，如跃问StepChat、阿里通义Qwen等。该项目可帮助用户免费体验，通过Docker-compose轻松部署。只需获取refresh_token，即可开始使用。这个开源项目促进了AI学习和开发，为探索AI潜力提供了新途径。
修己xj
232 2
Onebound19970109110
|
16天前
|
JSON 监控 API
在API接口对接中关键示例问题（1）
在API接口对接中，有几个关键的问题需要注意，以确保接口的稳定性、安全性和易用性。以下是这些问题及部分示例代码的简要概述
Onebound19970109110
17 0

热门文章

最新文章

  • 1
    免费使用Kimi的API接口，kimi-free-api真香
  • 2
    【C/C++ 数据库 sqlite3】SQLite C语言API返回值深入解析
  • 3
    阿里云微服务引擎及 API 网关 2024 年 3 月产品动态
  • 4
    怎样获取当当网dangdang商品详情 API 返回值说明？
  • 5
    如何获得阿里巴巴中国站店铺的所有商品 API 返回值说明
  • 6
    如何获取易贝EBAY商品详情 API 返回值说明？
  • 7
    实战篇：商品API接口在跨平台销售中的有效运用与案例解析
  • 8
    掌握Java 8 Stream API的艺术：详解流式编程（一）
  • 9
    Gmail邮箱API发送邮件的方法有什么
  • 10
    阿里云DNS常见问题之DNS中alidns的api调用失败如何解决
  • 1
    亚马逊API接口获取商品详情的全面指南
    58
  • 2
    从API到Agent：万字长文洞悉LangChain工程化设计
    103
  • 3
    如何在Linux使用docker部署Swagger Editor并实现无公网IP远程协同编辑API文档
    49
  • 4
    虾皮Shopee根据ID取商品详情API
    30
  • 5
    谷歌发布MediaPipe LLM Inference API，28亿参数模型本地跑
    81
  • 6
    【微信小程序】-- 使用 npm 包 - API Promise化（四十二）
    34
  • 7
    阿里云BssOpenAPI是一个基于阿里云开放API的服务
    143
  • 8
    零一万物API正式上线：支持输入30万汉字
    27
  • 9
    如何高效接入 Flink： Connecter / Catalog API 核心设计与社区进展
    287
  • 10
    DataWorks常见问题之使用API删除之前的部署文件失败如何解决
    22

    • 相关课程

    更多
  • 体验-K8S API 基础及Pod 基本应用

    • 相关电子书

    更多
  • API 平台的安全实践
  • API平台的安全实践
  • API网关实践

    • 相关实验场景

    更多
  • 快速体验智能体API应用
  • Elasticsearch Java API Client 开发
    • 下一篇
    部署LAMP环境（Alibaba Cloud Linux 3）