com.distriqt.extension.ironsource.IronSource

	Property	Defined By
		implementation : String [read-only] The implementation currently in use.	IronSource
		instance : IronSource [static] [read-only] The singleton instance of the IronSource class.	IronSource
		isSupported : Boolean [static] [read-only] Whether the current device supports the extensions functionality	IronSource
		nativeVersion : String [read-only] The native version string of the native extension.	IronSource
		service : IronSource [static] [read-only] The singleton instance of the IronSource class.	IronSource
		version : String [read-only] The version of this extension.	IronSource

	Method	Defined By
		IronSource() Constructor You should not call this directly, but instead use the singleton access	IronSource
		authorisationStatus():String Returns the current authorisation status of the device.	IronSource
		destroyBanner():void	IronSource
		displayBanner():void	IronSource
		dispose():void Disposes the extension and releases any allocated resources.	IronSource
		getAdvertiserId():String	IronSource
		getOfferwallCredits():void Starts a query to retrieve the current user's credits.	IronSource
		hideBanner():void	IronSource
		init(appKey:String, adUnits:Array = null):void	IronSource
		isInterstitialReady():Boolean	IronSource
		isOfferwallAvailable():Boolean	IronSource
		isRewardedVideoAvailable():Boolean	IronSource
		isRewardedVideoCappedForPlacement(placementName:String):Boolean	IronSource
		loadBanner(size:IronSourceBannerSize, position:int, placementName:String):void	IronSource
		loadInterstitial():void	IronSource
		onPause():void	IronSource
		onResume():void	IronSource
		registerAppForAdNetworkAttribution():void	IronSource
		requestAuthorisation(callback:Function = null):Boolean This function triggers the authorisation request dialog.	IronSource
		setAdaptersDebug(enabled:Boolean):void When set to true, this will enable debug logs to help you troubleshoot issues with all of your mediation ad networks.	IronSource
		setConsent(granted:Boolean):void	IronSource
		setDynamicUserId(dynamicUserId:String):Boolean	IronSource
		setIronSourceClientSideCallbacks(status:Boolean):void Set whether IronSource will automatically trigger the OfferwallEvent.AD_CREDITED event when the user's credit status changes.	IronSource
		setIronSourceOfferwallCustomParams(paramsJson:String):void	IronSource
		setMetaData(param:String, value:String):void Set any meta data values.	IronSource
		setUserId(userId:String):Boolean If you’re serving the offerwall ad unit or using server-to-server callbacks to reward your users with ironSource SDK rewarded ad units, you must define a unique identifier for each user (“UserID”), using the setUserId method.	IronSource
		showInterstitial(placementName:String = null):void	IronSource
		showOfferwall(placementName:String = null):void Show the offerwall (if available).	IronSource
		showRewardedVideo(placementName:String = null):void	IronSource
		validateIntegration():void	IronSource

	Event	Summary	Defined By
		onImpressionDataDidSucceed	Dispatched when the ad was displayed successfully and the impression data was recorded.	IronSource

	Constant	Defined By
		BANNER : String = banner [static]	IronSource
		EXT_CONTEXT_ID : String = com.distriqt.IronSource [static]	IronSource
		INTERSTITIAL : String = interstitial [static]	IronSource
		OFFERWALL : String = offerwall [static]	IronSource
		POSITION_BOTTOM : int = 2 [static] Banner will be positioned at the bottom center of the screen	IronSource
		POSITION_TOP : int = 1 [static] Banner will be positioned at the top center of the screen	IronSource
		REWARDED_VIDEO : String = rewardedvideo [static]	IronSource
		VERSION : String = 5.1.0 [static]	IronSource

Property Detail

implementation

property

implementation:String [read-only]

The implementation currently in use. This should be one of the following depending on the platform in use and the functionality supported by this extension:

Android
iOS
default
unknown

Implementation
public function get implementation():String

instance

property

instance:IronSource [read-only]

The singleton instance of the IronSource class.

Implementation
public static function get instance():IronSource

Throws

Error — If there was a problem creating or accessing the extension, or if the key is invalid

isSupported

property

isSupported:Boolean [read-only]

Whether the current device supports the extensions functionality

Implementation
public static function get isSupported():Boolean

nativeVersion

property

nativeVersion:String [read-only]

The native version string of the native extension.

Implementation
public function get nativeVersion():String

service

property

service:IronSource [read-only]

The singleton instance of the IronSource class.

Implementation
public static function get service():IronSource

Throws

Error — If there was a problem creating or accessing the extension, or if the key is invalid

version

property

version:String [read-only]

The version of this extension.

This should be of the format, MAJOR.MINOR.BUILD

Implementation
public function get version():String

Constructor Detail

IronSource

()

Constructor

public function IronSource()

Constructor You should not call this directly, but instead use the singleton access

Method Detail

authorisationStatus

()

method

public function authorisationStatus():String

Returns the current authorisation status of the device. This status indicates whether the user has authorised or denied access to notifications. The NOT_DETERMINED status is returned when your application is first installed and you have not yet requested authorisation.

Returns

String — A value from the TrackingAuthorisationStatus constants

See also

TrackingAuthorisationStatus

destroyBanner

()

method

public function destroyBanner():void

displayBanner

()

method

public function displayBanner():void

dispose

()

method

public function dispose():void

Disposes the extension and releases any allocated resources. Once this function has been called, a call to init is neccesary again before any of the extensions functionality will work.

getAdvertiserId

()

method

public function getAdvertiserId():String

Returns

String

getOfferwallCredits

()

method

public function getOfferwallCredits():void

Starts a query to retrieve the current user's credits. Will dispatch a OfferwallEvent.AD_CREDITED on complete with the details of the user's credits.

hideBanner

()

method

public function hideBanner():void

init

()

method

public function init(appKey:String, adUnits:Array = null):void

Parameters

	`appKey:String`

	`adUnits:Array` (default = `null`)

isInterstitialReady

()

method

public function isInterstitialReady():Boolean

Returns

Boolean

isOfferwallAvailable

()

method

public function isOfferwallAvailable():Boolean

Returns

Boolean — true if the offerwall is available

isRewardedVideoAvailable

()

method

public function isRewardedVideoAvailable():Boolean

Returns

Boolean

isRewardedVideoCappedForPlacement

()

method

public function isRewardedVideoCappedForPlacement(placementName:String):Boolean

Parameters

placementName:String

Returns

Boolean

loadBanner

()

method

public function loadBanner(size:IronSourceBannerSize, position:int, placementName:String):void

Parameters

	`size:IronSourceBannerSize`

	`position:int`

	`placementName:String`

loadInterstitial

()

method

public function loadInterstitial():void

onPause

()

method

public function onPause():void

onResume

()

method

public function onResume():void

registerAppForAdNetworkAttribution

()

method

public function registerAppForAdNetworkAttribution():void

requestAuthorisation

()

method

public function requestAuthorisation(callback:Function = null):Boolean

This function triggers the authorisation request dialog. This dialog will only be displayed once to a user on iOS so make sure you have adequately informed your user why you are requesting authorisation.

Parameters

callback:Function (default = null)

Returns

Boolean — true if the request was started successfully and false otherwise

setAdaptersDebug

()

method

public function setAdaptersDebug(enabled:Boolean):void

When set to true, this will enable debug logs to help you troubleshoot issues with all of your mediation ad networks. Remove this call before your app goes live with your ad units!

Parameters

enabled:Boolean — Enable debug log outputs for mediation networks

setConsent

()

method

public function setConsent(granted:Boolean):void

Parameters

granted:Boolean

setDynamicUserId

()

method

public function setDynamicUserId(dynamicUserId:String):Boolean

Parameters

dynamicUserId:String

Returns

Boolean

setIronSourceClientSideCallbacks

()

method

public function setIronSourceClientSideCallbacks(status:Boolean):void

Set whether IronSource will automatically trigger the OfferwallEvent.AD_CREDITED event when the user's credit status changes. Important! This code MUST be implemented before calling the init.

Parameters

status:Boolean — If true client side events will be triggered automatically

setIronSourceOfferwallCustomParams

()

method

public function setIronSourceOfferwallCustomParams(paramsJson:String):void

Parameters

paramsJson:String

setMetaData

()

method

public function setMetaData(param:String, value:String):void

Set any meta data values. See the documentation for specific uses, including:

Parameters

	`param:String` — The name of the meta data parameter

	`value:String` — The value to use

setUserId

()

method

public function setUserId(userId:String):Boolean

If you’re serving the offerwall ad unit or using server-to-server callbacks to reward your users with ironSource SDK rewarded ad units, you must define a unique identifier for each user (“UserID”), using the setUserId method. Set the UserID before the init request, to make sure you avoid any data loses, related to the user. Use a unique identifier, with up to 64 alphanumeric characters Note: You should not use IDFA or GAID as identifiers, in order to ensure UserID is available and unique for all users.

Parameters

userId:String

Returns

Boolean — true if the user id was set and false if it is not supported

showInterstitial

()

method

public function showInterstitial(placementName:String = null):void

Parameters

placementName:String (default = null)

showOfferwall

()

method

public function showOfferwall(placementName:String = null):void

Show the offerwall (if available). If there is no available offerwall then this will do nothing.

Parameters

placementName:String (default = null) — (optional) placement name

showRewardedVideo

()

method

public function showRewardedVideo(placementName:String = null):void

Parameters

placementName:String (default = null)

validateIntegration

()

method

public function validateIntegration():void

Event Detail

onImpressionDataDidSucceed

Event

Event Object Type: com.distriqt.extension.ironsource.events.ImpressionDataEvent
ImpressionDataEvent.type property = com.distriqt.extension.ironsource.events.ImpressionDataEvent.SUCCESS

Dispatched when the ad was displayed successfully and the impression data was recorded. This will be reported when rewarded video or interstitial ad is opened. Or when the impression is reported on load success for banners.

Constant Detail

BANNER

Constant

public static const BANNER:String = banner

EXT_CONTEXT_ID

Constant

public static const EXT_CONTEXT_ID:String = com.distriqt.IronSource

INTERSTITIAL

Constant

public static const INTERSTITIAL:String = interstitial

OFFERWALL

Constant

public static const OFFERWALL:String = offerwall

POSITION_BOTTOM

Constant

public static const POSITION_BOTTOM:int = 2

Banner will be positioned at the bottom center of the screen

POSITION_TOP

Constant

public static const POSITION_TOP:int = 1

Banner will be positioned at the top center of the screen

REWARDED_VIDEO

Constant

public static const REWARDED_VIDEO:String = rewardedvideo

VERSION

Constant

public static const VERSION:String = 5.1.0

Fri Mar 21 2025, 04:06 PM +10:00

distriqt // IronSource Native Extension Documentation	All Packages \| All Classes \| Index \| Frames No Frames
IronSource	Properties \| Methods \| Events \| Constants

Package	com.distriqt.extension.ironsource
Class	public final class IronSource
Inheritance	IronSource flash.events.EventDispatcher