UMSocialManager.h 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. //
  2. // UMComPlatformProviderManager.h
  3. // UMSocialSDK
  4. //
  5. // Created by 张军华 on 16/8/5.
  6. // Copyright © 2016年 dongjianxiong. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. #import "UMSocialPlatformProvider.h"
  10. #import "UMSocialGlobal.h"
  11. @class UMSocialMessageObject;
  12. @interface UMSocialManager : NSObject
  13. +(instancetype)defaultManager;
  14. /**
  15. 友盟appkey
  16. */
  17. @property(nonatomic,strong)NSString* umSocialAppkey;
  18. @property(nonatomic,strong)NSString* umSocialAppSecret;
  19. /**
  20. 返回当前有效(安装并是可用的)平台列表
  21. */
  22. @property(nonatomic,readonly,strong) NSArray * platformTypeArray;
  23. /**
  24. * 打开日志
  25. *
  26. * @param isOpen YES代表打开,No代表关闭
  27. */
  28. -(void) openLog:(BOOL)isOpen;
  29. /**
  30. * 设置平台的appkey
  31. *
  32. * @param platformType 平台类型 @see UMSocialPlatformType
  33. * @param appKey 第三方平台的appKey(QQ平台为appID)
  34. * @param appSecret 第三方平台的appSecret(QQ平台为appKey)
  35. * @param redirectURL redirectURL
  36. */
  37. - (BOOL)setPlaform:(UMSocialPlatformType)platformType
  38. appKey:(NSString *)appKey
  39. appSecret:(NSString *)appSecret
  40. redirectURL:(NSString *)redirectURL;
  41. /**
  42. * 设置分享平台
  43. *
  44. * @param platformType 平台类型 @see UMSocialPlatformType
  45. * @param messageObject 分享的content @see UMSocialMessageObject
  46. * @param currentViewController 用于弹出类似邮件分享、短信分享等这样的系统页面
  47. * @param completion 回调
  48. * @discuss currentViewController 只正对sms,email等平台需要传入viewcontroller的平台,其他不需要的平台可以传入nil
  49. */
  50. - (void)shareToPlatform:(UMSocialPlatformType)platformType
  51. messageObject:(UMSocialMessageObject *)messageObject
  52. currentViewController:(id)currentViewController
  53. completion:(UMSocialRequestCompletionHandler)completion;
  54. /**
  55. * 取消授权
  56. *
  57. * @param platformType 平台类型 @see UMSocialPlatformType
  58. * @param completion 回调
  59. */
  60. - (void)cancelAuthWithPlatform:(UMSocialPlatformType)platformType
  61. completion:(UMSocialRequestCompletionHandler)completion;
  62. /**
  63. * 授权并获取用户信息
  64. * @param platformType 平台类型 @see UMSocialPlatformType
  65. * @param currentViewController 用于弹出类似邮件分享、短信分享等这样的系统页面
  66. * @param completion 回调
  67. */
  68. - (void)getUserInfoWithPlatform:(UMSocialPlatformType)platformType
  69. currentViewController:(id)currentViewController
  70. completion:(UMSocialRequestCompletionHandler)completion;
  71. /**
  72. * 获得从sso或者web端回调到本app的回调
  73. *
  74. * @param url 第三方sdk的打开本app的回调的url
  75. *
  76. * @return 是否处理 YES代表处理成功,NO代表不处理
  77. */
  78. -(BOOL)handleOpenURL:(NSURL *)url;
  79. /**
  80. * 获得从sso或者web端回调到本app的回调
  81. *
  82. * @param url 第三方sdk的打开本app的回调的url
  83. * @param sourceApplication 回调的源程序
  84. * @param annotation annotation
  85. *
  86. * @return 是否处理 YES代表处理成功,NO代表不处理
  87. *
  88. * @note 此函数在6.3版本加入
  89. */
  90. -(BOOL)handleOpenURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation;
  91. /**
  92. * 获得从sso或者web端回调到本app的回调
  93. *
  94. * @param url 第三方sdk的打开本app的回调的url
  95. * @param options 回调的参数
  96. *
  97. * @return 是否处理 YES代表处理成功,NO代表不处理
  98. *
  99. * @note 此函数在6.3版本加入
  100. */
  101. -(BOOL)handleOpenURL:(NSURL *)url options:(NSDictionary*)options;
  102. /**
  103. * 动态的增加用户自定义的PlatformProvider
  104. *
  105. * @param userDefinePlatformProvider 用户自定义的userDefinePlatformProvider必须实现UMSocialPlatformProvider
  106. * @param platformType 平台类型 @see platformType platformType的有效范围在 (UMSocialPlatformType_UserDefine_Begin,UMSocialPlatformType_UserDefine_End)之间
  107. *
  108. * @return YES代表返回成功,NO代表失败
  109. * @disuss 在调用此函数前,必须先设置对应的平台的配置信息 @see - (BOOL)setPlaform:(UMSocialPlatformType)platformType appKey:(NSString *)appKey appSecret:(NSString *)appSecret redirectURL:(NSString *)redirectURL;
  110. */
  111. -(BOOL)addAddUserDefinePlatformProvider:(id<UMSocialPlatformProvider>)userDefinePlatformProvider
  112. withUserDefinePlatformType:(UMSocialPlatformType)platformType;
  113. /**
  114. * 获得对应的平台类型platformType的PlatformProvider
  115. *
  116. * @param platformType 平台类型 @see platformType
  117. *
  118. * @return 返回继承UMSocialPlatformProvider的handle
  119. */
  120. -(id<UMSocialPlatformProvider>)platformProviderWithPlatformType:(UMSocialPlatformType)platformType;
  121. /**
  122. * 动态的删除不想显示的平台,不管是预定义还是用户自定义的
  123. *
  124. * @param platformTypeArray 平台类型数组
  125. */
  126. -(void) removePlatformProviderWithPlatformTypes:(NSArray *)platformTypeArray;
  127. /**
  128. * 动态的删除PlatformProvider,不管是预定义还是用户自定义的
  129. *
  130. * @param platformType 平台类型 @see UMSocialPlatformType
  131. */
  132. -(void) removePlatformProviderWithPlatformType:(UMSocialPlatformType)platformType;
  133. /**
  134. * 平台是否安装
  135. *
  136. * @param platformType 平台类型 @see UMSocialPlatformType
  137. *
  138. * @return YES 代表安装,NO 代表未安装
  139. * @note 调用前请检查是否配置好平台相关白名单: http://dev.umeng.com/social/ios/quick-integration#1_3
  140. * 在判断QQ空间的App的时候,QQApi判断会出问题
  141. */
  142. -(BOOL) isInstall:(UMSocialPlatformType)platformType;
  143. /**
  144. * 当前平台是否支持分享
  145. *
  146. * @param platformType 平台类型 @see UMSocialPlatformType
  147. *
  148. * @return YES代表支持,NO代表不支持
  149. */
  150. -(BOOL) isSupport:(UMSocialPlatformType)platformType;
  151. #pragma mark - NOT COMMON METHOD
  152. /**
  153. * 授权平台 (此方法仅获取授权token,不包含获取用户信息。推荐使用上面的 getUserInfoWithPlatform... 接口获取授权及用户信息)
  154. *
  155. * @param platformType 平台类型 @see UMSocialPlatformType
  156. * @param currentViewController 用于弹出类似邮件分享、短信分享等这样的系统页面
  157. * @discuss currentViewController 只对sms,email等平台需要传入viewcontroller的平台,其他不需要的平台可以传入nil
  158. * @param completion 回调
  159. */
  160. - (void)authWithPlatform:(UMSocialPlatformType)platformType
  161. currentViewController:(UIViewController *)currentViewController
  162. completion:(UMSocialRequestCompletionHandler)completion;
  163. @end