初始化 iOS SDK

更新时间: 2024/03/13 15:44:31

本文提供初始化 NetEase IM SDK V10(以下简称 NIM SDK)的详细说明。

功能介绍

在使用云信 IM 的各项功能之前,必须先对 NIM SDK 进行初始化。一般情况下,在应用的生命周期内,仅需进行一次初始化。

初始化时,可配置 APNs 离线推送服务、会话已读多端同步、群消息已读和融合存储等重要功能。

前提条件

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

实现初始化

步骤1:引入头文件

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

#import <NIMSDK/NIMSDK.h>

步骤2(可选):配置初始化可选项

您可按需对初始化的可选项进行配置。

可选项(如果不配置,将使用默认配置)主要分为:

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

步骤3:调用初始化接口

调用 registerWithOptionV2 方法初始化 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 无法同时使用,只能选择其一。
    • 示例代码:
    NIMSDKOption *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

    此文档是否对你有帮助?
    有帮助
    去反馈
    • 功能介绍
    • 前提条件
    • 实现初始化
    • 步骤1:引入头文件
    • 步骤2(可选):配置初始化可选项
    • 步骤3:调用初始化接口
    • 后续步骤