初始化

下载pdf
更新时间:2019-09-27 10:09

1 功能简介

集成 SDK 后,要想使用 SDK 的功能,还需要对 SDK 进行初始化操作。

2 使用步骤

2.1 导入 SDK 头文件

首先,导入头文件:

#import <ZegoChatroom/ZegoChatroom.h>

2.2 初始化

  1. 设置测试环境。
    从官网申请的 AppID 默认是测试环境,而 SDK 初始化默认是正式环境,所以需要在初始化 SDK 前设置测试环境,否则 SDK 会初始化失败,当 App 集成完成后,再向 ZEGO 申请开启正式环境。

注意上线前需切换为正式环境运营。

  1. 设置语聊房单例初始化配置。

    请注意:

    1. userID 和 userName 来自于 App 自定义的账号系统。
    2. AppID 和 AppSign 由 ZEGO 分配给各 App。为了安全考虑,建议将 AppSign 存储在 App 的业务后台,使用时从后台获取。

核心代码片段示例如下:

// 设置测试环境
[ZegoChatroom setUseTestEnv:YES];

// 设置语聊房单例初始化配置
[ZegoChatroom setAppID:appID appSignature:appSign user:ZGUserHelper.user];

// 初始化 ZegoChatroom 单例对象。
[ZegoChatroom shared];

2.3 集成日志上传

SDK 不会自动上传日志,为了便于人工定位问题,我们建议开发者将 SDK 的日志上传功能,集成在 App 的合适位置。

请注意,建议开发者在 App 中引导用户手动触发日志上传。不建议 App 频繁自动上传日志

上报日志 API 调用示例代码如下:

[ZegoChatroom uploadLog];

3 相关文档

初始化完成后,开发者即可调用 SDK 接口实现语聊功能。

常用功能-进入房间

4 API参考列表

API 描述
+ setAppID:appSignature:user: 设置语聊房单例初始化配置
+ shared 获取语聊房单例
+ releaseShared 释放当前语聊房单例
+ setUseTestEnv: 是否启用测试环境
+ uploadLog 上报日志