@sudoplatform/sudo-privacy-interaction 2.0.0 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/gen/graphqlTypes.js +2291 -780
- package/cjs/private/data/action/actionSubscriptionManager.js +25 -0
- package/cjs/private/data/action/defaultActionService.js +80 -0
- package/cjs/private/data/action/transformer/actionFulfilmentMethodTransformer.js +47 -0
- package/cjs/private/data/action/transformer/actionIntentTransformer.js +69 -0
- package/cjs/private/data/action/transformer/actionOriginTransformer.js +37 -0
- package/cjs/private/data/action/transformer/actionStatusTransformer.js +53 -0
- package/cjs/private/data/action/transformer/actionTransformer.js +85 -0
- package/cjs/private/data/action/transformer/availableActionTransformer.js +37 -0
- package/cjs/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
- package/cjs/private/data/common/apiClient.js +58 -0
- package/cjs/private/data/data-holder/defaultDataHolderService.js +12 -0
- package/cjs/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +56 -0
- package/cjs/private/data/organization-analysis/defaultOrganizationAnalysisService.js +31 -0
- package/cjs/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +29 -0
- package/cjs/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +45 -0
- package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
- package/cjs/private/domain/entities/action/actionEntity.js +86 -0
- package/cjs/private/domain/entities/action/actionService.js +7 -0
- package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +24 -0
- package/cjs/private/domain/entities/organization-analysis/organizationAnalysisService.js +7 -0
- package/cjs/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +25 -0
- package/cjs/private/domain/use-cases/action/initiateActionUseCase.js +26 -0
- package/cjs/private/domain/use-cases/action/listAvailableActionsUseCase.js +26 -0
- package/cjs/private/domain/use-cases/action/subscribeToActionUseCase.js +37 -0
- package/cjs/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +27 -0
- package/cjs/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +29 -0
- package/cjs/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +25 -0
- package/cjs/public/defaultSudoPrivacyInteractionClient.js +133 -6
- package/cjs/public/inputs/action.js +7 -0
- package/cjs/public/inputs/index.js +2 -0
- package/cjs/public/inputs/organizationAnalysis.js +7 -0
- package/cjs/public/typings/action.js +85 -0
- package/cjs/public/typings/index.js +2 -0
- package/cjs/public/typings/organizationAnalysis.js +24 -0
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/DefaultSudoPrivacyInteractionClient.html +176 -21
- package/docs/enums/ActionFulfilmentMethod.html +63 -0
- package/docs/enums/ActionIntent.html +84 -0
- package/docs/enums/ActionOrigin.html +75 -0
- package/docs/enums/ActionStatus.html +99 -0
- package/docs/enums/ConnectionState.html +3 -3
- package/docs/enums/DataCategory.html +18 -18
- package/docs/enums/DataHolderProtectionState.html +5 -5
- package/docs/enums/OrganizationAnalysisMode.html +70 -0
- package/docs/enums/OrganizationCategory.html +30 -30
- package/docs/enums/ProviderType.html +3 -3
- package/docs/enums/RetentionStyle.html +5 -5
- package/docs/enums/ShareStyle.html +6 -6
- package/docs/enums/SignalValue.html +4 -4
- package/docs/enums/VirtualPresenceState.html +7 -7
- package/docs/hierarchy.html +6 -5
- package/docs/interfaces/Action.html +167 -0
- package/docs/interfaces/ActionContact.html +77 -0
- package/docs/interfaces/ActionSubscriber.html +92 -0
- package/docs/interfaces/AnalysisResultSubscriber.html +3 -3
- package/docs/interfaces/AssistedEmailTemplate.html +70 -0
- package/docs/interfaces/AssistedPayload.html +113 -0
- package/docs/interfaces/AvailableAction.html +102 -0
- package/docs/interfaces/CapabilitySignals.html +9 -9
- package/docs/interfaces/CategorySignals.html +11 -11
- package/docs/interfaces/DataHolder.html +24 -14
- package/docs/interfaces/DataHolderScanSummary.html +158 -0
- package/docs/interfaces/DataHolderSubscriber.html +3 -3
- package/docs/interfaces/GetDataHolderOptions.html +63 -0
- package/docs/interfaces/GetOrganizationAnalysisInput.html +70 -0
- package/docs/interfaces/InitiateActionInput.html +79 -0
- package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
- package/docs/interfaces/ListAvailableActionsInput.html +61 -0
- package/docs/interfaces/ListDataHolderScanSummariesInput.html +85 -0
- package/docs/interfaces/ListDataHoldersInput.html +1 -1
- package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
- package/docs/interfaces/OrganizationAnalysis.html +131 -0
- package/docs/interfaces/OrganizationIdentity.html +5 -5
- package/docs/interfaces/Pagination.html +2 -1
- package/docs/interfaces/PrivacyScore.html +13 -5
- package/docs/interfaces/PrivacySummary.html +4 -4
- package/docs/interfaces/RetentionInfo.html +4 -4
- package/docs/interfaces/RiskIndicators.html +8 -8
- package/docs/interfaces/ScoreContribution.html +3 -3
- package/docs/interfaces/ScoreCoverage.html +70 -0
- package/docs/interfaces/SudoPrivacyInteractionClient.html +169 -21
- package/docs/interfaces/VirtualPresence.html +21 -12
- package/docs/interfaces/VirtualPresenceSubscriber.html +3 -3
- package/docs/modules.html +4 -4
- package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
- package/lib/gen/graphqlTypes.js +2290 -779
- package/lib/private/data/action/actionSubscriptionManager.js +21 -0
- package/lib/private/data/action/defaultActionService.js +76 -0
- package/lib/private/data/action/transformer/actionFulfilmentMethodTransformer.js +43 -0
- package/lib/private/data/action/transformer/actionIntentTransformer.js +65 -0
- package/lib/private/data/action/transformer/actionOriginTransformer.js +33 -0
- package/lib/private/data/action/transformer/actionStatusTransformer.js +49 -0
- package/lib/private/data/action/transformer/actionTransformer.js +81 -0
- package/lib/private/data/action/transformer/availableActionTransformer.js +33 -0
- package/lib/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
- package/lib/private/data/common/apiClient.js +59 -1
- package/lib/private/data/data-holder/defaultDataHolderService.js +12 -0
- package/lib/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +52 -0
- package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +27 -0
- package/lib/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +25 -0
- package/lib/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +41 -0
- package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
- package/lib/private/domain/entities/action/actionEntity.js +83 -0
- package/lib/private/domain/entities/action/actionService.js +6 -0
- package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +21 -0
- package/lib/private/domain/entities/organization-analysis/organizationAnalysisService.js +6 -0
- package/lib/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +21 -0
- package/lib/private/domain/use-cases/action/initiateActionUseCase.js +22 -0
- package/lib/private/domain/use-cases/action/listAvailableActionsUseCase.js +22 -0
- package/lib/private/domain/use-cases/action/subscribeToActionUseCase.js +33 -0
- package/lib/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +23 -0
- package/lib/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +25 -0
- package/lib/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +21 -0
- package/lib/public/defaultSudoPrivacyInteractionClient.js +133 -6
- package/lib/public/inputs/action.js +6 -0
- package/lib/public/inputs/index.js +2 -0
- package/lib/public/inputs/organizationAnalysis.js +6 -0
- package/lib/public/typings/action.js +82 -0
- package/lib/public/typings/index.js +2 -0
- package/lib/public/typings/organizationAnalysis.js +21 -0
- package/package.json +5 -3
- package/types/gen/graphqlTypes.d.ts +569 -1
- package/types/private/data/action/actionSubscriptionManager.d.ts +19 -0
- package/types/private/data/action/defaultActionService.d.ts +23 -0
- package/types/private/data/action/transformer/actionFulfilmentMethodTransformer.d.ts +14 -0
- package/types/private/data/action/transformer/actionIntentTransformer.d.ts +14 -0
- package/types/private/data/action/transformer/actionOriginTransformer.d.ts +12 -0
- package/types/private/data/action/transformer/actionStatusTransformer.d.ts +12 -0
- package/types/private/data/action/transformer/actionTransformer.d.ts +39 -0
- package/types/private/data/action/transformer/availableActionTransformer.d.ts +15 -0
- package/types/private/data/common/apiClient.d.ts +16 -1
- package/types/private/data/common/baseSubscriptionManager.d.ts +5 -0
- package/types/private/data/data-holder/defaultDataHolderService.d.ts +3 -1
- package/types/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.d.ts +18 -0
- package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +15 -0
- package/types/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.d.ts +12 -0
- package/types/private/data/organization-analysis/transformer/organizationAnalysisTransformer.d.ts +14 -0
- package/types/private/domain/entities/action/actionEntity.d.ts +187 -0
- package/types/private/domain/entities/action/actionService.d.ts +99 -0
- package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +14 -0
- package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +34 -0
- package/types/private/domain/entities/data-holder/dataHolderService.d.ts +35 -1
- package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +53 -0
- package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +35 -0
- package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +3 -0
- package/types/private/domain/use-cases/action/confirmActionOutcomeUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/action/initiateActionUseCase.d.ts +17 -0
- package/types/private/domain/use-cases/action/listAvailableActionsUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/action/subscribeToActionUseCase.d.ts +27 -0
- package/types/private/domain/use-cases/action/unsubscribeFromActionUseCase.d.ts +15 -0
- package/types/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.d.ts +36 -0
- package/types/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.d.ts +16 -0
- package/types/public/defaultSudoPrivacyInteractionClient.d.ts +19 -3
- package/types/public/inputs/action.d.ts +30 -0
- package/types/public/inputs/dataHolder.d.ts +22 -0
- package/types/public/inputs/index.d.ts +2 -0
- package/types/public/inputs/organizationAnalysis.d.ts +18 -0
- package/types/public/sudoPrivacyInteractionClient.d.ts +64 -3
- package/types/public/typings/action.d.ts +185 -0
- package/types/public/typings/analysisResult.d.ts +14 -0
- package/types/public/typings/dataHolder.d.ts +38 -0
- package/types/public/typings/index.d.ts +2 -0
- package/types/public/typings/organizationAnalysis.d.ts +53 -0
- package/types/public/typings/subscription.d.ts +23 -0
- package/types/public/typings/virtualPresence.d.ts +3 -0
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AssistedPayload | @sudoplatform/sudo-privacy-interaction</title><meta name="description" content="Documentation for @sudoplatform/sudo-privacy-interaction"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-privacy-interaction</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">AssistedPayload</a></li></ul>
|
|
12
|
+
<h1>Interface AssistedPayload</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Materials for an assisted action. The service supplies the organisation
|
|
15
|
+
contact points and any source-provided instructions, but never the user's own
|
|
16
|
+
data.</p>
|
|
17
|
+
<p>AssistedPayload</p>
|
|
18
|
+
</div></section>
|
|
19
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AssistedPayload</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#contact">contact</a><span class="tsd-signature-symbol">?:</span> <a href="ActionContact.html" class="tsd-signature-type tsd-kind-interface">ActionContact</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#emailtemplate">emailTemplate</a><span class="tsd-signature-symbol">?:</span> <a href="AssistedEmailTemplate.html" class="tsd-signature-type tsd-kind-interface">AssistedEmailTemplate</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#instructions">instructions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#jurisdiction">jurisdiction</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#toaddress">toAddress</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#unsubscribemailto">unsubscribeMailto</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#unsubscribeurl">unsubscribeUrl</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
20
|
+
<ul>
|
|
21
|
+
<li>Defined in src/public/typings/action.ts:127</li></ul></aside>
|
|
22
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
23
|
+
<section class="tsd-panel tsd-index-panel">
|
|
24
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
25
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
26
|
+
<div class="tsd-accordion-details">
|
|
27
|
+
<section class="tsd-index-section">
|
|
28
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
29
|
+
<div class="tsd-index-list"><a href="#contact" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>contact?</span></a>
|
|
30
|
+
<a href="#emailtemplate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>email<wbr/>Template?</span></a>
|
|
31
|
+
<a href="#instructions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>instructions?</span></a>
|
|
32
|
+
<a href="#jurisdiction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jurisdiction?</span></a>
|
|
33
|
+
<a href="#toaddress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Address?</span></a>
|
|
34
|
+
<a href="#unsubscribemailto" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>Mailto?</span></a>
|
|
35
|
+
<a href="#unsubscribeurl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>Url?</span></a>
|
|
36
|
+
</div></section></div></details></section></section>
|
|
37
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
38
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
39
|
+
<section>
|
|
40
|
+
<section class="tsd-panel tsd-member">
|
|
41
|
+
<h3 class="tsd-anchor-link" id="contact"><code class="tsd-tag">Optional</code><span>contact</span><a href="#contact" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
42
|
+
<div class="tsd-signature"><span class="tsd-kind-property">contact</span><span class="tsd-signature-symbol">?:</span> <a href="ActionContact.html" class="tsd-signature-type tsd-kind-interface">ActionContact</a></div>
|
|
43
|
+
<div class="tsd-comment tsd-typography"><p>Organisation contact points, when available.</p>
|
|
44
|
+
</div><aside class="tsd-sources">
|
|
45
|
+
<ul>
|
|
46
|
+
<li>Defined in src/public/typings/action.ts:131</li></ul></aside></section>
|
|
47
|
+
<section class="tsd-panel tsd-member">
|
|
48
|
+
<h3 class="tsd-anchor-link" id="emailtemplate"><code class="tsd-tag">Optional</code><span>email<wbr/>Template</span><a href="#emailtemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
49
|
+
<div class="tsd-signature"><span class="tsd-kind-property">emailTemplate</span><span class="tsd-signature-symbol">?:</span> <a href="AssistedEmailTemplate.html" class="tsd-signature-type tsd-kind-interface">AssistedEmailTemplate</a></div>
|
|
50
|
+
<div class="tsd-comment tsd-typography"><p>An email template for the action,
|
|
51
|
+
resolved from a deployment-time template store.</p>
|
|
52
|
+
</div><aside class="tsd-sources">
|
|
53
|
+
<ul>
|
|
54
|
+
<li>Defined in src/public/typings/action.ts:134</li></ul></aside></section>
|
|
55
|
+
<section class="tsd-panel tsd-member">
|
|
56
|
+
<h3 class="tsd-anchor-link" id="instructions"><code class="tsd-tag">Optional</code><span>instructions</span><a href="#instructions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
57
|
+
<div class="tsd-signature"><span class="tsd-kind-property">instructions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
58
|
+
<div class="tsd-comment tsd-typography"><p>Free-text instructions, potentially provided
|
|
59
|
+
verbatim by an analysis source.</p>
|
|
60
|
+
</div><aside class="tsd-sources">
|
|
61
|
+
<ul>
|
|
62
|
+
<li>Defined in src/public/typings/action.ts:133</li></ul></aside></section>
|
|
63
|
+
<section class="tsd-panel tsd-member">
|
|
64
|
+
<h3 class="tsd-anchor-link" id="jurisdiction"><code class="tsd-tag">Optional</code><span>jurisdiction</span><a href="#jurisdiction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
65
|
+
<div class="tsd-signature"><span class="tsd-kind-property">jurisdiction</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
66
|
+
<div class="tsd-comment tsd-typography"><p>Jurisdiction relevant to the action, when available.</p>
|
|
67
|
+
</div><aside class="tsd-sources">
|
|
68
|
+
<ul>
|
|
69
|
+
<li>Defined in src/public/typings/action.ts:132</li></ul></aside></section>
|
|
70
|
+
<section class="tsd-panel tsd-member">
|
|
71
|
+
<h3 class="tsd-anchor-link" id="toaddress"><code class="tsd-tag">Optional</code><span>to<wbr/>Address</span><a href="#toaddress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
72
|
+
<div class="tsd-signature"><span class="tsd-kind-property">toAddress</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
73
|
+
<div class="tsd-comment tsd-typography"><p>Recipient address for an assisted email action.</p>
|
|
74
|
+
</div><aside class="tsd-sources">
|
|
75
|
+
<ul>
|
|
76
|
+
<li>Defined in src/public/typings/action.ts:128</li></ul></aside></section>
|
|
77
|
+
<section class="tsd-panel tsd-member">
|
|
78
|
+
<h3 class="tsd-anchor-link" id="unsubscribemailto"><code class="tsd-tag">Optional</code><span>unsubscribe<wbr/>Mailto</span><a href="#unsubscribemailto" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
79
|
+
<div class="tsd-signature"><span class="tsd-kind-property">unsubscribeMailto</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
80
|
+
<div class="tsd-comment tsd-typography"><p>Unsubscribe mailto link, when available.</p>
|
|
81
|
+
</div><aside class="tsd-sources">
|
|
82
|
+
<ul>
|
|
83
|
+
<li>Defined in src/public/typings/action.ts:130</li></ul></aside></section>
|
|
84
|
+
<section class="tsd-panel tsd-member">
|
|
85
|
+
<h3 class="tsd-anchor-link" id="unsubscribeurl"><code class="tsd-tag">Optional</code><span>unsubscribe<wbr/>Url</span><a href="#unsubscribeurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
86
|
+
<div class="tsd-signature"><span class="tsd-kind-property">unsubscribeUrl</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
87
|
+
<div class="tsd-comment tsd-typography"><p>Unsubscribe URL, when available.</p>
|
|
88
|
+
</div><aside class="tsd-sources">
|
|
89
|
+
<ul>
|
|
90
|
+
<li>Defined in src/public/typings/action.ts:129</li></ul></aside></section></section></details></div>
|
|
91
|
+
<div class="col-sidebar">
|
|
92
|
+
<div class="page-menu">
|
|
93
|
+
<div class="tsd-navigation settings">
|
|
94
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
95
|
+
<h3>Settings</h3></summary>
|
|
96
|
+
<div class="tsd-accordion-details">
|
|
97
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
98
|
+
<ul id="tsd-filter-options">
|
|
99
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
100
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
101
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
102
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
103
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
104
|
+
<h3>On This Page</h3></summary>
|
|
105
|
+
<div class="tsd-accordion-details">
|
|
106
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
107
|
+
<div><a href="#contact"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>contact</span></a><a href="#emailtemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>email<wbr/>Template</span></a><a href="#instructions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>instructions</span></a><a href="#jurisdiction"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jurisdiction</span></a><a href="#toaddress"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to<wbr/>Address</span></a><a href="#unsubscribemailto"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>Mailto</span></a><a href="#unsubscribeurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>unsubscribe<wbr/>Url</span></a></div></details></div></details></div>
|
|
108
|
+
<div class="site-menu">
|
|
109
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
110
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
111
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
112
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
113
|
+
<div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AvailableAction | @sudoplatform/sudo-privacy-interaction</title><meta name="description" content="Documentation for @sudoplatform/sudo-privacy-interaction"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-privacy-interaction</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">AvailableAction</a></li></ul>
|
|
12
|
+
<h1>Interface AvailableAction</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>The Sudo Platform SDK representation of a derived, non-persisted action the
|
|
15
|
+
user could take against a data holder.</p>
|
|
16
|
+
<p>AvailableAction</p>
|
|
17
|
+
</div></section>
|
|
18
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AvailableAction</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#additionalinfo">additionalInfo</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#fulfilmentmethod">fulfilmentMethod</a><span class="tsd-signature-symbol">:</span> <a href="../enums/ActionFulfilmentMethod.html" class="tsd-signature-type tsd-kind-enum">ActionFulfilmentMethod</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#intent">intent</a><span class="tsd-signature-symbol">:</span> <a href="../enums/ActionIntent.html" class="tsd-signature-type tsd-kind-enum">ActionIntent</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#origin">origin</a><span class="tsd-signature-symbol">:</span> <a href="../enums/ActionOrigin.html" class="tsd-signature-type tsd-kind-enum">ActionOrigin</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
19
|
+
<ul>
|
|
20
|
+
<li>Defined in src/public/typings/action.ts:187</li></ul></aside>
|
|
21
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
22
|
+
<section class="tsd-panel tsd-index-panel">
|
|
23
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
24
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
25
|
+
<div class="tsd-accordion-details">
|
|
26
|
+
<section class="tsd-index-section">
|
|
27
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
28
|
+
<div class="tsd-index-list"><a href="#additionalinfo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>additional<wbr/>Info?</span></a>
|
|
29
|
+
<a href="#description" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description?</span></a>
|
|
30
|
+
<a href="#fulfilmentmethod" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fulfilment<wbr/>Method</span></a>
|
|
31
|
+
<a href="#intent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>intent</span></a>
|
|
32
|
+
<a href="#origin" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>origin</span></a>
|
|
33
|
+
<a href="#title" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title?</span></a>
|
|
34
|
+
</div></section></div></details></section></section>
|
|
35
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
36
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
37
|
+
<section>
|
|
38
|
+
<section class="tsd-panel tsd-member">
|
|
39
|
+
<h3 class="tsd-anchor-link" id="additionalinfo"><code class="tsd-tag">Optional</code><span>additional<wbr/>Info</span><a href="#additionalinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
40
|
+
<div class="tsd-signature"><span class="tsd-kind-property">additionalInfo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
41
|
+
<div class="tsd-comment tsd-typography"><p>Additional info, populated when intent is <code>Other</code>.</p>
|
|
42
|
+
</div><aside class="tsd-sources">
|
|
43
|
+
<ul>
|
|
44
|
+
<li>Defined in src/public/typings/action.ts:189</li></ul></aside></section>
|
|
45
|
+
<section class="tsd-panel tsd-member">
|
|
46
|
+
<h3 class="tsd-anchor-link" id="description"><code class="tsd-tag">Optional</code><span>description</span><a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
47
|
+
<div class="tsd-signature"><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
48
|
+
<div class="tsd-comment tsd-typography"><p>Short presentation hint describing the action.</p>
|
|
49
|
+
</div><aside class="tsd-sources">
|
|
50
|
+
<ul>
|
|
51
|
+
<li>Defined in src/public/typings/action.ts:193</li></ul></aside></section>
|
|
52
|
+
<section class="tsd-panel tsd-member">
|
|
53
|
+
<h3 class="tsd-anchor-link" id="fulfilmentmethod"><span>fulfilment<wbr/>Method</span><a href="#fulfilmentmethod" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
54
|
+
<div class="tsd-signature"><span class="tsd-kind-property">fulfilmentMethod</span><span class="tsd-signature-symbol">:</span> <a href="../enums/ActionFulfilmentMethod.html" class="tsd-signature-type tsd-kind-enum">ActionFulfilmentMethod</a></div>
|
|
55
|
+
<div class="tsd-comment tsd-typography"><p>How the action is fulfilled.</p>
|
|
56
|
+
</div><aside class="tsd-sources">
|
|
57
|
+
<ul>
|
|
58
|
+
<li>Defined in src/public/typings/action.ts:190</li></ul></aside></section>
|
|
59
|
+
<section class="tsd-panel tsd-member">
|
|
60
|
+
<h3 class="tsd-anchor-link" id="intent"><span>intent</span><a href="#intent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
61
|
+
<div class="tsd-signature"><span class="tsd-kind-property">intent</span><span class="tsd-signature-symbol">:</span> <a href="../enums/ActionIntent.html" class="tsd-signature-type tsd-kind-enum">ActionIntent</a></div>
|
|
62
|
+
<div class="tsd-comment tsd-typography"><p>The user-facing intent of the action.</p>
|
|
63
|
+
</div><aside class="tsd-sources">
|
|
64
|
+
<ul>
|
|
65
|
+
<li>Defined in src/public/typings/action.ts:188</li></ul></aside></section>
|
|
66
|
+
<section class="tsd-panel tsd-member">
|
|
67
|
+
<h3 class="tsd-anchor-link" id="origin"><span>origin</span><a href="#origin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
68
|
+
<div class="tsd-signature"><span class="tsd-kind-property">origin</span><span class="tsd-signature-symbol">:</span> <a href="../enums/ActionOrigin.html" class="tsd-signature-type tsd-kind-enum">ActionOrigin</a></div>
|
|
69
|
+
<div class="tsd-comment tsd-typography"><p>Which source contributed this action.</p>
|
|
70
|
+
</div><aside class="tsd-sources">
|
|
71
|
+
<ul>
|
|
72
|
+
<li>Defined in src/public/typings/action.ts:191</li></ul></aside></section>
|
|
73
|
+
<section class="tsd-panel tsd-member">
|
|
74
|
+
<h3 class="tsd-anchor-link" id="title"><code class="tsd-tag">Optional</code><span>title</span><a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
75
|
+
<div class="tsd-signature"><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
76
|
+
<div class="tsd-comment tsd-typography"><p>Short presentation hint for the action's title.</p>
|
|
77
|
+
</div><aside class="tsd-sources">
|
|
78
|
+
<ul>
|
|
79
|
+
<li>Defined in src/public/typings/action.ts:192</li></ul></aside></section></section></details></div>
|
|
80
|
+
<div class="col-sidebar">
|
|
81
|
+
<div class="page-menu">
|
|
82
|
+
<div class="tsd-navigation settings">
|
|
83
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
84
|
+
<h3>Settings</h3></summary>
|
|
85
|
+
<div class="tsd-accordion-details">
|
|
86
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
87
|
+
<ul id="tsd-filter-options">
|
|
88
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
89
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
90
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
91
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
92
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
93
|
+
<h3>On This Page</h3></summary>
|
|
94
|
+
<div class="tsd-accordion-details">
|
|
95
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
96
|
+
<div><a href="#additionalinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>additional<wbr/>Info</span></a><a href="#description"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#fulfilmentmethod"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fulfilment<wbr/>Method</span></a><a href="#intent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>intent</span></a><a href="#origin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>origin</span></a><a href="#title"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title</span></a></div></details></div></details></div>
|
|
97
|
+
<div class="site-menu">
|
|
98
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
99
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
100
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
101
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
102
|
+
<div class="overlay"></div></body></html>
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CapabilitySignals</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#sellspersonalinformation">sellsPersonalInformation</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#supportsaccountcreation">supportsAccountCreation</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#supportsaccountdeletion">supportsAccountDeletion</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#supportsdatadeletionrequests">supportsDataDeletionRequests</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#supportsdataexport">supportsDataExport</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#supportssubscriptions">supportsSubscriptions</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#supportstwofactorauth">supportsTwoFactorAuth</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#usescookiesortracking">usesCookiesOrTracking</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
19
|
+
<li>Defined in src/public/typings/analysisResult.ts:282</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -42,56 +42,56 @@
|
|
|
42
42
|
<div class="tsd-comment tsd-typography"><p>Whether the organization sells personal information.</p>
|
|
43
43
|
</div><aside class="tsd-sources">
|
|
44
44
|
<ul>
|
|
45
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
45
|
+
<li>Defined in src/public/typings/analysisResult.ts:288</li></ul></aside></section>
|
|
46
46
|
<section class="tsd-panel tsd-member">
|
|
47
47
|
<h3 class="tsd-anchor-link" id="supportsaccountcreation"><span>supports<wbr/>Account<wbr/>Creation</span><a href="#supportsaccountcreation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
48
48
|
<div class="tsd-signature"><span class="tsd-kind-property">supportsAccountCreation</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
49
49
|
<div class="tsd-comment tsd-typography"><p>Whether the organization supports creating an account.</p>
|
|
50
50
|
</div><aside class="tsd-sources">
|
|
51
51
|
<ul>
|
|
52
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
52
|
+
<li>Defined in src/public/typings/analysisResult.ts:283</li></ul></aside></section>
|
|
53
53
|
<section class="tsd-panel tsd-member">
|
|
54
54
|
<h3 class="tsd-anchor-link" id="supportsaccountdeletion"><span>supports<wbr/>Account<wbr/>Deletion</span><a href="#supportsaccountdeletion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
55
55
|
<div class="tsd-signature"><span class="tsd-kind-property">supportsAccountDeletion</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
56
56
|
<div class="tsd-comment tsd-typography"><p>Whether the organization supports account deletion.</p>
|
|
57
57
|
</div><aside class="tsd-sources">
|
|
58
58
|
<ul>
|
|
59
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
59
|
+
<li>Defined in src/public/typings/analysisResult.ts:284</li></ul></aside></section>
|
|
60
60
|
<section class="tsd-panel tsd-member">
|
|
61
61
|
<h3 class="tsd-anchor-link" id="supportsdatadeletionrequests"><span>supports<wbr/>Data<wbr/>Deletion<wbr/>Requests</span><a href="#supportsdatadeletionrequests" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
62
62
|
<div class="tsd-signature"><span class="tsd-kind-property">supportsDataDeletionRequests</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
63
63
|
<div class="tsd-comment tsd-typography"><p>Whether the organization supports data deletion requests.</p>
|
|
64
64
|
</div><aside class="tsd-sources">
|
|
65
65
|
<ul>
|
|
66
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
66
|
+
<li>Defined in src/public/typings/analysisResult.ts:285</li></ul></aside></section>
|
|
67
67
|
<section class="tsd-panel tsd-member">
|
|
68
68
|
<h3 class="tsd-anchor-link" id="supportsdataexport"><span>supports<wbr/>Data<wbr/>Export</span><a href="#supportsdataexport" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
69
69
|
<div class="tsd-signature"><span class="tsd-kind-property">supportsDataExport</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
70
70
|
<div class="tsd-comment tsd-typography"><p>Whether the organization supports data export.</p>
|
|
71
71
|
</div><aside class="tsd-sources">
|
|
72
72
|
<ul>
|
|
73
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
73
|
+
<li>Defined in src/public/typings/analysisResult.ts:286</li></ul></aside></section>
|
|
74
74
|
<section class="tsd-panel tsd-member">
|
|
75
75
|
<h3 class="tsd-anchor-link" id="supportssubscriptions"><span>supports<wbr/>Subscriptions</span><a href="#supportssubscriptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
76
76
|
<div class="tsd-signature"><span class="tsd-kind-property">supportsSubscriptions</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
77
77
|
<div class="tsd-comment tsd-typography"><p>Whether the organization supports subscription management.</p>
|
|
78
78
|
</div><aside class="tsd-sources">
|
|
79
79
|
<ul>
|
|
80
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
80
|
+
<li>Defined in src/public/typings/analysisResult.ts:287</li></ul></aside></section>
|
|
81
81
|
<section class="tsd-panel tsd-member">
|
|
82
82
|
<h3 class="tsd-anchor-link" id="supportstwofactorauth"><span>supports<wbr/>Two<wbr/>Factor<wbr/>Auth</span><a href="#supportstwofactorauth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
83
|
<div class="tsd-signature"><span class="tsd-kind-property">supportsTwoFactorAuth</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
84
84
|
<div class="tsd-comment tsd-typography"><p>Whether the organization supports two-factor auth for logins.</p>
|
|
85
85
|
</div><aside class="tsd-sources">
|
|
86
86
|
<ul>
|
|
87
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
87
|
+
<li>Defined in src/public/typings/analysisResult.ts:290</li></ul></aside></section>
|
|
88
88
|
<section class="tsd-panel tsd-member">
|
|
89
89
|
<h3 class="tsd-anchor-link" id="usescookiesortracking"><span>uses<wbr/>Cookies<wbr/>Or<wbr/>Tracking</span><a href="#usescookiesortracking" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
90
90
|
<div class="tsd-signature"><span class="tsd-kind-property">usesCookiesOrTracking</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
91
91
|
<div class="tsd-comment tsd-typography"><p>Whether the organization uses cookies or tracking.</p>
|
|
92
92
|
</div><aside class="tsd-sources">
|
|
93
93
|
<ul>
|
|
94
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
94
|
+
<li>Defined in src/public/typings/analysisResult.ts:289</li></ul></aside></section></section></details></div>
|
|
95
95
|
<div class="col-sidebar">
|
|
96
96
|
<div class="page-menu">
|
|
97
97
|
<div class="tsd-navigation settings">
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CategorySignals</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#category">category</a><span class="tsd-signature-symbol">:</span> <a href="../enums/DataCategory.html" class="tsd-signature-type tsd-kind-enum">DataCategory</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#collected">collected</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#datalabels">dataLabels</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#monetized">monetized</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#requiredforlaw">requiredForLaw</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#requiredforservice">requiredForService</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#retained">retained</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#retention">retention</a><span class="tsd-signature-symbol">?:</span> <a href="RetentionInfo.html" class="tsd-signature-type tsd-kind-interface">RetentionInfo</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#sharedwiththirdparties">sharedWithThirdParties</a><span class="tsd-signature-symbol">:</span> <a href="../enums/ShareStyle.html" class="tsd-signature-type tsd-kind-enum">ShareStyle</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#usercanoptout">userCanOptOut</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
19
|
+
<li>Defined in src/public/typings/analysisResult.ts:256</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -44,70 +44,70 @@
|
|
|
44
44
|
<div class="tsd-comment tsd-typography"><p>The data category these signals apply to.</p>
|
|
45
45
|
</div><aside class="tsd-sources">
|
|
46
46
|
<ul>
|
|
47
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
47
|
+
<li>Defined in src/public/typings/analysisResult.ts:257</li></ul></aside></section>
|
|
48
48
|
<section class="tsd-panel tsd-member">
|
|
49
49
|
<h3 class="tsd-anchor-link" id="collected"><span>collected</span><a href="#collected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
50
50
|
<div class="tsd-signature"><span class="tsd-kind-property">collected</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
51
51
|
<div class="tsd-comment tsd-typography"><p>Whether this category of data is collected.</p>
|
|
52
52
|
</div><aside class="tsd-sources">
|
|
53
53
|
<ul>
|
|
54
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
54
|
+
<li>Defined in src/public/typings/analysisResult.ts:258</li></ul></aside></section>
|
|
55
55
|
<section class="tsd-panel tsd-member">
|
|
56
56
|
<h3 class="tsd-anchor-link" id="datalabels"><span>data<wbr/>Labels</span><a href="#datalabels" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
57
57
|
<div class="tsd-signature"><span class="tsd-kind-property">dataLabels</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
58
58
|
<div class="tsd-comment tsd-typography"><p>Descriptive labels for the collected data within this category.</p>
|
|
59
59
|
</div><aside class="tsd-sources">
|
|
60
60
|
<ul>
|
|
61
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
61
|
+
<li>Defined in src/public/typings/analysisResult.ts:259</li></ul></aside></section>
|
|
62
62
|
<section class="tsd-panel tsd-member">
|
|
63
63
|
<h3 class="tsd-anchor-link" id="monetized"><span>monetized</span><a href="#monetized" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
64
64
|
<div class="tsd-signature"><span class="tsd-kind-property">monetized</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
65
65
|
<div class="tsd-comment tsd-typography"><p>Whether this category is used for monetization.</p>
|
|
66
66
|
</div><aside class="tsd-sources">
|
|
67
67
|
<ul>
|
|
68
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
68
|
+
<li>Defined in src/public/typings/analysisResult.ts:261</li></ul></aside></section>
|
|
69
69
|
<section class="tsd-panel tsd-member">
|
|
70
70
|
<h3 class="tsd-anchor-link" id="requiredforlaw"><span>required<wbr/>For<wbr/>Law</span><a href="#requiredforlaw" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
71
71
|
<div class="tsd-signature"><span class="tsd-kind-property">requiredForLaw</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
72
72
|
<div class="tsd-comment tsd-typography"><p>Whether this data is collected to comply with legal requirements.</p>
|
|
73
73
|
</div><aside class="tsd-sources">
|
|
74
74
|
<ul>
|
|
75
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
75
|
+
<li>Defined in src/public/typings/analysisResult.ts:266</li></ul></aside></section>
|
|
76
76
|
<section class="tsd-panel tsd-member">
|
|
77
77
|
<h3 class="tsd-anchor-link" id="requiredforservice"><span>required<wbr/>For<wbr/>Service</span><a href="#requiredforservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
78
78
|
<div class="tsd-signature"><span class="tsd-kind-property">requiredForService</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
79
79
|
<div class="tsd-comment tsd-typography"><p>Whether this data is required for the core service to function.</p>
|
|
80
80
|
</div><aside class="tsd-sources">
|
|
81
81
|
<ul>
|
|
82
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
82
|
+
<li>Defined in src/public/typings/analysisResult.ts:265</li></ul></aside></section>
|
|
83
83
|
<section class="tsd-panel tsd-member">
|
|
84
84
|
<h3 class="tsd-anchor-link" id="retained"><span>retained</span><a href="#retained" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
85
85
|
<div class="tsd-signature"><span class="tsd-kind-property">retained</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
86
86
|
<div class="tsd-comment tsd-typography"><p>Whether this category is retained.</p>
|
|
87
87
|
</div><aside class="tsd-sources">
|
|
88
88
|
<ul>
|
|
89
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
89
|
+
<li>Defined in src/public/typings/analysisResult.ts:262</li></ul></aside></section>
|
|
90
90
|
<section class="tsd-panel tsd-member">
|
|
91
91
|
<h3 class="tsd-anchor-link" id="retention"><code class="tsd-tag">Optional</code><span>retention</span><a href="#retention" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
92
92
|
<div class="tsd-signature"><span class="tsd-kind-property">retention</span><span class="tsd-signature-symbol">?:</span> <a href="RetentionInfo.html" class="tsd-signature-type tsd-kind-interface">RetentionInfo</a></div>
|
|
93
93
|
<div class="tsd-comment tsd-typography"><p>Retention details when data is retained.</p>
|
|
94
94
|
</div><aside class="tsd-sources">
|
|
95
95
|
<ul>
|
|
96
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
96
|
+
<li>Defined in src/public/typings/analysisResult.ts:263</li></ul></aside></section>
|
|
97
97
|
<section class="tsd-panel tsd-member">
|
|
98
98
|
<h3 class="tsd-anchor-link" id="sharedwiththirdparties"><span>shared<wbr/>With<wbr/>Third<wbr/>Parties</span><a href="#sharedwiththirdparties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
99
99
|
<div class="tsd-signature"><span class="tsd-kind-property">sharedWithThirdParties</span><span class="tsd-signature-symbol">:</span> <a href="../enums/ShareStyle.html" class="tsd-signature-type tsd-kind-enum">ShareStyle</a></div>
|
|
100
100
|
<div class="tsd-comment tsd-typography"><p>How this category is shared with third parties.</p>
|
|
101
101
|
</div><aside class="tsd-sources">
|
|
102
102
|
<ul>
|
|
103
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
103
|
+
<li>Defined in src/public/typings/analysisResult.ts:260</li></ul></aside></section>
|
|
104
104
|
<section class="tsd-panel tsd-member">
|
|
105
105
|
<h3 class="tsd-anchor-link" id="usercanoptout"><span>user<wbr/>Can<wbr/>Opt<wbr/>Out</span><a href="#usercanoptout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
106
106
|
<div class="tsd-signature"><span class="tsd-kind-property">userCanOptOut</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
107
107
|
<div class="tsd-comment tsd-typography"><p>Whether the user can opt out of this category's collection.</p>
|
|
108
108
|
</div><aside class="tsd-sources">
|
|
109
109
|
<ul>
|
|
110
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
110
|
+
<li>Defined in src/public/typings/analysisResult.ts:264</li></ul></aside></section></section></details></div>
|
|
111
111
|
<div class="col-sidebar">
|
|
112
112
|
<div class="page-menu">
|
|
113
113
|
<div class="tsd-navigation settings">
|