rbf_removeAllSessionData()

Purpose

This function removes all session data for the user.

If this function raises an error, Platform sets the HTTP status to 500 and invokes the callback function provided via rbf_setErrorsCallback() and passes that function the following message:

  • No Custom Session Data is Set by User — No session data exists for the user

Note: If this function call results in an error, and you have not configured a callback function using rbf_setErrorsCallback(), you will still see the HTTP status of 500 but will not see the reason for the error.

Syntax

rbf_removeAllSessionData(callback);

Parameters

callback

The callback function that will receive a JSON array of picklist items as its first parameter.

Note: This API is not supported in portals.

Sets the HTTP status to 200 and passes the string OK to callback as the first argument.

Example

The following example removes all session data for the user:

<script>
  var callback = function(errMsg, apiName) {
      alert("ERROR: "+errMsg+" in: "+apiName);
      };
      rbf_setErrorsCallback(callback);
  var handleSessionData = function (returnValue) {
    if(console){
      console.log("**** Processing handleSessionData ****");
      console.log("Response is " +returnValue);
    }
  }
  rbf_removeAllSessionData(handleSessionData);
  </script>