-
Notifications
You must be signed in to change notification settings - Fork 28
/
Copy pathWebApiClient.BatchRequest.js.html
159 lines (116 loc) · 6.98 KB
/
WebApiClient.BatchRequest.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>WebApiClient.BatchRequest.js - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="module-WebApiClient.Batch.html">Batch</a><ul class='methods'><li data-type='method'><a href="module-WebApiClient.Batch.html#buildPayload">buildPayload</a></li></ul></li><li><a href="module-WebApiClient.BatchRequest.html">BatchRequest</a><ul class='methods'><li data-type='method'><a href="module-WebApiClient.BatchRequest.html#stringify">stringify</a></li></ul></li><li><a href="module-WebApiClient.BatchResponse.html">BatchResponse</a></li><li><a href="module-WebApiClient.ChangeSet.html">ChangeSet</a><ul class='methods'><li data-type='method'><a href="module-WebApiClient.ChangeSet.html#stringify">stringify</a></li></ul></li><li><a href="module-WebApiClient.Response.html">Response</a></li><li><a href="WebApiClient.Promise.html">Promise</a></li><li><a href="WebApiClient.Requests.Request.html">Request</a></li></ul><h3>Modules</h3><ul><li><a href="module-Requests.html">Requests</a><ul class='methods'><li data-type='method'><a href="module-Requests.html#.Requests.Request#with">Requests.Request#with</a></li></ul></li><li><a href="module-WebApiClient.html">WebApiClient</a><ul class='methods'><li data-type='method'><a href="module-WebApiClient.html#.AppendToDefaultHeaders">AppendToDefaultHeaders</a></li><li data-type='method'><a href="module-WebApiClient.html#.Associate">Associate</a></li><li data-type='method'><a href="module-WebApiClient.html#.Configure">Configure</a></li><li data-type='method'><a href="module-WebApiClient.html#.Create">Create</a></li><li data-type='method'><a href="module-WebApiClient.html#.Delete">Delete</a></li><li data-type='method'><a href="module-WebApiClient.html#.Disassociate">Disassociate</a></li><li data-type='method'><a href="module-WebApiClient.html#.Execute">Execute</a></li><li data-type='method'><a href="module-WebApiClient.html#.Expand">Expand</a></li><li data-type='method'><a href="module-WebApiClient.html#.GetApiUrl">GetApiUrl</a></li><li data-type='method'><a href="module-WebApiClient.html#.GetDefaultHeaders">GetDefaultHeaders</a></li><li data-type='method'><a href="module-WebApiClient.html#.GetSetName">GetSetName</a></li><li data-type='method'><a href="module-WebApiClient.html#.Retrieve">Retrieve</a></li><li data-type='method'><a href="module-WebApiClient.html#.SendBatch">SendBatch</a></li><li data-type='method'><a href="module-WebApiClient.html#.SendRequest">SendRequest</a></li><li data-type='method'><a href="module-WebApiClient.html#.Update">Update</a></li></ul></li></ul>
</nav>
<div id="main">
<h1 class="page-title">WebApiClient.BatchRequest.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>(function(undefined) {
"use strict";
/**
* Request used inside batches, used for all HTTP methods
* @constructor
* @see https://msdn.microsoft.com/en-us/library/mt607719.aspx#bkmk_BatchRequests
* @param {Object} parameters
* @param {String} parameters.method The HTTP method such as GET, POST, ... for this request
* @param {String} parameters.url The url used for this request
* @param {Object} [parameters.payload] The request body for this request. Will be stringified and embedded.
* @param {Array<{key:string,value:string}>} [parameters.headers] Headers to append to this request
* @param {String} parameters.contentId Content ID to set for this request
* @memberof module:WebApiClient
*/
var BatchRequest = function (parameters) {
var params = parameters || {};
/**
* @property {String} method - Method of the request such as GET, POST, ...
* @this {BatchRequest}
*/
this.method = params.method;
/**
* @property {String} url - URL for this request
* @this {BatchRequest}
*/
this.url = params.url;
/**
* @property {Object} payload - Payload to send with this request
* @this {BatchRequest}
*/
this.payload = params.payload;
/**
* @property {Array<{key: string, value:string}>} headers - Headers to append to this request
* @this {BatchRequest}
*/
this.headers = params.headers || [];
/**
* @property {String} contentId - Content ID for this request. Will be set on the responses as well, to match responses with requests
* @this {BatchRequest}
*/
this.contentId = params.contentId;
};
/**
* @description Converts current batch request into a string representation for including in the batch body
* @return {String}
* @this {BatchRequest}
*/
BatchRequest.prototype.stringify = function () {
var payload = "";
if (this.contentId) {
payload += "Content-ID: " + this.contentId + "\n\n";
}
payload += this.method + " " + this.url + " HTTP/1.1\n";
for (var i = 0; i < this.headers.length; i++) {
var header = this.headers[i];
if (["accept", "content-type"].indexOf(header.key.toLowerCase()) === -1) {
payload += header.key + ": " + header.value + "\n";
}
}
if (this.method.toLowerCase() === "get") {
payload += "Accept: application/json\n\n";
} else {
payload += "Content-Type: application/json;type=entry\n\n";
}
if (this.payload) {
payload += JSON.stringify(this.payload);
}
else if (this.method.toLowerCase() === "delete") {
// Delete requests need an empty payload, pass it if not already set
payload += JSON.stringify({});
}
return payload;
};
module.exports = BatchRequest;
} ());
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sat Nov 06 2021 00:44:45 GMT+0100 (Mitteleuropäische Normalzeit) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>
</body>
</html>