ALSdkSettings.h 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. //
  2. // ALSdkSettings.h
  3. // AppLovinSDK
  4. //
  5. // Copyright © 2020 AppLovin Corporation. All rights reserved.
  6. //
  7. #import <AppLovinSDK/ALTermsAndPrivacyPolicyFlowSettings.h>
  8. NS_ASSUME_NONNULL_BEGIN
  9. /**
  10. * This class contains mutable settings for the AppLovin SDK.
  11. */
  12. @interface ALSdkSettings : NSObject
  13. /**
  14. * Settings relating to the MAX Terms and Privacy Policy Flow.
  15. */
  16. @property (nonatomic, strong, readonly) ALTermsAndPrivacyPolicyFlowSettings *termsAndPrivacyPolicyFlowSettings;
  17. /**
  18. * A toggle for verbose logging for the SDK. This is set to @c NO by default. Set it to @c NO if you want the SDK to be silent (this is recommended for App Store
  19. * submissions).
  20. *
  21. * If set to @c YES AppLovin messages will appear in the standard application log which is accessible via the console. All AppLovin log messages are prefixed
  22. * with the @code /AppLovinSdk: [AppLovinSdk] @endcode tag.
  23. *
  24. * Verbose logging is <em>disabled</em> (@c NO) by default.
  25. *
  26. * @see <a href="https://dash.applovin.com/documentation/mediation/ios/getting-started/advanced-settings#enable-verbose-logging">MAX Integration Guide ⇒ iOS ⇒ Advanced Settings ⇒ Enable Verbose Logging</a>
  27. */
  28. @property (nonatomic, assign, getter=isVerboseLoggingEnabled) BOOL verboseLoggingEnabled;
  29. /**
  30. * Whether to begin video ads in a muted state or not. Defaults to @c NO unless you change this in the dashboard.
  31. *
  32. * @see <a href="https://dash.applovin.com/documentation/mediation/ios/getting-started/advanced-settings#mute-audio">MAX Integration Guide ⇒ iOS ⇒ Advanced Settings ⇒ Mute Audio</a>
  33. */
  34. @property (nonatomic, assign, getter=isMuted) BOOL muted;
  35. /**
  36. * Whether the Creative Debugger will be displayed after flipping the device screen down twice. Defaults to @c YES.
  37. *
  38. * @see <a href="https://dash.applovin.com/documentation/mediation/ios/testing-networks/creative-debugger">MAX Integration Guide ⇒ iOS ⇒ Testing Networks ⇒ Creative Debugger</a>
  39. */
  40. @property (nonatomic, assign, getter=isCreativeDebuggerEnabled) BOOL creativeDebuggerEnabled;
  41. /**
  42. * Whether or not the AppLovin SDK will collect the device location from `CLLocationManager` if available. Defaults to @c YES.
  43. */
  44. @property (nonatomic, assign, getter=isLocationCollectionEnabled) BOOL locationCollectionEnabled;
  45. /**
  46. * An identifier for the current user. This identifier will be tied to SDK events and AppLovin’s optional S2S postbacks.
  47. *
  48. * If you use reward validation, you can optionally set an identifier that AppLovin will include with its currency validation postbacks (for example, a username
  49. * or email address). AppLovin will include this in the postback when AppLovin pings your currency endpoint from our server.
  50. *
  51. * @see <a href="https://dash.applovin.com/documentation/mediation/s2s-rewarded-callback-api#setting-an-internal-user-id">MAX Integration Guide ⇒ MAX S2S Rewarded Callback API ⇒ Setting an Internal User ID</a>
  52. */
  53. @property (nonatomic, copy, nullable) NSString *userIdentifier;
  54. /**
  55. * A copy of the extra parameters that are currently set.
  56. */
  57. @property (nonatomic, copy) NSDictionary<NSString *, NSString *> *extraParameters;
  58. /**
  59. * Set an extra parameter to pass to the AppLovin server.
  60. *
  61. * @param key Parameter key. Must not be nil.
  62. * @param value Parameter value. May be nil.
  63. */
  64. - (void)setExtraParameterForKey:(NSString *)key value:(nullable NSString *)value;
  65. @property (nonatomic, copy) NSArray<NSString *> *testDeviceAdvertisingIdentifiers __deprecated_msg("This property is deprecated and will be removed in a future SDK version. Please use the new ALSdkInitializationConfiguration (see ALSdkInitializationConfiguration.testDeviceAdvertisingIdentifiers)");
  66. @property (nonatomic, copy) NSArray<NSString *> *initializationAdUnitIdentifiers __deprecated_msg("This property is deprecated and will be removed in a future SDK version. version. Please use the new ALSdkInitializationConfiguration (see ALSdkInitializationConfiguration.initializationAdUnitIdentifiers");
  67. @property (nonatomic, assign, getter=isExceptionHandlerEnabled) BOOL exceptionHandlerEnabled __deprecated_msg("This property is deprecated and will be removed in a future SDK version. Please use the new ALSdkInitializationConfiguration (see ALSdkInitializationConfiguration.exceptionHandlerEnabled)");
  68. @end
  69. @interface ALSdkSettings (ALDeprecated)
  70. @property (nonatomic, assign) BOOL isVerboseLogging __deprecated_msg("This property is deprecated and will be removed in a future SDK version. Please use `-[ALSdkSettings isVerboseLoggingEnabled]` instead.");
  71. @property (nonatomic, strong, readonly) ALConsentFlowSettings *consentFlowSettings __deprecated_msg("This property is deprecated and will be removed in a future SDK version. Please use the new MAX Terms and Privacy Policy Flow instead (see ALSdkSettings.termsAndPrivacyPolicyFlowSettings)");
  72. - (instancetype)init __deprecated_msg("This method is deprecated and will be removed in a future SDK version. Please use `ALSdkInitializationConfiguration.settings` instead");
  73. + (instancetype)new __deprecated_msg("This method is deprecated and will be removed in a future SDK version. Please use ` ALSdkInitializationConfiguration.settings` instead");
  74. @end
  75. NS_ASSUME_NONNULL_END