@sudoplatform/sudo-privacy-interaction 2.0.0 → 2.1.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 +1727 -772
- package/cjs/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
- package/cjs/private/data/common/apiClient.js +23 -0
- package/cjs/private/data/data-holder/defaultDataHolderService.js +12 -0
- package/cjs/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +56 -0
- package/cjs/private/data/organization-analysis/defaultOrganizationAnalysisService.js +31 -0
- package/cjs/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +29 -0
- package/cjs/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +45 -0
- package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
- package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +24 -0
- package/cjs/private/domain/entities/organization-analysis/organizationAnalysisService.js +7 -0
- package/cjs/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +29 -0
- package/cjs/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +25 -0
- package/cjs/public/defaultSudoPrivacyInteractionClient.js +75 -6
- package/cjs/public/inputs/index.js +1 -0
- package/cjs/public/inputs/organizationAnalysis.js +7 -0
- package/cjs/public/typings/index.js +1 -0
- package/cjs/public/typings/organizationAnalysis.js +24 -0
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/DefaultSudoPrivacyInteractionClient.html +69 -20
- package/docs/enums/DataCategory.html +18 -18
- package/docs/enums/DataHolderProtectionState.html +5 -5
- package/docs/enums/OrganizationAnalysisMode.html +70 -0
- package/docs/enums/OrganizationCategory.html +30 -30
- package/docs/enums/ProviderType.html +3 -3
- package/docs/enums/RetentionStyle.html +5 -5
- package/docs/enums/ShareStyle.html +6 -6
- package/docs/enums/SignalValue.html +4 -4
- package/docs/enums/VirtualPresenceState.html +7 -7
- package/docs/hierarchy.html +6 -5
- package/docs/interfaces/CapabilitySignals.html +9 -9
- package/docs/interfaces/CategorySignals.html +11 -11
- package/docs/interfaces/DataHolder.html +24 -14
- package/docs/interfaces/DataHolderScanSummary.html +158 -0
- package/docs/interfaces/GetDataHolderOptions.html +63 -0
- package/docs/interfaces/GetOrganizationAnalysisInput.html +70 -0
- package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
- package/docs/interfaces/ListDataHolderScanSummariesInput.html +85 -0
- package/docs/interfaces/ListDataHoldersInput.html +1 -1
- package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
- package/docs/interfaces/OrganizationAnalysis.html +131 -0
- package/docs/interfaces/OrganizationIdentity.html +5 -5
- package/docs/interfaces/Pagination.html +2 -1
- package/docs/interfaces/PrivacyScore.html +13 -5
- package/docs/interfaces/PrivacySummary.html +4 -4
- package/docs/interfaces/RetentionInfo.html +4 -4
- package/docs/interfaces/RiskIndicators.html +8 -8
- package/docs/interfaces/ScoreContribution.html +3 -3
- package/docs/interfaces/ScoreCoverage.html +70 -0
- package/docs/interfaces/SudoPrivacyInteractionClient.html +67 -20
- package/docs/interfaces/VirtualPresence.html +21 -12
- package/docs/modules.html +4 -4
- package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
- package/lib/gen/graphqlTypes.js +1726 -771
- package/lib/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
- package/lib/private/data/common/apiClient.js +24 -1
- package/lib/private/data/data-holder/defaultDataHolderService.js +12 -0
- package/lib/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +52 -0
- package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +27 -0
- package/lib/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +25 -0
- package/lib/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +41 -0
- package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
- package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +21 -0
- package/lib/private/domain/entities/organization-analysis/organizationAnalysisService.js +6 -0
- package/lib/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +25 -0
- package/lib/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +21 -0
- package/lib/public/defaultSudoPrivacyInteractionClient.js +75 -6
- package/lib/public/inputs/index.js +1 -0
- package/lib/public/inputs/organizationAnalysis.js +6 -0
- package/lib/public/typings/index.js +1 -0
- package/lib/public/typings/organizationAnalysis.js +21 -0
- package/package.json +4 -2
- package/types/gen/graphqlTypes.d.ts +324 -0
- package/types/private/data/common/apiClient.d.ts +10 -1
- package/types/private/data/common/baseSubscriptionManager.d.ts +5 -0
- package/types/private/data/data-holder/defaultDataHolderService.d.ts +3 -1
- package/types/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.d.ts +18 -0
- package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +15 -0
- package/types/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.d.ts +12 -0
- package/types/private/data/organization-analysis/transformer/organizationAnalysisTransformer.d.ts +14 -0
- package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +14 -0
- package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +34 -0
- package/types/private/domain/entities/data-holder/dataHolderService.d.ts +35 -1
- package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +53 -0
- package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +35 -0
- package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +3 -0
- package/types/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.d.ts +36 -0
- package/types/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.d.ts +16 -0
- package/types/public/defaultSudoPrivacyInteractionClient.d.ts +9 -3
- package/types/public/inputs/dataHolder.d.ts +22 -0
- package/types/public/inputs/index.d.ts +1 -0
- package/types/public/inputs/organizationAnalysis.d.ts +18 -0
- package/types/public/sudoPrivacyInteractionClient.d.ts +25 -3
- package/types/public/typings/analysisResult.d.ts +14 -0
- package/types/public/typings/dataHolder.d.ts +38 -0
- package/types/public/typings/index.d.ts +1 -0
- package/types/public/typings/organizationAnalysis.d.ts +53 -0
- package/types/public/typings/virtualPresence.d.ts +3 -0
|
@@ -0,0 +1,158 @@
|
|
|
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>DataHolderScanSummary | @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">DataHolderScanSummary</a></li></ul>
|
|
12
|
+
<h1>Interface DataHolderScanSummary</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>The Sudo Platform SDK representation of email interaction metrics captured
|
|
15
|
+
during a single scan for a specific data holder.</p>
|
|
16
|
+
<p>DataHolderScanSummary</p>
|
|
17
|
+
</div></section>
|
|
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
|
+
<ul>
|
|
20
|
+
<li>Defined in src/public/typings/dataHolder.ts:78</li></ul></aside>
|
|
21
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
22
|
+
<section class="tsd-panel tsd-index-panel">
|
|
23
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
24
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
25
|
+
<div class="tsd-accordion-details">
|
|
26
|
+
<section class="tsd-index-section">
|
|
27
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
28
|
+
<div class="tsd-index-list"><a href="#categorybreakdown" 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<wbr/>Breakdown</span></a>
|
|
29
|
+
<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>
|
|
30
|
+
<a href="#emailcount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>email<wbr/>Count</span></a>
|
|
31
|
+
<a href="#marketingemailcount" 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>marketing<wbr/>Email<wbr/>Count</span></a>
|
|
32
|
+
<a href="#marketingemailopened" 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>marketing<wbr/>Email<wbr/>Opened</span></a>
|
|
33
|
+
<a href="#marketingopenrate" 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>marketing<wbr/>Open<wbr/>Rate</span></a>
|
|
34
|
+
<a href="#owner" 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>owner</span></a>
|
|
35
|
+
<a href="#readcount" 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>read<wbr/>Count</span></a>
|
|
36
|
+
<a href="#readrate" 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>read<wbr/>Rate</span></a>
|
|
37
|
+
<a href="#scannedat" 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>scanned<wbr/>At</span></a>
|
|
38
|
+
<a href="#scanrangefrom" 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>scan<wbr/>Range<wbr/>From</span></a>
|
|
39
|
+
<a href="#scanrangeto" 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>scan<wbr/>Range<wbr/>To</span></a>
|
|
40
|
+
<a href="#uncategorizedcount" 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>uncategorized<wbr/>Count</span></a>
|
|
41
|
+
</div></section></div></details></section></section>
|
|
42
|
+
<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>
|
|
43
|
+
<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>
|
|
44
|
+
<section>
|
|
45
|
+
<section class="tsd-panel tsd-member">
|
|
46
|
+
<h3 class="tsd-anchor-link" id="categorybreakdown"><span>category<wbr/>Breakdown</span><a href="#categorybreakdown" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
47
|
+
<div class="tsd-signature"><span class="tsd-kind-property">categoryBreakdown</span><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></div>
|
|
48
|
+
<div class="tsd-comment tsd-typography"><p>Count of emails per category.</p>
|
|
49
|
+
</div><aside class="tsd-sources">
|
|
50
|
+
<ul>
|
|
51
|
+
<li>Defined in src/public/typings/dataHolder.ts:90</li></ul></aside></section>
|
|
52
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>The data holder these metrics apply to.</p>
|
|
56
|
+
</div><aside class="tsd-sources">
|
|
57
|
+
<ul>
|
|
58
|
+
<li>Defined in src/public/typings/dataHolder.ts:79</li></ul></aside></section>
|
|
59
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Total number of emails observed in the scan range.</p>
|
|
63
|
+
</div><aside class="tsd-sources">
|
|
64
|
+
<ul>
|
|
65
|
+
<li>Defined in src/public/typings/dataHolder.ts:84</li></ul></aside></section>
|
|
66
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Number of marketing emails observed.</p>
|
|
70
|
+
</div><aside class="tsd-sources">
|
|
71
|
+
<ul>
|
|
72
|
+
<li>Defined in src/public/typings/dataHolder.ts:87</li></ul></aside></section>
|
|
73
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Number of marketing emails that were opened.</p>
|
|
77
|
+
</div><aside class="tsd-sources">
|
|
78
|
+
<ul>
|
|
79
|
+
<li>Defined in src/public/typings/dataHolder.ts:88</li></ul></aside></section>
|
|
80
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Ratio of opened marketing emails to marketing emails.</p>
|
|
84
|
+
</div><aside class="tsd-sources">
|
|
85
|
+
<ul>
|
|
86
|
+
<li>Defined in src/public/typings/dataHolder.ts:89</li></ul></aside></section>
|
|
87
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Unique identifier of the user.</p>
|
|
91
|
+
</div><aside class="tsd-sources">
|
|
92
|
+
<ul>
|
|
93
|
+
<li>Defined in src/public/typings/dataHolder.ts:80</li></ul></aside></section>
|
|
94
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Number of emails that were read.</p>
|
|
98
|
+
</div><aside class="tsd-sources">
|
|
99
|
+
<ul>
|
|
100
|
+
<li>Defined in src/public/typings/dataHolder.ts:85</li></ul></aside></section>
|
|
101
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Ratio of read emails to total emails.</p>
|
|
105
|
+
</div><aside class="tsd-sources">
|
|
106
|
+
<ul>
|
|
107
|
+
<li>Defined in src/public/typings/dataHolder.ts:86</li></ul></aside></section>
|
|
108
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Date for when the scan was performed.</p>
|
|
112
|
+
</div><aside class="tsd-sources">
|
|
113
|
+
<ul>
|
|
114
|
+
<li>Defined in src/public/typings/dataHolder.ts:81</li></ul></aside></section>
|
|
115
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Start of the scanned time range.</p>
|
|
119
|
+
</div><aside class="tsd-sources">
|
|
120
|
+
<ul>
|
|
121
|
+
<li>Defined in src/public/typings/dataHolder.ts:82</li></ul></aside></section>
|
|
122
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>End of the scanned time range.</p>
|
|
126
|
+
</div><aside class="tsd-sources">
|
|
127
|
+
<ul>
|
|
128
|
+
<li>Defined in src/public/typings/dataHolder.ts:83</li></ul></aside></section>
|
|
129
|
+
<section class="tsd-panel tsd-member">
|
|
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
|
+
<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
|
+
<div class="tsd-comment tsd-typography"><p>Number of emails that could not be categorized.</p>
|
|
133
|
+
</div><aside class="tsd-sources">
|
|
134
|
+
<ul>
|
|
135
|
+
<li>Defined in src/public/typings/dataHolder.ts:91</li></ul></aside></section></section></details></div>
|
|
136
|
+
<div class="col-sidebar">
|
|
137
|
+
<div class="page-menu">
|
|
138
|
+
<div class="tsd-navigation settings">
|
|
139
|
+
<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>
|
|
140
|
+
<h3>Settings</h3></summary>
|
|
141
|
+
<div class="tsd-accordion-details">
|
|
142
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
143
|
+
<ul id="tsd-filter-options">
|
|
144
|
+
<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>
|
|
145
|
+
<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>
|
|
146
|
+
<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>
|
|
147
|
+
<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>
|
|
148
|
+
<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>
|
|
149
|
+
<h3>On This Page</h3></summary>
|
|
150
|
+
<div class="tsd-accordion-details">
|
|
151
|
+
<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>
|
|
152
|
+
<div><a href="#categorybreakdown"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>category<wbr/>Breakdown</span></a><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="#emailcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>email<wbr/>Count</span></a><a href="#marketingemailcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>marketing<wbr/>Email<wbr/>Count</span></a><a href="#marketingemailopened"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>marketing<wbr/>Email<wbr/>Opened</span></a><a href="#marketingopenrate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>marketing<wbr/>Open<wbr/>Rate</span></a><a href="#owner"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>owner</span></a><a href="#readcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>read<wbr/>Count</span></a><a href="#readrate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>read<wbr/>Rate</span></a><a href="#scannedat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scanned<wbr/>At</span></a><a href="#scanrangefrom"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scan<wbr/>Range<wbr/>From</span></a><a href="#scanrangeto"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scan<wbr/>Range<wbr/>To</span></a><a href="#uncategorizedcount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uncategorized<wbr/>Count</span></a></div></details></div></details></div>
|
|
153
|
+
<div class="site-menu">
|
|
154
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
155
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
156
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
157
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
158
|
+
<div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,63 @@
|
|
|
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>GetDataHolderOptions | @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">GetDataHolderOptions</a></li></ul>
|
|
12
|
+
<h1>Interface GetDataHolderOptions</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Options to control what <code>getDataHolder</code> returns.</p>
|
|
15
|
+
<p>GetDataHolderOptions</p>
|
|
16
|
+
</div></section>
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">GetDataHolderOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#includescansummary">includeScanSummary</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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/dataHolder.ts:41</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="#includescansummary" 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>include<wbr/>Scan<wbr/>Summary?</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="includescansummary"><code class="tsd-tag">Optional</code><span>include<wbr/>Scan<wbr/>Summary</span><a href="#includescansummary" 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">includeScanSummary</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
35
|
+
<div class="tsd-comment tsd-typography"><p>Whether to also fetch and attach the most recent
|
|
36
|
+
scan summary to the returned data holder. Defaults to <code>true</code>. When <code>true</code>, the data holder
|
|
37
|
+
and its latest scan summary are fetched concurrently.</p>
|
|
38
|
+
</div><aside class="tsd-sources">
|
|
39
|
+
<ul>
|
|
40
|
+
<li>Defined in src/public/inputs/dataHolder.ts:42</li></ul></aside></section></section></details></div>
|
|
41
|
+
<div class="col-sidebar">
|
|
42
|
+
<div class="page-menu">
|
|
43
|
+
<div class="tsd-navigation settings">
|
|
44
|
+
<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>
|
|
45
|
+
<h3>Settings</h3></summary>
|
|
46
|
+
<div class="tsd-accordion-details">
|
|
47
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
48
|
+
<ul id="tsd-filter-options">
|
|
49
|
+
<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>
|
|
50
|
+
<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>
|
|
51
|
+
<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>
|
|
52
|
+
<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>
|
|
53
|
+
<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>
|
|
54
|
+
<h3>On This Page</h3></summary>
|
|
55
|
+
<div class="tsd-accordion-details">
|
|
56
|
+
<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>
|
|
57
|
+
<div><a href="#includescansummary"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>include<wbr/>Scan<wbr/>Summary</span></a></div></details></div></details></div>
|
|
58
|
+
<div class="site-menu">
|
|
59
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
60
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
61
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
62
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
63
|
+
<div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,70 @@
|
|
|
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>GetOrganizationAnalysisInput | @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">GetOrganizationAnalysisInput</a></li></ul>
|
|
12
|
+
<h1>Interface GetOrganizationAnalysisInput</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Properties required to obtain an organization analysis.</p>
|
|
15
|
+
<p>GetOrganizationAnalysisInput</p>
|
|
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">
|
|
18
|
+
<ul>
|
|
19
|
+
<li>Defined in src/public/inputs/organizationAnalysis.ts:17</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="#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
|
+
<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
|
+
</div></section></div></details></section></section>
|
|
30
|
+
<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
|
+
<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>
|
|
32
|
+
<section>
|
|
33
|
+
<section class="tsd-panel tsd-member">
|
|
34
|
+
<h3 class="tsd-anchor-link" id="domain"><span>domain</span><a href="#domain" 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>
|
|
35
|
+
<div class="tsd-signature"><span class="tsd-kind-property">domain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
36
|
+
<div class="tsd-comment tsd-typography"><p>The domain to analyze.</p>
|
|
37
|
+
</div><aside class="tsd-sources">
|
|
38
|
+
<ul>
|
|
39
|
+
<li>Defined in src/public/inputs/organizationAnalysis.ts:18</li></ul></aside></section>
|
|
40
|
+
<section class="tsd-panel tsd-member">
|
|
41
|
+
<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
|
+
<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>
|
|
43
|
+
<div class="tsd-comment tsd-typography"><p>How to obtain source results. When omitted, the
|
|
44
|
+
backend behaves as <code>Analyze</code> (read-through).</p>
|
|
45
|
+
</div><aside class="tsd-sources">
|
|
46
|
+
<ul>
|
|
47
|
+
<li>Defined in src/public/inputs/organizationAnalysis.ts:19</li></ul></aside></section></section></details></div>
|
|
48
|
+
<div class="col-sidebar">
|
|
49
|
+
<div class="page-menu">
|
|
50
|
+
<div class="tsd-navigation settings">
|
|
51
|
+
<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>
|
|
52
|
+
<h3>Settings</h3></summary>
|
|
53
|
+
<div class="tsd-accordion-details">
|
|
54
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
55
|
+
<ul id="tsd-filter-options">
|
|
56
|
+
<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>
|
|
57
|
+
<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>
|
|
58
|
+
<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>
|
|
59
|
+
<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>
|
|
60
|
+
<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>
|
|
61
|
+
<h3>On This Page</h3></summary>
|
|
62
|
+
<div class="tsd-accordion-details">
|
|
63
|
+
<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>
|
|
65
|
+
<div class="site-menu">
|
|
66
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
67
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
68
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
69
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
70
|
+
<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="173">
|
|
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,85 @@
|
|
|
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>ListDataHolderScanSummariesInput | @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">ListDataHolderScanSummariesInput</a></li></ul>
|
|
12
|
+
<h1>Interface ListDataHolderScanSummariesInput</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>Properties required to list scan summaries for a data holder.</p>
|
|
15
|
+
<p>ListDataHolderScanSummariesInput</p>
|
|
16
|
+
</div></section>
|
|
17
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListDataHolderScanSummariesInput</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="#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/><span class="tsd-signature-symbol">}</span></div>
|
|
18
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="184">
|
|
19
|
+
<h4>Hierarchy (<a href="../hierarchy.html#ListDataHolderScanSummariesInput">View Summary</a>)</h4>
|
|
20
|
+
<ul class="tsd-hierarchy">
|
|
21
|
+
<li class="tsd-hierarchy-item"><a href="Pagination.html" class="tsd-signature-type tsd-kind-interface">Pagination</a>
|
|
22
|
+
<ul class="tsd-hierarchy">
|
|
23
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ListDataHolderScanSummariesInput</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
24
|
+
<ul>
|
|
25
|
+
<li>Defined in src/public/inputs/dataHolder.ts:29</li></ul></aside>
|
|
26
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
27
|
+
<section class="tsd-panel tsd-index-panel">
|
|
28
|
+
<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>
|
|
29
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
30
|
+
<div class="tsd-accordion-details">
|
|
31
|
+
<section class="tsd-index-section">
|
|
32
|
+
<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>
|
|
33
|
+
<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>
|
|
34
|
+
<a href="#limit" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>limit?</span></a>
|
|
35
|
+
<a href="#nexttoken" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next<wbr/>Token?</span></a>
|
|
36
|
+
</div></section></div></details></section></section>
|
|
37
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
38
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
39
|
+
<section>
|
|
40
|
+
<section class="tsd-panel tsd-member">
|
|
41
|
+
<h3 class="tsd-anchor-link" id="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>
|
|
42
|
+
<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>
|
|
43
|
+
<div class="tsd-comment tsd-typography"><p>The identifier of the data holder to list scan summaries for.</p>
|
|
44
|
+
</div><aside class="tsd-sources">
|
|
45
|
+
<ul>
|
|
46
|
+
<li>Defined in src/public/inputs/dataHolder.ts:30</li></ul></aside></section>
|
|
47
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
48
|
+
<h3 class="tsd-anchor-link" id="limit"><code class="tsd-tag">Optional</code><span>limit</span><a href="#limit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
49
|
+
<div class="tsd-signature"><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
50
|
+
<div class="tsd-comment tsd-typography"><p>Number of items to return.</p>
|
|
51
|
+
</div><aside class="tsd-sources">
|
|
52
|
+
<p>Inherited from <a href="Pagination.html">Pagination</a>.<a href="Pagination.html#limit">limit</a></p>
|
|
53
|
+
<ul>
|
|
54
|
+
<li>Defined in src/public/inputs/common.ts:15</li></ul></aside></section>
|
|
55
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
56
|
+
<h3 class="tsd-anchor-link" id="nexttoken"><code class="tsd-tag">Optional</code><span>next<wbr/>Token</span><a href="#nexttoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
57
|
+
<div class="tsd-signature"><span class="tsd-kind-property">nextToken</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
58
|
+
<div class="tsd-comment tsd-typography"><p>A token generated by a previous call.</p>
|
|
59
|
+
</div><aside class="tsd-sources">
|
|
60
|
+
<p>Inherited from <a href="Pagination.html">Pagination</a>.<a href="Pagination.html#nexttoken">nextToken</a></p>
|
|
61
|
+
<ul>
|
|
62
|
+
<li>Defined in src/public/inputs/common.ts:16</li></ul></aside></section></section></details></div>
|
|
63
|
+
<div class="col-sidebar">
|
|
64
|
+
<div class="page-menu">
|
|
65
|
+
<div class="tsd-navigation settings">
|
|
66
|
+
<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>
|
|
67
|
+
<h3>Settings</h3></summary>
|
|
68
|
+
<div class="tsd-accordion-details">
|
|
69
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
70
|
+
<ul id="tsd-filter-options">
|
|
71
|
+
<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>
|
|
72
|
+
<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>
|
|
73
|
+
<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>
|
|
74
|
+
<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>
|
|
75
|
+
<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>
|
|
76
|
+
<h3>On This Page</h3></summary>
|
|
77
|
+
<div class="tsd-accordion-details">
|
|
78
|
+
<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>
|
|
79
|
+
<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="#limit" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>limit</span></a><a href="#nexttoken" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next<wbr/>Token</span></a></div></details></div></details></div>
|
|
80
|
+
<div class="site-menu">
|
|
81
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
82
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
83
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
84
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
85
|
+
<div class="overlay"></div></body></html>
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<p>ListDataHoldersInput</p>
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListDataHoldersInput</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="180">
|
|
19
19
|
<h4>Hierarchy (<a href="../hierarchy.html#ListDataHoldersInput">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>
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<p>ListVirtualPresencesInput</p>
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ListVirtualPresencesInput</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/><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="206">
|
|
19
19
|
<h4>Hierarchy (<a href="../hierarchy.html#ListVirtualPresencesInput">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>
|