FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
Force.com-JavaScript-REST-Toolkit/forcetk.js at patch-1 · Shedal/Force.com-JavaScript-REST-Toolkit · GitHub
Shedal
/
Force.com-JavaScript-REST-Toolkit
Public
forked from
developerforce/Force.com-JavaScript-REST-Toolkit
Notifications
You must be signed in to change notification settings
Fork
0
Star
1
Code
Pull requests
0
Actions
Projects
Wiki
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
Force.com-JavaScript-REST-Toolkit
/
forcetk.js
Copy path
More file actions
More file actions
Latest commit
History
History
History
338 lines (315 loc) · 14.4 KB
Breadcrumbs
Force.com-JavaScript-REST-Toolkit
/
forcetk.js
Copy path
File metadata and controls
338 lines (315 loc) · 14.4 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
/*
* 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
[clientId=null] 'Consumer Key' in the Remote Access app settings
*
@param
[loginUrl='https://login.salesforce.com/'] Login endpoint
*
@param
[proxyUrl=null] Proxy URL. Omit if running on Visualforce or
* PhoneGap etc
*
@constructor
*/
forcetk
.
Client
=
function
(
clientId
,
loginUrl
,
proxyUrl
)
{
this
.
clientId
=
clientId
;
this
.
loginUrl
=
loginUrl
||
'https://login.salesforce.com/'
;
if
(
typeof
proxyUrl
===
'undefined'
||
proxyUrl
===
null
)
{
if
(
location
.
protocol
===
'file:'
)
{
// In PhoneGap
this
.
proxyUrl
=
null
;
}
else
{
// In Visualforce
this
.
proxyUrl
=
location
.
protocol
+
"//"
+
location
.
hostname
+
"/services/proxy"
;
}
this
.
authzHeader
=
"Authorization"
;
}
else
{
// On a server outside VF
this
.
proxyUrl
=
proxyUrl
;
this
.
authzHeader
=
"X-Authorization"
;
}
this
.
refreshToken
=
null
;
this
.
sessionId
=
null
;
this
.
apiVersion
=
null
;
this
.
instanceUrl
=
null
;
this
.
asyncAjax
=
true
;
}
/**
* Set a refresh token in the client.
*
@param
refreshToken an OAuth refresh token
*/
forcetk
.
Client
.
prototype
.
setRefreshToken
=
function
(
refreshToken
)
{
this
.
refreshToken
=
refreshToken
;
}
/**
* Refresh the access token.
*
@param
callback function to call on success
*
@param
error function to call on failure
*/
forcetk
.
Client
.
prototype
.
refreshAccessToken
=
function
(
callback
,
error
)
{
var
that
=
this
;
var
url
=
this
.
loginUrl
+
'/services/oauth2/token'
;
$j
.
ajax
(
{
type
:
'POST'
,
url
:
(
this
.
proxyUrl
!==
null
)
?
this
.
proxyUrl
:
url
,
processData
:
false
,
data
:
'grant_type=refresh_token&client_id='
+
this
.
clientId
+
'&refresh_token='
+
this
.
refreshToken
,
success
:
callback
,
error
:
error
,
dataType
:
"json"
,
beforeSend
:
function
(
xhr
)
{
if
(
that
.
proxyUrl
!==
null
)
{
xhr
.
setRequestHeader
(
'SalesforceProxy-Endpoint'
,
url
)
;
}
}
}
)
;
}
/**
* Set a session token and the associated metadata in the client.
*
@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
*
@param
[instanceUrl] Omit this if running on Visualforce; otherwise
* use the value from the OAuth token.
*/
forcetk
.
Client
.
prototype
.
setSessionToken
=
function
(
sessionId
,
apiVersion
,
instanceUrl
)
{
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
.
instanceUrl
=
"https://"
+
instance
+
".salesforce.com"
;
}
else
{
this
.
instanceUrl
=
instanceUrl
;
}
}
/*
* Low level utility function to call the Salesforce endpoint.
*
@param
path resource path relative to /services/data
*
@param
callback function to which response will be passed
*
@param
[error=null] function to which jqXHR will be passed in case of error
*
@param
[method="GET"] HTTP method for call
*
@param
[payload=null] payload for POST/PATCH etc
*/
forcetk
.
Client
.
prototype
.
ajax
=
function
(
path
,
callback
,
error
,
method
,
payload
,
retry
)
{
var
that
=
this
;
var
url
=
this
.
instanceUrl
+
'/services/data'
+
path
;
$j
.
ajax
(
{
type
:
method
||
"GET"
,
async
:
this
.
asyncAjax
,
url
:
(
this
.
proxyUrl
!==
null
)
?
this
.
proxyUrl
:
url
,
contentType
:
'application/json'
,
processData
:
false
,
data
:
payload
,
success
:
callback
,
error
:
(
!
this
.
refreshToken
||
retry
)
?
error
:
function
(
jqXHR
,
textStatus
,
errorThrown
)
{
if
(
jqXHR
.
status
===
401
)
{
that
.
refreshAccessToken
(
function
(
oauthResponse
)
{
that
.
setSessionToken
(
oauthResponse
.
access_token
,
null
,
oauthResponse
.
instance_url
)
;
that
.
ajax
(
path
,
callback
,
error
,
method
,
payload
,
true
)
;
}
,
error
)
;
}
else
{
error
(
jqXHR
,
textStatus
,
errorThrown
)
;
}
}
,
dataType
:
"json"
,
beforeSend
:
function
(
xhr
)
{
if
(
that
.
proxyUrl
!==
null
)
{
xhr
.
setRequestHeader
(
'SalesforceProxy-Endpoint'
,
url
)
;
}
xhr
.
setRequestHeader
(
that
.
authzHeader
,
"OAuth "
+
that
.
sessionId
)
;
xhr
.
setRequestHeader
(
'X-User-Agent'
,
'salesforce-toolkit-rest-javascript/'
+
that
.
apiVersion
)
;
}
}
)
;
}
/*
* 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
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
versions
=
function
(
callback
,
error
)
{
this
.
ajax
(
'/'
,
callback
,
error
)
;
}
/*
* Lists available resources for the client's API version, including
* resource name and URI.
*
@param
callback function to which response will be passed
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
resources
=
function
(
callback
,
error
)
{
this
.
ajax
(
'/'
+
this
.
apiVersion
+
'/'
,
callback
,
error
)
;
}
/*
* Lists the available objects and their metadata for your organization's
* data.
*
@param
callback function to which response will be passed
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
describeGlobal
=
function
(
callback
,
error
)
{
this
.
ajax
(
'/'
+
this
.
apiVersion
+
'/sobjects/'
,
callback
,
error
)
;
}
/*
* Describes the individual metadata for the specified object.
*
@param
objtype object type; e.g. "Account"
*
@param
callback function to which response will be passed
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
metadata
=
function
(
objtype
,
callback
,
error
)
{
this
.
ajax
(
'/'
+
this
.
apiVersion
+
'/sobjects/'
+
objtype
+
'/'
,
callback
,
error
)
;
}
/*
* 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
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
describe
=
function
(
objtype
,
callback
,
error
)
{
this
.
ajax
(
'/'
+
this
.
apiVersion
+
'/sobjects/'
+
objtype
+
'/describe/'
,
callback
,
error
)
;
}
/*
* 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
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
create
=
function
(
objtype
,
fields
,
callback
,
error
)
{
this
.
ajax
(
'/'
+
this
.
apiVersion
+
'/sobjects/'
+
objtype
+
'/'
,
callback
,
error
,
"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=null] optional comma-separated list of fields for which
* to return values; e.g. Name,Industry,TickerSymbol
*
@param
callback function to which response will be passed
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
retrieve
=
function
(
objtype
,
id
,
fieldlist
,
callback
,
error
)
{
if
(
!
arguments
[
4
]
)
{
error
=
callback
;
callback
=
fieldlist
;
fieldlist
=
null
;
}
var
fields
=
fieldlist
?
'?fields='
+
fieldlist
:
''
;
this
.
ajax
(
'/'
+
this
.
apiVersion
+
'/sobjects/'
+
objtype
+
'/'
+
id
+
fields
,
callback
,
error
)
;
}
/*
* Upsert - creates or updates record of the given type, based on the
* given external Id.
*
@param
objtype object type; e.g. "Account"
*
@param
externalIdField external ID field name; e.g. "accountMaster__c"
*
@param
externalId the record's external ID value
*
@param
fields an object containing field names and values for
* the record, e.g. {:Name "salesforce.com", :TickerSymbol
* "CRM"}
*
@param
callback function to which response will be passed
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
upsert
=
function
(
objtype
,
externalIdField
,
externalId
,
fields
,
callback
,
error
)
{
this
.
ajax
(
'/'
+
this
.
apiVersion
+
'/sobjects/'
+
objtype
+
'/'
+
externalIdField
+
'/'
+
externalId
+
'?_HttpMethod=PATCH'
,
callback
,
error
,
"POST"
,
JSON
.
stringify
(
fields
)
)
;
}
/*
* 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
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
update
=
function
(
objtype
,
id
,
fields
,
callback
,
error
)
{
this
.
ajax
(
'/'
+
this
.
apiVersion
+
'/sobjects/'
+
objtype
+
'/'
+
id
+
'?_HttpMethod=PATCH'
,
callback
,
error
,
"POST"
,
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
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
del
=
function
(
objtype
,
id
,
callback
,
error
)
{
this
.
ajax
(
'/'
+
this
.
apiVersion
+
'/sobjects/'
+
objtype
+
'/'
+
id
,
callback
,
error
,
"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
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
query
=
function
(
soql
,
callback
,
error
)
{
this
.
ajax
(
'/'
+
this
.
apiVersion
+
'/query?q='
+
escape
(
soql
)
,
callback
,
error
)
;
}
/*
* 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
*
@param
[error=null] function to which jqXHR will be passed in case of error
*/
forcetk
.
Client
.
prototype
.
search
=
function
(
sosl
,
callback
,
error
)
{
this
.
ajax
(
'/'
+
this
.
apiVersion
+
'/search?s='
+
escape
(
sosl
)
,
callback
,
error
)
;
}
}
Back
|
FazBrowse Home
|
New Git URL