@progress/sitefinity-webservices-sdk 0.3.0 → 1.0.2

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 +1140 -1734
  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 +68 -83
  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 +108 -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/config/html.conf.json +0 -5
  139. package/dist/docs/assets/css/main.css +0 -865
  140. package/dist/docs/assets/css/main.css.map +0 -7
  141. package/dist/docs/assets/images/icons.png +0 -0
  142. package/dist/docs/assets/images/icons@2x.png +0 -0
  143. package/dist/docs/assets/js/main.js +0 -5
  144. package/dist/docs/assets/js/search.js +0 -3
  145. package/dist/docs/classes/_authentication_.authentication.html +0 -527
  146. package/dist/docs/classes/_blobbuilder_.blobbuilder.html +0 -351
  147. package/dist/docs/classes/_data_.data.html +0 -974
  148. package/dist/docs/classes/_expression_.binaryexpression.html +0 -450
  149. package/dist/docs/classes/_expression_.complexexpression.html +0 -374
  150. package/dist/docs/classes/_expression_.expressionbase.html +0 -336
  151. package/dist/docs/classes/_orderproperty_.orderproperty.html +0 -381
  152. package/dist/docs/classes/_query_.query.html +0 -896
  153. package/dist/docs/classes/_querybase_.querybase.html +0 -518
  154. package/dist/docs/classes/_querybuilder_.querybuilder.html +0 -493
  155. package/dist/docs/classes/_requests_batchrequest_.batchrequest.html +0 -1511
  156. package/dist/docs/classes/_requests_batchrequest_.transaction.html +0 -804
  157. package/dist/docs/classes/_requests_executablerequest_.executablerequest.html +0 -549
  158. package/dist/docs/classes/_requests_request_.createrelatedrequest.html +0 -689
  159. package/dist/docs/classes/_requests_request_.createrequest.html +0 -680
  160. package/dist/docs/classes/_requests_request_.deleterelatedbyidrequest.html +0 -687
  161. package/dist/docs/classes/_requests_request_.deleterelatedrequest.html +0 -673
  162. package/dist/docs/classes/_requests_request_.deleterequest.html +0 -666
  163. package/dist/docs/classes/_requests_request_.getbyidrequest.html +0 -666
  164. package/dist/docs/classes/_requests_request_.getrelatedbyidrequest.html +0 -687
  165. package/dist/docs/classes/_requests_request_.getrelatedrequest.html +0 -673
  166. package/dist/docs/classes/_requests_request_.getrequest.html +0 -658
  167. package/dist/docs/classes/_requests_request_.requestbase.html +0 -687
  168. package/dist/docs/classes/_requests_request_.updaterequest.html +0 -686
  169. package/dist/docs/classes/_requests_request_.uploadrequest.html +0 -715
  170. package/dist/docs/classes/_requests_requestfactory_.requestfactory.html +0 -724
  171. package/dist/docs/classes/_sitefinity_.sitefinity.html +0 -521
  172. package/dist/docs/classes/_utils_.utils.html +0 -597
  173. package/dist/docs/classes/_wherequery_.wherequery.html +0 -992
  174. package/dist/docs/globals.html +0 -238
  175. package/dist/docs/modules/_authentication_.html +0 -225
  176. package/dist/docs/modules/_blobbuilder_.html +0 -225
  177. package/dist/docs/modules/_constants_.html +0 -528
  178. package/dist/docs/modules/_contenttypes_.html +0 -248
  179. package/dist/docs/modules/_data_.html +0 -225
  180. package/dist/docs/modules/_expression_.html +0 -233
  181. package/dist/docs/modules/_headers_.html +0 -328
  182. package/dist/docs/modules/_httpmethods_.html +0 -288
  183. package/dist/docs/modules/_main_.html +0 -209
  184. package/dist/docs/modules/_orderproperty_.html +0 -225
  185. package/dist/docs/modules/_query_.html +0 -225
  186. package/dist/docs/modules/_querybase_.html +0 -225
  187. package/dist/docs/modules/_querybuilder_.html +0 -247
  188. package/dist/docs/modules/_requests_batchrequest_.html +0 -265
  189. package/dist/docs/modules/_requests_executablerequest_.html +0 -296
  190. package/dist/docs/modules/_requests_request_.html +0 -333
  191. package/dist/docs/modules/_requests_requestfactory_.html +0 -247
  192. package/dist/docs/modules/_sitefinity_.html +0 -225
  193. package/dist/docs/modules/_utils_.html +0 -225
  194. package/dist/docs/modules/_wherequery_.html +0 -247
  195. package/dist/index.html +0 -474
  196. package/src/Authentication.ts +0 -96
  197. package/src/ContentTypes.ts +0 -5
  198. package/src/Headers.ts +0 -12
  199. package/src/HttpMethods.ts +0 -9
  200. package/src/main.ts +0 -2
  201. package/version.txt +0 -1
package/dist/docs/classes/_authentication_.authentication.html DELETED
@@ -1,527 +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>Authentication | @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/_authentication_.html">&quot;Authentication&quot;</a>
58
- </li>
59
- <li>
60
- <a href="_authentication_.authentication.html">Authentication</a>
61
- </li>
62
- </ul>
63
- <h1>Class Authentication</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>Authentication</p>
75
- </dd>
76
- <dt>classdesc</dt>
77
- <dd><p>The constructor of the Authentication object. This object is used for authenticating a user to Sitefinity.</p>
78
- </dd>
79
- <dt>param</dt>
80
- <dd><p>An object containing configuration options for the <a href="_authentication_.authentication.html">Authentication</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
- </dl>
86
- </div>
87
- </section>
88
- <section class="tsd-panel tsd-hierarchy">
89
- <h3>Hierarchy</h3>
90
- <ul class="tsd-hierarchy">
91
- <li>
92
- <span class="target">Authentication</span>
93
- </li>
94
- </ul>
95
- </section>
96
- <section class="tsd-panel-group tsd-index-group">
97
- <h2>Index</h2>
98
- <section class="tsd-panel tsd-index-panel">
99
- <div class="tsd-index-content">
100
- <section class="tsd-index-section ">
101
- <h3>Constructors</h3>
102
- <ul class="tsd-index-list">
103
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_authentication_.authentication.html#constructor" class="tsd-kind-icon">constructor</a></li>
104
- </ul>
105
- </section>
106
- <section class="tsd-index-section tsd-is-private tsd-is-private-protected">
107
- <h3>Properties</h3>
108
- <ul class="tsd-index-list">
109
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_authentication_.authentication.html#_serviceurl" class="tsd-kind-icon">_service<wbr>Url</a></li>
110
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_authentication_.authentication.html#_token" class="tsd-kind-icon">_token</a></li>
111
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_authentication_.authentication.html#factory" class="tsd-kind-icon">factory</a></li>
112
- </ul>
113
- </section>
114
- <section class="tsd-index-section ">
115
- <h3>Methods</h3>
116
- <ul class="tsd-index-list">
117
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_authentication_.authentication.html#gettoken" class="tsd-kind-icon">get<wbr>Token</a></li>
118
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_authentication_.authentication.html#login" class="tsd-kind-icon">login</a></li>
119
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_authentication_.authentication.html#logout" class="tsd-kind-icon">logout</a></li>
120
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="_authentication_.authentication.html#settoken" class="tsd-kind-icon">set<wbr>Token</a></li>
121
- </ul>
122
- </section>
123
- </div>
124
- </section>
125
- </section>
126
- <section class="tsd-panel-group tsd-member-group ">
127
- <h2>Constructors</h2>
128
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
129
- <a name="constructor" class="tsd-anchor"></a>
130
- <h3>constructor</h3>
131
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
132
- <li class="tsd-signature tsd-kind-icon">new <wbr>Authentication<span class="tsd-signature-symbol">(</span>options<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="_authentication_.authentication.html" class="tsd-signature-type">Authentication</a></li>
133
- </ul>
134
- <ul class="tsd-descriptions">
135
- <li class="tsd-description">
136
- <aside class="tsd-sources">
137
- <ul>
138
- <li>Defined in Authentication.ts:10</li>
139
- </ul>
140
- </aside>
141
- <h4 class="tsd-parameters-title">Parameters</h4>
142
- <ul class="tsd-parameters">
143
- <li>
144
- <h5>options: <span class="tsd-signature-type">any</span></h5>
145
- </li>
146
- </ul>
147
- <h4 class="tsd-returns-title">Returns <a href="_authentication_.authentication.html" class="tsd-signature-type">Authentication</a></h4>
148
- </li>
149
- </ul>
150
- </section>
151
- </section>
152
- <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
153
- <h2>Properties</h2>
154
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
155
- <a name="_serviceurl" class="tsd-anchor"></a>
156
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> _service<wbr>Url</h3>
157
- <div class="tsd-signature tsd-kind-icon">_service<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
158
- <aside class="tsd-sources">
159
- <ul>
160
- <li>Defined in Authentication.ts:9</li>
161
- </ul>
162
- </aside>
163
- </section>
164
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
165
- <a name="_token" class="tsd-anchor"></a>
166
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> _token</h3>
167
- <div class="tsd-signature tsd-kind-icon">_token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
168
- <aside class="tsd-sources">
169
- <ul>
170
- <li>Defined in Authentication.ts:8</li>
171
- </ul>
172
- </aside>
173
- </section>
174
- <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
175
- <a name="factory" class="tsd-anchor"></a>
176
- <h3><span class="tsd-flag ts-flagPrivate">Private</span> factory</h3>
177
- <div class="tsd-signature tsd-kind-icon">factory<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
178
- <aside class="tsd-sources">
179
- <ul>
180
- <li>Defined in Authentication.ts:10</li>
181
- </ul>
182
- </aside>
183
- </section>
184
- </section>
185
- <section class="tsd-panel-group tsd-member-group ">
186
- <h2>Methods</h2>
187
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
188
- <a name="gettoken" class="tsd-anchor"></a>
189
- <h3>get<wbr>Token</h3>
190
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
191
- <li class="tsd-signature tsd-kind-icon">get<wbr>Token<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
192
- </ul>
193
- <ul class="tsd-descriptions">
194
- <li class="tsd-description">
195
- <aside class="tsd-sources">
196
- <ul>
197
- <li>Defined in Authentication.ts:93</li>
198
- </ul>
199
- </aside>
200
- <div class="tsd-comment tsd-typography">
201
- <div class="lead">
202
- <p>Gets the authentication token.</p>
203
- </div>
204
- <dl class="tsd-comment-tags">
205
- <dt>memberof</dt>
206
- <dd><p>Authentication</p>
207
- </dd>
208
- <dt>instance</dt>
209
- <dd></dd>
210
- </dl>
211
- </div>
212
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
213
- </li>
214
- </ul>
215
- </section>
216
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
217
- <a name="login" class="tsd-anchor"></a>
218
- <h3>login</h3>
219
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
220
- <li class="tsd-signature tsd-kind-icon">login<span class="tsd-signature-symbol">(</span>username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, success<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, failure<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>
221
- </ul>
222
- <ul class="tsd-descriptions">
223
- <li class="tsd-description">
224
- <aside class="tsd-sources">
225
- <ul>
226
- <li>Defined in Authentication.ts:30</li>
227
- </ul>
228
- </aside>
229
- <div class="tsd-comment tsd-typography">
230
- <div class="lead">
231
- <p>Logins the user. A service call is made to login the user. If the call is successful and the service returns a token, this token is cached in the <a href="_authentication_.authentication.html">Authentication</a> object.</p>
232
- </div>
233
- <dl class="tsd-comment-tags">
234
- <dt>memberof</dt>
235
- <dd><p>Authentication</p>
236
- </dd>
237
- <dt>instance</dt>
238
- <dd></dd>
239
- <dt>deprecated</dt>
240
- <dd><p>This method is deprecated and should not be used with versions of sitefinity &gt;= 10.0</p>
241
- </dd>
242
- <dt>example</dt>
243
- <dd><p>sf.authentication.login(&quot;username&quot;, &quot;password&quot;, successCb, failureCb);</p>
244
- </dd>
245
- </dl>
246
- </div>
247
- <h4 class="tsd-parameters-title">Parameters</h4>
248
- <ul class="tsd-parameters">
249
- <li>
250
- <h5>username: <span class="tsd-signature-type">string</span></h5>
251
- <div class="tsd-comment tsd-typography">
252
- <p>The username.</p>
253
- </div>
254
- </li>
255
- <li>
256
- <h5>password: <span class="tsd-signature-type">string</span></h5>
257
- <div class="tsd-comment tsd-typography">
258
- <p>The password.</p>
259
- </div>
260
- </li>
261
- <li>
262
- <h5>success: <span class="tsd-signature-type">any</span></h5>
263
- </li>
264
- <li>
265
- <h5>failure: <span class="tsd-signature-type">any</span></h5>
266
- </li>
267
- </ul>
268
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
269
- </li>
270
- </ul>
271
- </section>
272
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
273
- <a name="logout" class="tsd-anchor"></a>
274
- <h3>logout</h3>
275
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
276
- <li class="tsd-signature tsd-kind-icon">logout<span class="tsd-signature-symbol">(</span>success<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, failure<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>
277
- </ul>
278
- <ul class="tsd-descriptions">
279
- <li class="tsd-description">
280
- <aside class="tsd-sources">
281
- <ul>
282
- <li>Defined in Authentication.ts:59</li>
283
- </ul>
284
- </aside>
285
- <div class="tsd-comment tsd-typography">
286
- <div class="lead">
287
- <p>Logouts the user.</p>
288
- </div>
289
- <dl class="tsd-comment-tags">
290
- <dt>memberof</dt>
291
- <dd><p>Authentication</p>
292
- </dd>
293
- <dt>instance</dt>
294
- <dd></dd>
295
- <dt>deprecated</dt>
296
- <dd><p>This method is deprecated and should not be used with versions of sitefinity &gt;= 10.0</p>
297
- </dd>
298
- </dl>
299
- </div>
300
- <h4 class="tsd-parameters-title">Parameters</h4>
301
- <ul class="tsd-parameters">
302
- <li>
303
- <h5>success: <span class="tsd-signature-type">any</span></h5>
304
- </li>
305
- <li>
306
- <h5>failure: <span class="tsd-signature-type">any</span></h5>
307
- </li>
308
- </ul>
309
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
310
- </li>
311
- </ul>
312
- </section>
313
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
314
- <a name="settoken" class="tsd-anchor"></a>
315
- <h3>set<wbr>Token</h3>
316
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
317
- <li class="tsd-signature tsd-kind-icon">set<wbr>Token<span class="tsd-signature-symbol">(</span>token<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>
318
- </ul>
319
- <ul class="tsd-descriptions">
320
- <li class="tsd-description">
321
- <aside class="tsd-sources">
322
- <ul>
323
- <li>Defined in Authentication.ts:83</li>
324
- </ul>
325
- </aside>
326
- <div class="tsd-comment tsd-typography">
327
- <div class="lead">
328
- <p>Sets the authentication token.</p>
329
- </div>
330
- <dl class="tsd-comment-tags">
331
- <dt>memberof</dt>
332
- <dd><p>Authentication</p>
333
- </dd>
334
- <dt>instance</dt>
335
- <dd></dd>
336
- </dl>
337
- </div>
338
- <h4 class="tsd-parameters-title">Parameters</h4>
339
- <ul class="tsd-parameters">
340
- <li>
341
- <h5>token: <span class="tsd-signature-type">any</span></h5>
342
- <div class="tsd-comment tsd-typography">
343
- <p>The token, which will be used for authentication.</p>
344
- </div>
345
- </li>
346
- </ul>
347
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
348
- </li>
349
- </ul>
350
- </section>
351
- </section>
352
- </div>
353
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
354
- <nav class="tsd-navigation primary">
355
- <ul>
356
- <li class="globals ">
357
- <a href="../globals.html"><em>Globals</em></a>
358
- </li>
359
- <li class="current tsd-kind-external-module">
360
- <a href="../modules/_authentication_.html">"<wbr>Authentication"</a>
361
- </li>
362
- <li class=" tsd-kind-external-module">
363
- <a href="../modules/_blobbuilder_.html">"<wbr>Blob<wbr>Builder"</a>
364
- </li>
365
- <li class=" tsd-kind-external-module">
366
- <a href="../modules/_contenttypes_.html">"<wbr>Content<wbr>Types"</a>
367
- </li>
368
- <li class=" tsd-kind-external-module">
369
- <a href="../modules/_data_.html">"<wbr>Data"</a>
370
- </li>
371
- <li class=" tsd-kind-external-module">
372
- <a href="../modules/_expression_.html">"<wbr>Expression"</a>
373
- </li>
374
- <li class=" tsd-kind-external-module">
375
- <a href="../modules/_headers_.html">"<wbr>Headers"</a>
376
- </li>
377
- <li class=" tsd-kind-external-module">
378
- <a href="../modules/_httpmethods_.html">"<wbr>Http<wbr>Methods"</a>
379
- </li>
380
- <li class=" tsd-kind-external-module">
381
- <a href="../modules/_orderproperty_.html">"<wbr>Order<wbr>Property"</a>
382
- </li>
383
- <li class=" tsd-kind-external-module">
384
- <a href="../modules/_query_.html">"<wbr>Query"</a>
385
- </li>
386
- <li class=" tsd-kind-external-module">
387
- <a href="../modules/_querybase_.html">"<wbr>Query<wbr>Base"</a>
388
- </li>
389
- <li class=" tsd-kind-external-module">
390
- <a href="../modules/_querybuilder_.html">"<wbr>Query<wbr>Builder"</a>
391
- </li>
392
- <li class=" tsd-kind-external-module">
393
- <a href="../modules/_requests_batchrequest_.html">"<wbr>Requests/<wbr>Batch<wbr>Request"</a>
394
- </li>
395
- <li class=" tsd-kind-external-module">
396
- <a href="../modules/_requests_executablerequest_.html">"<wbr>Requests/<wbr>Executable<wbr>Request"</a>
397
- </li>
398
- <li class=" tsd-kind-external-module">
399
- <a href="../modules/_requests_request_.html">"<wbr>Requests/<wbr>Request"</a>
400
- </li>
401
- <li class=" tsd-kind-external-module">
402
- <a href="../modules/_requests_requestfactory_.html">"<wbr>Requests/<wbr>Request<wbr>Factory"</a>
403
- </li>
404
- <li class=" tsd-kind-external-module">
405
- <a href="../modules/_sitefinity_.html">"<wbr>Sitefinity"</a>
406
- </li>
407
- <li class=" tsd-kind-external-module">
408
- <a href="../modules/_wherequery_.html">"<wbr>Where<wbr>Query"</a>
409
- </li>
410
- <li class=" tsd-kind-external-module">
411
- <a href="../modules/_constants_.html">"constants"</a>
412
- </li>
413
- <li class=" tsd-kind-external-module">
414
- <a href="../modules/_main_.html">"main"</a>
415
- </li>
416
- <li class=" tsd-kind-external-module">
417
- <a href="../modules/_utils_.html">"utils"</a>
418
- </li>
419
- </ul>
420
- </nav>
421
- <nav class="tsd-navigation secondary menu-sticky">
422
- <ul class="before-current">
423
- </ul>
424
- <ul class="current">
425
- <li class="current tsd-kind-class tsd-parent-kind-external-module">
426
- <a href="_authentication_.authentication.html" class="tsd-kind-icon">Authentication</a>
427
- <ul>
428
- <li class=" tsd-kind-constructor tsd-parent-kind-class">
429
- <a href="_authentication_.authentication.html#constructor" class="tsd-kind-icon">constructor</a>
430
- </li>
431
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
432
- <a href="_authentication_.authentication.html#_serviceurl" class="tsd-kind-icon">_service<wbr>Url</a>
433
- </li>
434
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
435
- <a href="_authentication_.authentication.html#_token" class="tsd-kind-icon">_token</a>
436
- </li>
437
- <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
438
- <a href="_authentication_.authentication.html#factory" class="tsd-kind-icon">factory</a>
439
- </li>
440
- <li class=" tsd-kind-method tsd-parent-kind-class">
441
- <a href="_authentication_.authentication.html#gettoken" class="tsd-kind-icon">get<wbr>Token</a>
442
- </li>
443
- <li class=" tsd-kind-method tsd-parent-kind-class">
444
- <a href="_authentication_.authentication.html#login" class="tsd-kind-icon">login</a>
445
- </li>
446
- <li class=" tsd-kind-method tsd-parent-kind-class">
447
- <a href="_authentication_.authentication.html#logout" class="tsd-kind-icon">logout</a>
448
- </li>
449
- <li class=" tsd-kind-method tsd-parent-kind-class">
450
- <a href="_authentication_.authentication.html#settoken" class="tsd-kind-icon">set<wbr>Token</a>
451
- </li>
452
- </ul>
453
- </li>
454
- </ul>
455
- <ul class="after-current">
456
- </ul>
457
- </nav>
458
- </div>
459
- </div>
460
- </div>
461
- <footer class="with-border-bottom">
462
- <div class="container">
463
- <h2>Legend</h2>
464
- <div class="tsd-legend-group">
465
- <ul class="tsd-legend">
466
- <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
467
- <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
468
- <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
469
- <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
470
- <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
471
- <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
472
- <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
473
- </ul>
474
- <ul class="tsd-legend">
475
- <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
476
- <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
477
- <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
478
- <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
479
- </ul>
480
- <ul class="tsd-legend">
481
- <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
482
- <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
483
- <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
484
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
485
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
486
- <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
487
- </ul>
488
- <ul class="tsd-legend">
489
- <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
490
- <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
491
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
492
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
493
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
494
- <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
495
- <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
496
- </ul>
497
- <ul class="tsd-legend">
498
- <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
499
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
500
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
501
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
502
- </ul>
503
- <ul class="tsd-legend">
504
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
505
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
506
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
507
- </ul>
508
- <ul class="tsd-legend">
509
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
510
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
511
- <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
512
- </ul>
513
- <ul class="tsd-legend">
514
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
515
- <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
516
- </ul>
517
- </div>
518
- </div>
519
- </footer>
520
- <div class="container tsd-generator">
521
- <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
522
- </div>
523
- <div class="overlay"></div>
524
- <script src="../assets/js/main.js"></script>
525
- <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
526
- </body>
527
- </html>