FBSDKShareMessengerMediaTemplateContent.h 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. // Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
  2. //
  3. // You are hereby granted a non-exclusive, worldwide, royalty-free license to use,
  4. // copy, modify, and distribute this software in source code or binary form for use
  5. // in connection with the web services and APIs provided by Facebook.
  6. //
  7. // As with any software that integrates with the Facebook platform, your use of
  8. // this software is subject to the Facebook Developer Principles and Policies
  9. // [http://developers.facebook.com/policy/]. This copyright notice shall be
  10. // included in all copies or substantial portions of the software.
  11. //
  12. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  13. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  14. // FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  15. // COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  16. // IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  17. // CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  18. #import <Foundation/Foundation.h>
  19. #import <FBSDKShareKit/FBSDKShareMessengerActionButton.h>
  20. #import <FBSDKShareKit/FBSDKSharingContent.h>
  21. typedef NS_ENUM(NSUInteger, FBSDKShareMessengerMediaTemplateMediaType) {
  22. FBSDKShareMessengerMediaTemplateMediaTypeImage = 0,
  23. FBSDKShareMessengerMediaTemplateMediaTypeVideo
  24. };
  25. /**
  26. A model for sharing media template content. See
  27. https://developers.facebook.com/docs/messenger-platform/send-messages/template/media for details.
  28. */
  29. @interface FBSDKShareMessengerMediaTemplateContent : NSObject <FBSDKSharingContent>
  30. /**
  31. The media type (image or video) for this content. This must match the media type specified in the
  32. attachmentID/mediaURL to avoid an error when sharing. Defaults to image.
  33. */
  34. @property (nonatomic, assign) FBSDKShareMessengerMediaTemplateMediaType mediaType;
  35. /**
  36. The attachmentID of the item to share. Optional, but either attachmentID or mediaURL must be specified.
  37. */
  38. @property (nonatomic, copy, readonly) NSString *attachmentID;
  39. /**
  40. The Facebook url for this piece of media. External urls will not work; this must be a Facebook url.
  41. See https://developers.facebook.com/docs/messenger-platform/send-messages/template/media for details.
  42. Optional, but either attachmentID or mediaURL must be specified.
  43. */
  44. @property (nonatomic, copy, readonly) NSURL *mediaURL;
  45. /**
  46. This specifies what action button to show below the media. Optional.
  47. */
  48. @property (nonatomic, copy) id<FBSDKShareMessengerActionButton> button;
  49. /**
  50. Custom initializer to create media template share with attachment id.
  51. */
  52. - (instancetype)initWithAttachmentID:(NSString *)attachmentID;
  53. /**
  54. Custom initializer to create media template share with media url. This must be a Facebook url
  55. and cannot be an external url.
  56. */
  57. - (instancetype)initWithMediaURL:(NSURL *)mediaURL;
  58. @end