FBSDKAppInviteContent - Documentation

FBSDKAppInviteContent

A more recent version of this class is available. Check out the latest version.

A model for app invite.

Conforms to:	`FBSDKCopying, NSSecureCoding`
Superclass:	`NSObject`
Declared in:	`FBSDKAppInviteContent.h`

Properties

appInvitePreviewImageURL

A URL to a preview image that will be displayed with the app invite

@property (nonatomic,
    copy) NSURL *appInvitePreviewImageURL;

Discussion:

This is optional. If you don't include it a fallback image will be used.

Declared In: FBSDKAppInviteContent.h

appLinkURL

An app link target that will be used as a target when the user accept the invite.

@property (nonatomic,
    copy) NSURL *appLinkURL;

Discussion:

This is a requirement.

Declared In: FBSDKAppInviteContent.h

destination

Destination for the app invite.

Discussion:

This is optional and for declaring destination of the invite.

Declared In: FBSDKAppInviteContent.h

previewImageURL

@property (nonatomic,
    copy) NSURL *previewImageURL __attribute__ ((deprecated("use appInvitePreviewImageURL instead"

Declared In: FBSDKAppInviteContent.h

promotionCode

Promotional code to be displayed while sending and receiving the invite.

@property (nonatomic,
    copy) NSString *promotionCode;

Discussion:

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.

Declared In: FBSDKAppInviteContent.h

promotionText

Promotional text to be displayed while sending and receiving the invite.

@property (nonatomic,
    copy) NSString *promotionText;

Discussion:

This is optional. This can be between 0 and 80 characters long and can contain alphanumeric and spaces only.

Declared In: FBSDKAppInviteContent.h

Instance Methods

isEqualToAppInviteContent:

Compares the receiver to another app invite content.

Parameter	Description
`content`	The other content

- (BOOL) isEqualToAppInviteContent:(FBSDKAppInviteContent *)content;

Declared In: FBSDKAppInviteContent.h

Typedefs

NS_ENUM

Specifies the privacy of a group.

typedef NS_ENUM(NSUInteger, FBSDKAppInviteDestination) { 
    /*! Deliver to Facebook. */
    FBSDKAppInviteDestinationFacebook = 0, /*! Deliver to Messenger. 
        */
    FBSDKAppInviteDestinationMessenger, 
};

Constant	Description
`FBSDKAppInviteDestinationFacebook`	Deliver to Facebook.

Discussion:

FBSDKAppInviteDestination)

Declared In: FBSDKAppInviteContent.h

NS_ENUM(NSUInteger,

Specifies the privacy of a group.

typedef NS_ENUM(NSUInteger, FBSDKAppInviteDestination) { 
    /*! Deliver to Facebook. */
    FBSDKAppInviteDestinationFacebook = 0, /*! Deliver to Messenger. 
        */
    FBSDKAppInviteDestinationMessenger, 
};

Constant	Description
`FBSDKAppInviteDestinationFacebook`	Deliver to Facebook.
`FBSDKAppInviteDestinationMessenger`	Deliver to Messenger.

Discussion:

FBSDKAppInviteDestination)

Declared In: FBSDKAppInviteContent.h