QNUploadManager.h 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. //
  2. // QNUploader.h
  3. // QiniuSDK
  4. //
  5. // Created by bailong on 14-9-28.
  6. // Copyright (c) 2014年 Qiniu. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. #import "QNRecorderDelegate.h"
  10. @class QNResponseInfo;
  11. @class QNUploadOption;
  12. @class QNConfiguration;
  13. @class PHAsset;
  14. @class PHAssetResource;
  15. #if !TARGET_OS_MACCATALYST
  16. @class ALAsset;
  17. #endif
  18. /**
  19. * 上传完成后的回调函数
  20. *
  21. * @param info 上下文信息,包括状态码,错误值
  22. * @param key 上传时指定的key,原样返回
  23. * @param resp 上传成功会返回文件信息,失败为nil; 可以通过此值是否为nil 判断上传结果
  24. */
  25. typedef void (^QNUpCompletionHandler)(QNResponseInfo *info, NSString *key, NSDictionary *resp);
  26. /**
  27. 管理上传的类,可以生成一次,持续使用,不必反复创建。
  28. */
  29. @interface QNUploadManager : NSObject
  30. /**
  31. * 默认构造方法,没有持久化记录
  32. *
  33. * @return 上传管理类实例
  34. */
  35. - (instancetype)init;
  36. /**
  37. * 使用一个持久化的记录接口进行记录的构造方法
  38. *
  39. * @param recorder 持久化记录接口实现
  40. *
  41. * @return 上传管理类实例
  42. */
  43. - (instancetype)initWithRecorder:(id<QNRecorderDelegate>)recorder;
  44. /**
  45. * 使用持久化记录接口以及持久化key生成函数的构造方法,默认情况下使用上传存储的key, 如果key为nil或者有特殊字符比如/,建议使用自己的生成函数
  46. *
  47. * @param recorder 持久化记录接口实现
  48. * @param recorderKeyGenerator 持久化记录key生成函数
  49. *
  50. * @return 上传管理类实例
  51. */
  52. - (instancetype)initWithRecorder:(id<QNRecorderDelegate>)recorder
  53. recorderKeyGenerator:(QNRecorderKeyGenerator)recorderKeyGenerator;
  54. /**
  55. * 使用配置信息生成上传实例
  56. *
  57. * @param config 配置信息
  58. *
  59. * @return 上传管理类实例
  60. */
  61. - (instancetype)initWithConfiguration:(QNConfiguration *)config;
  62. /**
  63. * 方便使用的单例方法
  64. *
  65. * @param config 配置信息
  66. *
  67. * @return 上传管理类实例
  68. */
  69. + (instancetype)sharedInstanceWithConfiguration:(QNConfiguration *)config;
  70. /**
  71. * 直接上传数据
  72. *
  73. * @param data 待上传的数据
  74. * @param key 上传到云存储的key,为nil时表示是由七牛生成
  75. * @param token 上传需要的token, 由服务器生成
  76. * @param completionHandler 上传完成后的回调函数
  77. * @param option 上传时传入的可选参数
  78. */
  79. - (void)putData:(NSData *)data
  80. key:(NSString *)key
  81. token:(NSString *)token
  82. complete:(QNUpCompletionHandler)completionHandler
  83. option:(QNUploadOption *)option;
  84. /**
  85. * 上传文件
  86. *
  87. * @param filePath 文件路径
  88. * @param key 上传到云存储的key,为nil时表示是由七牛生成
  89. * @param token 上传需要的token, 由服务器生成
  90. * @param completionHandler 上传完成后的回调函数
  91. * @param option 上传时传入的可选参数
  92. */
  93. - (void)putFile:(NSString *)filePath
  94. key:(NSString *)key
  95. token:(NSString *)token
  96. complete:(QNUpCompletionHandler)completionHandler
  97. option:(QNUploadOption *)option;
  98. #if !TARGET_OS_MACCATALYST
  99. /**
  100. * 上传ALAsset文件
  101. *
  102. * @param asset ALAsset文件
  103. * @param key 上传到云存储的key,为nil时表示是由七牛生成
  104. * @param token 上传需要的token, 由服务器生成
  105. * @param completionHandler 上传完成后的回调函数
  106. * @param option 上传时传入的可选参数
  107. */
  108. - (void)putALAsset:(ALAsset *)asset
  109. key:(NSString *)key
  110. token:(NSString *)token
  111. complete:(QNUpCompletionHandler)completionHandler
  112. option:(QNUploadOption *)option API_UNAVAILABLE(macos, tvos);
  113. #endif
  114. /**
  115. * 上传PHAsset文件(IOS8 andLater)
  116. *
  117. * @param asset PHAsset文件
  118. * @param key 上传到云存储的key,为nil时表示是由七牛生成
  119. * @param token 上传需要的token, 由服务器生成
  120. * @param completionHandler 上传完成后的回调函数
  121. * @param option 上传时传入的可选参数
  122. */
  123. - (void)putPHAsset:(PHAsset *)asset
  124. key:(NSString *)key
  125. token:(NSString *)token
  126. complete:(QNUpCompletionHandler)completionHandler
  127. option:(QNUploadOption *)option API_AVAILABLE(ios(9.1)) API_UNAVAILABLE(macos, tvos);
  128. /**
  129. * 上传PHAssetResource文件(IOS9.1 andLater)
  130. *
  131. * @param assetResource PHAssetResource文件
  132. * @param key 上传到云存储的key,为nil时表示是由七牛生成
  133. * @param token 上传需要的token, 由服务器生成
  134. * @param completionHandler 上传完成后的回调函数
  135. * @param option 上传时传入的可选参数
  136. */
  137. - (void)putPHAssetResource:(PHAssetResource *)assetResource
  138. key:(NSString *)key
  139. token:(NSString *)token
  140. complete:(QNUpCompletionHandler)completionHandler
  141. option:(QNUploadOption *)option API_AVAILABLE(ios(9)) API_UNAVAILABLE(macos, tvos);
  142. @end