@coveo/push-api-client 2.5.21 → 2.5.23
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/assets/search.js +1 -1
- package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
- package/dist/docs/classes/CatalogSource.html +31 -17
- package/dist/docs/classes/DocumentBuilder.html +40 -33
- package/dist/docs/classes/FieldAnalyser.html +18 -11
- package/dist/docs/classes/GroupSecurityIdentityBuilder.html +22 -3
- package/dist/docs/classes/PushSource.html +39 -25
- package/dist/docs/classes/UserSecurityIdentityBuilder.html +22 -3
- package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +22 -3
- 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 +4 -4
- package/dist/docs/interfaces/Document.html +16 -16
- 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 +2 -2
- 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 +2 -2
- package/dist/docs/variables/Source.html +1 -1
- package/package.json +6 -6
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
<ul class="tsd-hierarchy">
|
|
22
22
|
<li><span class="target">DocumentBuilder</span></li></ul></section><aside class="tsd-sources">
|
|
23
23
|
<ul>
|
|
24
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
24
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L14">src/documentBuilder.ts:14</a></li></ul></aside>
|
|
25
25
|
<section class="tsd-panel-group tsd-index-group">
|
|
26
26
|
<section class="tsd-panel tsd-index-panel">
|
|
27
27
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -34,6 +34,7 @@
|
|
|
34
34
|
<section class="tsd-index-section">
|
|
35
35
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
36
36
|
<div class="tsd-index-list"><a href="DocumentBuilder.html#doc" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>doc</span></a>
|
|
37
|
+
<a href="DocumentBuilder.html#uri" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>uri</span></a>
|
|
37
38
|
</div></section>
|
|
38
39
|
<section class="tsd-index-section">
|
|
39
40
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
@@ -82,14 +83,19 @@
|
|
|
82
83
|
</div></li></ul></div>
|
|
83
84
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
84
85
|
<ul>
|
|
85
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
86
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></li></ul></section></section>
|
|
86
87
|
<section class="tsd-panel-group tsd-member-group">
|
|
87
88
|
<h2>Properties</h2>
|
|
88
89
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="doc" class="tsd-anchor"></a>
|
|
89
90
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>doc</span><a href="#doc" 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>
|
|
90
91
|
<div class="tsd-signature">doc<span class="tsd-signature-symbol">:</span> <a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources">
|
|
91
92
|
<ul>
|
|
92
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
93
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L15">src/documentBuilder.ts:15</a></li></ul></aside></section>
|
|
94
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="uri" class="tsd-anchor"></a>
|
|
95
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>uri</span><a href="#uri" 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>
|
|
96
|
+
<div class="tsd-signature">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
97
|
+
<ul>
|
|
98
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L21">src/documentBuilder.ts:21</a></li></ul></aside></section></section>
|
|
93
99
|
<section class="tsd-panel-group tsd-member-group">
|
|
94
100
|
<h2>Methods</h2>
|
|
95
101
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="build" class="tsd-anchor"></a>
|
|
@@ -99,7 +105,7 @@
|
|
|
99
105
|
<li class="tsd-description">
|
|
100
106
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></h4><aside class="tsd-sources">
|
|
101
107
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
108
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L242">src/documentBuilder.ts:242</a></li></ul></aside></li></ul></section>
|
|
103
109
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="generatePermanentId" class="tsd-anchor"></a>
|
|
104
110
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>generate<wbr/>Permanent<wbr/>Id</span><a href="#generatePermanentId" 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>
|
|
105
111
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -107,26 +113,26 @@
|
|
|
107
113
|
<li class="tsd-description">
|
|
108
114
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
109
115
|
<ul>
|
|
110
|
-
<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/e2f617b/src/documentBuilder.ts#L309">src/documentBuilder.ts:309</a></li></ul></aside></li></ul></section>
|
|
111
117
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="marshal" class="tsd-anchor"></a>
|
|
112
118
|
<h3 class="tsd-anchor-link"><span>marshal</span><a href="#marshal" 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>
|
|
113
119
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
114
|
-
<li class="tsd-signature tsd-anchor-link" id="marshal.marshal-1">marshal<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span>deniedPermissions<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><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span>deniedPermissions<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><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><a href="#marshal.marshal-1" 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></li>
|
|
120
|
+
<li class="tsd-signature tsd-anchor-link" id="marshal.marshal-1">marshal<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span> </span>title<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><span class="tsd-signature-symbol">{ </span><br/><span> </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span>deniedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>title<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><span class="tsd-signature-symbol">{ </span><br/><span> </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span> </span>title<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><span class="tsd-signature-symbol">{ </span><br/><span> </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span>deniedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>title<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><a href="#marshal.marshal-1" 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></li>
|
|
115
121
|
<li class="tsd-description">
|
|
116
122
|
<div class="tsd-comment tsd-typography"><p>Marshal the document into a JSON format accepted by the push API.</p>
|
|
117
123
|
|
|
118
124
|
<h3>Returns</h3></div>
|
|
119
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span>deniedPermissions<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><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span>deniedPermissions<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><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h4><aside class="tsd-sources">
|
|
125
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span> </span>title<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><span class="tsd-signature-symbol">{ </span><br/><span> </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span>deniedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>title<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><span class="tsd-signature-symbol">{ </span><br/><span> </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span> </span>title<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><span class="tsd-signature-symbol">{ </span><br/><span> </span>author<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>clickableUri<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span> </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>date<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>fileExtension<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>modifiedDate<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>parentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permanentId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span>deniedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span>title<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></h4><aside class="tsd-sources">
|
|
120
126
|
<ul>
|
|
121
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
127
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L250">src/documentBuilder.ts:250</a></li></ul></aside></li></ul></section>
|
|
122
128
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalCompressedBinaryData" class="tsd-anchor"></a>
|
|
123
129
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>marshal<wbr/>Compressed<wbr/>Binary<wbr/>Data</span><a href="#marshalCompressedBinaryData" 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>
|
|
124
130
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
125
|
-
<li class="tsd-signature tsd-anchor-link" id="marshalCompressedBinaryData.marshalCompressedBinaryData-1">marshal<wbr/>Compressed<wbr/>Binary<wbr/>Data<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">
|
|
131
|
+
<li class="tsd-signature tsd-anchor-link" id="marshalCompressedBinaryData.marshalCompressedBinaryData-1">marshal<wbr/>Compressed<wbr/>Binary<wbr/>Data<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#marshalCompressedBinaryData.marshalCompressedBinaryData-1" 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></li>
|
|
126
132
|
<li class="tsd-description">
|
|
127
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">
|
|
133
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>compressedBinaryData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><aside class="tsd-sources">
|
|
128
134
|
<ul>
|
|
129
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
135
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L274">src/documentBuilder.ts:274</a></li></ul></aside></li></ul></section>
|
|
130
136
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalMetadata" class="tsd-anchor"></a>
|
|
131
137
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>marshal<wbr/>Metadata</span><a href="#marshalMetadata" 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>
|
|
132
138
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -134,15 +140,15 @@
|
|
|
134
140
|
<li class="tsd-description">
|
|
135
141
|
<h4 class="tsd-returns-title">Returns <a href="../types/Metadata.html" class="tsd-signature-type" data-tsd-kind="Type alias">Metadata</a></h4><aside class="tsd-sources">
|
|
136
142
|
<ul>
|
|
137
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
143
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L263">src/documentBuilder.ts:263</a></li></ul></aside></li></ul></section>
|
|
138
144
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="marshalPermissions" class="tsd-anchor"></a>
|
|
139
145
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>marshal<wbr/>Permissions</span><a href="#marshalPermissions" 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>
|
|
140
146
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
141
|
-
<li class="tsd-signature tsd-anchor-link" id="marshalPermissions.marshalPermissions-1">marshal<wbr/>Permissions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">
|
|
147
|
+
<li class="tsd-signature tsd-anchor-link" id="marshalPermissions.marshalPermissions-1">marshal<wbr/>Permissions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span>deniedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#marshalPermissions.marshalPermissions-1" 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></li>
|
|
142
148
|
<li class="tsd-description">
|
|
143
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">
|
|
149
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>permissions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span>allowedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span>deniedPermissions<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><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><aside class="tsd-sources">
|
|
144
150
|
<ul>
|
|
145
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
151
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L284">src/documentBuilder.ts:284</a></li></ul></aside></li></ul></section>
|
|
146
152
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="setPermission" class="tsd-anchor"></a>
|
|
147
153
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>set<wbr/>Permission</span><a href="#setPermission" 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>
|
|
148
154
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -157,7 +163,7 @@
|
|
|
157
163
|
<h5>permissionSection: <span class="tsd-signature-type">"allowedPermissions"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"deniedPermissions"</span></h5></li></ul></div>
|
|
158
164
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
159
165
|
<ul>
|
|
160
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
166
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L327">src/documentBuilder.ts:327</a></li></ul></aside></li></ul></section>
|
|
161
167
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateAndFillMissing" class="tsd-anchor"></a>
|
|
162
168
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>And<wbr/>Fill<wbr/>Missing</span><a href="#validateAndFillMissing" 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>
|
|
163
169
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -165,7 +171,7 @@
|
|
|
165
171
|
<li class="tsd-description">
|
|
166
172
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
167
173
|
<ul>
|
|
168
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
174
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L299">src/documentBuilder.ts:299</a></li></ul></aside></li></ul></section>
|
|
169
175
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateCompressedBinaryData" class="tsd-anchor"></a>
|
|
170
176
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Compressed<wbr/>Binary<wbr/>Data</span><a href="#validateCompressedBinaryData" 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>
|
|
171
177
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -178,7 +184,7 @@
|
|
|
178
184
|
<h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
179
185
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
180
186
|
<ul>
|
|
181
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
187
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L320">src/documentBuilder.ts:320</a></li></ul></aside></li></ul></section>
|
|
182
188
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="validateDateAndReturnValidDate" class="tsd-anchor"></a>
|
|
183
189
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>validate<wbr/>Date<wbr/>And<wbr/>Return<wbr/>Valid<wbr/>Date</span><a href="#validateDateAndReturnValidDate" 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
190
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
@@ -191,7 +197,7 @@
|
|
|
191
197
|
<h5>d: <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>
|
|
192
198
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
193
199
|
<ul>
|
|
194
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
200
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L315">src/documentBuilder.ts:315</a></li></ul></aside></li></ul></section>
|
|
195
201
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowAnonymousUsers" class="tsd-anchor"></a>
|
|
196
202
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Allow<wbr/>Anonymous<wbr/>Users</span><a href="#withAllowAnonymousUsers" 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>
|
|
197
203
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -207,7 +213,7 @@
|
|
|
207
213
|
<h5>allowAnonymous: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
|
|
208
214
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
209
215
|
<ul>
|
|
210
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
216
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L237">src/documentBuilder.ts:237</a></li></ul></aside></li></ul></section>
|
|
211
217
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAllowedPermissions" class="tsd-anchor"></a>
|
|
212
218
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Allowed<wbr/>Permissions</span><a href="#withAllowedPermissions" 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>
|
|
213
219
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -223,7 +229,7 @@
|
|
|
223
229
|
<h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
|
|
224
230
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
225
231
|
<ul>
|
|
226
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
232
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L213">src/documentBuilder.ts:213</a></li></ul></aside></li></ul></section>
|
|
227
233
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withAuthor" class="tsd-anchor"></a>
|
|
228
234
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Author</span><a href="#withAuthor" 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
235
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -239,7 +245,7 @@
|
|
|
239
245
|
<h5>author: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
240
246
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
241
247
|
<ul>
|
|
242
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
248
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L128">src/documentBuilder.ts:128</a></li></ul></aside></li></ul></section>
|
|
243
249
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withClickableUri" class="tsd-anchor"></a>
|
|
244
250
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Clickable<wbr/>Uri</span><a href="#withClickableUri" 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>
|
|
245
251
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -255,7 +261,7 @@
|
|
|
255
261
|
<h5>clickURI: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
256
262
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
257
263
|
<ul>
|
|
258
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
264
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L116">src/documentBuilder.ts:116</a></li></ul></aside></li></ul></section>
|
|
259
265
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withCompressedBinaryData" class="tsd-anchor"></a>
|
|
260
266
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Compressed<wbr/>Binary<wbr/>Data</span><a href="#withCompressedBinaryData" 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
267
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -273,7 +279,7 @@
|
|
|
273
279
|
<h5>compressionType: <a href="../types/CompressionType.html" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a></h5></li></ul></div>
|
|
274
280
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
275
281
|
<ul>
|
|
276
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
282
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L76">src/documentBuilder.ts:76</a></li></ul></aside></li></ul></section>
|
|
277
283
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withData" class="tsd-anchor"></a>
|
|
278
284
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Data</span><a href="#withData" 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>
|
|
279
285
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -289,7 +295,7 @@
|
|
|
289
295
|
<h5>data: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
290
296
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
291
297
|
<ul>
|
|
292
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
298
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L35">src/documentBuilder.ts:35</a></li></ul></aside></li></ul></section>
|
|
293
299
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDate" class="tsd-anchor"></a>
|
|
294
300
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Date</span><a href="#withDate" 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>
|
|
295
301
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -305,7 +311,7 @@
|
|
|
305
311
|
<h5>date: <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>
|
|
306
312
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
307
313
|
<ul>
|
|
308
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
314
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L45">src/documentBuilder.ts:45</a></li></ul></aside></li></ul></section>
|
|
309
315
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withDeniedPermissions" class="tsd-anchor"></a>
|
|
310
316
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Denied<wbr/>Permissions</span><a href="#withDeniedPermissions" 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>
|
|
311
317
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -321,7 +327,7 @@
|
|
|
321
327
|
<h5>securityIdentityBuilder: <a href="../interfaces/SecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentityBuilder</a></h5></li></ul></div>
|
|
322
328
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
323
329
|
<ul>
|
|
324
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
330
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L225">src/documentBuilder.ts:225</a></li></ul></aside></li></ul></section>
|
|
325
331
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withFileExtension" class="tsd-anchor"></a>
|
|
326
332
|
<h3 class="tsd-anchor-link"><span>with<wbr/>File<wbr/>Extension</span><a href="#withFileExtension" 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>
|
|
327
333
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -337,7 +343,7 @@
|
|
|
337
343
|
<h5>extension: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
338
344
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
339
345
|
<ul>
|
|
340
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
346
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L93">src/documentBuilder.ts:93</a></li></ul></aside></li></ul></section>
|
|
341
347
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadata" class="tsd-anchor"></a>
|
|
342
348
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Metadata</span><a href="#withMetadata" 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>
|
|
343
349
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -359,7 +365,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
|
|
|
359
365
|
</div></li></ul></div>
|
|
360
366
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
361
367
|
<ul>
|
|
362
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
368
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L184">src/documentBuilder.ts:184</a></li></ul></aside></li></ul></section>
|
|
363
369
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withMetadataValue" class="tsd-anchor"></a>
|
|
364
370
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Metadata<wbr/>Value</span><a href="#withMetadataValue" 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>
|
|
365
371
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -379,7 +385,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
|
|
|
379
385
|
<h5>keyTransformer: <a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol"> = BuiltInTransformers.identity</span></h5></li></ul></div>
|
|
380
386
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
381
387
|
<ul>
|
|
382
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
388
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L143">src/documentBuilder.ts:143</a></li></ul></aside></li></ul></section>
|
|
383
389
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withModifiedDate" class="tsd-anchor"></a>
|
|
384
390
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Modified<wbr/>Date</span><a href="#withModifiedDate" 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>
|
|
385
391
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -395,7 +401,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
|
|
|
395
401
|
<h5>date: <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>
|
|
396
402
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
397
403
|
<ul>
|
|
398
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
404
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L55">src/documentBuilder.ts:55</a></li></ul></aside></li></ul></section>
|
|
399
405
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withParentID" class="tsd-anchor"></a>
|
|
400
406
|
<h3 class="tsd-anchor-link"><span>with<wbr/>ParentID</span><a href="#withParentID" 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>
|
|
401
407
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -411,7 +417,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
|
|
|
411
417
|
<h5>id: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
412
418
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
413
419
|
<ul>
|
|
414
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
420
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L106">src/documentBuilder.ts:106</a></li></ul></aside></li></ul></section>
|
|
415
421
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="withPermanentId" class="tsd-anchor"></a>
|
|
416
422
|
<h3 class="tsd-anchor-link"><span>with<wbr/>Permanent<wbr/>Id</span><a href="#withPermanentId" 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>
|
|
417
423
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
@@ -427,7 +433,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
|
|
|
427
433
|
<h5>permanentID: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
428
434
|
<h4 class="tsd-returns-title">Returns <a href="DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a></h4><aside class="tsd-sources">
|
|
429
435
|
<ul>
|
|
430
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
436
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/e2f617b/src/documentBuilder.ts#L65">src/documentBuilder.ts:65</a></li></ul></aside></li></ul></section></section></div>
|
|
431
437
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
432
438
|
<div class="tsd-navigation settings">
|
|
433
439
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -456,6 +462,7 @@ If not specified, no transformation will be applied to the metadata keys.</p>
|
|
|
456
462
|
<ul>
|
|
457
463
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="DocumentBuilder.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
|
458
464
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="DocumentBuilder.html#doc" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>doc</a></li>
|
|
465
|
+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="DocumentBuilder.html#uri" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>uri</a></li>
|
|
459
466
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DocumentBuilder.html#build" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>build</a></li>
|
|
460
467
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="DocumentBuilder.html#generatePermanentId" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>generate<wbr/>Permanent<wbr/>Id</a></li>
|
|
461
468
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DocumentBuilder.html#marshal" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>marshal</a></li>
|