forked from developerforce/Force.com-JavaScript-REST-Toolkit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathforcetk.js
More file actions
229 lines (210 loc) · 9.37 KB
/
Copy pathforcetk.js
File metadata and controls
229 lines (210 loc) · 9.37 KB
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
/*
* Copyright (c) 2011, salesforce.com, inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided
* that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the
* following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or other materials provided with the distribution.
*
* Neither the name of salesforce.com, inc. nor the names of its contributors may be used to endorse or
* promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/* JavaScript library to wrap REST API on Visualforce. Leverages Ajax Proxy
* (see http://bit.ly/sforce_ajax_proxy for details).
*
* Note that you must add the REST endpoint hostname for your instance (i.e.
* https://na1.salesforce.com/ or similar) as a remote site - in the admin
* console, go to Your Name | Setup | Security Controls | Remote Site Settings
*/
var forcetk = window.forcetk;
if (forcetk === undefined) {
forcetk = {};
}
if (forcetk.Client === undefined) {
// We use $j rather than $ for jQuery so it works in Visualforce
if (window.$j === undefined) {
$j = $;
}
/**
* The Client provides a convenient wrapper for the Force.com REST API,
* allowing JavaScript in Visualforce pages to use the API via the Ajax
* Proxy.
* @param sessionId a salesforce.com session ID. In a Visualforce page,
* use '{!$Api.sessionId}' to obtain a session ID.
* @param [apiVersion="21.0"] Force.com API version
* @constructor
*/
forcetk.Client = function(sessionId, apiVersion, instanceUrl, proxyUrl) {
this.sessionId = sessionId;
this.apiVersion = (typeof apiVersion === 'undefined' || apiVersion == null)
? 'v21.0' : apiVersion;
if (typeof instanceUrl === 'undefined' || instanceUrl == null) {
// location.hostname can be of the form 'abc.na1.visual.force.com' or
// 'na1.salesforce.com'. Split on '.', and take the [1] or [0] element
// as appropriate
var elements = location.hostname.split(".");
var instance = (elements.length == 3) ? elements[0] : elements[1];
this.instance_url = "https://"+instance+".salesforce.com";
} else {
this.instance_url = instanceUrl;
}
if (typeof proxyUrl === 'undefined' || proxyUrl == null) {
this.proxy_url = location.protocol + "//" + location.hostname
+ "/services/proxy";
} else {
this.proxy_url = proxyUrl;
}
}
/*
* Low level utility function to call the Salesforce proxy endpoint.
* @param path resource path relative to /services/data
* @param callback function to which response will be passed
* @param [method="GET"] HTTP method for call
* @param [payload=null] payload for POST/PATCH etc
*/
forcetk.Client.prototype.proxyAjax = function(path, callback, method, payload) {
var url = this.instance_url + '/services/data' + path;
var sessionId = this.sessionId;
$j.ajax({
type: (typeof method === 'undefined' || method == null)
? "GET" : method,
url: this.proxy_url,
contentType: 'application/json',
processData: false,
data: (typeof payload === 'undefined' || payload == null)
? null : payload,
success: callback,
dataType: "json",
beforeSend: function(xhr) {
xhr.setRequestHeader('SalesforceProxy-Endpoint', url);
xhr.setRequestHeader("Authorization", "OAuth " + sessionId);
}
});
}
/*
* Lists summary information about each Salesforce.com version currently
* available, including the version, label, and a link to each version's
* root.
* @param callback function to which response will be passed
*/
forcetk.Client.prototype.versions = function(callback) {
this.proxyAjax('/', callback);
}
/*
* Lists available resources for the client's API version, including
* resource name and URI.
* @param callback function to which response will be passed
*/
forcetk.Client.prototype.resources = function(callback) {
this.proxyAjax('/' + this.apiVersion + '/', callback);
}
/*
* Lists the available objects and their metadata for your organization's
* data.
* @param callback function to which response will be passed
*/
forcetk.Client.prototype.describeGlobal = function(callback) {
this.proxyAjax('/' + this.apiVersion + '/sobjects/', callback);
}
/*
* Describes the individual metadata for the specified object.
* @param objtype object type; e.g. "Account"
* @param callback function to which response will be passed
*/
forcetk.Client.prototype.metadata = function(objtype, callback) {
this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype + '/'
, callback);
}
/*
* Completely describes the individual metadata at all levels for the
* specified object.
* @param objtype object type; e.g. "Account"
* @param callback function to which response will be passed
*/
forcetk.Client.prototype.describe = function(objtype, callback) {
this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype
+ '/describe/', callback);
}
/*
* Creates a new record of the given type.
* @param objtype object type; e.g. "Account"
* @param fields an object containing initial field names and values for
* the record, e.g. {:Name "salesforce.com", :TickerSymbol
* "CRM"}
* @param callback function to which response will be passed
*/
forcetk.Client.prototype.create = function(objtype, fields, callback) {
this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype + '/'
, callback, "POST", JSON.stringify(fields));
}
/*
* Retrieves field values for a record of the given type.
* @param objtype object type; e.g. "Account"
* @param id the record's object ID
* @param fields comma-separated list of fields for which to return
* values; e.g. Name,Industry,TickerSymbol
* @param callback function to which response will be passed
*/
forcetk.Client.prototype.retrieve = function(objtype, id, fieldlist, callback) {
this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype + '/' + id
+ '?fields=' + fieldlist, callback);
}
/*
* Updates field values on a record of the given type.
* @param objtype object type; e.g. "Account"
* @param id the record's object ID
* @param fields an object containing initial field names and values for
* the record, e.g. {:Name "salesforce.com", :TickerSymbol
* "CRM"}
* @param callback function to which response will be passed
*/
forcetk.Client.prototype.update = function(objtype, id, fields, callback) {
this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype + '/' + id
, callback, "PATCH", JSON.stringify(fields));
}
/*
* Deletes a record of the given type. Unfortunately, 'delete' is a
* reserved word in JavaScript.
* @param objtype object type; e.g. "Account"
* @param id the record's object ID
* @param callback function to which response will be passed
*/
forcetk.Client.prototype.del = function(objtype, id, callback) {
this.proxyAjax('/' + this.apiVersion + '/sobjects/' + objtype + '/' + id
, callback, "DELETE");
}
/*
* Executes the specified SOQL query.
* @param soql a string containing the query to execute - e.g. "SELECT Id,
* Name from Account ORDER BY Name LIMIT 20"
* @param callback function to which response will be passed
*/
forcetk.Client.prototype.query = function(soql, callback) {
this.proxyAjax('/' + this.apiVersion + '/query?q=' + escape(soql)
, callback);
}
/*
* Executes the specified SOSL search.
* @param sosl a string containing the search to execute - e.g. "FIND
* {needle}"
* @param callback function to which response will be passed
*/
forcetk.Client.prototype.search = function(sosl, callback) {
this.proxyAjax('/' + this.apiVersion + '/search?s=' + escape(sosl)
, callback);
}
}