FBSDKShareMessengerGenericTemplateContent.h 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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/FBSDKSharingContent.h>
  20. @class FBSDKShareMessengerGenericTemplateElement;
  21. typedef NS_ENUM(NSUInteger, FBSDKShareMessengerGenericTemplateImageAspectRatio) {
  22. FBSDKShareMessengerGenericTemplateImageAspectRatioHorizontal = 0,
  23. FBSDKShareMessengerGenericTemplateImageAspectRatioSquare
  24. };
  25. /**
  26. A model for sharing a generic template element to Messenger. This wrapper element allows
  27. specifying whether or not the bubble is sharable and what aspect to render the images.
  28. See https://developers.facebook.com/docs/messenger-platform/send-messages/template/generic
  29. for more details.
  30. */
  31. @interface FBSDKShareMessengerGenericTemplateContent : NSObject <FBSDKSharingContent>
  32. /**
  33. This specifies whether or not this generic template message can be shared again after the
  34. initial share. Defaults to false.
  35. */
  36. @property (nonatomic, assign) BOOL isSharable;
  37. /**
  38. The aspect ratio for when the image is rendered in the generic template bubble after being
  39. shared. Defaults to horizontal.
  40. */
  41. @property (nonatomic, assign) FBSDKShareMessengerGenericTemplateImageAspectRatio imageAspectRatio;
  42. /**
  43. A generic template element with a title, optional subtitle, optional image, etc. Required.
  44. */
  45. @property (nonatomic, copy) FBSDKShareMessengerGenericTemplateElement *element;
  46. @end