No Description

WXApi.h 6.8KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. //
  2. // WXApi.h
  3. // 所有Api接口
  4. //
  5. // Created by Wechat on 12-2-28.
  6. // Copyright (c) 2012年 Tencent. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. #import "WXApiObject.h"
  10. #pragma mark - WXApiDelegate
  11. /*! @brief 接收并处理来自微信终端程序的事件消息
  12. *
  13. * 接收并处理来自微信终端程序的事件消息,期间微信界面会切换到第三方应用程序。
  14. * WXApiDelegate 会在handleOpenURL:delegate:中使用并触发。
  15. */
  16. @protocol WXApiDelegate <NSObject>
  17. @optional
  18. /*! @brief 收到一个来自微信的请求,第三方应用程序处理完后调用sendResp向微信发送结果
  19. *
  20. * 收到一个来自微信的请求,异步处理完成后必须调用sendResp发送处理结果给微信。
  21. * 可能收到的请求有GetMessageFromWXReq、ShowMessageFromWXReq等。
  22. * @param req 具体请求内容,是自动释放的
  23. */
  24. -(void) onReq:(BaseReq*)req;
  25. /*! @brief 发送一个sendReq后,收到微信的回应
  26. *
  27. * 收到一个来自微信的处理结果。调用一次sendReq后会收到onResp。
  28. * 可能收到的处理结果有SendMessageToWXResp、SendAuthResp等。
  29. * @param resp具体的回应内容,是自动释放的
  30. */
  31. -(void) onResp:(BaseResp*)resp;
  32. @end
  33. #pragma mark - WXApiLogDelegate
  34. @protocol WXApiLogDelegate <NSObject>
  35. -(void) onLog:(NSString*)log logLevel:(WXLogLevel)level;
  36. @end
  37. #pragma mark - WXApi
  38. /*! @brief 微信Api接口函数类
  39. *
  40. * 该类封装了微信终端SDK的所有接口
  41. */
  42. @interface WXApi : NSObject
  43. /*! @brief WXApi的成员函数,向微信终端程序注册第三方应用。
  44. *
  45. * 需要在每次启动第三方应用程序时调用。第一次调用后,会在微信的可用应用列表中出现,默认开启MTA数据上报。
  46. * iOS7及以上系统需要调起一次微信才会出现在微信的可用应用列表中。
  47. * @attention 请保证在主线程中调用此函数
  48. * @param appid 微信开发者ID
  49. * @param typeFlag 应用支持打开的文件类型
  50. * @return 成功返回YES,失败返回NO。
  51. */
  52. +(BOOL) registerApp:(NSString *)appid;
  53. /*! @brief WXApi的成员函数,向微信终端程序注册第三方应用。
  54. *
  55. * 需要在每次启动第三方应用程序时调用。第一次调用后,会在微信的可用应用列表中出现。
  56. * iOS7及以上系统需要调起一次微信才会出现在微信的可用应用列表中。
  57. * @attention 请保证在主线程中调用此函数
  58. * @param appid 微信开发者ID
  59. * @param isEnableMTA 是否支持MTA数据上报
  60. * @return 成功返回YES,失败返回NO。
  61. */
  62. +(BOOL) registerApp:(NSString *)appid enableMTA:(BOOL)isEnableMTA;
  63. /*! @brief WXApi的成员函数,向微信终端程序注册应用支持打开的文件类型。
  64. *
  65. * 需要在每次启动第三方应用程序时调用。调用后并第一次成功分享数据到微信后,会在微信的可用应用列表中出现。
  66. * @see registerApp
  67. * @param typeFlag 应用支持打开的数据类型, enAppSupportContentFlag枚举类型 “|” 操作后结果
  68. */
  69. +(void) registerAppSupportContentFlag:(UInt64)typeFlag;
  70. /*! @brief 处理微信通过URL启动App时传递的数据
  71. *
  72. * 需要在 application:openURL:sourceApplication:annotation:或者application:handleOpenURL中调用。
  73. * @param url 微信启动第三方应用时传递过来的URL
  74. * @param delegate WXApiDelegate对象,用来接收微信触发的消息。
  75. * @return 成功返回YES,失败返回NO。
  76. */
  77. +(BOOL) handleOpenURL:(NSURL *) url delegate:(id<WXApiDelegate>) delegate;
  78. /*! @brief 检查微信是否已被用户安装
  79. *
  80. * @return 微信已安装返回YES,未安装返回NO。
  81. */
  82. +(BOOL) isWXAppInstalled;
  83. /*! @brief 判断当前微信的版本是否支持OpenApi
  84. *
  85. * @return 支持返回YES,不支持返回NO。
  86. */
  87. +(BOOL) isWXAppSupportApi;
  88. /*! @brief 获取微信的itunes安装地址
  89. *
  90. * @return 微信的安装地址字符串。
  91. */
  92. +(NSString *) getWXAppInstallUrl;
  93. /*! @brief 获取当前微信SDK的版本号
  94. *
  95. * @return 返回当前微信SDK的版本号
  96. */
  97. +(NSString *) getApiVersion;
  98. /*! @brief 打开微信
  99. *
  100. * @return 成功返回YES,失败返回NO。
  101. */
  102. +(BOOL) openWXApp;
  103. /*! @brief 发送请求到微信,等待微信返回onResp
  104. *
  105. * 函数调用后,会切换到微信的界面。第三方应用程序等待微信返回onResp。微信在异步处理完成后一定会调用onResp。支持以下类型
  106. * SendAuthReq、SendMessageToWXReq、PayReq等。
  107. * @param req 具体的发送请求,在调用函数后,请自己释放。
  108. * @return 成功返回YES,失败返回NO。
  109. */
  110. +(BOOL) sendReq:(BaseReq*)req;
  111. /*! @brief 发送Auth请求到微信,支持用户没安装微信,等待微信返回onResp
  112. *
  113. * 函数调用后,会切换到微信的界面。第三方应用程序等待微信返回onResp。微信在异步处理完成后一定会调用onResp。支持SendAuthReq类型。
  114. * @param req 具体的发送请求,在调用函数后,请自己释放。
  115. * @param viewController 当前界面对象。
  116. * @param delegate WXApiDelegate对象,用来接收微信触发的消息。
  117. * @return 成功返回YES,失败返回NO。
  118. */
  119. +(BOOL) sendAuthReq:(SendAuthReq*)req viewController:(UIViewController*)viewController delegate:(id<WXApiDelegate>)delegate;
  120. /*! @brief 收到微信onReq的请求,发送对应的应答给微信,并切换到微信界面
  121. *
  122. * 函数调用后,会切换到微信的界面。第三方应用程序收到微信onReq的请求,异步处理该请求,完成后必须调用该函数。可能发送的相应有
  123. * GetMessageFromWXResp、ShowMessageFromWXResp等。
  124. * @param resp 具体的应答内容,调用函数后,请自己释放
  125. * @return 成功返回YES,失败返回NO。
  126. */
  127. +(BOOL) sendResp:(BaseResp*)resp;
  128. /*! @brief WXApi的成员函数,接受微信的log信息。byBlock
  129. 注意1:SDK会强引用这个block,注意不要导致内存泄漏,注意不要导致内存泄漏
  130. 注意2:调用过一次startLog by block之后,如果再调用一次任意方式的startLoad,会释放上一次logBlock,不再回调上一个logBlock
  131. *
  132. * @param level 打印log的级别
  133. * @param logBlock 打印log的回调block
  134. */
  135. +(void) startLogByLevel:(WXLogLevel)level logBlock:(WXLogBolock)logBlock;
  136. /*! @brief WXApi的成员函数,接受微信的log信息。byDelegate
  137. 注意1:sdk会弱引用这个delegate,这里可加任意对象为代理,不需要与WXApiDelegate同一个对象
  138. 注意2:调用过一次startLog by delegate之后,再调用一次任意方式的startLoad,不会再回调上一个logDelegate对象
  139. * @param level 打印log的级别
  140. * @param logDelegate 打印log的回调代理,
  141. */
  142. + (void)startLogByLevel:(WXLogLevel)level logDelegate:(id<WXApiLogDelegate>)logDelegate;
  143. /*! @brief 停止打印log,会清理block或者delegate为空,释放block
  144. * @param
  145. */
  146. + (void)stopLog;
  147. @end