com.adcolony.sdk

Class AdColonyAdOptions

java.lang.Object

com.adcolony.sdk.AdColonyAdOptions

public class AdColonyAdOptions
extends java.lang.Object

An optional object developers can pass to AdColony.requestInterstitial(String, AdColonyInterstitialListener, AdColonyAdOptions). Used to set various options such as the use of confirmation and result dialogs for rewarded ads. Extra information, such as various user metadata, can also be sent with this object which may improve ad targeting.

Constructor Summary

Constructors

Constructor and Description
AdColonyAdOptions()

Method Summary

Modifier and Type	Method and Description
AdColonyAdOptions	enableConfirmationDialog(boolean confirmation_enabled) Enables or disables the confirmation dialog for rewarded interstitials, which will prompt the user before displaying the ad.
AdColonyAdOptions	enableResultsDialog(boolean results_enabled) Enables or disables the results dialog for rewarded interstitials.
java.lang.Object	getOption(java.lang.String key) Used to retrieve an arbitrary option with the given key.
AdColonyUserMetadata	getUserMetadata() Used to retrieve the currently set user metadata.
AdColonyAdOptions	setOption(java.lang.String key, boolean value) Optionally set an arbitrary key/value definition
AdColonyAdOptions	setOption(java.lang.String key, double value) Optionally set an arbitrary key/value definition
AdColonyAdOptions	setOption(java.lang.String key, java.lang.String value) Optionally set an arbitrary key/value definition
AdColonyAdOptions	setUserMetadata(AdColonyUserMetadata metadata) Used to send AdColony extra information about this user.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdColonyAdOptions

public AdColonyAdOptions()

Method Detail

enableConfirmationDialog

public AdColonyAdOptions enableConfirmationDialog(boolean confirmation_enabled)

Enables or disables the confirmation dialog for rewarded interstitials, which will prompt the user before displaying the ad.

Parameters:

confirmation_enabled - whether or not you'd like the confirmation dialog to be enabled.

Returns:

'this' for chaining calls.

enableResultsDialog

public AdColonyAdOptions enableResultsDialog(boolean results_enabled)

Enables or disables the results dialog for rewarded interstitials. The results dialog will appear after the ad is closed. For server-side reward enabled zones, the actual reward is asynchronous so the dialog may appear before a reward was granted.

Parameters:

results_enabled - whether or not you'd like the results dialog to be enabled.

Returns:

'this' for chaining calls.

setOption

public AdColonyAdOptions setOption(@NonNull
                                   java.lang.String key,
                                   boolean value)

Optionally set an arbitrary key/value definition

Parameters:

key - the key for this option mapping.

value - the value for this option mapping.

Returns:

'this' for chaining calls.

getOption

public java.lang.Object getOption(@NonNull
                                  java.lang.String key)

Used to retrieve an arbitrary option with the given key.

Parameters:

key - the key of the option you wish to retrieve.

Returns:

the value mapped to the provided key, or false if the mapping does not exist.

setOption

public AdColonyAdOptions setOption(@NonNull
                                   java.lang.String key,
                                   double value)

Optionally set an arbitrary key/value definition

Parameters:

key - the key for this option mapping.

value - the value for this option mapping.

Returns:

'this' for chaining calls.

setOption

public AdColonyAdOptions setOption(@NonNull
                                   java.lang.String key,
                                   @NonNull
                                   java.lang.String value)

Optionally set an arbitrary key/value definition

Parameters:

key - the key for ths option mapping.

value - the value for this option mapping.

Returns:

'this' for chaining calls.

setUserMetadata

public AdColonyAdOptions setUserMetadata(@NonNull
                                         AdColonyUserMetadata metadata)

Used to send AdColony extra information about this user.

Parameters:

metadata - the AdColonyUserMetadata object to send.

Returns:

'this' for chaining calls.

See Also:

AdColonyUserMetadata

getUserMetadata

public AdColonyUserMetadata getUserMetadata()

Used to retrieve the currently set user metadata.

Returns:

the currently set AdColonyUserMetadata object. Will return null if it has not been set.

See Also:

AdColonyUserMetadata