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

    Liquit.Applications.Get

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

    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 Liquit Workspace interface.
    By default, the Liquit Application 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:

    NameDescriptionValue
    idThe ID of the application you wish to request.<GUID>
    source.typeThis information is made available to you by the Applications.List function.<string>
    source.idThis information is made available to you by the Applications.List function.<GUID>

    Return parameters

    The following properties are returned:

    NameDescriptionValue
    browserDefines the browser that will be used to start the application:
    • Default
    • InternetExplorer
    • Firefox
    • Chrome
    • Opera
    • Edge
    • Safari
    Only available for a URI application.    		<string>
    directoryThe start directory the application will use when launched.
    Only available for a path application.    		<string>
    displayDefines how the window for the application should be opened:
    • Normal: Open up the application in the default settings.
    • Minimized: Start the application minimized.
    • Maximized: Start the application maximized.
    Only available for a path application.    		<string>
    idThe ID of the application.<string>
    nameThe display name of the personal application.<string>
    pathThe path of the local application.
    Only available for a path application.    		<string>
    typeThe type of application:
    • Path: a local application. These applications require an Agent to be running.
    • Uri: A URI that can be opened by the browser. These applications do not require an Agent to be running).
    		<string>
    uriThe 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 Liquit API calls...
Liquit.Applications.Get({
    id: id,
    source: {
        id: sourceId,
        type: 'Team'
    }
}, function(fault, result) {
    console.log({
        fault: fault,
        result: result
    });
});
    Was this article helpful?
    What's Next