new Ajax
Simplicité® application.
Parameters:
Name | Type | Description |
---|---|---|
approot |
Application root (either application name or /<context root> or absolute base URL) | |
gateway |
Gateway type to use :
|
|
login |
User's login (not required for UI gateways) | |
password |
User's password (not required for UI gateways) | |
async |
Asynchronous calls by default (true if absent) ? |
- Source:
- appsession.js, line 34
Example
// Using authenticated user thru UI gateway
var app = new Simplicite.Ajax("myapp");
// Using public user thru public UI gateway
var app = new Simplicite.Ajax("myapp", "uipublic");
// Using website user thru WS gateway
var app = new Simplicite.Ajax("myapp", "ws", "myuser", "mypassword");
// Using website user thru API gateway
var app = new Simplicite.Ajax("myapp", "api", "myuser", "mypassword");
Classes
Members
-
appinfo
-
Application info data.
- name: Application name
- version: Application version
- platformversion: Platform version
- encoding: Encoding
- server: Server vendor
- TO BE COMPLETED...
- Source:
- appsession.js, line 588
-
authToken
-
Server side session authentication token.
- Source:
- appsession.js, line 1410
-
<constant> CONTEXT_ACTION
-
Action context.
- Source:
- appsession.js, line 327
-
<constant> CONTEXT_AGENDA
-
Agenda context.
- Source:
- appsession.js, line 332
-
<constant> CONTEXT_ASSOCIATE
-
Association context.
- Source:
- appsession.js, line 317
-
<constant> CONTEXT_COPY
-
Copy context.
- Source:
- appsession.js, line 247
-
<constant> CONTEXT_CREATE
-
Creation context.
- Source:
- appsession.js, line 242
-
<constant> CONTEXT_CROSSTAB
-
Cross table context.
- Source:
- appsession.js, line 267
-
<constant> CONTEXT_DATAMAPSELECT
-
Data mapping selection context.
- Source:
- appsession.js, line 287
-
<constant> CONTEXT_DELETE
-
Delete context.
- Source:
- appsession.js, line 257
-
<constant> CONTEXT_EXPORT
-
Export context.
- Source:
- appsession.js, line 307
-
<constant> CONTEXT_GRAPH
-
Chart context.
- Source:
- appsession.js, line 262
-
<constant> CONTEXT_IMPORT
-
Import context.
- Source:
- appsession.js, line 312
-
<constant> CONTEXT_LIST
-
List context.
- Source:
- appsession.js, line 237
-
<constant> CONTEXT_NONE
-
No context.
- Source:
- appsession.js, line 227
-
<constant> CONTEXT_PANELLIST
-
Panel list context.
- Source:
- appsession.js, line 322
-
<constant> CONTEXT_PLACEMAP
-
Place map context.
- Source:
- appsession.js, line 337
-
<constant> CONTEXT_POSTVALIDATE
-
Post validate context.
- Source:
- appsession.js, line 297
-
<constant> CONTEXT_PREVALIDATE
-
Pre-validate context.
- Source:
- appsession.js, line 292
-
<constant> CONTEXT_PRINTTMPL
-
Publication template context.
- Source:
- appsession.js, line 272
-
<constant> CONTEXT_REFSELECT
-
Reference selection context.
- Source:
- appsession.js, line 282
-
<constant> CONTEXT_SEARCH
-
Search context.
- Source:
- appsession.js, line 232
-
<constant> CONTEXT_STATETRANSITION
-
State transition context.
- Source:
- appsession.js, line 302
-
<constant> CONTEXT_UPDATE
-
Update context.
- Source:
- appsession.js, line 252
-
<constant> CONTEXT_UPDATEALL
-
Bulk update context.
- Source:
- appsession.js, line 277
-
<constant> DEFAULT_ROW_ID
-
Default row ID value (for creation).
- Source:
- appsession.js, line 221
-
<constant> ERRLEVEL_ERROR
-
Error error value
- Source:
- appsession.js, line 569
-
<constant> ERRLEVEL_FATAL
-
Fatal error value
- Source:
- appsession.js, line 564
-
<constant> ERRLEVEL_WARNING
-
Minor error value
- Source:
- appsession.js, line 574
-
<constant> FALSE
-
False value
- Source:
- appsession.js, line 558
-
grant
-
Grant data.
- login: User login
- firstname: User first name
- lastname: User last name
- responsibilities: User active responsibilites array
- TO BE COMPLETED...
- Source:
- appsession.js, line 601
-
menu
-
Menu data.
- TO BE COMPLETED...
- Source:
- appsession.js, line 622
-
news
-
News array. Use news["<code>"] to get a news object), each news object is:
- TO BE COMPLETED...
- Source:
- appsession.js, line 631
-
<constant> RENDERING_DEFAULT
-
Default rendering.
- Source:
- appsession.js, line 522
-
<constant> RENDERING_HORIZCHECKBOX
-
Rendering horizontal checkbox(es).
- Source:
- appsession.js, line 532
-
<constant> RENDERING_HORIZRADIOBUTTON
-
Rendering horizontal radio button(s).
- Source:
- appsession.js, line 542
-
<constant> RENDERING_SELECTBOX
-
Select box rendering (single or multiple select).
- Source:
- appsession.js, line 527
-
<constant> RENDERING_VERTCHECKBOX
-
Rendering vertical checkbox(es).
- Source:
- appsession.js, line 537
-
<constant> RENDERING_VERTRADIOBUTTON
-
Rendering vertical radio button(s).
- Source:
- appsession.js, line 547
-
<constant> SEARCH_MONO
-
Searchable.
- Source:
- appsession.js, line 501
-
<constant> SEARCH_MULTI_CHECK
-
Searchable using check boxes.
- Source:
- appsession.js, line 506
-
<constant> SEARCH_MULTI_LIST
-
Searchable using list box.
- Source:
- appsession.js, line 511
-
<constant> SEARCH_NONE
-
Not searchable.
- Source:
- appsession.js, line 496
-
<constant> SEARCH_PERIOD
-
Searchable using period.
- Source:
- appsession.js, line 516
-
sessionId
-
Server side session identifier.
- Source:
- appsession.js, line 1404
-
sysparams
-
System parameters array. Use sysparams["<name>"] to get a system parameter value.
- Source:
- appsession.js, line 607
-
texts
-
Texts. Use texts["<code>"] to get a text value.
- Source:
- appsession.js, line 613
-
<constant> TRUE
-
True value
- Source:
- appsession.js, line 553
-
<constant> TYPE_BOOLEAN
-
Boolean type.
- Source:
- appsession.js, line 383
-
<constant> TYPE_COLOR
-
Color type.
- Source:
- appsession.js, line 453
-
<constant> TYPE_DATE
-
Date type.
- Source:
- appsession.js, line 363
-
<constant> TYPE_DATETIME
-
Date and time type.
- Source:
- appsession.js, line 368
-
<constant> TYPE_DOC
-
Document type
- Source:
- appsession.js, line 423
-
<constant> TYPE_EMAIL
-
Email type.
- Source:
- appsession.js, line 403
-
<constant> TYPE_ENUM
-
Single enumerated (list of values) type.
- Source:
- appsession.js, line 378
-
<constant> TYPE_ENUM_MULTI
-
Multiple enumerated (list of values) type.
- Source:
- appsession.js, line 413
-
<constant> TYPE_EXTFILE
-
External file reference type.
- Source:
- appsession.js, line 433
-
<constant> TYPE_FLOAT
-
Float type.
- Source:
- appsession.js, line 353
-
<constant> TYPE_FLOAT_EMPTY
-
Float type (same as TYPE_FLOAT).
- Source:
- appsession.js, line 428
-
<constant> TYPE_GEOCOORDS
-
Geo coordinates type.
- Source:
- appsession.js, line 463
-
<constant> TYPE_HTML
-
HTML content type.
- Source:
- appsession.js, line 398
-
<constant> TYPE_ID
-
Internal ID (foreign key) type.
- Source:
- appsession.js, line 343
-
<constant> TYPE_IMAGE
-
Image type.
- Source:
- appsession.js, line 438
-
<constant> TYPE_INT
-
Integer type.
- Source:
- appsession.js, line 348
-
<constant> TYPE_LONG_STRING
-
Long string (unlimited) type.
- Source:
- appsession.js, line 408
-
<constant> TYPE_NOTEPAD
-
Notepad (incremental long text) type.
- Source:
- appsession.js, line 443
-
<constant> TYPE_OBJECT
-
Object type.
- Source:
- appsession.js, line 458
-
<constant> TYPE_PASSWORD
-
Password type.
- Source:
- appsession.js, line 388
-
<constant> TYPE_PHONENUM
-
Phone number type.
- Source:
- appsession.js, line 448
-
<constant> TYPE_REGEXP
-
Regular expression type.
- Source:
- appsession.js, line 418
-
<constant> TYPE_STRING
-
String type.
- Source:
- appsession.js, line 358
-
<constant> TYPE_TIME
-
Time type.
- Source:
- appsession.js, line 373
-
<constant> TYPE_URL
-
URL type.
- Source:
- appsession.js, line 393
-
<constant> VIS_BOTH
-
Visible in lists and forms.
- Source:
- appsession.js, line 485
-
<constant> VIS_FORBIDDEN
-
Forbidden on UI
- Source:
- appsession.js, line 490
-
<constant> VIS_FORM
-
Visible in forms.
- Source:
- appsession.js, line 480
-
<constant> VIS_HIDDEN
-
Not visible.
- Source:
- appsession.js, line 469
-
<constant> VIS_LIST
-
Visible in lists.
- Source:
- appsession.js, line 475
Methods
-
base64Decode
-
Decode a base64 string to string
Parameters:
Name Type Description s
Base64-encoded string - Source:
- appsession.js, line 1647
Returns:
Decoded string -
base64Encode
-
Encode a string to base64
Parameters:
Name Type Description s
Input string - Source:
- appsession.js, line 1573
Returns:
Base64-encoded string -
base64EncodeArrayBuffer
-
Encode an array buffer (such as got from a local file read) to to base64
Parameters:
Name Type Description b
Array buffer - Source:
- appsession.js, line 1633
Returns:
Base64-encoded string -
contentURL
-
Returns content URL.
Parameters:
Name Type Description file
Content file name - Source:
- appsession.js, line 803
-
dataURL
-
Returns local data URL (e.g. suitable for src of img tags).
Parameters:
Name Type Description doc
Document thumb
Return document thumbnail? - Source:
- appsession.js, line 764
-
dispositionResourceURL
-
Returns disposition resource URL.
Parameters:
Name Type Description code
Resource code type
Resource type (IMG=image (default), ICO=Icon, CSS=stylesheet, JS=Javascript, HTML=HTML) - Source:
- appsession.js, line 813
-
documentURL
-
Returns document URL.
Parameters:
Name Type Description object
Object name field
Field name rowId
Object record row ID docId
Document ID (can be omitted then a lookup is done on record matching rowId) cdisp
Disposition: attachment or inline (defaults to inline) - Source:
- appsession.js, line 778
-
getAppInfo
-
Loads application info data.
Parameters:
Name Type Description callback
Callback function called when loading is completed (loaded application info data is passed to this function) params
Optional parameters: - async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 966
-
getBusinessObject
-
Get a new business object.
Parameters:
Name Type Description objName
Object name objInstName
Object instance name, optional (defauts to ajax_<object name>) autoRefreshMetaData
deprecated - Source:
- businessobject.js, line 20
Example
// app is a Simplicite.Ajax instance var obj = app.getBusinessObject("MyObject");
-
getExternalObject
-
Loads external object.
Parameters:
Name Type Description callback
Callback function called when loading is completed (loaded external object is passed to this function) name
External object name params
Optional parameters: - async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 1380
-
getGrant
-
Loads grant data.
Parameters:
Name Type Description callback
Callback function called when loading is completed (loaded grant data is passed to this function) params
Optional parameters: - inlinePicture Inline picture (false if absent or undefined)
- async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 1025
-
getMenu
-
Loads menu data.
Parameters:
Name Type Description callback
Callback function called when loading is completed (loaded menu data is passed to this function) params
Optional parameters: - async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 1161
-
getNews
-
Loads news.
Parameters:
Name Type Description callback
Callback function called when loading is completed (loaded news array is passed to this function) params
Optional parameters: - inlineImages Inline news images (false if absent or undefined)
- async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 1340
-
getSysInfo
-
Loads system info data.
Parameters:
Name Type Description callback
Callback function called when loading is completed (loaded system info data is passed to this function) params
Optional parameters: - async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 996
-
getSysParam
-
Get system parameter value.
Parameters:
Name Type Description name
System parameter name params
Optional parameters: - async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 1223
-
getSysParams
-
Loads system parameters.
Parameters:
Name Type Description callback
Callback function called when loading is completed (loaded system parameters array is passed to this function) params
Optional parameters: - async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 1191
-
getText
-
Get text value.
Parameters:
Name Type Description code
Text code - Source:
- appsession.js, line 1316
-
getTexts
-
Loads texts.
Parameters:
Name Type Description callback
Callback function called when loading is completed (loaded texts array is passed to this function) params
Optional parameters: - async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 1289
-
getUserInfo
-
Loads basic user data (login, name, email, picture).
Parameters:
Name Type Description callback
Callback function called when loading is completed (loaded user data is passed to this function) login
User login params
Optional parameters: - inlinePicture Inline picture (false if absent or undefined)
- async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 1131
-
imageURL
-
Returns image URL.
Parameters:
Name Type Description object
Object name field
Field name rowId
Object record row ID docId
Document ID thumb
Return thumbnail image - Source:
- appsession.js, line 793
-
login
-
Login (same as session()).
Parameters:
Name Type Description successCallback
Callback function called when login is sucessful failureCallback
Callback function called when login fails authToken
Authentication token to (re)use (in case of a persistent token) params
Optional parameters: - async Asynchronous call (use default if absent) ?
- Source:
- appsession.js, line 1459
-
logout
-
Logout (in case of a persistent token it is deleted)
Parameters:
Name Type Description successCallback
Callback function called when login is sucessful failureCallback
Callback function called when login fails params
Optional parameters: - async Asynchronous call (use default if absent) ?
- Source:
- appsession.js, line 1473
-
parseDateTimeValue
-
Parse a date time value into a Javascript Date
Parameters:
Name Type Description v
Date time value (YYYY-MM-DD hh:mm:ss) - Source:
- appsession.js, line 1524
-
parseDateValue
-
Parse a date value into a Javascript Date
Parameters:
Name Type Description v
Date value (YYYY-MM-DD) - Source:
- appsession.js, line 1515
-
resourceURL
-
Returns resource URL.
Parameters:
Name Type Description id
Resource ID (e.g. taken from business object or external object resources list in metadata) - Source:
- appsession.js, line 822
-
session
-
Session init (retrieves server side session identifier and auth token).
Parameters:
Name Type Description successCallback
Callback function called when session init is sucessful failureCallback
Callback function called when session init fails authToken
Auth token to (re)use (in case of persistent tokens) params
Optional parameters: - async Asynchronous call (use default if absent) ?
- Source:
- appsession.js, line 1423
-
setDebugHandler
-
Change default global debug handler.
Parameters:
Name Type Description debugHandler
Debug handler function - Source:
- appsession.js, line 744
-
setDebugHandlerActive
-
Set default global debug handler active or inactive.
Parameters:
Name Type Description active
Active status - Source:
- appsession.js, line 736
-
setErrorHandler
-
Change default global error handler.
Parameters:
Name Type Description errorHandler
Error handler function - Source:
- appsession.js, line 681
-
setErrorHandlerActive
-
Set default global error handler active or inactive.
Parameters:
Name Type Description active
Active status - Source:
- appsession.js, line 672
-
setInfoHandler
-
Change default global information handler.
Parameters:
Name Type Description infoHandler
Information handler function - Source:
- appsession.js, line 723
-
setInfoHandlerActive
-
Set default global information handler active or inactive.
Parameters:
Name Type Description active
Active status - Source:
- appsession.js, line 715
-
setPassword
-
Set password.
Parameters:
Name Type Description callback
Callback function called when loading is completed password
Password params
Optional parameters: - async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 1100
-
setSysParam
-
Set a user system parameter.
Parameters:
Name Type Description callback
Callback function called when loading is completed (parameter is passed to this function) name
Parameter name value
Parameter value (if undefined parameter is unset) save
Save parameter in user parameters (if undefined parameter is not saved) params
Optional parameters : - async Asynchronous call (use default if absent) ?
- error Custom error handler (use default error handler if absent) ?
- Source:
- appsession.js, line 1256
-
setVersionCompatibility
-
Set default JSON services version compatibility
Parameters:
Name Type Description version
Simplicite(R) JSON services version to be compatible with (e.g. 2.7) - Source:
- appsession.js, line 639
-
setWarningHandler
-
Change default global warning handler.
Parameters:
Name Type Description warningHandler
Warning handler function - Source:
- appsession.js, line 702
-
setWarningHandlerActive
-
Set default global warning handler active or inactive.
Parameters:
Name Type Description active
Active status - Source:
- appsession.js, line 694
-
T
-
Alias for getText
- Source:
- appsession.js, line 1327
-
toDateTimeValue
-
Parse a Javascript Date into a date time value
Parameters:
Name Type Description d
Javascript date - Source:
- appsession.js, line 1563
-
toDateValue
-
Parse a Javascript Date into a date value
Parameters:
Name Type Description d
Javascript date - Source:
- appsession.js, line 1539
-
toTimeValue
-
Parse a Javascript Date into a time value
Parameters:
Name Type Description d
Javascript date - Source:
- appsession.js, line 1551