Last Updated on
July 15, 2022
All iOS 14 information is available on this page.
The Chartboost SDK's delegate methods allow you to exercise a greater degree of control over your integration. For example, you can:
You can view the Chartboost iOS SDK methods at your disposal in the CHBAdDelegate.h header file in the Chartboost framework. You can see many of these methods in use within the Chartboost sample project.
Click here to view iOS SDK configuration methods.
In order to receive delegate method calls you need to set the ad's delegate:
All the event objects passed as parameters in delegate method calls include an adID property. This is a string that uniquely identifies a cached ad. It might help when working with Chartboost to identify faulty creatives.
Parameter event: A cache event with info related to the cached ad.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when an ad is ready to be shown after the cache method has been called.
Example:
Description: Called after a showFromViewController: call, right before an ad is presented.
Parameter event: A show event with info related to the ad to be shown.
Discussion: Implement to be notified of when an ad is about to be presented.
Example:
Description: Called after a showFromViewController: call, either if the ad has been presented and an ad impression logged, or if the operation failed.
Parameter event: A show event with info related to the ad shown.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when the ad presentation process has finished.
Example:
Description: Called whenever the user clicks an ad to give a chance to the developer to present a confirmation gate before the click is handled.
Parameter event: A click event with info related to the ad clicked.
Parameter confirmationHandler: A block to be executed only if the return value is YES. It takes a BOOL parameter that indicates if the confirmation gate was passed or not.
Returns: YES if the handling of the triggering click should be paused for confirmation, NO if the click should be handled without confirmation.
Warning: If you return YES in your implementation make sure to execute the confirmationHandler at some point, since the ad flow will be paused until then. If you use the event's view controller to present a confirmation view make sure it has been dismissed by the time you execute the confirmationHandler.
Discussion: If you return YES it is your responsibility to implement some confirmation method that triggers the execution of the confirmationHandler. If this method is not implemented clicks will be handled without confirmation.
Example:
Description: Called after an ad has been clicked.
Parameter event: A click event with info related to the ad clicked.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when an ad has been clicked. If the click does not result into the opening of a link an error will be provided explaining why.
Example:
Description: Called when the link viewer presented as result of an ad click has been dismissed.
Parameter event: A click event with info related to the ad clicked.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when an ad click has been handled. This can mean an in-app web browser or App Store app sheet has been dismissed, or that the user came back to the app after the link was opened on an external application.
Example:
Description: Called after an ad is dismissed.
Parameter event: A dismiss event with info related to the dismissed ad.
Discussion: Implement to be notified of when an ad is no longer displayed.
Example:
Don't make cache requests inside a didCacheAd:error or your app may enter an infinite loop under some conditions like having connectivity-issues and crash.
Parameter event: A cache event with info related to the cached ad.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when an ad is ready to be shown after the cache method has been called.
Example:
Description: Called after a showFromViewController: call, right before an ad is presented.
Parameter event: A show event with info related to the ad to be shown.
Discussion: Implement to be notified of when an ad is about to be presented.
Example:
Description: Called after a showFromViewController: call, either if the ad has been presented and an ad impression logged, or if the operation failed.
Parameter event: A show event with info related to the ad shown.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when the ad presentation process has finished.
Example:
Description: Called whenever the user clicks an ad to give a chance to the developer to present a confirmation gate before the click is handled.
Parameter event: A click event with info related to the ad clicked.
Parameter confirmationHandler: A block to be executed only if the return value is YES. It takes a BOOL parameter that indicates if the confirmation gate was passed or not.
Returns: YES if the handling of the triggering click should be paused for confirmation, NO if the click should be handled without confirmation.
Warning: If you return YES in your implementation make sure to execute the confirmationHandler at some point, since the ad flow will be paused until then. If you use the event's view controller to present a confirmation view make sure it has been dismissed by the time you execute the confirmationHandler.
Discussion: If you return YES it is your responsibility to implement some confirmation method that triggers the execution of the confirmationHandler. If this method is not implemented clicks will be handled without confirmation.
Example:
Description: Called after an ad has been clicked.
Parameter event: A click event with info related to the ad clicked.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when an ad has been clicked. If the click does not result into the opening of a link an error will be provided explaining why.
Example:
Description: Called when the link viewer presented as result of an ad click has been dismissed.
Parameter event: A click event with info related to the ad clicked.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when an ad click has been handled. This can mean an in-app web browser or App Store app sheet has been dismissed, or that the user came back to the app after the link was opened on an external application.
Example:
Description: Called after an ad is dismissed.
Parameter event: A dismiss event with info related to the dismissed ad.
Discussion: Implement to be notified of when an ad is no longer displayed.
Example:
Description: Called when a rewarded ad has completed playing.
Parameter event: A reward event with info related to the ad and the reward.
Discussion: Implement to be notified when a reward is earned.
Example:
Don't make cache requests inside a didCacheAd:error or your app may enter an infinite loop under some conditions like having connectivity-issues and crash.
Parameter event: A cache event with info related to the cached ad.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when an ad is ready to be shown after the cache method has been called.
Example:
Description: Called after a showFromViewController: call, right before an ad is presented.
Parameter event: A show event with info related to the ad to be shown.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when an ad is about to be presented.
Example:
Description: Called after a showFromViewController: call, either if the ad has been presented and an ad impression logged, or if the operation failed.
Parameter event: A show event with info related to the ad shown.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when the ad presentation process has finished.
Example:
Description: Called whenever the user clicks an ad to give a chance to the developer to present a confirmation gate before the click is handled.
Parameter event: A click event with info related to the ad clicked.
Parameter confirmationHandler: A block to be executed only if the return value is YES. It takes a BOOL parameter that indicates if the confirmation gate was passed or not.
Returns: YES if the handling of the triggering click should be paused for confirmation, NO if the click should be handled without confirmation.
Warning: If you return YES in your implementation make sure to execute the confirmationHandler at some point, since the ad flow will be paused until then. If you use the event's view controller to present a confirmation view make sure it has been dismissed by the time you execute the confirmationHandler.
Discussion: If you return YES it is your responsibility to implement some confirmation method that triggers the execution of the confirmationHandler. If this method is not implemented clicks will be handled without confirmation.
Example:
Description: Called after an ad has been clicked.
Parameter event: A click event with info related to the ad clicked.
Parameter error: An error specifying the failure reason, or nil if the operation was successful.
Discussion: Implement to be notified of when an ad has been clicked. If the click does not result into the opening of a link an error will be provided explaining why.
Example:
Learn more about Chartboost banner ads here.
