NIMSDKHeader.h
3.71 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
//
// NIMSDKHeaders.h
// NIMLib
//
// Created by Netease.
// Copyright (c) 2015 Netease. All rights reserved.
//
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@class NIMSDKOption;
@class NIMServerSetting;
/**
* NIMSDK
*/
@interface NIMSDK : NSObject
/**
* 获取SDK实例
*
* @return NIMSDK实例
*/
+ (instancetype)sharedSDK;
/**
* 获取SDK版本号
*
* @return SDK版本号
*/
- (NSString *)sdkVersion;
/**
* 初始化SDK
*
* @param appKey 申请的appKey
* @param cerName 推送证书名
* @discussion 如果需要更多注册选项，推荐使用 registerWithOption:
*/
- (void)registerWithAppID:(NSString *)appKey
cerName:(nullable NSString *)cerName;
/**
* 初始化SDK
*
* @param option 注册选项
*/
- (void)registerWithOption:(NIMSDKOption *)option;
/**
* 获取AppKey
*
* @return 返回当前注册的AppKey
*/
- (nullable NSString *)appKey;
/**
* 是否正在使用Demo AppKey
*
* @return 返回是否正在使用Demo AppKey
*/
- (BOOL)isUsingDemoAppKey;
/**
* 更新APNS Token
*
* @param token APNS Token
*/
- (void)updateApnsToken:(NSData *)token;
/**
* 更新 PushKit Token
*
* @param token PushKit token
* @discussion 目前仅支持 PKPushTypeVoIP
*/
- (void)updatePushKitToken:(NSData *)token;
/**
* 获得SDK Log路径
*
* @return SDK当天log路径
* @discussion 这个接口会返回当前最新的一个 log 文件路径,SDK 会每天生成一个 log 文件方便开发者定位和反馈问题
*/
- (NSString *)currentLogFilepath;
/**
* 开启控制台Log
*/
- (void)enableConsoleLog;
/**
* 当前服务器配置
* @discussion 私有化需要进行自定义设置，必须在注册 appkey 完成之前设置
*/
@property (nonatomic,strong) NIMServerSetting *serverSetting;
/**
* 登录管理类 负责登录,注销和相关操作的通知收发
*/
@property (nonatomic,strong,readonly) id<NIMLoginManager> loginManager;
/**
* 聊天管理类,负责消息的收发
*/
@property (nonatomic,strong,readonly) id<NIMChatManager> chatManager;
/**
* 会话管理类,负责消息,最近会话的读写和管理
*/
@property (nonatomic,strong,readonly) id<NIMConversationManager> conversationManager;
/**
* 媒体管理类,负责多媒体相关的接口 (录音等)
*/
@property (nonatomic,strong,readonly) id<NIMMediaManager> mediaManager;
/**
* 群组管理类,负责群组的操作:创建,拉人,踢人,同步等
*/
@property (nonatomic,strong,readonly) id<NIMTeamManager> teamManager;
/**
* 好友管理类
*/
@property (nonatomic,strong,readonly) id<NIMUserManager> userManager;
/**
* 系统通知管理类
*/
@property (nonatomic,strong,readonly) id<NIMSystemNotificationManager> systemNotificationManager;
/**
* APNS推送管理类
*/
@property (nonatomic,strong,readonly) id<NIMApnsManager> apnsManager;
/**
* 资源管理器,负责文件上传和下载
*/
@property (nonatomic,strong,readonly) id<NIMResourceManager> resourceManager;
/**
* 聊天室管理类
*/
@property (nonatomic,strong,readonly) id<NIMChatroomManager> chatroomManager;
/**
* 文档转码管理类
*/
@property (nonatomic,strong,readonly) id<NIMDocTranscodingManager> docTranscodingManager;
/**
* 事件订阅管理类
*/
@property (nonatomic,strong,readonly) id<NIMEventSubscribeManager> subscribeManager;
/**
* 智能机器人管理类
*/
@property (nonatomic,strong,readonly) id<NIMRobotManager> robotManager;
/**
* 红包管理类
*/
@property (nonatomic,strong,readonly) id<NIMRedPacketManager> redPacketManager;
/**
* 广播消息管理类
*/
@property (nonatomic,strong,readonly) id<NIMBroadcastManager> broadcastManager;
@end
NS_ASSUME_NONNULL_END