#import <NIMSDKHeader.h>
构造函数 | |
| (NSString *) | - sdkVersion |
| (NSString *) | - gitVersion |
| (void) | - registerWithAppID:cerName: |
| (void) | - registerWithOption: |
| (nullable NSString *) | - appKey |
| (BOOL) | - isUsingDemoAppKey |
| (void) | - qchatWithOption: |
| (NSString *) | - updateApnsToken: |
| (NSString *) | - updateApnsToken:customContentKey: |
| (NSString *) | - updateApnsToken:customContentKey:qchatCustomContentKey: |
| (void) | - updatePushKitToken: |
| (NSString *) | - currentLogFilepath |
| (void) | - archiveLogs: |
| (void) | - uploadLogs: |
| (void) | - uploadLogsWithAttach:roomId:completion: |
| (void) | - optimizeQChat |
| (void) | - enableConsoleLog |
类方法 | |
| (instancetype) | + sharedSDK |
详细描述
SDK 核心类，提供初始化 SDK，获取各个服务能力接口，获取当前版本等接口
函数文档
◆ appKey
| - (nullable NSString *) appKey |
获取 AppKey。
- 返回：
- 当前注册应用的 AppKey
◆ archiveLogs:
| - (void) archiveLogs: | (NIMArchiveLogsHandler) | completion |
打包当前所有的 log 文件，调用该接口后，SDK 将压缩当前所有的日志为 Zip 文件，并输出 Zip 路径，上层可以根据该文件进行上传反馈。
- 参数说明：
- completion：压缩日志的回调，回调信息包含 error（执行结果，如果成功将返回 nil）和 path（压缩包的路径，只有当执行成功才有值，否则将返回 nil）
◆ currentLogFilepath
| - (NSString *) currentLogFilepath |
获得 SDK 当前的 log 文件路径。
- 注意事项：
- SDK 每天会生成一个 log 文件，方便开发者定位和反馈问题。
- 返回：
- SDK 当前的 log 文件路径（当前生成的最新的 log 文件路径）
◆ enableConsoleLog
| - (void) enableConsoleLog |
开启控制台 Log。调用该接口开启控制台 Log 后，会将云信 SDK 的日志写进开发者调试工具的控制台日志文件中（Console Log）。
◆ gitVersion
| - (NSString *) gitVersion |
获取当前 Git 的版本号。
◆ isUsingDemoAppKey
| - (BOOL) isUsingDemoAppKey |
是否正在使用 Demo 的 AppKey。
- 返回：
- YES：正在使用；NO ：没有使用
◆ optimizeQChat
| - (void) optimizeQChat |
优化圈组表现。
◆ qchatWithOption:
| - (void) qchatWithOption: | (NIMQChatOption *) | option |
配置圈组的推送证书。通过配置推送证书的名称（对应云信控制台上的推送证书名称），与第三方推送厂商完成通信。
- 参数说明：
- option：圈组选项，推送证书名称
◆ registerWithAppID:cerName:
| - (void) registerWithAppID: | (NSString *) | appKey | |
| cerName: | (nullable NSString *) | cerName | |
初始化 SDK，初始化时，可同时注册应用的 AppKey 和 APNs 推送证书名称。
如需要同时配置 PushKit 推送证书名称，请使用 - (void)registerWithOption:option; 接口。
- 调用时机：
- 建议在应用启动时初始化 NIM SDK。
- 参数说明：
参数名称 描述 appKey 对应云信控制台应用的 AppKey，应用的唯一标识。使用相同 App Key 、不同 Bundle Id 的应用，消息仍可以互通 cerName 对应云信控制台配置的推送证书名称，不超过 32 个字符，否则登录时会报 500 错误
◆ registerWithOption:
| - (void) registerWithOption: | (NIMSDKOption *) | option |
初始化 SDK，初始化时，可同时注册 APNs 推送证书名称和 PushKit 推送证书名称。
- 调用时机：
- 建议在应用启动时初始化 NIM SDK。
- 参数说明：
- option：初始化的配置项，包括应用的 AppKey 、APNs 推送证书名称和 PushKit 推送证书名称
◆ sdkVersion
| - (NSString *) sdkVersion |
获取当前 SDK 版本号。
- 返回：
- 当前 SDK 版本号，如 "1.0.0"
◆ sharedSDK
| + (instancetype) sharedSDK |
获取 NIM SDK 实例。
- 调用时机：
- IM 所有业务均通过 NIM SDK 单例进行调用。
- 注意事项：
- 虽然所有的云信接口都是线程安全的，但为了防范于未然，推荐您在且只在主线程调用该接口。
- 返回：
- NIM SDK: 实例
◆ updateApnsToken:
| - (NSString *) updateApnsToken: | (NSData *) | token |
上传/更新 DeviceToken 至云信服务器，用于后续的 APNs 推送。若需要同时设置自定义推送文案，请使用 updateApnsToken:customContentKey: customContentKey:(nullable NSString *)key;
- 参数说明：
- token：当前设备的 DeviceToken
- 返回：
- 格式化后的 DeviceToken
◆ updateApnsToken:customContentKey:
| - (NSString *) updateApnsToken: | (NSData *) | token | |
| customContentKey: | (nullable NSString *) | key | |
上传/更新 DeviceToken 至云信服务器，用于后续的 APNs 推送。该接口可同时设置自定义推送文案（对应云信控制台中的自定义推送文案类型）。若需要在圈组中使用自定义推送文案，请使用 updateApnsToken:customContentKey:qchatCustomContentKey:
- 参数说明：
参数名称 描述 token 当前设备的 DeviceToken key 自定义的推送文案（对应云信控制台中的自定义推送文案类型，最多可设置 100 种，对应不同的业务场景）
不填（nil），则表示不更改，使用云信系统内默认的推送文案：“你收到一条新消息”；
填 “”（空值），则清空配置；
- 返回：
- 格式化后的 DeviceToken
◆ updateApnsToken:customContentKey:qchatCustomContentKey:
| - (NSString *) updateApnsToken: | (NSData *) | token | |
| customContentKey: | (nullable NSString *) | key | |
| qchatCustomContentKey: | (nullable NSString *) | qchatKey | |
上传/更新 DeviceToken 至云信服务器，用于后续的 APNs 推送。该接口可同时设置自定义推送文案以及圈组自定义推送文案（对应云信控制台中的自定义推送文案类型）。
- 参数说明：
参数名称 描述 token 当前设备的 DeviceToken key 自定义的推送文案（对应云信控制台中的自定义推送文案类型，最多可设置 100 种，对应不同的业务场景）
不填（nil），则表示不更改，使用云信系统内默认的推送文案：“你收到一条新消息”；
填 “”（空值），则清空配置qchatKey 圈组的自定义推送文案（对应云信控制台中的自定义推送文案类型，最多可设置 100 种，对应不同的业务场景）
不填（nil），则表示不更改，圈组使用云信系统内默认的推送文案：“你收到一条新消息”；
填 “”（空值），则清空配置
- 返回：
- 格式化后的 DeviceToken
◆ updatePushKitToken:
| - (void) updatePushKitToken: | (NSData *) | token |
上传/更新 PushKit Token 至云信服务器，用于后续的离线推送。目前仅支持 PKPushTypeVoIP 类型。
- 参数说明：
- token ：VoIP Push Token
- 返回：
- 格式化后的 VoIP Push Token
◆ uploadLogs:
| - (void) uploadLogs: | (NIMUploadLogsHandler _Nullable) | completion |
打包并上传当前所有的 log 文件，调用该接口后，SDK 将压缩当前所有的日志为 Zip 文件，输出 Zip 路径并上传，上层可以根据该文件进行上传反馈。
- 参数说明：
- completion：打包并上传日志的回调，回调信息包含 error（执行结果，如果成功将返回 nil）和 path（压缩包的路径，只有当执行成功才有值，否则将返回 nil）
◆ uploadLogsWithAttach:roomId:completion:
| - (void) uploadLogsWithAttach: | (nullable NSString *) | attach | |
| roomId: | (nullable NSString *) | roomId | |
| completion: | (NIMUploadLogsHandler _Nullable) | completion | |
打包并上传目标聊天室的所有的 log 文件，调用该接口后，SDK 将压缩目标聊天室当前所有的日志为 Zip 文件，输出 Zip 路径并上传，上层可以根据该文件进行上传反馈。
- 参数说明：
参数名称 描述 attach 附言，可为空 roomId 目标聊天室 ID，可为空 completion 打包并上传日志的回调，回调信息包含 error 和 path
error ：执行结果，如果成功将返回 nil
path ：压缩包的路径，只有当执行成功才有值，否则将返回 nil
属性说明
◆ antispamManager
|
readnonatomicstrong |
反垃圾管理类，提供本地反垃圾检查接口
◆ apnsManager
|
readnonatomicstrong |
APNS 推送管理类，提供APNs 离线推送服务相关配置接口
◆ broadcastManager
|
readnonatomicstrong |
广播消息管理类，提供广播消息监听等接口
◆ chatExtendManager
|
readnonatomicstrong |
Thread Talk（扩展消息）管理类，提供收藏消息、快捷评论等接口
◆ chatManager
|
readnonatomicstrong |
聊天管理类，提供消息发送、消息查询、消息撤回等相关接口
◆ chatroomManager
|
readnonatomicstrong |
聊天室管理类，提供进出聊天室、发送聊天室消息、聊天室成员管理、聊天室队列服务、聊天室标签等接口
◆ conversationManager
|
readnonatomicstrong |
会话管理类，负责消息、最近会话的读写和管理，提供获取/删除会话消息、设置会话消息已读等相关接口
◆ customizedAPIManager
|
readnonatomicstrong |
定制化接口调用管理类，提供调用定制化 API 接口
◆ docTranscodingManager
|
readnonatomicstrong |
文档转码管理类，提供查询文档转码信息、删除转码文档等接口
◆ indexManager
|
readnonatomicstrong |
索引管理类，提供消息检索相关接口
◆ loginManager
|
readnonatomicstrong |
登录管理类，负责登录、注销和相关操作的通知收发，提供鉴权、登录、登出、踢人等接口
◆ mediaManager
|
readnonatomicstrong |
媒体管理类，提供语音录制和播放相关接口
◆ passThroughManager
|
readnonatomicstrong |
透传代理管理类
◆ qchatApnsManager
|
readnonatomicstrong |
圈组APNS推送管理类
◆ qchatChannelManager
|
readnonatomicstrong |
圈组频道管理类
◆ qchatManager
|
readnonatomicstrong |
圈组管理类
◆ qchatMessageExtendManager
|
readnonatomicstrong |
圈组消息扩展管理类
◆ qchatMessageManager
|
readnonatomicstrong |
圈组消息管理类
◆ qchatRoleManager
|
readnonatomicstrong |
圈组身份组管理类
◆ qchatRTCChannelManager
|
readnonatomicstrong |
圈组rtc管理类
◆ qchatServerManager
|
readnonatomicstrong |
圈组服务器管理类
◆ redPacketManager
|
readnonatomicstrong |
红包管理类，提供获取红包 token 的接口
◆ resourceManager
|
readnonatomicstrong |
资源管理器，提供下载、搜索、查询资源等接口
◆ robotManager
|
readnonatomicstrong |
智能机器人管理类，提供获取机器人信息等接口
◆ sceneDict
|
readwritenonatomicstrong |
资源场景配置 @discussion nos 预设场景和自定义场景规则 可以覆盖设置，如果预设场景不设置，为系统默认设置 sceneDict key-value，系统默认预设场景为3种，自定义场景不超过10种 key 是场景，nsstring类型；value 是资源存活时间，nsnumber类型，精确到天，0为永久存活 例如："nim_icon":@0,@"nim_msg":@0,@"nim_system":@0,@"nim_custom":@30}
◆ serverSetting
|
readwritenonatomicstrong |
当前服务器配置 @discussion 私有化需要进行自定义设置，必须在注册 appkey 完成之前设置
◆ signalManager
|
readnonatomicstrong |
通用音视频信令管理类，提供信令相关接口
◆ subscribeManager
|
readnonatomicstrong |
事件订阅管理类，提供发布、查询、订阅事件等接口
◆ superTeamManager
|
readnonatomicstrong |
超大群管理类，提供超大群成员管理、超大群消息发送、超大群资料管理等相关接口
◆ systemNotificationManager
|
readnonatomicstrong |
系统通知管理类，提供发送、标记、删除系统通知等接口
◆ teamManager
|
readnonatomicstrong |
群组管理类,负责群组的操作:创建,拉人,踢人,同步等
◆ userManager
|
readnonatomicstrong |
好友管理类，提供用户信息管理和好友关系管理相关接口
该类的文档由以下文件生成:
