BBjThinClient::getUserProperties


Description

In BBj 15.0 and higher, this method returns the client-side properties from a given property group.

 See below.


Syntax

Return Value

Method

Map

getUserProperties()

Map

getUserProperties(java.util.Collection properties)

Map

getUserProperties(long group)

Map

getUserProperties(long group, java.util.Collection properties)

Parameters

Variable

Description

keys!

A Java Collection (e.g. a BBjVector) listing the keys to be returned.

Variable

Description

group

  • USER_PROPERTIES_COOKIES (0)

  • USER_PROPERTIES_STORAGE (1)

  • USER_PROPERTIES_SESSION (-1)

properties

A Collection (e.g. a BBjVector) containing the keys to be returned. If this parameter is null(), contains zero elements, or is omitted, all key/value pairs from the group are returned.

Return Value

Returns a Map structure of key/value pairs from the specified properties group.

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.

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

Example

tc! = bbjapi().getThinClient()

props! = new java.util.HashMap()

props!.put("key1","value1")

props!.put("key2","value2")

tc!.setUserProperties(props!)

print tc!.getUserProperties()

See Also

BBjAPI

BBjThinClient

BBjThinClient::getUserProperty

BBjThinClient::setUserProperties

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



______________________________________________________________________________________

Copyright BASIS International Ltd. BBj®, Visual PRO/5®, PRO/5®, and BBx® are registered trademarks.