The Liquit.Catalog.List function returns all applications available in the user's catalog. Whenever an application is made available in the Catalog, it is listed in the response of this function.
Request parameters
The following parameters are available for the API:
Name | Description | Value |
---|---|---|
sort | Determines the order in which the API returns the applications:
|
<int> |
search | Allows you to search by name | <string> |
reviews | If true, reviews will be included in the response (available for Application Workspace 3.6 and later) | <boolean> |
media | If true, media will be included in the response (available for Application Workspace 3.6 and later) | <boolean> |
faq | If true, the frequently asked questions will be included in the response (available for Application Workspace 3.6 and later) | <boolean |
Return parameters
Name | Description | Value |
---|---|---|
active | Determines whether or not the application is active. If this is true, the application was already successfully requested. | <boolean> |
categories | Returns an array containing all categories associated with the application. | <array[]> |
icon | Returns the URL of the application icon. | <string> |
id | The GUID of the application. | <guid> |
name | The friendly name of the application. | <string> |
rating | The global rating of the application. | <int> |
requestable | Indicates if the application is requestable by the user | <boolean> |
status | The status of the application:
|
<string> |
Example
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);
});