初始化 iOS SDK

更新时间: 2024/09/05 16:38:53

本文介绍如何初始化适配 iOS 应用的 V10 系列网易云信即时通讯 SDK(简称 NIM SDK)。初始化 SDK 时,可同时配置 APNs 离线推送服务、会话已读多端同步、群消息已读和融合存储等重要功能。

调用时机

对 NIM SDK 进行初始化的时机,是在调用各项即时通讯功能之前。一般情况下,在应用的生命周期内,仅需进行一次初始化。

前提条件

初始化 NIM SDK 前,请确保您已 集成 SDK

第一步:引入头文件

在项目文件中引入头文件。

Objective-C#import <NIMSDK/NIMSDK.h>

第二步:配置初始化可选项

您可按需对初始化的可选项进行配置。本步骤为可选步骤,如果不配置,将使用默认配置。

配置可选项主要分为:

  • NIMSDKConfig:主要提供自动下载消息附件、撤回消息是否计入未读、是否多端同步未读数、HTTPS 支持、自动登录最大重试次数、本地日志存活期等重要 SDK 初始化配置项。
  • SDK 根目录:若不设置,数据默认放置于 $Document/NIMSDK 目录下。
  • NIMServerSetting:对网易云信服务器进行配置,如 CDN 域名下发、是否是专属云、IM 服务器 LBS 域名等。
  • NIMQChatConfig:可配置圈组初始化实例,如圈组消息缓存、自动订阅功能。

第三步:调用初始化接口

调用 registerWithOptionV2 方法初始化 SDK,推荐在应用程序启动时初始化,目的是配置 SDK 并准备进行登录和即时通讯功能。初始化成功后,即可使用 V10 所有的 API。

参数说明

参数 类型 是否必选 说明
option NIMSDKOption 应用配置参数。
v2Option V2NIMSDKOption V10 初始化配置参数。

V2NIMSDKOption 参数说明:

参数 类型 是否必选 说明
useV1Login BOOL 是否在开启 V10 API 后,仍使用 V9 的登录 API 登录 IM。
  • 默认 NO,即开启 V10 API 后需要使用 V10 的登录 API 登录 IM。
  • 设置为 YES,则开启 V10 API 后仍需要使用 V9 的登录 API 登录 IM。V9 和 V10 版本的登录 API 无法同时使用,只能选择其一。
  • 示例代码

    Objective-CNIMSDKOption *option = [NIMSDKOption optionWithAppKey:appKey];
    option.apnsCername = @"your apns certificate";
    option.pkCername = @"your push kit certificate";
    // 配置 useV1Login
    V2NIMSDKOption *v2Option = [[V2NIMSDKOption alloc] init];
    //激活 V10 所有 API,默认使用 V10 的登录接口登录 IM
    v2Option.useV1Login = NO;
    //若仍使用 V9 的登录接口登录 IM
    //v2Option.useV1Login = YES;
    [[NIMSDK sharedSDK] registerWithOptionV2:option v2Option:v2Option];
    

    下一步

    完成初始化后,您可以尝试 登录 IM

    此文档是否对你有帮助?
    有帮助
    去反馈
    • 调用时机
    • 前提条件
    • 第一步:引入头文件
    • 第二步:配置初始化可选项
    • 第三步:调用初始化接口
    • 参数说明
    • 示例代码
    • 下一步