@sudoplatform/sudo-privacy-interaction 1.0.0 → 2.0.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 +44 -4
- package/cjs/private/data/analysis-result/transformer/analysisResultDataTransformer.js +2 -0
- package/cjs/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +2 -0
- package/cjs/private/data/analysis-result/transformer/categorySignalsTransformer.js +2 -2
- package/cjs/private/data/common/apiClient.js +8 -0
- package/cjs/private/data/provider-configuration/defaultProviderConfigurationService.js +23 -0
- package/cjs/private/data/provider-configuration/transformer/providerConfigurationTransformer.js +52 -0
- package/cjs/private/data/virtual-presence/defaultVirtualPresenceService.js +11 -1
- package/cjs/private/data/virtual-presence/transformer/relationshipProviderTransformer.js +29 -0
- package/cjs/private/domain/entities/configuration/providerConfigurationEntity.js +7 -0
- package/cjs/private/domain/entities/configuration/providerConfigurationService.js +7 -0
- package/cjs/private/domain/entities/inputs/relationshipProviderEntity.js +21 -0
- package/cjs/private/domain/use-cases/configuration/getProviderConfigurationUseCase.js +25 -0
- package/cjs/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.js +6 -2
- package/cjs/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +7 -1
- package/cjs/public/defaultSudoPrivacyInteractionClient.js +34 -3
- package/cjs/public/inputs/virtualPresence.js +14 -0
- package/cjs/public/typings/index.js +1 -0
- package/cjs/public/typings/providerConfiguration.js +7 -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 +36 -21
- package/docs/enums/DataCategory.html +18 -18
- package/docs/enums/OrganizationCategory.html +30 -30
- package/docs/enums/RelationshipProvider.html +63 -0
- package/docs/enums/RetentionStyle.html +5 -5
- package/docs/enums/ShareStyle.html +6 -6
- package/docs/enums/SignalValue.html +4 -4
- package/docs/hierarchy.html +5 -5
- package/docs/interfaces/AnalysisResultData.html +18 -10
- package/docs/interfaces/CapabilitySignals.html +18 -10
- package/docs/interfaces/CategorySignals.html +20 -20
- package/docs/interfaces/ConnectVirtualPresenceWithAuthCodeInput.html +79 -0
- package/docs/interfaces/ConnectVirtualPresenceWithRefreshTokenInput.html +16 -7
- package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
- package/docs/interfaces/ListDataHoldersInput.html +1 -1
- package/docs/interfaces/ListVirtualPresencesInput.html +2 -2
- package/docs/interfaces/OrganizationIdentity.html +5 -5
- package/docs/interfaces/Pagination.html +1 -1
- package/docs/interfaces/PrivacyScore.html +3 -3
- package/docs/interfaces/PrivacySummary.html +4 -4
- package/docs/interfaces/ProviderConfiguration.html +80 -0
- package/docs/interfaces/RescanVirtualPresenceInput.html +3 -3
- package/docs/interfaces/RetentionInfo.html +4 -4
- package/docs/interfaces/RiskIndicators.html +8 -8
- package/docs/interfaces/ScanOptions.html +6 -6
- package/docs/interfaces/ScoreContribution.html +3 -3
- package/docs/interfaces/SudoPrivacyInteractionClient.html +35 -21
- package/docs/modules.html +4 -4
- package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
- package/lib/gen/graphqlTypes.js +43 -3
- package/lib/private/data/analysis-result/transformer/analysisResultDataTransformer.js +2 -0
- package/lib/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +2 -0
- package/lib/private/data/analysis-result/transformer/categorySignalsTransformer.js +2 -2
- package/lib/private/data/common/apiClient.js +9 -1
- package/lib/private/data/provider-configuration/defaultProviderConfigurationService.js +19 -0
- package/lib/private/data/provider-configuration/transformer/providerConfigurationTransformer.js +48 -0
- package/lib/private/data/virtual-presence/defaultVirtualPresenceService.js +11 -1
- package/lib/private/data/virtual-presence/transformer/relationshipProviderTransformer.js +25 -0
- package/lib/private/domain/entities/configuration/providerConfigurationEntity.js +6 -0
- package/lib/private/domain/entities/configuration/providerConfigurationService.js +6 -0
- package/lib/private/domain/entities/inputs/relationshipProviderEntity.js +18 -0
- package/lib/private/domain/use-cases/configuration/getProviderConfigurationUseCase.js +21 -0
- package/lib/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.js +6 -2
- package/lib/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +7 -1
- package/lib/public/defaultSudoPrivacyInteractionClient.js +34 -3
- package/lib/public/inputs/virtualPresence.js +13 -1
- package/lib/public/typings/index.js +1 -0
- package/lib/public/typings/providerConfiguration.js +6 -0
- package/package.json +6 -4
- package/types/gen/graphqlTypes.d.ts +37 -5
- package/types/private/data/common/apiClient.d.ts +2 -1
- package/types/private/data/provider-configuration/defaultProviderConfigurationService.d.ts +14 -0
- package/types/private/data/provider-configuration/transformer/providerConfigurationTransformer.d.ts +19 -0
- package/types/private/data/virtual-presence/defaultVirtualPresenceService.d.ts +1 -0
- package/types/private/data/virtual-presence/transformer/relationshipProviderTransformer.d.ts +12 -0
- package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +6 -2
- package/types/private/domain/entities/configuration/providerConfigurationEntity.d.ts +23 -0
- package/types/private/domain/entities/configuration/providerConfigurationService.d.ts +21 -0
- package/types/private/domain/entities/inputs/relationshipProviderEntity.d.ts +17 -0
- package/types/private/domain/entities/virtual-presence/virtualPresenceService.d.ts +17 -2
- package/types/private/domain/use-cases/configuration/getProviderConfigurationUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.d.ts +13 -1
- package/types/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.d.ts +2 -0
- package/types/public/defaultSudoPrivacyInteractionClient.d.ts +7 -3
- package/types/public/inputs/virtualPresence.d.ts +30 -0
- package/types/public/sudoPrivacyInteractionClient.d.ts +11 -4
- package/types/public/typings/analysisResult.d.ts +6 -2
- package/types/public/typings/index.d.ts +1 -0
- package/types/public/typings/providerConfiguration.d.ts +23 -0
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>The structured data payload for an analysis result.</p>
|
|
15
15
|
<p>AnalysisResultData</p>
|
|
16
16
|
</div></section>
|
|
17
|
-
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AnalysisResultData</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#capabilities">capabilities</a><span class="tsd-signature-symbol">:</span> <a href="CapabilitySignals.html" class="tsd-signature-type tsd-kind-interface">CapabilitySignals</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#categories">categories</a><span class="tsd-signature-symbol">:</span> <a href="CategorySignals.html" class="tsd-signature-type tsd-kind-interface">CategorySignals</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#organizationidentity">organizationIdentity</a><span class="tsd-signature-symbol">?:</span> <a href="OrganizationIdentity.html" class="tsd-signature-type tsd-kind-interface">OrganizationIdentity</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#privacyscore">privacyScore</a><span class="tsd-signature-symbol">?:</span> <a href="PrivacyScore.html" class="tsd-signature-type tsd-kind-interface">PrivacyScore</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#privacysummary">privacySummary</a><span class="tsd-signature-symbol">:</span> <a href="PrivacySummary.html" class="tsd-signature-type tsd-kind-interface">PrivacySummary</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#riskindicators">riskIndicators</a><span class="tsd-signature-symbol">:</span> <a href="RiskIndicators.html" class="tsd-signature-type tsd-kind-interface">RiskIndicators</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AnalysisResultData</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#attribution">attribution</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="#capabilities">capabilities</a><span class="tsd-signature-symbol">:</span> <a href="CapabilitySignals.html" class="tsd-signature-type tsd-kind-interface">CapabilitySignals</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#categories">categories</a><span class="tsd-signature-symbol">:</span> <a href="CategorySignals.html" class="tsd-signature-type tsd-kind-interface">CategorySignals</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#organizationidentity">organizationIdentity</a><span class="tsd-signature-symbol">?:</span> <a href="OrganizationIdentity.html" class="tsd-signature-type tsd-kind-interface">OrganizationIdentity</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#privacyscore">privacyScore</a><span class="tsd-signature-symbol">?:</span> <a href="PrivacyScore.html" class="tsd-signature-type tsd-kind-interface">PrivacyScore</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#privacysummary">privacySummary</a><span class="tsd-signature-symbol">:</span> <a href="PrivacySummary.html" class="tsd-signature-type tsd-kind-interface">PrivacySummary</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#riskindicators">riskIndicators</a><span class="tsd-signature-symbol">:</span> <a href="RiskIndicators.html" class="tsd-signature-type tsd-kind-interface">RiskIndicators</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:93</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>
|
|
@@ -24,7 +24,8 @@
|
|
|
24
24
|
<div class="tsd-accordion-details">
|
|
25
25
|
<section class="tsd-index-section">
|
|
26
26
|
<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>
|
|
27
|
-
<div class="tsd-index-list"><a href="#
|
|
27
|
+
<div class="tsd-index-list"><a href="#attribution" 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>attribution</span></a>
|
|
28
|
+
<a href="#capabilities" 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>capabilities</span></a>
|
|
28
29
|
<a href="#categories" 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>categories</span></a>
|
|
29
30
|
<a href="#organizationidentity" 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>organization<wbr/>Identity?</span></a>
|
|
30
31
|
<a href="#privacyscore" 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>privacy<wbr/>Score?</span></a>
|
|
@@ -35,26 +36,33 @@
|
|
|
35
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>
|
|
36
37
|
<section>
|
|
37
38
|
<section class="tsd-panel tsd-member">
|
|
39
|
+
<h3 class="tsd-anchor-link" id="attribution"><span>attribution</span><a href="#attribution" 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">attribution</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
41
|
+
<div class="tsd-comment tsd-typography"><p>Information describing where the analysis result is derived from.</p>
|
|
42
|
+
</div><aside class="tsd-sources">
|
|
43
|
+
<ul>
|
|
44
|
+
<li>Defined in src/public/typings/analysisResult.ts:100</li></ul></aside></section>
|
|
45
|
+
<section class="tsd-panel tsd-member">
|
|
38
46
|
<h3 class="tsd-anchor-link" id="capabilities"><span>capabilities</span><a href="#capabilities" 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>
|
|
39
47
|
<div class="tsd-signature"><span class="tsd-kind-property">capabilities</span><span class="tsd-signature-symbol">:</span> <a href="CapabilitySignals.html" class="tsd-signature-type tsd-kind-interface">CapabilitySignals</a></div>
|
|
40
48
|
<div class="tsd-comment tsd-typography"><p>Action-derived capability signals.</p>
|
|
41
49
|
</div><aside class="tsd-sources">
|
|
42
50
|
<ul>
|
|
43
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
51
|
+
<li>Defined in src/public/typings/analysisResult.ts:97</li></ul></aside></section>
|
|
44
52
|
<section class="tsd-panel tsd-member">
|
|
45
53
|
<h3 class="tsd-anchor-link" id="categories"><span>categories</span><a href="#categories" 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>
|
|
46
54
|
<div class="tsd-signature"><span class="tsd-kind-property">categories</span><span class="tsd-signature-symbol">:</span> <a href="CategorySignals.html" class="tsd-signature-type tsd-kind-interface">CategorySignals</a><span class="tsd-signature-symbol">[]</span></div>
|
|
47
55
|
<div class="tsd-comment tsd-typography"><p>Per-category signal breakdown.</p>
|
|
48
56
|
</div><aside class="tsd-sources">
|
|
49
57
|
<ul>
|
|
50
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
58
|
+
<li>Defined in src/public/typings/analysisResult.ts:96</li></ul></aside></section>
|
|
51
59
|
<section class="tsd-panel tsd-member">
|
|
52
60
|
<h3 class="tsd-anchor-link" id="organizationidentity"><code class="tsd-tag">Optional</code><span>organization<wbr/>Identity</span><a href="#organizationidentity" 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>
|
|
53
61
|
<div class="tsd-signature"><span class="tsd-kind-property">organizationIdentity</span><span class="tsd-signature-symbol">?:</span> <a href="OrganizationIdentity.html" class="tsd-signature-type tsd-kind-interface">OrganizationIdentity</a></div>
|
|
54
62
|
<div class="tsd-comment tsd-typography"><p>Organization identity (brand, company, business categories).</p>
|
|
55
63
|
</div><aside class="tsd-sources">
|
|
56
64
|
<ul>
|
|
57
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
65
|
+
<li>Defined in src/public/typings/analysisResult.ts:99</li></ul></aside></section>
|
|
58
66
|
<section class="tsd-panel tsd-member">
|
|
59
67
|
<h3 class="tsd-anchor-link" id="privacyscore"><code class="tsd-tag">Optional</code><span>privacy<wbr/>Score</span><a href="#privacyscore" 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>
|
|
60
68
|
<div class="tsd-signature"><span class="tsd-kind-property">privacyScore</span><span class="tsd-signature-symbol">?:</span> <a href="PrivacyScore.html" class="tsd-signature-type tsd-kind-interface">PrivacyScore</a></div>
|
|
@@ -62,21 +70,21 @@
|
|
|
62
70
|
Undefined when scoring is disabled.</p>
|
|
63
71
|
</div><aside class="tsd-sources">
|
|
64
72
|
<ul>
|
|
65
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
73
|
+
<li>Defined in src/public/typings/analysisResult.ts:94</li></ul></aside></section>
|
|
66
74
|
<section class="tsd-panel tsd-member">
|
|
67
75
|
<h3 class="tsd-anchor-link" id="privacysummary"><span>privacy<wbr/>Summary</span><a href="#privacysummary" 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
76
|
<div class="tsd-signature"><span class="tsd-kind-property">privacySummary</span><span class="tsd-signature-symbol">:</span> <a href="PrivacySummary.html" class="tsd-signature-type tsd-kind-interface">PrivacySummary</a></div>
|
|
69
77
|
<div class="tsd-comment tsd-typography"><p>Concise human-readable summary of privacy findings.</p>
|
|
70
78
|
</div><aside class="tsd-sources">
|
|
71
79
|
<ul>
|
|
72
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
80
|
+
<li>Defined in src/public/typings/analysisResult.ts:95</li></ul></aside></section>
|
|
73
81
|
<section class="tsd-panel tsd-member">
|
|
74
82
|
<h3 class="tsd-anchor-link" id="riskindicators"><span>risk<wbr/>Indicators</span><a href="#riskindicators" 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
83
|
<div class="tsd-signature"><span class="tsd-kind-property">riskIndicators</span><span class="tsd-signature-symbol">:</span> <a href="RiskIndicators.html" class="tsd-signature-type tsd-kind-interface">RiskIndicators</a></div>
|
|
76
84
|
<div class="tsd-comment tsd-typography"><p>Aggregated risk indicators.</p>
|
|
77
85
|
</div><aside class="tsd-sources">
|
|
78
86
|
<ul>
|
|
79
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
87
|
+
<li>Defined in src/public/typings/analysisResult.ts:98</li></ul></aside></section></section></details></div>
|
|
80
88
|
<div class="col-sidebar">
|
|
81
89
|
<div class="page-menu">
|
|
82
90
|
<div class="tsd-navigation settings">
|
|
@@ -93,7 +101,7 @@ Undefined when scoring is disabled.</p>
|
|
|
93
101
|
<h3>On This Page</h3></summary>
|
|
94
102
|
<div class="tsd-accordion-details">
|
|
95
103
|
<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="#capabilities"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>capabilities</span></a><a href="#categories"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>categories</span></a><a href="#organizationidentity"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>organization<wbr/>Identity</span></a><a href="#privacyscore"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>privacy<wbr/>Score</span></a><a href="#privacysummary"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>privacy<wbr/>Summary</span></a><a href="#riskindicators"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>risk<wbr/>Indicators</span></a></div></details></div></details></div>
|
|
104
|
+
<div><a href="#attribution"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>attribution</span></a><a href="#capabilities"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>capabilities</span></a><a href="#categories"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>categories</span></a><a href="#organizationidentity"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>organization<wbr/>Identity</span></a><a href="#privacyscore"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>privacy<wbr/>Score</span></a><a href="#privacysummary"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>privacy<wbr/>Summary</span></a><a href="#riskindicators"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>risk<wbr/>Indicators</span></a></div></details></div></details></div>
|
|
97
105
|
<div class="site-menu">
|
|
98
106
|
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
99
107
|
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>Signals derived from privacy actions and capabilities.</p>
|
|
15
15
|
<p>CapabilitySignals</p>
|
|
16
16
|
</div></section>
|
|
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="#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">
|
|
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:267</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>
|
|
@@ -30,6 +30,7 @@
|
|
|
30
30
|
<a href="#supportsdatadeletionrequests" 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>supports<wbr/>Data<wbr/>Deletion<wbr/>Requests</span></a>
|
|
31
31
|
<a href="#supportsdataexport" 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>supports<wbr/>Data<wbr/>Export</span></a>
|
|
32
32
|
<a href="#supportssubscriptions" 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>supports<wbr/>Subscriptions</span></a>
|
|
33
|
+
<a href="#supportstwofactorauth" 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>supports<wbr/>Two<wbr/>Factor<wbr/>Auth</span></a>
|
|
33
34
|
<a href="#usescookiesortracking" 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>uses<wbr/>Cookies<wbr/>Or<wbr/>Tracking</span></a>
|
|
34
35
|
</div></section></div></details></section></section>
|
|
35
36
|
<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>
|
|
@@ -41,49 +42,56 @@
|
|
|
41
42
|
<div class="tsd-comment tsd-typography"><p>Whether the organization sells personal information.</p>
|
|
42
43
|
</div><aside class="tsd-sources">
|
|
43
44
|
<ul>
|
|
44
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
45
|
+
<li>Defined in src/public/typings/analysisResult.ts:273</li></ul></aside></section>
|
|
45
46
|
<section class="tsd-panel tsd-member">
|
|
46
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>
|
|
47
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>
|
|
48
49
|
<div class="tsd-comment tsd-typography"><p>Whether the organization supports creating an account.</p>
|
|
49
50
|
</div><aside class="tsd-sources">
|
|
50
51
|
<ul>
|
|
51
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
52
|
+
<li>Defined in src/public/typings/analysisResult.ts:268</li></ul></aside></section>
|
|
52
53
|
<section class="tsd-panel tsd-member">
|
|
53
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>
|
|
54
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>
|
|
55
56
|
<div class="tsd-comment tsd-typography"><p>Whether the organization supports account deletion.</p>
|
|
56
57
|
</div><aside class="tsd-sources">
|
|
57
58
|
<ul>
|
|
58
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
59
|
+
<li>Defined in src/public/typings/analysisResult.ts:269</li></ul></aside></section>
|
|
59
60
|
<section class="tsd-panel tsd-member">
|
|
60
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>
|
|
61
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>
|
|
62
63
|
<div class="tsd-comment tsd-typography"><p>Whether the organization supports data deletion requests.</p>
|
|
63
64
|
</div><aside class="tsd-sources">
|
|
64
65
|
<ul>
|
|
65
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
66
|
+
<li>Defined in src/public/typings/analysisResult.ts:270</li></ul></aside></section>
|
|
66
67
|
<section class="tsd-panel tsd-member">
|
|
67
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>
|
|
68
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>
|
|
69
70
|
<div class="tsd-comment tsd-typography"><p>Whether the organization supports data export.</p>
|
|
70
71
|
</div><aside class="tsd-sources">
|
|
71
72
|
<ul>
|
|
72
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
73
|
+
<li>Defined in src/public/typings/analysisResult.ts:271</li></ul></aside></section>
|
|
73
74
|
<section class="tsd-panel tsd-member">
|
|
74
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>
|
|
75
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>
|
|
76
77
|
<div class="tsd-comment tsd-typography"><p>Whether the organization supports subscription management.</p>
|
|
77
78
|
</div><aside class="tsd-sources">
|
|
78
79
|
<ul>
|
|
79
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
80
|
+
<li>Defined in src/public/typings/analysisResult.ts:272</li></ul></aside></section>
|
|
81
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Whether the organization supports two-factor auth for logins.</p>
|
|
85
|
+
</div><aside class="tsd-sources">
|
|
86
|
+
<ul>
|
|
87
|
+
<li>Defined in src/public/typings/analysisResult.ts:275</li></ul></aside></section>
|
|
80
88
|
<section class="tsd-panel tsd-member">
|
|
81
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>
|
|
82
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>
|
|
83
91
|
<div class="tsd-comment tsd-typography"><p>Whether the organization uses cookies or tracking.</p>
|
|
84
92
|
</div><aside class="tsd-sources">
|
|
85
93
|
<ul>
|
|
86
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
94
|
+
<li>Defined in src/public/typings/analysisResult.ts:274</li></ul></aside></section></section></details></div>
|
|
87
95
|
<div class="col-sidebar">
|
|
88
96
|
<div class="page-menu">
|
|
89
97
|
<div class="tsd-navigation settings">
|
|
@@ -100,7 +108,7 @@
|
|
|
100
108
|
<h3>On This Page</h3></summary>
|
|
101
109
|
<div class="tsd-accordion-details">
|
|
102
110
|
<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>
|
|
103
|
-
<div><a href="#sellspersonalinformation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sells<wbr/>Personal<wbr/>Information</span></a><a href="#supportsaccountcreation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Account<wbr/>Creation</span></a><a href="#supportsaccountdeletion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Account<wbr/>Deletion</span></a><a href="#supportsdatadeletionrequests"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Data<wbr/>Deletion<wbr/>Requests</span></a><a href="#supportsdataexport"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Data<wbr/>Export</span></a><a href="#supportssubscriptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Subscriptions</span></a><a href="#usescookiesortracking"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uses<wbr/>Cookies<wbr/>Or<wbr/>Tracking</span></a></div></details></div></details></div>
|
|
111
|
+
<div><a href="#sellspersonalinformation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sells<wbr/>Personal<wbr/>Information</span></a><a href="#supportsaccountcreation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Account<wbr/>Creation</span></a><a href="#supportsaccountdeletion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Account<wbr/>Deletion</span></a><a href="#supportsdatadeletionrequests"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Data<wbr/>Deletion<wbr/>Requests</span></a><a href="#supportsdataexport"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Data<wbr/>Export</span></a><a href="#supportssubscriptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Subscriptions</span></a><a href="#supportstwofactorauth"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Two<wbr/>Factor<wbr/>Auth</span></a><a href="#usescookiesortracking"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uses<wbr/>Cookies<wbr/>Or<wbr/>Tracking</span></a></div></details></div></details></div>
|
|
104
112
|
<div class="site-menu">
|
|
105
113
|
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
106
114
|
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>Privacy signals specific to a single data category.</p>
|
|
15
15
|
<p>CategorySignals</p>
|
|
16
16
|
</div></section>
|
|
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="#
|
|
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:241</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>
|
|
@@ -27,12 +27,12 @@
|
|
|
27
27
|
<div class="tsd-index-list"><a href="#category" 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>category</span></a>
|
|
28
28
|
<a href="#collected" 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>collected</span></a>
|
|
29
29
|
<a href="#datalabels" 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>data<wbr/>Labels</span></a>
|
|
30
|
+
<a href="#monetized" 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>monetized</span></a>
|
|
30
31
|
<a href="#requiredforlaw" 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>required<wbr/>For<wbr/>Law</span></a>
|
|
31
32
|
<a href="#requiredforservice" 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>required<wbr/>For<wbr/>Service</span></a>
|
|
32
33
|
<a href="#retained" 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>retained</span></a>
|
|
33
34
|
<a href="#retention" 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>retention?</span></a>
|
|
34
35
|
<a href="#sharedwiththirdparties" 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>shared<wbr/>With<wbr/>Third<wbr/>Parties</span></a>
|
|
35
|
-
<a href="#usedforadvertising" 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>used<wbr/>For<wbr/>Advertising</span></a>
|
|
36
36
|
<a href="#usercanoptout" 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>user<wbr/>Can<wbr/>Opt<wbr/>Out</span></a>
|
|
37
37
|
</div></section></div></details></section></section>
|
|
38
38
|
<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>
|
|
@@ -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:242</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:243</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:244</li></ul></aside></section>
|
|
62
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Whether this category is used for monetization.</p>
|
|
66
|
+
</div><aside class="tsd-sources">
|
|
67
|
+
<ul>
|
|
68
|
+
<li>Defined in src/public/typings/analysisResult.ts:246</li></ul></aside></section>
|
|
62
69
|
<section class="tsd-panel tsd-member">
|
|
63
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>
|
|
64
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>
|
|
65
72
|
<div class="tsd-comment tsd-typography"><p>Whether this data is collected to comply with legal requirements.</p>
|
|
66
73
|
</div><aside class="tsd-sources">
|
|
67
74
|
<ul>
|
|
68
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
75
|
+
<li>Defined in src/public/typings/analysisResult.ts:251</li></ul></aside></section>
|
|
69
76
|
<section class="tsd-panel tsd-member">
|
|
70
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>
|
|
71
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>
|
|
72
79
|
<div class="tsd-comment tsd-typography"><p>Whether this data is required for the core service to function.</p>
|
|
73
80
|
</div><aside class="tsd-sources">
|
|
74
81
|
<ul>
|
|
75
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
82
|
+
<li>Defined in src/public/typings/analysisResult.ts:250</li></ul></aside></section>
|
|
76
83
|
<section class="tsd-panel tsd-member">
|
|
77
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>
|
|
78
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>
|
|
79
86
|
<div class="tsd-comment tsd-typography"><p>Whether this category is retained.</p>
|
|
80
87
|
</div><aside class="tsd-sources">
|
|
81
88
|
<ul>
|
|
82
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
89
|
+
<li>Defined in src/public/typings/analysisResult.ts:247</li></ul></aside></section>
|
|
83
90
|
<section class="tsd-panel tsd-member">
|
|
84
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>
|
|
85
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>
|
|
86
93
|
<div class="tsd-comment tsd-typography"><p>Retention details when data is retained.</p>
|
|
87
94
|
</div><aside class="tsd-sources">
|
|
88
95
|
<ul>
|
|
89
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
96
|
+
<li>Defined in src/public/typings/analysisResult.ts:248</li></ul></aside></section>
|
|
90
97
|
<section class="tsd-panel tsd-member">
|
|
91
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>
|
|
92
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>
|
|
93
100
|
<div class="tsd-comment tsd-typography"><p>How this category is shared with third parties.</p>
|
|
94
101
|
</div><aside class="tsd-sources">
|
|
95
102
|
<ul>
|
|
96
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
97
|
-
<section class="tsd-panel tsd-member">
|
|
98
|
-
<h3 class="tsd-anchor-link" id="usedforadvertising"><span>used<wbr/>For<wbr/>Advertising</span><a href="#usedforadvertising" 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
|
-
<div class="tsd-signature"><span class="tsd-kind-property">usedForAdvertising</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
100
|
-
<div class="tsd-comment tsd-typography"><p>Whether this category is used for advertising or monetization.</p>
|
|
101
|
-
</div><aside class="tsd-sources">
|
|
102
|
-
<ul>
|
|
103
|
-
<li>Defined in src/public/typings/analysisResult.ts:244</li></ul></aside></section>
|
|
103
|
+
<li>Defined in src/public/typings/analysisResult.ts:245</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:249</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">
|
|
@@ -124,7 +124,7 @@
|
|
|
124
124
|
<h3>On This Page</h3></summary>
|
|
125
125
|
<div class="tsd-accordion-details">
|
|
126
126
|
<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>
|
|
127
|
-
<div><a href="#category"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>category</span></a><a href="#collected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>collected</span></a><a href="#datalabels"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Labels</span></a><a href="#
|
|
127
|
+
<div><a href="#category"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>category</span></a><a href="#collected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>collected</span></a><a href="#datalabels"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data<wbr/>Labels</span></a><a href="#monetized"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>monetized</span></a><a href="#requiredforlaw"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>required<wbr/>For<wbr/>Law</span></a><a href="#requiredforservice"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>required<wbr/>For<wbr/>Service</span></a><a href="#retained"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retained</span></a><a href="#retention"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>retention</span></a><a href="#sharedwiththirdparties"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>shared<wbr/>With<wbr/>Third<wbr/>Parties</span></a><a href="#usercanoptout"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>user<wbr/>Can<wbr/>Opt<wbr/>Out</span></a></div></details></div></details></div>
|
|
128
128
|
<div class="site-menu">
|
|
129
129
|
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
130
130
|
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
@@ -0,0 +1,79 @@
|
|
|
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>ConnectVirtualPresenceWithAuthCodeInput | @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">ConnectVirtualPresenceWithAuthCodeInput</a></li></ul>
|
|
12
|
+
<h1>Interface ConnectVirtualPresenceWithAuthCodeInput</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Properties required to connect a virtual presence with an auth code.</p>
|
|
15
|
+
<p>ConnectVirtualPresenceWithAuthCodeInput</p>
|
|
16
|
+
</div></section>
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ConnectVirtualPresenceWithAuthCodeInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#authcode">authCode</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="#redirecturi">redirectUri</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="#relationshipprovider">relationshipProvider</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/RelationshipProvider.html" class="tsd-signature-type tsd-kind-enum">RelationshipProvider</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
|
+
<ul>
|
|
19
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:19</li></ul></aside>
|
|
20
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
21
|
+
<section class="tsd-panel tsd-index-panel">
|
|
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>
|
|
23
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
24
|
+
<div class="tsd-accordion-details">
|
|
25
|
+
<section class="tsd-index-section">
|
|
26
|
+
<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>
|
|
27
|
+
<div class="tsd-index-list"><a href="#authcode" 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>auth<wbr/>Code</span></a>
|
|
28
|
+
<a href="#redirecturi" 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>redirect<wbr/>Uri?</span></a>
|
|
29
|
+
<a href="#relationshipprovider" 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>relationship<wbr/>Provider?</span></a>
|
|
30
|
+
</div></section></div></details></section></section>
|
|
31
|
+
<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>
|
|
32
|
+
<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>
|
|
33
|
+
<section>
|
|
34
|
+
<section class="tsd-panel tsd-member">
|
|
35
|
+
<h3 class="tsd-anchor-link" id="authcode"><span>auth<wbr/>Code</span><a href="#authcode" 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>
|
|
36
|
+
<div class="tsd-signature"><span class="tsd-kind-property">authCode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
37
|
+
<div class="tsd-comment tsd-typography"><p>An authorization code obtained from the OAuth flow.</p>
|
|
38
|
+
</div><aside class="tsd-sources">
|
|
39
|
+
<ul>
|
|
40
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:20</li></ul></aside></section>
|
|
41
|
+
<section class="tsd-panel tsd-member">
|
|
42
|
+
<h3 class="tsd-anchor-link" id="redirecturi"><code class="tsd-tag">Optional</code><span>redirect<wbr/>Uri</span><a href="#redirecturi" 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>
|
|
43
|
+
<div class="tsd-signature"><span class="tsd-kind-property">redirectUri</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
44
|
+
<div class="tsd-comment tsd-typography"><p>The redirect URI that was used to obtain the
|
|
45
|
+
authorization code.</p>
|
|
46
|
+
</div><aside class="tsd-sources">
|
|
47
|
+
<ul>
|
|
48
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:21</li></ul></aside></section>
|
|
49
|
+
<section class="tsd-panel tsd-member">
|
|
50
|
+
<h3 class="tsd-anchor-link" id="relationshipprovider"><code class="tsd-tag">Optional</code><span>relationship<wbr/>Provider</span><a href="#relationshipprovider" 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>
|
|
51
|
+
<div class="tsd-signature"><span class="tsd-kind-property">relationshipProvider</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/RelationshipProvider.html" class="tsd-signature-type tsd-kind-enum">RelationshipProvider</a></div>
|
|
52
|
+
<div class="tsd-comment tsd-typography"><p>The relationship provider
|
|
53
|
+
to associate with the connection.</p>
|
|
54
|
+
</div><aside class="tsd-sources">
|
|
55
|
+
<ul>
|
|
56
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:22</li></ul></aside></section></section></details></div>
|
|
57
|
+
<div class="col-sidebar">
|
|
58
|
+
<div class="page-menu">
|
|
59
|
+
<div class="tsd-navigation settings">
|
|
60
|
+
<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>
|
|
61
|
+
<h3>Settings</h3></summary>
|
|
62
|
+
<div class="tsd-accordion-details">
|
|
63
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
64
|
+
<ul id="tsd-filter-options">
|
|
65
|
+
<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>
|
|
66
|
+
<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>
|
|
67
|
+
<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>
|
|
68
|
+
<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>
|
|
69
|
+
<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>
|
|
70
|
+
<h3>On This Page</h3></summary>
|
|
71
|
+
<div class="tsd-accordion-details">
|
|
72
|
+
<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>
|
|
73
|
+
<div><a href="#authcode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auth<wbr/>Code</span></a><a href="#redirecturi"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>redirect<wbr/>Uri</span></a><a href="#relationshipprovider"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>relationship<wbr/>Provider</span></a></div></details></div></details></div>
|
|
74
|
+
<div class="site-menu">
|
|
75
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
76
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
77
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
78
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
79
|
+
<div class="overlay"></div></body></html>
|