The Liquit.Applications.Get function returns the properties of a personal application. This function is not available for packages assigned to the user via the Application Workspace interface.
By default, the Liquit.Applications.Get API returns information about the entity triggered by the personal app, and its corresponding settings. To acquire information on the application, you need to supply its ID and its source information.
Request parameters
The following parameters are available for the API:
Name | Description | Value |
---|---|---|
id | The ID of the application you wish to request. | <GUID> |
source.type | This information is made available to you by the Applications.List function. | <string> |
source.id | This information is made available to you by the Applications.List function. | <GUID> |
Return parameters
The following properties are returned:
Name | Description | Value |
---|---|---|
browser | Defines the browser that will be used to start the application:
|
<string> |
directory | The start directory the application will use when launched. Only available for a path application. |
<string> |
display | Defines how the window for the application should be opened:
|
<string> |
id | The ID of the application. | <string> |
name | The display name of the personal application. | <string> |
path | The path of the local application. Only available for a path application. |
<string> |
type | The type of application:
|
<string> |
uri | The URI the package will open. Only available for a URI application. |
<string> |
Example
Below you will find a small example of code to fetch a personal application and its starting information.
// Do Application Workspace API calls...
Liquit.Applications.Get({
id: id,
source: {
id: sourceId,
type: 'Team'
}
}, function(fault, result) {
console.log({
fault: fault,
result: result
});
});