com.iab.omid.library.adsession

Class AdSessionContext

java.lang.Object

com.iab.omid.library.adsession.AdSessionContext

public final class AdSessionContext
extends java.lang.Object

This class will provide the ad session both details of the partner and whether this is considered HTML or native.

Created by Natasha Garner on 01/08/2017.

Method Summary

Modifier and Type	Method and Description
static AdSessionContext	createHtmlAdSessionContext(Partner partner, android.webkit.WebView webView, java.lang.String customReferenceData) Create a new "html" ad session context.
static AdSessionContext	createNativeAdSessionContext(Partner partner, java.lang.String omidJsScriptContent, java.util.List<VerificationScriptResource> verificationScriptResources, java.lang.String customReferenceData) Create a new "native" ad session context.
com.iab.omid.library.adsession.AdSessionContextType	getAdSessionContextType()
java.lang.String	getCustomReferenceData()
java.lang.String	getOmidJsScriptContent()
Partner	getPartner()
java.util.List<VerificationScriptResource>	getVerificationScriptResources()
android.webkit.WebView	getWebView()

Methods inherited from class java.lang.Object

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

Method Detail

createHtmlAdSessionContext

public static AdSessionContext createHtmlAdSessionContext(Partner partner,
                                                          android.webkit.WebView webView,
                                                          java.lang.String customReferenceData)

Create a new "html" ad session context.

Parameters:

partner - details of the integration partner responsible for the ad session

webView - responsible for serving the ad content

customReferenceData - containing reference data specific to the integration partner.

Returns:

a new HTML context instance

Throws:

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

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

java.lang.IllegalArgumentException - if customReferenceData is greater than 256 characters.

See Also:

Partner, WebView

createNativeAdSessionContext

public static AdSessionContext createNativeAdSessionContext(Partner partner,
                                                            java.lang.String omidJsScriptContent,
                                                            java.util.List<VerificationScriptResource> verificationScriptResources,
                                                            java.lang.String customReferenceData)

Create a new "native" ad session context.

Parameters:

partner - details of the integration partner responsible for the ad session

omidJsScriptContent - containing the OMID JS service content to be injected into the hidden tracking web view

verificationScriptResources - of all verification providers who expect to receive OMID event data.

customReferenceData - containing reference data specific to the integration partner.

Returns:

a new native context instance

Throws:

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

java.lang.IllegalArgumentException - if the supplied omidJsServiceContent is null or blank.

java.lang.IllegalArgumentException - if the supplied verificationScriptResources is null or empty.

java.lang.IllegalArgumentException - if customReferenceData is greater than 256 characters.

See Also:

Partner, VerificationScriptResource

getPartner

public Partner getPartner()

getVerificationScriptResources

public java.util.List<VerificationScriptResource> getVerificationScriptResources()

getWebView

public android.webkit.WebView getWebView()

getCustomReferenceData

public java.lang.String getCustomReferenceData()

getOmidJsScriptContent

public java.lang.String getOmidJsScriptContent()

getAdSessionContextType

public com.iab.omid.library.adsession.AdSessionContextType getAdSessionContextType()