lpw
2022-03-14 7acec95dedc4b1175a8d1fc5a123f5d381d276f8
commit | author | age
eec5d6 1 ///
L 2 /// \file TencentOAuth.h
3 /// \brief QQ互联开放平台授权登录及相关开放接口实现类
4 ///
5 /// Created by Tencent on 12-12-21.
6 /// Copyright (c) 2012年 Tencent. All rights reserved.
7 ///
8
9 #import <UIKit/UIKit.h>
7acec9 10 #import <TencentOpenAPI/SDKDef.h>
eec5d6 11
L 12 @protocol TencentSessionDelegate;
13 @protocol TencentLoginDelegate;
14 @protocol TencentApiInterfaceDelegate;
15 @protocol TencentWebViewDelegate;
16
17 @class TencentApiReq;
18 @class TencentApiResp;
19
20 typedef NS_ENUM(NSUInteger, TencentAuthorizeState) {
21     kTencentNotAuthorizeState,
22     kTencentSSOAuthorizeState,
23     kTencentWebviewAuthorzieState,
24 };
25
26 typedef NS_ENUM(NSUInteger, TencentAuthMode) {
27     kAuthModeClientSideToken,
28     kAuthModeServerSideCode,
29 };
30
31 #pragma mark - TencentOAuth(授权登录及相关开放接口调用)
32
33 /**
34  * \brief TencentOpenAPI授权登录及相关开放接口调用
35  *
36  * TencentOAuth实现授权登录逻辑以及相关开放接口的请求调用
37  */
38 @interface TencentOAuth : NSObject
39 {
7acec9 40     NSMutableDictionary *_apiRequests;
L 41     NSString *_accessToken;
42     NSDate *_expirationDate;
eec5d6 43     id<TencentSessionDelegate> _sessionDelegate;
7acec9 44     NSString *_localAppId;
L 45     NSString *_openId;
46     NSString *_redirectURI;
47     NSArray *_permissions;
eec5d6 48 }
L 49
50 /** Access Token凭证,用于后续访问各开放接口 */
7acec9 51 @property(nonatomic, copy) NSString *accessToken;
eec5d6 52
L 53 /** Access Token的失效期 */
7acec9 54 @property(nonatomic, copy) NSDate *expirationDate;
eec5d6 55
L 56 /** 已实现的开放接口的回调委托对象 */
7acec9 57 @property(nonatomic, weak) id<TencentSessionDelegate> sessionDelegate;
eec5d6 58
L 59 /** 第三方应用在开发过程中设置的URLSchema,用于浏览器登录后后跳到第三方应用 */
7acec9 60 @property(nonatomic, copy) NSString *localAppId;
eec5d6 61
L 62 /** 用户授权登录后对该用户的唯一标识 */
7acec9 63 @property(nonatomic, copy) NSString *openId;
eec5d6 64
L 65 /** 用户登录成功过后的跳转页面地址 */
7acec9 66 @property(nonatomic, copy) NSString *redirectURI;
eec5d6 67
L 68 /** 第三方应用在互联开放平台申请的appID */
7acec9 69 @property(nonatomic, retain) NSString *appId;
eec5d6 70
L 71 /** 第三方应用在互联开放平台注册的UniversalLink */
7acec9 72 @property(nonatomic, retain) NSString *universalLink;
eec5d6 73
L 74 /** 主要是互娱的游戏设置uin */
7acec9 75 @property(nonatomic, retain) NSString *uin;
eec5d6 76
L 77 /** 主要是互娱的游戏设置鉴定票据 */
7acec9 78 @property(nonatomic, retain) NSString *skey;
eec5d6 79
L 80 /** 登陆透传的数据 */
7acec9 81 @property(nonatomic, copy) NSDictionary *passData;
eec5d6 82
L 83 /** 授权方式(Client Side Token或者Server Side Code) */
84 @property(nonatomic, assign) TencentAuthMode authMode;
85
86 /** union id */
7acec9 87 @property(nonatomic, retain) NSString *unionid;
eec5d6 88
L 89 /** 第三方在授权登录/分享 时选择 QQ,还是TIM 。在授权前一定要指定其中一个类型*/
90 @property(nonatomic, assign) TencentAuthShareType authShareType;
7acec9 91
eec5d6 92 /**
L 93  * 获取上次登录得到的token
94  *
95  **/
96 - (NSString *)getCachedToken;
97
98 /**
99  * 获取上次登录得到的openid
100  *
101  **/
102 - (NSString *)getCachedOpenID;
103
104 /**
105  * 获取上次登录的token过期日期
106  *
107  **/
108 - (NSDate *)getCachedExpirationDate;
109
110 /**
111  * 上次登录的token是否过期(本地判断)
112  **/
113 - (BOOL)isCachedTokenValid;
114
115 /**
116  * 删除上次登录登录的token信息
117  *
118  **/
119 - (BOOL)deleteCachedToken;
120
121 /**
122  * 用来获得当前sdk的版本号
123  * \return 返回sdk版本号
124  **/
125
7acec9 126 + (NSString *)sdkVersion;
eec5d6 127
L 128 /**
129  * 用来获得当前sdk的小版本号
130  * \return 返回sdk小版本号
131  **/
132
7acec9 133 + (NSString *)sdkSubVersion;
eec5d6 134
L 135 /**
136  * 用来获得当前sdk的是否精简版
137  * \return 返回YES表示精简版
138  **/
139
140 + (BOOL)isLiteSDK;
141
142 /** 
143  * 主要是用来帮助判断是否有登陆被发起,但是还没有过返回结果 
144  * \return 
145  *          kTencentNotAuthorizeState:无授权 
146  *          kTencentSSOAuthorizeState:有人发起了sso授权但无返回
147  *          kTencentWebviewAuthorzieState:有人发起了webview授权还未返回
148  **/
149
150 + (TencentAuthorizeState *)authorizeState;
151
152 /**
153  * 初始化TencentOAuth对象
8822d6 154  * \param appId 不可为nil,第三方应用在互联开放平台申请的唯一标识
L 155  * \param delegate 不可为nil,第三方应用用于接收请求返回结果的委托对象
eec5d6 156  * \return 初始化后的授权登录对象
L 157  */
158 - (id)initWithAppId:(NSString *)appId
159         andDelegate:(id<TencentSessionDelegate>)delegate;
160
161 /**
162 * 初始化TencentOAuth对象(>=3.3.7)
8822d6 163 * \param appId 不可为nil,第三方应用在互联开放平台申请的唯一标识
L 164 * \param universalLink 可以为nil,第三方应用在互联开放平台注册的UniversalLink,和bundleID一一对应(当为nil时,互联平台会按规则生成universallink,详见官网说明)
165 * \param delegate 不可为nil,第三方应用用于接收请求返回结果的委托对象
eec5d6 166 * \return 初始化后的授权登录对象
8822d6 167 *
L 168 ****【使用说明】*****
169 * 1、支持BundleId与UniversalLink的一一对应,主要目的“是为了解决应用的iPhone版本和iPad HD版本共用同一个AppId,导致同时安装情况下的跳转问题"。
170 * 2 、由于手Q版本在 >=8.1.8 后才支持了这种对应方式,所以一旦使用,“务必做到”及时知会用户升级手Q版本。
171 ****
eec5d6 172 */
L 173 - (id)initWithAppId:(NSString *)appId
174    andUniversalLink:(NSString *)universalLink
175         andDelegate:(id<TencentSessionDelegate>)delegate;
8822d6 176
L 177 /**
178 * 初始化TencentOAuth对象(>=3.3.8)
179 * \param appId 不可为nil,第三方应用在互联开放平台申请的唯一标识
180 * \param enabled  默认为NO,第三方应用是否将sdk和手机QQ的交互方式切换为UniversalLink方式,启用后则在iOS9及以上的系统都会生效UniversalLink方式;否则,默认仅在iOS13及以上的系统生效UniversalLink方式。
181 * \param universalLink 可以为nil,第三方应用在互联开放平台注册的UniversalLink,和bundleID一一对应(当为nil时,互联平台会按规则生成UniversalLink,详见官网说明)
182 * \param delegate 不可为nil,第三方应用用于接收请求返回结果的委托对象
183 * \return 初始化后的授权登录对象
184 *
185 *****【使用说明】*****
186 *  1、支持sdk与手Q的交互切换为UniversalLink模式,主要目的"是为了避免手Q的UrlScheme被其他应用抢注后,导致sdk接口功能受到影响"。
187 *  2 、由于手Q版本在 >=8.1.3 后才适配了UniversalLink,所以一旦开启了enabled开关,“务必做到”及时知会用户升级手Q版本。
188 *****
189 */
190 - (id)initWithAppId:(NSString *)appId
191  enableUniveralLink:(BOOL)enabled
192       universalLink:(NSString *)universalLink
193            delegate:(id<TencentSessionDelegate>)delegate;
eec5d6 194
L 195 /**
7acec9 196  * 设置用户是否已经授权同意授权隐私协议,在主体应用中,用户同意授权隐私协议后再初始化互联SDK,默认未同意授权
L 197  * 注意:如未同意授权隐私协议,则互联SDK的所有功能都无法使用,包括初始化!!!
198  * 从3.5.7版本开始支持该方法
199  *
200  * @param isAgreedAuthorization 是否已经授权,isAgreedAuthorization=YES, 表示已经同意授权;isAgreedAuthorization=NO,表示未同意授权,互联SDK的所有功能都无法使用
201  */
202 + (void)setIsUserAgreedAuthorization:(BOOL)isUserAgreedAuthorization;
203
204 /**
205  * 获取当前用户是否已经同意授权隐私协议
206  * 从3.5.7版本开始支持该方法
207  */
208 + (BOOL)isUserAgreedAuthorization;
209
210 /**
eec5d6 211  * 判断用户手机上是否安装手机QQ
L 212  * \return YES:安装 NO:没安装
213  *
214  * \note SDK目前已经支持QQ、TIM授权登录及分享功能, 会按照QQ>TIM的顺序进行调用。
215  * 只要用户安装了QQ、TIM中任意一个应用,都可为第三方应用进行授权登录、分享功能。
216  * 第三方应用在接入SDK时不需要判断是否安装QQ、TIM。若有判断安装QQ、TIM的逻辑建议移除。
217  */
218 + (BOOL)iphoneQQInstalled;
219
220 /**
221  * 判断用户手机上是否安装手机TIM
222  * \return YES:安装 NO:没安装
223  *
224  * \note SDK目前已经支持QQ、TIM授权登录及分享功能, 会按照QQ>TIM的顺序进行调用。
225  * 只要用户安装了QQ、TIM中任意一个应用,都可为第三方应用进行授权登录、分享功能。
226  * 第三方应用在接入SDK时不需要判断是否安装QQ、TIM。若有判断安装QQ、TIM的逻辑建议移除。
227  */
228 + (BOOL)iphoneTIMInstalled;
229  
230 /**
231  * 登录授权
232  *
233  * \param permissions 授权信息列
234  */
235 - (BOOL)authorize:(NSArray *)permissions;
236
237 /**
238  * 登录授权
239  * \param permissions 授权信息列表
240  * \param localAppId 应用APPID
241  */
242 - (BOOL)authorize:(NSArray *)permissions
8822d6 243        localAppId:(NSString *)localAppId;
eec5d6 244
L 245 /**
246  * 登录授权<web为二维码扫码方式>
247  *
248  * \param permissions 授权信息列
249  */
250 - (BOOL)authorizeWithQRlogin:(NSArray *)permissions;
251
252 /**
253  * 增量授权,因用户没有授予相应接口调用的权限,需要用户确认是否授权
254  * \param permissions 需增量授权的信息列表
255  * \return 增量授权调用是否成功
256  */
257 - (BOOL)incrAuthWithPermissions:(NSArray *)permissions;
258
259 /**
260  * 重新授权,因token废除或失效导致接口调用失败,需用户重新授权
261  * \param permissions 授权信息列表,同登录授权
262  * \return 授权调用是否成功
263  */
264 - (BOOL)reauthorizeWithPermissions:(NSArray *)permissions;
265
266 /**
267  * 获取UnindID,可以根据UnindID的比较来确定OpenID是否属于同一个用户
268  * \return NO未登录,信息不足;YES条件满足,发送请求成功,请等待回调
269  */
270 - (BOOL)RequestUnionId;
271
272 /**
273  * (静态方法)处理应用拉起协议
274  * \param url 处理被其他应用呼起时的逻辑
275  * \return 处理结果,YES表示成功,NO表示失败
276  */
277 + (BOOL)HandleOpenURL:(NSURL *)url;
278
279 /**
280  * (静态方法)sdk是否可以处理应用拉起协议
281  * \param url 处理被其他应用呼起时的逻辑
282  * \return 处理结果,YES表示可以 NO表示不行
283  */
284 + (BOOL)CanHandleOpenURL:(NSURL *)url;
285
286 /**
287  * (静态方法)处理应用的UniversalLink拉起协议
288  * \param url 处理被其他应用呼起时的逻辑
289  * \return 处理结果,YES表示成功,NO表示失败
290  */
291 + (BOOL)HandleUniversalLink:(NSURL *)url;
292
293 /**
294  * (静态方法)sdk是否可以处理应用的Universallink拉起协议
295  * \param url 处理被其他应用呼起时的逻辑(应用的Universallink链接须满足官网注册时的格式要求)
296  * \return 处理结果,YES表示可以 NO表示不行
297  * 注:在调用其他Universallink相关处理接口之前,均需进行此项判断
298  */
299 + (BOOL)CanHandleUniversalLink:(NSURL *)url;
300
301 /**
302  * (静态方法)获取TencentOAuth调用的上一次错误信息
303  */
304 + (NSString *)getLastErrorMsg;
305
306 /**
307  * 以Server Side Code模式授权登录时,通过此接口获取返回的code值;
308  * 以Client Side Token模式授权登录时,忽略此接口。
309  */
310 - (NSString *)getServerSideCode;
311
312 /**
313  * 退出登录(退出登录后,TecentOAuth失效,需要重新初始化)
314  * \param delegate 第三方应用用于接收请求返回结果的委托对象
315  */
316 - (void)logout:(id<TencentSessionDelegate>)delegate;
317
318 /**
319  * 判断登录态是否有效
320  * \return 处理结果,YES表示有效,NO表示无效,请用户重新登录授权
321  */
322 - (BOOL)isSessionValid;
323
324 /**
325  * 获取用户个人信息
326  * \return 处理结果,YES表示API调用成功,NO表示API调用失败,登录态失败,重新登录
327  */
328 - (BOOL)getUserInfo;
329
330 /**
331  * 退出指定API调用
332  * \param userData 用户调用某条API的时候传入的保留参数
333  * \return 处理结果,YES表示成功 NO表示失败
334  */
335 - (BOOL)cancel:(id)userData;
336
337 /**
338  * CGI类任务创建接口
339  * \param apiURL CGI请求的URL地址
340  * \param method CGI请求方式:"GET","POST"
341  * \param params CGI请求参数字典
342  * \param callback CGI请求结果的回调接口对象
343  * \return CGI请求任务实例,用于取消任务,返回nil代表任务创建失败
344  */
345 - (TCAPIRequest *)cgiRequestWithURL:(NSURL *)apiURL method:(NSString *)method params:(NSDictionary *)params callback:(id<TCAPIRequestDelegate>)callback;
346
347 /**
348  * TencentOpenApi发送任务统一接口
349  * \param request 请求发送的任务
350  * \param callback 任务发送后的回调地址
351  */
352 - (BOOL)sendAPIRequest:(TCAPIRequest *)request callback:(id<TCAPIRequestDelegate>)callback;
353
354 - (NSString *)getUserOpenID;
355
356 @end
357
358 #pragma mark - TencentLoginDelegate(授权登录回调协议)
359
360 /**
361  * \brief TencentLoginDelegate iOS Open SDK 1.3 API回调协议
362  *
363  * 第三方应用实现登录的回调协议
364  */
365 @protocol TencentLoginDelegate <NSObject>
366
367 @required
368
369 /**
370  * 登录成功后的回调
371  */
372 - (void)tencentDidLogin;
373
374 /**
375  * 登录失败后的回调
376  * \param cancelled 代表用户是否主动退出登录
377  */
378 - (void)tencentDidNotLogin:(BOOL)cancelled;
379
380 /**
381  * 登录时网络有问题的回调
382  */
383 - (void)tencentDidNotNetWork;
384
385 @optional
386 /**
387  * 登录时权限信息的获得
388  */
8822d6 389 - (NSArray *)getAuthorizedPermissions:(NSArray *)permissions withExtraParams:(NSDictionary *)extraParams __attribute__((deprecated("该接口已过期, 建议删除调用")));
eec5d6 390
L 391 /**
392  * unionID获得
393  */
394 - (void)didGetUnionID;
395
396 /**
397  * 强制网页登录,包括账号密码登录和二维码登录
398  * return YES时,就算本地有手Q也会打开web界面
399  */
400 - (BOOL)forceWebLogin;
401 @end
402
403 #pragma mark - TencentSessionDelegate(开放接口回调协议)
404
405 /**
406  * \brief TencentSessionDelegate iOS Open SDK 1.3 API回调协议
407  *
408  * 第三方应用需要实现每条需要调用的API的回调协议
409  */
410 @protocol TencentSessionDelegate<NSObject, TencentLoginDelegate,
411                                 TencentWebViewDelegate>
412
413 @optional
414
415 /**
416  * 退出登录的回调
417  */
418 - (void)tencentDidLogout;
419
420 /**
421  * 因用户未授予相应权限而需要执行增量授权。在用户调用某个api接口时,如果服务器返回操作未被授权,则触发该回调协议接口,由第三方决定是否跳转到增量授权页面,让用户重新授权。
422  * \param tencentOAuth 登录授权对象。
423  * \param permissions 需增量授权的权限列表。
424  * \return 是否仍然回调返回原始的api请求结果。
425  * \note 不实现该协议接口则默认为不开启增量授权流程。若需要增量授权请调用\ref TencentOAuth#incrAuthWithPermissions: \n注意:增量授权时用户可能会修改登录的帐号
426  */
427 - (BOOL)tencentNeedPerformIncrAuth:(TencentOAuth *)tencentOAuth withPermissions:(NSArray *)permissions;
428
429 /**
430  * [该逻辑未实现]因token失效而需要执行重新登录授权。在用户调用某个api接口时,如果服务器返回token失效,则触发该回调协议接口,由第三方决定是否跳转到登录授权页面,让用户重新授权。
431  * \param tencentOAuth 登录授权对象。
432  * \return 是否仍然回调返回原始的api请求结果。
433  * \note 不实现该协议接口则默认为不开启重新登录授权流程。若需要重新登录授权请调用\ref TencentOAuth#reauthorizeWithPermissions: \n注意:重新登录授权时用户可能会修改登录的帐号
434  */
435 - (BOOL)tencentNeedPerformReAuth:(TencentOAuth *)tencentOAuth;
436
437 /**
438  * 用户通过增量授权流程重新授权登录,token及有效期限等信息已被更新。
439  * \param tencentOAuth token及有效期限等信息更新后的授权实例对象
440  * \note 第三方应用需更新已保存的token及有效期限等信息。
441  */
442 - (void)tencentDidUpdate:(TencentOAuth *)tencentOAuth;
443
444 /**
445  * 用户增量授权过程中因取消或网络问题导致授权失败
446  * \param reason 授权失败原因,具体失败原因参见sdkdef.h文件中\ref UpdateFailType
447  */
448 - (void)tencentFailedUpdate:(UpdateFailType)reason;
449
450 /**
451  * 获取用户个人信息回调
452  * \param response API返回结果,具体定义参见sdkdef.h文件中\ref APIResponse
453  * \remarks 正确返回示例: \snippet example/getUserInfoResponse.exp success
454  *          错误返回示例: \snippet example/getUserInfoResponse.exp fail
455  */
456 - (void)getUserInfoResponse:(APIResponse*) response;
457
458 /**
459  * 社交API统一回调接口
460  * \param response API返回结果,具体定义参见sdkdef.h文件中\ref APIResponse
461  * \param message 响应的消息,目前支持‘SendStory’,‘AppInvitation’,‘AppChallenge’,‘AppGiftRequest’
462  */
463 - (void)responseDidReceived:(APIResponse*)response forMessage:(NSString *)message;
464
465 /**
466  * post请求的上传进度
467  * \param tencentOAuth 返回回调的tencentOAuth对象
468  * \param bytesWritten 本次回调上传的数据字节数
469  * \param totalBytesWritten 总共已经上传的字节数
470  * \param totalBytesExpectedToWrite 总共需要上传的字节数
471  * \param userData 用户自定义数据
472  */
473 - (void)tencentOAuth:(TencentOAuth *)tencentOAuth didSendBodyData:(NSInteger)bytesWritten totalBytesWritten:(NSInteger)totalBytesWritten totalBytesExpectedToWrite:(NSInteger)totalBytesExpectedToWrite userData:(id)userData;
474
475
476 /**
477  * 通知第三方界面需要被关闭
478  * \param tencentOAuth 返回回调的tencentOAuth对象
479  * \param viewController 需要关闭的viewController
480  */
481 - (void)tencentOAuth:(TencentOAuth *)tencentOAuth doCloseViewController:(UIViewController *)viewController;
482
483 @end
484
485 #pragma mark - TencentWebViewDelegate(H5登录webview旋转方向回调)
486
487 /**
488  * \brief TencentWebViewDelegate: H5登录webview旋转方向回调协议
489  *
490  * 第三方应用可以根据自己APP的旋转方向限制,通过此协议设置
491  */
492 @protocol TencentWebViewDelegate <NSObject>
493 @optional
494 - (BOOL) tencentWebViewShouldAutorotateToInterfaceOrientation:(UIInterfaceOrientation)toInterfaceOrientation;
495 - (NSUInteger) tencentWebViewSupportedInterfaceOrientationsWithWebkit;
496 - (BOOL) tencentWebViewShouldAutorotateWithWebkit;
497 @end