PCCViewer. SessionData

Gets the data value for the given key, or gets a hash containing all key values, if a key was not provided.

Note: While this is similar to PCCViewer.Data#getData, the data stored in the session will not persist when the page is reloaded, it is used for runtime operations.

Note: If a hash is returned, this will be a new object each time it is called. Adding new properties to the returned hash will not add data to the object.

Note: The returned data is not mutated or sanitized, which could lead to a security vulnerability if not sanitized properly before use.

Example

// The key "Author" is set the value "Mark".
item.setSessionData("Author", "Mark");

// The key "Note" is set the value "This is really important!".
item.setSessionData("Note", "This is really important!");

item.getSessionData("Author"); // returns "Mark"
item.getSessionData();         // returns {"Author":"Mark", "Note":"This is really important!"}
item.getSessionData("FooBar"); // returns

Gets an array of session data keys known to this object.

Note: While this is similar to PCCViewer.Data#getDataKeys, the data stored in the session will not persist when the page is reloaded, it is used for runtime operations.

Example

// Returns an empty array before key-value pairs are stored.
item.getSessionDataKeys(); // returns []

// Returns a list of all keys.
item.setSessionData("Author", "Mark");
item.setSessionData("Note", "This is really important!");
item.getSessionDataKeys(); // returns ["Author", "Note"]

Sets the data value for the given key.

Note: While this is similar to PCCViewer.Data#setData, the data stored in the session will not persist when the page is reloaded, it is used for runtime operations.

Notes:

• Overwrites any data value already associated with the given key.
• There is no artificial limit imposed on the number of key-value pairs that are stored.
• If limits on the number of key-value pairs are required, they should be enforced by calling code.
• Setting the value as undefined results in no information for the key being persisted to the server.
• The returned data is not mutated or sanitized, which could lead to a security vulnerability if not sanitized properly before use.

Example

// Get data returns undefined before the key is set.
item.getSessionData("Author"); // returns undefined

// The key "Author" is set the value "Mark".
item.setSessionData("Author", "Mark");
item.getSessionData("Author"); // returns "Mark"

// The key "Author" is overwritten with the value "Clark".
item.setSessionData("Author", "Clark");
item.getSessionData("Author"); // returns "Clark"

// The key "Author" is unset, by setting the value to undefined.
item.setSessionData("Author", undefined);
item.getSessionData("Author"); // returns undefined

// The value can only be set to a string or undefined.
// All other data types throw.
item.setSessionData("FooBar", null); // throws
item.setSessionData("FooBar", 1);    // throws
item.setSessionData("FooBar", true); // throws
item.setSessionData("FooBar", {});   // throws
item.setSessionData("FooBar", []);   // throws