Liquit.Contexts.List
  • 29 Jan 2021
  • 1 Minute To Read
  • Print
  • Share
  • Dark
    Light

Liquit.Contexts.List

  • Print
  • Share
  • Dark
    Light

This api is available for Liquit Workspace 3.5 and higher

The Liquit.Contexts.List function returns all available contexts that are in effect for the end user.

For every context that is effictive for the end user the following properties are available.

Name Description Value
id The guid belonging to the context <guid>
name The friendly name for the context <string>
primary Only one context will be primary, this is used for filtering in the Liquit Workspace. <boolean>
priority This number indicates which context is more important, a lower number will result in more proiotority (e.g. 0 is mroe important than 2). <number>

Usage

By default the Liquit Context List API will return all available contexts.

Liquit.Contexts.List(function (fault, result) {

        // Check if the request failed.
        if (fault != null) {
            alert('Error ' + fault.code + ': ' + fault.message);
            return;
	    }

	    // The result object will contain an array of all contexts
        console.log(result);
});
Was This Article Helpful?