com.iab.omid.library

Class Omid

java.lang.Object

com.iab.omid.library.Omid

public final class Omid
extends java.lang.Object

This application level class will be called by all integration partners to ensure OMID has
been activated before calling any other API methods.
Any attempt to use other API methods prior to activation will result in an exception.

Note that OM SDK may only be used on the main UI thread. Make sure you are on the main thread when you initialize the SDK, create its objects, and invoke its methods.

Created by Natasha Garner on 20/06/2017.

Method Summary

Modifier and Type	Method and Description
static boolean	activateWithOmidApiVersion(java.lang.String version, android.content.Context applicationContext) Enables the integration partner to activate OMID prior to calling any other API methods.
static java.lang.String	getVersion() Access the running OMID library semantic version.
static boolean	isActive() Used to determine if the running OMID library is active before attempting to create any ad sessions.
static boolean	isCompatibleWithOmidApiVersion(java.lang.String version) Allows the integration partner to check that they are compatible with the running OMID library version.

Methods inherited from class java.lang.Object

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

Method Detail

isCompatibleWithOmidApiVersion

public static boolean isCompatibleWithOmidApiVersion(java.lang.String version)

Allows the integration partner to check that they are compatible with the running OMID library version.

Parameters:

version - of OMID library integrated by the partner.

Returns:

true if the version supplied is compatible with the integrated OMID library version.

Throws:

java.lang.IllegalArgumentException - if the supplied version parameter is null, blank or an invalid semantic version number.

getVersion

public static java.lang.String getVersion()

Access the running OMID library semantic version.

Returns:

the current semantic version of the integrated OMID library.

isActive

public static boolean isActive()

Used to determine if the running OMID library is active before attempting to create any ad sessions.

Returns:

true if the OMID library has already been activated.

activateWithOmidApiVersion

public static boolean activateWithOmidApiVersion(java.lang.String version,
                                                 android.content.Context applicationContext)

Enables the integration partner to activate OMID prior to calling any other API methods.

Parameters:

version - of OMID library integrated by the partner.

applicationContext - of the running application.

Returns:

true if activation was successful when checking the supplied version number for compatibility.

Throws:

java.lang.IllegalArgumentException - if the supplied version parameter is null, blank or an invalid semantic version number.

java.lang.IllegalArgumentException - if the supplied application context is null.