com.chartboost.sdk

Class ChartboostDelegate

java.lang.Object

com.chartboost.sdk.ChartboostDelegate

All Implemented Interfaces:

AbstractChartboostDelegate

public abstract class ChartboostDelegate
extends java.lang.Object
implements AbstractChartboostDelegate

An implementation of AbstractChartboostDelegate. Extending from this instead will allow you to skip overriding the methods you are not interested in.

Constructor Summary

Constructors

Constructor and Description
ChartboostDelegate()

Method Summary

Modifier and Type	Method and Description
void	didCacheInPlay(java.lang.String location) Called after an InPlay object has been loaded from the Chartboost API servers and cached locally.
void	didCacheInterstitial(java.lang.String location) Called after an interstitial has been loaded from the Chartboost API servers and cached locally.
void	didCacheMoreApps(java.lang.String location) Deprecated. Support for MoreApps has been removed as of SDK 7.
void	didCacheRewardedVideo(java.lang.String location) Called after a rewarded video has been loaded from the Chartboost API servers and cached locally.
void	didClickInterstitial(java.lang.String location) Called after an interstitial has been clicked.
void	didClickMoreApps(java.lang.String location) Deprecated. Support for MoreApps has been removed as of SDK 7.
void	didClickRewardedVideo(java.lang.String location) Called after a rewarded video has been clicked.
void	didCloseInterstitial(java.lang.String location) Called after an interstitial has been closed.
void	didCloseMoreApps(java.lang.String location) Deprecated. Support for MoreApps has been removed as of SDK 7.
void	didCloseRewardedVideo(java.lang.String location) Called after a rewarded video has been closed.
void	didCompleteInterstitial(java.lang.String location) Called after an interstitial has been viewed completely.
void	didCompleteRewardedVideo(java.lang.String location, int reward) Called after a rewarded video has been viewed completely and user is eligible for reward.
void	didDismissInterstitial(java.lang.String location) Called after an interstitial has been dismissed.
void	didDismissMoreApps(java.lang.String location) Deprecated. Support for MoreApps has been removed as of SDK 7.
void	didDismissRewardedVideo(java.lang.String location) Called after a rewarded video has been dismissed.
void	didDisplayInterstitial(java.lang.String location) Called after an interstitial has been displayed on the screen.
void	didDisplayMoreApps(java.lang.String location) Deprecated. Support for MoreApps has been removed as of SDK 7.
void	didDisplayRewardedVideo(java.lang.String location) Called after a rewarded video has been displayed on the screen.
void	didFailToLoadInPlay(java.lang.String location, CBError.CBImpressionError error) Called after a InPlay has attempted to load from the Chartboost API servers but failed.
void	didFailToLoadInterstitial(java.lang.String location, CBError.CBImpressionError error) Called after an interstitial has attempted to load from the Chartboost API servers but failed.
void	didFailToLoadMoreApps(java.lang.String location, CBError.CBImpressionError error) Deprecated. Support for MoreApps has been removed as of SDK 7.
void	didFailToLoadRewardedVideo(java.lang.String location, CBError.CBImpressionError error) Called after a rewarded video has attempted to load from the Chartboost API servers but failed.
void	didFailToRecordClick(java.lang.String uri, CBError.CBClickError error) Called after a click is registered, but the user is not fowrwarded to the Google Play Store.
void	didInitialize() Called when the SDK is finished intializing.
boolean	shouldDisplayInterstitial(java.lang.String location) Called before an interstitial will be displayed on the screen.
boolean	shouldDisplayMoreApps(java.lang.String location) Deprecated. Support for MoreApps has been removed as of SDK 7.
boolean	shouldDisplayRewardedVideo(java.lang.String location) Called before a rewarded video will be displayed on the screen.
boolean	shouldRequestInterstitial(java.lang.String location) Called before requesting an interstitial via the Chartboost API server.
boolean	shouldRequestMoreApps(java.lang.String location) Deprecated. Support for MoreApps has been removed as of SDK 7.
void	willDisplayInterstitial(java.lang.String location) Called before the interstitial is about to be displayed on the screen.
void	willDisplayVideo(java.lang.String location) Called before the video is about to be displayed on the screen.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartboostDelegate

public ChartboostDelegate()

Method Detail

shouldRequestInterstitial

public boolean shouldRequestInterstitial(java.lang.String location)

Called before requesting an interstitial via the Chartboost API server.

Implement to control if the Chartboost SDK should fetch data from the Chartboost API servers for the given CBLocation}. This is evaluated if the Chartboost.showInterstitial(String)} orChartboost.cacheInterstitial(String)} are called. If true is returned the operation will proceed, if false, then the operation is treated as a no-op.

Specified by:

shouldRequestInterstitial in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

Returns:

true if execution should proceed, false if not. Default return is true.

shouldDisplayInterstitial

public boolean shouldDisplayInterstitial(java.lang.String location)

Called before an interstitial will be displayed on the screen.

Implement to control if the Chartboost SDK should display an interstitial for the given CBLocation}. This is evaluated if the Chartboost.showInterstitial(String)} is called. If true is returned the operation will proceed, if false, then the operation is treated as a no-op and nothing is displayed.

Specified by:

shouldDisplayInterstitial in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

Returns:

true if execution should proceed, false if not. Default return is true.

didCacheInterstitial

public void didCacheInterstitial(java.lang.String location)

Called after an interstitial has been loaded from the Chartboost API servers and cached locally.

Implement to be notified of when an interstitial has been loaded from the Chartboost API servers and cached locally for a given CBLocation}.

Specified by:

didCacheInterstitial in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didFailToLoadInterstitial

public void didFailToLoadInterstitial(java.lang.String location,
                                      CBError.CBImpressionError error)

Called after an interstitial has attempted to load from the Chartboost API servers but failed.

Implement to be notified of when an interstitial has attempted to load from the Chartboost API servers but failed for a given CBLocation}.

Specified by:

didFailToLoadInterstitial in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

error - The reason for the error defined via a CBError.CBImpressionError.

willDisplayInterstitial

public void willDisplayInterstitial(java.lang.String location)

Called before the interstitial is about to be displayed on the screen.

Specified by:

willDisplayInterstitial in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didDismissInterstitial

public void didDismissInterstitial(java.lang.String location)

Called after an interstitial has been dismissed.

Implement to be notified of when an interstitial has been dismissed for a given CBLocation}. "Dismissal" is defined as any action that removed the interstitial UI such as a click or close.

Specified by:

didDismissInterstitial in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didCloseInterstitial

public void didCloseInterstitial(java.lang.String location)

Called after an interstitial has been closed.

Implement to be notified of when an interstitial has been closed for a given CBLocation}. "Closed" is defined as clicking the close interface for the interstitial.

Specified by:

didCloseInterstitial in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didClickInterstitial

public void didClickInterstitial(java.lang.String location)

Called after an interstitial has been clicked.

Implement to be notified of when an interstitial has been click for a given CBLocation}. "Clicked" is defined as clicking the creative interface for the interstitial.

Specified by:

didClickInterstitial in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didCompleteInterstitial

public void didCompleteInterstitial(java.lang.String location)

Called after an interstitial has been viewed completely.

Implement to be notified of when an interstitial has been viewed completely.

Specified by:

didCompleteInterstitial in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didDisplayInterstitial

public void didDisplayInterstitial(java.lang.String location)

Called after an interstitial has been displayed on the screen.

Implement to be notified of when an interstitial has been displayed on the screen for a given CBLocation}.

Specified by:

didDisplayInterstitial in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

shouldRequestMoreApps

public boolean shouldRequestMoreApps(java.lang.String location)

Deprecated. Support for MoreApps has been removed as of SDK 7.

Called before requesting more apps from the back-end. Only useful to prevent an ad from being implicitly displayed on fast app switching.

Specified by:

shouldRequestMoreApps in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

Returns:

whether to request an interstitial

didCacheMoreApps

public void didCacheMoreApps(java.lang.String location)

Deprecated. Support for MoreApps has been removed as of SDK 7.

Called after an "more applications" has been loaded from the Chartboost API servers and cached locally.

Implement to be notified of when an "more applications" has been loaded from the Chartboost API servers and cached locally for a given CBLocation}.

Specified by:

didCacheMoreApps in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

shouldDisplayMoreApps

public boolean shouldDisplayMoreApps(java.lang.String location)

Deprecated. Support for MoreApps has been removed as of SDK 7.

Called before an "more applications" will be displayed on the screen.

Implement to control if the Charboost SDK should display an "more applications" for the given CBLocation. This is evaluated if the Chartboost.showMoreApps(String) is called. If true is returned the operation will proceed, if false, then the operation is treated as a no-op and nothing is displayed.

Specified by:

shouldDisplayMoreApps in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

Returns:

true if execution should proceed, false if not. Default return is true.

didFailToLoadMoreApps

public void didFailToLoadMoreApps(java.lang.String location,
                                  CBError.CBImpressionError error)

Deprecated. Support for MoreApps has been removed as of SDK 7.

Called after an "more applications" has attempted to load from the Chartboost API servers but failed.

Implement to be notified of when an "more applications" has attempted to load from the Chartboost API servers but failed for a given CBLocation.

Specified by:

didFailToLoadMoreApps in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

error - The reason for the error defined via a CBError.CBImpressionError}.

didDismissMoreApps

public void didDismissMoreApps(java.lang.String location)

Deprecated. Support for MoreApps has been removed as of SDK 7.

Called after an "more applications" has been dismissed.

Implement to be notified of when an "more applications" has been dismissed for a given CBLocation}. "Dismissal" is defined as any action that removed the "more applications" UI such as a click or close.

Specified by:

didDismissMoreApps in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didCloseMoreApps

public void didCloseMoreApps(java.lang.String location)

Deprecated. Support for MoreApps has been removed as of SDK 7.

Called after an "more applications" has been closed.

Implement to be notified of when an "more applications" has been closed for a given CBLocation. "Closed" is defined as clicking the close interface for the "more applications".

Specified by:

didCloseMoreApps in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didClickMoreApps

public void didClickMoreApps(java.lang.String location)

Deprecated. Support for MoreApps has been removed as of SDK 7.

Called after an "more applications" has been clicked.

Implement to be notified of when an "more applications" has been click for a given CBLocation. "Clicked" is defined as clicking the creative interface for the "more applications".

Specified by:

didClickMoreApps in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didDisplayMoreApps

public void didDisplayMoreApps(java.lang.String location)

Deprecated. Support for MoreApps has been removed as of SDK 7.

Called after an "more applications" has been displayed on the screen.

Implement to be notified of when an "more applications" has been displayed on the screen for a given CBLocation}.

Specified by:

didDisplayMoreApps in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didFailToRecordClick

public void didFailToRecordClick(java.lang.String uri,
                                 CBError.CBClickError error)

Called after a click is registered, but the user is not fowrwarded to the Google Play Store.

Implement to be notified of when a click is registered, but the user is not fowrwarded to the Google Play Store for a given CBLocation}.

Specified by:

didFailToRecordClick in interface AbstractChartboostDelegate

Parameters:

uri - The location for the Chartboost impression type.

error - The reason for the error defined via a CBError.CBClickError}.

shouldDisplayRewardedVideo

public boolean shouldDisplayRewardedVideo(java.lang.String location)

Called before a rewarded video will be displayed on the screen.

Implement to control if the Charboost SDK should display a rewarded video for the given CBLocation. This is evaluated if the Chartboost.showRewardedVideo(String) is called. If true is returned the operation will proceed, if false, then the operation is treated as a no-op and nothing is displayed.

Specified by:

shouldDisplayRewardedVideo in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

Returns:

true if execution should proceed, false if not. Default return is true.

didCacheRewardedVideo

public void didCacheRewardedVideo(java.lang.String location)

Called after a rewarded video has been loaded from the Chartboost API servers and cached locally.

Implement to be notified of when a rewarded video has been loaded from the Chartboost API servers and cached locally for a given CBLocation.

Specified by:

didCacheRewardedVideo in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didFailToLoadRewardedVideo

public void didFailToLoadRewardedVideo(java.lang.String location,
                                       CBError.CBImpressionError error)

Called after a rewarded video has attempted to load from the Chartboost API servers but failed.

Implement to be notified of when an rewarded video has attempted to load from the Chartboost API servers but failed for a given CBLocation}.

Specified by:

didFailToLoadRewardedVideo in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

error - The reason for the error defined via a CBError.CBImpressionError}.

didDismissRewardedVideo

public void didDismissRewardedVideo(java.lang.String location)

Called after a rewarded video has been dismissed.

Implement to be notified of when a rewarded video has been dismissed for a given CBLocation}. "Dismissal" is defined as any action that removed the rewarded video UI such as a click or close.

Specified by:

didDismissRewardedVideo in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didCloseRewardedVideo

public void didCloseRewardedVideo(java.lang.String location)

Called after a rewarded video has been closed.

Implement to be notified of when a rewarded video has been closed for a given CBLocation. "Closed" is defined as clicking the close interface for the rewarded video.

Specified by:

didCloseRewardedVideo in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didClickRewardedVideo

public void didClickRewardedVideo(java.lang.String location)

Called after a rewarded video has been clicked.

Implement to be notified of when a rewarded video has been click for a given CBLocation. "Clicked" is defined as clicking the creative interface for the rewarded video.

Specified by:

didClickRewardedVideo in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didCompleteRewardedVideo

public void didCompleteRewardedVideo(java.lang.String location,
                                     int reward)

Called after a rewarded video has been viewed completely and user is eligible for reward.

Implement to be notified of when a rewarded video has been viewed completely and user is eligible for reward.

Specified by:

didCompleteRewardedVideo in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

reward - The reward for watching the video.

didDisplayRewardedVideo

public void didDisplayRewardedVideo(java.lang.String location)

Called after a rewarded video has been displayed on the screen.

Implement to be notified of when a rewarded video has been displayed on the screen for a given CBLocation.

Specified by:

didDisplayRewardedVideo in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

willDisplayVideo

public void willDisplayVideo(java.lang.String location)

Called before the video is about to be displayed on the screen.

Specified by:

willDisplayVideo in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didCacheInPlay

public void didCacheInPlay(java.lang.String location)

Called after an InPlay object has been loaded from the Chartboost API servers and cached locally.

Implement to be notified of when an InPlay object has been loaded from the Chartboost API servers and cached locally for a given CBLocation}.

Specified by:

didCacheInPlay in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

didFailToLoadInPlay

public void didFailToLoadInPlay(java.lang.String location,
                                CBError.CBImpressionError error)

Called after a InPlay has attempted to load from the Chartboost API servers but failed.

Implement to be notified of when an InPlay has attempted to load from the Chartboost API servers but failed for a given CBLocation}.

Specified by:

didFailToLoadInPlay in interface AbstractChartboostDelegate

Parameters:

location - The location for the Chartboost impression type.

error - The reason for the error defined via a CBError.CBImpressionError}.

didInitialize

public void didInitialize()

Called when the SDK is finished intializing.

Specified by:

didInitialize in interface AbstractChartboostDelegate