com.marpies.ane.facebook.share.IAIRFacebookShare

	Property	Defined By
		canShareAppInvite : Boolean Deprecated Since 2.0.0App invitation has been deprecated by Facebook. [read-only] Call this to find out if an app invite dialog can be presented on current device.	IAIRFacebookShare
		canShareLink : Boolean [read-only] Call this to find out if link sharing is possible on current device.	IAIRFacebookShare
		canShareLinkMessage : Boolean [read-only] Call this to find out if link sharing with Messenger is possible on current device.	IAIRFacebookShare
		canShareOpenGraphStory : Boolean [read-only] Call this to find out if Open Graph story sharing is possible on current device.	IAIRFacebookShare
		canSharePhoto : Boolean [read-only] Call this to find out if photo sharing is possible on current device.	IAIRFacebookShare
		canSharePhotoMessage : Boolean [read-only] Call this to find out if photo sharing with Messenger is possible on current device.	IAIRFacebookShare

	Method	Defined By
		appInvite(appLinkURL:String, imageURL:String = null, listener:IAIRFacebookAppInviteListener = null):void Deprecated Since 2.0.0App invitation has been deprecated by Facebook. Opens up web dialog or native Facebook app with an option to send app invitation.	IAIRFacebookShare
		link(contentURL:String, postWithoutUI:Boolean = false, message:String = null, listener:IAIRFacebookShareListener = null):void Opens up web dialog or native Facebook app to post link on user's timeline.	IAIRFacebookShare
		linkMessage(contentURL:String, listener:IAIRFacebookShareListener = null):void Opens up native Facebook Messenger app to share link in message.	IAIRFacebookShare
		openGraphStory(actionType:String, objectType:String, title:String, image:Object = null, objectProperties:Object = null, listener:IAIRFacebookShareListener = null):void Opens up web dialog or native Facebook app to share an Open Graph story.	IAIRFacebookShare
		photo(photo:Object, isUserGenerated:Boolean = false, postWithoutUI:Boolean = false, message:String = null, listener:IAIRFacebookShareListener = null):void Opens up native Facebook app to post photo on user's timeline.	IAIRFacebookShare
		photoMessage(photo:Object, isUserGenerated:Boolean = false, listener:IAIRFacebookShareListener = null):void Opens up native Facebook Messenger app to share photo in message.	IAIRFacebookShare

Property Detail

canShareAppInvite

property

canShareAppInvite:Boolean [read-only]

Deprecated Since 2.0.0App invitation has been deprecated by Facebook.

Call this to find out if an app invite dialog can be presented on current device.

Implementation
public function get canShareAppInvite():Boolean

See also

appInvite()

canShareLink

property

canShareLink:Boolean [read-only]

Call this to find out if link sharing is possible on current device.

Implementation
public function get canShareLink():Boolean

See also

link()

canShareLinkMessage

property

canShareLinkMessage:Boolean [read-only]

Call this to find out if link sharing with Messenger is possible on current device.

Note: Sharing via Messenger on iOS is only possible on iPhones.

Implementation
public function get canShareLinkMessage():Boolean

See also

linkMessage()

canShareOpenGraphStory

property

canShareOpenGraphStory:Boolean [read-only]

Call this to find out if Open Graph story sharing is possible on current device.

Implementation
public function get canShareOpenGraphStory():Boolean

See also

openGraphStory()

canSharePhoto

property

canSharePhoto:Boolean [read-only]

Call this to find out if photo sharing is possible on current device.

Implementation
public function get canSharePhoto():Boolean

See also

photo()

canSharePhotoMessage

property

canSharePhotoMessage:Boolean [read-only]

Call this to find out if photo sharing with Messenger is possible on current device.

Note: Sharing via Messenger on iOS is only possible on iPhones.

Implementation
public function get canSharePhotoMessage():Boolean

See also

photoMessage()

Method Detail

appInvite

()

method

 public function appInvite(appLinkURL:String, imageURL:String = null, listener:IAIRFacebookAppInviteListener = null):void

Deprecated Since 2.0.0App invitation has been deprecated by Facebook.

Opens up web dialog or native Facebook app with an option to send app invitation. Friends who already have your app installed will not receive the invitation.

Parameters

	`appLinkURL:String` — App link for what should be opened when the recipient clicks on the install/play button on the app invite page. See Facebook docs on how to generate an app link.

	`imageURL:String` (default = `null`) — URL to an image to be used in the invite. If a `imageURL` is not set the invite will use Promotional Images from the App Details section in Facebook apps settings. The invite will not show if no images are available.

	`listener:IAIRFacebookAppInviteListener` (default = `null`) — Object that will be notified about the invitation process result.

Events

shareResult:AIRFacebookShareEvent — Dispatched when the result of the invitation process is obtained.

link

()

method

 public function link(contentURL:String, postWithoutUI:Boolean = false, message:String = null, listener:IAIRFacebookShareListener = null):void

Opens up web dialog or native Facebook app to post link on user's timeline.

Parameters

	`contentURL:String` — URL to which the posted link redirects.

	`postWithoutUI:Boolean` (default = `false`) — Set to `true` if the link should be posted immediately without dialog or Facebook app popping up. User must be logged in and your app must have been granted `publish_actions` permission.

	`message:String` (default = `null`) — Message that is added to the post when shared without UI. When shared using native UI this message can be added by user manually.

	`listener:IAIRFacebookShareListener` (default = `null`) — Object that will be notified about the sharing process result.

Events

shareResult:AIRFacebookShareEvent — Dispatched when the result of the sharing process is obtained.

linkMessage

()

method

public function linkMessage(contentURL:String, listener:IAIRFacebookShareListener = null):void

Opens up native Facebook Messenger app to share link in message.

Note: Facebook Messenger app is required for this feature to work. Sharing via Messenger on iOS is only possible on iPhones.

Note: On Android, successful result is dispatched even when user cancelled the share action. According to Facebook dev team, it is not considered a bug.

Parameters

	`contentURL:String` — URL to which the posted link redirects.

	`listener:IAIRFacebookShareListener` (default = `null`) — Object that will be notified about the sharing process result.

Events

shareResult:AIRFacebookShareEvent — Dispatched when the result of the sharing process is obtained.

See also

canShareLinkMessage

openGraphStory

()

method

 public function openGraphStory(actionType:String, objectType:String, title:String, image:Object = null, objectProperties:Object = null, listener:IAIRFacebookShareListener = null):void

Opens up web dialog or native Facebook app to share an Open Graph story.

Parameters

	`actionType:String` — Open Graph action, e.g. `books.reads` or custom action `app_namespace:action`.

	`objectType:String` — Open Graph object (must contain namespace), e.g. `books:book` or `app_namespace:object`.

	`title:String` — Title of the Open Graph content.

	`image:Object` (default = `null`) — Image displayed with the content. This parameter may be either `String` (image URL) or `BitmapData`.

	`objectProperties:Object` (default = `null`) — Key-value object specifying additional Open Graph object properties. The keys must contain namespace, e.g. `{ "books:isbn", "0-553-57340-3", "app_namespace:property": "value" }`.

	`listener:IAIRFacebookShareListener` (default = `null`) — Object that will be notified about the sharing process result.

Events

shareResult:AIRFacebookShareEvent — Dispatched when the result of the sharing process is obtained.

photo

()

method

 public function photo(photo:Object, isUserGenerated:Boolean = false, postWithoutUI:Boolean = false, message:String = null, listener:IAIRFacebookShareListener = null):void

Opens up native Facebook app to post photo on user's timeline.

Note: Facebook app is required for this feature to work.

Parameters

	`photo:Object` — Object representing the photo to share. This parameter may be either `String` (image URL - local or remote location) or `BitmapData`. If image URL is specified then the image will be loaded before sharing which might introduce a slight delay between user's interaction and UI response.

	`isUserGenerated:Boolean` (default = `false`) — Specifies whether the photo was generated by the user or by the application.

	`postWithoutUI:Boolean` (default = `false`) — Set to `true` if the photo should be posted immediately without Facebook app popping up. User must be logged in and your app must have been granted `publish_actions` permission.

	`message:String` (default = `null`) — Message that is added to the post when shared without UI. When shared using native UI this message can be added by user manually.

	`listener:IAIRFacebookShareListener` (default = `null`) — Object that will be notified about the sharing process result.

Events

shareResult:AIRFacebookShareEvent — Dispatched when the result of the sharing process is obtained.

photoMessage

()

method

 public function photoMessage(photo:Object, isUserGenerated:Boolean = false, listener:IAIRFacebookShareListener = null):void

Opens up native Facebook Messenger app to share photo in message.

Note: Facebook Messenger app is required for this feature to work. Sharing via Messenger on iOS is only possible on iPhones.

Note: On Android, successful result is dispatched even when user cancelled the share action. According to Facebook dev team, it is not considered a bug.

Parameters

	`photo:Object` — Object representing the photo to share. This parameter may be either `String` (image URL - local or remote location) or `BitmapData`. If image URL is specified then the image will be loaded before sharing which might introduce a slight delay between user's interaction and UI response.

	`isUserGenerated:Boolean` (default = `false`) — Specifies whether the photo was generated by the user or by the application.

	`listener:IAIRFacebookShareListener` (default = `null`) — Object that will be notified about the sharing process result.

Events

shareResult:AIRFacebookShareEvent — Dispatched when the result of the sharing process is obtained.

See also

canSharePhotoMessage

Mon Jan 29 2018, 11:50 PM +01:00

AIRFacebook documentation	All Packages \| All Classes \| Index \| Frames No Frames
IAIRFacebookShare	Properties \| Methods

Package	com.marpies.ane.facebook.share
Interface	public interface IAIRFacebookShare extends flash.events.IEventDispatcher