Packagecom.adobe.ane.stageAd
Classpublic class StageFullscreenAd
InheritanceStageFullscreenAd Inheritance flash.events.EventDispatcher

The main class responsible for creating, displaying and managing fullscreen advertisements from the iAd network (fullscreen ads are supported on iPad devices only).



Public Properties
 PropertyDefined By
  isSupported : Boolean
[static] [read-only] Indicates whether the feature is supported on the underlying platform This method should always be called before attempting to use any functionality related to the feature (currently, the feature is supported only in AIR on iOS).
StageFullscreenAd
  loaded : Boolean
[read-only] Indicates whether or not the StageFullscreenAd is currently loaded with iAd content.
StageFullscreenAd
Public Methods
 MethodDefined By
  
Creates a new StageFullscreenAd instance
StageFullscreenAd
  
addToStage():void
Add the StageFullscreenAd to the stage When this method is called, the StageBannerAd does not load immediately.
StageFullscreenAd
  
Cancel the Action that has been initiated on the StageFullscreenAd by a user interaction
StageFullscreenAd
Events
 Event Summary Defined By
  The adActionComplete event is dispatched when an ad action finishes and the user is returned to the application's UI.StageFullscreenAd
  The adActionStart event is dispatched when the end user interacts with iAd content in the StageBannerAd by tapping on it.StageFullscreenAd
  The adLoadComplete event is dispatched when iAd content is loaded into the StageFullScreenAd.StageFullscreenAd
  The adLoadFail event is dispatched when iAd content fails to load in the StageFullScreenAd.StageFullscreenAd
  The adUnload event is dispatched when iAd content is unloaded from the StageFullScreenAd.StageFullscreenAd
Property Detail
isSupportedproperty
isSupported:Boolean  [read-only]

Indicates whether the feature is supported on the underlying platform

This method should always be called before attempting to use any functionality related to the feature (currently, the feature is supported only in AIR on iOS).


Implementation
    public static function get isSupported():Boolean
loadedproperty 
loaded:Boolean  [read-only]

Indicates whether or not the StageFullscreenAd is currently loaded with iAd content. If it is not loaded, the StageFullscreenAd will not be visible on the stage


Implementation
    public function get loaded():Boolean
Constructor Detail
StageFullscreenAd()Constructor
public function StageFullscreenAd()

Creates a new StageFullscreenAd instance

Method Detail
addToStage()method
public function addToStage():void

Add the StageFullscreenAd to the stage

When this method is called, the StageBannerAd does not load immediately. In case the app needs to make any UI changes after the StageBannerAd is loaded, the app must listen for the adLoadComplete event and perform any required UI changes in the event handler.

See also

com.adobe.ane.stageAd.StageAdEvent.AD_LOAD_COMPLETE
cancelAction()method 
public function cancelAction():void

Cancel the Action that has been initiated on the StageFullscreenAd by a user interaction

Event Detail
adActionComplete Event
Event Object Type: com.adobe.ane.stageAd.StageAdEvent
StageAdEvent.type property = com.adobe.ane.stageAd.StageAdEvent.AD_ACTION_COMPLETE

The adActionComplete event is dispatched when an ad action finishes and the user is returned to the application's UI. The application should re-start any services, such as background music, which it had stopped when the action started.

Defines the value of the type property of a StageAdEvent event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe StageBannerAd or StageFullscreenAd object receiving data.
willLeaveApplicationfalse
messageempty String
adActionStart Event  
Event Object Type: com.adobe.ane.stageAd.StageAdEvent
StageAdEvent.type property = com.adobe.ane.stageAd.StageAdEvent.AD_ACTION_START

The adActionStart event is dispatched when the end user interacts with iAd content in the StageBannerAd by tapping on it. It indicates that an action is about to start and the application's UI will be covered by the UI of the ad action. The application should stop or pause any services, such as background music, which might interfere with the ad action.

An action may or may not cause the application to go into the background. For example, if an action will cause the web browser to be launched, the application will go into background.

Defines the value of the type property of a StageAdEvent event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; the action initiated by the user interaction cannot be cancelled by calling preventDefault().
currentTargetThe object that is actively processing the event object with an event listener.
targetThe StageBannerAd or StageFullscreenAd object receiving data.
willLeaveApplicationWhether the action that is about to start will cause the Application to go into the background
messageempty String
adLoadComplete Event  
Event Object Type: com.adobe.ane.stageAd.StageAdEvent
StageAdEvent.type property = com.adobe.ane.stageAd.StageAdEvent.AD_LOAD_COMPLETE

The adLoadComplete event is dispatched when iAd content is loaded into the StageFullScreenAd. The iAd content automatically becomes visible when this event occurs. The application can then perform any additional UI adjustments required to accomodate the StageFullscreenAd.

Defines the value of the type property of a StageAdEvent event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe StageBannerAd or StageFullscreenAd object receiving data.
willLeaveApplicationfalse
messageempty String
adLoadFail Event  
Event Object Type: com.adobe.ane.stageAd.StageAdEvent
StageAdEvent.type property = com.adobe.ane.stageAd.StageAdEvent.AD_LOAD_FAIL

The adLoadFail event is dispatched when iAd content fails to load in the StageFullScreenAd. iAd content could fail to load for any of the following reasons:

When this event occurs, the StageFullScreenAd is automatically removed from the stage.

Defines the value of the type property of a StageAdEvent event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe StageBannerAd or StageFullscreenAd object receiving data.
willLeaveApplicationfalse
messageThe details of the reason why the ad failed to load
adUnload Event  
Event Object Type: com.adobe.ane.stageAd.StageAdEvent
StageAdEvent.type property = com.adobe.ane.stageAd.StageAdEvent.AD_UNLOAD

The adUnload event is dispatched when iAd content is unloaded from the StageFullScreenAd. iAd content could be unloaded for any of the following reasons:

When this event occurs, the StageFullscreenAd is automatically removed from the stage.

Defines the value of the type property of a StageAdEvent event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe StageBannerAd or StageFullscreenAd object receiving data.
willLeaveApplicationfalse
messageempty String