| 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 | ||
| 9febd9 | 23 | /** |
| W | 24 | NS_ENUM(NSUInteger, FBSDKAppInviteDestination) |
| 25 | Specifies the privacy of a group. | |
| 26 | */ | |
| 27 | typedef NS_ENUM(NSUInteger, FBSDKAppInviteDestination) | |
| 28 | { | |
| 29 | /** Deliver to Facebook. */ | |
| 30 | FBSDKAppInviteDestinationFacebook = 0, | |
| 31 | /** Deliver to Messenger. */ | |
| 32 | FBSDKAppInviteDestinationMessenger, | |
| 33 | }; | |
| 34 | ||
| 35 | /** | |
| 36 | A model for app invite. | |
| bad748 | 37 | */ |
| W | 38 | @interface FBSDKAppInviteContent : NSObject <FBSDKCopying, NSSecureCoding> |
| 39 | ||
| 9febd9 | 40 | /** |
| W | 41 | A URL to a preview image that will be displayed with the app invite |
| bad748 | 42 | |
| 9febd9 | 43 | |
| W | 44 | This is optional. If you don't include it a fallback image will be used. |
| bad748 | 45 | */ |
| W | 46 | @property (nonatomic, copy) NSURL *appInvitePreviewImageURL; |
| 47 | ||
| 9febd9 | 48 | /** |
| W | 49 | An app link target that will be used as a target when the user accept the invite. |
| bad748 | 50 | |
| 9febd9 | 51 | |
| W | 52 | This is a requirement. |
| bad748 | 53 | */ |
| W | 54 | @property (nonatomic, copy) NSURL *appLinkURL; |
| 55 | ||
| 9febd9 | 56 | /** |
| W | 57 | |
| 58 | - Warning:Use `appInvitePreviewImageURL` instead. | |
| bad748 | 59 | */ |
| W | 60 | @property (nonatomic, copy) NSURL *previewImageURL __attribute__ ((deprecated("use appInvitePreviewImageURL instead"))); |
| 61 | ||
| 9febd9 | 62 | /** |
| W | 63 | Promotional code to be displayed while sending and receiving the invite. |
| bad748 | 64 | |
| 9febd9 | 65 | |
| W | 66 | This is optional. This can be between 0 and 10 characters long and can contain |
| bad748 | 67 | alphanumeric characters only. To set a promo code, you need to set promo text. |
| W | 68 | */ |
| 69 | @property (nonatomic, copy) NSString *promotionCode; | |
| 70 | ||
| 9febd9 | 71 | /** |
| W | 72 | Promotional text to be displayed while sending and receiving the invite. |
| bad748 | 73 | |
| 9febd9 | 74 | |
| W | 75 | This is optional. This can be between 0 and 80 characters long and can contain |
| bad748 | 76 | alphanumeric and spaces only. |
| W | 77 | */ |
| 78 | @property (nonatomic, copy) NSString *promotionText; | |
| 79 | ||
| 9febd9 | 80 | /** |
| W | 81 | Destination for the app invite. |
| 82 | ||
| 83 | ||
| 84 | This is optional and for declaring destination of the invite. | |
| 85 | */ | |
| 86 | @property FBSDKAppInviteDestination destination; | |
| 87 | ||
| 88 | /** | |
| 89 | Compares the receiver to another app invite content. | |
| 90 | - Parameter content: The other content | |
| 91 | - Returns: YES if the receiver's values are equal to the other content's values; otherwise NO | |
| bad748 | 92 | */ |
| W | 93 | - (BOOL)isEqualToAppInviteContent:(FBSDKAppInviteContent *)content; |
| 94 | ||
| 95 | @end | |
