Contents x
    Liquit.Contexts.List
    • 12 Dec 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Liquit.Contexts.List

    • Updated on 12 Dec 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    This API function is available for Liquit Workspace 3.5 and later.

    The Liquit.Contexts.List function returns all contexts that are available to the user.

    Return parameters

    The following properties are available:

    NameDescriptionValue
    idThe GUID of the context<guid>
    nameThe friendly name of the context<string>
    primaryOnly one context will be primary; this is used for filtering in the Liquit Workspace.<boolean>
    priorityThis number indicates which context is more important, the lower the number the higher the priority (e.g. 0 is more important than 2).<number>

    Example

    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?
    What's Next