===== Gestione parametri in Sessione (Session Parameters) ===== Esistono delle API per poter gestire dei parametri legati alla sessione utente corrente: * [[:custom:api_js_session_parameters#addGwSessionParameter|addGwSessionParameter()]] * [[:custom:api_js_session_parameters#addGwSessionParameters|addGwSessionParameters()]] * [[:custom:api_js_session_parameters#getGwSessionParameters|getGwSessionParameters()]] * [[:custom:api_js_session_parameters#setGwSessionParameters|setGwSessionParameters()]] * [[:custom:api_js_session_parameters#removeGwSessionParameter|removeGwSessionParameter()]] * [[:custom:api_js_session_parameters#clearAllGwSessionParameters|clearAllGwSessionParameters()]] * [[:custom:api_js_session_parameters#clearGwSessionParameters|clearGwSessionParameters()]] ==== addGwSessionParameter() ==== Aggiunge un paramtero //paramName// in sessione, con valore //paramValue//. Se il parametro è già presente il suo valore viene sovrascritto. Gli altri parametri non sono modificati. var paramName = 'p1'; var paramValue = 2; var params = { callback: function(jsonServerResponse){ }, errorCallback: function(jsonServerResponse){ } }; addGwSessionParameter(paramName, paramValue, params); ==== addGwSessionParameters() ==== Aggiunge tutti i parametri di //parametersMap// in sessione. Se i parametri sono già presenti i loro valori vengono sovrascritti. Gli altri parametri non sono modificati. var parametersMap = {p1: 'one', p2: 2}; var params = { callback: function(jsonServerResponse){ let success = jsonServerResponse.success; let description = jsonServerResponse.description; let sessionParameters = jsonServerResponse.responseHashMap.sessionParameters; }, errorCallback: function(jsonServerResponse){ } }; addGwSessionParameters(parametersMap, params); ==== getGwSessionParameters() ==== Recupera tutti i parametri attualmente in sessione. E li rende utilizzabili dentro la mappa //sessionParameters// nella callback. var params = { callback: function(sessionParameters){ var p1 = sessionParameters.p1; ... }, errorCallback: function(jsonServerResponse){ } }; getGwSessionParameters(params); ==== setGwSessionParameters() ==== **Dalla versione 4.6.9** Imposta i parametri di //parametersMap// in sessione. Sovrascrivendo tutti i parametri eventualmente gia presenti. var parametersMap = {p1: 'one', p2: 2, p3: true}; var params = { callback: function(jsonServerResponse){ let success = jsonServerResponse.success; let description = jsonServerResponse.description; let sessionParameters = jsonServerResponse.responseHashMap.sessionParameters; }, errorCallback: function(jsonServerResponse){ } }; setGwSessionParameters(parametersMap, params); ==== removeGwSessionParameters() ==== Rimuove i parametri della mappa dalla sessione. Vengono valutate le sole //key//. Gli altri parametri non vengono modificati. var sessionParameters = {p1: null, p2: null, p3: null}; var params = { callback: function(jsonServerResponse){ let success = jsonServerResponse.success; let description = jsonServerResponse.description; let sessionParameters = jsonServerResponse.responseHashMap.sessionParameters; var p4Value = sessionParameters.p4; ... }, errorCallback: function(jsonServerResponse){ } }; removeGwSessionParameters(sessionParameters, params); ==== clearAllGwSessionParameters() ==== **@Deprecated** Rimuove tutti i parametri dalla sessione. clearAllGwSessionParameters(); ==== clearGwSessionParameters() ==== **Dalla 4.6.9** Rimuove tutti i parametri dalla sessione. var params = { callback: function(jsonServerResponse){ let success = jsonServerResponse.success; let description = jsonServerResponse.description; let sessionParameters = jsonServerResponse.responseHashMap.sessionParameters; //sessionParameters empty now ... }, errorCallback: function(jsonServerResponse){ } }; clearGwSessionParameters(params);