| commit | author | age | ||
| bad748 | 1 | // Copyright (c) 2014-present, Facebook, Inc. All rights reserved. |
| W | 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 | ||
| 19 | #import <Foundation/Foundation.h> | |
| 20 | ||
| 21 | #import <FBSDKCoreKit/FBSDKCopying.h> | |
| 22 | ||
| 23 | #import <FBSDKShareKit/FBSDKShareOpenGraphObject.h> | |
| 24 | #import <FBSDKShareKit/FBSDKShareOpenGraphValueContainer.h> | |
| 25 | ||
| e81c27 | 26 | NS_ASSUME_NONNULL_BEGIN |
| H | 27 | |
| 9febd9 | 28 | /** |
| W | 29 | An Open Graph Action for sharing. |
| 30 | ||
| 31 | The property keys MUST have namespaces specified on them, such as `og:image`. | |
| bad748 | 32 | */ |
| e81c27 | 33 | NS_SWIFT_NAME(ShareOpenGraphAction) |
| bad748 | 34 | @interface FBSDKShareOpenGraphAction : FBSDKShareOpenGraphValueContainer <FBSDKCopying, NSSecureCoding> |
| e81c27 | 35 | |
| H | 36 | - (instancetype)init NS_UNAVAILABLE; |
| 37 | + (instancetype)new NS_UNAVAILABLE; | |
| 38 | ||
| 39 | /** | |
| 40 | Designated initializer to build a new action and set the object for the specified key. | |
| 41 | @param actionType The action type of the receiver | |
| 42 | */ | |
| 43 | - (instancetype)initWithActionType:(NSString *)actionType | |
| 44 | NS_SWIFT_NAME(init(type:)); | |
| bad748 | 45 | |
| 9febd9 | 46 | /** |
| W | 47 | Convenience method to build a new action and set the object for the specified key. |
| 13e53a | 48 | @param actionType The action type of the receiver |
| H | 49 | @param object The Open Graph object represented by this action |
| 50 | @param key The key for the object | |
| bad748 | 51 | */ |
| W | 52 | + (instancetype)actionWithType:(NSString *)actionType object:(FBSDKShareOpenGraphObject *)object key:(NSString *)key; |
| 53 | ||
| 9febd9 | 54 | /** |
| W | 55 | Convenience method to build a new action and set the object for the specified key. |
| 13e53a | 56 | @param actionType The action type of the receiver |
| H | 57 | @param objectID The ID of an existing Open Graph object |
| 58 | @param key The key for the object | |
| bad748 | 59 | */ |
| W | 60 | + (instancetype)actionWithType:(NSString *)actionType objectID:(NSString *)objectID key:(NSString *)key; |
| 61 | ||
| 9febd9 | 62 | /** |
| W | 63 | Convenience method to build a new action and set the object for the specified key. |
| 13e53a | 64 | @param actionType The action type of the receiver |
| H | 65 | @param objectURL The URL to a page that defines the Open Graph object with meta tags |
| 66 | @param key The key for the object | |
| bad748 | 67 | */ |
| W | 68 | + (instancetype)actionWithType:(NSString *)actionType objectURL:(NSURL *)objectURL key:(NSString *)key; |
| 69 | ||
| 9febd9 | 70 | /** |
| W | 71 | Gets the action type. |
| 13e53a | 72 | @return The action type |
| bad748 | 73 | */ |
| W | 74 | @property (nonatomic, copy) NSString *actionType; |
| 75 | ||
| 9febd9 | 76 | /** |
| W | 77 | Compares the receiver to another Open Graph Action. |
| 13e53a | 78 | @param action The other action |
| H | 79 | @return YES if the receiver's values are equal to the other action's values; otherwise NO |
| bad748 | 80 | */ |
| W | 81 | - (BOOL)isEqualToShareOpenGraphAction:(FBSDKShareOpenGraphAction *)action; |
| 82 | ||
| 83 | @end | |
| e81c27 | 84 | |
| H | 85 | NS_ASSUME_NONNULL_END |
