@coveo/push-api-client 2.5.25 → 2.5.26
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/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
- package/dist/docs/classes/CatalogSource.html +16 -16
- package/dist/docs/classes/DocumentBuilder.html +28 -28
- package/dist/docs/classes/FieldAnalyser.html +12 -12
- package/dist/docs/classes/GroupSecurityIdentityBuilder.html +5 -5
- package/dist/docs/classes/PushSource.html +24 -24
- package/dist/docs/classes/UserSecurityIdentityBuilder.html +5 -5
- package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +5 -5
- package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
- package/dist/docs/classes/errors.InvalidDocument.html +3 -3
- package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
- package/dist/docs/classes/errors.NotAFileError.html +3 -3
- package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
- package/dist/docs/classes/errors.PrivilegeError.html +4 -4
- package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
- package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
- package/dist/docs/enums/PlatformEnvironment.html +5 -5
- package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
- package/dist/docs/interfaces/BatchUpdateDocuments.html +3 -3
- package/dist/docs/interfaces/Document.html +14 -14
- package/dist/docs/interfaces/SecurityIdentity.html +4 -4
- package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
- package/dist/docs/interfaces/UploadBatchCallbackData.html +4 -4
- package/dist/docs/modules/errors.html +1 -1
- package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
- package/dist/docs/types/CompressionType.html +1 -1
- package/dist/docs/types/FailedUploadCallback.html +1 -1
- package/dist/docs/types/Metadata.html +1 -1
- package/dist/docs/types/MetadataValue.html +1 -1
- package/dist/docs/types/PlatformUrlOptions.html +1 -1
- package/dist/docs/types/SecurityIdentityType.html +1 -1
- package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
- package/dist/docs/types/Transformer.html +1 -1
- package/dist/docs/variables/BuiltInTransformers.html +1 -1
- package/dist/docs/variables/Source.html +1 -1
- package/package.json +1 -1
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
<ul class="tsd-hierarchy">
|
|
24
24
|
<li><span class="target">FieldAnalyser</span></li></ul></section><aside class="tsd-sources">
|
|
25
25
|
<ul>
|
|
26
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
26
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L18">src/fieldAnalyser/fieldAnalyser.ts:18</a></li></ul></aside>
|
|
27
27
|
<section class="tsd-panel-group tsd-index-group">
|
|
28
28
|
<section class="tsd-panel tsd-index-panel">
|
|
29
29
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -63,29 +63,29 @@
|
|
|
63
63
|
<h5>platformClient: <span class="tsd-signature-type">PlatformClient</span></h5></li></ul></div>
|
|
64
64
|
<h4 class="tsd-returns-title">Returns <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h4><aside class="tsd-sources">
|
|
65
65
|
<ul>
|
|
66
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
66
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></li></ul></section></section>
|
|
67
67
|
<section class="tsd-panel-group tsd-member-group">
|
|
68
68
|
<h2>Properties</h2>
|
|
69
69
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="existingFields" class="tsd-anchor"></a>
|
|
70
70
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>existing<wbr/>Fields</span><a href="#existingFields" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
71
71
|
<div class="tsd-signature">existing<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
72
72
|
<ul>
|
|
73
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
73
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L21">src/fieldAnalyser/fieldAnalyser.ts:21</a></li></ul></aside></section>
|
|
74
74
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="inconsistencies" class="tsd-anchor"></a>
|
|
75
75
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>inconsistencies</span><a href="#inconsistencies" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
76
76
|
<div class="tsd-signature">inconsistencies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Inconsistencies</span></div><aside class="tsd-sources">
|
|
77
77
|
<ul>
|
|
78
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
78
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L19">src/fieldAnalyser/fieldAnalyser.ts:19</a></li></ul></aside></section>
|
|
79
79
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="missingFields" class="tsd-anchor"></a>
|
|
80
80
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>missing<wbr/>Fields</span><a href="#missingFields" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
81
81
|
<div class="tsd-signature">missing<wbr/>Fields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FieldStore</span></div><aside class="tsd-sources">
|
|
82
82
|
<ul>
|
|
83
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
83
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L20">src/fieldAnalyser/fieldAnalyser.ts:20</a></li></ul></aside></section>
|
|
84
84
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="platformClient" class="tsd-anchor"></a>
|
|
85
85
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>platform<wbr/>Client</span><a href="#platformClient" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
86
86
|
<div class="tsd-signature">platform<wbr/>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PlatformClient</span></div><aside class="tsd-sources">
|
|
87
87
|
<ul>
|
|
88
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
88
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L23">src/fieldAnalyser/fieldAnalyser.ts:23</a></li></ul></aside></section></section>
|
|
89
89
|
<section class="tsd-panel-group tsd-member-group">
|
|
90
90
|
<h2>Methods</h2>
|
|
91
91
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="add" class="tsd-anchor"></a>
|
|
@@ -104,7 +104,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
|
104
104
|
<h5>batch: <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
105
105
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
106
106
|
<ul>
|
|
107
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
107
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L35">src/fieldAnalyser/fieldAnalyser.ts:35</a></li></ul></aside></li></ul></section>
|
|
108
108
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensureExistingFields" class="tsd-anchor"></a>
|
|
109
109
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ensure<wbr/>Existing<wbr/>Fields</span><a href="#ensureExistingFields" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
110
110
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -112,7 +112,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
|
112
112
|
<li class="tsd-description">
|
|
113
113
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">FieldModel</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
114
114
|
<ul>
|
|
115
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
115
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L96">src/fieldAnalyser/fieldAnalyser.ts:96</a></li></ul></aside></li></ul></section>
|
|
116
116
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="ensurePermanentId" class="tsd-anchor"></a>
|
|
117
117
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ensure<wbr/>Permanent<wbr/>Id</span><a href="#ensurePermanentId" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
118
118
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -125,7 +125,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
|
125
125
|
<h5>fieldStore: <span class="tsd-signature-type">FieldStore</span></h5></li></ul></div>
|
|
126
126
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
127
127
|
<ul>
|
|
128
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
128
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L103">src/fieldAnalyser/fieldAnalyser.ts:103</a></li></ul></aside></li></ul></section>
|
|
129
129
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="removeInconsistentFields" class="tsd-anchor"></a>
|
|
130
130
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>remove<wbr/>Inconsistent<wbr/>Fields</span><a href="#removeInconsistentFields" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
131
131
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -133,7 +133,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
|
133
133
|
<li class="tsd-description">
|
|
134
134
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
135
135
|
<ul>
|
|
136
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
136
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L66">src/fieldAnalyser/fieldAnalyser.ts:66</a></li></ul></aside></li></ul></section>
|
|
137
137
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="report" class="tsd-anchor"></a>
|
|
138
138
|
<h3 class="tsd-anchor-link"><span>report</span><a href="#report" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
139
139
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -145,7 +145,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
|
145
145
|
</div>
|
|
146
146
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FieldAnalyserReport</span></h4><aside class="tsd-sources">
|
|
147
147
|
<ul>
|
|
148
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
148
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L56">src/fieldAnalyser/fieldAnalyser.ts:56</a></li></ul></aside></li></ul></section>
|
|
149
149
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="storeMetadata" class="tsd-anchor"></a>
|
|
150
150
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>store<wbr/>Metadata</span><a href="#storeMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
151
151
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -160,7 +160,7 @@ This method can be called as many time as needed as it will take into considerat
|
|
|
160
160
|
<h5>metadataValue: <a href="../types/MetadataValue.html" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a></h5></li></ul></div>
|
|
161
161
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
162
162
|
<ul>
|
|
163
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
163
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/fieldAnalyser/fieldAnalyser.ts#L72">src/fieldAnalyser/fieldAnalyser.ts:72</a></li></ul></aside></li></ul></section></section></div>
|
|
164
164
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
165
165
|
<div class="tsd-navigation settings">
|
|
166
166
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
<ul class="tsd-hierarchy">
|
|
30
30
|
<li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
|
|
31
31
|
<ul>
|
|
32
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
32
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L90">src/securityIdentityBuilder.ts:90</a></li></ul></aside>
|
|
33
33
|
<section class="tsd-panel-group tsd-index-group">
|
|
34
34
|
<section class="tsd-panel tsd-index-panel">
|
|
35
35
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -66,19 +66,19 @@
|
|
|
66
66
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
67
67
|
<h4 class="tsd-returns-title">Returns <a href="GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
|
|
68
68
|
<ul>
|
|
69
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
69
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L96">src/securityIdentityBuilder.ts:96</a></li></ul></aside></li></ul></section></section>
|
|
70
70
|
<section class="tsd-panel-group tsd-member-group">
|
|
71
71
|
<h2>Properties</h2>
|
|
72
72
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="group" class="tsd-anchor"></a>
|
|
73
73
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>group</span><a href="#group" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
74
74
|
<div class="tsd-signature">group<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
75
75
|
<ul>
|
|
76
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
76
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L97">src/securityIdentityBuilder.ts:97</a></li></ul></aside></section>
|
|
77
77
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityProvider" class="tsd-anchor"></a>
|
|
78
78
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>security<wbr/>Provider</span><a href="#securityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
79
79
|
<div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
80
80
|
<ul>
|
|
81
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
81
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L98">src/securityIdentityBuilder.ts:98</a></li></ul></aside></section></section>
|
|
82
82
|
<section class="tsd-panel-group tsd-member-group">
|
|
83
83
|
<h2>Methods</h2>
|
|
84
84
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
|
@@ -92,7 +92,7 @@
|
|
|
92
92
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
93
93
|
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
|
|
94
94
|
<ul>
|
|
95
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
95
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L105">src/securityIdentityBuilder.ts:105</a></li></ul></aside></li></ul></section></section></div>
|
|
96
96
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
97
97
|
<div class="tsd-navigation settings">
|
|
98
98
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
<ul class="tsd-hierarchy">
|
|
25
25
|
<li><span class="target">PushSource</span></li></ul></section><aside class="tsd-sources">
|
|
26
26
|
<ul>
|
|
27
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
27
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L49">src/source/push.ts:49</a></li></ul></aside>
|
|
28
28
|
<section class="tsd-panel-group tsd-index-group">
|
|
29
29
|
<section class="tsd-panel tsd-index-panel">
|
|
30
30
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -87,7 +87,7 @@
|
|
|
87
87
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a></h5></li></ul></div>
|
|
88
88
|
<h4 class="tsd-returns-title">Returns <a href="PushSource.html" class="tsd-signature-type" data-tsd-kind="Class">PushSource</a></h4><aside class="tsd-sources">
|
|
89
89
|
<ul>
|
|
90
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
90
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L61">src/source/push.ts:61</a></li></ul></aside></li></ul></section></section>
|
|
91
91
|
<section class="tsd-panel-group tsd-member-group">
|
|
92
92
|
<h2>Properties</h2>
|
|
93
93
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="apikey" class="tsd-anchor"></a>
|
|
@@ -96,29 +96,29 @@
|
|
|
96
96
|
<div class="tsd-comment tsd-typography"><p>An apiKey capable of pushing documents and managing sources in a Coveo organization. See <a href="https://docs.coveo.com/en/1718">Manage API Keys</a>.</p>
|
|
97
97
|
</div><aside class="tsd-sources">
|
|
98
98
|
<ul>
|
|
99
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
99
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L62">src/source/push.ts:62</a></li></ul></aside></section>
|
|
100
100
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="options" class="tsd-anchor"></a>
|
|
101
101
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
102
102
|
<div class="tsd-signature">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources">
|
|
103
103
|
<ul>
|
|
104
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
104
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L51">src/source/push.ts:51</a></li></ul></aside></section>
|
|
105
105
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="organizationid" class="tsd-anchor"></a>
|
|
106
106
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>organizationid</span><a href="#organizationid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
107
107
|
<div class="tsd-signature">organizationid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
108
108
|
<div class="tsd-comment tsd-typography"><p>The Coveo Organization identifier.</p>
|
|
109
109
|
</div><aside class="tsd-sources">
|
|
110
110
|
<ul>
|
|
111
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
111
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L63">src/source/push.ts:63</a></li></ul></aside></section>
|
|
112
112
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="platformClient" class="tsd-anchor"></a>
|
|
113
113
|
<h3 class="tsd-anchor-link"><span>platform<wbr/>Client</span><a href="#platformClient" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
114
114
|
<div class="tsd-signature">platform<wbr/>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PlatformClient</span></div><aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L50">src/source/push.ts:50</a></li></ul></aside></section>
|
|
117
117
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultOptions" class="tsd-anchor"></a>
|
|
118
118
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>default<wbr/>Options</span><a href="#defaultOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
119
119
|
<div class="tsd-signature">default<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="../types/PlatformUrlOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">PlatformUrlOptions</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
|
|
120
120
|
<ul>
|
|
121
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
121
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L52">src/source/push.ts:52</a></li></ul></aside></section></section>
|
|
122
122
|
<section class="tsd-panel-group tsd-member-group">
|
|
123
123
|
<h2>Accessors</h2>
|
|
124
124
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><a id="documentsAxiosConfig" class="tsd-anchor"></a>
|
|
@@ -128,7 +128,7 @@
|
|
|
128
128
|
<li class="tsd-description">
|
|
129
129
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
130
130
|
<ul>
|
|
131
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
131
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L279">src/source/push.ts:279</a></li></ul></aside></li></ul></section>
|
|
132
132
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="identity" class="tsd-anchor"></a>
|
|
133
133
|
<h3 class="tsd-anchor-link"><span>identity</span><a href="#identity" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
134
134
|
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
|
|
@@ -136,7 +136,7 @@
|
|
|
136
136
|
<li class="tsd-description">
|
|
137
137
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SecurityIdentity</span></h4><aside class="tsd-sources">
|
|
138
138
|
<ul>
|
|
139
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
139
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L165">src/source/push.ts:165</a></li></ul></aside></li></ul></section></section>
|
|
140
140
|
<section class="tsd-panel-group tsd-member-group">
|
|
141
141
|
<h2>Methods</h2>
|
|
142
142
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="addOrUpdateDocument" class="tsd-anchor"></a>
|
|
@@ -158,7 +158,7 @@
|
|
|
158
158
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
159
159
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
160
160
|
<ul>
|
|
161
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
161
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L176">src/source/push.ts:176</a></li></ul></aside></li></ul></section>
|
|
162
162
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocuments" class="tsd-anchor"></a>
|
|
163
163
|
<h3 class="tsd-anchor-link"><span>batch<wbr/>Update<wbr/>Documents</span><a href="#batchUpdateDocuments" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
164
164
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">BatchUpdateDocumentsOptions</span></h5></li></ul></div>
|
|
179
179
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
180
180
|
<ul>
|
|
181
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
181
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L197">src/source/push.ts:197</a></li></ul></aside></li></ul></section>
|
|
182
182
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="batchUpdateDocumentsFromFiles" class="tsd-anchor"></a>
|
|
183
183
|
<h3 class="tsd-anchor-link"><span>batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files</span><a href="#batchUpdateDocumentsFromFiles" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
184
184
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -201,7 +201,7 @@
|
|
|
201
201
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../types/BatchUpdateDocumentsFromFiles.html" class="tsd-signature-type" data-tsd-kind="Type alias">BatchUpdateDocumentsFromFiles</a></h5></li></ul></div>
|
|
202
202
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BatchUploadDocumentsFromFilesReturn</span></h4><aside class="tsd-sources">
|
|
203
203
|
<ul>
|
|
204
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
204
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L218">src/source/push.ts:218</a></li></ul></aside></li></ul></section>
|
|
205
205
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="create" class="tsd-anchor"></a>
|
|
206
206
|
<h3 class="tsd-anchor-link"><span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
207
207
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -223,7 +223,7 @@
|
|
|
223
223
|
</div></li></ul></div>
|
|
224
224
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>id<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><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
225
225
|
<ul>
|
|
226
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
226
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L81">src/source/push.ts:81</a></li></ul></aside></li></ul></section>
|
|
227
227
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createFields" class="tsd-anchor"></a>
|
|
228
228
|
<h3 class="tsd-anchor-link"><span>create<wbr/>Fields</span><a href="#createFields" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
229
229
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -236,7 +236,7 @@
|
|
|
236
236
|
<h5>analyser: <a href="FieldAnalyser.html" class="tsd-signature-type" data-tsd-kind="Class">FieldAnalyser</a></h5></li></ul></div>
|
|
237
237
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
238
238
|
<ul>
|
|
239
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
239
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L283">src/source/push.ts:283</a></li></ul></aside></li></ul></section>
|
|
240
240
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createOrUpdateSecurityIdentityAlias" class="tsd-anchor"></a>
|
|
241
241
|
<h3 class="tsd-anchor-link"><span>create<wbr/>Or<wbr/>Update<wbr/>Security<wbr/>Identity<wbr/>Alias</span><a href="#createOrUpdateSecurityIdentityAlias" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
242
242
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -255,7 +255,7 @@
|
|
|
255
255
|
<h5>securityIdentityAlias: <span class="tsd-signature-type">SecurityIdentityAliasModel</span></h5></li></ul></div>
|
|
256
256
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
257
257
|
<ul>
|
|
258
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
258
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L110">src/source/push.ts:110</a></li></ul></aside></li></ul></section>
|
|
259
259
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createSecurityIdentity" class="tsd-anchor"></a>
|
|
260
260
|
<h3 class="tsd-anchor-link"><span>create<wbr/>Security<wbr/>Identity</span><a href="#createSecurityIdentity" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
261
261
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -274,7 +274,7 @@
|
|
|
274
274
|
<h5>securityIdentity: <span class="tsd-signature-type">SecurityIdentityModel</span></h5></li></ul></div>
|
|
275
275
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
276
276
|
<ul>
|
|
277
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
277
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L95">src/source/push.ts:95</a></li></ul></aside></li></ul></section>
|
|
278
278
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocument" class="tsd-anchor"></a>
|
|
279
279
|
<h3 class="tsd-anchor-link"><span>delete<wbr/>Document</span><a href="#deleteDocument" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
280
280
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -294,7 +294,7 @@
|
|
|
294
294
|
<h5>deleteChildren: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
|
|
295
295
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
296
296
|
<ul>
|
|
297
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
297
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L238">src/source/push.ts:238</a></li></ul></aside></li></ul></section>
|
|
298
298
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDocumentsOlderThan" class="tsd-anchor"></a>
|
|
299
299
|
<h3 class="tsd-anchor-link"><span>delete<wbr/>Documents<wbr/>Older<wbr/>Than</span><a href="#deleteDocumentsOlderThan" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
300
300
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -312,7 +312,7 @@
|
|
|
312
312
|
<h5>olderThan: <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-type">Date</span></h5></li></ul></div>
|
|
313
313
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
314
314
|
<ul>
|
|
315
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
315
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L255">src/source/push.ts:255</a></li></ul></aside></li></ul></section>
|
|
316
316
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteOldSecurityIdentities" class="tsd-anchor"></a>
|
|
317
317
|
<h3 class="tsd-anchor-link"><span>delete<wbr/>Old<wbr/>Security<wbr/>Identities</span><a href="#deleteOldSecurityIdentities" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
318
318
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -331,7 +331,7 @@
|
|
|
331
331
|
<h5>batchDelete: <span class="tsd-signature-type">SecurityIdentityDeleteOptions</span></h5></li></ul></div>
|
|
332
332
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
333
333
|
<ul>
|
|
334
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
334
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L140">src/source/push.ts:140</a></li></ul></aside></li></ul></section>
|
|
335
335
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteSecurityIdentity" class="tsd-anchor"></a>
|
|
336
336
|
<h3 class="tsd-anchor-link"><span>delete<wbr/>Security<wbr/>Identity</span><a href="#deleteSecurityIdentity" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
337
337
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -350,7 +350,7 @@
|
|
|
350
350
|
<h5>securityIdentityToDelete: <span class="tsd-signature-type">SecurityIdentityDelete</span></h5></li></ul></div>
|
|
351
351
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
352
352
|
<ul>
|
|
353
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
353
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L125">src/source/push.ts:125</a></li></ul></aside></li></ul></section>
|
|
354
354
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="fileContainerStrategy" class="tsd-anchor"></a>
|
|
355
355
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>file<wbr/>Container<wbr/>Strategy</span><a href="#fileContainerStrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
356
356
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -363,7 +363,7 @@
|
|
|
363
363
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
364
364
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">UploadStrategy</span></h4><aside class="tsd-sources">
|
|
365
365
|
<ul>
|
|
366
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
366
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L292">src/source/push.ts:292</a></li></ul></aside></li></ul></section>
|
|
367
367
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="manageSecurityIdentities" class="tsd-anchor"></a>
|
|
368
368
|
<h3 class="tsd-anchor-link"><span>manage<wbr/>Security<wbr/>Identities</span><a href="#manageSecurityIdentities" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
369
369
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -382,7 +382,7 @@
|
|
|
382
382
|
<h5>batchConfig: <span class="tsd-signature-type">SecurityIdentityBatchConfig</span></h5></li></ul></div>
|
|
383
383
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
384
384
|
<ul>
|
|
385
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
385
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L155">src/source/push.ts:155</a></li></ul></aside></li></ul></section>
|
|
386
386
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setSourceStatus" class="tsd-anchor"></a>
|
|
387
387
|
<h3 class="tsd-anchor-link"><span>set<wbr/>Source<wbr/>Status</span><a href="#setSourceStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
388
388
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -400,7 +400,7 @@
|
|
|
400
400
|
<h5>status: <span class="tsd-signature-type">SourceStatus</span></h5></li></ul></div>
|
|
401
401
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
402
402
|
<ul>
|
|
403
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
403
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L273">src/source/push.ts:273</a></li></ul></aside></li></ul></section>
|
|
404
404
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="urlBuilder" class="tsd-anchor"></a>
|
|
405
405
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>url<wbr/>Builder</span><a href="#urlBuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
406
406
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -413,7 +413,7 @@
|
|
|
413
413
|
<h5>sourceId: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
414
414
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PushUrlBuilder</span></h4><aside class="tsd-sources">
|
|
415
415
|
<ul>
|
|
416
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
416
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/source/push.ts#L288">src/source/push.ts:288</a></li></ul></aside></li></ul></section></section></div>
|
|
417
417
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
418
418
|
<div class="tsd-navigation settings">
|
|
419
419
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
<ul class="tsd-hierarchy">
|
|
30
30
|
<li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
|
|
31
31
|
<ul>
|
|
32
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
32
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L54">src/securityIdentityBuilder.ts:54</a></li></ul></aside>
|
|
33
33
|
<section class="tsd-panel-group tsd-index-group">
|
|
34
34
|
<section class="tsd-panel tsd-index-panel">
|
|
35
35
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -66,19 +66,19 @@
|
|
|
66
66
|
<h5>securityProvider: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'Email Security Provider'</span></h5></li></ul></div>
|
|
67
67
|
<h4 class="tsd-returns-title">Returns <a href="UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
|
|
68
68
|
<ul>
|
|
69
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
69
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L60">src/securityIdentityBuilder.ts:60</a></li></ul></aside></li></ul></section></section>
|
|
70
70
|
<section class="tsd-panel-group tsd-member-group">
|
|
71
71
|
<h2>Properties</h2>
|
|
72
72
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityProvider" class="tsd-anchor"></a>
|
|
73
73
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>security<wbr/>Provider</span><a href="#securityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
74
74
|
<div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'Email Security Provider'</span></div><aside class="tsd-sources">
|
|
75
75
|
<ul>
|
|
76
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
76
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L62">src/securityIdentityBuilder.ts:62</a></li></ul></aside></section>
|
|
77
77
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="user" class="tsd-anchor"></a>
|
|
78
78
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>user</span><a href="#user" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
79
79
|
<div class="tsd-signature">user<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
80
80
|
<ul>
|
|
81
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
81
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L61">src/securityIdentityBuilder.ts:61</a></li></ul></aside></section></section>
|
|
82
82
|
<section class="tsd-panel-group tsd-member-group">
|
|
83
83
|
<h2>Methods</h2>
|
|
84
84
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
|
@@ -92,7 +92,7 @@
|
|
|
92
92
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
93
93
|
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
|
|
94
94
|
<ul>
|
|
95
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
95
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L69">src/securityIdentityBuilder.ts:69</a></li></ul></aside></li></ul></section></section></div>
|
|
96
96
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
97
97
|
<div class="tsd-navigation settings">
|
|
98
98
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
<ul class="tsd-hierarchy">
|
|
30
30
|
<li><a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></li></ul></section><aside class="tsd-sources">
|
|
31
31
|
<ul>
|
|
32
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
32
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L129">src/securityIdentityBuilder.ts:129</a></li></ul></aside>
|
|
33
33
|
<section class="tsd-panel-group tsd-index-group">
|
|
34
34
|
<section class="tsd-panel tsd-index-panel">
|
|
35
35
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -66,19 +66,19 @@
|
|
|
66
66
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> securityProvider: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
67
67
|
<h4 class="tsd-returns-title">Returns <a href="VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></h4><aside class="tsd-sources">
|
|
68
68
|
<ul>
|
|
69
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
69
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L137">src/securityIdentityBuilder.ts:137</a></li></ul></aside></li></ul></section></section>
|
|
70
70
|
<section class="tsd-panel-group tsd-member-group">
|
|
71
71
|
<h2>Properties</h2>
|
|
72
72
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="securityProvider" class="tsd-anchor"></a>
|
|
73
73
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>security<wbr/>Provider</span><a href="#securityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
74
74
|
<div class="tsd-signature">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
75
75
|
<ul>
|
|
76
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
76
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L139">src/securityIdentityBuilder.ts:139</a></li></ul></aside></section>
|
|
77
77
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="virtualGroup" class="tsd-anchor"></a>
|
|
78
78
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>virtual<wbr/>Group</span><a href="#virtualGroup" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
79
79
|
<div class="tsd-signature">virtual<wbr/>Group<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
|
|
80
80
|
<ul>
|
|
81
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
81
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L138">src/securityIdentityBuilder.ts:138</a></li></ul></aside></section></section>
|
|
82
82
|
<section class="tsd-panel-group tsd-member-group">
|
|
83
83
|
<h2>Methods</h2>
|
|
84
84
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
|
@@ -92,7 +92,7 @@
|
|
|
92
92
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
93
93
|
<p>Implementation of <a href="../interfaces/SecurityIdentityBuilder.html">SecurityIdentityBuilder</a>.<a href="../interfaces/SecurityIdentityBuilder.html#build">build</a></p>
|
|
94
94
|
<ul>
|
|
95
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
95
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/securityIdentityBuilder.ts#L146">src/securityIdentityBuilder.ts:146</a></li></ul></aside></li></ul></section></section></div>
|
|
96
96
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
97
97
|
<div class="tsd-navigation settings">
|
|
98
98
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
<ul class="tsd-hierarchy">
|
|
24
24
|
<li><span class="target">FieldTypeInconsistencyError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
25
25
|
<ul>
|
|
26
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
26
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/errors/fieldErrors.ts#L5">src/errors/fieldErrors.ts:5</a></li></ul></aside>
|
|
27
27
|
<section class="tsd-panel-group tsd-index-group">
|
|
28
28
|
<section class="tsd-panel tsd-index-panel">
|
|
29
29
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
<h4 class="tsd-returns-title">Returns <a href="errors.FieldTypeInconsistencyError.html" class="tsd-signature-type" data-tsd-kind="Class">FieldTypeInconsistencyError</a></h4><aside class="tsd-sources">
|
|
61
61
|
<p>Overrides PushApiClientBaseError.constructor</p>
|
|
62
62
|
<ul>
|
|
63
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
63
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/errors/fieldErrors.ts#L7">src/errors/fieldErrors.ts:7</a></li></ul></aside></li></ul></section></section>
|
|
64
64
|
<section class="tsd-panel-group tsd-member-group">
|
|
65
65
|
<h2>Properties</h2>
|
|
66
66
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="message" class="tsd-anchor"></a>
|
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
<div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'Field Type Inconsistency Error'</span></div><aside class="tsd-sources">
|
|
75
75
|
<p>Overrides PushApiClientBaseError.name</p>
|
|
76
76
|
<ul>
|
|
77
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
77
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/3bde5ff/src/errors/fieldErrors.ts#L6">src/errors/fieldErrors.ts:6</a></li></ul></aside></section>
|
|
78
78
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
|
|
79
79
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
80
80
|
<div class="tsd-signature">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|