| | |
| | | /* |
| | | * Chartboost.h |
| | | * Chartboost |
| | | * 6.0.0 |
| | | * 6.6.0 |
| | | * |
| | | * Copyright 2011 Chartboost. All rights reserved. |
| | | */ |
| | | |
| | | #import <Foundation/Foundation.h> |
| | | #import <UIKit/UIKit.h> |
| | | |
| | | /*! |
| | | @typedef NS_ENUM (NSUInteger, CBFramework) |
| | |
| | | Used with setFramework:(CBFramework)framework calls to set suffix for |
| | | wrapper libraries like Unity or Corona. |
| | | */ |
| | | #import <UIKit/UIKit.h> |
| | | typedef NS_ENUM(NSUInteger, CBFramework) { |
| | | /*! Unity. */ |
| | | CBFrameworkUnity, |
| | |
| | | CBFrameworkCocoonJS, |
| | | /*! Cocos2d-x. */ |
| | | CBFrameworkCocos2dx, |
| | | /*! MoPub. */ |
| | | CBFrameworkMoPub, |
| | | /*! Fyber. */ |
| | | CBFrameworkFyber, |
| | | /*! Prime31Unreal. */ |
| | | CBFrameworkPrime31Unreal, |
| | | /*! Weeby. */ |
| | | CBFrameworkWeeby |
| | | CBFrameworkWeeby, |
| | | /*! Unknown. Other */ |
| | | CBFrameworkOther |
| | | }; |
| | | |
| | | /*! |
| | |
| | | CBMediationMoPub, |
| | | /*! Supersonic */ |
| | | CBMediationSupersonic, |
| | | /*! AdMob */ |
| | | CBMediationAdMob, |
| | | /*! HyprMX */ |
| | | CBMediationHyprMX, |
| | | /*! AerServ */ |
| | | CBMediationAerServ |
| | | }; |
| | | |
| | | |
| | |
| | | */ |
| | | typedef NS_ENUM(NSUInteger, CBLoadError) { |
| | | /*! Unknown internal error. */ |
| | | CBLoadErrorInternal, |
| | | CBLoadErrorInternal = 0, |
| | | /*! Network is currently unavailable. */ |
| | | CBLoadErrorInternetUnavailable, |
| | | CBLoadErrorInternetUnavailable = 1, |
| | | /*! Too many requests are pending for that location. */ |
| | | CBLoadErrorTooManyConnections, |
| | | CBLoadErrorTooManyConnections = 2, |
| | | /*! Interstitial loaded with wrong orientation. */ |
| | | CBLoadErrorWrongOrientation, |
| | | CBLoadErrorWrongOrientation = 3, |
| | | /*! Interstitial disabled, first session. */ |
| | | CBLoadErrorFirstSessionInterstitialsDisabled, |
| | | CBLoadErrorFirstSessionInterstitialsDisabled = 4, |
| | | /*! Network request failed. */ |
| | | CBLoadErrorNetworkFailure, |
| | | CBLoadErrorNetworkFailure = 5, |
| | | /*! No ad received. */ |
| | | CBLoadErrorNoAdFound, |
| | | CBLoadErrorNoAdFound = 6, |
| | | /*! Session not started. */ |
| | | CBLoadErrorSessionNotStarted, |
| | | CBLoadErrorSessionNotStarted = 7, |
| | | /*! There is an impression already visible.*/ |
| | | CBLoadErrorImpressionAlreadyVisible = 8, |
| | | /*! User manually cancelled the impression. */ |
| | | CBLoadErrorUserCancellation, |
| | | CBLoadErrorUserCancellation = 10, |
| | | /*! No location detected. */ |
| | | CBLoadErrorNoLocationFound, |
| | | CBLoadErrorNoLocationFound = 11, |
| | | /*! Error downloading asset. */ |
| | | CBLoadErrorAssetDownloadFailure = 16, |
| | | /*! Video Prefetching is not finished */ |
| | | CBLoadErrorPrefetchingIncomplete, |
| | | /*! There is an impression already visible.*/ |
| | | CBLoadErrorImpressionAlreadyVisible |
| | | CBLoadErrorPrefetchingIncomplete = 21, |
| | | /*! Error Originating from the JS side of a Web View */ |
| | | CBLoadErrorWebViewScriptError = 22 |
| | | }; |
| | | |
| | | /*! |
| | |
| | | + (void)startWithAppId:(NSString*)appId |
| | | appSignature:(NSString*)appSignature |
| | | delegate:(id<ChartboostDelegate>)delegate; |
| | | |
| | | /*! |
| | | @abstract |
| | | Set the Chartboost Delegate |
| | | |
| | | @param del The new Chartboost Delegate for the sharedChartboost instance |
| | | |
| | | @discussion This doesn't need to be called when calling startWithAppID, only later |
| | | to switch the delegate object. |
| | | */ |
| | | + (void)setDelegate:(id<ChartboostDelegate>)del; |
| | | |
| | | |
| | | /*! |
| | | @abstract |
| | |
| | | @discussion This is an internal method used via Chartboost's Unity and Corona SDKs |
| | | to track their usage. |
| | | */ |
| | | + (void)setFrameworkVersion:(NSString*)frameworkVersion; |
| | | + (void)setFrameworkVersion:(NSString*)frameworkVersion __attribute__((deprecated("This method is deprecated, please use + (void)setChartboostWrapperVersion:(NSString*)chartboostWrapperVersion instead"))); |
| | | |
| | | /*! |
| | | @abstract |
| | | Set a custom version to append to the POST body of every request. This is useful for analytics and provides chartboost with important information. |
| | | example: [Chartboost setChartboostWrapperVersion:@"6.4.6"]; |
| | | |
| | | @param chartboostWrapperVersion The version sent as a string. |
| | | |
| | | @discussion This is an internal method used via Chartboost's Unity and Corona SDKs |
| | | to track their usage. |
| | | */ |
| | | + (void)setChartboostWrapperVersion:(NSString*)chartboostWrapperVersion; |
| | | |
| | | /*! |
| | | @abstract |
| | |
| | | @discussion This is an internal method used via Chartboost's Unity and Corona SDKs |
| | | to track their usage. |
| | | */ |
| | | + (void)setFramework:(CBFramework)framework; |
| | | + (void)setFramework:(CBFramework)framework __attribute__((deprecated("This method is deprecated, please use + (void)setFramework:(CBFramework)framework withVersion:(NSString *)version; instead"))); |
| | | |
| | | /*! |
| | | @abstract |
| | |
| | | */ |
| | | + (void)setShouldPrefetchVideoContent:(BOOL)shouldPrefetch; |
| | | |
| | | |
| | | /*! |
| | | @abstract |
| | | Returns the version of the Chartboost SDK. |
| | | */ |
| | | + (NSString*)getSDKVersion; |
| | | |
| | | |
| | | #pragma mark - Advanced Caching |
| | | |
| | | /*! |
| | |
| | | |
| | | /*! |
| | | @abstract |
| | | Close any visible chartboost impressions (interstitials, more apps, rewarded video, etc..) and the loading view (if visible) |
| | | |
| | | @discussion There are some use cases when this functionality is useful. |
| | | */ |
| | | + (void)closeImpression; |
| | | |
| | | /*! |
| | | @abstract |
| | | Set to control how the fullscreen ad units should interact with the status bar. (CBStatusBarBehaviorIgnore by default). |
| | | |
| | | @param statusBarBehavior The param to set if fullscreen video should respect the status bar. |
| | |
| | | application has the status bar enabled. |
| | | */ |
| | | + (void)setStatusBarBehavior:(CBStatusBarBehavior)statusBarBehavior; |
| | | |
| | | |
| | | /*! |
| | | @abstract |
| | | returns YES if auto IAP tracking is enabled, NO if it isn't. |
| | | |
| | | @discussion Call to check if automatic tracking of in-app purchases is enabled. |
| | | The setting is controlled by the server. |
| | | */ |
| | | + (BOOL)getAutoIAPTracking; |
| | | |
| | | |
| | | @end |
| | | |
| | |
| | | @protocol ChartboostDelegate <NSObject> |
| | | |
| | | @optional |
| | | |
| | | /*! |
| | | @abstract |
| | | Called after the SDK has been successfully initialized |
| | | |
| | | @param status The result of the initialization. YES if successful. NO if failed. |
| | | |
| | | @discussion Implement to be notified of when the initialization process has finished. |
| | | */ |
| | | |
| | | - (void)didInitialize:(BOOL)status; |
| | | |
| | | #pragma mark - Interstitial Delegate |
| | | |
| | |
| | | - (void)didFailToLoadMoreApps:(CBLocation)location |
| | | withError:(CBLoadError)error; |
| | | |
| | | #pragma mark - Video Delegate |
| | | |
| | | /*! |
| | | @abstract |
| | | Called after videos have been successfully prefetched. |
| | | |
| | | @discussion Implement to be notified of when the prefetching process has finished successfully. |
| | | */ |
| | | |
| | | - (void)didPrefetchVideos; |
| | | |
| | | #pragma mark - Rewarded Video Delegate |
| | | |
| | | /*! |
| | |
| | | Once confirmed call didPassAgeGate:(BOOL)pass to continue execution. |
| | | */ |
| | | - (void)didPauseClickForConfirmation; |
| | | |
| | | #pragma mark - Deprecated Delegate |
| | | |
| | | /*! |
| | | @abstract |
| | | Called before an "more applications" will be displayed on the screen. |
| | | |
| | | @return YES if execution should proceed, NO if not. |
| | | |
| | | @discussion Implement to control if the Charboost SDK should display an "more applications". |
| | | This is evaluated if the showMoreApps:(CBLocation) is called. If YES is returned the operation will proceed, if NO, then the |
| | | operation is treated as a no-op and nothing is displayed. |
| | | |
| | | Default return is YES. |
| | | |
| | | @deprecated This method has been deprecated and will be removed in a future version. |
| | | */ |
| | | - (BOOL)shouldDisplayMoreApps __attribute__((deprecated("As of version 4.5, use shouldDisplayMoreApps:(CBLocation)location")));; |
| | | |
| | | /*! |
| | | @abstract |
| | | Called after an "more applications" has been displayed on the screen. |
| | | |
| | | @discussion Implement to be notified of when an "more applications" has |
| | | been displayed on the screen. |
| | | |
| | | @deprecated This method has been deprecated and will be removed in a future version. |
| | | */ |
| | | - (void)didDisplayMoreApps __attribute__((deprecated("As of version 4.5, use didDisplayMoreApps:(CBLocation)location"))); |
| | | |
| | | /*! |
| | | @abstract |
| | | Called after an "more applications" has been loaded from the Chartboost API |
| | | servers and cached locally. |
| | | |
| | | @discussion Implement to be notified of when an "more applications" has been loaded from the Chartboost API |
| | | servers and cached locally. |
| | | |
| | | @deprecated This method has been deprecated and will be removed in a future version. |
| | | */ |
| | | - (void)didCacheMoreApps __attribute__((deprecated("As of version 4.5, use didCacheMoreApps:(CBLocation)location"))); |
| | | |
| | | /*! |
| | | @abstract |
| | | Called after an "more applications" has been dismissed. |
| | | |
| | | @discussion Implement to be notified of when an "more applications" has been dismissed. |
| | | "Dismissal" is defined as any action that removed the "more applications" UI such as a click or close. |
| | | |
| | | @deprecated This method has been deprecated and will be removed in a future version. |
| | | */ |
| | | - (void)didDismissMoreApps __attribute__((deprecated("As of version 4.5, use didDismissMoreApps:(CBLocation)location"))); |
| | | |
| | | /*! |
| | | @abstract |
| | | Called after an "more applications" has been closed. |
| | | |
| | | @discussion Implement to be notified of when an "more applications" has been closed. |
| | | "Closed" is defined as clicking the close interface for the "more applications". |
| | | |
| | | @deprecated This method has been deprecated and will be removed in a future version. |
| | | */ |
| | | - (void)didCloseMoreApps __attribute__((deprecated("As of version 4.5, use didCloseMoreApps:(CBLocation)location"))); |
| | | |
| | | /*! |
| | | @abstract |
| | | Called after an "more applications" has been clicked. |
| | | |
| | | @discussion Implement to be notified of when an "more applications" has been clicked. |
| | | "Clicked" is defined as clicking the creative interface for the "more applications". |
| | | |
| | | @deprecated This method has been deprecated and will be removed in a future version. |
| | | */ |
| | | - (void)didClickMoreApps __attribute__((deprecated("As of version 4.5, use didClickMoreApps:(CBLocation)location"))); |
| | | |
| | | /*! |
| | | @abstract |
| | | Called after an "more applications" has attempted to load from the Chartboost API |
| | | servers but failed. |
| | | |
| | | @param error The reason for the error defined via a CBLoadError. |
| | | |
| | | @discussion Implement to be notified of when an "more applications" has attempted to load from the Chartboost API |
| | | servers but failed. |
| | | |
| | | @deprecated This method has been deprecated and will be removed in a future version. |
| | | */ |
| | | - (void)didFailToLoadMoreApps:(CBLoadError)error __attribute__((deprecated("As of version 4.5, use didFailToLoadMoreApps:(CBLoadError)error forLocation:(CBLocation)location"))); |
| | | |
| | | /*! |
| | | @abstract |
| | | Called after an InPlay object has been loaded from the Chartboost API |
| | | servers and cached locally. |
| | | |
| | | @discussion Implement to be notified of when an InPlay object has been loaded from the Chartboost API |
| | | servers and cached locally. |
| | | |
| | | @deprecated This method has been deprecated and will be removed in a future version. |
| | | */ |
| | | - (void)didLoadInPlay __attribute__((deprecated("As of version 4.5, use didCacheInPlay:(CBLocation)location"))); |
| | | |
| | | |
| | | |
| | | @end |
| | | |