Skip to content

Commit b147efe

Browse files
Tweak wording and position of deprecation explanation.
1 parent 978ed4e commit b147efe

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/core.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ export interface ConsentOptions {
150150
*/
151151
confirmed?: boolean | 0;
152152
/**
153+
* @deprecated It was discovered that this value was not being set reliably and was not used by our UI.
153154
* Was the UI shown to the user?
154-
* @deprecated Deprecated because it was discovered to have not been being set reliably, and was not being used by our UI.
155155
*/
156156
prompted?: boolean;
157157
/**
@@ -272,8 +272,8 @@ export type AirgapAPI = Readonly<{
272272
options?: ConsentOptions,
273273
): Promise<boolean> | boolean;
274274
/**
275+
* @deprecated It was discovered that this function was not working reliably, and that the value it set was not used by our UI.
275276
* Sets whether or not the Consent UI has been shown to the user
276-
* @deprecated Deprecated because it was discovered to have not been working reliably, and the value it was attempting to set was not being used by our UI.
277277
*/
278278
setPrompted(state: boolean): Promise<void>;
279279
/** Consents the user to all tracking purposes (requires recent UI interaction) */
@@ -620,8 +620,8 @@ export const CoreTrackingConsentDetails = t.intersection([
620620
/** Has the consent been updated (including no-change confirmation) since default resolution */
621621
updated: t.boolean,
622622
/**
623+
* @deprecated It was discovered that this value was not being set reliably and was not used by our UI.
623624
* Whether or not the UI has been shown to the end-user (undefined in older versions of airgap.js)
624-
* @deprecated Deprecated because it was discovered to have not been being set reliably, and was not being used by our UI.
625625
*/
626626
prompted: t.boolean,
627627
/** Arbitrary metadata that customers want to be associated with consent state */

0 commit comments

Comments
 (0)