Liquit.Catalog.List

Updated On 29 Jan 2021
1 Minute To Read

Print
Share
Dark

Light

The Liquit.Catalog.List function returns all available applications in the users catalog. Whenever a applications has been made available in the Catalog it will be listed in the response of this function.

The following properties are returned:

Name	Description	Value
active	Determines whether or not the application is active, if this is true the application is already successfully requested.	`<boolean>`
categories	Returns an array containing all categories associated with the application	`<array[]>`
icon	Returns the URL for the application icon	`<string>`
id	The guid belonging to the application	`<guid>`
name	The friendly name for the application	`<string>`
rating	The global rating for the application	`<int>`
status	The status of the application this can contain one of the following values : active the application has been requested and approved available The application can be requested and no approval workflow is attached, meaning it becomes available to the workspace immediately pending The application has been requested however an approval is still needed	`<string>`

The following parameters are available for the API:

Name	Description	Value
sort	Determines the order in which the API returns the Applications, the following options are available: 0 User defined ordering, as determined by position 1 Order on name ascending 2 Order on name decending 3 Order on launch count (available for Liquit Workspace 3.4 and higher ) 4 Order on last launched (available for Liquit Workspace 3.4 and higher )	`<int>`
search	Allows you to search on name	`<string>`
reviews	If true reviews will be included (available for Liquit Workspace 3.6 and higher )	`<boolean>`
media	If true media will be included (available for Liquit Workspace 3.6 and higher )	`<boolean>`
faq	if true the faq will be included (available for Liquit Workspace 3.6 and higher )	`<boolean`

Usage

By default the Liquit Catalog List API will return all applications available in the catalog.

Liquit.Catalog.List({
    media: true,
    license: true,
    reviews: true,
    faq: true
        }, 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 catalog items.
        console.log(result);
});

Was This Article Helpful?

Table Of Contents