UMSocialMessageObject.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  1. //
  2. // UMSocialMessageObject.h
  3. // SocialSDK
  4. //
  5. // Created by umeng on 16/4/22.
  6. // Copyright © 2016年 dongjianxiong. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. #import <UIKit/UIKit.h>
  10. @interface UMSocialMessageObject : NSObject
  11. /**
  12. * 文本标题
  13. * @disucss v6.0.3版本后增加的一个字段,
  14. * @disucss 该字段目前只有Tumblr平台会使用到。
  15. * @discuss 该字段以后会在需要文本title字段中扩展,具体请参看官方文档。
  16. */
  17. @property (nonatomic,copy)NSString* title;
  18. /**
  19. * text 文本内容
  20. * @note 非纯文本分享文本
  21. */
  22. @property (nonatomic, copy) NSString *text;
  23. /**
  24. * 分享的所媒体内容对象
  25. */
  26. @property (nonatomic, strong) id shareObject;
  27. /**
  28. * 其他相关参数,见相应平台说明
  29. */
  30. @property (nonatomic, strong) NSDictionary *moreInfo;
  31. + (UMSocialMessageObject *)messageObject;
  32. + (UMSocialMessageObject *)messageObjectWithMediaObject:(id)mediaObject;
  33. @end
  34. @interface UMShareObject : NSObject
  35. /**
  36. * 标题
  37. * @note 标题的长度依各个平台的要求而定
  38. */
  39. @property (nonatomic, copy) NSString *title;
  40. /**
  41. * 描述
  42. * @note 描述内容的长度依各个平台的要求而定
  43. */
  44. @property (nonatomic, copy) NSString *descr;
  45. /**
  46. * 缩略图 UIImage或者NSData类型或者NSString类型(图片url)
  47. */
  48. @property (nonatomic, strong) id thumbImage;
  49. /**
  50. * @param title 标题
  51. * @param descr 描述
  52. * @param thumImage 缩略图(UIImage或者NSData类型,或者image_url)
  53. *
  54. */
  55. + (id)shareObjectWithTitle:(NSString *)title
  56. descr:(NSString *)descr
  57. thumImage:(id)thumImage;
  58. + (void)um_imageDataWithImage:(id)image completion:(void (^)(NSData *image))completion;
  59. #pragma mark - 6.0.3新版本的函数
  60. + (void)um_imageDataWithImage:(id)image withCompletion:(void (^)(NSData *imageData,NSError* error))completion;
  61. @end
  62. @interface UMShareImageObject : UMShareObject
  63. /** 分享单个图片(支持UIImage,NSdata以及图片链接Url NSString类对象集合)
  64. * @note 图片大小根据各个平台限制而定
  65. */
  66. @property (nonatomic, retain) id shareImage;
  67. /** 分享图片数组,支持 UIImage、NSData 类型
  68. * @note 仅支持分享到:
  69. * 微博平台,最多可分享9张图片
  70. * QZone平台,最多可分享20张图片
  71. */
  72. @property (nonatomic, copy) NSArray *shareImageArray;
  73. /**
  74. * @param title 标题
  75. * @param descr 描述
  76. * @param thumImage 缩略图(UIImage或者NSData类型,或者image_url)
  77. *
  78. */
  79. + (UMShareImageObject *)shareObjectWithTitle:(NSString *)title
  80. descr:(NSString *)descr
  81. thumImage:(id)thumImage;
  82. @end
  83. @interface UMShareMusicObject : UMShareObject
  84. /** 音乐网页的url地址
  85. * @note 长度不能超过10K
  86. */
  87. @property (nonatomic, retain) NSString *musicUrl;
  88. /** 音乐lowband网页的url地址
  89. * @note 长度不能超过10K
  90. */
  91. @property (nonatomic, retain) NSString *musicLowBandUrl;
  92. /** 音乐数据url地址
  93. * @note 长度不能超过10K
  94. */
  95. @property (nonatomic, retain) NSString *musicDataUrl;
  96. /**音乐lowband数据url地址
  97. * @note 长度不能超过10K
  98. */
  99. @property (nonatomic, retain) NSString *musicLowBandDataUrl;
  100. /**
  101. * @param title 标题
  102. * @param descr 描述
  103. * @param thumImage 缩略图(UIImage或者NSData类型,或者image_url)
  104. *
  105. */
  106. + (UMShareMusicObject *)shareObjectWithTitle:(NSString *)title
  107. descr:(NSString *)descr
  108. thumImage:(id)thumImage;
  109. @end
  110. @interface UMShareVideoObject : UMShareObject
  111. /**
  112. 视频网页的url
  113. @warning 不能为空且长度不能超过255
  114. */
  115. @property (nonatomic, strong) NSString *videoUrl;
  116. /**
  117. 视频lowband网页的url
  118. @warning 长度不能超过255
  119. */
  120. @property (nonatomic, strong) NSString *videoLowBandUrl;
  121. /**
  122. 视频数据流url
  123. @warning 长度不能超过255
  124. */
  125. @property (nonatomic, strong) NSString *videoStreamUrl;
  126. /**
  127. 视频lowband数据流url
  128. @warning 长度不能超过255
  129. */
  130. @property (nonatomic, strong) NSString *videoLowBandStreamUrl;
  131. /**
  132. * @param title 标题
  133. * @param descr 描述
  134. * @param thumImage 缩略图(UIImage或者NSData类型,或者image_url)
  135. *
  136. */
  137. + (UMShareVideoObject *)shareObjectWithTitle:(NSString *)title
  138. descr:(NSString *)descr
  139. thumImage:(id)thumImage;
  140. @end
  141. @interface UMShareWebpageObject : UMShareObject
  142. /** 网页的url地址
  143. * @note 不能为空且长度不能超过10K
  144. */
  145. @property (nonatomic, retain) NSString *webpageUrl;
  146. /**
  147. * @param title 标题
  148. * @param descr 描述
  149. * @param thumImage 缩略图(UIImage或者NSData类型,或者image_url)
  150. *
  151. */
  152. + (UMShareWebpageObject *)shareObjectWithTitle:(NSString *)title
  153. descr:(NSString *)descr
  154. thumImage:(id)thumImage;
  155. @end
  156. /*! @brief 分享消息中的邮件分享对象
  157. *
  158. * @see UMSocialMessageObject
  159. */
  160. @interface UMShareEmailObject : UMShareObject
  161. /**
  162. * 主题
  163. */
  164. @property (nonatomic, strong) NSString *subject;
  165. /**
  166. * 接收人
  167. */
  168. @property (nonatomic, strong) NSArray *toRecipients;
  169. /**
  170. * 抄送人
  171. */
  172. @property (nonatomic, strong) NSArray *ccRecipients;
  173. /**
  174. * 密送人
  175. */
  176. @property (nonatomic, strong) NSArray *bccRecipients;
  177. /**
  178. * 文本内容
  179. */
  180. @property (nonatomic, copy) NSString *emailContent;
  181. /**
  182. * 图片,最好是本地图片(UIImage,或者NSdata)
  183. */
  184. @property (nonatomic, strong) id emailImage;
  185. /**
  186. * 发送图片的类型 @see MIME
  187. * 默认 "image/ *"
  188. */
  189. @property (nonatomic, copy) NSString* emailImageType;
  190. /**
  191. * 发送图片的名字
  192. * 默认 "um_share_image.png"
  193. */
  194. @property (nonatomic, copy) NSString* emailImageName;
  195. /**
  196. * 文件(NSData)
  197. */
  198. @property (nonatomic, strong) NSData *emailSendData;
  199. /**
  200. * 文件格式
  201. * @see MIME
  202. * 默认 "text/ *"
  203. */
  204. @property (nonatomic, copy) NSString *fileType;
  205. /**
  206. * 文件名,(例如图片 imageName.png, 文件名后要跟文件后缀名,否则没法识别,导致类似图片不显示的问题)
  207. * 默认 "um_share_file.txt"
  208. */
  209. @property (nonatomic, copy) NSString *fileName;
  210. @end
  211. /*! @brief 分享消息中的短信分享对象
  212. *
  213. * @see UMSocialMessageObject
  214. * @discuss UMShareSmsObject只能发送的附件是图片!!!!
  215. * 如果发送其他的文件的话,虽然能在短信界面显示发送的文件,但是会发送不成功
  216. */
  217. @interface UMShareSmsObject : UMShareObject
  218. /**
  219. * 接收人
  220. */
  221. @property (nonatomic, strong) NSArray *recipients;
  222. /**
  223. * 主题
  224. */
  225. @property (nonatomic, strong) NSString *subject;
  226. /**
  227. * 文本内容
  228. */
  229. @property (nonatomic, copy) NSString *smsContent;
  230. /**
  231. * 图片
  232. */
  233. @property (nonatomic, strong) id smsImage;//UIImage对象必填
  234. @property (nonatomic, copy) NSString *imageType;//图片格式必填,必须指定数据格式,如png图片格式应传入@"png"
  235. @property (nonatomic, copy) NSString *imageName;//图片 例如 imageName.png, 文件名后要跟文件后缀名,否则没法识别,导致类似图片不显示的问题)
  236. #pragma mark - 以下字段为非图片的属性
  237. /**
  238. * 文件数据(NSData)
  239. * 必填
  240. */
  241. @property (nonatomic, strong) NSData *smsSendData;
  242. /**
  243. * 文件格式
  244. * 必填,必须指定数据格式,如png图片格式应传入@"txt"
  245. */
  246. @property (nonatomic, copy) NSString *fileType;
  247. /**
  248. * 文件名,(例如图片 fileName.txt, 文件名后要跟文件后缀名,否则没法识别,导致类似图片不显示的问题)
  249. */
  250. @property (nonatomic, copy) NSString *fileName;
  251. /**
  252. * 文件地址url(http:// or file:// ...../fileName.txt)
  253. */
  254. @property (nonatomic, copy) NSString *fileUrl;
  255. @end
  256. /**
  257. * 表情的类
  258. * 表请的缩略图数据请存放在UMShareEmotionObject中
  259. * 注意:emotionData和emotionURL成员不能同时为空,若同时出现则取emotionURL
  260. */
  261. @interface UMShareEmotionObject : UMShareObject
  262. /**
  263. * 表情数据,如GIF等
  264. * @note 微信的话大小不能超过10M
  265. */
  266. @property (nonatomic, strong) NSData *emotionData;
  267. /**
  268. * @param title 标题
  269. * @param descr 描述
  270. * @param thumImage 缩略图(UIImage或者NSData类型,或者image_url)
  271. *
  272. */
  273. + (UMShareEmotionObject *)shareObjectWithTitle:(NSString *)title
  274. descr:(NSString *)descr
  275. thumImage:(id)thumImage;
  276. @end
  277. #pragma mark - UMSAppExtendObject
  278. /*! @brief 多媒体消息中包含的App扩展数据对象
  279. *
  280. * 第三方程序向微信终端发送包含UMShareExtendObject的多媒体消息,
  281. * 微信需要处理该消息时,会调用该第三方程序来处理多媒体消息内容。
  282. * @note url,extInfo和fileData不能同时为空
  283. * @see UMShareObject
  284. */
  285. @interface UMShareExtendObject : UMShareObject
  286. /** 若第三方程序不存在,微信终端会打开该url所指的App下载地址
  287. * @note 长度不能超过10K
  288. */
  289. @property (nonatomic, retain) NSString *url;
  290. /** 第三方程序自定义简单数据,微信终端会回传给第三方程序处理
  291. * @note 长度不能超过2K
  292. */
  293. @property (nonatomic, retain) NSString *extInfo;
  294. /** App文件数据,该数据发送给微信好友,微信好友需要点击后下载数据,微信终端会回传给第三方程序处理
  295. * @note 大小不能超过10M
  296. */
  297. @property (nonatomic, retain) NSData *fileData;
  298. @end
  299. #pragma mark - UMFileObject
  300. /*! @brief 多媒体消息中包含的文件数据对象
  301. *
  302. * @see UMShareObject
  303. */
  304. @interface UMShareFileObject : UMShareObject
  305. /** 文件后缀名
  306. * @note 长度不超过64字节
  307. */
  308. @property (nonatomic, retain) NSString *fileExtension;
  309. /** 文件真实数据内容
  310. * @note 大小不能超过10M
  311. */
  312. @property (nonatomic, retain) NSData *fileData;
  313. @end
  314. #pragma mark - UMMiniProgramObject
  315. typedef NS_ENUM(NSUInteger, UShareWXMiniProgramType){
  316. UShareWXMiniProgramTypeRelease = 0, //**< 正式版 */
  317. UShareWXMiniProgramTypeTest = 1, //**< 开发版 */
  318. UShareWXMiniProgramTypePreview = 2, //**< 体验版 */
  319. };
  320. /*! @brief 多媒体消息中包含 分享微信小程序的数据对象
  321. *
  322. * @see UMShareObject
  323. */
  324. @interface UMShareMiniProgramObject : UMShareObject
  325. /**
  326. 低版本微信网页链接
  327. */
  328. @property (nonatomic, strong) NSString *webpageUrl;
  329. /**
  330. 小程序username
  331. */
  332. @property (nonatomic, strong) NSString *userName;
  333. /**
  334. 小程序页面的路径
  335. */
  336. @property (nonatomic, strong) NSString *path;
  337. /**
  338. 小程序新版本的预览图 128k
  339. */
  340. @property (nonatomic, strong) NSData *hdImageData;
  341. /**
  342. 分享小程序的版本(正式,开发,体验)
  343. 正式版 尾巴正常显示
  344. 开发版 尾巴显示“未发布的小程序·开发版”
  345. 体验版 尾巴显示“未发布的小程序·体验版”
  346. */
  347. @property (nonatomic, assign) UShareWXMiniProgramType miniProgramType;
  348. /**
  349. 是否使用带 shareTicket 的转发
  350. */
  351. @property (nonatomic, assign) BOOL withShareTicket;
  352. @end