@progress/sitefinity-webservices-sdk 0.3.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (201) hide show
  1. package/.eslintignore +4 -0
  2. package/.eslintrc.js +19 -0
  3. package/ci/pipelines/ci.yml +219 -0
  4. package/config/helpers.js +0 -6
  5. package/config/webpack.common.js +1 -3
  6. package/config/webpack.dev.js +2 -9
  7. package/config/webpack.prod.js +5 -6
  8. package/dist/docs/.nojekyll +1 -0
  9. package/dist/docs/assets/highlight.css +57 -0
  10. package/dist/docs/assets/icons.css +1043 -0
  11. package/dist/docs/assets/icons.png +0 -0
  12. package/dist/docs/assets/icons@2x.png +0 -0
  13. package/dist/docs/assets/main.js +52 -0
  14. package/dist/docs/assets/search.js +1 -0
  15. package/dist/docs/assets/style.css +1413 -0
  16. package/dist/docs/assets/{images/widgets.png → widgets.png} +0 -0
  17. package/dist/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  18. package/dist/docs/classes/BlobBuilder.BlobBuilder-1.html +7 -0
  19. package/dist/docs/classes/Data.Data-1.html +65 -0
  20. package/dist/docs/classes/Expression.BinaryExpression.html +1 -0
  21. package/dist/docs/classes/Expression.ComplexExpression.html +1 -0
  22. package/dist/docs/classes/Expression.ExpressionBase.html +1 -0
  23. package/dist/docs/classes/OrderProperty.OrderProperty-1.html +1 -0
  24. package/dist/docs/classes/Query.Query-1.html +33 -0
  25. package/dist/docs/classes/QueryBase.QueryBase-1.html +7 -0
  26. package/dist/docs/classes/QueryBuilder.QueryBuilder-1.html +1 -0
  27. package/dist/docs/classes/Requests_BatchRequest.BatchRequest.html +17 -0
  28. package/dist/docs/classes/Requests_BatchRequest.Transaction.html +17 -0
  29. package/dist/docs/classes/Requests_ExecutableRequest.ExecutableRequest.html +1 -0
  30. package/dist/docs/classes/Requests_Request.CreateRelatedRequest.html +1 -0
  31. package/dist/docs/classes/Requests_Request.CreateRequest.html +1 -0
  32. package/dist/docs/classes/Requests_Request.DeleteRelatedByIdRequest.html +1 -0
  33. package/dist/docs/classes/Requests_Request.DeleteRelatedRequest.html +1 -0
  34. package/dist/docs/classes/Requests_Request.DeleteRequest.html +1 -0
  35. package/dist/docs/classes/Requests_Request.GetByIdRequest.html +1 -0
  36. package/dist/docs/classes/Requests_Request.GetRelatedByIdRequest.html +1 -0
  37. package/dist/docs/classes/Requests_Request.GetRelatedRequest.html +1 -0
  38. package/dist/docs/classes/Requests_Request.GetRequest.html +1 -0
  39. package/dist/docs/classes/Requests_Request.UpdateRequest.html +1 -0
  40. package/dist/docs/classes/Requests_Request.UploadRequest.html +1 -0
  41. package/dist/docs/classes/Requests_RequestBase.RequestBase.html +1 -0
  42. package/dist/docs/classes/Requests_RequestFactory.RequestFactory.html +1 -0
  43. package/dist/docs/classes/Sitefinity.Sitefinity-1.html +5 -0
  44. package/dist/docs/classes/WhereQuery.WhereQuery-1.html +31 -0
  45. package/dist/docs/classes/utils.utils-1.html +1 -0
  46. package/dist/docs/index.html +54 -242
  47. package/dist/docs/interfaces/Data.CreateRelatedRequestOptions.html +1 -0
  48. package/dist/docs/interfaces/Data.CreateRequestOptions.html +1 -0
  49. package/dist/docs/interfaces/Data.OperationsRequestOptions.html +1 -0
  50. package/dist/docs/interfaces/Data.PropertyRequestOptions.html +1 -0
  51. package/dist/docs/interfaces/Data.RequestOptionsBase.html +1 -0
  52. package/dist/docs/interfaces/Data.SingleRelatedItemRequestOptions.html +1 -0
  53. package/dist/docs/interfaces/Data.UpdateRequestOptions.html +1 -0
  54. package/dist/docs/interfaces/Data.UploadRequestOptions.html +1 -0
  55. package/dist/docs/interfaces/Requests_BatchRequest.BatchCreateRelatedRequestOptions.html +1 -0
  56. package/dist/docs/interfaces/Requests_BatchRequest.BatchCreateRequestOptions.html +1 -0
  57. package/dist/docs/interfaces/Requests_BatchRequest.BatchPropertyRequestOptions.html +1 -0
  58. package/dist/docs/interfaces/Requests_BatchRequest.BatchRequestOptionsBase.html +1 -0
  59. package/dist/docs/interfaces/Requests_BatchRequest.BatchRequestOptionsExtended.html +1 -0
  60. package/dist/docs/interfaces/Requests_BatchRequest.BatchSingleItemRequestOptions.html +1 -0
  61. package/dist/docs/interfaces/Requests_BatchRequest.BatchSingleRelatedItemRequestOptions.html +1 -0
  62. package/dist/docs/interfaces/Requests_BatchRequest.BatchUpdateRequestOptions.html +1 -0
  63. package/dist/docs/interfaces/Requests_ExecutableRequest.ResponseHandlers.html +5 -0
  64. package/dist/docs/interfaces/Requests_Request.PostRequestOptionsExtended.html +1 -0
  65. package/dist/docs/interfaces/Requests_Request.PutRequestOptionsExtended.html +1 -0
  66. package/dist/docs/interfaces/Requests_Request.RelatedByIdRequestOptionsExtended.html +1 -0
  67. package/dist/docs/interfaces/Requests_Request.RelatedRequestOptionsExtended.html +1 -0
  68. package/dist/docs/interfaces/Requests_Request.UploadRequestOptionsExtended.html +1 -0
  69. package/dist/docs/interfaces/Requests_RequestBase.RequestOptionsBaseExtended.html +1 -0
  70. package/dist/docs/interfaces/Sitefinity.SDKOptions.html +9 -0
  71. package/dist/docs/interfaces/Sitefinity.Token.html +1 -0
  72. package/dist/docs/interfaces/Sitefinity.TypeOptions.html +13 -0
  73. package/dist/docs/modules/BlobBuilder.html +1 -0
  74. package/dist/docs/modules/Data.html +1 -0
  75. package/dist/docs/modules/Expression.html +1 -0
  76. package/dist/docs/modules/OrderProperty.html +1 -0
  77. package/dist/docs/modules/Query.html +1 -0
  78. package/dist/docs/modules/QueryBase.html +1 -0
  79. package/dist/docs/modules/QueryBuilder.html +1 -0
  80. package/dist/docs/modules/Requests_BatchRequest.html +1 -0
  81. package/dist/docs/modules/Requests_ExecutableRequest.html +1 -0
  82. package/dist/docs/modules/Requests_Request.html +1 -0
  83. package/dist/docs/modules/Requests_RequestBase.html +1 -0
  84. package/dist/docs/modules/Requests_RequestFactory.html +1 -0
  85. package/dist/docs/modules/Sitefinity.html +1 -0
  86. package/dist/docs/modules/WhereQuery.html +1 -0
  87. package/dist/docs/modules/constants.html +1 -0
  88. package/dist/docs/modules/utils.html +1 -0
  89. package/dist/docs/modules.html +1 -0
  90. package/dist/samples.html +33 -81
  91. package/dist/sitefinity-webservices-sdk.d.ts +16 -0
  92. package/dist/sitefinity-webservices-sdk.js +1141 -1737
  93. package/dist/sitefinity-webservices-sdk.js.map +1 -1
  94. package/dist/sitefinity-webservices-sdk.min.js +2 -16
  95. package/dist/sitefinity-webservices-sdk.min.js.LICENSE.txt +14 -0
  96. package/dist/src/BlobBuilder.d.ts +14 -0
  97. package/dist/src/Data.d.ts +144 -0
  98. package/dist/src/Expression.d.ts +19 -0
  99. package/dist/src/OrderProperty.d.ts +8 -0
  100. package/dist/src/Query.d.ts +59 -0
  101. package/dist/src/QueryBase.d.ts +18 -0
  102. package/dist/src/QueryBuilder.d.ts +13 -0
  103. package/dist/src/Requests/BatchRequest.d.ts +146 -0
  104. package/dist/src/Requests/ExecutableRequest.d.ts +20 -0
  105. package/dist/src/Requests/Request.d.ts +88 -0
  106. package/dist/src/Requests/RequestBase.d.ts +28 -0
  107. package/dist/src/Requests/RequestFactory.d.ts +22 -0
  108. package/dist/src/Sitefinity.d.ts +66 -0
  109. package/dist/src/WhereQuery.d.ts +68 -0
  110. package/dist/src/constants.d.ts +55 -0
  111. package/dist/src/utils.d.ts +16 -0
  112. package/karma.conf.js +29 -0
  113. package/package-lock.json +16108 -6805
  114. package/package.json +28 -10
  115. package/sitefinity-webservices-sdk.ts +16 -0
  116. package/src/BlobBuilder.ts +7 -12
  117. package/src/Data.spec.ts +160 -0
  118. package/src/Data.ts +132 -207
  119. package/src/Expression.ts +0 -1
  120. package/src/OrderProperty.ts +4 -5
  121. package/src/Query.ts +52 -78
  122. package/src/QueryBase.ts +21 -47
  123. package/src/QueryBuilder.ts +64 -82
  124. package/src/Requests/BatchRequest.ts +312 -335
  125. package/src/Requests/ExecutableRequest.ts +46 -73
  126. package/src/Requests/Request.ts +134 -260
  127. package/src/Requests/RequestBase.ts +161 -0
  128. package/src/Requests/RequestFactory.ts +36 -54
  129. package/src/Requests/request.spec.ts +92 -0
  130. package/src/Sitefinity.spec.ts +418 -0
  131. package/src/Sitefinity.ts +77 -146
  132. package/src/WhereQuery.ts +52 -112
  133. package/src/constants.ts +58 -39
  134. package/src/utils.ts +17 -14
  135. package/template.html +33 -35
  136. package/tsconfig.json +8 -1
  137. package/type.txt +1 -1
  138. package/version.txt +1 -1
  139. package/config/html.conf.json +0 -5
  140. package/dist/docs/assets/css/main.css +0 -865
  141. package/dist/docs/assets/css/main.css.map +0 -7
  142. package/dist/docs/assets/images/icons.png +0 -0
  143. package/dist/docs/assets/images/icons@2x.png +0 -0
  144. package/dist/docs/assets/js/main.js +0 -5
  145. package/dist/docs/assets/js/search.js +0 -3
  146. package/dist/docs/classes/_authentication_.authentication.html +0 -527
  147. package/dist/docs/classes/_blobbuilder_.blobbuilder.html +0 -351
  148. package/dist/docs/classes/_data_.data.html +0 -974
  149. package/dist/docs/classes/_expression_.binaryexpression.html +0 -450
  150. package/dist/docs/classes/_expression_.complexexpression.html +0 -374
  151. package/dist/docs/classes/_expression_.expressionbase.html +0 -336
  152. package/dist/docs/classes/_orderproperty_.orderproperty.html +0 -381
  153. package/dist/docs/classes/_query_.query.html +0 -896
  154. package/dist/docs/classes/_querybase_.querybase.html +0 -518
  155. package/dist/docs/classes/_querybuilder_.querybuilder.html +0 -496
  156. package/dist/docs/classes/_requests_batchrequest_.batchrequest.html +0 -1511
  157. package/dist/docs/classes/_requests_batchrequest_.transaction.html +0 -804
  158. package/dist/docs/classes/_requests_executablerequest_.executablerequest.html +0 -549
  159. package/dist/docs/classes/_requests_request_.createrelatedrequest.html +0 -689
  160. package/dist/docs/classes/_requests_request_.createrequest.html +0 -680
  161. package/dist/docs/classes/_requests_request_.deleterelatedbyidrequest.html +0 -687
  162. package/dist/docs/classes/_requests_request_.deleterelatedrequest.html +0 -673
  163. package/dist/docs/classes/_requests_request_.deleterequest.html +0 -666
  164. package/dist/docs/classes/_requests_request_.getbyidrequest.html +0 -666
  165. package/dist/docs/classes/_requests_request_.getrelatedbyidrequest.html +0 -687
  166. package/dist/docs/classes/_requests_request_.getrelatedrequest.html +0 -673
  167. package/dist/docs/classes/_requests_request_.getrequest.html +0 -658
  168. package/dist/docs/classes/_requests_request_.requestbase.html +0 -687
  169. package/dist/docs/classes/_requests_request_.updaterequest.html +0 -686
  170. package/dist/docs/classes/_requests_request_.uploadrequest.html +0 -715
  171. package/dist/docs/classes/_requests_requestfactory_.requestfactory.html +0 -724
  172. package/dist/docs/classes/_sitefinity_.sitefinity.html +0 -521
  173. package/dist/docs/classes/_utils_.utils.html +0 -597
  174. package/dist/docs/classes/_wherequery_.wherequery.html +0 -992
  175. package/dist/docs/globals.html +0 -238
  176. package/dist/docs/modules/_authentication_.html +0 -225
  177. package/dist/docs/modules/_blobbuilder_.html +0 -225
  178. package/dist/docs/modules/_constants_.html +0 -528
  179. package/dist/docs/modules/_contenttypes_.html +0 -248
  180. package/dist/docs/modules/_data_.html +0 -225
  181. package/dist/docs/modules/_expression_.html +0 -233
  182. package/dist/docs/modules/_headers_.html +0 -328
  183. package/dist/docs/modules/_httpmethods_.html +0 -288
  184. package/dist/docs/modules/_main_.html +0 -209
  185. package/dist/docs/modules/_orderproperty_.html +0 -225
  186. package/dist/docs/modules/_query_.html +0 -225
  187. package/dist/docs/modules/_querybase_.html +0 -225
  188. package/dist/docs/modules/_querybuilder_.html +0 -247
  189. package/dist/docs/modules/_requests_batchrequest_.html +0 -265
  190. package/dist/docs/modules/_requests_executablerequest_.html +0 -296
  191. package/dist/docs/modules/_requests_request_.html +0 -333
  192. package/dist/docs/modules/_requests_requestfactory_.html +0 -247
  193. package/dist/docs/modules/_sitefinity_.html +0 -225
  194. package/dist/docs/modules/_utils_.html +0 -225
  195. package/dist/docs/modules/_wherequery_.html +0 -247
  196. package/dist/index.html +0 -474
  197. package/src/Authentication.ts +0 -96
  198. package/src/ContentTypes.ts +0 -5
  199. package/src/Headers.ts +0 -12
  200. package/src/HttpMethods.ts +0 -9
  201. package/src/main.ts +0 -2
package/dist/docs/classes/_data_.data.html DELETED
@@ -1,974 +0,0 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>Data | @progress/sitefinity-webservices-sdk</title>
7
- <meta name="description" content="">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- </head>
11
- <body>
12
- <header>
13
- <div class="tsd-page-toolbar">
14
- <div class="container">
15
- <div class="table-wrap">
16
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17
- <div class="field">
18
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
- <input id="tsd-search-field" type="text" />
20
- </div>
21
- <ul class="results">
22
- <li class="state loading">Preparing search index...</li>
23
- <li class="state failure">The search index is not available</li>
24
- </ul>
25
- <a href="../index.html" class="title">@progress/sitefinity-webservices-sdk</a>
26
- </div>
27
- <div class="table-cell" id="tsd-widgets">
28
- <div id="tsd-filter">
29
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
- <div class="tsd-filter-group">
31
- <div class="tsd-select" id="tsd-filter-visibility">
32
- <span class="tsd-select-label">All</span>
33
- <ul class="tsd-select-list">
34
- <li data-value="public">Public</li>
35
- <li data-value="protected">Public/Protected</li>
36
- <li data-value="private" class="selected">All</li>
37
- </ul>
38
- </div>
39
- <input type="checkbox" id="tsd-filter-inherited" checked />
40
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
- <input type="checkbox" id="tsd-filter-only-exported" />
42
- <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
43
- </div>
44
- </div>
45
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
46
- </div>
47
- </div>
48
- </div>
49
- </div>
50
- <div class="tsd-page-title">
51
- <div class="container">
52
- <ul class="tsd-breadcrumb">
53
- <li>
54
- <a href="../globals.html">Globals</a>
55
- </li>
56
- <li>
57
- <a href="../modules/_data_.html">&quot;Data&quot;</a>
58
- </li>
59
- <li>
60
- <a href="_data_.data.html">Data</a>
61
- </li>
62
- </ul>
63
- <h1>Class Data</h1>
64
- </div>
65
- </div>
66
- </header>
67
- <div class="container container-main">
68
- <div class="row">
69
- <div class="col-8 col-content">
70
- <section class="tsd-panel tsd-comment">
71
- <div class="tsd-comment tsd-typography">
72
- <dl class="tsd-comment-tags">
73
- <dt>class</dt>
74
- <dd><p>Data</p>
75
- </dd>
76
- <dt>classdesc</dt>
77
- <dd><p>The constructor of the Data object. This object is used for requesting data from Sitefinity.</p>
78
- </dd>
79
- <dt>param</dt>
80
- <dd><p>An object containing configuration options for the <a href="_data_.data.html">Data</a> object.</p>
81
- </dd>
82
- <dt>param</dt>
83
- <dd><p>Your service url that points to the configured instance of Sitefinity service.</p>
84
- </dd>
85
- <dt>param</dt>
86
- <dd><p>The url name of the type.</p>
87
- </dd>
88
- <dt>param</dt>
89
- <dd><p>An object containing configuration options for requests.</p>
90
- </dd>
91
- <dt>param</dt>
92
- <dd><p>The provider name to use in each request.</p>
93
- </dd>
94
- <dt>param</dt>
95
- <dd><p>The culture name to use in each request.</p>
96
- </dd>
97
- </dl>
98
- </div>
99
- </section>
100
- <section class="tsd-panel tsd-hierarchy">
101
- <h3>Hierarchy</h3>
102
- <ul class="tsd-hierarchy">
103
- <li>
104
- <span class="target">Data</span>
105
- </li>
106
- </ul>
107
- </section>
108
- <section class="tsd-panel-group tsd-index-group">
109
- <h2>Index</h2>
110
- <section class="tsd-panel tsd-index-panel">
111
- <div class="tsd-index-content">
112
- <section class="tsd-index-section ">
113
- <h3>Constructors</h3>
114
- <ul class="tsd-index-list">
115
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_data_.data.html#constructor" class="tsd-kind-icon">constructor</a></li>
116
- </ul>
117
- </section>
118
- <section class="tsd-index-section tsd-is-private tsd-is-private-protected">
119
- <h3>Properties</h3>
120
- <ul class="tsd-index-list">
121
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_data_.data.html#factory" class="tsd-kind-icon">factory</a></li>
122
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_data_.data.html#urloptions" class="tsd-kind-icon">url<wbr>Options</a></li>
123
- </ul>
124
- </section>
125
- <section class="tsd-index-section ">
126
- <h3>Methods</h3>
127
- <ul class="tsd-index-list">
128
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#create" class="tsd-kind-icon">create</a></li>
129
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#createrelated" class="tsd-kind-icon">create<wbr>Related</a></li>
130
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#destroy" class="tsd-kind-icon">destroy</a></li>
131
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#destroyrelated" class="tsd-kind-icon">destroy<wbr>Related</a></li>
132
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#destroyrelatedbyid" class="tsd-kind-icon">destroy<wbr>Related<wbr>ById</a></li>
133
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#get" class="tsd-kind-icon">get</a></li>
134
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#getoperations" class="tsd-kind-icon">get<wbr>Operations</a></li>
135
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#getproperty" class="tsd-kind-icon">get<wbr>Property</a></li>
136
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#getrelated" class="tsd-kind-icon">get<wbr>Related</a></li>
137
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#getrelatedbyid" class="tsd-kind-icon">get<wbr>Related<wbr>ById</a></li>
138
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#getsingle" class="tsd-kind-icon">get<wbr>Single</a></li>
139
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#operation" class="tsd-kind-icon">operation</a></li>
140
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#update" class="tsd-kind-icon">update</a></li>
141
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_data_.data.html#upload" class="tsd-kind-icon">upload</a></li>
142
- </ul>
143
- </section>
144
- </div>
145
- </section>
146
- </section>
147
- <section class="tsd-panel-group tsd-member-group ">
148
- <h2>Constructors</h2>
149
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
150
- <a name="constructor" class="tsd-anchor"></a>
151
- <h3>constructor</h3>
152
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
153
- <li class="tsd-signature tsd-kind-icon">new <wbr>Data<span class="tsd-signature-symbol">(</span>urlOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, factory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_data_.data.html" class="tsd-signature-type">Data</a></li>
154
- </ul>
155
- <ul class="tsd-descriptions">
156
- <li class="tsd-description">
157
- <aside class="tsd-sources">
158
- <ul>
159
- <li>Defined in Data.ts:13</li>
160
- </ul>
161
- </aside>
162
- <h4 class="tsd-parameters-title">Parameters</h4>
163
- <ul class="tsd-parameters">
164
- <li>
165
- <h5>urlOptions: <span class="tsd-signature-type">any</span></h5>
166
- </li>
167
- <li>
168
- <h5>factory: <span class="tsd-signature-type">any</span></h5>
169
- </li>
170
- </ul>
171
- <h4 class="tsd-returns-title">Returns <a href="_data_.data.html" class="tsd-signature-type">Data</a></h4>
172
- </li>
173
- </ul>
174
- </section>
175
- </section>
176
- <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
177
- <h2>Properties</h2>
178
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
179
- <a name="factory" class="tsd-anchor"></a>
180
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> factory</h3>
181
- <div class="tsd-signature tsd-kind-icon">factory<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
182
- <aside class="tsd-sources">
183
- <ul>
184
- <li>Defined in Data.ts:13</li>
185
- </ul>
186
- </aside>
187
- </section>
188
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
189
- <a name="urloptions" class="tsd-anchor"></a>
190
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> url<wbr>Options</h3>
191
- <div class="tsd-signature tsd-kind-icon">url<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
192
- <aside class="tsd-sources">
193
- <ul>
194
- <li>Defined in Data.ts:12</li>
195
- </ul>
196
- </aside>
197
- </section>
198
- </section>
199
- <section class="tsd-panel-group tsd-member-group ">
200
- <h2>Methods</h2>
201
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
202
- <a name="create" class="tsd-anchor"></a>
203
- <h3>create</h3>
204
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
205
- <li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
206
- </ul>
207
- <ul class="tsd-descriptions">
208
- <li class="tsd-description">
209
- <aside class="tsd-sources">
210
- <ul>
211
- <li>Defined in Data.ts:123</li>
212
- </ul>
213
- </aside>
214
- <div class="tsd-comment tsd-typography">
215
- <div class="lead">
216
- <p>Executes a POST request for a single item.</p>
217
- </div>
218
- <dl class="tsd-comment-tags">
219
- <dt>memberof</dt>
220
- <dd><p>Data</p>
221
- </dd>
222
- <dt>instance</dt>
223
- <dd></dd>
224
- </dl>
225
- </div>
226
- <h4 class="tsd-parameters-title">Parameters</h4>
227
- <ul class="tsd-parameters">
228
- <li>
229
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
230
- <div class="tsd-comment tsd-typography">
231
- <p>The parameters for the request.</p>
232
- </div>
233
- </li>
234
- </ul>
235
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
236
- </li>
237
- </ul>
238
- </section>
239
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
240
- <a name="createrelated" class="tsd-anchor"></a>
241
- <h3>create<wbr>Related</h3>
242
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
243
- <li class="tsd-signature tsd-kind-icon">create<wbr>Related<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
244
- </ul>
245
- <ul class="tsd-descriptions">
246
- <li class="tsd-description">
247
- <aside class="tsd-sources">
248
- <ul>
249
- <li>Defined in Data.ts:378</li>
250
- </ul>
251
- </aside>
252
- <div class="tsd-comment tsd-typography">
253
- <div class="lead">
254
- <p>Executes a POST request to add a related item to the property collection.</p>
255
- </div>
256
- <dl class="tsd-comment-tags">
257
- <dt>memberof</dt>
258
- <dd><p>Data</p>
259
- </dd>
260
- <dt>instance</dt>
261
- <dd></dd>
262
- </dl>
263
- </div>
264
- <h4 class="tsd-parameters-title">Parameters</h4>
265
- <ul class="tsd-parameters">
266
- <li>
267
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
268
- <div class="tsd-comment tsd-typography">
269
- <p>The parameters for the request.</p>
270
- </div>
271
- </li>
272
- </ul>
273
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
274
- </li>
275
- </ul>
276
- </section>
277
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
278
- <a name="destroy" class="tsd-anchor"></a>
279
- <h3>destroy</h3>
280
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
281
- <li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
282
- </ul>
283
- <ul class="tsd-descriptions">
284
- <li class="tsd-description">
285
- <aside class="tsd-sources">
286
- <ul>
287
- <li>Defined in Data.ts:198</li>
288
- </ul>
289
- </aside>
290
- <div class="tsd-comment tsd-typography">
291
- <div class="lead">
292
- <p>Executes a DELETE request to delete a single item.</p>
293
- </div>
294
- <dl class="tsd-comment-tags">
295
- <dt>memberof</dt>
296
- <dd><p>Data</p>
297
- </dd>
298
- <dt>instance</dt>
299
- <dd></dd>
300
- </dl>
301
- </div>
302
- <h4 class="tsd-parameters-title">Parameters</h4>
303
- <ul class="tsd-parameters">
304
- <li>
305
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
306
- <div class="tsd-comment tsd-typography">
307
- <p>The parameters for the request.</p>
308
- </div>
309
- </li>
310
- </ul>
311
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
312
- </li>
313
- </ul>
314
- </section>
315
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
316
- <a name="destroyrelated" class="tsd-anchor"></a>
317
- <h3>destroy<wbr>Related</h3>
318
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
319
- <li class="tsd-signature tsd-kind-icon">destroy<wbr>Related<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
320
- </ul>
321
- <ul class="tsd-descriptions">
322
- <li class="tsd-description">
323
- <aside class="tsd-sources">
324
- <ul>
325
- <li>Defined in Data.ts:325</li>
326
- </ul>
327
- </aside>
328
- <div class="tsd-comment tsd-typography">
329
- <div class="lead">
330
- <p>Executes a DELETE request to retrieve the delete all of the associated members in the relation property.</p>
331
- </div>
332
- <dl class="tsd-comment-tags">
333
- <dt>memberof</dt>
334
- <dd><p>Data</p>
335
- </dd>
336
- <dt>instance</dt>
337
- <dd></dd>
338
- </dl>
339
- </div>
340
- <h4 class="tsd-parameters-title">Parameters</h4>
341
- <ul class="tsd-parameters">
342
- <li>
343
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
344
- <div class="tsd-comment tsd-typography">
345
- <p>The parameters for the request.</p>
346
- </div>
347
- </li>
348
- </ul>
349
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
350
- </li>
351
- </ul>
352
- </section>
353
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
354
- <a name="destroyrelatedbyid" class="tsd-anchor"></a>
355
- <h3>destroy<wbr>Related<wbr>ById</h3>
356
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
357
- <li class="tsd-signature tsd-kind-icon">destroy<wbr>Related<wbr>ById<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
358
- </ul>
359
- <ul class="tsd-descriptions">
360
- <li class="tsd-description">
361
- <aside class="tsd-sources">
362
- <ul>
363
- <li>Defined in Data.ts:351</li>
364
- </ul>
365
- </aside>
366
- <div class="tsd-comment tsd-typography">
367
- <div class="lead">
368
- <p>Executes a DELETE request to retrieve the a single entry of the associated members in the relation property.</p>
369
- </div>
370
- <dl class="tsd-comment-tags">
371
- <dt>memberof</dt>
372
- <dd><p>Data</p>
373
- </dd>
374
- <dt>instance</dt>
375
- <dd></dd>
376
- </dl>
377
- </div>
378
- <h4 class="tsd-parameters-title">Parameters</h4>
379
- <ul class="tsd-parameters">
380
- <li>
381
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
382
- <div class="tsd-comment tsd-typography">
383
- <p>The parameters for the request.</p>
384
- </div>
385
- </li>
386
- </ul>
387
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
388
- </li>
389
- </ul>
390
- </section>
391
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
392
- <a name="get" class="tsd-anchor"></a>
393
- <h3>get</h3>
394
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
395
- <li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
396
- </ul>
397
- <ul class="tsd-descriptions">
398
- <li class="tsd-description">
399
- <aside class="tsd-sources">
400
- <ul>
401
- <li>Defined in Data.ts:31</li>
402
- </ul>
403
- </aside>
404
- <div class="tsd-comment tsd-typography">
405
- <div class="lead">
406
- <p>Executes a GET request to retrieve a collection of items.</p>
407
- </div>
408
- <dl class="tsd-comment-tags">
409
- <dt>memberof</dt>
410
- <dd><p>Data</p>
411
- </dd>
412
- <dt>instance</dt>
413
- <dd></dd>
414
- </dl>
415
- </div>
416
- <h4 class="tsd-parameters-title">Parameters</h4>
417
- <ul class="tsd-parameters">
418
- <li>
419
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
420
- <div class="tsd-comment tsd-typography">
421
- <p>The parameters for the request.</p>
422
- </div>
423
- </li>
424
- </ul>
425
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
426
- </li>
427
- </ul>
428
- </section>
429
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
430
- <a name="getoperations" class="tsd-anchor"></a>
431
- <h3>get<wbr>Operations</h3>
432
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
433
- <li class="tsd-signature tsd-kind-icon">get<wbr>Operations<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
434
- </ul>
435
- <ul class="tsd-descriptions">
436
- <li class="tsd-description">
437
- <aside class="tsd-sources">
438
- <ul>
439
- <li>Defined in Data.ts:57</li>
440
- </ul>
441
- </aside>
442
- <div class="tsd-comment tsd-typography">
443
- <div class="lead">
444
- <p>Executes a GET request to retrieve an/all item(s) operations.</p>
445
- </div>
446
- <dl class="tsd-comment-tags">
447
- <dt>memberof</dt>
448
- <dd><p>Data</p>
449
- </dd>
450
- <dt>instance</dt>
451
- <dd></dd>
452
- </dl>
453
- </div>
454
- <h4 class="tsd-parameters-title">Parameters</h4>
455
- <ul class="tsd-parameters">
456
- <li>
457
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
458
- <div class="tsd-comment tsd-typography">
459
- <p>The parameters for the request.</p>
460
- </div>
461
- </li>
462
- </ul>
463
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
464
- </li>
465
- </ul>
466
- </section>
467
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
468
- <a name="getproperty" class="tsd-anchor"></a>
469
- <h3>get<wbr>Property</h3>
470
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
471
- <li class="tsd-signature tsd-kind-icon">get<wbr>Property<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
472
- </ul>
473
- <ul class="tsd-descriptions">
474
- <li class="tsd-description">
475
- <aside class="tsd-sources">
476
- <ul>
477
- <li>Defined in Data.ts:248</li>
478
- </ul>
479
- </aside>
480
- <div class="tsd-comment tsd-typography">
481
- <div class="lead">
482
- <p>Executes a GET request to get the property of a single item.</p>
483
- </div>
484
- <dl class="tsd-comment-tags">
485
- <dt>memberof</dt>
486
- <dd><p>Data</p>
487
- </dd>
488
- <dt>instance</dt>
489
- <dd></dd>
490
- </dl>
491
- </div>
492
- <h4 class="tsd-parameters-title">Parameters</h4>
493
- <ul class="tsd-parameters">
494
- <li>
495
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
496
- <div class="tsd-comment tsd-typography">
497
- <p>The parameters for the request.</p>
498
- </div>
499
- </li>
500
- </ul>
501
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
502
- </li>
503
- </ul>
504
- </section>
505
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
506
- <a name="getrelated" class="tsd-anchor"></a>
507
- <h3>get<wbr>Related</h3>
508
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
509
- <li class="tsd-signature tsd-kind-icon">get<wbr>Related<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
510
- </ul>
511
- <ul class="tsd-descriptions">
512
- <li class="tsd-description">
513
- <aside class="tsd-sources">
514
- <ul>
515
- <li>Defined in Data.ts:273</li>
516
- </ul>
517
- </aside>
518
- <div class="tsd-comment tsd-typography">
519
- <div class="lead">
520
- <p>Executes a GET request to get the related property value of a single item.</p>
521
- </div>
522
- <dl class="tsd-comment-tags">
523
- <dt>memberof</dt>
524
- <dd><p>Data</p>
525
- </dd>
526
- <dt>instance</dt>
527
- <dd></dd>
528
- </dl>
529
- </div>
530
- <h4 class="tsd-parameters-title">Parameters</h4>
531
- <ul class="tsd-parameters">
532
- <li>
533
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
534
- <div class="tsd-comment tsd-typography">
535
- <p>The parameters for the request.</p>
536
- </div>
537
- </li>
538
- </ul>
539
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
540
- </li>
541
- </ul>
542
- </section>
543
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
544
- <a name="getrelatedbyid" class="tsd-anchor"></a>
545
- <h3>get<wbr>Related<wbr>ById</h3>
546
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
547
- <li class="tsd-signature tsd-kind-icon">get<wbr>Related<wbr>ById<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
548
- </ul>
549
- <ul class="tsd-descriptions">
550
- <li class="tsd-description">
551
- <aside class="tsd-sources">
552
- <ul>
553
- <li>Defined in Data.ts:299</li>
554
- </ul>
555
- </aside>
556
- <div class="tsd-comment tsd-typography">
557
- <div class="lead">
558
- <p>Executes a GET request to retrieve the related property value of a single item by the id of the related item.</p>
559
- </div>
560
- <dl class="tsd-comment-tags">
561
- <dt>memberof</dt>
562
- <dd><p>Data</p>
563
- </dd>
564
- <dt>instance</dt>
565
- <dd></dd>
566
- </dl>
567
- </div>
568
- <h4 class="tsd-parameters-title">Parameters</h4>
569
- <ul class="tsd-parameters">
570
- <li>
571
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
572
- <div class="tsd-comment tsd-typography">
573
- <p>The parameters for the request.</p>
574
- </div>
575
- </li>
576
- </ul>
577
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
578
- </li>
579
- </ul>
580
- </section>
581
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
582
- <a name="getsingle" class="tsd-anchor"></a>
583
- <h3>get<wbr>Single</h3>
584
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
585
- <li class="tsd-signature tsd-kind-icon">get<wbr>Single<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
586
- </ul>
587
- <ul class="tsd-descriptions">
588
- <li class="tsd-description">
589
- <aside class="tsd-sources">
590
- <ul>
591
- <li>Defined in Data.ts:93</li>
592
- </ul>
593
- </aside>
594
- <div class="tsd-comment tsd-typography">
595
- <div class="lead">
596
- <p>Executes a GET request for a single item.</p>
597
- </div>
598
- <dl class="tsd-comment-tags">
599
- <dt>memberof</dt>
600
- <dd><p>Data</p>
601
- </dd>
602
- <dt>instance</dt>
603
- <dd></dd>
604
- </dl>
605
- </div>
606
- <h4 class="tsd-parameters-title">Parameters</h4>
607
- <ul class="tsd-parameters">
608
- <li>
609
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
610
- <div class="tsd-comment tsd-typography">
611
- <p>The parameters for the request.</p>
612
- </div>
613
- </li>
614
- </ul>
615
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
616
- </li>
617
- </ul>
618
- </section>
619
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
620
- <a name="operation" class="tsd-anchor"></a>
621
- <h3>operation</h3>
622
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
623
- <li class="tsd-signature tsd-kind-icon">operation<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
624
- </ul>
625
- <ul class="tsd-descriptions">
626
- <li class="tsd-description">
627
- <aside class="tsd-sources">
628
- <ul>
629
- <li>Defined in Data.ts:222</li>
630
- </ul>
631
- </aside>
632
- <div class="tsd-comment tsd-typography">
633
- <div class="lead">
634
- <p>Executes a POST request to execute a workflow operation for single item.</p>
635
- </div>
636
- <dl class="tsd-comment-tags">
637
- <dt>memberof</dt>
638
- <dd><p>Data</p>
639
- </dd>
640
- <dt>instance</dt>
641
- <dd></dd>
642
- </dl>
643
- </div>
644
- <h4 class="tsd-parameters-title">Parameters</h4>
645
- <ul class="tsd-parameters">
646
- <li>
647
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
648
- <div class="tsd-comment tsd-typography">
649
- <p>The parameters for the request.</p>
650
- </div>
651
- </li>
652
- </ul>
653
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
654
- </li>
655
- </ul>
656
- </section>
657
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
658
- <a name="update" class="tsd-anchor"></a>
659
- <h3>update</h3>
660
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
661
- <li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
662
- </ul>
663
- <ul class="tsd-descriptions">
664
- <li class="tsd-description">
665
- <aside class="tsd-sources">
666
- <ul>
667
- <li>Defined in Data.ts:172</li>
668
- </ul>
669
- </aside>
670
- <div class="tsd-comment tsd-typography">
671
- <div class="lead">
672
- <p>Executes a PATCH request to update a single item.</p>
673
- </div>
674
- <dl class="tsd-comment-tags">
675
- <dt>memberof</dt>
676
- <dd><p>Data</p>
677
- </dd>
678
- <dt>instance</dt>
679
- <dd></dd>
680
- <dt>example</dt>
681
- <dd><p>var data = sf.data({
682
- urlName: &quot;newsitems&quot;,
683
- providerName: &quot;OpenAccessDataProvider&quot;,
684
- cultureName: &quot;en&quot;
685
- });</p>
686
- <p>var newsItemUpdate = {
687
- &quot;Title&quot;: &#39;updated news title&#39;
688
- };</p>
689
- <p>data.update({
690
- key: &#39;00000000-0000-0000-0000-000000000000&#39;, // key of item to update
691
- data: newsItemUpdate,
692
- saveTemp: true,
693
- successCb: successCb,
694
- failureCb: failureCb
695
- });</p>
696
- </dd>
697
- </dl>
698
- </div>
699
- <h4 class="tsd-parameters-title">Parameters</h4>
700
- <ul class="tsd-parameters">
701
- <li>
702
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
703
- <div class="tsd-comment tsd-typography">
704
- <p>The parameters for the request.</p>
705
- </div>
706
- </li>
707
- </ul>
708
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
709
- </li>
710
- </ul>
711
- </section>
712
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
713
- <a name="upload" class="tsd-anchor"></a>
714
- <h3>upload</h3>
715
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
716
- <li class="tsd-signature tsd-kind-icon">upload<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
717
- </ul>
718
- <ul class="tsd-descriptions">
719
- <li class="tsd-description">
720
- <aside class="tsd-sources">
721
- <ul>
722
- <li>Defined in Data.ts:433</li>
723
- </ul>
724
- </aside>
725
- <div class="tsd-comment tsd-typography">
726
- <div class="lead">
727
- <p>Executes a POST request to upload a media item.</p>
728
- </div>
729
- <dl class="tsd-comment-tags">
730
- <dt>memberof</dt>
731
- <dd><p>Data</p>
732
- </dd>
733
- <dt>instance</dt>
734
- <dd></dd>
735
- <dt>example</dt>
736
- <dd><p>var data = sf.data({
737
- urlName: &quot;images&quot;
738
- });
739
- data.upload({
740
- data: {
741
- content: &quot;base 64 representation of the file&quot;,
742
- contentType: &quot;image/jpeg&quot;,
743
- name: &quot;test.jpg&quot;,
744
- payload: {
745
- Title: &quot;Test&quot;,
746
- UrlName: &quot;test&quot;
747
- },
748
- uploadProperties: {
749
- ParentId: &quot;4BA7AD46-F29B-4E65-BE17-9BF7CE5BA1FB&quot;
750
- }
751
- },
752
- successCb: successCb,
753
- failureCb: failureCb
754
- });</p>
755
- </dd>
756
- </dl>
757
- </div>
758
- <h4 class="tsd-parameters-title">Parameters</h4>
759
- <ul class="tsd-parameters">
760
- <li>
761
- <h5>parameters: <span class="tsd-signature-type">any</span></h5>
762
- <div class="tsd-comment tsd-typography">
763
- <p>The parameters for the request.</p>
764
- </div>
765
- </li>
766
- </ul>
767
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
768
- </li>
769
- </ul>
770
- </section>
771
- </section>
772
- </div>
773
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
774
- <nav class="tsd-navigation primary">
775
- <ul>
776
- <li class="globals ">
777
- <a href="../globals.html"><em>Globals</em></a>
778
- </li>
779
- <li class=" tsd-kind-external-module">
780
- <a href="../modules/_authentication_.html">"<wbr>Authentication"</a>
781
- </li>
782
- <li class=" tsd-kind-external-module">
783
- <a href="../modules/_blobbuilder_.html">"<wbr>Blob<wbr>Builder"</a>
784
- </li>
785
- <li class=" tsd-kind-external-module">
786
- <a href="../modules/_contenttypes_.html">"<wbr>Content<wbr>Types"</a>
787
- </li>
788
- <li class="current tsd-kind-external-module">
789
- <a href="../modules/_data_.html">"<wbr>Data"</a>
790
- </li>
791
- <li class=" tsd-kind-external-module">
792
- <a href="../modules/_expression_.html">"<wbr>Expression"</a>
793
- </li>
794
- <li class=" tsd-kind-external-module">
795
- <a href="../modules/_headers_.html">"<wbr>Headers"</a>
796
- </li>
797
- <li class=" tsd-kind-external-module">
798
- <a href="../modules/_httpmethods_.html">"<wbr>Http<wbr>Methods"</a>
799
- </li>
800
- <li class=" tsd-kind-external-module">
801
- <a href="../modules/_orderproperty_.html">"<wbr>Order<wbr>Property"</a>
802
- </li>
803
- <li class=" tsd-kind-external-module">
804
- <a href="../modules/_query_.html">"<wbr>Query"</a>
805
- </li>
806
- <li class=" tsd-kind-external-module">
807
- <a href="../modules/_querybase_.html">"<wbr>Query<wbr>Base"</a>
808
- </li>
809
- <li class=" tsd-kind-external-module">
810
- <a href="../modules/_querybuilder_.html">"<wbr>Query<wbr>Builder"</a>
811
- </li>
812
- <li class=" tsd-kind-external-module">
813
- <a href="../modules/_requests_batchrequest_.html">"<wbr>Requests/<wbr>Batch<wbr>Request"</a>
814
- </li>
815
- <li class=" tsd-kind-external-module">
816
- <a href="../modules/_requests_executablerequest_.html">"<wbr>Requests/<wbr>Executable<wbr>Request"</a>
817
- </li>
818
- <li class=" tsd-kind-external-module">
819
- <a href="../modules/_requests_request_.html">"<wbr>Requests/<wbr>Request"</a>
820
- </li>
821
- <li class=" tsd-kind-external-module">
822
- <a href="../modules/_requests_requestfactory_.html">"<wbr>Requests/<wbr>Request<wbr>Factory"</a>
823
- </li>
824
- <li class=" tsd-kind-external-module">
825
- <a href="../modules/_sitefinity_.html">"<wbr>Sitefinity"</a>
826
- </li>
827
- <li class=" tsd-kind-external-module">
828
- <a href="../modules/_wherequery_.html">"<wbr>Where<wbr>Query"</a>
829
- </li>
830
- <li class=" tsd-kind-external-module">
831
- <a href="../modules/_constants_.html">"constants"</a>
832
- </li>
833
- <li class=" tsd-kind-external-module">
834
- <a href="../modules/_main_.html">"main"</a>
835
- </li>
836
- <li class=" tsd-kind-external-module">
837
- <a href="../modules/_utils_.html">"utils"</a>
838
- </li>
839
- </ul>
840
- </nav>
841
- <nav class="tsd-navigation secondary menu-sticky">
842
- <ul class="before-current">
843
- </ul>
844
- <ul class="current">
845
- <li class="current tsd-kind-class tsd-parent-kind-external-module">
846
- <a href="_data_.data.html" class="tsd-kind-icon">Data</a>
847
- <ul>
848
- <li class=" tsd-kind-constructor tsd-parent-kind-class">
849
- <a href="_data_.data.html#constructor" class="tsd-kind-icon">constructor</a>
850
- </li>
851
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
852
- <a href="_data_.data.html#factory" class="tsd-kind-icon">factory</a>
853
- </li>
854
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
855
- <a href="_data_.data.html#urloptions" class="tsd-kind-icon">url<wbr>Options</a>
856
- </li>
857
- <li class=" tsd-kind-method tsd-parent-kind-class">
858
- <a href="_data_.data.html#create" class="tsd-kind-icon">create</a>
859
- </li>
860
- <li class=" tsd-kind-method tsd-parent-kind-class">
861
- <a href="_data_.data.html#createrelated" class="tsd-kind-icon">create<wbr>Related</a>
862
- </li>
863
- <li class=" tsd-kind-method tsd-parent-kind-class">
864
- <a href="_data_.data.html#destroy" class="tsd-kind-icon">destroy</a>
865
- </li>
866
- <li class=" tsd-kind-method tsd-parent-kind-class">
867
- <a href="_data_.data.html#destroyrelated" class="tsd-kind-icon">destroy<wbr>Related</a>
868
- </li>
869
- <li class=" tsd-kind-method tsd-parent-kind-class">
870
- <a href="_data_.data.html#destroyrelatedbyid" class="tsd-kind-icon">destroy<wbr>Related<wbr>ById</a>
871
- </li>
872
- <li class=" tsd-kind-method tsd-parent-kind-class">
873
- <a href="_data_.data.html#get" class="tsd-kind-icon">get</a>
874
- </li>
875
- <li class=" tsd-kind-method tsd-parent-kind-class">
876
- <a href="_data_.data.html#getoperations" class="tsd-kind-icon">get<wbr>Operations</a>
877
- </li>
878
- <li class=" tsd-kind-method tsd-parent-kind-class">
879
- <a href="_data_.data.html#getproperty" class="tsd-kind-icon">get<wbr>Property</a>
880
- </li>
881
- <li class=" tsd-kind-method tsd-parent-kind-class">
882
- <a href="_data_.data.html#getrelated" class="tsd-kind-icon">get<wbr>Related</a>
883
- </li>
884
- <li class=" tsd-kind-method tsd-parent-kind-class">
885
- <a href="_data_.data.html#getrelatedbyid" class="tsd-kind-icon">get<wbr>Related<wbr>ById</a>
886
- </li>
887
- <li class=" tsd-kind-method tsd-parent-kind-class">
888
- <a href="_data_.data.html#getsingle" class="tsd-kind-icon">get<wbr>Single</a>
889
- </li>
890
- <li class=" tsd-kind-method tsd-parent-kind-class">
891
- <a href="_data_.data.html#operation" class="tsd-kind-icon">operation</a>
892
- </li>
893
- <li class=" tsd-kind-method tsd-parent-kind-class">
894
- <a href="_data_.data.html#update" class="tsd-kind-icon">update</a>
895
- </li>
896
- <li class=" tsd-kind-method tsd-parent-kind-class">
897
- <a href="_data_.data.html#upload" class="tsd-kind-icon">upload</a>
898
- </li>
899
- </ul>
900
- </li>
901
- </ul>
902
- <ul class="after-current">
903
- </ul>
904
- </nav>
905
- </div>
906
- </div>
907
- </div>
908
- <footer class="with-border-bottom">
909
- <div class="container">
910
- <h2>Legend</h2>
911
- <div class="tsd-legend-group">
912
- <ul class="tsd-legend">
913
- <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
914
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
915
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
916
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
917
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
918
- <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
919
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
920
- </ul>
921
- <ul class="tsd-legend">
922
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
923
- <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
924
- <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
925
- <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
926
- </ul>
927
- <ul class="tsd-legend">
928
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
929
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
930
- <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
931
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
932
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
933
- <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
934
- </ul>
935
- <ul class="tsd-legend">
936
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
937
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
938
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
939
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
940
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
941
- <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
942
- <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
943
- </ul>
944
- <ul class="tsd-legend">
945
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
946
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
947
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
948
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
949
- </ul>
950
- <ul class="tsd-legend">
951
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
952
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
953
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
954
- </ul>
955
- <ul class="tsd-legend">
956
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
957
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
958
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
959
- </ul>
960
- <ul class="tsd-legend">
961
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
962
- <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
963
- </ul>
964
- </div>
965
- </div>
966
- </footer>
967
- <div class="container tsd-generator">
968
- <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
969
- </div>
970
- <div class="overlay"></div>
971
- <script src="../assets/js/main.js"></script>
972
- <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
973
- </body>
974
- </html>