SDK

sessionVars()

5min

Method
JS
|
relicxSDK.sessionVars(vars);
relicxSDK.sessionVars(vars);
﻿
Attach custom key/value data to the session.
Parameters
Name
Description
vars
(Required) An object containing key/value pairs that provide additional context for the session.
 The keys can be arbitrary but special support is provided for some keys.
Key
Description
email
E-mail address for the user.
user_name
A human readable name for the user. 
tenant
A name/identifier for the tenant the user belongs to. 
build_version
An identifier for the current build of your app.
Examples
JS
|
relicxSDK.sessionVars({
    // Special keys
    email: "foo.bar@test.com",
    user_name: "Foo Bar",
    tenant: "Amazing Bazz Org",
    build_version: "v1.2.3"
    // Arbitrary keys
    role: "UX designer",
});
relicxSDK.sessionVars({
    // Special keys
    email: "foo.bar@test.com",
    user_name: "Foo Bar",
    tenant: "Amazing Bazz Org",
    build_version: "v1.2.3"
    // Arbitrary keys
    role: "UX designer",
});
﻿
Multiple calls to relicxSDK.sessionVars() are resolved by using the latest value for each key.

Updated 06 Mar 2023

Did this page help you?

TABLE OF CONTENTS

Method

Parameters

Examples

Name	Description
vars	(Required) An object containing key/value pairs that provide additional context for the session.

Key	Description
email	E-mail address for the user.
user_name	A human readable name for the user.
tenant	A name/identifier for the tenant the user belongs to.
build_version	An identifier for the current build of your app.