From 40838a2f0517d0a8370c7bba7bd88167459d2710 Mon Sep 17 00:00:00 2001 From: lpw Date: Tue, 15 Feb 2022 15:38:31 +0800 Subject: [PATCH] 3.9.7 --- frameworks/Chartboost.framework/Versions/A/Headers/Chartboost.h | 1099 +++++---------------------------------------------------- 1 files changed, 101 insertions(+), 998 deletions(-) diff --git a/frameworks/Chartboost.framework/Versions/A/Headers/Chartboost.h b/frameworks/Chartboost.framework/Versions/A/Headers/Chartboost.h index 9f2b52b..deb5be5 100644 --- a/frameworks/Chartboost.framework/Versions/A/Headers/Chartboost.h +++ b/frameworks/Chartboost.framework/Versions/A/Headers/Chartboost.h @@ -1,542 +1,81 @@ -/* - * Chartboost.h - * Chartboost - * 6.6.3 - * - * Copyright 2011 Chartboost. All rights reserved. - */ +// +// Chartboost.h +// Chartboost +// +// Copyright 2018 Chartboost. All rights reserved. +// #import <Foundation/Foundation.h> #import <UIKit/UIKit.h> +#import "ChartboostDelegate.h" +#import "CHBDataUseConsent.h" +#import "CHBInterstitial.h" +#import "CHBRewarded.h" +#import "CHBBanner.h" +@class CBInPlay; -/*! - @typedef NS_ENUM (NSUInteger, CBFramework) - - @abstract - Used with setFramework:(CBFramework)framework calls to set suffix for - wrapper libraries like Unity or Corona. - */ -typedef NS_ENUM(NSUInteger, CBFramework) { - /*! Unity. */ - CBFrameworkUnity, - /*! Corona. */ - CBFrameworkCorona, - /*! Adobe AIR. */ - CBFrameworkAIR, - /*! GameSalad. */ - CBFrameworkGameSalad, - /*! Cordova. */ - CBFrameworkCordova, - /*! CocoonJS. */ - CBFrameworkCocoonJS, - /*! Cocos2d-x. */ - CBFrameworkCocos2dx, - /*! Prime31Unreal. */ - CBFrameworkPrime31Unreal, - /*! Weeby. */ - CBFrameworkWeeby, - /*! Unknown. Other */ - CBFrameworkOther -}; - -/*! - @typedef NS_ENUM (NSUInteger, CBMediation) - - @abstract - Used with setMediation:(CBMediation)library calls to set mediation library name - partners. If you don't see your library here, contact support. - */ -typedef NS_ENUM(NSUInteger, CBMediation) { - /*! Unknown. Other */ - CBMediationOther, - /*! AdMarvel */ - CBMediationAdMarvel, - /*! Fuse */ - CBMediationFuse, - /*! Fyber */ - CBMediationFyber, - /*! HeyZap */ - CBMediationHeyZap, - /*! MoPub */ - CBMediationMoPub, - /*! Supersonic */ - CBMediationSupersonic, - /*! AdMob */ - CBMediationAdMob, - /*! HyprMX */ - CBMediationHyprMX, - /*! AerServ */ - CBMediationAerServ -}; - - - -/*! - @typedef NS_ENUM (NSUInteger, CBLoadError) - - @abstract - Returned to ChartboostDelegate methods to notify of Chartboost SDK errors. - */ -typedef NS_ENUM(NSUInteger, CBLoadError) { - /*! Unknown internal error. */ - CBLoadErrorInternal = 0, - /*! Network is currently unavailable. */ - CBLoadErrorInternetUnavailable = 1, - /*! Too many requests are pending for that location. */ - CBLoadErrorTooManyConnections = 2, - /*! Interstitial loaded with wrong orientation. */ - CBLoadErrorWrongOrientation = 3, - /*! Interstitial disabled, first session. */ - CBLoadErrorFirstSessionInterstitialsDisabled = 4, - /*! Network request failed. */ - CBLoadErrorNetworkFailure = 5, - /*! No ad received. */ - CBLoadErrorNoAdFound = 6, - /*! Session not started. */ - CBLoadErrorSessionNotStarted = 7, - /*! There is an impression already visible.*/ - CBLoadErrorImpressionAlreadyVisible = 8, - /*! User manually cancelled the impression. */ - CBLoadErrorUserCancellation = 10, - /*! No location detected. */ - CBLoadErrorNoLocationFound = 11, - /*! Error downloading asset. */ - CBLoadErrorAssetDownloadFailure = 16, - /*! Video Prefetching is not finished */ - CBLoadErrorPrefetchingIncomplete = 21, - /*! Error Originating from the JS side of a Web View */ - CBLoadErrorWebViewScriptError = 22 -}; - -/*! - @typedef NS_ENUM (NSUInteger, CBClickError) - - @abstract - Returned to ChartboostDelegate methods to notify of Chartboost SDK errors. - */ -typedef NS_ENUM(NSUInteger, CBClickError) { - /*! Invalid URI. */ - CBClickErrorUriInvalid, - /*! The device does not know how to open the protocol of the URI */ - CBClickErrorUriUnrecognized, - /*! User failed to pass the age gate. */ - CBClickErrorAgeGateFailure, - /*! Unknown internal error */ - CBClickErrorInternal, -}; - -/*! - @typedef NS_ENUM (NSUInteger, CBStatusBarBehavior) - - @abstract - Used with setStatusBarBehavior:(CBStatusBarBehavior)statusBarBehavior calls to set how fullscreen ads should - behave with regards to the status bar. - */ -typedef NS_ENUM(NSUInteger, CBStatusBarBehavior) { - /*! Ignore status bar altogether; fullscreen ads will use the space of the status bar. */ - CBStatusBarBehaviorIgnore, - /*! Respect the status bar partially; fullscreen ads will use the space of the status bar but any user interactive buttons will not. */ - CBStatusBarBehaviorRespectButtons, - /*! Respect the status bar fully; fullscreen ads will not use the status bar space. */ - CBStatusBarBehaviorRespect -}; - -/*! - @typedef CBLocation - - @abstract - Defines standard locations to describe where Chartboost SDK features appear in game. - - @discussion Standard locations used to describe where Chartboost features show up in your game - For best performance, it is highly recommended to use standard locations. - - Benefits include: - - Higher eCPMs. - - Control of ad targeting and frequency. - - Better reporting. - */ -typedef NSString * const CBLocation; - -/*! "Startup" - Initial startup of game. */ -extern CBLocation const CBLocationStartup; -/*! "Home Screen" - Home screen the player first sees. */ -extern CBLocation const CBLocationHomeScreen; -/*! "Main Menu" - Menu that provides game options. */ -extern CBLocation const CBLocationMainMenu; -/*! "Game Screen" - Game screen where all the magic happens. */ -extern CBLocation const CBLocationGameScreen; -/*! "Achievements" - Screen with list of achievements in the game. */ -extern CBLocation const CBLocationAchievements; -/*! "Quests" - Quest, missions or goals screen describing things for a player to do. */ -extern CBLocation const CBLocationQuests; -/*! "Pause" - Pause screen. */ -extern CBLocation const CBLocationPause; -/*! "Level Start" - Start of the level. */ -extern CBLocation const CBLocationLevelStart; -/*! "Level Complete" - Completion of the level */ -extern CBLocation const CBLocationLevelComplete; -/*! "Turn Complete" - Finishing a turn in a game. */ -extern CBLocation const CBLocationTurnComplete; -/*! "IAP Store" - The store where the player pays real money for currency or items. */ -extern CBLocation const CBLocationIAPStore; -/*! "Item Store" - The store where a player buys virtual goods. */ -extern CBLocation const CBLocationItemStore; -/*! "Game Over" - The game over screen after a player is finished playing. */ -extern CBLocation const CBLocationGameOver; -/*! "Leaderboard" - List of leaders in the game. */ -extern CBLocation const CBLocationLeaderBoard; -/*! "Settings" - Screen where player can change settings such as sound. */ -extern CBLocation const CBLocationSettings; -/*! "Quit" - Screen displayed right before the player exits a game. */ -extern CBLocation const CBLocationQuit; -/*! "Default" - Supports legacy applications that only have one "Default" location */ -extern CBLocation const CBLocationDefault; - -@protocol ChartboostDelegate; - -/*! - @class Chartboost - - @abstract - Provide methods to display and control Chartboost native advertising types. - - @discussion For more information on integrating and using the Chartboost SDK - please visit our help site documentation at https://help.chartboost.com - */ @interface Chartboost : NSObject - -#pragma mark - Main Chartboost API /*! @abstract Start Chartboost with required appId, appSignature and delegate. - + @param appId The Chartboost application ID for this application. - + @param appSignature The Chartboost application signature for this application. - - @param delegate The delegate instance to receive Chartboost SDK callbacks. - + + @param completion A completion block to be executed when the SDK finishes initializing. + It takes a boolean parameter which indicates if the initialization succeeded or not. + @discussion This method must be executed before any other Chartboost SDK methods can be used. Once executed this call will also controll session tracking and background tasks used by Chartboost. + */ ++ (void)startWithAppId:(NSString*)appId appSignature:(NSString*)appSignature completion:(void (^)(BOOL))completion; + +/*! + @brief Use to restrict Chartboost's ability to collect personal data from the user. + @discussion This method can be called multiple times to set the consent for different privacy standards. + If a consent has already been set for a privacy standard, adding a consent object for that standard will overwrite the previous value. + + This method should be called before starting the Chartboost SDK with startWithAppId:appSignature:completion: if possible. + The added consents are persisted, so you may just call this when the consent status needs to be updated. */ -+ (void)startWithAppId:(NSString*)appId - appSignature:(NSString*)appSignature - delegate:(id<ChartboostDelegate>)delegate; ++ (void)addDataUseConsent:(CHBDataUseConsent *)consent NS_SWIFT_NAME(addDataUseConsent(_:)); /*! - @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; - + @brief Clears the previously added consent for the desired privacy standard. + @param privacyStandard The privacy standard for which you want to clear the consent. + @discussion Chartboost persists the added consents, so you'll need to call this method if you want to withdraw a previously added consent. + If no consent was available for the indicated standard nothing will happen. +*/ ++ (void)clearDataUseConsentForPrivacyStandard:(CHBPrivacyStandard)privacyStandard NS_SWIFT_NAME(clearDataUseConsent(for:)); /*! - @abstract - Check to see if any views are visible + @brief Returns the current consent status for the desired privacy standard. + @param privacyStandard The privacy standard for which you want to obtain the consent status. + @returns A CHBDataUseConsent subclass (the same one used to set the consent in addDataUseConsent:) or nil if no consent status is currently available. + @discussion Use this to check the current consent status, either set by a call to addDataUseConsent: or persisted from a call to the same method on a previous app run. You may need to cast the returned object to the proper CHBDataUseConsent subclass in order to read its consent value. - @return YES if there is any view visible + For example, to check if a consent is not set for GDPR: + @code + // Obj-C + if (![Chartboost dataUseConsentForPrivacyStandard:CHBPrivacyStandardGDPR]) { ... } + // Swift + if Chartboost.dataUseConsent(for: .GDPR) == nil { ... } + @endcode - @discussion This method can be used to check if any chartboost ad's are visible on the app. + To check the specific consent status for GDPR: + @code + // Obj-C + CHBGDPRDataUseConsent *gdpr = [Chartboost dataUseConsentForPrivacyStandard:CHBPrivacyStandardGDPR]; + if (gdpr && gdpr.consent == CHBGDPRConsentNonBehavioral) { ... } + // Swift + let gdpr = Chartboost.dataUseConsent(for: .GDPR) as? CHBDataUseConsent.GDPR + if gdpr?.consent == .nonBehavioral { ... } + @endcode */ -+ (BOOL)isAnyViewVisible; - -/*! - @abstract - Determine if a locally cached interstitial exists for the given CBLocation. - - @param location The location for the Chartboost impression type. - - @return YES if there a locally cached interstitial, and NO if not. - - @discussion A return value of YES here indicates that the corresponding - showInterstitial:(CBLocation)location method will present without making - additional Chartboost API server requests to fetch data to present. - */ -+ (BOOL)hasInterstitial:(CBLocation)location; - -/*! - @abstract - Present an interstitial for the given CBLocation. - - @param location The location for the Chartboost impression type. - - @discussion This method will first check if there is a locally cached interstitial - for the given CBLocation and, if found, will present using the locally cached data. - If no locally cached data exists the method will attempt to fetch data from the - Chartboost API server and present it. If the Chartboost API server is unavailable - or there is no eligible interstitial to present in the given CBLocation this method - is a no-op. - */ -+ (void)showInterstitial:(CBLocation)location; - -/*! - @abstract - Determine if a locally cached "more applications" exists for the given CBLocation. - - @param location The location for the Chartboost impression type. - - @return YES if there a locally cached "more applications", and NO if not. - - @discussion A return value of YES here indicates that the corresponding - showMoreApps:(CBLocation)location method will present without making - additional server requests to fetch data to present. - */ -+ (BOOL)hasMoreApps:(CBLocation)location; - -/*! - @abstract - Present an "more applications" for the given CBLocation. - - @param location The location for the Chartboost impression type. - - @discussion This method will first check if there is a locally cached "more applications" - for the given CBLocation and, if found, will present using the locally cached data. - If no locally cached data exists the method will attempt to fetch data from the - Chartboost API server and present it. If the Chartboost API server is unavailable - or there is no eligible "more applications" to present in the given CBLocation this method - is a no-op. - */ -+ (void)showMoreApps:(CBLocation)location; - -/*! - @abstract - Present an "more applications" for the given CBLocation and inside the given UIViewController. - - @param viewController The UIViewController to display the "more applications" UI within. - - @param location The location for the Chartboost impression type. - - @discussion This method uses the same implementation logic as showMoreApps:(CBLocation)location - for loading the "more applications" data, but adds an optional viewController parameter. - The viewController object allows the "more applications" page to be presented modally in a specified - view hierarchy. If the Chartboost API server is unavailable or there is no eligible "more applications" - to present in the given CBLocation this method is a no-op. - */ -+ (void)showMoreApps:(UIViewController *)viewController - location:(CBLocation)location; - -/*! - @abstract - Determine if a locally cached rewarded video exists for the given CBLocation. - - @param location The location for the Chartboost impression type. - - @return YES if there a locally cached rewarded video, and NO if not. - - @discussion A return value of YES here indicates that the corresponding - showRewardedVideo:(CBLocation)location method will present without making - additional Chartboost API server requests to fetch data to present. - */ -+ (BOOL)hasRewardedVideo:(CBLocation)location; - -/*! - @abstract - Present a rewarded video for the given CBLocation. - - @param location The location for the Chartboost impression type. - - @discussion This method will first check if there is a locally cached rewarded video - for the given CBLocation and, if found, will present it using the locally cached data. - If no locally cached data exists the method will attempt to fetch data from the - Chartboost API server and present it. If the Chartboost API server is unavailable - or there is no eligible rewarded video to present in the given CBLocation this method - is a no-op. - */ -+ (void)showRewardedVideo:(CBLocation)location; - -#pragma mark - Advanced Configuration & Use - -/*! - @abstract - Confirm if an age gate passed or failed. When specified Chartboost will wait for - this call before showing the IOS App Store. - - @param pass The result of successfully passing the age confirmation. - - @discussion If you have configured your Chartboost experience to use the age gate feature - then this method must be executed after the user has confirmed their age. The Chartboost SDK - will halt until this is done. - */ -+ (void)didPassAgeGate:(BOOL)pass; - -/*! - @abstract - Opens a "deep link" URL for a Chartboost Custom Scheme. - - @param url The URL to open. - - @param sourceApplication The application that originated the action. - - @return YES if Chartboost SDK is capable of handling the URL and does so, and NO if not. - - @discussion If you have configured a custom scheme and provided "deep link" URLs that the - Chartboost SDK is capable of handling you should use this method in your ApplicationDelegate - class methods that handle custom URL schemes. - */ -+ (BOOL)handleOpenURL:(NSURL *)url - sourceApplication:(NSString *)sourceApplication; - -/*! - @abstract - Opens a "deep link" URL for a Chartboost Custom Scheme. - - @param url The URL to open. - - @param sourceApplication The application that originated the action. - - @param annotation The provided annotation. - - @return YES if Chartboost SDK is capable of handling the URL and does so, and NO if not. - - @discussion If you have configured a custom scheme and provided "deep link" URLs that the - Chartboost SDK is capable of handling you should use this method in your ApplicationDelegate - class methods that handle custom URL schemes. - */ -+ (BOOL)handleOpenURL:(NSURL *)url - sourceApplication:(NSString *)sourceApplication - annotation:(id)annotation; - -/*! - @abstract - Set a custom identifier to send in the POST body for all Chartboost API server requests. - - @param customId The identifier to send with all Chartboost API server requests. - - @discussion Use this method to set a custom identifier that can be used later in the Chartboost - dashboard to group information by. - */ -+ (void)setCustomId:(NSString *)customId; - -/*! - @abstract - Get the current custom identifier being sent in the POST body for all Chartboost API server requests. - - @return The identifier being sent with all Chartboost API server requests. - - @discussion Use this method to get the custom identifier that can be used later in the Chartboost - dashboard to group information by. - */ -+ (NSString *)getCustomId; - -/*! - @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 setFramework:Unity withVersion:4.6, setFrameworkVersion:5.2.1 - - @param frameworkVersion 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)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 - Set a custom framework suffix to append to the POST headers field. - - @param framework The suffx to send with all Chartboost API server requests. - - @discussion This is an internal method used via Chartboost's Unity and Corona SDKs - to track their usage. - */ -+ (void)setFramework:(CBFramework)framework __attribute__((deprecated("This method is deprecated, please use + (void)setFramework:(CBFramework)framework withVersion:(NSString *)version; instead"))); - -/*! - @abstract - Set a custom framework suffix to append to the POST headers field. -example setFramework:Unity withVersion:4.6, setFrameworkVersion:5.2.1 - - @param framework The suffix to send with all Chartbooost API server requets. - @param version The platform version used for analytics. Example Unity should set Application.unityVersion - - @discussion This is an internal method used via Chartboost's Unity and Corona SDKs - to track their usage. - */ -+ (void)setFramework:(CBFramework)framework withVersion:(NSString *)version; - -/*! - @abstract - Set a custom mediation library to append to the POST body of every request. - example setMediation:CBMediationMoPub withVersion:@"3.8.0" - - @param library The constant for the name of the mediation library. - @param libraryVersion The version sent as a string. - - @discussion This is an internal method used by mediation partners to track their usage. - */ -+ (void)setMediation:(CBMediation)library withVersion:(NSString*)libraryVersion; - -/*! - @abstract - Decide if Chartboost SDK should show interstitials in the first session. - - @param shouldRequest YES if allowed to show interstitials in first session, NO otherwise. - - @discussion Set to control if Chartboost SDK can show interstitials in the first session. - The session count is controlled via the startWithAppId:appSignature:delegate: method in the Chartboost - class. - - Default is YES. - */ -+ (void)setShouldRequestInterstitialsInFirstSession:(BOOL)shouldRequest; - -/*! - @abstract - Decide if Chartboost SDK should block for an age gate. - - @param shouldPause YES if Chartboost should pause for an age gate, NO otherwise. - - @discussion Set to control if Chartboost SDK should block for an age gate. - - Default is NO. - */ -+ (void)setShouldPauseClickForConfirmation:(BOOL)shouldPause; - -/*! - @abstract - Decide if Chartboost SDK should show a loading view while preparing to display the - "more applications" UI. - - @param shouldDisplay YES if Chartboost should display a loading view, NO otherwise. - - @discussion Set to control if Chartboost SDK should show a loading view while - preparing to display the "more applications" UI. - - Default is NO. - */ -+ (void)setShouldDisplayLoadingViewForMoreApps:(BOOL)shouldDisplay; - -/*! - @abstract - Decide if Chartboost SDKK will attempt to fetch videos from the Chartboost API servers. - - @param shouldPrefetch YES if Chartboost should prefetch video content, NO otherwise. - - @discussion Set to control if Chartboost SDK control if videos should be prefetched. - - Default is YES. - */ -+ (void)setShouldPrefetchVideoContent:(BOOL)shouldPrefetch; - ++ (__kindof CHBDataUseConsent *)dataUseConsentForPrivacyStandard:(CHBPrivacyStandard)privacyStandard NS_SWIFT_NAME(dataUseConsent(for:)); /*! @abstract @@ -544,493 +83,57 @@ */ + (NSString*)getSDKVersion; +/*! + @abstract + Set the logging level + + @param loggingLevel The minimum level that's going to be logged + + @discussion Logging by default is off. + */ -#pragma mark - Advanced Caching ++ (void)setLoggingLevel:(CBLoggingLevel)loggingLevel; /*! @abstract - Cache an interstitial at the given CBLocation. - - @param location The location for the Chartboost impression type. - - @discussion This method will first check if there is a locally cached interstitial - for the given CBLocation and, if found, will do nothing. If no locally cached data exists - the method will attempt to fetch data from the Chartboost API server. + Mute/unmute chartboost ads. + @param mute YES all sounds, NO activates them. Default is NO + @discussion default value is NO */ -+ (void)cacheInterstitial:(CBLocation)location; - -/*! - @abstract - Cache an "more applications" at the given CBLocation. - - @param location The location for the Chartboost impression type. - - @discussion This method will first check if there is a locally cached "more applications" - for the given CBLocation and, if found, will do nothing. If no locally cached data exists - the method will attempt to fetch data from the Chartboost API server. - */ -+ (void)cacheMoreApps:(CBLocation)location; - -/*! - @abstract - Cache a rewarded video at the given CBLocation. - - @param location The location for the Chartboost impression type. - - @discussion This method will first check if there is a locally cached rewarded video - for the given CBLocation and, if found, will do nothing. If no locally cached data exists - the method will attempt to fetch data from the Chartboost API server. - */ -+ (void)cacheRewardedVideo:(CBLocation)location; - -/*! - @abstract - Set to enable and disable the auto cache feature (Enabled by default). - - @param shouldCache The param to enable or disable auto caching. - - @discussion If set to YES the Chartboost SDK will automatically attempt to cache an impression - once one has been consumed via a "show" call. If set to NO, it is the responsibility of the - developer to manage the caching behavior of Chartboost impressions. - */ -+ (void)setAutoCacheAds:(BOOL)shouldCache; - -/*! - @abstract - Get the current auto cache behavior (Enabled by default). - - @return YES if the auto cache is enabled, NO if it is not. - - @discussion If set to YES the Chartboost SDK will automatically attempt to cache an impression - once one has been consumed via a "show" call. If set to NO, it is the responsibility of the - developer to manage the caching behavior of Chartboost impressions. - */ -+ (BOOL)getAutoCacheAds; - -/*! - @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. - - @discussion See the enum value comments for descriptions on the values and their behavior. Only use this feature if your - application has the status bar enabled. - */ -+ (void)setStatusBarBehavior:(CBStatusBarBehavior)statusBarBehavior; ++ (void)setMuted:(BOOL)mute; -/*! - @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; - +#pragma mark - Deprecated ++ (void)setStatusBarBehavior:(CBStatusBarBehavior)statusBarBehavior __attribute__((deprecated("This method is deprecated and is a no-op"))); ++ (void)setMediation:(CBMediation)library withVersion:(NSString*)libraryVersion DEPRECATED_MSG_ATTRIBUTE("Please use setMediation:withLibraryVersion:adapterVersion: instead."); ++ (void)cacheInPlay:(CBLocation)location DEPRECATED_MSG_ATTRIBUTE("This is a deprecated no-op method and will be removed in a future version."); ++ (BOOL)hasInPlay:(CBLocation)location DEPRECATED_MSG_ATTRIBUTE("This is a deprecated no-op method and will be removed in a future version."); ++ (CBInPlay *)getInPlay:(CBLocation)location DEPRECATED_MSG_ATTRIBUTE("This is a deprecated no-op method and will be removed in a future version."); ++ (void)startWithAppId:(NSString*)appId appSignature:(NSString*)appSignature delegate:(id<ChartboostDelegate>)delegate DEPRECATED_MSG_ATTRIBUTE("Please use +[Chartboost startWithAppId:appSignature:completion:] instead."); ++ (BOOL)isAnyViewVisible DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (BOOL)hasInterstitial:(CBLocation)location DEPRECATED_MSG_ATTRIBUTE("Please use -[CHBInterstitial isCached] instead."); ++ (BOOL)hasRewardedVideo:(CBLocation)location DEPRECATED_MSG_ATTRIBUTE("Please use -[CHBRewarded isCached] instead."); ++ (void)cacheInterstitial:(CBLocation)location DEPRECATED_MSG_ATTRIBUTE("Please use -[CHBInterstitial cache] instead."); ++ (void)showInterstitial:(CBLocation)location DEPRECATED_MSG_ATTRIBUTE("Please use -[CHBInterstitial showFromViewController:] instead."); ++ (void)cacheRewardedVideo:(CBLocation)location DEPRECATED_MSG_ATTRIBUTE("Please use -[CHBRewarded cache] instead."); ++ (void)showRewardedVideo:(CBLocation)location DEPRECATED_MSG_ATTRIBUTE("Please use -[CHBRewarded showFromViewController:] instead."); ++ (void)setDelegate:(id<ChartboostDelegate>)del DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (void)didPassAgeGate:(BOOL)pass DEPRECATED_MSG_ATTRIBUTE("Please use -[CHBAdDelegate shouldConfirmClick:confirmationHandler:] instead."); ++ (BOOL)handleOpenURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (BOOL)handleOpenURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (void)setShouldRequestInterstitialsInFirstSession:(BOOL)shouldRequest DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (void)setShouldPauseClickForConfirmation:(BOOL)shouldPause DEPRECATED_MSG_ATTRIBUTE("Please use -[CHBAdDelegate shouldConfirmClick:confirmationHandler:] instead."); ++ (void)setAutoCacheAds:(BOOL)shouldCache DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (BOOL)getAutoCacheAds DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (void)setMediation:(CBMediation)library withLibraryVersion:(NSString*)libraryVersion adapterVersion:(NSString*)adapterVersion DEPRECATED_MSG_ATTRIBUTE("Please use CHBMediation as specified in Chartboost+Mediation.h instead."); ++ (CBPIDataUseConsent)getPIDataUseConsent DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (void)setPIDataUseConsent:(CBPIDataUseConsent)consent DEPRECATED_MSG_ATTRIBUTE("Please use addDataUseConsent: passing a CHBDataUseConsent GDPR object instead."); +FOUNDATION_EXPORT BOOL ChartboostInitialized(const char* function) DEPRECATED_MSG_ATTRIBUTE("This function is deprecated and will be removed in a future version."); ++ (void)setCustomId:(NSString *)customId DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (NSString *)getCustomId DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (void)setChartboostWrapperVersion:(NSString*)chartboostWrapperVersion DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (void)setFramework:(CBFramework)framework withVersion:(NSString *)version DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (void)setShouldPrefetchVideoContent:(BOOL)shouldPrefetch DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); ++ (BOOL)getAutoIAPTracking DEPRECATED_MSG_ATTRIBUTE("This method is deprecated and will be removed in a future version."); @end - -/*! - @protocol ChartboostDelegate - - @abstract - Provide methods and callbacks to receive notifications of when the Chartboost SDK - has taken specific actions or to more finely control the Chartboost SDK. - - @discussion For more information on integrating and using the Chartboost SDK - please visit our help site documentation at https://help.chartboost.com - - All of the delegate methods are optional. - */ -@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 - -/*! - @abstract - Called before requesting an interstitial via the Chartboost API server. - - @param location The location for the Chartboost impression type. - - @return YES if execution should proceed, NO if not. - - @discussion Implement to control if the Charboost SDK should fetch data from - the Chartboost API servers for the given CBLocation. This is evaluated - if the showInterstitial:(CBLocation) or cacheInterstitial:(CBLocation)location - are called. If YES is returned the operation will proceed, if NO, then the - operation is treated as a no-op. - - Default return is YES. - */ -- (BOOL)shouldRequestInterstitial:(CBLocation)location; - -/*! - @abstract - Called before an interstitial will be displayed on the screen. - - @param location The location for the Chartboost impression type. - - @return YES if execution should proceed, NO if not. - - @discussion Implement to control if the Charboost SDK should display an interstitial - for the given CBLocation. This is evaluated if the showInterstitial:(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. - */ -- (BOOL)shouldDisplayInterstitial:(CBLocation)location; - -/*! - @abstract - Called after an interstitial has been displayed on the screen. - - @param location The location for the Chartboost impression type. - - @discussion Implement to be notified of when an interstitial has - been displayed on the screen for a given CBLocation. - */ -- (void)didDisplayInterstitial:(CBLocation)location; - -/*! - @abstract - Called after an interstitial has been loaded from the Chartboost API - servers and cached locally. - - @param location The location for the Chartboost impression type. - - @discussion Implement to be notified of when an interstitial has been loaded from the Chartboost API - servers and cached locally for a given CBLocation. - */ -- (void)didCacheInterstitial:(CBLocation)location; - -/*! - @abstract - Called after an interstitial has attempted to load from the Chartboost API - servers but failed. - - @param location The location for the Chartboost impression type. - - @param error The reason for the error defined via a CBLoadError. - - @discussion Implement to be notified of when an interstitial has attempted to load from the Chartboost API - servers but failed for a given CBLocation. - */ -- (void)didFailToLoadInterstitial:(CBLocation)location - withError:(CBLoadError)error; - -/*! - @abstract - Called after a click is registered, but the user is not fowrwarded to the IOS App Store. - - @param location The location for the Chartboost impression type. - - @param error The reason for the error defined via a CBLoadError. - - @discussion Implement to be notified of when a click is registered, but the user is not fowrwarded - to the IOS App Store for a given CBLocation. - */ -- (void)didFailToRecordClick:(CBLocation)location - withError:(CBClickError)error; - -/*! - @abstract - Called after an interstitial has been dismissed. - - @param location The location for the Chartboost impression type. - - @discussion 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. - */ -- (void)didDismissInterstitial:(CBLocation)location; - -/*! - @abstract - Called after an interstitial has been closed. - - @param location The location for the Chartboost impression type. - - @discussion 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. - */ -- (void)didCloseInterstitial:(CBLocation)location; - -/*! - @abstract - Called after an interstitial has been clicked. - - @param location The location for the Chartboost impression type. - - @discussion 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. - */ -- (void)didClickInterstitial:(CBLocation)location; - -/*! - @abstract - Called before an "more applications" will be displayed on the screen. - - @param location The location for the Chartboost impression type. - - @return YES if execution should proceed, NO if not. - - @discussion Implement to control if the Charboost SDK should display an "more applications" - for the given CBLocation. 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. - */ -- (BOOL)shouldDisplayMoreApps:(CBLocation)location; - -/*! - @abstract - Called after an "more applications" has been displayed on the screen. - - @param location The location for the Chartboost impression type. - - @discussion Implement to be notified of when an "more applications" has - been displayed on the screen for a given CBLocation. - */ -- (void)didDisplayMoreApps:(CBLocation)location; - -/*! - @abstract - Called after an "more applications" has been loaded from the Chartboost API - servers and cached locally. - - @param location The location for the Chartboost impression type. - - @discussion Implement to be notified of when an "more applications" has been loaded from the Chartboost API - servers and cached locally for a given CBLocation. - */ -- (void)didCacheMoreApps:(CBLocation)location; - -/*! - @abstract - Called after an "more applications" has been dismissed. - - @param location The location for the Chartboost impression type. - - @discussion 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. - */ -- (void)didDismissMoreApps:(CBLocation)location; - -/*! - @abstract - Called after an "more applications" has been closed. - - @param location The location for the Chartboost impression type. - - @discussion 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". - */ -- (void)didCloseMoreApps:(CBLocation)location; - -/*! - @abstract - Called after an "more applications" has been clicked. - - @param location The location for the Chartboost impression type. - - @discussion Implement to be notified of when an "more applications" has been clicked for a given CBLocation. - "Clicked" is defined as clicking the creative interface for the "more applications". - */ -- (void)didClickMoreApps:(CBLocation)location; - -/*! - @abstract - Called after an "more applications" has attempted to load from the Chartboost API - servers but failed. - - @param location The location for the Chartboost impression type. - - @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 for a given CBLocation. - */ -- (void)didFailToLoadMoreApps:(CBLocation)location - withError:(CBLoadError)error; - -#pragma mark - Rewarded Video Delegate - -/*! - @abstract - Called before a rewarded video will be displayed on the screen. - - @param location The location for the Chartboost impression type. - - @return YES if execution should proceed, NO if not. - - @discussion Implement to control if the Charboost SDK should display a rewarded video - for the given CBLocation. This is evaluated if the showRewardedVideo:(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. - */ -- (BOOL)shouldDisplayRewardedVideo:(CBLocation)location; - -/*! - @abstract - Called after a rewarded video has been displayed on the screen. - - @param location The location for the Chartboost impression type. - - @discussion Implement to be notified of when a rewarded video has - been displayed on the screen for a given CBLocation. - */ -- (void)didDisplayRewardedVideo:(CBLocation)location; - -/*! - @abstract - Called after a rewarded video has been loaded from the Chartboost API - servers and cached locally. - - @param location The location for the Chartboost impression type. - - @discussion Implement to be notified of when a rewarded video has been loaded from the Chartboost API - servers and cached locally for a given CBLocation. - */ -- (void)didCacheRewardedVideo:(CBLocation)location; - -/*! - @abstract - Called after a rewarded video has attempted to load from the Chartboost API - servers but failed. - - @param location The location for the Chartboost impression type. - - @param error The reason for the error defined via a CBLoadError. - - @discussion Implement to be notified of when an rewarded video has attempted to load from the Chartboost API - servers but failed for a given CBLocation. - */ -- (void)didFailToLoadRewardedVideo:(CBLocation)location - withError:(CBLoadError)error; - -/*! - @abstract - Called after a rewarded video has been dismissed. - - @param location The location for the Chartboost impression type. - - @discussion 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. - */ -- (void)didDismissRewardedVideo:(CBLocation)location; - -/*! - @abstract - Called after a rewarded video has been closed. - - @param location The location for the Chartboost impression type. - - @discussion 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. - */ -- (void)didCloseRewardedVideo:(CBLocation)location; - -/*! - @abstract - Called after a rewarded video has been clicked. - - @param location The location for the Chartboost impression type. - - @discussion 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. - */ -- (void)didClickRewardedVideo:(CBLocation)location; - -/*! - @abstract - Called after a rewarded video has been viewed completely and user is eligible for reward. - - @param reward The reward for watching the video. - - @param location The location for the Chartboost impression type. - - @discussion Implement to be notified of when a rewarded video has been viewed completely and user is eligible for reward. - */ -- (void)didCompleteRewardedVideo:(CBLocation)location - withReward:(int)reward; - -#pragma mark - InPlay Delegate - -/*! - @abstract - Called after an InPlay object has been loaded from the Chartboost API - servers and cached locally. - - @param location The location for the Chartboost impression type. - - @discussion Implement to be notified of when an InPlay object has been loaded from the Chartboost API - servers and cached locally for a given CBLocation. - */ -- (void)didCacheInPlay:(CBLocation)location; - -/*! - @abstract - Called after a InPlay has attempted to load from the Chartboost API - servers but failed. - - @param location The location for the Chartboost impression type. - - @param error The reason for the error defined via a CBLoadError. - - @discussion Implement to be notified of when an InPlay has attempted to load from the Chartboost API - servers but failed for a given CBLocation. - */ -- (void)didFailToLoadInPlay:(CBLocation)location - withError:(CBLoadError)error; - -#pragma mark - General Delegate - -/*! - @abstract - Called before a video has been displayed on the screen. - - @param location The location for the Chartboost impression type. - - @discussion Implement to be notified of when a video will - be displayed on the screen for a given CBLocation. You can then do things like mute - effects and sounds. - */ -- (void)willDisplayVideo:(CBLocation)location; - -/*! - @abstract - Called after the App Store sheet is dismissed, when displaying the embedded app sheet. - - @discussion Implement to be notified of when the App Store sheet is dismissed. - */ -- (void)didCompleteAppStoreSheetFlow; - -/*! - @abstract - Called if Chartboost SDK pauses click actions awaiting confirmation from the user. - - @discussion Use this method to display any gating you would like to prompt the user for input. - Once confirmed call didPassAgeGate:(BOOL)pass to continue execution. - */ -- (void)didPauseClickForConfirmation; - -@end - - -- Gitblit v1.8.0