BBjThinClient::setUserProperty


Description

In BBj 11.0 and higher, this method stores a key/value pair in a specified client-side property group.

 

 See below.

 

Syntax

Return Value

Method

void

setUserProperty(long group, string key, string value)

void

setUserProperty(string key, string value)

Parameters

Variable

Description

group

  • USER_PROPERTIES_COOKIES (0)

  • USER_PROPERTIES_STORAGE (1)

  • USER_PROPERTIES_SESSION (-1)

key

Specifies the key to be saved on the client.

value

Specifies the value to be saved on the client.

Return Value

None.

Remarks

In BUI, USER_PROPERTIES_COOKIES maps to browser cookies with a 30-day expiration, USER_PROPERTIES_STORAGE maps to browser local storage, and USER_PROPERTIES_SESSION maps to browser session storage. Any other group value is treated as a cookie with a specified expiration timestamp (e.g. System.currentTimeMillis()+24*60*60*1000*7 is exactly 7 days from now).

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()

tc!.setUserProperty("key","value")

print tc!.getUserProperty("key")  

See Also

BBjAPI

BBjThinClient::getUserProperties

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.