@sudoplatform/sudo-privacy-interaction 2.1.0 → 2.3.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 +1111 -132
- package/cjs/gen/schema-types.js +2 -0
- package/cjs/private/data/action/actionSubscriptionManager.js +25 -0
- package/cjs/private/data/action/defaultActionService.js +87 -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/capabilitySignalsTransformer.js +5 -2
- package/cjs/private/data/analysis-result/transformer/organizationCategoryTransformer.js +4 -0
- package/cjs/private/data/common/apiClient.js +64 -1
- package/cjs/private/data/data-holder/defaultDataHolderService.js +8 -0
- package/cjs/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +4 -0
- package/cjs/private/data/organization-analysis/defaultOrganizationAnalysisService.js +6 -0
- package/cjs/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.js +29 -0
- package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +8 -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/analysis-result/analysisResultEntity.js +1 -0
- package/cjs/private/domain/entities/data-holder/dataHolderEntity.js +2 -0
- package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +17 -1
- package/cjs/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +25 -0
- package/cjs/private/domain/use-cases/action/getActionUseCase.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/archiveDataHolderUseCase.js +25 -0
- package/cjs/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.js +25 -0
- package/cjs/public/defaultSudoPrivacyInteractionClient.js +89 -0
- package/cjs/public/inputs/action.js +7 -0
- package/cjs/public/inputs/index.js +1 -0
- package/cjs/public/typings/action.js +85 -0
- package/cjs/public/typings/analysisResult.js +1 -0
- package/cjs/public/typings/dataHolder.js +2 -0
- package/cjs/public/typings/index.js +1 -0
- package/cjs/public/typings/organizationAnalysis.js +17 -1
- 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 +194 -22
- 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/DataHolderProtectionState.html +12 -6
- package/docs/enums/OrganizationAnalysisDomainResolution.html +70 -0
- package/docs/enums/OrganizationCategory.html +38 -32
- package/docs/enums/ProviderType.html +3 -3
- package/docs/enums/VirtualPresenceState.html +7 -7
- package/docs/hierarchy.html +6 -6
- 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 +41 -29
- package/docs/interfaces/DataHolderCount.html +98 -0
- package/docs/interfaces/DataHolderScanSummary.html +14 -14
- package/docs/interfaces/DataHolderSubscriber.html +3 -3
- package/docs/interfaces/GetOrganizationAnalysisInput.html +24 -5
- 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 +1 -1
- package/docs/interfaces/ListDataHoldersInput.html +1 -1
- package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
- package/docs/interfaces/OrganizationIdentity.html +5 -5
- package/docs/interfaces/Pagination.html +1 -1
- package/docs/interfaces/RiskIndicators.html +8 -8
- package/docs/interfaces/SudoPrivacyInteractionClient.html +186 -22
- package/docs/interfaces/VirtualPresence.html +22 -13
- 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 +1109 -131
- package/lib/gen/schema-types.js +1 -0
- package/lib/private/data/action/actionSubscriptionManager.js +21 -0
- package/lib/private/data/action/defaultActionService.js +83 -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/capabilitySignalsTransformer.js +5 -2
- package/lib/private/data/analysis-result/transformer/organizationCategoryTransformer.js +4 -0
- package/lib/private/data/common/apiClient.js +65 -2
- package/lib/private/data/data-holder/defaultDataHolderService.js +8 -0
- package/lib/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +4 -0
- package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +6 -0
- package/lib/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.js +25 -0
- package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +8 -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/analysis-result/analysisResultEntity.js +1 -0
- package/lib/private/domain/entities/data-holder/dataHolderEntity.js +2 -0
- package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +16 -0
- package/lib/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +21 -0
- package/lib/private/domain/use-cases/action/getActionUseCase.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/archiveDataHolderUseCase.js +21 -0
- package/lib/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.js +21 -0
- package/lib/public/defaultSudoPrivacyInteractionClient.js +89 -0
- package/lib/public/inputs/action.js +6 -0
- package/lib/public/inputs/index.js +1 -0
- package/lib/public/typings/action.js +82 -0
- package/lib/public/typings/analysisResult.js +1 -0
- package/lib/public/typings/dataHolder.js +2 -0
- package/lib/public/typings/index.js +1 -0
- package/lib/public/typings/organizationAnalysis.js +16 -0
- package/package.json +20 -24
- package/types/gen/graphqlTypes.d.ts +427 -497
- package/types/gen/schema-types.d.ts +521 -0
- package/types/private/data/action/actionSubscriptionManager.d.ts +19 -0
- package/types/private/data/action/defaultActionService.d.ts +24 -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 +12 -1
- package/types/private/data/data-holder/defaultDataHolderService.d.ts +2 -0
- package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +1 -0
- package/types/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.d.ts +12 -0
- package/types/private/domain/entities/action/actionEntity.d.ts +187 -0
- package/types/private/domain/entities/action/actionService.d.ts +110 -0
- package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +3 -2
- package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +2 -0
- package/types/private/domain/entities/data-holder/dataHolderService.d.ts +16 -0
- package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +15 -0
- package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +8 -1
- package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +24 -0
- package/types/private/domain/use-cases/action/confirmActionOutcomeUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/action/getActionUseCase.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/archiveDataHolderUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.d.ts +16 -0
- package/types/public/defaultSudoPrivacyInteractionClient.d.ts +16 -2
- package/types/public/inputs/action.d.ts +30 -0
- package/types/public/inputs/index.d.ts +1 -0
- package/types/public/inputs/organizationAnalysis.d.ts +8 -1
- package/types/public/sudoPrivacyInteractionClient.d.ts +68 -2
- package/types/public/typings/action.d.ts +185 -0
- package/types/public/typings/analysisResult.d.ts +8 -0
- package/types/public/typings/dataHolder.d.ts +2 -0
- package/types/public/typings/index.d.ts +1 -0
- package/types/public/typings/organizationAnalysis.d.ts +15 -0
- package/types/public/typings/subscription.d.ts +23 -0
- package/types/public/typings/virtualPresence.d.ts +25 -0
|
@@ -0,0 +1,98 @@
|
|
|
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>DataHolderCount | @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">DataHolderCount</a></li></ul>
|
|
12
|
+
<h1>Interface DataHolderCount</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Counts of a virtual presence's data holders, broken down by protection state.</p>
|
|
15
|
+
<p>DataHolderCount</p>
|
|
16
|
+
</div></section>
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DataHolderCount</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#archived">archived</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#completedactions">completedActions</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#count">count</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#initiatedactions">initiatedActions</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#monitored">monitored</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><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/typings/virtualPresence.ts:56</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="#archived" 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>archived</span></a>
|
|
28
|
+
<a href="#completedactions" 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>completed<wbr/>Actions</span></a>
|
|
29
|
+
<a href="#count" 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>count</span></a>
|
|
30
|
+
<a href="#initiatedactions" 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>initiated<wbr/>Actions</span></a>
|
|
31
|
+
<a href="#monitored" 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>monitored</span></a>
|
|
32
|
+
</div></section></div></details></section></section>
|
|
33
|
+
<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>
|
|
34
|
+
<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>
|
|
35
|
+
<section>
|
|
36
|
+
<section class="tsd-panel tsd-member">
|
|
37
|
+
<h3 class="tsd-anchor-link" id="archived"><span>archived</span><a href="#archived" 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>
|
|
38
|
+
<div class="tsd-signature"><span class="tsd-kind-property">archived</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
39
|
+
<div class="tsd-comment tsd-typography"><p>Data holders the user has archived
|
|
40
|
+
(protection state Archived).</p>
|
|
41
|
+
</div><aside class="tsd-sources">
|
|
42
|
+
<ul>
|
|
43
|
+
<li>Defined in src/public/typings/virtualPresence.ts:61</li></ul></aside></section>
|
|
44
|
+
<section class="tsd-panel tsd-member">
|
|
45
|
+
<h3 class="tsd-anchor-link" id="completedactions"><span>completed<wbr/>Actions</span><a href="#completedactions" 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
|
+
<div class="tsd-signature"><span class="tsd-kind-property">completedActions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
47
|
+
<div class="tsd-comment tsd-typography"><p>Data holders whose action has completed
|
|
48
|
+
(protection state Resolved).</p>
|
|
49
|
+
</div><aside class="tsd-sources">
|
|
50
|
+
<ul>
|
|
51
|
+
<li>Defined in src/public/typings/virtualPresence.ts:60</li></ul></aside></section>
|
|
52
|
+
<section class="tsd-panel tsd-member">
|
|
53
|
+
<h3 class="tsd-anchor-link" id="count"><span>count</span><a href="#count" 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">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
55
|
+
<div class="tsd-comment tsd-typography"><p>Active (non-archived) data holders: the sum of monitored,
|
|
56
|
+
initiatedActions, and completedActions. Excludes archived.</p>
|
|
57
|
+
</div><aside class="tsd-sources">
|
|
58
|
+
<ul>
|
|
59
|
+
<li>Defined in src/public/typings/virtualPresence.ts:57</li></ul></aside></section>
|
|
60
|
+
<section class="tsd-panel tsd-member">
|
|
61
|
+
<h3 class="tsd-anchor-link" id="initiatedactions"><span>initiated<wbr/>Actions</span><a href="#initiatedactions" 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
|
+
<div class="tsd-signature"><span class="tsd-kind-property">initiatedActions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
63
|
+
<div class="tsd-comment tsd-typography"><p>Data holders with an action in progress
|
|
64
|
+
(protection state ActionRequested).</p>
|
|
65
|
+
</div><aside class="tsd-sources">
|
|
66
|
+
<ul>
|
|
67
|
+
<li>Defined in src/public/typings/virtualPresence.ts:59</li></ul></aside></section>
|
|
68
|
+
<section class="tsd-panel tsd-member">
|
|
69
|
+
<h3 class="tsd-anchor-link" id="monitored"><span>monitored</span><a href="#monitored" 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>
|
|
70
|
+
<div class="tsd-signature"><span class="tsd-kind-property">monitored</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
71
|
+
<div class="tsd-comment tsd-typography"><p>Data holders the system has identified
|
|
72
|
+
(protection state Monitored).</p>
|
|
73
|
+
</div><aside class="tsd-sources">
|
|
74
|
+
<ul>
|
|
75
|
+
<li>Defined in src/public/typings/virtualPresence.ts:58</li></ul></aside></section></section></details></div>
|
|
76
|
+
<div class="col-sidebar">
|
|
77
|
+
<div class="page-menu">
|
|
78
|
+
<div class="tsd-navigation settings">
|
|
79
|
+
<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>
|
|
80
|
+
<h3>Settings</h3></summary>
|
|
81
|
+
<div class="tsd-accordion-details">
|
|
82
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
83
|
+
<ul id="tsd-filter-options">
|
|
84
|
+
<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>
|
|
85
|
+
<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>
|
|
86
|
+
<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>
|
|
87
|
+
<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>
|
|
88
|
+
<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>
|
|
89
|
+
<h3>On This Page</h3></summary>
|
|
90
|
+
<div class="tsd-accordion-details">
|
|
91
|
+
<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>
|
|
92
|
+
<div><a href="#archived"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>archived</span></a><a href="#completedactions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>completed<wbr/>Actions</span></a><a href="#count"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>count</span></a><a href="#initiatedactions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>initiated<wbr/>Actions</span></a><a href="#monitored"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>monitored</span></a></div></details></div></details></div>
|
|
93
|
+
<div class="site-menu">
|
|
94
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
95
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
96
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
97
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
98
|
+
<div class="overlay"></div></body></html>
|
|
@@ -17,7 +17,7 @@ during a single scan for a specific data holder.</p>
|
|
|
17
17
|
</div></section>
|
|
18
18
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DataHolderScanSummary</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#categorybreakdown">categoryBreakdown</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#dataholderid">dataHolderId</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="#emailcount">emailCount</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#marketingemailcount">marketingEmailCount</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#marketingemailopened">marketingEmailOpened</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#marketingopenrate">marketingOpenRate</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#owner">owner</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="#readcount">readCount</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#readrate">readRate</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#scannedat">scannedAt</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#scanrangefrom">scanRangeFrom</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#scanrangeto">scanRangeTo</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#uncategorizedcount">uncategorizedCount</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
19
19
|
<ul>
|
|
20
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
20
|
+
<li>Defined in src/public/typings/dataHolder.ts:80</li></ul></aside>
|
|
21
21
|
<section class="tsd-panel-group tsd-index-group">
|
|
22
22
|
<section class="tsd-panel tsd-index-panel">
|
|
23
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>
|
|
@@ -48,91 +48,91 @@ during a single scan for a specific data holder.</p>
|
|
|
48
48
|
<div class="tsd-comment tsd-typography"><p>Count of emails per category.</p>
|
|
49
49
|
</div><aside class="tsd-sources">
|
|
50
50
|
<ul>
|
|
51
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
51
|
+
<li>Defined in src/public/typings/dataHolder.ts:92</li></ul></aside></section>
|
|
52
52
|
<section class="tsd-panel tsd-member">
|
|
53
53
|
<h3 class="tsd-anchor-link" id="dataholderid"><span>data<wbr/>Holder<wbr/>Id</span><a href="#dataholderid" 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
54
|
<div class="tsd-signature"><span class="tsd-kind-property">dataHolderId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
55
55
|
<div class="tsd-comment tsd-typography"><p>The data holder these metrics apply to.</p>
|
|
56
56
|
</div><aside class="tsd-sources">
|
|
57
57
|
<ul>
|
|
58
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
58
|
+
<li>Defined in src/public/typings/dataHolder.ts:81</li></ul></aside></section>
|
|
59
59
|
<section class="tsd-panel tsd-member">
|
|
60
60
|
<h3 class="tsd-anchor-link" id="emailcount"><span>email<wbr/>Count</span><a href="#emailcount" 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
61
|
<div class="tsd-signature"><span class="tsd-kind-property">emailCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
62
62
|
<div class="tsd-comment tsd-typography"><p>Total number of emails observed in the scan range.</p>
|
|
63
63
|
</div><aside class="tsd-sources">
|
|
64
64
|
<ul>
|
|
65
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
65
|
+
<li>Defined in src/public/typings/dataHolder.ts:86</li></ul></aside></section>
|
|
66
66
|
<section class="tsd-panel tsd-member">
|
|
67
67
|
<h3 class="tsd-anchor-link" id="marketingemailcount"><span>marketing<wbr/>Email<wbr/>Count</span><a href="#marketingemailcount" 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
68
|
<div class="tsd-signature"><span class="tsd-kind-property">marketingEmailCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
69
69
|
<div class="tsd-comment tsd-typography"><p>Number of marketing emails observed.</p>
|
|
70
70
|
</div><aside class="tsd-sources">
|
|
71
71
|
<ul>
|
|
72
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
72
|
+
<li>Defined in src/public/typings/dataHolder.ts:89</li></ul></aside></section>
|
|
73
73
|
<section class="tsd-panel tsd-member">
|
|
74
74
|
<h3 class="tsd-anchor-link" id="marketingemailopened"><span>marketing<wbr/>Email<wbr/>Opened</span><a href="#marketingemailopened" 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
75
|
<div class="tsd-signature"><span class="tsd-kind-property">marketingEmailOpened</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
76
76
|
<div class="tsd-comment tsd-typography"><p>Number of marketing emails that were opened.</p>
|
|
77
77
|
</div><aside class="tsd-sources">
|
|
78
78
|
<ul>
|
|
79
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
79
|
+
<li>Defined in src/public/typings/dataHolder.ts:90</li></ul></aside></section>
|
|
80
80
|
<section class="tsd-panel tsd-member">
|
|
81
81
|
<h3 class="tsd-anchor-link" id="marketingopenrate"><span>marketing<wbr/>Open<wbr/>Rate</span><a href="#marketingopenrate" 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
82
|
<div class="tsd-signature"><span class="tsd-kind-property">marketingOpenRate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
83
83
|
<div class="tsd-comment tsd-typography"><p>Ratio of opened marketing emails to marketing emails.</p>
|
|
84
84
|
</div><aside class="tsd-sources">
|
|
85
85
|
<ul>
|
|
86
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
86
|
+
<li>Defined in src/public/typings/dataHolder.ts:91</li></ul></aside></section>
|
|
87
87
|
<section class="tsd-panel tsd-member">
|
|
88
88
|
<h3 class="tsd-anchor-link" id="owner"><span>owner</span><a href="#owner" 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>
|
|
89
89
|
<div class="tsd-signature"><span class="tsd-kind-property">owner</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
90
90
|
<div class="tsd-comment tsd-typography"><p>Unique identifier of the user.</p>
|
|
91
91
|
</div><aside class="tsd-sources">
|
|
92
92
|
<ul>
|
|
93
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
93
|
+
<li>Defined in src/public/typings/dataHolder.ts:82</li></ul></aside></section>
|
|
94
94
|
<section class="tsd-panel tsd-member">
|
|
95
95
|
<h3 class="tsd-anchor-link" id="readcount"><span>read<wbr/>Count</span><a href="#readcount" 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>
|
|
96
96
|
<div class="tsd-signature"><span class="tsd-kind-property">readCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
97
97
|
<div class="tsd-comment tsd-typography"><p>Number of emails that were read.</p>
|
|
98
98
|
</div><aside class="tsd-sources">
|
|
99
99
|
<ul>
|
|
100
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
100
|
+
<li>Defined in src/public/typings/dataHolder.ts:87</li></ul></aside></section>
|
|
101
101
|
<section class="tsd-panel tsd-member">
|
|
102
102
|
<h3 class="tsd-anchor-link" id="readrate"><span>read<wbr/>Rate</span><a href="#readrate" 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>
|
|
103
103
|
<div class="tsd-signature"><span class="tsd-kind-property">readRate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
104
104
|
<div class="tsd-comment tsd-typography"><p>Ratio of read emails to total emails.</p>
|
|
105
105
|
</div><aside class="tsd-sources">
|
|
106
106
|
<ul>
|
|
107
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
107
|
+
<li>Defined in src/public/typings/dataHolder.ts:88</li></ul></aside></section>
|
|
108
108
|
<section class="tsd-panel tsd-member">
|
|
109
109
|
<h3 class="tsd-anchor-link" id="scannedat"><span>scanned<wbr/>At</span><a href="#scannedat" 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>
|
|
110
110
|
<div class="tsd-signature"><span class="tsd-kind-property">scannedAt</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
111
111
|
<div class="tsd-comment tsd-typography"><p>Date for when the scan was performed.</p>
|
|
112
112
|
</div><aside class="tsd-sources">
|
|
113
113
|
<ul>
|
|
114
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
114
|
+
<li>Defined in src/public/typings/dataHolder.ts:83</li></ul></aside></section>
|
|
115
115
|
<section class="tsd-panel tsd-member">
|
|
116
116
|
<h3 class="tsd-anchor-link" id="scanrangefrom"><span>scan<wbr/>Range<wbr/>From</span><a href="#scanrangefrom" 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>
|
|
117
117
|
<div class="tsd-signature"><span class="tsd-kind-property">scanRangeFrom</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
118
118
|
<div class="tsd-comment tsd-typography"><p>Start of the scanned time range.</p>
|
|
119
119
|
</div><aside class="tsd-sources">
|
|
120
120
|
<ul>
|
|
121
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
121
|
+
<li>Defined in src/public/typings/dataHolder.ts:84</li></ul></aside></section>
|
|
122
122
|
<section class="tsd-panel tsd-member">
|
|
123
123
|
<h3 class="tsd-anchor-link" id="scanrangeto"><span>scan<wbr/>Range<wbr/>To</span><a href="#scanrangeto" 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>
|
|
124
124
|
<div class="tsd-signature"><span class="tsd-kind-property">scanRangeTo</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
125
125
|
<div class="tsd-comment tsd-typography"><p>End of the scanned time range.</p>
|
|
126
126
|
</div><aside class="tsd-sources">
|
|
127
127
|
<ul>
|
|
128
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
128
|
+
<li>Defined in src/public/typings/dataHolder.ts:85</li></ul></aside></section>
|
|
129
129
|
<section class="tsd-panel tsd-member">
|
|
130
130
|
<h3 class="tsd-anchor-link" id="uncategorizedcount"><span>uncategorized<wbr/>Count</span><a href="#uncategorizedcount" 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>
|
|
131
131
|
<div class="tsd-signature"><span class="tsd-kind-property">uncategorizedCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
132
132
|
<div class="tsd-comment tsd-typography"><p>Number of emails that could not be categorized.</p>
|
|
133
133
|
</div><aside class="tsd-sources">
|
|
134
134
|
<ul>
|
|
135
|
-
<li>Defined in src/public/typings/dataHolder.ts:
|
|
135
|
+
<li>Defined in src/public/typings/dataHolder.ts:93</li></ul></aside></section></section></details></div>
|
|
136
136
|
<div class="col-sidebar">
|
|
137
137
|
<div class="page-menu">
|
|
138
138
|
<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">DataHolderSubscriber</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#connectionstatuschanged-1">connectionStatusChanged</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <a href="../enums/ConnectionState.html" class="tsd-signature-type tsd-kind-enum">ConnectionState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#dataholdersupdated-1">dataHoldersUpdated</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dataHolders</span><span class="tsd-signature-symbol">:</span> <a href="DataHolder.html" class="tsd-signature-type tsd-kind-interface">DataHolder</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><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/subscription.ts:
|
|
19
|
+
<li>Defined in src/public/typings/subscription.ts:54</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>
|
|
@@ -49,7 +49,7 @@ data holder change notifications when the connection state changes to <code>Conn
|
|
|
49
49
|
</div></li></ul></div>
|
|
50
50
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
51
51
|
<ul>
|
|
52
|
-
<li>Defined in src/public/typings/subscription.ts:
|
|
52
|
+
<li>Defined in src/public/typings/subscription.ts:70</li></ul></aside></div></li></ul></section>
|
|
53
53
|
<section class="tsd-panel tsd-member">
|
|
54
54
|
<h3 class="tsd-anchor-link" id="dataholdersupdated"><span>data<wbr/>Holders<wbr/>Updated</span><a href="#dataholdersupdated" 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
|
<ul class="tsd-signatures">
|
|
@@ -66,7 +66,7 @@ data holder change notifications when the connection state changes to <code>Conn
|
|
|
66
66
|
</div></li></ul></div>
|
|
67
67
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
68
68
|
<ul>
|
|
69
|
-
<li>Defined in src/public/typings/subscription.ts:
|
|
69
|
+
<li>Defined in src/public/typings/subscription.ts:60</li></ul></aside></div></li></ul></section></section></details></div>
|
|
70
70
|
<div class="col-sidebar">
|
|
71
71
|
<div class="page-menu">
|
|
72
72
|
<div class="tsd-navigation settings">
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
<div class="tsd-comment tsd-typography"><p>Properties required to obtain an organization analysis.</p>
|
|
15
15
|
<p>GetOrganizationAnalysisInput</p>
|
|
16
16
|
</div></section>
|
|
17
|
-
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">GetOrganizationAnalysisInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#domain">domain</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="#mode">mode</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/OrganizationAnalysisMode.html" class="tsd-signature-type tsd-kind-enum">OrganizationAnalysisMode</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">GetOrganizationAnalysisInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#domain">domain</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="#mode">mode</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/OrganizationAnalysisMode.html" class="tsd-signature-type tsd-kind-enum">OrganizationAnalysisMode</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</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="#resolution">resolution</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/OrganizationAnalysisDomainResolution.html" class="tsd-signature-type tsd-kind-enum">OrganizationAnalysisDomainResolution</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/inputs/organizationAnalysis.ts:
|
|
19
|
+
<li>Defined in src/public/inputs/organizationAnalysis.ts:25</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>
|
|
@@ -26,6 +26,8 @@
|
|
|
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
27
|
<div class="tsd-index-list"><a href="#domain" 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>domain</span></a>
|
|
28
28
|
<a href="#mode" 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>mode?</span></a>
|
|
29
|
+
<a href="#name" 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>name?</span></a>
|
|
30
|
+
<a href="#resolution" 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>resolution?</span></a>
|
|
29
31
|
</div></section></div></details></section></section>
|
|
30
32
|
<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>
|
|
31
33
|
<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,7 +38,7 @@
|
|
|
36
38
|
<div class="tsd-comment tsd-typography"><p>The domain to analyze.</p>
|
|
37
39
|
</div><aside class="tsd-sources">
|
|
38
40
|
<ul>
|
|
39
|
-
<li>Defined in src/public/inputs/organizationAnalysis.ts:
|
|
41
|
+
<li>Defined in src/public/inputs/organizationAnalysis.ts:26</li></ul></aside></section>
|
|
40
42
|
<section class="tsd-panel tsd-member">
|
|
41
43
|
<h3 class="tsd-anchor-link" id="mode"><code class="tsd-tag">Optional</code><span>mode</span><a href="#mode" 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
44
|
<div class="tsd-signature"><span class="tsd-kind-property">mode</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/OrganizationAnalysisMode.html" class="tsd-signature-type tsd-kind-enum">OrganizationAnalysisMode</a></div>
|
|
@@ -44,7 +46,24 @@
|
|
|
44
46
|
backend behaves as <code>Analyze</code> (read-through).</p>
|
|
45
47
|
</div><aside class="tsd-sources">
|
|
46
48
|
<ul>
|
|
47
|
-
<li>Defined in src/public/inputs/organizationAnalysis.ts:
|
|
49
|
+
<li>Defined in src/public/inputs/organizationAnalysis.ts:28</li></ul></aside></section>
|
|
50
|
+
<section class="tsd-panel tsd-member">
|
|
51
|
+
<h3 class="tsd-anchor-link" id="name"><code class="tsd-tag">Optional</code><span>name</span><a href="#name" 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>
|
|
52
|
+
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
53
|
+
<div class="tsd-comment tsd-typography"><p>Organization name to analyze (e.g. "amazon", "stripe"). When it resolves
|
|
54
|
+
to a domain it takes precedence over <code>domain</code>; <code>domain</code> remains required and is used as the
|
|
55
|
+
fallback when the name cannot be resolved.</p>
|
|
56
|
+
</div><aside class="tsd-sources">
|
|
57
|
+
<ul>
|
|
58
|
+
<li>Defined in src/public/inputs/organizationAnalysis.ts:27</li></ul></aside></section>
|
|
59
|
+
<section class="tsd-panel tsd-member">
|
|
60
|
+
<h3 class="tsd-anchor-link" id="resolution"><code class="tsd-tag">Optional</code><span>resolution</span><a href="#resolution" 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">resolution</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/OrganizationAnalysisDomainResolution.html" class="tsd-signature-type tsd-kind-enum">OrganizationAnalysisDomainResolution</a></div>
|
|
62
|
+
<div class="tsd-comment tsd-typography"><p>How the requested domain is treated
|
|
63
|
+
before analysis. When omitted, defaults to <code>Exact</code> (the domain is analyzed verbatim).</p>
|
|
64
|
+
</div><aside class="tsd-sources">
|
|
65
|
+
<ul>
|
|
66
|
+
<li>Defined in src/public/inputs/organizationAnalysis.ts:29</li></ul></aside></section></section></details></div>
|
|
48
67
|
<div class="col-sidebar">
|
|
49
68
|
<div class="page-menu">
|
|
50
69
|
<div class="tsd-navigation settings">
|
|
@@ -61,7 +80,7 @@ backend behaves as <code>Analyze</code> (read-through).</p>
|
|
|
61
80
|
<h3>On This Page</h3></summary>
|
|
62
81
|
<div class="tsd-accordion-details">
|
|
63
82
|
<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>
|
|
64
|
-
<div><a href="#domain"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain</span></a><a href="#mode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mode</span></a></div></details></div></details></div>
|
|
83
|
+
<div><a href="#domain"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>domain</span></a><a href="#mode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mode</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#resolution"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resolution</span></a></div></details></div></details></div>
|
|
65
84
|
<div class="site-menu">
|
|
66
85
|
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
67
86
|
<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>InitiateActionInput | @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">InitiateActionInput</a></li></ul>
|
|
12
|
+
<h1>Interface InitiateActionInput</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Properties required to initiate an action against a data holder relationship.</p>
|
|
15
|
+
<p>InitiateActionInput</p>
|
|
16
|
+
</div></section>
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">InitiateActionInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#dataholderid">dataHolderId</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/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
|
+
<ul>
|
|
19
|
+
<li>Defined in src/public/inputs/action.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="#dataholderid" 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/>Holder<wbr/>Id</span></a>
|
|
28
|
+
<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>
|
|
29
|
+
<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>
|
|
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="dataholderid"><span>data<wbr/>Holder<wbr/>Id</span><a href="#dataholderid" 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">dataHolderId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
37
|
+
<div class="tsd-comment tsd-typography"><p>The data holder relationship to scope the action to.</p>
|
|
38
|
+
</div><aside class="tsd-sources">
|
|
39
|
+
<ul>
|
|
40
|
+
<li>Defined in src/public/inputs/action.ts:20</li></ul></aside></section>
|
|
41
|
+
<section class="tsd-panel tsd-member">
|
|
42
|
+
<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>
|
|
43
|
+
<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>
|
|
44
|
+
<div class="tsd-comment tsd-typography"><p>The fulfilment method the client
|
|
45
|
+
was offered for this intent. Initiation fails if the server re-resolves a different
|
|
46
|
+
method.</p>
|
|
47
|
+
</div><aside class="tsd-sources">
|
|
48
|
+
<ul>
|
|
49
|
+
<li>Defined in src/public/inputs/action.ts:22</li></ul></aside></section>
|
|
50
|
+
<section class="tsd-panel tsd-member">
|
|
51
|
+
<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>
|
|
52
|
+
<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>
|
|
53
|
+
<div class="tsd-comment tsd-typography"><p>The intent of the action to initiate.</p>
|
|
54
|
+
</div><aside class="tsd-sources">
|
|
55
|
+
<ul>
|
|
56
|
+
<li>Defined in src/public/inputs/action.ts:21</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="#dataholderid"><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/>Holder<wbr/>Id</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></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>
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<p>ListAnalysisResultsInput</p>
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListAnalysisResultsInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#limit">limit</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nexttoken">nextToken</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="#virtualpresenceid">virtualPresenceId</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>
|
|
18
|
-
<section class="tsd-panel tsd-hierarchy" data-refl="
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="235">
|
|
19
19
|
<h4>Hierarchy (<a href="../hierarchy.html#ListAnalysisResultsInput">View Summary</a>)</h4>
|
|
20
20
|
<ul class="tsd-hierarchy">
|
|
21
21
|
<li class="tsd-hierarchy-item"><a href="Pagination.html" class="tsd-signature-type tsd-kind-interface">Pagination</a>
|
|
@@ -0,0 +1,61 @@
|
|
|
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>ListAvailableActionsInput | @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">ListAvailableActionsInput</a></li></ul>
|
|
12
|
+
<h1>Interface ListAvailableActionsInput</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Properties required to list the actions available for a data holder relationship.</p>
|
|
15
|
+
<p>ListAvailableActionsInput</p>
|
|
16
|
+
</div></section>
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListAvailableActionsInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#dataholderid">dataHolderId</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">
|
|
18
|
+
<ul>
|
|
19
|
+
<li>Defined in src/public/inputs/action.ts:31</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="#dataholderid" 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/>Holder<wbr/>Id</span></a>
|
|
28
|
+
</div></section></div></details></section></section>
|
|
29
|
+
<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>
|
|
30
|
+
<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>
|
|
31
|
+
<section>
|
|
32
|
+
<section class="tsd-panel tsd-member">
|
|
33
|
+
<h3 class="tsd-anchor-link" id="dataholderid"><span>data<wbr/>Holder<wbr/>Id</span><a href="#dataholderid" 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>
|
|
34
|
+
<div class="tsd-signature"><span class="tsd-kind-property">dataHolderId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
35
|
+
<div class="tsd-comment tsd-typography"><p>The data holder relationship to list available actions for.</p>
|
|
36
|
+
</div><aside class="tsd-sources">
|
|
37
|
+
<ul>
|
|
38
|
+
<li>Defined in src/public/inputs/action.ts:32</li></ul></aside></section></section></details></div>
|
|
39
|
+
<div class="col-sidebar">
|
|
40
|
+
<div class="page-menu">
|
|
41
|
+
<div class="tsd-navigation settings">
|
|
42
|
+
<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>
|
|
43
|
+
<h3>Settings</h3></summary>
|
|
44
|
+
<div class="tsd-accordion-details">
|
|
45
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
46
|
+
<ul id="tsd-filter-options">
|
|
47
|
+
<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>
|
|
48
|
+
<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>
|
|
49
|
+
<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>
|
|
50
|
+
<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>
|
|
51
|
+
<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>
|
|
52
|
+
<h3>On This Page</h3></summary>
|
|
53
|
+
<div class="tsd-accordion-details">
|
|
54
|
+
<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>
|
|
55
|
+
<div><a href="#dataholderid"><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/>Holder<wbr/>Id</span></a></div></details></div></details></div>
|
|
56
|
+
<div class="site-menu">
|
|
57
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
58
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
59
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
60
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
61
|
+
<div class="overlay"></div></body></html>
|