BBjThinClient::clearUserProperties

Description

In BBj 15.0 and higher, this method clears all client-side properties within a given property group.

BUI logo

 See below.

Syntax

Return Value

Method

void

clearUserProperties()

void

clearUserProperties(long group)

Parameters

Variable

Description

group

  • USER_PROPERTIES_COOKIES (0)

  • USER_PROPERTIES_STORAGE (1)

  • USER_PROPERTIES_SESSION (-1)

Return Value

None.

Remarks

In BUI, USER_PROPERTIES_COOKIES maps to browser cookies, USER_PROPERTIES_STORAGE maps to browser local storage, and USER_PROPERTIES_SESSION maps to browser session storage.

In GUI, the three groups map to nodes in a Preferences tree, which doesn't allow keys or values to include any $00$ characters.

If no group is specified, the default value is taken from STBL("!USER_PROPERTIES").

Example

tc! = bbjapi().getThinClient()
tc!.clearUserProperties()

See Also

BBjAPI

BBjThinClient

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.