| commit | author | age | ||
| 09e73a | 1 | ⨠) 8,@ð |
| L | 2 | ¤P ¬P |
| 3 | ¿@ | |
| 4 | ¯0 | |
| 5 | ¿ | |
| 6 | ¬ð | |
| 7 | £° | |
| 8 | A²ÐÂ+¸-ÈÂ+°Â/+¼Â(¬ÂC´B)ÐB(B(ÐB(<0B+¼)Ô+Â/¸B(´B)< -,B)ÐÂA Í(¼B+´B)¸-ü(°Â+Â*<8)Â(°Â/Â+´B++ÐÂ,<0Â)ÈÂ+Ô,ü+B+Â, ¨+ % & TjÀ 0"D1P Å ´ | |
| 9 | Apple Swift version 5.8.1 (swiftlang-5.8.0.124.5 clang-1403.0.22.11.100)4 Didomi arm64-apple-ios10.0 }+ 2 JЩ ¸» 5= c:@M@Didomi@objc(cs)Didomi(im)addVendorStatusListenerWithId::- Listen for changes on the status of a vendor. Ç /** | |
| 10 | Listen for changes on the status of a vendor. | |
| 11 | ||
| 12 | - Parameter id: vendor ID. | |
| 13 | - Parameter callback: callback to be executed when there are changes on the specified vendor. | |
| 14 | */ ¥d i c:@M@Didomi@E@ConsentStatus& Consent status to a vendor or purpose. + /// Consent status to a vendor or purpose. | |
| 15 | X J% ¡ c:@M@Didomi@objc(cs)DDMVendor(py)urlsB Privacy policy and LI disclaimer urls. Introduced in IAB TCF v2.2. G /// Privacy policy and LI disclaimer urls. Introduced in IAB TCF v2.2. | |
| 16 | ¼ýà c:@M@Didomi@objc(cs)DDMVendor8 Public class representing a single Vendor configuration. = /// Public class representing a single Vendor configuration. | |
| 17 | ¥! s:6Didomi21UserAuthWithoutParamsC1 User Authentication Parameters without encryption < /** | |
| 18 | * User Authentication Parameters without encryption | |
| 19 | */ ůüU E s:e:c:@CM@Didomi@objc(cs)Didomi(im)getNoticeViewControllerWithPosition:noticeSkipped: Here we implement the ViewProviderDelegate protocol to provide the default view controllers. If we need to provide custom view controllers, the ViewProviderDelegate protocol will have to be implemented and the appropriate view controllers will have to be returned. a /// Here we implement the ViewProviderDelegate protocol to provide the default view controllers. | |
| 20 | q /// If we need to provide custom view controllers, the ViewProviderDelegate protocol will have to be implemented | |
| 21 | C /// and the appropriate view controllers will have to be returned. | |
| 22 | ||
| 23 | âEÛ. K s:e:s:So19NSRegularExpressionC6DidomiEyABSScfc Better RegEx management /// Better RegEx management | |
| 24 | wfÚ( 1 c:@M@Didomi@objc(pl)ViewProviderDelegateþ Protocol used to provide the view controllers for the preferences/purposes and notice view. To provide customs views, this protocol will have to be implemented. This protocol is implemented by the Didomi singleton to provide the default view controllers. ` /// Protocol used to provide the view controllers for the preferences/purposes and notice view. | |
| 25 | I /// To provide customs views, this protocol will have to be implemented. | |
| 26 | b /// This protocol is implemented by the Didomi singleton to provide the default view controllers. | |
| 27 | x©ð$ s:6Didomi24DataProcessingNamespacesV3 Struct used to represent a Namespaces in a Purpose. 8 /// Struct used to represent a Namespaces in a Purpose. | |
| 28 | yز2 | c:@M@Didomi@objc(cs)Didomi(im)getRequiredVendorIds% Get the configured vendor IDs @return ? /** | |
| 29 | * Get the configured vendor IDs | |
| 30 | * @return | |
| 31 | */ ì>êK E c:@M@Didomi@objc(cs)DDMEventListener(py)onPreferencesClickAgreeToAllVendors Preferences - Vendor /// Preferences - Vendor | |
| 32 | èé ) Ñ s:e:c:objc(cs)JSValues:6Didomi0A7JSValuePZ JSValue should already implement all the properties and methods declared in DidomiJSValue. _ /// JSValue should already implement all the properties and methods declared in DidomiJSValue. | |
| 33 | èó- c:@CM@Didomi@objc(cs)Didomi(im)setUserWithId:! Set organization user information b /** | |
| 34 | Set organization user information | |
| 35 | ||
| 36 | - Parameter id: Organization user ID | |
| 37 | */ - Îgì g s:e:s:SD6DidomiE5mergeyySDyxq_GF% Extension file for Dictionary struct. * /// Extension file for Dictionary struct. | |
| 38 | !Mäk3 ç c:@CM@Didomi@objc(cs)Didomi(im)isPreferencesVisible8 Method used to check if the Preferences view is visible. /** | |
| 39 | Method used to check if the Preferences view is visible. | |
| 40 | - Returns: **true** if Preferences view is visible, **false** otherwise. | |
| 41 | */ ) "æºK$ c:@M@Didomi@objc(cs)DDMEventListenerA Class used as a listener for internal events occurred in the SDK. F /// Class used as a listener for internal events occurred in the SDK. | |
| 42 | #9J% C c:@M@Didomi@objc(cs)DDMVendor(py)name Name of the vendor. /// Name of the vendor. | |
| 43 | $|1 · c:@M@Didomi@objc(cs)Didomi(im)getRequiredPurposes1 Method used to get an array of required purposes. n /** | |
| 44 | Method used to get an array of required purposes. | |
| 45 | - Returns: array of required purposes. | |
| 46 | */ $®&§7 ë c:@CM@Didomi@objc(cs)Didomi(im)shouldConsentBeCollected· 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 /** | |
| 47 | 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 | |
| 48 | ||
| 49 | - Returns: A boolean depending if the consent should be collected or not | |
| 50 | */ $ %Ã9 3 c:@M@Didomi@objc(cs)DDMEventListener(py)onHidePreferences Preferences /// Preferences | |
| 51 | 'aB Þ c:@M@Didomi@objc(cs)CurrentUserStatusTransaction(im)enablePurpose:( Enable a single purpose based on its ID. /** | |
| 52 | Enable a single purpose based on its ID. | |
| 53 | - Parameter id: purpose ID. | |
| 54 | - Returns: current instance of `CurrentUserStatusTransaction`. | |
| 55 | */ 'ªB c:@CM@Didomi@objc(cs)Didomi(im)showPreferencesWithController:view:e Show the preferences screen when/if the SDK is ready. By default the purposes list will be displayed. ¢ /** | |
| 56 | Show the preferences screen when/if the SDK is ready. By default the purposes list will be displayed. | |
| 57 | - Parameter controller: view controller from where preferences will be presented. | |
| 58 | - Parameter view: a value from `Didomi.Views`. It can be `.purposes` or `.sensitivePersonalInformation` or `.vendors` (`ViewsPurposes` or `ViewsSensitivePersonalInformation` or `ViewsVendors` in Objective-C) | |
| 59 | */ ' ( c:@M@Didomi@E@DDMErrorEventType= Enum used to represent a type for the DidomiErrorEvent class. B /// Enum used to represent a type for the DidomiErrorEvent class. | |
| 60 | .4æq+ g c:@M@Didomi@objc(cs)DDMVendor(py)featureIDs% Set with IDs that represent features. * /// Set with IDs that represent features. | |
| 61 | /Ì62 « c:@M@Didomi@objc(cs)DDMVendor(py)specialFeatureIDsG Set with IDs that represent Special Features. Introduced in IAB TCF v2. L /// Set with IDs that represent Special Features. Introduced in IAB TCF v2. | |
| 62 | ||
| 63 | 0D P+ « c:@M@Didomi@objc(cs)DDMVendor(py)purposeIDsG Purpose IDs that the vendor is operating under the consent legal basis. L /// Purpose IDs that the vendor is operating under the consent legal basis. | |
| 64 | 1Üðà2 « c:@M@Didomi@objc(cs)DDMVendor(py)specialPurposeIDsG Set with IDs that represent Special Purposes. Introduced in IAB TCF v2. L /// Set with IDs that represent Special Purposes. Introduced in IAB TCF v2. | |
| 65 | 1xéD G c:@M@Didomi@objc(cs)DDMEventListener(py)onPreferencesClickAgreeToAll Preferences - Purpose /// Preferences - Purpose | |
| 66 | 109Y. ¦ c:@CM@Didomi@objc(cs)Didomi(im)isNoticeVisible: Check if the consent notice is currently displayed @return T /** | |
| 67 | * Check if the consent notice is currently displayed | |
| 68 | * @return | |
| 69 | */ # 4¯Ò> c:@M@Didomi@objc(cs)Didomi(im)removeEventListenerWithListener: Remove an event listener b /** | |
| 70 | Remove an event listener | |
| 71 | ||
| 72 | - Parameter listener: listener to be removed. | |
| 73 | */ 6É -H c:@M@Didomi@objc(cs)UserAuthWithEncryptionParams(py)initializationVector4 Initialization Vector used for computing the user ID G /** | |
| 74 | * Initialization Vector used for computing the user ID | |
| 75 | */ < | |
| 76 | ï¦ ¡ s:e:s:So12NSURLSessionC6DidomiE8dataTask4with17completionHandlerAC014URLSessionDataD8Protocol_p10Foundation10URLRequestV_yAH0I0VSg_So13NSURLResponseCSgs5Error_pSgtctFB Extension added to make sure URLSession adopts URLSessionProtocol. G /// Extension added to make sure URLSession adopts URLSessionProtocol. | |
| 77 | @]çoi S c:@M@Didomi@objc(cs)UserAuthWithHashParams(im)initWithId:algorithm:secretID:digest:salt:legacyExpiration: Initializer for Objective-C /// Initializer for Objective-C | |
| 78 | A¹¾: " c:@M@Didomi@objc(cs)CurrentUserStatusTransaction(im)commitW Commit the user status changes made through the âenableâ and âdisableâ methods. ³ /** | |
| 79 | Commit the user status changes made through the "enable" and "disable" methods. | |
| 80 | - Returns: **true** if user's choices have been updated, **false** otherwise. | |
| 81 | */ DRÞb { s:6Didomi6VendorC10NamespacesC/ Store additional IDs (IAB, num) for the Vendor. 4 /// Store additional IDs (IAB, num) for the Vendor. | |
| 82 | E*àö/ c:@M@Didomi@objc(cs)Didomi(im)getIABVendorCount Get number of IAB vendors R /** | |
| 83 | Get number of IAB vendors | |
| 84 | - Returns the count of IAB vendors | |
| 85 | */ Gc¢A u c:@M@Didomi@E@DDMEventType@DDMEventTypeNoticeClickViewSPIPurposes, Preferences - Sensitive Personal Information 1 /// Preferences - Sensitive Personal Information | |
| 86 | HÖ, ã c:@CM@Didomi@objc(cs)Didomi(im)getUserStatus] Get an instance of UserStatus containing all the information related to the userâs choices. n /** | |
| 87 | Get an instance of `UserStatus` containing all the information related to the user's choices. | |
| 88 | */ 2 IKÕ. Ô c:@CM@Didomi@objc(cs)Didomi(im)getTextWithKey: Method used to get a dictionary/map in the form of { âenâ: âKey in Englishâ, âfrâ: âKey in French.â } for a given key. 6 /** | |
| 89 | Method used to get a dictionary/map in the form of { "en": "Key in English", "fr": "Key in French." } | |
| 90 | for a given key. | |
| 91 | ||
| 92 | - Parameter key: used to find its corresponding value in the dictionary/map. | |
| 93 | - Returns: dictionary containing the different translations for a given key. | |
| 94 | */ + Mt?õ~ ç c:@M@Didomi@objc(cs)Didomi(im)setUserConsentStatusWithEnabledPurposeIds:disabledPurposeIds:enabledVendorIds:disabledVendorIds: Set the user consent status. ³ /** | |
| 95 | Set the user consent status. | |
| 96 | ||
| 97 | - Parameter enabledPurposeIds: set containing **enabled purpose ids** | |
| 98 | - Parameter disabledPurposeIds: set containing **disabled purpose ids** | |
| 99 | - Parameter enabledVendorIds: set containing **enabled vendor ids** | |
| 100 | - Parameter disabledVendorIds: set containing **disabled purpose ids** | |
| 101 | ||
| 102 | - Returns: **true** if consent status has been updated, **false** otherwise. | |
| 103 | */ OH@6 & c:@M@Didomi@objc(cs)Didomi(im)getQueryStringForWebView Get a query-string to add to the URL of a WebView or Chrome Custom Tab to pass the consent status from the app to the Didomi Web SDK embedded on the target URL. n /** | |
| 104 | Get a query-string to add to the URL of a WebView or Chrome Custom Tab to pass the consent status from the app to the Didomi Web SDK embedded on the target URL. | |
| 105 | ||
| 106 | The returned parameter will have the format `didomiConfig.user.externalConsent.value=...` It includes the user consent information URL-encoded and JSON-encoded. | |
| 107 | Append the returned query-string parameter to the URL of your WebView or SFSafariViewController. | |
| 108 | ||
| 109 | See https://developers.didomi.io/cmp/mobile-sdk/share-consent-with-webviews for more information. | |
| 110 | ||
| 111 | - Returns: Query string parameter to append to URL | |
| 112 | */ Qáü> c:@CM@Didomi@objc(cs)Didomi(im)setupUIWithContainerController:3 Provide the objects required to display UI elements F /** | |
| 113 | * Provide the objects required to display UI elements | |
| 114 | */ Sð@Ä1 Ã c:@M@Didomi@objc(cs)DDMVendor(py)legIntPurposeIDsS Purpose IDs that the vendor is operating under the legitimate interest legal basis. X /// Purpose IDs that the vendor is operating under the legitimate interest legal basis. | |
| 115 | S\²÷; É c:@M@Didomi@objc(cs)Didomi(im)setUserAgentWithName:version:' Set custom user agent name and version. /** | |
| 116 | Set custom user agent name and version. | |
| 117 | ||
| 118 | - Parameter name: Agent name. | |
| 119 | - Parameter version: Agent version. | |
| 120 | */ S¹Ù'( s:6Didomi21UserAuthWithoutParamsC2idSSvp* Organization ID to associate with the user = /** | |
| 121 | * Organization ID to associate with the user | |
| 122 | */ SôáÅ? è c:@M@Didomi@objc(cs)Didomi(im)getJavaScriptForWebViewWithExtra:~ Get JavaScript to embed into a WebView to pass the consent status from the app to the Didomi Web SDK embedded into the WebView R /** | |
| 123 | Get JavaScript to embed into a WebView to pass the consent status from the app | |
| 124 | to the Didomi Web SDK embedded into the WebView | |
| 125 | ||
| 126 | Inject the returned JavaScript into a WebView | |
| 127 | ||
| 128 | - Parameter extra: Extra JavaScript to inject in the returned code | |
| 129 | - Returns: JavaScript code to inject in a WebView | |
| 130 | */ Wa_¹2 c:@M@Didomi@objc(cs)Didomi(im)onReadyWithCallback:¨ Provide a function that needs to be called once the SDK is ready Automatically call the function if the SDK is already ready (thatâs why this is not a standard event) À /** | |
| 131 | * Provide a function that needs to be called once the SDK is ready | |
| 132 | * Automatically call the function if the SDK is already ready (that's why this is not a standard event) | |
| 133 | */ | |
| 134 | ZRB è c:@M@Didomi@objc(cs)CurrentUserStatusTransaction(im)enableVendors:( Enable vendors based on an array of IDs. ¨ /** | |
| 135 | Enable vendors based on an array of IDs. | |
| 136 | - Parameter ids: array of vendor IDs. | |
| 137 | - Returns: current instance of `CurrentUserStatusTransaction`. | |
| 138 | */ [ 8 K | |
| 139 | c:@CM@Didomi@objc(cs)Didomi(im)getTranslatedTextWithKey:2 Method used to get a translated text based on the key being passed. The language and the source of this translated text will depend on the availability of the translation for the specific key. The language being used will be either the selected language of the SDK (based on device Locale and other parameters) or the language specified by app developers as the default language being used by the SDK. The source can be either the didomi_config.json file which can be either local or remote, or the didomi_master_config.json file which is bundled within the SDK. /** | |
| 140 | Method used to get a translated text based on the key being passed. | |
| 141 | The language and the source of this translated text will depend on the availability of the translation for the specific key. | |
| 142 | The language being used will be either the selected language of the SDK (based on device Locale and other parameters) or the language specified by app developers as the default language being used by the SDK. The source can be either the `didomi_config.json` file which can be either local or remote, or the `didomi_master_config.json` file which is bundled within the SDK. | |
| 143 | ||
| 144 | These are the attempts performed by the SDK to try to find a translation for the specific key: | |
| 145 | - Get translated value in user locale (selected language) from `didomi_config.json` (either local or remote). | |
| 146 | - Get translated value in default locale (from the config) from `didomi_config.json` (either local or remote). | |
| 147 | - Get translated value in user locale (selected language) from `didomi_master_config.json` (bundled within the Didomi SDK). | |
| 148 | - Get translated value in default locale (from the config) from `didomi_master_config.json` (bundled within the Didomi SDK). | |
| 149 | ||
| 150 | If no translation can be found after these 4 attempts, the key will be returned. | |
| 151 | ||
| 152 | App developers can provide these translated texts through the `didomi_config.json` file (locally or remotely) in 3 different ways: | |
| 153 | - Custom texts for the consent notice: https://developers.didomi.io/cmp/mobile-sdk/consent-notice/customize-the-notice#texts | |
| 154 | - Custom texts for the preferences: https://developers.didomi.io/cmp/mobile-sdk/consent-notice/customize-the-preferences-popup#text | |
| 155 | - Custom texts for custom notices: https://developers.didomi.io/cmp/mobile-sdk/consent-notice/customize-the-theme#translatable-texts-for-custom-notices | |
| 156 | ||
| 157 | - Parameter key: used to find its corresponding value in one of the different sources. | |
| 158 | - Returns: a translated string if a translation was found, the same key that was passed otherwise. | |
| 159 | */ * ]Ü*°8 Ç c:@M@Didomi@objc(cs)DDMEventListener(py)onConsentChangedO Closures used to execute code when the different events are triggered. Internal K /// Closures used to execute code when the different events are triggered. | |
| 160 | /// Internal | |
| 161 | ]·À1 } c:@M@Didomi@objc(cs)Didomi(im)getTotalVendorCount Get number of vendors. O /** | |
| 162 | Get number of vendors. | |
| 163 | - Returns the count of all vendors | |
| 164 | */ a®®s6 ð c:@M@Didomi@objc(cs)Didomi(im)getPurposeWithPurposeId:- Method used to get a Purpose based on its ID. « /** | |
| 165 | Method used to get a Purpose based on its ID. | |
| 166 | ||
| 167 | - Parameter purposeId: purpose ID used in the search. | |
| 168 | - Returns: purpose found in the array. | |
| 169 | */ d5v¼0 ´ c:@M@Didomi@objc(cs)Didomi(im)getRequiredVendors0 Method used to get an array of required vendors. l /** | |
| 170 | Method used to get an array of required vendors. | |
| 171 | - Returns: array of required vendors. | |
| 172 | */ i0o s:6Didomi6VendorC3URLC5 Store localized URLs for privacy policy and LI claim. : /// Store localized URLs for privacy policy and LI claim. | |
| 173 | kèQ]3 ñ c:@CM@Didomi@objc(cs)Didomi(im)getCurrentUserStatusd Get an instance of CurrentUserStatus containing all the information related to the userâs choices. u /** | |
| 174 | Get an instance of `CurrentUserStatus` containing all the information related to the user's choices. | |
| 175 | */ 3 k ÄQ? ¹ c:@M@Didomi@objc(cs)Didomi(im)removeVendorStatusListenerWithId:5 Stop listening for changes on the status of a vendor. l /** | |
| 176 | Stop listening for changes on the status of a vendor. | |
| 177 | ||
| 178 | - Parameter id: vendor ID. | |
| 179 | */ kêuI( Ñ c:@CM@Didomi@objc(cs)Didomi(im)clearUserT Remove organization user information (should be called when the SDK is initialized). e /** | |
| 180 | Remove organization user information (should be called when the SDK is initialized). | |
| 181 | */ 1 m`âs/ 1 c:@M@Didomi@objc(cs)Didomi(im)setUserAgreeToAll[ Method that allows to enable consent and legitimate interest for all the required purposes. ¾ /** | |
| 182 | Method that allows to enable consent and legitimate interest for all the required purposes. | |
| 183 | - Returns: **true** if consent status has been updated, **false** otherwise. | |
| 184 | */ o&&$ Y c:@M@Didomi@objc(cs)DDMPurpose(py)id Purpose id used by Didomi SDK. # /// Purpose id used by Didomi SDK. | |
| 185 | o¨S; c:@M@Didomi@objc(cs)Didomi(im)addEventListenerWithListener: Add an event listener ] /** | |
| 186 | Add an event listener | |
| 187 | ||
| 188 | - Parameter listener: listener to be added. | |
| 189 | */ pç¿/ s:e:s:Sa6DidomiAA6EntityRzlE10sortedByIdSayxGyF6 Extension used to sort Entity list (Purpose or Vendor) ; /// Extension used to sort Entity list (Purpose or Vendor) | |
| 190 | sÆ·tI c:@CM@Didomi@objc(cs)Didomi(im)setCurrentUserStatusWithCurrentUserStatus: Save userâs choices. Ý /** | |
| 191 | Save user's choices. | |
| 192 | ||
| 193 | - Parameter currentUserStatus: instance of CurrentUserStatus containing the user's choices. | |
| 194 | - Returns: **true** if user's choices have been saved, **false** otherwise. | |
| 195 | */ 4 u"íã S c:@M@Didomi@objc(cs)Didomi(im)setUserStatusWithEnabledConsentPurposeIds:disabledConsentPurposeIds:enabledLIPurposeIds:disabledLIPurposeIds:enabledConsentVendorIds:disabledConsentVendorIds:enabledLIVendorIds:disabledLIVendorIds:Q Set the user status for purposes and vendors for consent and legitimate interest. ê /** | |
| 196 | Set the user status for purposes and vendors for consent and legitimate interest. | |
| 197 | - Parameter enabledConsentPurposeIds: List of purpose IDs to enable for consent. | |
| 198 | - Parameter disabledConsentPurposeIds: List of purpose IDs to disable for consent. | |
| 199 | - Parameter enabledLIPurposeIds: List of purpose IDs to enable for LI. | |
| 200 | - Parameter disabledLIPurposeIds: List of purpose IDs to disable for LI. | |
| 201 | - Parameter enabledConsentVendorIds: List of vendor IDs to enable for consent. | |
| 202 | - Parameter disabledConsentVendorIds: List of vendor IDs to disable for consent. | |
| 203 | - Parameter enabledLIVendorIds: List of vendor IDs to enable for LI. | |
| 204 | - Parameter disabledLIVendorIds: List of vendor IDs to disable for LI. | |
| 205 | */ |®ÃM ¾ c:@CM@Didomi@objc(cs)Didomi(im)setUserWithUserAuthParams:containerController:w Set organization user information with authentication, and display consent notice if it is needed after synchronization / /** | |
| 206 | Set organization user information with authentication, and display consent notice if it is needed after synchronization | |
| 207 | ||
| 208 | - Parameter userAuthParams: Organization user authentication params | |
| 209 | - Parameter containerController: View controller from which we can setup Didomi UI | |
| 210 | */ 0 ôs ã c:@M@Didomi@E@Regulationc Regulation for which Didomi SDK is currently configured. Only one regulation is active at each run. h /// Regulation for which Didomi SDK is currently configured. Only one regulation is active at each run. | |
| 211 | M0 c:@M@Didomi@objc(cs)UserAuthWithEncryptionParams. User Authentication Parameters with encryption 9 /** | |
| 212 | * User Authentication Parameters with encryption | |
| 213 | */ #åK+ c:@M@Didomi@objc(cs)DDMVendor(py)namespaces@ Namespaces of the vendor (IAB, num) and their corresponding IDs. E /// Namespaces of the vendor (IAB, num) and their corresponding IDs. | |
| 214 | fðï? « c:@CM@Didomi@objc(cs)Didomi(im)openCurrentUserStatusTransaction Create an instance of theCurrentUserStatusTransaction class. This class is used to asynchronously enable and disable purposes and vendors through different methods. These changes will not be reflected on the user status until the commit method of the returned object is called. } /** | |
| 215 | Create an instance of the`CurrentUserStatusTransaction` class. | |
| 216 | This class is used to asynchronously enable and disable purposes and vendors through different methods. | |
| 217 | These changes will not be reflected on the user status until the `commit` method of the returned object is called. | |
| 218 | - Returns: an instance of the `CurrentUserStatusTransaction` class | |
| 219 | */ 5 5* m c:@M@Didomi@objc(cs)DDMVendor(py)policyUrl( URL to the privacy policy of the vendor. - /// URL to the privacy policy of the vendor. | |
| 220 | qÛl) á c:@CM@Didomi@objc(cs)Didomi(im)showNotice[ Show the consent notice (if required, not disabled in the config and not already displayed) n /** | |
| 221 | * Show the consent notice (if required, not disabled in the config and not already displayed) | |
| 222 | */ ! åÕ1 s:e:s:So16UIViewControllerC6DidomiE9isVisibleSbyF@ Extension created to ease the interaction with view controllers. E /// Extension created to ease the interaction with view controllers. | |
| 223 | ×/-^ Ö c:@M@Didomi@objc(pl)ViewProviderDelegate(im)getNoticeViewControllerWithPosition:noticeSkipped:Q Method used to provide a view controller that will be used to display the notice. m /** | |
| 224 | Method used to provide a view controller that will be used to display the notice. | |
| 225 | - Parameter position: string that represents the position of the notice (e.g.: bottom, popup, etc.). | |
| 226 | - Parameter skipped: Whether notice display is skipped and Preferences are displayed directly | |
| 227 | - Returns: the view controller associated to the notice. | |
| 228 | */ Ç'L2 c:@M@Didomi@objc(cs)Didomi(im)onErrorWithCallback:H Accepts a closure that will be called if an unexpected situation occurs. ¬ /** | |
| 229 | Accepts a closure that will be called if an unexpected situation occurs. | |
| 230 | - Parameter callback: closure to be called if an unexpected situation occurs. | |
| 231 | */ ' s:6Didomi14UserAuthParamsC8secretIDSSvp3 ID of the secret used for the computing the user ID F /** | |
| 232 | * ID of the secret used for the computing the user ID | |
| 233 | */ ¼ì) ² c:@M@Didomi@objc(cs)Didomi(im)initialize: Initialize the Didomi SDK /** | |
| 234 | Initialize the Didomi SDK | |
| 235 | ||
| 236 | - Parameter parameters: object specifying parameters to initialize the SDK. | |
| 237 | */ q)0 c:@M@Didomi@objc(cs)CurrentUserStatusTransaction¹ Class used to asynchronously enable and disable purposes and vendors through different methods. These changes will not be reflected on the user status until the commit method is called. d /// Class used to asynchronously enable and disable purposes and vendors through different methods. | |
| 238 | ` /// These changes will not be reflected on the user status until the `commit` method is called. | |
| 239 | hV . y c:@CM@Didomi@objc(cs)Didomi(im)hidePreferences' Hide the preferences popup for purposes : /** | |
| 240 | * Hide the preferences popup for purposes | |
| 241 | */ ( Dg© c:@M@Didomi@objc(cs)DDMVendor(im)initWithId:name:policyUrl:namespaces:purposeIDs:legIntPurposeIDs:featureIDs:flexiblePurposeIDs:specialPurposeIDs:specialFeatureIDs:urls:) Initializer method for the Purpose class. Q /** | |
| 242 | Initializer method for the Purpose class. | |
| 243 | - Parameters: | |
| 244 | - id: Unique ID of the vendor. | |
| 245 | - name: Name of the vendor. | |
| 246 | - policyUrl: URL to the privacy policy of the vendor. | |
| 247 | - namespaces: Namespaces of the vendor (IAB, num) and their corresponding IDs. | |
| 248 | - purposeIDs: Purpose IDs that the vendor is operating under the consent legal basis. | |
| 249 | - legIntPurposeIDs: Purpose IDs that the vendor is operating under the legitimate interest legal basis. | |
| 250 | - featureIDs: Set with IDs that represent features. | |
| 251 | - flexiblePurposeIDs: Set with IDs that represent flexible purposes. | |
| 252 | - specialPurposeIDs: Set with IDs that represent Special Purposes. | |
| 253 | - specialFeatureIDs: Set with IDs that represent Special Features. | |
| 254 | - urls: Privacy policy and LI disclaimer urls. | |
| 255 | */ ¥ægC à c:@M@Didomi@objc(cs)CurrentUserStatusTransaction(im)disablePurpose:) Disable a single purpose based on its ID. /** | |
| 256 | Disable a single purpose based on its ID. | |
| 257 | - Parameter id: purpose ID. | |
| 258 | - Returns: current instance of `CurrentUserStatusTransaction`. | |
| 259 | */ Y®C ë c:@M@Didomi@objc(cs)CurrentUserStatusTransaction(im)enablePurposes:) Enable purposes based on an array of IDs. ª /** | |
| 260 | Enable purposes based on an array of IDs. | |
| 261 | - Parameter ids: array of purpose IDs. | |
| 262 | - Returns: current instance of `CurrentUserStatusTransaction`. | |
| 263 | */ DQ" ø c:@M@Didomi@objc(cs)UserAuthParamsi Protocol for User Authentication Parameters declare the common properties of encryption / hash parameters w /** | |
| 264 | * Protocol for User Authentication Parameters | |
| 265 | * declare the common properties of encryption / hash parameters | |
| 266 | */ ³ÍJ9 â c:@CM@Didomi@objc(cs)Didomi(im)setUserWithUserAuthParams:5 Set organization user information with authentication /** | |
| 267 | Set organization user information with authentication | |
| 268 | ||
| 269 | - Parameter userAuthParams: Organization user authentication params | |
| 270 | */ / ¥ÞÆ·# k c:@M@Didomi@objc(cs)Didomi(im)reset Remove all consents for the user 3 /** | |
| 271 | * Remove all consents for the user | |
| 272 | */ §_»dD í c:@M@Didomi@objc(cs)CurrentUserStatusTransaction(im)disablePurposes:* Disable purposes based on an array of IDs. « /** | |
| 273 | Disable purposes based on an array of IDs. | |
| 274 | - Parameter ids: array of purpose IDs. | |
| 275 | - Returns: current instance of `CurrentUserStatusTransaction`. | |
| 276 | */ §³õ{ c:@M@Didomi@objc(cs)Didomi(im)setUserStatusWithPurposesConsentStatus:purposesLIStatus:vendorsConsentStatus:vendorsLIStatus:Q Set the user status for purposes and vendors for consent and legitimate interest. ª /** | |
| 277 | Set the user status for purposes and vendors for consent and legitimate interest. | |
| 278 | - Parameter purposesConsentStatus: boolean used to determine if consent will be enabled or disabled for all purposes. | |
| 279 | - Parameter purposesLIStatus: boolean used to determine if legitimate interest will be enabled or disabled for all purposes. | |
| 280 | - Parameter vendorsConsentStatus: boolean used to determine if consent will be enabled or disabled for all vendors. | |
| 281 | - Parameter vendorsLIStatus: boolean used to determine if legitimate interest will be enabled or disabled for all vendors. | |
| 282 | - Returns: **true** if consent status has been updated, **false** otherwise. | |
| 283 | */ §Jm%E ù c:@M@Didomi@objc(cs)Didomi(im)updateSelectedLanguageWithLanguageCode:´ Method used to update the selected language of the Didomi SDK and any property that depends on it. In most cases this method doesnât need to be called. It would only be required for those apps that allow language change on-the-fly, i.e.: from within the app rather than from the device settings. In order to update the language of the views displayed by the Didomi SDK, this method needs to be called before these views are displayed. - /** | |
| 284 | Method used to update the selected language of the Didomi SDK and any property that depends on it. | |
| 285 | In most cases this method doesn't need to be called. It would only be required for those apps that allow language change on-the-fly, i.e.: from within the app rather than from the device settings. | |
| 286 | In order to update the language of the views displayed by the Didomi SDK, this method needs to be called before these views are displayed. | |
| 287 | ||
| 288 | - Parameter languageCode: string containing the language code e.g.: "es", "fr", etc. | |
| 289 | */ ¨QyX c:@M@Didomi@objc(cs)DDMPurpose9 Public class representing a single Purpose configuration. > /// Public class representing a single Purpose configuration. | |
| 290 | ¨ïØÁ2 c:@M@Didomi@objc(cs)UserAuthWithHashParams(py)salt. Salt used for computing the user ID (optional) A /** | |
| 291 | * Salt used for computing the user ID (optional) | |
| 292 | */ h<F C c:@M@Didomi@objc(cs)DDMEventListener(py)onPreferencesClickViewPurposes Preferences - Views /// Preferences - Views | |
| 293 | ìc2 K c:@M@Didomi@objc(cs)Didomi(im)setUserDisagreeToAllh Method that allows to disable consent and legitimate interest for all the required purposes and vendors. Ë /** | |
| 294 | Method that allows to disable consent and legitimate interest for all the required purposes and vendors. | |
| 295 | - Returns: **true** if consent status has been updated, **false** otherwise. | |
| 296 | */ ¯ÔoI u c:@M@Didomi@objc(cs)DDMEventListener(py)onPreferencesClickSPIPurposeAgree, Preferences - Sensitive Personal Information 1 /// Preferences - Sensitive Personal Information | |
| 297 | ±6@, s:6Didomi14UserAuthParamsC10expirationSdSgvp8 Expiration date as timestamp (to prevent replay attacks) K /** | |
| 298 | * Expiration date as timestamp (to prevent replay attacks) | |
| 299 | */ ´MÖ|B Ý c:@M@Didomi@objc(cs)CurrentUserStatusTransaction(im)disableVendor:( Disable a single vendor based on its ID. /** | |
| 300 | Disable a single vendor based on its ID. | |
| 301 | - Parameter id: vendor ID. | |
| 302 | - Returns: current instance of `CurrentUserStatusTransaction`. | |
| 303 | */ ¹g#·/ Ò c:@M@Didomi@objc(cs)Didomi(im)isConsentRequiredR Determine if the user is subject to a regulation that requires consent collection. h /** | |
| 304 | Determine if the user is subject to a regulation that requires consent collection. | |
| 305 | ||
| 306 | This along with the choices that the user has or has not made | |
| 307 | will determine each time that the SDK is initialized if the notice should be displayed or not. | |
| 308 | ||
| 309 | - Returns: **true** if consent is required, **false** if it is not required. | |
| 310 | */ º"BÁ* s c:@M@Didomi@objc(cs)UserAuthWithHashParams( User Authentication Parameters with hash 3 /** | |
| 311 | * User Authentication Parameters with hash | |
| 312 | */ ¿ ¤- © s:e:s:So18NSAttributedStringC6DidomiE7strings6bullet11indentation11lineSpacing09paragraphH0ABSaySSG_SS14CoreFoundation7CGFloatVA2LtcfcF Extension created to add functionality to the NSAttributedString class K /// Extension created to add functionality to the NSAttributedString class | |
| 313 | Ãn H& c:@M@Didomi@objc(cs)DDMPurpose(py)name= Purpose human-readable name, translated in selected language. B /// Purpose human-readable name, translated in selected language. | |
| 314 | Ã{¤" c:@M@Didomi@objc(pl)UserAuth(py)id* Organization ID to associate with the user = /** | |
| 315 | * Organization ID to associate with the user | |
| 316 | */ Äí9 - c:@M@Didomi@objc(cs)DDMEventListener(py)onLanguageUpdated Language /// Language | |
| 317 | ÅãäC â s:6Didomi0A10ErrorEventC15descriptionText4typeACSS_AA0abC4TypeOtcfc Initilizer for DidomiErrorEvent. ª /** | |
| 318 | Initilizer for DidomiErrorEvent. | |
| 319 | - Parameter descriptionText: text used to describe the error. | |
| 320 | - Parameter type: type use to clasify the error. | |
| 321 | */ Ç C ê c:@M@Didomi@objc(cs)CurrentUserStatusTransaction(im)disableVendors:) Disable vendors based on an array of IDs. © /** | |
| 322 | Disable vendors based on an array of IDs. | |
| 323 | - Parameter ids: array of vendor IDs. | |
| 324 | - Returns: current instance of `CurrentUserStatusTransaction`. | |
| 325 | */ Ëëÿ71 c:@M@Didomi@objc(cs)DDMPurpose(py)descriptionText5 Purpose description, translated in selected language. : /// Purpose description, translated in selected language. | |
| 326 | Ïɨ|# ç c:@M@Didomi@objc(cs)DDMVendor(py)idg Unique ID of the vendor provided by Didomi. This ID does not include prefixes. Example: âvendor-1â. h /// Unique ID of the vendor provided by Didomi. This ID does not include prefixes. Example: "vendor-1". | |
| 327 | Ðë+ S s:e:s:So12UIScrollViewC6DidomiE7isAtTopSbvp Extension for scroll status /// Extension for scroll status | |
| 328 | ÐH³Ñ2 c:@M@Didomi@objc(cs)Didomi(im)getNonIABVendorCount Get number of non-IAB vendors Z /** | |
| 329 | Get number of non-IAB vendors | |
| 330 | - Returns the count of non-IAB vendors | |
| 331 | */ ÑoR3 } c:@M@Didomi@objc(cs)Didomi(im)getRequiredPurposeIds Get the configured purpose IDs G /** | |
| 332 | * Get the configured purpose IDs | |
| 333 | * | |
| 334 | * @return | |
| 335 | */ ÑùÜß2 ¯ c:@CM@Didomi@objc(cs)Didomi(im)isUserStatusPartial Check if user status is partial x /** | |
| 336 | Check if user status is partial | |
| 337 | - Returns: **true** if user status is partial, **false** otherwise | |
| 338 | */ & ÓÅ.% Y c:@M@Didomi@objc(cs)Didomi(im)isReady Is the Didomi SDK ready? ) /** | |
| 339 | Is the Didomi SDK ready? | |
| 340 | */ Ôícy4 { c:@M@Didomi@objc(cs)UserAuthWithHashParams(py)digest( Digest used for representing the user ID ; /** | |
| 341 | * Digest used for representing the user ID | |
| 342 | */ Ôë[x S c:@M@Didomi@objc(cs)UserAuthWithEncryptionParams(im)initWithId:algorithm:secretID:initializationVector:legacyExpiration: Initializer for Objective-C /// Initializer for Objective-C | |
| 343 | ||
| 344 | ײe. c:@CM@Didomi@objc(cs)Didomi(im)forceShowNotice¯ Force show the consent notice without checking if consent is required Important: Do not keep a local reference to the View Controller itself as that could create a memory leak É /** | |
| 345 | * Force show the consent notice without checking if consent is required | |
| 346 | * Important: Do not keep a local reference to the View Controller itself as that could create a memory leak | |
| 347 | */ ÚAN=H » s:e:c:objc(cs)NSURLSessionDataTasks:6Didomi26URLSessionDataTaskProtocolPÆ Extension added to make sure URLSessionDataTask adopts URLSessionDataTaskProtocol. URLSessionDataTask class already implements the resume method so we donât have to include that in this extension. W /// Extension added to make sure URLSessionDataTask adopts URLSessionDataTaskProtocol. | |
| 348 | ~ /// **URLSessionDataTask** class already implements the **resume** method so we don't have to include that in this extension. | |
| 349 | Ú°/ % c:@M@Didomi@E@DDMEventType@DDMEventTypeSyncDone Sync /// Sync | |
| 350 | Ûe&3 c:@M@Didomi@objc(cs)DDMVendor(py)flexiblePurposeIDsH Set with IDs that represent flexible purposes. Introduced in IAB TCF v2. M /// Set with IDs that represent flexible purposes. Introduced in IAB TCF v2. | |
| 351 | ÝAë7 6 c:@CM@Didomi@objc(cs)Didomi(im)setLogLevelWithMinLevel:( Set the minimum level of messages to log ö /** | |
| 352 | Set the minimum level of messages to log | |
| 353 | ||
| 354 | Messages with a level below `minLevel` will not be logged. | |
| 355 | Levels are standard levels from `OSLogType` (https://developer.apple.com/documentation/os/logging/choosing_the_log_level_for_a_message): | |
| 356 | - OSLogType.info (1) | |
| 357 | - OSLogType.debug (2) | |
| 358 | - OSLogType.error (16) | |
| 359 | - OSLogType.fault (17) | |
| 360 | ||
| 361 | We recommend setting `OSLogType.error` (16) in production | |
| 362 | ||
| 363 | - Parameter minLevel: Minimum level of messages to log | |
| 364 | */ , á{ìm. m c:@M@Didomi@objc(cs)DidomiInitializeParameters( Initialization parameters for Didomi SDK - /// Initialization parameters for Didomi SDK | |
| 365 | á¿!£( c:@M@Didomi@objc(cs)UserAuthParams(py)id* Organization ID to associate with the user = /** | |
| 366 | * Organization ID to associate with the user | |
| 367 | */ á°'¡C p c:@M@Didomi@objc(cs)Didomi(im)isUserLegitimateInterestStatusPartialh Determine if legitimate interest information is available for all purposes and vendors that are required ð /** | |
| 368 | Determine if legitimate interest information is available for all purposes and vendors that are required | |
| 369 | - Returns: **true** if consent is required and legitimate interest information is available, **false** otherwise. | |
| 370 | */ ᳺ4 ë c:@M@Didomi@objc(cs)Didomi(im)getVendorWithVendorId:, Method used to get a Vendor based on its ID. § /** | |
| 371 | Method used to get a Vendor based on its ID. | |
| 372 | ||
| 373 | - Parameter vendorId: vendor ID used in the search. | |
| 374 | - Returns: vendor found in the array. | |
| 375 | */ á:w$) c:@CM@Didomi@objc(cs)Didomi(im)hideNotice, Hide the notice if it is currently displayed ? /** | |
| 376 | * Hide the notice if it is currently displayed | |
| 377 | */ " ⎛ 6 - c:@M@Didomi@E@DDMEventType@DDMEventTypeLanguageUpdated Language /// Language | |
| 378 | âlP( { s:6Didomi14UserAuthParamsC9algorithmSSvp( Algorithm used for computing the user ID ; /** | |
| 379 | * Algorithm used for computing the user ID | |
| 380 | */ ä}¢B Z c:@M@Didomi@objc(cs)DDMPurpose(im)initWithId:name:descriptionText:) Initializer method for the Purpose class. /** | |
| 381 | Initializer method for the Purpose class. | |
| 382 | - Parameters: | |
| 383 | - id: Purpose id used by Didomi SDK. | |
| 384 | - name: Purpose human-readable name, translated in selected language. | |
| 385 | - descriptionText: Purpose description, translated in selected language. | |
| 386 | */ äl¯H B c:@M@Didomi@objc(pl)ViewProviderDelegate(im)getPreferencesViewControllerd Method used to provide a view controller that will be used to display the preferences/purposes view. Æ /** | |
| 387 | Method used to provide a view controller that will be used to display the preferences/purposes view. | |
| 388 | - Returns: the view controller associated to the preferences/purposes view. | |
| 389 | */ æ% ! « c:@M@Didomi@objc(cs)DDMErrorEventG Type used to represent unexpected situations during SDK initialization. L /// Type used to represent unexpected situations during SDK initialization. | |
| 390 | ç.ÌA Û c:@M@Didomi@objc(cs)CurrentUserStatusTransaction(im)enableVendor:' Enable a single vendor based on its ID. /** | |
| 391 | Enable a single vendor based on its ID. | |
| 392 | - Parameter id: vendor ID. | |
| 393 | - Returns: current instance of `CurrentUserStatusTransaction`. | |
| 394 | */ èüÈ8 L c:@M@Didomi@objc(cs)Didomi(im)isUserConsentStatusPartial\ Determine if consent information is available for all purposes and vendors that are required Ø /** | |
| 395 | Determine if consent information is available for all purposes and vendors that are required | |
| 396 | - Returns: **true** if consent is required and consent information is available, **false** otherwise. | |
| 397 | */ êÞ2 ³ s:6DidomiAAC16setLocalProperty3key5valueySS_ypSgtFK Internal use only. Can activate specific features currently in development. P /// Internal use only. Can activate specific features currently in development. | |
| 398 | 6 í,o: = c:@CM@Didomi@objc(cs)Didomi(im)shouldUserStatusBeCollectedf Determine if the User Status (consent) should be collected or not. User Status should be collected if: ¿ /** | |
| 399 | Determine if the User Status (consent) should be collected or not. User Status should be collected if: | |
| 400 | - Regulation is different from NONE and | |
| 401 | - User status is partial and | |
| 402 | - The number of days before displaying the notice again has exceeded the limit specified on the Console or no User Status has been saved | |
| 403 | ||
| 404 | - Returns: A boolean depending if the User Status (consent) should be collected or not | |
| 405 | */ % ô§Ë×A u c:@CM@Didomi@objc(cs)Didomi(im)setUserWithId:containerController:b Set organization user information and display consent notice if it is needed after synchronization û /** | |
| 406 | Set organization user information and display consent notice if it is needed after synchronization | |
| 407 | ||
| 408 | - Parameter id: Organization user ID | |
| 409 | - Parameter containerController: View controller from which we can setup Didomi UI | |
| 410 | */ . õ®´¨4 ) c:@M@Didomi@objc(cs)DDMEventListener(py)onHideNotice Notice /// Notice | |
| 411 | ü¤9q2 % c:@M@Didomi@objc(cs)DDMEventListener(py)onSyncDone Sync /// Sync | |
| 412 | üh c:@M@Didomi@objc(pl)UserAuth4 Protocol for User Authentication declare the user id B /** | |
| 413 | * Protocol for User Authentication | |
| 414 | * declare the user id | |
| 415 | */ þvuì Q c:@M@Didomi@E@DDMEventType Enum used to define the different type of internal events that can be triggered from the SDK. Please keep the current order because of Unity bridge. b /// Enum used to define the different type of internal events that can be triggered from the SDK. | |
| 416 | ; /// Please keep the current order because of Unity bridge. | |
| 417 | [ í ) Ñ X r | |
| 418 | . Ì ¨ = e 6 ¬ Ð J å © I 4 z X A `! Ê" q# 1$ õ$ & "( * ÿ- Ü. Ô3 5 Ì6 ]A $C XD JE õE 0I J úK ÀL "N fR T U EV W Z ¸Z Ð[ ¬\ î^ :` a éa wd ïi Ql zm n 9w ¹x Ùz ¥{ z| §} ¶ a ½ ø ¾ Ö / Ú f ú Æ 7 % ¾ þ Ø ¡ ¢ ¥ Ц ;§ V¨ " | |
| 419 | h! | |
