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