Packagecom.vungle.extensions
Classpublic class VungleAdConfig
InheritanceVungleAdConfig Inheritance Object

Configuration object for the ad experience. Developers may instantiate multiple instances of this class and pass them to Vungle.playAd().

See also

Vungle.playAd()


Public Properties
 PropertyDefined By
  backButtonImmediatelyEnabled : Boolean
Pressing the Android back button during a video ad by default has the same effect as pressing the on screen close button once it appears.
VungleAdConfig
  extra1 : String
The first developer-defined extra configuration value.
VungleAdConfig
  extra2 : String
The second developer-defined extra configuration value.
VungleAdConfig
  extra3 : String
The third developer-defined extra configuration value.
VungleAdConfig
  extra4 : String
The fourth developer-defined extra configuration value.
VungleAdConfig
  extra5 : String
The fifth developer-defined extra configuration value.
VungleAdConfig
  extra6 : String
The sixth developer-defined extra configuration value.
VungleAdConfig
  extra7 : String
The seventh developer-defined extra configuration value.
VungleAdConfig
  extra8 : String
The eigth developer-defined extra configuration value.
VungleAdConfig
  globalConfig : VungleAdConfig
[static] [read-only] Global ad configuration is a singleton instance of the VungleAdConfig class.
VungleAdConfig
  immersiveMode : Boolean
Indicates whether in KitKat (API level 19) and later devices immersive mode will be enabled.
VungleAdConfig
  incentivizedCancelDialogBodyText : String
The custom body text for the popup dialog warning the user that they will not be rewarded if they exit an incentivized ad early.
VungleAdConfig
  incentivizedCancelDialogCloseButtonText : String
The custom cancel button text for the popup dialog warning the user that they will not be rewarded if they exit an incentivized ad early.
VungleAdConfig
  incentivizedCancelDialogKeepWatchingButtonText : String
Returns the custom continue watching button text for the popup dialog warning the user that they will not be rewarded if they exit an incentivized ad early.
VungleAdConfig
  incentivizedCancelDialogTitle : String
The custom title for the popup dialog warning the user that they will not be rewarded if they exit an incentivized ad early.
VungleAdConfig
  incentivizedUserId : String
The user name or ID in your application that will be rewarded for an incentivized view.
VungleAdConfig
  orientation : int
The orientation of the video ad.
VungleAdConfig
  soundEnabled : Boolean
Indicates whether the video will start with its sound matching the settings of your enclosing application (the default) or muted.
VungleAdConfig
Public Methods
 MethodDefined By
  
Creates a new instance of the class.
VungleAdConfig
Property Detail
backButtonImmediatelyEnabledproperty
public var backButtonImmediatelyEnabled:Boolean

Pressing the Android back button during a video ad by default has the same effect as pressing the on screen close button once it appears. However, if this option is set, it enables the user to exit the video at any time by pressing the back button.

The default value is false.

extra1property 
public var extra1:String

The first developer-defined extra configuration value.

The default value is null.

extra2property 
public var extra2:String

The second developer-defined extra configuration value.

The default value is null.

extra3property 
public var extra3:String

The third developer-defined extra configuration value.

The default value is null.

extra4property 
public var extra4:String

The fourth developer-defined extra configuration value.

The default value is null.

extra5property 
public var extra5:String

The fifth developer-defined extra configuration value.

The default value is null.

extra6property 
public var extra6:String

The sixth developer-defined extra configuration value.

The default value is null.

extra7property 
public var extra7:String

The seventh developer-defined extra configuration value.

The default value is null.

extra8property 
public var extra8:String

The eigth developer-defined extra configuration value.

The default value is null.

globalConfigproperty 
globalConfig:VungleAdConfig  [read-only]

Global ad configuration is a singleton instance of the VungleAdConfig class. Any new VungleAdConfig object created by the developer will contain the same set of options as the global object.


Implementation
    public static function get globalConfig():VungleAdConfig
immersiveModeproperty 
public var immersiveMode:Boolean

Indicates whether in KitKat (API level 19) and later devices immersive mode will be enabled.

The default value is false.

incentivizedCancelDialogBodyTextproperty 
public var incentivizedCancelDialogBodyText:String

The custom body text for the popup dialog warning the user that they will not be rewarded if they exit an incentivized ad early.

The default value is null.

incentivizedCancelDialogCloseButtonTextproperty 
public var incentivizedCancelDialogCloseButtonText:String

The custom cancel button text for the popup dialog warning the user that they will not be rewarded if they exit an incentivized ad early.

The default value is null.

incentivizedCancelDialogKeepWatchingButtonTextproperty 
public var incentivizedCancelDialogKeepWatchingButtonText:String

Returns the custom continue watching button text for the popup dialog warning the user that they will not be rewarded if they exit an incentivized ad early.

The default value is null.

incentivizedCancelDialogTitleproperty 
public var incentivizedCancelDialogTitle:String

The custom title for the popup dialog warning the user that they will not be rewarded if they exit an incentivized ad early.

The default value is null.

incentivizedUserIdproperty 
public var incentivizedUserId:String

The user name or ID in your application that will be rewarded for an incentivized view.

The default value is null.

orientationproperty 
public var orientation:int

The orientation of the video ad. It's possible to combine the options for different platforms using a bitwise OR | operator.

The default value is 0.

See also

soundEnabledproperty 
public var soundEnabled:Boolean

Indicates whether the video will start with its sound matching the settings of your enclosing application (the default) or muted. Note that the user can still manually mute or unmute the sound during playback.

The default value is true.

Constructor Detail
VungleAdConfig()Constructor
public function VungleAdConfig(src:VungleAdConfig = null)

Creates a new instance of the class.

Parameters
src:VungleAdConfig (default = null) — source object to copy values from. If not specified, the global configuration will be used.

See also