com.iab.omid.library.adsession

Class AdSessionConfiguration

java.lang.Object

com.iab.omid.library.adsession.AdSessionConfiguration

public class AdSessionConfiguration
extends java.lang.Object

Created by pharris on 11/09/2017.

Method Summary

Modifier and Type	Method and Description
static AdSessionConfiguration	createAdSessionConfiguration(com.iab.omid.library.adsession.Owner impressionOwner, com.iab.omid.library.adsession.Owner videoEventsOwner) Deprecated.
static AdSessionConfiguration	createAdSessionConfiguration(com.iab.omid.library.adsession.Owner impressionOwner, com.iab.omid.library.adsession.Owner videoEventsOwner, boolean isolateVerificationScripts) Create new ad session configuration supplying the owner for both the impression and video events.
boolean	isNativeImpressionOwner()
boolean	isNativeVideoEventsOwner()
org.json.JSONObject	toJsonObject()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createAdSessionConfiguration

public static AdSessionConfiguration createAdSessionConfiguration(com.iab.omid.library.adsession.Owner impressionOwner,
                                                                  com.iab.omid.library.adsession.Owner videoEventsOwner,
                                                                  boolean isolateVerificationScripts)

Create new ad session configuration supplying the owner for both the impression and video events. The OMID JS service will use this information to help identify where the source of these events is expected to be received.

Parameters:

impressionOwner - of whether the native or JavaScript layer should be responsible for supplying the impression event.

videoEventsOwner - of whether the native or JavaScript layer should be responsible for supplying video events. Do not set this parameter to anything other than `Owner.NONE` unless this is for a video ad session. Setting this parameter to non-null values will cause the `mediaType` passed to verification scripts to be `video`. If it's `null`, then `mediaType` will be set to `display`.

isolateVerificationScripts - When true, verification scripts are in a sandboxed iframe. When false, verification scripts have access to DOM of webview. This setting is only applicable when verification script resources are injected via the javascript session client (typically this would only be relevant for HTML video ad sessions)

Returns:

new ad session configuration instance.

Throws:

java.lang.IllegalArgumentException - if the supplied impressionOwner is null.

createAdSessionConfiguration

@Deprecated
public static AdSessionConfiguration createAdSessionConfiguration(com.iab.omid.library.adsession.Owner impressionOwner,
                                                                              com.iab.omid.library.adsession.Owner videoEventsOwner)

Deprecated.

isNativeImpressionOwner

public boolean isNativeImpressionOwner()

isNativeVideoEventsOwner

public boolean isNativeVideoEventsOwner()

toJsonObject

public org.json.JSONObject toJsonObject()