-
Notifications
You must be signed in to change notification settings - Fork 34
/
sn_ws.js
149 lines (149 loc) · 3.83 KB
/
sn_ws.js
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
var sn_ws = {
/**
* Instantiates an empty RESTMessageV2 object.
When using an object instantiated without an argument, you must manually specify an HTTP method and endpoint.
WITH an argument;
Instantiates a RESTMessageV2 object using information from a REST message record.
You must have a REST message record defined before you can use this constructor (with an argument)
* @param {string} [name] - The name of the extant REST message defined in the system
* @param {string} [methodName] - The name of the method to use (e.g. "Default GET")
* @constructor
*/
'RESTMessageV2' : function(name, methodName) {
/**
* Send the REST message to the endpoint.
* @returns {RESTResponseV2}
*/
this.execute = function() {};
this.getStatusCode = function() {};
/**
* Send the REST message to the endpoint asynchronously. The instance does not wait for a response from the web service provider when making asynchronous calls.
*/
this.executeAsync = function() {};
/**
* Get the URL of the endpoint for the REST message.
*/
this.getEndpoint = function() {};
/**
* Get the content of the REST message body.
* @returns {string} the REST message body as a string.
*/
this.getRequestBody = function() {};
/**
*
* @param {string} headerName
* @returns {string} the value of the specified header
*/
this.getRequestHeader = function(headerName) {};
/**
* @returns {Object} An Object that maps the name of each header to the associated value.
*/
this.getRequestHeaders = function() {};
/**
*
* @param {string} tableName
* @param {string} recordSysId
* @param {string} fileName
* @param {string} encryptionContext
*/
this.saveResponseBodyAsAttachment = function(tableName, recordSysId, fileName, encryptionContext) {};
/**
*
* @param {string} type
* @param {string} profileId
*/
this.setAuthenticationProfile = function(type, profileId) {};
/**
*
* @param {string} userName
* @param {string} pass
*/
this.setBasicAuth = function(userName, pass) {};
/**
*
* @param {string} correlator
*/
this.setEccCorrelator = function(correlator) {};
/**
*
* @param {string} name - The parameter name (e.g. "skip_sensor").
* @param {string} value - Tha parameter value (e.g. "true").
*/
this.setEccParameter = function(name, value) {};
/**
*
* @param {string} endpoint
*/
this.setEndpoint = function(endpoint) {};
/**
*
* @param {string} method
*/
this.setHttpMethod = function(method) {};
/**
*
* @param {string} timeoutMs
*/
this.setHttpTimeout = function(timeoutMs) {};
/**
*
* @param {string} level
*/
this.setLogLevel = function(level) {};
/**
*
* @param {string} midServerName
*/
this.setMIDServer = function(midServerName) {};
/**
*
* @param {string} profileName
*/
this.setMutualAuth = function(profileName) {};
/**
*
* @param {string} name
* @param {string} value
*/
this.setQueryParameter = function(name, value) {};
/**
*
* @param {string|Object} body
*/
this.setRequestBody = function(body) {};
/**
*
* @param {string} attachmentSysId
*/
this.setRequestBodyFromAttachment = function(attachmentSysId) {};
/**
*
* @param {Object} stream
*/
this.setRequestBodyFromStream = function(stream) {};
/**
*
* @param {string} name
* @param {string} value
*/
this.setRequestHeader = function(name, value) {};
/**
*
* @param {string} requestorContext
* @param {string} requestorId
*/
this.setRequestorProfile = function(requestorContext, requestorId) {};
/**
*
* @param {string} name
* @param {string} value
*/
this.setStringParameter = function(name, value) {};
/**
*
* @param {string} name
* @param {string} value
*/
this.setStringParameterNoEscape = function(name, value) {};
}
}