xappmedia.sdk

Class XappAds

java.lang.Object

xappmedia.sdk.XappAds

public abstract class XappAds
extends java.lang.Object

This class acts as the entry point for the XappAds interface

Constructor Summary

Constructors

Constructor and Description
XappAds()

Method Summary

Modifier and Type	Method and Description
abstract XappAdController	attach() Retrieves a XappAdController from a currently running Ad.
abstract XappAdController	attach(FragmentManager fm, int containerId) Retrieves a XappAdController from a currently running ad and attaches it to the given View.
abstract ListenAdController	listenForAd(Advertisement ad) Retrieve a controller which merely only listens for the actions in the provided ad.
abstract XappAdController	loadAd(Advertisement ad) Preload an ad that will only be audio only.
abstract XappAdController	loadAd(Advertisement ad, android.content.Context ctx) Play an interstitial ad as soon as it loaded.
abstract XappAdController	loadAd(Advertisement ad, FragmentManager fm, int containerId) Play an ad inside a Fragment which resides in the provided container.
abstract AdRequester	newRequest() Begin a new Ad request.

Methods inherited from class java.lang.Object

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

Constructor Detail

XappAds

public XappAds()

Method Detail

newRequest

public abstract AdRequester newRequest()

Begin a new Ad request.

Returns:

A requester that can be used to ad more detail to the request.

listenForAd

public abstract ListenAdController listenForAd(Advertisement ad)

Retrieve a controller which merely only listens for the actions in the provided ad.

Parameters:

ad - Ad object to listen for.

Returns:

The listen controller which can be used to start listening when ready.

attach

public abstract XappAdController attach()

Retrieves a XappAdController from a currently running Ad. This will be an AudioOnly controller which can be used to control the ad.

Returns:

A XappController that can be used to control the ad. Returns null if there is no ad currently playing.

attach

public abstract XappAdController attach(FragmentManager fm,
                                        int containerId)

Retrieves a XappAdController from a currently running ad and attaches it to the given View.

Parameters:

fm - FragmentManager to use to attach the ad.

containerId - Container ID of the View that will hold the ad.

Returns:

A XappController that can be used to control the ad. Returns null if there is no ad currently playing.

loadAd

public abstract XappAdController loadAd(Advertisement ad,
                                        FragmentManager fm,
                                        int containerId)

Play an ad inside a Fragment which resides in the provided container.

Parameters:

fm - FragmentManager that handles the Xapp Fragment

containerId - ID value of the View that will hold the Fragment.

Returns:

A controller for controlling the playing ad.

loadAd

public abstract XappAdController loadAd(Advertisement ad)

Preload an ad that will only be audio only. Pressing XappController.start() will play the ad as soon as it is successfully loaded.

Parameters:

ad - Ad to retrieve a controller for.

Returns:

A controller to play only audio ads.

loadAd

public abstract XappAdController loadAd(Advertisement ad,
                                        android.content.Context ctx)

Play an interstitial ad as soon as it loaded. Unlike #loadAd(Advertisement, Activity, int), there will not be any result returned.

Parameters:

ad - The ad to play.

ctx - Context which will start the interstitial Activity.

Returns:

A controller which can be used to start the ad. Currently the other methods like "pause", "stop", and "release" are not functional to control the Activity.