Packagecom.distriqt.extension.facebookapi.appinvites
Interfacepublic interface AppInvite extends flash.events.IEventDispatcher
Deprecated: Deprecated

Starting 6th February 2018, App Invites will no longer be supported. Starting with SDK version 4.28 and above. See the notice here

App Invites are a content-rich, personal way for people to invite their Facebook friends to a mobile app.

App Invites does not require Facebook Login.


Public Methods
 MethodDefined By
  
canShow():Boolean
Deprecated: Deprecated
Indicates whether it is possible to show the App Invite dialog.
AppInvite
  
show(content:Object):Boolean
Deprecated: Deprecated
Shows the App Invite dialog using the provided content.
AppInvite
Events
 Event Summary Defined By
  
facebookapi:appinvite:dialog:cancelled
 Dispatched when the user cancelled an App Invite dialog AppInvite
  
facebookapi:appinvite:dialog:completed
 Dispatched when the Facebook App Invite dialog has completed successfully.AppInvite
  
facebookapi:appinvite:dialog:error
 Dispatched when an error occurred from an App Invite dialog errorMessage will contain details on the error that occurred.AppInvite
Method Detail
canShow()method
public function canShow():Boolean
Deprecated: Deprecated

Indicates whether it is possible to show the App Invite dialog.

Returns
Boolean — true if the dialog can be shown and false otherwise
show()method 
public function show(content:Object):Boolean
Deprecated: Deprecated

Shows the App Invite dialog using the provided content.

You must create the content using one of the builders:

Parameters

content:Object — App Invite content created using one the builder

Returns
Boolean — true if the dialog will be displayed and false if it is not available

Example
Display an App Invite dialog using the AppInviteContentBuilder 
         var builder:AppInviteContentBuilder = new AppInviteContentBuilder()
             .setAppLinkUrl("https://www.mydomain.com/myapplink")
             .setPreviewImageUrl("https://www.mydomain.com/my_invite_image.jpg");
         
             var success:Boolean = FacebookAPI.service.appInvite.show( builder.build() );
Event Detail
facebookapi:appinvite:dialog:cancelled Event
Event Object Type: com.distriqt.extension.facebookapi.events.AppInviteEvent
AppInviteEvent.type property = com.distriqt.extension.facebookapi.events.AppInviteEvent.DIALOG_CANCELLED

Dispatched when the user cancelled an App Invite dialog
facebookapi:appinvite:dialog:completed Event  
Event Object Type: com.distriqt.extension.facebookapi.events.AppInviteEvent
AppInviteEvent.type property = com.distriqt.extension.facebookapi.events.AppInviteEvent.DIALOG_COMPLETED

Dispatched when the Facebook App Invite dialog has completed successfully.

facebookapi:appinvite:dialog:error Event  
Event Object Type: com.distriqt.extension.facebookapi.events.AppInviteEvent
AppInviteEvent.type property = com.distriqt.extension.facebookapi.events.AppInviteEvent.DIALOG_ERROR

Dispatched when an error occurred from an App Invite dialog

errorMessage will contain details on the error that occurred.





Tue Oct 20 2020, 10:03 PM +10:00