| | |
| | | |
| | | SWIFT_CLASS("_TtC6Didomi6Didomi") |
| | | @interface Didomi : NSObject |
| | | SWIFT_CLASS_PROPERTY(@property (nonatomic, class, strong) Didomi * _Nonnull shared;) |
| | | SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) Didomi * _Nonnull shared;) |
| | | + (Didomi * _Nonnull)shared SWIFT_WARN_UNUSED_RESULT; |
| | | + (void)setShared:(Didomi * _Nonnull)value; |
| | | @property (nonatomic, weak) id <ViewProviderDelegate> _Nullable viewProviderDelegate; |
| | | /// Determine the regulation applicable for the user. |
| | | /// If no regulation is applicable, will return <code>.none</code> in Swift or <code>RegulationNone</code> in Objective-C. |
| | | /// |
| | | /// returns: |
| | | /// the applicable regulation as <code>Regulation</code>. |
| | | @property (nonatomic, readonly) enum Regulation applicableRegulation; |
| | | - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER; |
| | | /// Initialize the Didomi SDK |
| | | /// \param parameters object specifying parameters to initialize the SDK. |
| | |
| | | /// |
| | | /// returns: |
| | | /// <em>true</em> if consent is required, <em>false</em> if it is not required. |
| | | - (BOOL)isConsentRequired SWIFT_WARN_UNUSED_RESULT SWIFT_DEPRECATED_MSG("Use shouldUserStatusBeCollected() instead."); |
| | | - (BOOL)isConsentRequired SWIFT_WARN_UNUSED_RESULT SWIFT_DEPRECATED_MSG("Instead, check that applicableRegulation is not .none in Swift or RegulationNone in Objective-C"); |
| | | /// Determine if consent information is available for all purposes and vendors that are required |
| | | /// |
| | | /// returns: |
| | |
| | | /// Remove all consents for the user |
| | | - (void)reset; |
| | | /// Get the configured purpose IDs |
| | | /// @return |
| | | /// |
| | | /// returns: |
| | | /// array of required purpose IDs. |
| | | - (NSSet<NSString *> * _Nonnull)getRequiredPurposeIds SWIFT_WARN_UNUSED_RESULT; |
| | | /// Get the configured vendor IDs |
| | | /// @return |
| | | /// |
| | | /// returns: |
| | | /// array of required vendor IDs. |
| | | - (NSSet<NSString *> * _Nonnull)getRequiredVendorIds SWIFT_WARN_UNUSED_RESULT; |
| | | /// Add an event listener |
| | | /// \param listener listener to be added. |
| | |
| | | /// Method used to provide a view controller that will be used to display the notice. |
| | | /// \param position string that represents the position of the notice (e.g.: bottom, popup, etc.). |
| | | /// |
| | | /// \param skipped Whether notice display is skipped and Preferences are displayed directly |
| | | /// \param noticeSkipped Whether notice display is skipped and Preferences are displayed directly |
| | | /// |
| | | /// |
| | | /// returns: |
| | |
| | | - (UIViewController * _Nonnull)getPreferencesViewController SWIFT_WARN_UNUSED_RESULT; |
| | | @end |
| | | |
| | | @class DidomiUserParameters; |
| | | @class UserAuthParams; |
| | | @class DDMUserStatus; |
| | | |
| | |
| | | /// Hide the notice if it is currently displayed |
| | | - (void)hideNotice; |
| | | /// Check if the consent notice is currently displayed |
| | | /// @return |
| | | - (BOOL)isNoticeVisible SWIFT_WARN_UNUSED_RESULT; |
| | | /// Check if the consent should be collected depending on if we have any consents or if we have some consents but the number of days before displaying the notice again has not expired yet |
| | | /// |
| | |
| | | /// Show the preferences screen when/if the SDK is ready. By default the purposes list will be displayed. |
| | | /// \param controller view controller from where preferences will be presented. |
| | | /// |
| | | /// \param view a value from <code>Didomi.Views</code>. It can be <code>.purposes</code> or <code>.sensitivePersonalInformation</code> or <code>.vendors</code> (<code>ViewsPurposes</code> or <code>ViewsSensitivePersonalInformation</code> or <code>ViewsVendors</code> in Objective-C) |
| | | /// \param view a value from <code>Didomi.Views</code>. It can be <code>.purposes</code> or <code>.vendors</code> (<code>ViewsPurposes</code> or <code>ViewsVendors</code> in Objective-C). <code>.sensitivePersonalInformation</code> is now deprecated. |
| | | /// |
| | | - (void)showPreferencesWithController:(UIViewController * _Nullable)controller view:(enum Views)view; |
| | | /// Hide the preferences popup for purposes |
| | |
| | | /// |
| | | - (void)setLogLevelWithMinLevel:(uint8_t)minLevel; |
| | | /// Set organization user information |
| | | /// \param parameters The organization user parameters |
| | | /// |
| | | - (void)setUser:(DidomiUserParameters * _Nonnull)parameters; |
| | | /// Set organization user information |
| | | /// \param id Organization user ID |
| | | /// |
| | | - (void)setUserWithId:(NSString * _Nonnull)id; |
| | | - (void)setUserWithId:(NSString * _Nonnull)id SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information |
| | | /// \param id Organization user ID |
| | | /// |
| | | /// \param isUnderage Underage status of the user |
| | | /// |
| | | - (void)setUserWithId:(NSString * _Nonnull)id isUnderage:(BOOL)isUnderage; |
| | | - (void)setUserWithId:(NSString * _Nonnull)id isUnderage:(BOOL)isUnderage SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information and display consent notice if it is needed after synchronization |
| | | /// \param id Organization user ID |
| | | /// |
| | | /// \param containerController View controller from which we can setup Didomi UI |
| | | /// |
| | | - (void)setUserWithId:(NSString * _Nonnull)id containerController:(UIViewController * _Nonnull)containerController; |
| | | - (void)setUserWithId:(NSString * _Nonnull)id containerController:(UIViewController * _Nonnull)containerController SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information and display consent notice if it is needed after synchronization |
| | | /// \param id Organization user ID |
| | | /// |
| | |
| | | /// |
| | | /// \param containerController View controller from which we can setup Didomi UI |
| | | /// |
| | | - (void)setUserWithId:(NSString * _Nonnull)id isUnderage:(BOOL)isUnderage containerController:(UIViewController * _Nonnull)containerController; |
| | | - (void)setUserWithId:(NSString * _Nonnull)id isUnderage:(BOOL)isUnderage containerController:(UIViewController * _Nonnull)containerController SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information with authentication |
| | | /// \param userAuthParams Organization user authentication params |
| | | /// |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams; |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information with authentication |
| | | /// \param userAuthParams Organization user authentication params |
| | | /// |
| | | /// \param isUnderage Underage status of the user |
| | | /// |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams isUnderage:(BOOL)isUnderage; |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams isUnderage:(BOOL)isUnderage SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information with authentication |
| | | /// \param userAuthParams Organization user authentication params. |
| | | /// |
| | | /// \param synchronizedUsers Additional users to synchronize user status. |
| | | /// |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams synchronizedUsers:(NSArray<UserAuthParams *> * _Nonnull)synchronizedUsers; |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams synchronizedUsers:(NSArray<UserAuthParams *> * _Nonnull)synchronizedUsers SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams dcsUser:(UserAuthParams * _Nonnull)dcsUser SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams synchronizedUsers:(NSArray<UserAuthParams *> * _Nonnull)synchronizedUsers dcsUser:(UserAuthParams * _Nonnull)dcsUser SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information with authentication |
| | | /// \param userAuthParams Organization user authentication params. |
| | | /// |
| | |
| | | /// |
| | | /// \param isUnderage Underage status of the user |
| | | /// |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams synchronizedUsers:(NSArray<UserAuthParams *> * _Nonnull)synchronizedUsers isUnderage:(BOOL)isUnderage; |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams synchronizedUsers:(NSArray<UserAuthParams *> * _Nonnull)synchronizedUsers isUnderage:(BOOL)isUnderage SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information with authentication |
| | | /// \param userAuthParams Organization user authentication params. |
| | | /// |
| | | /// \param dcsUser User authentication parameters used for DCS signature. |
| | | /// |
| | | /// \param isUnderage Underage status of the user |
| | | /// |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams dcsUser:(UserAuthParams * _Nonnull)dcsUser isUnderage:(BOOL)isUnderage SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information with authentication |
| | | /// \param userAuthParams Organization user authentication params. |
| | | /// |
| | | /// \param synchronizedUsers Additional users to synchronize user status. |
| | | /// |
| | | /// \param dcsUser User authentication parameters used for DCS signature |
| | | /// |
| | | /// \param isUnderage Underage status of the user |
| | | /// |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams synchronizedUsers:(NSArray<UserAuthParams *> * _Nonnull)synchronizedUsers dcsUser:(UserAuthParams * _Nonnull)dcsUser isUnderage:(BOOL)isUnderage SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information with authentication, and display consent notice if it is needed after synchronization |
| | | /// \param userAuthParams Organization user authentication params |
| | | /// |
| | | /// \param containerController View controller from which we can setup Didomi UI |
| | | /// |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams containerController:(UIViewController * _Nonnull)containerController; |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams containerController:(UIViewController * _Nonnull)containerController SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information with authentication, and display consent notice if it is needed after synchronization |
| | | /// \param userAuthParams Organization user authentication params |
| | | /// |
| | | /// \param containerController View controller from which we can setup Didomi UI |
| | | /// |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams dcsUser:(UserAuthParams * _Nonnull)dcsUser containerController:(UIViewController * _Nonnull)containerController SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information with authentication, and display consent notice if it is needed after synchronization |
| | | /// \param userAuthParams Organization user authentication params |
| | | /// |
| | |
| | | /// |
| | | /// \param containerController View controller from which we can setup Didomi UI |
| | | /// |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams isUnderage:(BOOL)isUnderage containerController:(UIViewController * _Nonnull)containerController; |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams isUnderage:(BOOL)isUnderage containerController:(UIViewController * _Nonnull)containerController SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information with authentication, and display consent notice if it is needed after synchronization |
| | | /// \param userAuthParams Organization user authentication params. |
| | | /// |
| | |
| | | /// |
| | | /// \param containerController View controller from which we can setup Didomi UI |
| | | /// |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams synchronizedUsers:(NSArray<UserAuthParams *> * _Nonnull)synchronizedUsers containerController:(UIViewController * _Nonnull)containerController; |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams synchronizedUsers:(NSArray<UserAuthParams *> * _Nonnull)synchronizedUsers containerController:(UIViewController * _Nonnull)containerController SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Set organization user information with authentication, and display consent notice if it is needed after synchronization |
| | | /// \param userAuthParams Organization user authentication params. |
| | | /// |
| | |
| | | /// |
| | | /// \param containerController View controller from which we can setup Didomi UI |
| | | /// |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams synchronizedUsers:(NSArray<UserAuthParams *> * _Nonnull)synchronizedUsers isUnderage:(BOOL)isUnderage containerController:(UIViewController * _Nonnull)containerController; |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams synchronizedUsers:(NSArray<UserAuthParams *> * _Nonnull)synchronizedUsers isUnderage:(BOOL)isUnderage containerController:(UIViewController * _Nonnull)containerController SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | - (void)setUserWithUserAuthParams:(UserAuthParams * _Nonnull)userAuthParams synchronizedUsers:(NSArray<UserAuthParams *> * _Nonnull)synchronizedUsers dcsUser:(UserAuthParams * _Nonnull)dcsUser isUnderage:(BOOL)isUnderage containerController:(UIViewController * _Nonnull)containerController SWIFT_DEPRECATED_MSG("Use setUser(DidomiUserParameters) instead."); |
| | | /// Remove organization user information (should be called when the SDK is initialized). |
| | | - (void)clearUser; |
| | | /// Get an instance of <code>UserStatus</code> containing all the information related to the user’s choices. |
| | |
| | | DDMErrorEventTypeFailedAlready = 2, |
| | | DDMErrorEventTypeConfigFileError = 3, |
| | | DDMErrorEventTypeInvalidApiKey = 4, |
| | | DDMErrorEventTypeErrorLoadingUIResource = 5, |
| | | }; |
| | | |
| | | |
| | |
| | | @end |
| | | |
| | | |
| | | @protocol UserAuth; |
| | | @class NSNumber; |
| | | |
| | | /// User parameters for Didomi SDK |
| | | /// \param userAuth The main user authentication. |
| | | /// |
| | | /// \param dcsUserAuth The user authentication for Didomi Consent String. |
| | | /// |
| | | /// \param containerController The UIViewController if the notice should be displayed when the consent expired or the user is new. |
| | | /// |
| | | /// \param isUnderage If the user is underage (nil will keep the previous setting). |
| | | /// |
| | | SWIFT_CLASS("_TtC6Didomi20DidomiUserParameters") |
| | | @interface DidomiUserParameters : NSObject |
| | | /// Initializer for Objective-C compatibility |
| | | - (nonnull instancetype)initWithUserAuth:(id <UserAuth> _Nonnull)userAuth dcsUserAuth:(UserAuthParams * _Nullable)dcsUserAuth containerController:(UIViewController * _Nullable)containerController isUnderage:(NSNumber * _Nonnull)isUnderage; |
| | | /// Initializer for Objective-C compatibility |
| | | - (nonnull instancetype)initWithUserAuth:(id <UserAuth> _Nonnull)userAuth dcsUserAuth:(UserAuthParams * _Nullable)dcsUserAuth containerController:(UIViewController * _Nullable)containerController; |
| | | - (nonnull instancetype)init SWIFT_UNAVAILABLE; |
| | | + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable"); |
| | | @end |
| | | |
| | | |
| | | /// User parameters for Didomi SDK |
| | | /// \param userAuth The main user authentication. |
| | | /// |
| | | /// \param dcsUserAuth The user authentication for Didomi Consent String. |
| | | /// |
| | | /// \param synchronizedUser The synchronized user list. |
| | | /// |
| | | /// \param activity The UIViewController if the notice should be displayed when the consent expired or the user is new. |
| | | /// |
| | | /// \param isUnderage If the user is underage (nil will keep the previous setting). |
| | | /// |
| | | SWIFT_CLASS("_TtC6Didomi25DidomiMultiUserParameters") |
| | | @interface DidomiMultiUserParameters : DidomiUserParameters |
| | | /// Initializer for Objective-C compatibility |
| | | - (nonnull instancetype)initWithUserAuth:(id <UserAuth> _Nonnull)userAuth dcsUserAuth:(UserAuthParams * _Nullable)dcsUserAuth synchronizedUsers:(NSArray<UserAuthParams *> * _Nullable)synchronizedUsers containerController:(UIViewController * _Nullable)containerController isUnderage:(NSNumber * _Nonnull)isUnderage; |
| | | /// Initializer for Objective-C compatibility |
| | | - (nonnull instancetype)initWithUserAuth:(id <UserAuth> _Nonnull)userAuth dcsUserAuth:(UserAuthParams * _Nullable)dcsUserAuth synchronizedUsers:(NSArray<UserAuthParams *> * _Nullable)synchronizedUsers containerController:(UIViewController * _Nullable)containerController; |
| | | @end |
| | | |
| | | |
| | | enum DDMEventType : NSInteger; |
| | | @class DDMSyncUserChangedEvent; |
| | | @class DDMSyncReadyEvent; |
| | | |
| | | /// Class used as a listener for internal events occurred in the SDK. |
| | |
| | | @property (nonatomic, copy) void (^ _Nonnull onNoticeClickDisagree)(enum DDMEventType); |
| | | @property (nonatomic, copy) void (^ _Nonnull onNoticeClickMoreInfo)(enum DDMEventType); |
| | | @property (nonatomic, copy) void (^ _Nonnull onNoticeClickViewVendors)(enum DDMEventType); |
| | | @property (nonatomic, copy) void (^ _Nonnull onNoticeClickViewSPIPurposes)(enum DDMEventType); |
| | | @property (nonatomic, copy) void (^ _Nonnull onNoticeClickViewSPIPurposes)(enum DDMEventType) SWIFT_DEPRECATED_MSG("SPI purposes are now displayed in preferences screen, please use onNoticeClickMoreInfo() instead."); |
| | | @property (nonatomic, copy) void (^ _Nonnull onNoticeClickPrivacyPolicy)(enum DDMEventType); |
| | | /// Preferences |
| | | @property (nonatomic, copy) void (^ _Nonnull onHidePreferences)(enum DDMEventType); |
| | |
| | | /// Preferences - Views |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickViewPurposes)(enum DDMEventType); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickViewVendors)(enum DDMEventType); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickViewSPIPurposes)(enum DDMEventType); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickViewSPIPurposes)(enum DDMEventType) SWIFT_DEPRECATED_MSG("SPI purposes are now displayed in preferences screen."); |
| | | /// Preferences - Purpose |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickAgreeToAll)(enum DDMEventType); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickDisagreeToAll)(enum DDMEventType); |
| | |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickVendorAgree)(enum DDMEventType, NSString * _Nullable); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickVendorDisagree)(enum DDMEventType, NSString * _Nullable); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickVendorSaveChoices)(enum DDMEventType); |
| | | /// Preferences - Sensitive Personal Information |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickSPIPurposeAgree)(enum DDMEventType, NSString * _Nullable); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickSPIPurposeDisagree)(enum DDMEventType, NSString * _Nullable); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickSPICategoryAgree)(enum DDMEventType, NSString * _Nullable); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickSPICategoryDisagree)(enum DDMEventType, NSString * _Nullable); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickSPIPurposeSaveChoices)(enum DDMEventType); |
| | | /// Preferences - Sensitive Personal Information (deprecated) |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickSPIPurposeAgree)(enum DDMEventType, NSString * _Nullable) SWIFT_DEPRECATED_MSG("SPI purposes are now treated as other purposes, please use onPreferencesClickPurposeAgree() instead."); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickSPIPurposeDisagree)(enum DDMEventType, NSString * _Nullable) SWIFT_DEPRECATED_MSG("SPI purposes are now treated as other purposes, please use onPreferencesClickPurposeDisagree() instead."); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickSPICategoryAgree)(enum DDMEventType, NSString * _Nullable) SWIFT_DEPRECATED_MSG("SPI purposes are now treated as other purposes, please use onPreferencesClickCategoryAgree() instead."); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickSPICategoryDisagree)(enum DDMEventType, NSString * _Nullable) SWIFT_DEPRECATED_MSG("SPI purposes are now treated as other purposes, please use onPreferencesClickCategoryDisagree() instead."); |
| | | @property (nonatomic, copy) void (^ _Nonnull onPreferencesClickSPIPurposeSaveChoices)(enum DDMEventType) SWIFT_DEPRECATED_MSG("SPI purposes are now treated as other purposes, please use onPreferencesClickSaveChoices() instead."); |
| | | /// User |
| | | @property (nonatomic, copy) void (^ _Nonnull onSyncUserChanged)(DDMSyncUserChangedEvent * _Nonnull); |
| | | /// Sync |
| | | @property (nonatomic, copy) void (^ _Nonnull onSyncDone)(enum DDMEventType, NSString * _Nullable) SWIFT_DEPRECATED_MSG("Please use onSyncReady() instead"); |
| | | @property (nonatomic, copy) void (^ _Nonnull onSyncReady)(DDMSyncReadyEvent * _Nonnull); |
| | |
| | | /// Language |
| | | @property (nonatomic, copy) void (^ _Nonnull onLanguageUpdated)(enum DDMEventType, NSString * _Nullable); |
| | | @property (nonatomic, copy) void (^ _Nonnull onLanguageUpdateFailed)(enum DDMEventType, NSString * _Nullable); |
| | | @property (nonatomic, copy) void (^ _Nonnull onDCSSignatureReady)(enum DDMEventType); |
| | | @property (nonatomic, copy) void (^ _Nonnull onDCSSignatureError)(enum DDMEventType); |
| | | - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER; |
| | | @end |
| | | |
| | |
| | | DDMEventTypePreferencesClickVendorAgree = 25, |
| | | DDMEventTypePreferencesClickVendorDisagree = 26, |
| | | DDMEventTypePreferencesClickVendorSaveChoices = 27, |
| | | /// User |
| | | DDMEventTypeSyncUserChanged = 28, |
| | | /// Sync |
| | | DDMEventTypeSyncDone = 28, |
| | | DDMEventTypeSyncReady = 29, |
| | | DDMEventTypeSyncError = 30, |
| | | DDMEventTypeSyncDone = 29, |
| | | DDMEventTypeSyncReady = 30, |
| | | DDMEventTypeSyncError = 31, |
| | | /// Language |
| | | DDMEventTypeLanguageUpdated = 31, |
| | | DDMEventTypeLanguageUpdateFailed = 32, |
| | | DDMEventTypeLanguageUpdated = 32, |
| | | DDMEventTypeLanguageUpdateFailed = 33, |
| | | /// Preferences - Sensitive Personal Information |
| | | DDMEventTypeNoticeClickViewSPIPurposes = 33, |
| | | DDMEventTypePreferencesClickViewSPIPurposes = 34, |
| | | DDMEventTypePreferencesClickSPIPurposeAgree = 35, |
| | | DDMEventTypePreferencesClickSPIPurposeDisagree = 36, |
| | | DDMEventTypePreferencesClickSPICategoryAgree = 37, |
| | | DDMEventTypePreferencesClickSPICategoryDisagree = 38, |
| | | DDMEventTypePreferencesClickSPIPurposeSaveChoices = 39, |
| | | DDMEventTypeNoticeClickViewSPIPurposes = 34, |
| | | DDMEventTypePreferencesClickViewSPIPurposes = 35, |
| | | DDMEventTypePreferencesClickSPIPurposeAgree = 36, |
| | | DDMEventTypePreferencesClickSPIPurposeDisagree = 37, |
| | | DDMEventTypePreferencesClickSPICategoryAgree = 38, |
| | | DDMEventTypePreferencesClickSPICategoryDisagree = 39, |
| | | DDMEventTypePreferencesClickSPIPurposeSaveChoices = 40, |
| | | /// DCS Signature |
| | | DDMEventTypeDcsSignatureReady = 41, |
| | | DDMEventTypeDcsSignatureError = 42, |
| | | }; |
| | | |
| | | |
| | | |
| | | |
| | | |
| | |
| | | /// Class used to contain information about the occurrence of the Sync Ready event. |
| | | SWIFT_CLASS_NAMED("SyncReadyEvent") |
| | | @interface DDMSyncReadyEvent : NSObject |
| | | /// String that indicates the organization user ID used during sync. |
| | | @property (nonatomic, readonly, copy) NSString * _Nullable organizationUserId; |
| | | /// Boolean that indicates whether remote user status has been applied locally. |
| | | @property (nonatomic, readonly) BOOL statusApplied; |
| | | /// Closure used to send a Sync Acknowledged API Event. Returns <em>true</em> if the API Event was sent, <em>false</em> otherwise. |
| | | @property (nonatomic, readonly, copy) BOOL (^ _Nonnull syncAcknowledged)(void); |
| | | - (nonnull instancetype)init SWIFT_UNAVAILABLE; |
| | | + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable"); |
| | | @end |
| | | |
| | | |
| | | /// Class used to contain information about the occurrence of the Sync User Changed event. |
| | | SWIFT_CLASS_NAMED("SyncUserChangedEvent") |
| | | @interface DDMSyncUserChangedEvent : NSObject |
| | | /// String that indicates the organization user ID used during sync. |
| | | @property (nonatomic, readonly, strong) id <UserAuth> _Nullable userAuth; |
| | | - (nonnull instancetype)init SWIFT_UNAVAILABLE; |
| | | + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable"); |
| | | @end |
| | |
| | | |
| | | |
| | | /// Protocol for User Authentication |
| | | /// declare the user id |
| | | /// declare the Organization User ID |
| | | SWIFT_PROTOCOL("_TtP6Didomi8UserAuth_") |
| | | @protocol UserAuth |
| | | /// Organization ID to associate with the user |
| | | /// Organization User ID |
| | | @property (nonatomic, readonly, copy) NSString * _Nonnull id; |
| | | - (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT; |
| | | @end |
| | | |
| | | |
| | |
| | | /// declare the common properties of encryption / hash parameters |
| | | SWIFT_CLASS("_TtC6Didomi14UserAuthParams") |
| | | @interface UserAuthParams : NSObject <UserAuth> |
| | | /// Organization ID to associate with the user |
| | | /// Organization User ID |
| | | @property (nonatomic, copy) NSString * _Nonnull id; |
| | | - (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT; |
| | | - (nonnull instancetype)init SWIFT_UNAVAILABLE; |
| | | + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable"); |
| | | @end |
| | | |
| | | |
| | | |
| | | |
| | | /// User Authentication Parameters with encryption |
| | | SWIFT_CLASS("_TtC6Didomi28UserAuthWithEncryptionParams") |
| | | @interface UserAuthWithEncryptionParams : UserAuthParams |
| | | /// Convenience initializers without optional TimeInterval, necessary for Objective-C |
| | | - (nonnull instancetype)initWithId:(NSString * _Nonnull)id algorithm:(NSString * _Nonnull)algorithm secretID:(NSString * _Nonnull)secretID initializationVector:(NSString * _Nonnull)initializationVector; |
| | | /// Initializer for Objective-C |
| | | - (nonnull instancetype)initWithId:(NSString * _Nonnull)id algorithm:(NSString * _Nonnull)algorithm secretID:(NSString * _Nonnull)secretID initializationVector:(NSString * _Nonnull)initializationVector legacyExpiration:(NSTimeInterval)legacyExpiration; |
| | | /// Initialization Vector used for computing the user ID |
| | | @property (nonatomic, copy) NSString * _Nonnull initializationVector; |
| | | - (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT; |
| | | @end |
| | | |
| | | |
| | | |
| | | /// User Authentication Parameters with hash |
| | | SWIFT_CLASS("_TtC6Didomi22UserAuthWithHashParams") |
| | | @interface UserAuthWithHashParams : UserAuthParams |
| | | /// Convenience initializers without optional TimeInterval, necessary for Objective-C |
| | | - (nonnull instancetype)initWithId:(NSString * _Nonnull)id algorithm:(NSString * _Nonnull)algorithm secretID:(NSString * _Nonnull)secretID digest:(NSString * _Nonnull)digest salt:(NSString * _Nullable)salt; |
| | | /// Initializer for Objective-C |
| | | - (nonnull instancetype)initWithId:(NSString * _Nonnull)id algorithm:(NSString * _Nonnull)algorithm secretID:(NSString * _Nonnull)secretID digest:(NSString * _Nonnull)digest salt:(NSString * _Nullable)salt legacyExpiration:(NSTimeInterval)legacyExpiration; |
| | | /// Salt used for computing the user ID (optional) |
| | | /// Salt used for computing the OUID (optional) |
| | | @property (nonatomic, copy) NSString * _Nullable salt; |
| | | /// Digest used for representing the user ID |
| | | /// Digest used for representing the OUID |
| | | @property (nonatomic, copy) NSString * _Nonnull digest; |
| | | - (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT; |
| | | @end |
| | | |
| | | |
| | | |
| | | /// User Authentication Parameters without encryption |
| | | SWIFT_CLASS("_TtC6Didomi21UserAuthWithoutParams") |
| | | @interface UserAuthWithoutParams : NSObject <UserAuth> |
| | | - (nonnull instancetype)initWithId:(NSString * _Nonnull)id OBJC_DESIGNATED_INITIALIZER; |
| | | /// Organization User ID |
| | | @property (nonatomic, copy) NSString * _Nonnull id; |
| | | - (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT; |
| | | - (nonnull instancetype)init SWIFT_UNAVAILABLE; |
| | | + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable"); |
| | | @end |
| | | |
| | | |
| | | @class DDMUserStatusPurposes; |
| | | @class DDMUserStatusVendors; |
| | |
| | | |
| | | @class DDMUserStatusIDs; |
| | | |
| | | SWIFT_CLASS_NAMED("Purposes") |
| | | @interface DDMUserStatusPurposes : NSObject |
| | | SWIFT_CLASS_NAMED("Vendors") |
| | | @interface DDMUserStatusVendors : NSObject |
| | | @property (nonatomic, readonly, strong) DDMUserStatusIDs * _Nonnull consent; |
| | | @property (nonatomic, readonly, strong) DDMUserStatusIDs * _Nonnull legitimateInterest; |
| | | @property (nonatomic, readonly, strong) DDMUserStatusIDs * _Nonnull global; |
| | | @property (nonatomic, readonly, copy) NSSet<NSString *> * _Nonnull essential; |
| | | @property (nonatomic, readonly, strong) DDMUserStatusIDs * _Nonnull globalConsent; |
| | | @property (nonatomic, readonly, strong) DDMUserStatusIDs * _Nonnull globalLegitimateInterest; |
| | | - (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT; |
| | | - (nonnull instancetype)init SWIFT_UNAVAILABLE; |
| | | + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable"); |
| | |
| | | @end |
| | | |
| | | |
| | | SWIFT_CLASS_NAMED("Vendors") |
| | | @interface DDMUserStatusVendors : NSObject |
| | | SWIFT_CLASS_NAMED("Purposes") |
| | | @interface DDMUserStatusPurposes : NSObject |
| | | @property (nonatomic, readonly, strong) DDMUserStatusIDs * _Nonnull consent; |
| | | @property (nonatomic, readonly, strong) DDMUserStatusIDs * _Nonnull legitimateInterest; |
| | | @property (nonatomic, readonly, strong) DDMUserStatusIDs * _Nonnull global; |
| | | @property (nonatomic, readonly, strong) DDMUserStatusIDs * _Nonnull globalConsent; |
| | | @property (nonatomic, readonly, strong) DDMUserStatusIDs * _Nonnull globalLegitimateInterest; |
| | | @property (nonatomic, readonly, copy) NSSet<NSString *> * _Nonnull essential; |
| | | - (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT; |
| | | - (nonnull instancetype)init SWIFT_UNAVAILABLE; |
| | | + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable"); |
| | |
| | | @end |
| | | |
| | | |
| | | /// Store localized URLs for privacy policy and LI claim. |
| | | SWIFT_CLASS_NAMED("URL") |
| | | @interface DDMVendorURL : NSObject |
| | | @property (nonatomic, readonly, copy) NSString * _Nullable langID; |
| | | @property (nonatomic, readonly, copy) NSString * _Nullable privacy; |
| | | @property (nonatomic, readonly, copy) NSString * _Nullable legIntClaim; |
| | | /// Store additional IDs (IAB, num) for the Vendor. |
| | | SWIFT_CLASS_NAMED("Namespaces") |
| | | @interface DDMVendorNamespaces : NSObject |
| | | @property (nonatomic, readonly, copy) NSString * _Nullable iab2; |
| | | - (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT; |
| | | - (nonnull instancetype)init SWIFT_UNAVAILABLE; |
| | | + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable"); |
| | |
| | | @end |
| | | |
| | | |
| | | /// Store additional IDs (IAB, num) for the Vendor. |
| | | SWIFT_CLASS_NAMED("Namespaces") |
| | | @interface DDMVendorNamespaces : NSObject |
| | | @property (nonatomic, readonly, copy) NSString * _Nullable iab2; |
| | | /// Store localized URLs for privacy policy and LI claim. |
| | | SWIFT_CLASS_NAMED("URL") |
| | | @interface DDMVendorURL : NSObject |
| | | @property (nonatomic, readonly, copy) NSString * _Nullable langID; |
| | | @property (nonatomic, readonly, copy) NSString * _Nullable privacy; |
| | | @property (nonatomic, readonly, copy) NSString * _Nullable legIntClaim; |
| | | - (BOOL)isEqual:(id _Nullable)object SWIFT_WARN_UNUSED_RESULT; |
| | | - (nonnull instancetype)init SWIFT_UNAVAILABLE; |
| | | + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable"); |