FBSDKShareOpenGraphAction.h 3.0 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 <FBSDKCoreKit/FBSDKCopying.h>
  20. #import <FBSDKShareKit/FBSDKShareOpenGraphObject.h>
  21. #import <FBSDKShareKit/FBSDKShareOpenGraphValueContainer.h>
  22. /*!
  23. @abstract An Open Graph Action for sharing.
  24. @discussion The property keys MUST have namespaces specified on them, such as `og:image`.
  25. */
  26. @interface FBSDKShareOpenGraphAction : FBSDKShareOpenGraphValueContainer <FBSDKCopying, NSSecureCoding>
  27. /*!
  28. @abstract Convenience method to build a new action and set the object for the specified key.
  29. @param actionType The action type of the receiver
  30. @param object The Open Graph object represented by this action
  31. @param key The key for the object
  32. */
  33. + (instancetype)actionWithType:(NSString *)actionType object:(FBSDKShareOpenGraphObject *)object key:(NSString *)key;
  34. /*!
  35. @abstract Convenience method to build a new action and set the object for the specified key.
  36. @param actionType The action type of the receiver
  37. @param objectID The ID of an existing Open Graph object
  38. @param key The key for the object
  39. */
  40. + (instancetype)actionWithType:(NSString *)actionType objectID:(NSString *)objectID key:(NSString *)key;
  41. /*!
  42. @abstract Convenience method to build a new action and set the object for the specified key.
  43. @param actionType The action type of the receiver
  44. @param objectURL The URL to a page that defines the Open Graph object with meta tags
  45. @param key The key for the object
  46. */
  47. + (instancetype)actionWithType:(NSString *)actionType objectURL:(NSURL *)objectURL key:(NSString *)key;
  48. /*!
  49. @abstract Gets the action type.
  50. @return The action type
  51. */
  52. @property (nonatomic, copy) NSString *actionType;
  53. /*!
  54. @abstract Compares the receiver to another Open Graph Action.
  55. @param action The other action
  56. @return YES if the receiver's values are equal to the other action's values; otherwise NO
  57. */
  58. - (BOOL)isEqualToShareOpenGraphAction:(FBSDKShareOpenGraphAction *)action;
  59. @end