com.chartboost.sdk

Interface AbstractChartboostDelegate

All Known Implementing Classes:

ChartboostDelegate

public interface AbstractChartboostDelegate

Implement the following methods to more finely control Chartboost's behavior. If you only want to implement some of the methods (as they are all optional), consider extending from ChartboostDelegate instead.

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 forwarded to the Google Play Store.
void	didInitialize() Called when the SDK is finished initializing.
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.

Method Detail

shouldRequestInterstitial

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.

Parameters:

location - The location for the Chartboost impression type.

Returns:

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

shouldDisplayInterstitial

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.

Parameters:

location - The location for the Chartboost impression type.

Returns:

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

didCacheInterstitial

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}.

Parameters:

location - The location for the Chartboost impression type.

didFailToLoadInterstitial

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}.

Parameters:

location - The location for the Chartboost impression type.

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

willDisplayInterstitial

void willDisplayInterstitial(java.lang.String location)

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

Parameters:

location - The location for the Chartboost impression type.

didDismissInterstitial

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.

Parameters:

location - The location for the Chartboost impression type.

didCloseInterstitial

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.

Parameters:

location - The location for the Chartboost impression type.

didClickInterstitial

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.

Parameters:

location - The location for the Chartboost impression type.

didCompleteInterstitial

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.

Parameters:

location - The location for the Chartboost impression type.

didDisplayInterstitial

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}.

Parameters:

location - The location for the Chartboost impression type.

shouldRequestMoreApps

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.

Returns:

whether to request an interstitial

didCacheMoreApps

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}.

Parameters:

location - The location for the Chartboost impression type.

shouldDisplayMoreApps

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 Chartboost 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.

Parameters:

location - The location for the Chartboost impression type.

Returns:

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

didFailToLoadMoreApps

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.

Parameters:

location - The location for the Chartboost impression type.

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

didDismissMoreApps

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.

Parameters:

location - The location for the Chartboost impression type.

didCloseMoreApps

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".

Parameters:

location - The location for the Chartboost impression type.

didClickMoreApps

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".

Parameters:

location - The location for the Chartboost impression type.

didDisplayMoreApps

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}.

Parameters:

location - The location for the Chartboost impression type.

didFailToRecordClick

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

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

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

Parameters:

uri - The uri that failed to be forwarded.

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

didCacheInPlay

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}.

Parameters:

location - The location for the Chartboost impression type.

didFailToLoadInPlay

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}.

Parameters:

location - The location for the Chartboost impression type.

error - The reason for the error defined via a {@link CBImpressionError).

shouldDisplayRewardedVideo

boolean shouldDisplayRewardedVideo(java.lang.String location)

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

Implement to control if the Chartboost 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.

Parameters:

location - The location for the Chartboost impression type.

Returns:

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

didCacheRewardedVideo

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.

Parameters:

location - The location for the Chartboost impression type.

didFailToLoadRewardedVideo

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}.

Parameters:

location - The location for the Chartboost impression type.

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

didDismissRewardedVideo

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.

Parameters:

location - The location for the Chartboost impression type.

didCloseRewardedVideo

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.

Parameters:

location - The location for the Chartboost impression type.

didClickRewardedVideo

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.

Parameters:

location - The location for the Chartboost impression type.

didCompleteRewardedVideo

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.

Parameters:

location - The location for the Chartboost impression type.

reward - The reward for watching the video.

didDisplayRewardedVideo

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.

Parameters:

location - The location for the Chartboost impression type.

willDisplayVideo

void willDisplayVideo(java.lang.String location)

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

Parameters:

location - The location for the Chartboost impression type.

didInitialize

void didInitialize()

Called when the SDK is finished initializing.