文档反馈
文档反馈

初始化


NIMSDK 注册

NIM SDK 通过注册 App Key 来进行初始化。在使用 SDK 任何方法之前,都应该首先调用初始化方法。正常业务情况下,初始化方法有仅只应调用一次。

原型

@interface NIMSDK : NSObject
/**
 *  初始化SDK
 *
 *  @param option  注册选项
 */
- (void)registerWithOption:(NIMSDKOption *)option;
@end

NIMSDKOption 选项参数列表

参数 类型 说明
appKey NSString 云信分配的 App Key
apnsCername NSString 云信 APNs 推送证书名
pkCername NSString 云信 VOIP 推送证书名

AppKey 作为应用的唯一逻辑标识,同一 AppKey 不同 Bundle Id 的应用消息仍可以互通。

CerName 为开发者为推送证书在云信管理后台定义的名字,在使用中,云信服务器会寻找同名推送证书发起苹果推送服务。

目前 CerName 可传 APNs 证书 和 Voip 证书两种,分别对应了参数中 apnsCernamepkCername 两个字段。

如果没有在后台定义推送证书,则参数可传 nil 。

调用示例

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    ...
    //推荐在程序启动的时候初始化 NIMSDK    
    NSString *appKey        = @"your app key";
    NIMSDKOption *option    = [NIMSDKOption optionWithAppKey:appKey];
    option.apnsCername      = @"your APNs cer name";
    option.pkCername        = @"your pushkit cer name";
    [[NIMSDK sharedSDK] registerWithOption:option];
    ...
}

其他配置初始化

NIM SDK 还提供了一些其他额外的初始化配置以供开发者做一些扩展,定义在 NIMSDKConfig.h 中。

NIMSDKConfig 是一个单例,推荐在调用注册接口前配置。

原型

@interface NIMSDKConfig : NSObject

/**
 *  返回配置项实例
 *
 *  @return 配置项
 */
+ (instancetype)sharedConfig;

@end
配置名称 字段 说明
是否在收到消息后自动下载附件 fetchAttachmentAutomaticallyAfterReceiving 在收到图片或视频消息后,默认情况下 SDK 会去主动获取图片的缩略图和视频的第一帧封面,将这个字段设置为 NO,SDK 将不再主动获取,开发者需要在根据业务逻辑手动调用获取附件接口
是否在收到聊天室消息后自动下载附件 fetchAttachmentAutomaticallyAfterReceivingInChatroom 同普通消息下载附件开关说明,默认情况下 SDK 不会去主动获取聊天室消息的附件
是否使用 NSFileProtectionNone 作为云信文件的 NSProtectionKey fileProtectionNone 默认为 NO,只有在上层 APP 开启了 Data Protection 时才起效。设置成 YES 时,云信文件保护属性 为 NSFileProtectionNone ,设置成 NO 时,为 NSFileProtectionCompleteUntilFirstUserAuthentication
是否需要将被撤回的消息计入未读计算考虑 shouldConsiderRevokedMessageUnreadCount  默认为 NO。设置成 YES 的情况下,如果被撤回的消息本地还未读,那么当消息发生撤回时,对应会话的未读计数将减 1 以保持最近会话未读数的一致性。
是否需要多端同步未读数 shouldSyncUnreadCount 默认为 NO。设置成 YES 的情况下,同个账号多端(PC 和 移动端等)将同步未读计数。
自动登录重试次数 maxAutoLoginRetryTimes 即默认情况下,自动登录将无限重试。设置成大于 0 的值后,在没有登录成功前,自动登录将重试最多 maxAutoLoginRetryTimes 次,如果失败,则抛出错误 (NIMLocalErrorCodeAutoLoginRetryLimit)。
×

反馈成功

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