Salesforce

ClientSessionSet (Magic xpa 3.x)

« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

ClientSessionSet (Magic xpa 3.x)

This client-side function sets environment settings for the session.

Syntax:

ClientSessionSet (key, value)

Parameters:

key: an environment setting key. The following keys are supported:

  • EnableCommunicationDialogs – This key lets you disable the 'Do you wish to retry' dialog boxes that appear when there is an error accessing the server or network. If this key is set to False, the dialog boxes will not appear. By default, or if the key is set to True, the dialog boxes will appear. Note that when setting the value to False, you should handle network errors in your application by using the ServerLastAccessStatus function and the Unavailable Server event.

value: The required value for the key.

Returns:

Logical – If the set was successful.

Usages:

This is useful when the application is written to handle a network error, such as using Offline programs and client-side storage.

Example:

ClientSessionSet('EnableCommunicationDialogs','FALSE'LOG)

Since version:

2.4

Reference
Attachment 
Attachment