Class: UserContext

Methods

getCustomPropertyValue(name, type){String}

Returns a custom user property value by its name and type.
Custom user properties can be used to persist (i.e. load and store) arbitrary, user related application data across user sessions. The data type has to be String, e.g. JSON, XML or plain text data.

In DOCUMENTS Manager, any custom user property can be found at the lower properties tab of the user account settings dialog.

Notice that this function performs a request against the application server which is called synchronous by default. Thus the JavaScript- and UI thread of the browser will be blocked until the server response has returned.

Name	Type	Description
name	String	the name of the property
type	String	the type of the property

• Since:

  • 5.0a

• See:

  • setCustomPropertyValue

  • removeCustomProperty

Returns:

Type	Description
String	the value of the property

Examples

//  JSON example
//  Note: the custom user property "worldJSON" is stored in the corresponding setCustomPropertyValue() example
var worldJSON = documentsContext.getUserContext().getCustomPropertyValue("worldJSON", "");
console.log(worldJSON);  //  -> "{"Asia" : ["China", "India", "Japan"], "Europe" : ["Austria", "Denmark", "Germany", "Great Britain", "Norway", "Sweden", ...}"
var worldMap = JSON.parse(worldJSON);
var continent = worldMap["Oceania"];

for(var i = 0; i < continent.length; i++) {
	console.log(continent[i]);  //  -> "Australia", "New Zealand"
}

// XML example
// Note: the custom user property "worldXML" is stored in the corresponding setCustomPropertyValue() example
var worldXML = documentsContext.getUserContext().getCustomPropertyValue("worldXML", "");
console.log(worldXML);  // -> "<World><Continent name="Asia"><Country>China</Country><Country>India</Country><Country>Japan</Country></Continent><Continent name="Europe"><Country>Austria</Country>..."
var parser = new DOMParser();
var worldNode = parser.parseFromString(worldXML, "application/xml");
var countryNodes = worldNode.querySelectorAll("Continent[name='Oceania'] Country");

for(var i = 0; i < countryNodes.length; i++) {
	console.log(countryNodes[i].textContent);  //  -> "Australia", "New Zealand"
}

getProperty(key){String}

Returns a system user property by its key.
User properties can be used to define arbitrary, user related application settings. They are read-only by default. The data type has to be String, e.g. JSON, XML or plain text data.

In DOCUMENTS Manager, any user property can be found at the upper properties tab of the user account settings dialog.

Notice that this function performs a request against the application server which is called synchronous by default. Thus the JavaScript- and UI thread of the browser will be blocked until the server response has returned.

Name	Type	Description
key	String	the key of the property

• Since:

  • 5.0a

Returns:

Type	Description
String	the value of the property

Example

var userContext = documentsContext.getUserContext();
var b0 = userContext.getProperty("color") || "blue";  //  type: String, default "blue"
var b1 = userContext.getProperty("availableOnWeekends") === "true";  //  type: boolean, default: false
var b2 = userContext.getProperty("availableDuringWeek") !== "false";  //  type: boolean, default: true
var b3 = parseInt(userContext.getProperty("hoursPerWeek"), 10) || 25;  // type: Number (Integer), default: 25

removeCustomProperty(name, type){String}

Removes a custom user property by its name and type and returns its previous value.
Custom user properties can be used to persist (i.e. load and store) arbitrary, user related application data across user sessions. The data type has to be String, e.g. JSON, XML or plain text data.

In DOCUMENTS Manager, any custom user property can be found at the lower properties tab of the user account settings dialog.

Notice that this function performs a request against the application server which is called synchronous by default. Thus the JavaScript- and UI thread of the browser will be blocked until the server response has returned.

Name	Type	Description
name	String	the name of the property
type	String	the type of the property

• Since:

  • 5.0a

• See:

  • getCustomPropertyValue

  • setCustomPropertyValue

Returns:

Type	Description
String	the value of the property previous to removal

Examples

documentsContext.getUserContext().removeCustomProperty("worldXML", "");

documentsContext.getUserContext().removeCustomProperty("pdfViewerUserProperty", "json");

setCustomPropertyValue(name, type, value){String}

Sets a custom user property value by its name and type.
Custom user properties can be used to persist (i.e. load and store) arbitrary, user related application data across user sessions. The data type has to be String, e.g. JSON, XML or plain text data.

In DOCUMENTS Manager, any custom user property can be found at the lower properties tab of the user account settings dialog.

Notice that this function performs a request against the application server which is called synchronous by default. Thus the JavaScript- and UI thread of the browser will be blocked until the server response has returned.

Name	Type	Description
name	String	the name of the property
type	String	the type of the property
value	String	the new value of the property

• Since:

  • 5.0a

• See:

  • getCustomPropertyValue

  • removeCustomProperty

Returns:

Type	Description
String	the previous value of the property

Examples

//  JSON example
//  Note: the custom user property "worldJSON" is read in the corresponding getCustomPropertyValue() example
var worldMap = {
	"Asia" : ["China", "India", "Japan"],
	"Europe" : ["Austria", "Denmark", "Germany", "Great Britain", "Norway", "Sweden", "Switzerland"],
	"Oceania" : ["Australia", "New Zealand"],
	"South America" : ["Argentina", "Brazil", "Chile", "Peru", "Venezuela"]
}

var worldJSON = JSON.stringify(worldMap);
console.log(worldJSON);  //  -> "{"Asia" : ["China", "India", "Japan"], "Europe" : ["Austria", "Denmark", "Germany", "Great Britain", "Norway", "Sweden", ...}"

documentsContext.getUserContext().setCustomPropertyValue("worldJSON", "", worldJSON);

//  XML example
//  Note: the custom user property "worldXML" is read in the corresponding getCustomPropertyValue() example
var worldMap = {
	"Asia" : ["China", "India", "Japan"],
	"Europe" : ["Austria", "Denmark", "Germany", "Great Britain", "Norway", "Sweden", "Switzerland"],
	"Oceania" : ["Australia", "New Zealand"],
	"South America" : ["Argentina", "Brazil", "Chile", "Peru", "Venezuela"]
}

var createContinent = function(worldNode, continent, countries) {
 var continentNode = document.createElementNS("", 'Continent');
     continentNode.setAttribute('name', continent);
     worldNode.appendChild(continentNode);

 createCountries(continentNode, countries);
}

var createCountries = function(continentNode, countries) {
	for(var i = 0; i < countries.length; i++) {
		var countryNode = document.createElementNS("", 'Country');
		countryNode.appendChild( document.createTextNode(countries[i]) );
		continentNode.appendChild(countryNode);
	}
}

var worldNode = document.createElementNS("", "World");

for(continent in worldMap) {
	createContinent(worldNode, continent, worldMap[continent]);
}

var serializer = new XMLSerializer();
var worldXML = serializer.serializeToString(worldNode);
console.log(worldXML);  // -> "<World><Continent name="Asia"><Country>China</Country><Country>India</Country><Country>Japan</Country></Continent><Continent name="Europe"><Country>Austria</Country>..."

documentsContext.getUserContext().setCustomPropertyValue("worldXML", "", worldXML);