| Package | com.distriqt.extension.facebookapi.appinvites.builders |
| Class | public class AppInviteContentBuilder |
| Inheritance | AppInviteContentBuilder  Object |
| Method | Defined By | ||
|---|---|---|---|
Constructor
| AppInviteContentBuilder | ||
build():Object
Builds the object for the showing using AppInvite.show
| AppInviteContentBuilder | ||
setApplinkUrl(appLinkUrl:String):AppInviteContentBuilder
Sets the applink url that will be used for deep-linking
The App Link URL is a deep link to a specific place in your mobile app. | AppInviteContentBuilder | ||
setDestination(destination:String):AppInviteContentBuilder
Sets the destination of the invite either "facebook" or "messenger"
| AppInviteContentBuilder | ||
setPreviewImageUrl(previewImageUrl:String):AppInviteContentBuilder
Sets the preview image url for this invite. | AppInviteContentBuilder | ||
setPromotionDetails(promotionText:String, promotionCode:String):AppInviteContentBuilder
Sets promotion code and promotion text to be shown on sender and receiver flows for app invites. | AppInviteContentBuilder | ||
| AppInviteContentBuilder | () | Constructor |
public function AppInviteContentBuilder()Constructor
| build | () | method |
public function build():Object
Builds the object for the showing using AppInvite.show
Object — The content Object
|
See also
| setApplinkUrl | () | method |
public function setApplinkUrl(appLinkUrl:String):AppInviteContentBuilder
Sets the applink url that will be used for deep-linking
The App Link URL is a deep link to a specific place in your mobile app. Read more about this at https://developers.facebook.com/docs/app-invites/ios#app_links
Parameters
appLinkUrl:String — The applink url
|
AppInviteContentBuilder — AppInviteContentBuilder instance for chaining calls
|
| setDestination | () | method |
public function setDestination(destination:String):AppInviteContentBuilder
Sets the destination of the invite either "facebook" or "messenger"
Parameters
destination:String — The destination for the dialog invite
|
AppInviteContentBuilder — AppInviteContentBuilder instance for chaining calls
|
| setPreviewImageUrl | () | method |
public function setPreviewImageUrl(previewImageUrl:String):AppInviteContentBuilder
Sets the preview image url for this invite. See guidelines for correct dimensions.
The preview image URL will be used to render the image in the invite. While not required, it is recommended you pass this field in as your invite may not be rendered if no alternative images are found. Your invite may not be rendered if no alternative images are found.
If a previewImageURL is not set the invite will use Promotional Images from the App Details section in apps settings. The invite will not show if no images are available.
The suggested image size is 1,200 x 628 pixels with an image ratio of 1.9:1.
Parameters
previewImageUrl:String — Url of the image that is going to be used as a preview for invite
|
AppInviteContentBuilder — AppInviteContentBuilder instance for chaining calls
|
| setPromotionDetails | () | method |
public function setPromotionDetails(promotionText:String, promotionCode:String):AppInviteContentBuilder
Sets promotion code and promotion text to be shown on sender and receiver flows for app invites.
Parameters
promotionText:String — Promotion text to be shown on sender and receiver flows. Promotion text has to be between 1 and 80 characters long.
| |
promotionCode:String — Promotion code to be shown on sender and receiver flows. Promotion code is optional and has to be less than 10 characters long. promotionText needs to be specified if promotionCode is provided.
|
AppInviteContentBuilder — AppInviteContentBuilder instance for chaining calls
|