AdGem (library 2.5.0 API)

java.lang.Object
- com.adgem.android.AdGem

```
public abstract class AdGem
extends java.lang.Object
```
Main entry point for communications with AdGem SDK. Use get() to acquire instance of this class.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AdGem.State

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AdGem.State`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`STATE_DISABLED` Identifies that the component owning this state was disabled by the SDK configuration or server.
`static int`	`STATE_DOWNLOADING`
`static int`	`STATE_ERROR` Identifies that an error occurred.
`static int`	`STATE_INITIALIZING` Identifies that data is in initializing.
`static int`	`STATE_NEEDS_CAMPAIGN_REFRESH`
`static int`	`STATE_NEEDS_DOWNLOAD`
`static int`	`STATE_NEEDS_INITIALIZATION` Identifies that data is in unknown state and needs initialization.
`static int`	`STATE_READY`
`static int`	`STATE_REFRESHING_CAMPAIGN`

Constructor Summary

Constructors
Constructor and Description

AdGem()

Constructors
Constructor and Description
`AdGem()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static AdGem`	`get()` Obtains global instance of the AdGem framework.
`abstract Error`	`getError()` Returns last known error.
`abstract int`	`getInterstitialAdState()`
`abstract int`	`getOfferWallState()` Gets detailed state of the offer wall
`abstract int`	`getRewardedAdState()`
`boolean`	`isInterstitialAdReady()` Identifies whether AdGem is ready to show an interstitial advertisement via `showInterstitialAd(Context)`.
`abstract boolean`	`isOfferWallReady()` Identifies whether AdGem is ready to show offer wall via the `showOfferWall(Context)`}.
`boolean`	`isRewardedAdReady()` Identifies whether AdGem is ready to show a rewarded advertisement via `showRewardedAd(Context)`.
`abstract void`	`registerCallback(AdGemCallback callback)` Registers callback to receive AdGem SDK events.
`abstract void`	`registerOfferWallCallback(OfferWallCallback callback)` Registers callback to receive updates about the offer wall.
`abstract void`	`setPlayerMetaData(PlayerMetadata metaData)` Sets additional metadata specific to the user of this application.
`abstract void`	`showInterstitialAd(android.content.Context context)` Shows interstitial advertisement.
`abstract void`	`showOfferWall(android.content.Context context)` Shows offer wall.
`abstract void`	`showRewardedAd(android.content.Context context)` Shows rewarded advertisement.
`abstract void`	`unregisterCallback(AdGemCallback callback)` Unregisters AdGem events callback.
`abstract void`	`unregisterOfferWallCallback(OfferWallCallback callback)` Unregisters AdGem events callback.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STATE_ERROR
```
public static final int STATE_ERROR
```
    Identifies that an error occurred. AdGem will attempt to recover from error automatically. Last known error is available via getError().
    
    See Also:
    
    Constant Field Values
  - STATE_DISABLED
```
public static final int STATE_DISABLED
```
    Identifies that the component owning this state was disabled by the SDK configuration or server.
    
    See Also:
    
    Constant Field Values
  - STATE_NEEDS_INITIALIZATION
```
public static final int STATE_NEEDS_INITIALIZATION
```
    Identifies that data is in unknown state and needs initialization.
    
    See Also:
    
    Constant Field Values
  - STATE_INITIALIZING
```
public static final int STATE_INITIALIZING
```
    Identifies that data is in initializing.
    
    See Also:
    
    Constant Field Values
  - STATE_NEEDS_CAMPAIGN_REFRESH
```
public static final int STATE_NEEDS_CAMPAIGN_REFRESH
```
    See Also:
    
    Constant Field Values
  - STATE_REFRESHING_CAMPAIGN
```
public static final int STATE_REFRESHING_CAMPAIGN
```
    See Also:
    
    Constant Field Values
  - STATE_NEEDS_DOWNLOAD
```
public static final int STATE_NEEDS_DOWNLOAD
```
    See Also:
    
    Constant Field Values
  - STATE_DOWNLOADING
```
public static final int STATE_DOWNLOADING
```
    See Also:
    
    Constant Field Values
  - STATE_READY
```
public static final int STATE_READY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AdGem
```
public AdGem()
```
- Method Detail
  - get
```
public static AdGem get()
```
    Obtains global instance of the AdGem framework.
  - isInterstitialAdReady
```
public boolean isInterstitialAdReady()
```
    Identifies whether AdGem is ready to show an interstitial advertisement via showInterstitialAd(Context).
    
    Returns:
    
    true if AdGem is ready to show next ad, false otherwise.
  - getInterstitialAdState
```
public abstract int getInterstitialAdState()
```
  - isRewardedAdReady
```
public boolean isRewardedAdReady()
```
    Identifies whether AdGem is ready to show a rewarded advertisement via showRewardedAd(Context).
    
    Returns:
    
    true if AdGem is ready a rewarded ad, false otherwise.
  - getRewardedAdState
```
public abstract int getRewardedAdState()
```
  - isOfferWallReady
```
public abstract boolean isOfferWallReady()
```
    Identifies whether AdGem is ready to show offer wall via the showOfferWall(Context)}.
    
    Returns:
    
    true if AdGem is ready to show offer wall, false otherwise.
    
    See Also:
    
    registerOfferWallCallback(OfferWallCallback)
  - getOfferWallState
```
public abstract int getOfferWallState()
```
    Gets detailed state of the offer wall
    
    Returns:
    
    offer wall state as defined in AdGem.State
    
    See Also:
    
    registerOfferWallCallback(OfferWallCallback)
  - registerCallback
```
public abstract void registerCallback(AdGemCallback callback)
```
    Registers callback to receive AdGem SDK events. Each registered callback will receive corresponding events.
    
    Parameters:
    
    callback - instance of callback interface to receive events from AdGem. All events will be delivered on a main thread. Reference to this callback will be kept internally until unregistered via unregisterCallback(AdGemCallback).
    
    See Also:
    
    to receive offer wall events., unregisterCallback(AdGemCallback)
  - unregisterCallback
```
public abstract void unregisterCallback(AdGemCallback callback)
```
    Unregisters AdGem events callback.
    
    Parameters:
    
    callback - instance of AdGemCallback previously registered via registerCallback(AdGemCallback).
    
    See Also:
    
    unregisterCallback(AdGemCallback), unregisterOfferWallCallback(OfferWallCallback)
  - registerOfferWallCallback
```
public abstract void registerOfferWallCallback(OfferWallCallback callback)
```
    Registers callback to receive updates about the offer wall. Each registered callback will receive corresponding events.
    
    Parameters:
    
    callback - instance of callback to receive offer wall events from AdGem. All events will be delivered on a main thread. Reference to this callback will be kept internally until unregistered via unregisterOfferWallCallback(OfferWallCallback).
    
    See Also:
    
    to receive other AdGem events, unregisterOfferWallCallback(OfferWallCallback)
  - unregisterOfferWallCallback
```
public abstract void unregisterOfferWallCallback(OfferWallCallback callback)
```
    Unregisters AdGem events callback.
    
    Parameters:
    
    callback - instance of OfferWallCallback previously registered via registerOfferWallCallback(OfferWallCallback).
  - showInterstitialAd
```
public abstract void showInterstitialAd(android.content.Context context)
```
    Shows interstitial advertisement. AdGem will notify about completion via AdGemCallback.onInterstitialAdClosed().
    If interstitial ad is not in ready state, then nothing is shown.
    
    Throws:
    
    java.lang.IllegalStateException - if AdGem was not configured to serve interstitial ads.
  - showRewardedAd
```
public abstract void showRewardedAd(android.content.Context context)
```
    Shows rewarded advertisement. AdGem will notify about completion via AdGemCallback.onRewardedAdComplete().
    If a rewarded ad is not in ready state, then nothing is shown.
    
    Throws:
    
    java.lang.IllegalStateException - if AdGem was not configured to serve rewarded ads.
  - showOfferWall
```
public abstract void showOfferWall(android.content.Context context)
```
    Shows offer wall. Offer wall status callbacks (including even when offer wall is closed) will be delivered via the OfferWallCallback.
  - getError
```
public abstract Error getError()
```
    Returns last known error.
    
    Returns:
    
    last known error. Error state is notified via one of AdGemCallback.onOfferWallStateChanged(int), AdGemCallback.onInterstitialAdStateChanged(int) or AdGemCallback.onRewardedAdStateChanged(int).
  - setPlayerMetaData
```
public abstract void setPlayerMetaData(PlayerMetadata metaData)
```
    Sets additional metadata specific to the user of this application.
    
    Parameters:
    
    metaData - extra information about the player.
    
    See Also:
    
    for additional fields.

Class AdGem

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATE_ERROR

STATE_DISABLED

STATE_NEEDS_INITIALIZATION

STATE_INITIALIZING

STATE_NEEDS_CAMPAIGN_REFRESH

STATE_REFRESHING_CAMPAIGN

STATE_NEEDS_DOWNLOAD

STATE_DOWNLOADING

STATE_READY

Constructor Detail

AdGem

Method Detail

get

isInterstitialAdReady

getInterstitialAdState

isRewardedAdReady

getRewardedAdState

isOfferWallReady

getOfferWallState

registerCallback

unregisterCallback

registerOfferWallCallback

unregisterOfferWallCallback

showInterstitialAd

showRewardedAd

showOfferWall

getError

setPlayerMetaData