| 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> | |
| 13e53a | 22 | #import <FBSDKShareKit/FBSDKSharingValidation.h> |
| bad748 | 23 | |
| W | 24 | @class FBSDKHashtag; |
| 25 | ||
| 9febd9 | 26 | /** |
| W | 27 | A base interface for content to be shared. |
| bad748 | 28 | */ |
| 13e53a | 29 | @protocol FBSDKSharingContent <FBSDKCopying, FBSDKSharingValidation, NSSecureCoding> |
| bad748 | 30 | |
| 9febd9 | 31 | /** |
| W | 32 | URL for the content being shared. |
| 33 | ||
| 34 | This URL will be checked for all link meta tags for linking in platform specific ways. See documentation | |
| bad748 | 35 | for App Links (https://developers.facebook.com/docs/applinks/) |
| 13e53a | 36 | @return URL representation of the content link |
| bad748 | 37 | */ |
| W | 38 | @property (nonatomic, copy) NSURL *contentURL; |
| 39 | ||
| 9febd9 | 40 | /** |
| W | 41 | Hashtag for the content being shared. |
| 13e53a | 42 | @return The hashtag for the content being shared. |
| bad748 | 43 | */ |
| W | 44 | @property (nonatomic, copy) FBSDKHashtag *hashtag; |
| 45 | ||
| 9febd9 | 46 | /** |
| W | 47 | List of IDs for taggable people to tag with this content. |
| 48 | See documentation for Taggable Friends | |
| bad748 | 49 | (https://developers.facebook.com/docs/graph-api/reference/user/taggable_friends) |
| 13e53a | 50 | @return Array of IDs for people to tag (NSString) |
| bad748 | 51 | */ |
| W | 52 | @property (nonatomic, copy) NSArray *peopleIDs; |
| 53 | ||
| 9febd9 | 54 | /** |
| W | 55 | The ID for a place to tag with this content. |
| 13e53a | 56 | @return The ID for the place to tag |
| bad748 | 57 | */ |
| W | 58 | @property (nonatomic, copy) NSString *placeID; |
| 59 | ||
| 9febd9 | 60 | /** |
| W | 61 | A value to be added to the referrer URL when a person follows a link from this shared content on feed. |
| 13e53a | 62 | @return The ref for the content. |
| bad748 | 63 | */ |
| W | 64 | @property (nonatomic, copy) NSString *ref; |
| 65 | ||
| 27832c | 66 | /** |
| H | 67 | For shares into Messenger, this pageID will be used to map the app to page and attach attribution to the share. |
| 13e53a | 68 | @return The ID of the Facebok page this share is associated with. |
| 27832c | 69 | */ |
| H | 70 | @property (nonatomic, copy) NSString *pageID; |
| 71 | ||
| 72 | /** | |
| 73 | A unique identifier for a share involving this content, useful for tracking purposes. | |
| 13e53a | 74 | @return A unique string identifying this share data. |
| 27832c | 75 | */ |
| H | 76 | @property (nonatomic, copy, readonly) NSString *shareUUID; |
| 77 | ||
| 13e53a | 78 | /** |
| H | 79 | Adds content to an existing dictionary as key/value pairs and returns the |
| 80 | updated dictionary | |
| 81 | @param existingParameters An immutable dictionary of existing values | |
| 82 | @param bridgeOptions The options for bridging | |
| 83 | @return A new dictionary with the modified contents | |
| 84 | */ | |
| 85 | - (NSDictionary<NSString *, id> *)addParameters:(NSDictionary<NSString *, id> *)existingParameters | |
| 86 | bridgeOptions:(FBSDKShareBridgeOptions)bridgeOptions; | |
| 87 | ||
| 88 | /** | |
| 89 | Adds content to a dictionary as key/value pairs. | |
| 90 | @param parameters A mutable dictionary that may be appended with key/value pairs of content. | |
| 91 | @param bridgeOptions The options for bridging | |
| 92 | */ | |
| 93 | ||
| 94 | - (void)addToParameters:(NSMutableDictionary<NSString *, id> *)parameters | |
| 95 | bridgeOptions:(FBSDKShareBridgeOptions)bridgeOptions | |
| 96 | DEPRECATED_MSG_ATTRIBUTE("`addToParameters` is deprecated. Use `addParameters`"); | |
| 97 | ||
| bad748 | 98 | @end |
