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, WebView webView, java.lang.String contentUrl, java.lang.String customReferenceData) Create a new "html" ad session context.
static AdSessionContext	createJavascriptAdSessionContext(Partner partner, WebView webView, java.lang.String contentUrl, java.lang.String customReferenceData) Create a new "javascript" ad session context.
static AdSessionContext	createNativeAdSessionContext(Partner partner, java.lang.String omidJsScriptContent, java.util.List<VerificationScriptResource> verificationScriptResources, java.lang.String contentUrl, java.lang.String customReferenceData) Create a new "native" ad session context.
AdSessionContextType	getAdSessionContextType() For OM SDK internal use only.
java.lang.String	getContentUrl()
java.lang.String	getCustomReferenceData()
java.util.Map<java.lang.String,VerificationScriptResource>	getInjectedResourcesMap() For OM SDK internal use only.
java.lang.String	getOmidJsScriptContent()
Partner	getPartner()
java.util.List<VerificationScriptResource>	getVerificationScriptResources()
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,
                                                          WebView webView,
                                                          java.lang.String contentUrl,
                                                          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

contentUrl - containing the deep link to the ad's screen.

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

createJavascriptAdSessionContext

public static AdSessionContext createJavascriptAdSessionContext(Partner partner,
                                                                WebView webView,
                                                                java.lang.String contentUrl,
                                                                java.lang.String customReferenceData)

Create a new "javascript" ad session context. This can be used when the integration renders creatives using native APIs but runs other JavaScript code in a webview, which then can also be provided here to run measurement code in.

Parameters:

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

webView - will be used for running OMSDK JS service & verification script

contentUrl - containing the deep link to the ad's screen.

customReferenceData - containing reference data specific to the integration partner.

Returns:

a new JAVASCRIPT 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 contentUrl,
                                                            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 OM SDK JS service content to be injected into the hidden tracking web view

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

contentUrl - containing the deep link to the ad's screen.

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()

getInjectedResourcesMap

public java.util.Map<java.lang.String,VerificationScriptResource> getInjectedResourcesMap()

For OM SDK internal use only.

getWebView

public WebView getWebView()

getContentUrl

public java.lang.String getContentUrl()

getCustomReferenceData

public java.lang.String getCustomReferenceData()

getOmidJsScriptContent

public java.lang.String getOmidJsScriptContent()

getAdSessionContextType

public AdSessionContextType getAdSessionContextType()

For OM SDK internal use only.