iOS SDK Version
FBSDKShareKit Reference

FBSDKAppInviteContent

@interfaceFBSDKAppInviteContent:NSObject<NSCopying,NSObject,FBSDKSharingValidation,NSSecureCoding>
A model for app invite.
  • A URL to a preview image that will be displayed with the app invite
    This is optional. If you don’t include it a fallback image will be used.

    Declaration

    Objective-C
    @property(nonatomic,copy,readwrite,nullable)NSURL*appInvitePreviewImageURL;
    Swift
    varappInvitePreviewImageURL:URL?{getset}
  • An app link target that will be used as a target when the user accept the invite.
    This is a requirement.

    Declaration

    Objective-C
    @property(nonatomic,copy,readwrite)NSURL*_NonnullappLinkURL;
    Swift
    varappLinkURL:URL{getset}
  • Promotional code to be displayed while sending and receiving the invite.
    This is optional. This can be between 0 and 10 characters long and can contain alphanumeric characters only. To set a promo code, you need to set promo text.

    Declaration

    Objective-C
    @property(nonatomic,copy,readwrite,nullable)NSString*promotionCode;
    Swift
    varpromotionCode:String?{getset}
  • Promotional text to be displayed while sending and receiving the invite.
    This is optional. This can be between 0 and 80 characters long and can contain alphanumeric and spaces only.

    Declaration

    Objective-C
    @property(nonatomic,copy,readwrite,nullable)NSString*promotionText;
    Swift
    varpromotionText:String?{getset}
  • Destination for the app invite.
    This is optional and for declaring destination of the invite.

    Declaration

    Objective-C
    @property(nonatomic,assign,unsafe_unretained,readwrite)FBSDKAppInviteDestinationdestination;
    Swift
    vardestination:AppInviteDestination{getset}
  • Compares the receiver to another app invite content.

    Declaration

    Objective-C
    -(BOOL)isEqualToAppInviteContent:(nonnullFBSDKAppInviteContent*)content;
    Swift
    funcisEqual(tocontent:AppInviteContent)->Bool

    Parameters

    Return Value

    YES if the receiver’s values are equal to the other content’s values; otherwise NO