文档反馈
文档反馈
IM即时通讯 > 更新日志 > iOS端更新日志

iOS SDK 版本历史

[8.2.0] - 2020-12-30

新增

修正

[8.1.5] - 2020-12-21

优化

[8.1.4] - 2020-12-18

优化

[8.1.3] - 2020-12-9

优化

[8.1.0] - 2020-11-13

新增

[8.0.1] - 2020-10-23

优化

[8.0.0] - 2020-09-28

新增

优化

优化

[7.8.5] - 2020-08-20

优化

[7.8.4] - 2020-08-14

优化

[7.8.3] - 2020-07-31

优化

[7.8.1] - 2020-07-29

新增

优化

[7.8.0] - 2020-07-21

新增

优化

[7.7.4] - 2020-06-22

优化

[7.7.2] - 2020-06-12

新增

优化

[7.7.0] - 2020-05-27

新增

/**
 *  被踢(服务器/其他端)回调
*
 *  @param result        被踢原因
 */
- (void)onKickout:(NIMLoginKickoutResult *)result;

[7.6.0] - 2020-05-13

新增

变更

优化

[7.4.2] - 2020-3-20

新增

/**
 *  会话管理器回调
 */
@protocol NIMConversationManagerDelegate <NSObject>

@optional
/**
 *  未漫游完整会话列表回调
 *  @param infos 未漫游完整的会话信息
 */
- (void)onRecvIncompleteSessionInfos:(nullable NSArray<NIMIncompleteSessionInfo *> *)infos;
@end

接口原型

/**
 *  会话管理器
 */
@protocol NIMConversationManager <NSObject>

/**
 查询漫游消息未完整会话信息

 @param session 目标会话
 @param completion 结果完成回调
*/
- (void)incompleteSessionInfoBySession:(NIMSession *)session
                            completion:(nullable NIMIncompleteSessionsBlock)completion;
/**
 查询所有漫游消息未漫游完整会话信息

 @param completion 结果完成回调
*/
- (void)allIncompleteSessionInfos:(NIMIncompleteSessionsBlock)completion;

/**
 更新未漫游完整会话列表

 @param messages 消息对象，使用NIMMessage的会话、severId、timestamp、from等去更新b
 @param completion 结果完成回调
*/
- (void)updateIncompleteSessions:(NSArray<NIMMessage *> *)messages
                      completion:(nullable NIMUpdateIncompleteSessionsBlock)completion;

/**
 根据会话移除未漫游完整会话信息

 @param session 目标会话
 */
- (void)removeIncompleteSessionInfoBySession:(NIMSession *)session;

/**
 移除所有未完整会话信息
 */
- (void)removeAllIncompleteSessionInfos;
@end

[7.4.0] - 2020-3-11

新增

NSDictionary *payload = @{
        @"apns-collapse-id": message.messageId,
    };

    [[NIMSDK sharedSDK].chatManager revokeMessage:message
                                      apnsContent:@"撤回一条消息"
                                      apnsPayload:payload
                                  shouldBeCounted:![[NTESBundleSetting sharedConfig] isIgnoreRevokeMessageCount]
                                         completion:^(NSError * _Nullable error)
    {
    }];

变更

+ (void)setupMessage:(NIMMessage *)message
{
    message.apnsPayload = @{
        @"apns-collapse-id": message.messageId,
    };

    NIMMessageSetting *setting = [[NIMMessageSetting alloc] init];
    setting.scene = NIMNOSSceneTypeMessage;
    message.setting = setting;
}

修复

[7.2.0] - 2020-1-13

新增

/**
 *  会话管理器
 */
@protocol NIMConversationManager <NSObject>
    /**
     *  根据关键字从服务器上检索消息
     *
     *  @param session 消息所属的会话
     *  @param option  检索选项
     *  @param result  读取的消息列表结果
     *  @discussion    检索消息内容，大小写不敏感；此接口不支持查询聊天室消息，聊天室请参考 NIMChatroomManagerProtocol 中的消息接口。
     *
     */
    - (void)retrieveServerMessages:(NIMSession *)session
                            option:(NIMMessageServerRetrieveOption *)option
                            result:(nullable NIMRetrieveServerMessagesBlock)result;
@end
@protocol NIMUserManagerProtocol <NSObject>
/**
*  查找成员
*
*  @param option      查询条件
*  @param completion  完成回调
*/
- (void)searchUserWithOption:(NIMUserSearchOption *)option
                  completion:(nullable NIMUserInfoBlock)completion;

变更

[7.0.3] - 2019-12-4

新增

@protocol NIMSDKConfigDelegate <NSObject>
/**
 * 是否忽略某条消息
 */
 - (BOOL)shouldIgnoreMessage:(NIMMessage *)message;
@end

修复

[7.0.0] - 2019-11-13

新增

@protocol NIMConversationManagerDelegate <NSObject>
/**
*  最近会话数据库读取完成
*
*  @discussion 所有最近会话读取完成。设置NIMSDKConfig中的asyncLoadRecentSessionEnabled属性为YES时，此回调会执行。
*  该回调执行表示最近会话全部加载完毕可以通过allRecentSessions来取全部对话。
*/
- (void)didLoadAllRecentSessionCompletion;

@end
/**
 *  NIM SDK 配置项目
 */
@interface NIMSDKConfig : NSObject

/**
*  是否开启异步读取最近会话，默认NO，不开启
*  @discussion 对于最近会话比较多的用户，初始读取数据库时，可能影响到启动速度，用户可以选择开启该选项，开启异步读取最近会话，
*  allRecentSessions会优先返回一部分最近会话，等到全部读取完成时，通过回调通知用户刷新UI。
*/
@property (nonatomic, assign) BOOL asyncLoadRecentSessionEnabled;

@end

@protocol NIMConversationManager <NSObject>
/**
*  从服务端分页获取历史会话列表
*
*  @param option 分页查询选项，可为空，空时默认全量获取
*
*  @param completion 完成回调
*/
- (void)fetchServerSessions:(nullable NIMFetchServerSessionOption *)option
                 completion:(nullable NIMFetchRecentSessionsHistoryBlock)completion;
@end

@protocol NIMConversationManager <NSObject>
/**
 *  从服务端获取会话信息
 *
 *  @param session 目标会话
 *
 *  @param completion 完成回调
 */
- (void)fetchServerSessionBySession:(NIMSession *)session
                         completion:(nullable NIMFetchRecentSessionHistoryBlock)completion;
@end

@protocol NIMConversationManager <NSObject>
/**
*  更新服务端获取会话扩展信息
*
*  @param ext        扩展信息
*
*  @param session    目标最近会话
*
*  @param completion 完成回调
*/
- (void)updateServerSessionExt:(NSString *)ext
                       session:(NIMSession *)session
                    completion:(nullable NIMRemoteRecentSessionBlock)completion;
@end

@protocol NIMConversationManager <NSObject>
/**
*  删除服务端会话
*
*  @param sessions 目标会话
*
*  @param completion 完成回调
*/
- (void)deleteServerSessions:(NSArray<NIMSession *> *)sessions
                  completion:(nullable NIMRemoteRecentSessionBlock)completion;
@end

@interface NIMSDK : NSObject
/**
 *  更新APNS Token
 *
 *  @param token APNS Token
 *  @param key 自定义本端推送内容, 设置key可对应业务服务器自定义推送文案; 传@"" 清空配置, nil 则不更改
 */
- (void)updateApnsToken:(NSData *)token
       customContentKey:(nullable NSString *)key;
 @end

/**
 *  数据库异常信息
 */
@interface NIMDatabaseException : NSObject
/**
 *  注册数据库异常处理对象
 *  @param handler 用户自定义处理对象
 */
+ (void)registerExceptionHandler:(id<NIMDatabaseHandleExceptionProtocol>)handler;

@end

优化

@interface NIMMessage : NSObject
/**
 *  消息服务端ID
 */
@property (nonatomic,copy,readonly)   NSString * serverID;
@end
/**
 *  获取所有最近会话。
 *  @return 最近会话列表
 *  @discussion SDK 以 map 的形式保存 sessions，调用这个方法时将进行排序，数据量较大 (上万) 时会比较耗时。
 *  该方法默认是同步查询所有sessions，当数据量较大（上万）会比较耗时，可能会卡主线程，这种情况下
 *  用户可以配置NIMSDKConfig中的asyncLoadRecentSessionEnabled属性为YES，此时该接口可以先返回
 *  100条最近会话，等全部加载完会回调didLoadAllRecentSessionCompletion，此后再调用该接口可以全量返回
 *  所有会话，用户需要在didLoadAllRecentSessionCompletion回调中及时更新UI展示。
 */
- (nullable NSArray<NIMRecentSession *> *)allRecentSessions;

修改

[6.10.0] - 2019-10-29

修改

[6.9.1] - 2019-09-25

新增

[6.9.0] - 2019-09-17

新增

@protocol NIMConversationManager <NSObject>
/**
 *  获取所有最近100条会话
 *  @return 最近会话列表
 *  @discussion 用该接口在SDK启动时快速先获取
 */
- (nullable NSArray<NIMRecentSession *> *)mostRecentSessions;
@end

@protocol NIMNetCallManager <NSObject>
/**
 *  获取点对点通话记录
 *
 *  @param option 本地查询可选项, nil 返回所有
 *  @param completion 查询结果回调
 */
- (void)recordsWithOption:(NIMNetCallRecordsSearchOption * _Nullable)option
               completion:(NIMNetCallSearchRecordsHandler)completion;

/**
 *  清空点对点通话记录
 */
- (void)deleteAllRecords;
@end

变更

[6.7.0] - 2019-08-01

新增

@protocol NIMSuperTeamManager
/**
 *  修改群通知状态
 *
 *  @param state        群通知状态
 *  @param teamId       群组ID
 *  @param completion   完成后的回调
 */
- (void)updateNotifyState:(NIMTeamNotifyState)state
                   inTeam:(NSString *)teamId
               completion:(nullable NIMSuperTeamHandler)completion;
@end
@protocol NIMSuperTeamManager
/**
 *  群通知状态
 *
 *  @param teamId 群Id
 *
 *  @return 群通知状态
 */
- (NIMTeamNotifyState)notifyStateForNewMsg:(NSString *)teamId;
@end
/**
 *  获取所有最近会话
 *  @return 最近会话列表
 *  @discussion SDK 以 map 的形式保存 sessions，调用这个方法时将进行排序，数据量较大 (上万) 时会比较耗时。
 *  通过该接口获取的最近会话列表与allRecentSessions接口不同，是基于allRecentSessions接口筛选类型之后重新生成的新对象
 *  需要用户自行在外部管理，所有回调不回回调该接口查询的任何会话
 */
- (nullable NSArray<NIMRecentSession *> *)allRecentSessionsWithOption:(NIMRecentSessionOption *)option;
@interface NIMSDKConfig : NSObject

/**
 *  是否允许重置AVAudioSession 默认 YES，允许重置
 *  @discussion 默认在播放、Seek等操作下会内部重置AVAudioSession，设置为NO后，将不再重置
 */
@property (nonatomic, assign) BOOL audioSessionResetEnabled;

@end

变更

[6.6.6] - 2019-07-19

新增

@protocol NIMConversationManager

@end
/**
 *  删除指定时间范围内的
 *
 *  @param session 目标会话
 *  @param option 删除消息选项
 *  @param block 完成回调
 */
- (void)deleteMessagesInSession:(NIMSession *)session
                         option:(nullable NIMBatchDeleteMessagesOption *)option
                     completion:(nullable NIMDeleteMessagesBlock)block;

@end

[6.5.5] - 2019-06-12

新增

超大群是针对大规模群聊场景的功能。目前支持不超过5000人的群聊。由于超大群场景较为特殊，并不能支持所有高级群提供的管理功能。目前超大群仅支持群主与普通成员两种身份（开通超大群功能请联系商务）。 目前支持的功能：

[6.5.0] - 2019-05-24

新增


@protocol NIMTeamManager <NSObject>
/**
 *  获取群成员邀请人Accid 
 *  @param teamId      群组ID
 *  @param memberIDs   查询的成员ID，数目不允许大于200
 *  @param completion  完成后的回调
 */
- (void)fetchInviterAccids:(NSString *)teamID
         withTargetMembers:(NSArray<NSString *> *)memberIDs
                completion:(nullable NIMTeamFetchInviterAccidsHandler)completion;
@end

变更

[6.3.0] - 2019-04-18

新增

@protocol NIMConversationManager <NSObject>

/**
 *  清空点对点会话对应本地和服务端的消息
 *
 *  @param sessions 目标会话列表
 *  @param option 清空消息选项
 *  @param completion 完成回调
 *  @discussion 只支持点对点，清空本用户的服务端历史消息，不影响对方；如果不设置清空选项，服务端默认会同时清空漫游消息；
 */
- (void)deleteSelfRemoteSession:(NIMSession *)session
                         option:(nullable NIMClearMessagesOption *)option
                     completion:(nullable NIMRemoveRemoteSessionBlock)completion;                 
@end

/**
 *  好友协议
 */
@protocol NIMUserManager <NSObject>

/**
 *  删除好友
 *
 *  @param userId      好友Id
 *  @param remove      是否同时删除备注
 *  @param completion  完成回调
 */
- (void)deleteFriend:(NSString *)userId
         removeAlias:(BOOL)remove
          completion:(nullable NIMUserBlock)completion;
@end

变更

[6.2.0] - 2019-03-14

新增


@interface NIMResourceManager : NSObject
/**
 *  使用短链换源链
 *
 *  @param shortCode    短链
 *  @param completion   完成回调
 *  @discussion 当用户后台配置了NOS文件安全，文件上传的URL为短链，无法直接下载，
 *  可通过该接口换取源链
 */
- (void)fetchNOSURLWithURL:(NSString *)shortCode
              completion:(NIMFetchURLCompletion)completion;

@end
@protocol NIMLoginManagerDelegate <NSObject>
@optional
/**
 *  群用户同步完成通知
 *  @param success 群用户信息同步是否成功
 */
- (void)onTeamUsersSyncFinished:(BOOL)success;

@end

变更

[6.1.0] - 2019-01-22

新增

 /**
 导出历史消息到本地文件

 @param delegate 自定义消息的处理 delegate
 @param progress 导出进度更新回调
 @param completion 导出完成回调
 */
- (void)exportMeessageInfosWithDelegate:(id<NIMExportMessageDelegate>)delegate
                               progress:(NIMExportMessageProgress)progress
                             completion:(NIMExportMessageComletion)completion;

/**
 导入历史消息

 @param infoFilePath 已解码并序列化了的本地历史消息文件路径
 @param delegate 自定义消息的处理 delegate
 @param progress 导入进度更新回调
 @param completion 导入完成回调
 */
- (void)importMessageInfosAtPath:(NSString *)infoFilePath
                        delegate:(id<NIMImportMessageDelegate>)delegate
                        progress:(NIMImportMessageProgress)progress
                      completion:(NIMImportMessageCompletion)completion;


/**
 取消 导出/导入 历史消息操作
 */
- (void)cancelMigrateMessages;


/**
 更新历史消息备份信息

 @param URL 历史消息备份的 URL
 @param key 历史消息备份的加密 key
 @param completion 更新信息的完成回调
 */
- (void)updateMigrateMessageInfoWithURL:(NSString *)URL key:(NSString *)key completion:(NIMUpdateMigrateMessageCompletion)completion;


/**
 获取历史消息备份信息

 @param completion 获取历史消息备份的完成回调
 */
- (void)fetchMigrateMessageInfo:(NIMFetchMigrateMessageCompletion)completion;



/**
 * 撤回通知
 */
@interface NIMRevokeMessageNotification : NSObject

/**
 * 撤回操作是否属于漫游消息
 */
@property (nonatomic, readonly, getter=isRoaming) BOOL roaming;

/**
 * 撤回的附言
 */
@property(nullable, nonatomic, copy) NSString *postscript;

/**
 *  异步发送消息
 *
 *  @param message 消息
 *  @param session 接收方
 *  @param completion 发送完成后的回调，这里的回调完成只表示当前这个函数调用完成，需要后续的回调才能判断消息是否已经发送至服务器
 */
- (void)sendMessage:(NIMMessage *)message
          toSession:(NIMSession *)session
         completion:(nullable void(^)(NSError * __nullable error))completion;
/**
 *  取消正在发送的消息
 *
 *  @param message 目标消息
 *
 *  @param completion 完成回调
 *
 *  @return 是否调用成功
 */
- (BOOL)cancelSendingMessage:(NIMMessage *)message;

变更

/**
 *  邀请用户入群
 *
 *  @param users       用户ID列表
 *  @param teamId      群组ID
 *  @param postscript  邀请附言
 *  @param attach      扩展消息
 *  @param completion  完成后的回调
 */
- (void)addUsers:(NSArray<NSString *>  *)users
          toTeam:(NSString *)teamId
      postscript:(NSString *)postscript
          attach:(NSString *)attach
      completion:(nullable NIMTeamMemberHandler)completion;

[5.9.0] - 2018-11-28

新增

/**
 创建频道

 @param request 创建频道请求
 @param completion 完成回调
 @discussion 该接口用户创建频道，同一时刻频道名互斥，不能重复创建。但如果频道名缺省，服务器会自动分配频道id。对于频道在创建后如果没人加入，有效期2小时，当有成员加入后会自动延续频道有效期。当主动关闭频道或者最后一个成员退出后2小时后频道销毁。
 @discussion 错误码 200:成功  10405:房间已存在
 */
- (void)signalingCreateChannel:(NIMSignalingCreateChannelRequest *)request
                    completion:(nullable NIMSignalingCreateChannelBlock)completion;

/**
 关闭频道

 @param request 关闭频道请求
 @param completion 完成回调
 @discussion 该接口可以由创建者和频道内所有成员调用，无权限限制。调用该接口成功后，其他所有频道内的成员都回收到频道结束的通知，被动离开频道。此时其他成员需要调用离开接口，也不会收到别人的离开通知。
 @discussion 错误码 200:成功  10406:不在房间内
 */
- (void)signalingCloseChannel:(NIMSignalingCloseChannelRequest *)request
                   completion:(nullable NIMSignalingOperationBlock)completion;


/**
 加入频道

 @param request 加入频道请求
 @param completion 完成回调
 @discussion 错误码 200:成功  10407:已经房间内 10420:已经在房间内（自己的其他端） 10419:房间人数超限  10417:uid冲突
 */
- (void)signalingJoinChannel:(NIMSignalingJoinChannelRequest *)request
                  completion:(nullable NIMSignalingJoinChannelBlock)completion;

/**
 离开频道

 @param request 离开频道请求
 @param completion 完成回调
 @discussion 该接口用于自己退出频道，但不对频道进行销毁
 @discussion 错误码 200:成功  10406:不在房间内
 */
- (void)signalingLeaveChannel:(NIMSignalingLeaveChannelRequest *)request
                   completion:(nullable NIMSignalingOperationBlock)completion;

新增

/**
 邀请加入频道

 @param request 邀请加入频道请求
 @param completion 完成回调
 @discussion 该接口用于邀请对方加入频道，邀请者必须是创建者或者是频道中成员。如果需要对离线成员邀请，可以打开离线邀请开关并填写推送信息。被邀请者在线后通过离线通知接收到该邀请，并通过房间信息中的invalid_字段判断房间的有效性，也可以对所有离线消息处理后判断该邀请是否被取消。
 @discussion 错误码 200:成功  10404:房间不存在 10406:不在房间内（自己）10407:已经房间内（对方）10419:房间人数超限  10201:对方云信不在线  10202:对方推送不可达
 */
- (void)signalingInvite:(NIMSignalingInviteRequest *)request
             completion:(nullable NIMSignalingOperationBlock)completion;

/**
 取消邀请

 @param request 取消邀请请求
 @param completion 完成回调
 @discussion 错误码 200:成功  10404:房间不存在 10408:邀请不存在或已过期 10409:邀请已经拒绝 10410:邀请已经接受
 */
- (void)signalingCancelInvite:(NIMSignalingCancelInviteRequest *)request
                   completion:(nullable NIMSignalingOperationBlock)completion;

/**
 拒绝邀请

 @param request 拒绝邀请请求
 @param completion 完成回调
 @discussion 拒绝邀请后用户也可以通过加入频道接口加入频道，接口的使用由用户的业务决定
 @discussion 错误码 200:成功  10404:房间不存在 10408:邀请不存在或已过期 10409:邀请已经拒绝 10410:邀请已经接受
 */
- (void)signalingReject:(NIMSignalingRejectRequest *)request
             completion:(nullable NIMSignalingOperationBlock)completion;

/**
 接受邀请

 @param request 接受邀请请求
 @param completion 完成回调
 @discussion 接受频道接口
 不开自动加入开关：该接口只接受邀请并告知邀请者，并同步通知自己的其他在线设备，但不会主动加入频道，需要单独调用加入接口
 打开自动加入开关：该接口为组合接口，等同于先调用接受邀请，成功后再加入房间。
 @discussion 错误码 200:成功 10404:房间不存在 10408:邀请不存在或已过期 10409:邀请已经拒绝 10410:邀请已经接受 10407:已经房间内 10420:已经在房间内（自己的其他端） 10419:房间人数超限 10417:uid冲突
 */
- (void)signalingAccept:(NIMSignalingAcceptRequest *)request
             completion:(nullable NIMSignalingAcceptBlock)completion;

新增

/**
 自定义控制指令

 @param request 自定义控制指令请求
 @param completion 完成回调
 @discussion 该接口用于在频道中透传一些自定义指令，协助频道管理。该接口允许非频道内成员调用，但接收者必须是频道内成员或创建者
 @discussion 错误码 200:成功 10404:房间不存在  10406:不在房间内（自己或者对方）
 */
- (void)signalingControl:(NIMSignalingControlRequest *)request
              completion:(nullable NIMSignalingOperationBlock)completion;

新增


@interface NIMCreateTeamOption : NSObject

/**
*  设置群最大人数上限
*  @discussion 默认为0，表示使用默认人数上限
*/
@property (nonatomic,assign)    NSUInteger maxMemberCountLimitation;

@end

变更


@interface NIMMessage : NSObject

@property (nullable,nonatomic,copy) NSString *apnsContent;

@property (nullable,nonatomic,copy) NSDictionary *apnsPayload;

@end

[5.7.0] - 2018-10-11

新增


@interface NIMLoginClient : NSObject

/**
 *  自定义信息，最大32个字符；目前android多端登录，TV端和手表端，可以通过该字段区分
 */
@property (nullable,nonatomic,copy,readonly)     NSString *customTag;

@end

新增


@interface NIMSDKConfig : NSObject

/**
 客户端自定义信息，用于多端登录时同步该信息
 */
@property (nonatomic,copy)  NSString *customTag;

@end

新增


@protocol NIMChatroomManager <NSObject>
/**
 *  批量更新聊天室通用队列元素，权限由 NIMChatroom 的 queueModificationLevel 决定
 *
 *  @param request    聊天室队列批量请求
 *  @param completion 请求回调
 */
- (void)batchUpdateChatroomQueueObject:(NIMChatroomQueueBatchUpdateRequest *)request
                       completion:(nullable NIMChatroomQueueBatchUpdateHandler)completion;
@end

优化

新增


@protocol NIMConversationManager <NSObject>
/**
 *  增加某个最近空白会话
 *
 *  @param recentSession 待增加的最近空白会话
 *  @discussion 异步方法
 */
- (void)addEmptyRecentSessionBySession:(NIMSession *)session;
@end

变更

[5.5.0] - 2018-08-07

新增


@interface NIMSDK : NSObject

@property (nonatomic,strong)         NSMutableDictionary *sceneDict;

@end



@protocol NIMResourceManager <NSObject>

- (void)upload:(NSString *)filepath
         scene:(NSString *)scene
      progress:(nullable NIMHttpProgressBlock)progress
    completion:(nullable NIMUploadCompleteBlock)completion;

@end



@interface NIMImageObject : NSObject

- (instancetype)initWithImage:(UIImage*)image scene:(NSString *)scene;

- (instancetype)initWithFilepath:(NSString *)filepath scene:(NSString *)scene;

- (instancetype)initWithData:(NSData *)data
                   extension:(NSString *)extension
                       scene:(NSString *)scene;

@end



@interface NIMVideoObject : NSObject

- (instancetype)initWithSourcePath:(NSString *)sourcePath scene:(NSString *)scene;

- (instancetype)initWithData:(NSData *)data
                   extension:(NSString *)extension
                       scene:(NSString *)scene;

@end



@interface NIMAudioObject : NSObject

- (instancetype)initWithSourcePath:(NSString *)sourcePath scene:(NSString *)scene;

- (instancetype)initWithData:(NSData *)data
                   extension:(NSString *)extension
                       scene:(NSString *)scene;

@end



@interface NIMFileObject : NSObject

- (instancetype)initWithSourcePath:(NSString *)sourcePath scene:(NSString *)scene;

- (instancetype)initWithData:(NSData*)data extension:(NSString*)extension scene:(NSString *)scene;

@end



@interface NIMAudioObject : NSObject

@property (nullable,nonatomic, copy, readonly) NSString *md5;

@end



@interface NIMImageObject : NSObject

@property (nullable,nonatomic, copy, readonly) NSString *md5;

@end

[5.3.0] - 2018-06-26

新增


@interface NIMUser : NSObject

@property (nullable,nonatomic,copy,readonly)   NSString  *serverExt;

@end

修正

[5.2.2] - 2018-06-06

修正

[5.2.1] - 2018-05-28

修正

[5.1.1] - 2018-05-23

修正

/**
 *  聊天委托
 */
@protocol NIMChatManagerDelegate <NSObject>

/**
 *  取消收取消息附件
 *
 *  @param message 需要取消收取附件的消息
 *
 *  @discussion 附件包括：图片消息的图片缩略图，视频消息的视频缩略图，音频消息的音频文件，文件消息的文件以及自定义消息中的自定义文件
 *              个人和群组消息。SDK 不会触发任何下载回调
 */
- (void)cancelFetchingMessageAttachment:(NIMMessage *)message;

@end
/**
 *  本地错误码 (IM 和通用) Domain NIMLocalErrorDomain
 */
typedef NS_ENUM(NSInteger, NIMLocalErrorCode) {
/**
     *  主动取消任务
     */
    NIMLocalErrorCodeManualCancelTask = 19,
}

变更

/**
 *  聊天室管理器回调
 */
@protocol NIMChatroomManagerDelegate <NSObject>

/**
 *  被踢回调
 *
 *  @param roomId   被踢的聊天室Id
 *  @param reason   被踢原因
 */
- (void)chatroom:(NSString *)roomId beKicked:(NIMChatroomKickReason)reason;

@end

变更为

/**
 *  聊天室管理器回调
 */
@protocol NIMChatroomManagerDelegate <NSObject>

/**
 *  被踢回调
 *
 *  @param result   被踢的结果详情
 */
- (void)chatroomBeKicked:(NIMChatroomBeKickedResult *)result;

@end
/**
 *  检索服务器历史消息选项 (服务器)
 */
@interface NIMHistoryMessageSearchOption : NSObject

/**
 *  查询的消息类型
 *  @discusssion 消息类型组合，默认为 nil ，搜索全类型。一旦设置了这个字段，则 sync 字段失效，查询结果不会写入 db 。
 */
@property (nonatomic,copy)    NSArray<NSNumber *> *messageTypes;

@end

修正

[5.0.0] - 2018-03-29

新增

@protocol NIMResourceManager <NSObject>

/**
 *  搜索缓存的资源文件
 *
 *  @param option       搜索选项
 *  @param completion   完成回调
 */
- (void)searchResourceFiles:(NIMResourceQueryOption *)option
              completion:(NIMResourceSearchHandler)completion;

/**
 *  删除缓存的资源文件
 *
 *  @param option       搜索选项
 *  @param completion   完成回调
 */
- (void)removeResourceFiles:(NIMResourceQueryOption *)option
              completion:(NIMResourceDeleteHandler)completion;

@end
@protocol NIMTeamManager <NSObject>

/**
 *  刷新群组消息已读、未读数量
 *
 *  @param NIMMessage    要查询的消息
 *  @discussion          消息已读变化后，会通过 NIMChatManager 的代理 onRecvMessageReceipts: 回调给上层
 *                       刷新的消息必须为群组消息
 */
- (void)refreshTeamMessageReceipts:(NSArray<NIMMessage *> *)messages;


/**
 *  查询群组消息回执详情
 *
 *  @param NIMMessage    要查询的消息
 *  @discussion          详情包括已读人数的 id 列表和未读人数的 id 列表
 *                       查询详情对象不会跟着回执人数变化而变化，如果要获取最新的详情，必须再次调用此接口
 *
 */
- (void)queryMessageReceiptDetail:(NIMMessage *)message
                       completion:(NIMQueryReceiptDetailBlock)completion;

@end
@protocol NIMTeamManager <NSObject>

/**
 *  禁言群全体成员
 *
 *  @param mute        是否禁言
 *  @param teamId      群组ID
 *  @param completion  经验操作完成后的回调
 *  @discussion   操作成功后，云信服务器会下发禁言的群通知消息
 */
- (void)updateMuteState:(BOOL)mute
                inTeam:(NSString *)teamId
            completion:(nullable NIMTeamHandler)completion;

@end
@protocol NIMAntispamManager <NSObject>

/**
 *  本地反垃圾检查器
 *
 *  @param option        本地反垃圾检查选项
 *  @param error         错误提示
 *  @discussion          此扩展不会漫游到其他端,上层需要保证 NSDictionary 可以转换为 JSON。
 *  @return              本地反垃圾检查结果，本地反垃圾列表会在每次登录后同步更新
 *                       因为网络问题，或者没有登录，都会导致本地反垃圾列表无效的情况，error 中会包含具体出错原因
 */
- (NIMLocalAntiSpamCheckResult *)checkLocalAntispam:(NIMLocalAntiSpamCheckOption *)option
                                              error:(NSError **)error;

@end

变更

- (void)onRecvMessageReceipt:(NIMMessageReceipt *)receipt;

为

- (void)onRecvMessageReceipts:(NSArray<NIMMessageReceipt *> *)receipts;

[4.8.0] - 2018-02-08

新增

- (void)saveMessage:(NIMMessage *)message
         forSession:(NIMSession *)session
         completion:(nullable NIMUpdateMessageBlock)completion;
/**
 *  设置播放音频的起始时间
 *  @param timestamp 起始时间
 *  @discussion 起始时间不能大于整个音频的时间，否则播放无效。调用此方法后，不需要再调用 play: 方法，自动播放
 */
- (BOOL)seek:(NSTimeInterval)timestamp;

修正

[4.6.0] - 2018-01-04

新增

@interface NIMSDKConfig : NSObject
/**
 *  是否禁止后台重连
 *  @discusssion 默认为 NO。即默认情况下，当程序退到后台断开连接后，如果 App 仍能运行，SDK 将继续执行自动重连机制。设置为 YES 后在后台将不自动重连，重连将被推迟到前台进行。
 *                只有特殊用户场景才需要此设置，无明确原因请勿设置。
 */
@property (nonatomic,assign)    BOOL    reconnectInBackgroundStateDisabled;
@end
/**
 *  检索服务器历史消息选项 (服务器)
 */
@interface NIMHistoryMessageSearchOption : NSObject
/**
 *  查询的消息类型
 *  @discusssion 消息类型组合，默认为 nil ，搜索全类型。 此参数只对聊天室会话有效
 */
@property (nonatomic,copy)    NSArray<NSNumber *> *messageTypes;
@end
/**
 * 反垃圾选项
 * @discussion 这个选项用于配置易盾反垃圾，设置 enabled 为 YES (默认为 NO) 后该消息进投递到易盾系统进行反垃圾检测 （需要开启易盾服务）
 */
@interface NIMAntiSpamOption : NSObject
/**
 * 用户在易盾配置的额外反垃圾的业务ID
 */
@property (nullable,nonatomic,copy)     NSString    *businessId;
@end

修正

[4.4.0] - 2017-11-16

新增

修正

[4.3.0] - 2017-10-12

新增

@protocol NIMLoginManager <NSObject>
/**
*  当前 SDK 鉴权模式
*
*  @return 当前 SDK 鉴权模式
*/
- (NIMSDKAuthMode)currentAuthMode;
end
@protocol NIMConversationManager <NSObject>
/**
*  设置所有会话消息为已读
*
*  @discussion 异步方法，消息会标记为设置的状态。不会触发单条 recentSession 更新的回调，但会触发回调 - (void)allMessagesRead
*/
- (void)markAllMessagesRead
@end
@protocol NIMSDKConfig NSObject
/**
*  是否支持动图缩略
*  @discusssion 默认为 NO。即默认情况下，从服务器获取原图缩略图时，如果原图为动图，我们将返回原图第一帧的缩略图。
*               而开启这个选项后，我们将返回缩略图后的动图。这个选项只影响从服务器获取的缩略图，不影响本地生成的缩略图。
*/
@property (nonatomic,assign)    BOOL   animatedImageThumbnailEnabled;
@end

变更

修改通知状态接口变更 

 (void)updateNotifyState:(BOOL)notify
                   inTeam:(NSString *)teamId
               completion:(nullable NIMTeamHandler)completion;

为

- (void)updateNotifyState:(NIMTeamNotifyState)state
                   inTeam:(NSString *)teamId
               completion:(nullable NIMTeamHandler)completion;

查询通知状态接口变更

- (BOOL)notifyForNewMsg:(NSString *)teamId;

为

- (void)updateNotifyState:(NIMTeamNotifyState)state
                   inTeam:(NSString *)teamId
               completion:(nullable NIMTeamHandler)completion;

[4.2.0] - 2017-09-12

新增

@interface NIMSDKConfig : NSObject
/**
 *  @discusssion 默认为 NO。设置成 YES 的情况下，收到的群通知也会计入未读数
 */
@property (nonatomic,assign)    BOOL    shouldCountTeamNotification;
@end
@interface NIMSDKConfig : NSObject
/**
 *  @discusssion 默认为 7 天。即超过 7 天的 log 将被清除。只能设置大于等于 2 的值。
 */
@property (nonatomic,assign)    NSInteger   maximumLogDays;
@end

变更

/**
 *  创建群组
 *
 *  @param option     创建群选项
 *  @param users      用户ID列表
 *  @param completion 完成后的回调
 */
- (void)createTeam:(NIMCreateTeamOption *)option
              users:(NSArray<NSString *> *)users
         completion:(nullable NIMTeamCreateHandler)completion;

创建群完成的回调由

/**
 *  创建群组block
 *
 *  @param error   错误,如果成功则error为nil
 *  @param teamId 群组ID
 */
typedef void(^NIMTeamCreateHandler)(NSError * __nullable error,NSString * __nullable teamId);

变更为

/**
 *  创建群组block
 *
 *  @param error   错误,如果成功则error为nil
 *  @param teamId  群组ID
 *  @param failedUserIds 邀请失败的群成员ID
 */
typedef void(^NIMTeamCreateHandler)(NSError * __nullable error, NSString * __nullable teamId, NSArray<NSString *> * __nullable failedUserIds);

现在创建群可能会出现建群成功，建群同时邀请的用户部分成功的情况。此时建群依然成功，error 信息为 nil ，并返回邀请失败的群成员 ID 集合。

[4.1.0] - 2017-08-08

新增

变更

- (void)deleteAllMessages:(BOOL)removeRecentSessions

变更为 :

- (void)deleteAllMessages:(NIMDeleteMessagesOption *)option

[4.0.0] - 2017-07-06

新增

[3.8.0] - 2017-06-06

新增

[3.6.0] - 2017-04-27

新增

[3.5.0] - 2017-03-15

新增

变更

[3.4.1] - 2017-02-09

修正

[3.4.0] - 2017-01-20

新增

变更

[3.3.0] - 2016-12-28

新增

[3.2.5] - 2016-12-19

新增

[3.2.0] - 2016-11-30

新增

变更

[3.1.1] - 2016-10-28

修正

[3.1.0] - 2016-10-26

新增

变更

[3.0.0] - 2016-10-20

新增

[2.9.0] - 2016-09-19

新增

变更

[2.8.0] - 2016-08-30

新增

变更

[2.7.0] - 2016-08-11

新增

[2.6.0] - 2016-07-25

新增

变更

[2.5.0] - 2016-07-08

新增

修正

[2.4.0]- 2016-06-02

新增

变更

[2.3.0] - 2016-05-18

新增

变更

[2.2.0] - 2016-04-28

修正

新增

变更

[2.1.0] - 2016-03-24

修正

新增

变更

[2.0.0] - 2016-02-22

修正

新增

[1.8.0] - 2016-01-18

修正

新增

变更

[1.7.1] - 2015-12-04

修正

[1.7.0] - 2015-12-01

修正

新增

变更

[1.6.0] - 2015-11-02

修正

新增

变更

[1.5.0] - 2015-09-29

新增

变更

设置一个会话里所有消息置为已读

- (void)markAllMessageReadInSession:(NIMSession *)session

改为

- (void)markAllMessagesReadInSession:(NIMSession *)session

获取所有最近会话

- (NSArray*)allRecentSession

改为

- (NSArray*)allRecentSessions

标记单条系统消息为已读

- (void)markNotificationAsRead:(NIMSystemNotification *)notification

改为

- (void)markNotificationsAsRead:(NIMSystemNotification *)notification

标记所有系统消息为已读

- (void)markAllNotificationAsRead

改为

- (void)markAllNotificationsAsRead

[1.4.0] - 2015-09-02

新增

变更

无

[1.3.0] - 2015-07-31

新增

变更

[1.2.0] - 2015-06-23

新增

变更

所有新增会话调用

- (void)didAddRecentSession:(NIMRecentSession *)recentSession

其它更新会话则调用

- (void)didUpdateRecentSession:(NIMRecentSession *)recentSession
              totalUnreadCount:(NSInteger)totalUnreadCount

[1.1.0] - 2015-05-25

新增

变更

网易云信SDK首版上线

连接管理

用户管理

会话消息

普通群（类讨论组）

高级群(类企业群)

推送

相关文档

相关产品

×

反馈成功

非常感谢您的反馈，我们会继续努力做得更好。
确定