• Back to Glue42 Enterprise Docs
Glue42 enterprise documentation

Reference Documentation

  • Back to Glue42 Enterprise Docs
Press/
  • Glue
  • Application Preferences
  • AppManager
  • Channels
  • Connection
  • Cookies
  • Displays
  • Hotkeys
  • Intents
  • Interop
  • Layouts
  • Logger
  • Metrics
  • Notifications
  • Pub Sub
  • Shared Contexts
  • Themes
  • Windows
  • Workspaces

AppManager

5.22.1

The Application Management API provides a way to manage Glue42 Enterprise applications. It offers abstractions for:

  • Application - a program as a logical entity, registered in Glue42 Enterprise with some metadata (name, description, icon, etc.) and with all the configuration needed to spawn one or more instances of it. The Application Management API provides facilities for retrieving application metadata and for detecting when an application is started.

  • Instance - a running copy of an application. The Application Management API provides facilities for starting/stopping application instances and tracking application related events.

App Management

The Application Management API is accessible through the glue.appManager object.

APIobject

Description

Application Management API

Properties

Property Type Default Required Description
inMemory InMemoryStore

In memory store for applications - allows you to import application definitions at runtime

Available since version Glue42 3.12
myApplication Application

Returns the current application.

myInstance Instance

Returns the current application instance.

Methods

  • application
  • applications
  • exit
  • getConfigurations
  • instances
  • onAppAdded
  • onAppAvailable
  • onAppChanged
  • onAppRemoved
  • onAppUnavailable
  • onInstanceStartFailed
  • onInstanceStarted
  • onInstanceStopped
  • onInstanceUpdated
  • onShuttingDown
  • ready
  • restart

applicationmethod

Signature

(name: string) => Application

Description

Returns an application by name.

Parameters

Name Type Required Description
name string

Name of the desired application.

applicationsmethod

Signature

() => Application[]

Description

Returns an array with all registered applications for the current branch.

exitmethod

Signature

(options?: ExitOpts) => Promise<any>

Description

Exits Glue42

Parameters

Name Type Required Description
options ExitOpts

getConfigurationsmethod

Signature

(apps?: string[]) => Promise<Definition[]>

Description

Returns the configuration of the applications.

Available since version Glue42 3.17

Parameters

Name Type Required Description
apps string[]

instancesmethod

Signature

() => Instance[]

Description

Returns an array with all running application instances.

onAppAddedmethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies when an application is registered in the environment.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback function to handle the event. Receives the added application as a parameter.

onAppAvailablemethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies when an application is available and can be started.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback function to handle the event. Receives the available application as a parameter.

onAppChangedmethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies when the configuration for an application has changed.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback function to handle the event. Receives the changed application as a parameter.

onAppRemovedmethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies when the application is removed from the environment.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback function to handle the event. Receives the removed application as a parameter.

onAppUnavailablemethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies when an application is no longer available and cannot be started.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback function to handle the event. Receives the unavailable application as a parameter.

onInstanceStartedmethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies when a new application instance has been started.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback function to handle the event. Receives the started application instance as a parameter.

onInstanceStartFailedmethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies when starting a new application instance has failed.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback function to handle the event. Receives the started application instance as a parameter.

onInstanceStoppedmethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies when an application instance has been stopped.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback function to handle the event. Receives the stopped application instance as a parameter.

onInstanceUpdatedmethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies when an application instance is updated.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback function to handle the event. Receives the updated application instance as a parameter.

onShuttingDownmethod

Signature

(callback: (args: ShuttingDownEventArgs) => Promise<{ prevent: boolean; }>) => void

Description

Notifies when Glue42 GD will shut down or restart. If you return a promise from the callback it will be waited (up until 60 sec) before shutdown continues

Available since version 5.4.0

Parameters

Name Type Required Description
callback (args: ShuttingDownEventArgs) => Promise<{ prevent: boolean; }>

Callback to handle the event. Receives as an argument object with the property restarting.

readymethod

Signature

() => Promise<void | {}>

Description

Notifies when the Application Management API is ready to be used.

restartmethod

Signature

(options?: ExitOpts) => Promise<any>

Description

Restarts Glue42

Available since version 4.7.0

Parameters

Name Type Required Description
options ExitOpts

Applicationobject

Description

Object describing an application.

Properties

Property Type Default Required Description
activityType string

The activity type associated with this application (populated only if this is an activity application).

Available since version 3.1.0
activityWindowType string

The activity window type associated with this application (populated only if this is an activity application).

Available since version 3.1.0
allowMultiple boolean true

If true, the application can have multiple instances.

Available since version 3.1.0
autoStart boolean

If true, the application is auto started with the framework.

Available since version 3.1.0
available boolean

If true, the application is available and can be started.

caption string

The caption of the application.

Available since version 3.1.0
configuration LegacyAppConfigProperties

Glue42 Desktop legacy configuration object for the application. This is kept for legacy applications, all properties are available in the application object now.

container string

The container identifier.

hidden boolean false

Whether the application is present in the Application Manager or not.

Available since version 3.1.0
icon string

Base64 string of the app icon.

iconURL string

The URL of the app icon.

instances Instance[]

Instances of that app.

isActivity boolean

If true, the application is an activity.

Available since version 3.0.8
isShell boolean false

Whether the application is a shell application.

keywords string[]

An array of keywords that can help discovering the application easier

mode "html" | "flat" | "tab" | "frameless" | "unknown"

Mode of the application window. If the application is running in a Glue42 window, the possible modes are "flat", "html" or "tab". If the mode cannot be determined (e.g., external apps, activity definitions), the value is "unknown".

name string

Application name.

sortOrder number

Sort indicator used when ordering apps in a list.

title string

Application title.

type string

Type of the application.

userProperties PropertiesObject

Custom configuration object attached to the application.

version string

Application version.

windowSettings WindowSettings

The window settings object passed to Glue42 Desktop.

Available since version 3.1.0

Methods

  • getConfiguration
  • onAvailable
  • onChanged
  • onInstanceStarted
  • onInstanceStopped
  • onRemoved
  • onUnavailable
  • start

getConfigurationmethod

Signature

() => Promise<Definition>

Description

Returns the configuration of the application.

Available since version Glue42 3.17

onAvailablemethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies you when the application becomes available.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback to handle the event. Receives the application object as an argument.

onChangedmethod

Signature

(callback: (app: Application) => any) => void

Description

Notifies you when the application configuration is changed.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback to handle the event. Receives the application object as an argument.

onInstanceStartedmethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies you when instances of this application are started.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback to handle the event. Receives the instance object as an argument.

onInstanceStoppedmethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies you when instances of this application are stopped.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback to handle the event. Receives the instance object as an argument.

onRemovedmethod

Signature

(callback: (app: Application) => any) => void

Description

Notifies you when the application is removed.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback to handle the event. Receives the application object as an argument.

onUnavailablemethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies you when the application becomes unavailable.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback to handle the event. Receives the application object as an argument.

startmethod

Signature

(context?: object, options?: ApplicationStartOptions) => Promise<Instance>

Description

Start an instance of the application.

Available since version 3.0.5

Parameters

Name Type Required Description
context object

Context to be passed to the started application.

options ApplicationStartOptions

Options object in which you can specify window setting (that will override the default configuration settings), as well as other additional options.

ApplicationStartOptionsobject

Description

Object with options for starting an application.

Properties

Property Type Default Required Description
allowChannels boolean false

If true, Channels will be enabled for the app and the window will show the Channel Selector.

allowClose boolean true

If false, the window will not contain a close button.

allowCollapse boolean true

If false, the window will not contain a collapse button.

allowExtract boolean false

If true, the window will contain an Extract button when in a window group. The button can be used to break out the window from the window group.

allowForward boolean true

If false, the window will not contain an activity related forward button.

allowLockUnlock boolean false

If false, the window will not contain a lock/unlock button.

allowMaximize boolean true

If false, the window will not contain a maximize button.

allowMinimize boolean true

If false, the window will not contain a minimize button.

allowTabClose boolean true

If false, the tab header will not contain a close button.

allowUnstick boolean true

If false, the window will not unstick from other windows.

autoAlign boolean true

If true, a snapped window will adjust its bounds to the same width/height of the window it has stuck to, and/or will occupy the space between other windows (if any).

autoSnap boolean true

If true, when moving the window operation ends, the window will snap to one of the approaching edges of another window (if any of the approaching edges are marked with red).

base64ImageSource string

Image as base64 encoded string that will be used as a taskbar icon for the window. The supported formats are png, ico, jpg, apng.

borderColor string

Can be a color name such as "red", or a hex-encoded RGB or ARGB value.

cascade { enabled?: boolean; offset?: number; }

Settings for opening new window instances of the same app in a cascade.

channelId string

Name of the Channel which the app will join.

collapseHeight number -1

Defines the height of the window when collapsed.

devToolsEnable boolean true

If true, allows opening a developer console (using F12) for the new window.

downloadSettings DownloadSettings

Object that defines file download behavior in the window.

focus boolean true

If false, the window will not be on focus when created.

hasMoveAreas boolean true

If false, the window cannot be moved.

hasSizeAreas boolean true

If false, the window cannot be resized by dragging its borders, maximizing, etc.

height number 400

Window height.

hidden boolean false

If true, the window will be started as a hidden window.

historyNavigationEnabled boolean true

If true, this will allow the users to navigate back (CTRL+Left) and forward (CTRL+Right) through the web page history.

ignoreFromLayouts boolean

If true, this window will not be saved when saving a layout, nor closed or restored when restoring a layout.

ignoreSavedLayout boolean false

If true, the application layout will not be saved on close and if a saved layout exists, it will be ignored.

isChild boolean false

If true, the window will open as a child window, sharing the lifetime and the environment of the opener.

isCollapsed boolean false

If true, the window will start collapsed.

isPopup boolean false

If true, the window will open as a child window, sharing the lifetime and the environment of the opener.

isSticky boolean true

If true, the window will stick to other Glue42 Windows forming groups.

left number 0

Distance of the top left window corner from the left edge of the screen.

loader Loader

Object that defines loader behavior.

maxHeight number

Specifies the maximum window height.

maxWidth number

Specifies the maximum window width.

minHeight number 30

Specifies the minimum window height.

minWidth number 50

Specifies the minimum window width.

mode WindowMode "flat"

Glue42 Window type. Possible values are flat, tab, html and frameless.

moveAreaThickness string "0, 12, 0, 0"

How much of the window area is to be considered as a moving area (meaning you can move the window using it). The string value corresponds to the left, top, right and bottom borders of the window. Setting moveAreaThickness to "0, 20, 0, 0" will set a 20 pixel thick move area at the top of the window.

moveAreaTopMargin string "0, 0, 0, 0"

Margin for the top window move area. The string value corresponds to the left, top, right and bottom borders of the move area. Setting moveAreaTopMargin to "10, 0, 0, 10" will take away 10 pixels from the left and the right side of the move area.

onTop boolean false

If true, the window will appear on top of the z-order.

placement PlacementSettings

Specifies the window position relative to the screen.

Available since version Glue42 3.11
relativeDirection RelativeDirection "right"

Direction ("bottom", "top", "left", "right") of positioning the window relatively to the relativeTo window. Considered only if relativeTo is supplied.

relativeTo string

The ID of the window that will be used to relatively position the new window. Can be combined with relativeDirection.

showInTaskbar boolean true

If false, the window won't appear on the Windows taskbar. This property won't work for apps of type "exe" unless they are registered as Glue42 Windows.

showTitleBar boolean true

Determines whether the window will have a title bar.

sizeAreaThickness string "5, 5, 5, 5"

How much of the window area is to be considered as a sizing area (meaning you can resize the window using that area). The string value corresponds to the left, top, right and bottom borders.

snappingEdges string "all"

Specifies the active Glue42 Window snapping edges. Possible values are: top, left, right, bottom, all or any combination of them (e.g., left, right).

startLocation string

Specifies the start window location. Possible options are center, topCenter, bottomCenter, leftCenter, rightCenter, full, topFull, bottomFull, leftFull, rightFull.

stickyFrameColor string "#5b8dc9"

Specifies the Glue42 window frame color. Accepts hex color as string (e.g. "#666666") or named HTML colors (e.g. "red").

stickyGroup string "Any"

If set, the Glue42 Window can only stick to windows that have the same group.

tabGroupId string

Specifies the tab group ID. If two or more tab windows are defined with the same ID, they will be hosted in the same tab window.

tabIndex number

The tab index of the current window. All tabs in a common tab container have different indices.

tabSelected boolean true

Tab is selected.

tabTitle string ""

The tab title.

tabTooltip string ""

The tab tooltip.

title string

Sets the window title. To work properly, there should be a title HTML tag in the page.

top number 0

Distance of the top left window corner from the top edge of the screen.

urlLoadOptions LoadURLOptions

Options for loading the window URL. Can be used for POST requests like uploading a file or specifying additional headers.

Available since version Glue42 3.17
useRandomFrameColor boolean false

If true, this will set a random (from a predefined list of colors) frame color to the new window.

waitForAGMReady boolean true

Whether to wait for the Interop library to be initialized.

width number 400

Window width.

windowState FrameState "normal"

If set, the window will start in the specified state (maximized, minimized, normal).

AppManagerobject

Description

Application Management API that allows you to handle your Glue42 enabled applications.

Methods

  • application
  • applications
  • getConfigurations
  • getConfigurations
  • instances
  • onAppAdded
  • onAppAvailable
  • onAppChanged
  • onAppRemoved
  • onAppUnavailable
  • onInstanceStartFailed
  • onInstanceStarted
  • onInstanceStopped
  • onInstanceUpdated

applicationmethod

Signature

(name: string) => Application

Description

Returns an application by name.

Parameters

Name Type Required Description
name string

Name of the desired application.

applicationsmethod

Signature

() => Application[]

Description

Returns an array with all registered applications for the current branch.

getConfigurationsmethod

Signature

(apps?: string[]) => Promise<Definition[]>

Description

Returns the configuration of the applications.

Available since version Glue42 3.17

Parameters

Name Type Required Description
apps string[]

getConfigurationsmethod

Signature

(apps?: string[]) => Promise<Definition[]>

Parameters

Name Type Required Description
apps string[]

instancesmethod

Signature

() => Instance[]

Description

Returns an array with all running application instances.

onAppAddedmethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies when an application is registered in the environment.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback function to handle the event. Receives the added application as a parameter.

onAppAvailablemethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies when an application is available and can be started.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback function to handle the event. Receives the available application as a parameter.

onAppChangedmethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies when the configuration for an application has changed.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback function to handle the event. Receives the changed application as a parameter.

onAppRemovedmethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies when the application is removed from the environment.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback function to handle the event. Receives the removed application as a parameter.

onAppUnavailablemethod

Signature

(callback: (app: Application) => any) => UnsubscribeFunction

Description

Notifies when an application is no longer available and cannot be started.

Parameters

Name Type Required Description
callback (app: Application) => any

Callback function to handle the event. Receives the unavailable application as a parameter.

onInstanceStartedmethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies when a new application instance has been started.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback function to handle the event. Receives the started application instance as a parameter.

onInstanceStartFailedmethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies when starting a new application instance has failed.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback function to handle the event. Receives the started application instance as a parameter.

onInstanceStoppedmethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies when an application instance has been stopped.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback function to handle the event. Receives the stopped application instance as a parameter.

onInstanceUpdatedmethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies when an application instance is updated.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback function to handle the event. Receives the updated application instance as a parameter.

Definitionobject

Properties

Property Type Default Required Description
activityTarget ActivityTarget
allowCapture boolean

If true, this app will be allowed to capture display/window/group screenshots through the 'glue.displays' API

allowCookiesManipulation boolean

If true, the app can query and modify the session cookies.

allowHeadersManipulation boolean

If true, the app can query and modify the request headers.

allowLogging boolean

If true, this app will be allowed to log in a custom file in 'UserData/logs/application' through the 'glue.log' API

allowMultiple boolean

If true, multiple instances of the application can be started.

allowRegisteringWorkspaceShortcuts boolean

Will allow registering shortcuts in any workspace.

allowWorkspaceDrop boolean

If false, the user won't be able to drop the app in a Workspace.

asset { src?: string; headers?: { name: string; value: string; }[]; noCache?: boolean; }

Configuration for an archived app that will be downloaded and extracted at a specified location. The default location is %LocalAppData%/Tick42/UserData/%GLUE-ENV%-%GLUE-REGION%/remoteApps/<app-name> where <app-name> is the name of the app as defined in its configuration. The default location can be changed using the "userData" property of the "folders" top-level key in the system.json configuration file of Glue42 Enterprise. You can also use the $ASSET_LOCATION$ macro pointing to the default location of the extracted app when defining the "path" or the "url" property of your app.

autoStart boolean

If true, the application will auto start.

caption string

User friendly (longer) description that can be used by the Glue42 Desktop clients to show more detailed application information.

closeOnHibernate boolean

Whether to close the application when it is part of a hibernating layout.

configMode "All" | "File" | "CM"

Specifies in which Glue42 Desktop configuration mode these applications will be available.

customProperties { [k: string]: any; }

These name/value pairs are sent to the Glue42 Desktop clients. The Application Manager API exposes them as well, allowing custom UIs to interpret and use the values.

details WindowConfig | ActivityConfig | ExeConfig | NodeConfig | CanvasConfig | WorkspacesConfig | WebGroupConfig | ClickOnceConfig | CitrixConfig | ChildWindowConfig

Detailed configuration based on the application type.

disabled boolean

If true, the application will be disabled.

hidden boolean

If true, the application will not be visible in the App Manager.

icon string

URL or the Base64 encoding (only the data part from the URI scheme) of the icon used as a taskbar icon for the application.

ignoreFromLayouts boolean

If true, this app will not be saved when saving a layout, nor closed or restored when restoring a layout.

ignoreSavedLayout boolean

If true, the application default layout will not be auto saved when it is closed and on the next start, if the layout exists, it will be ignored.

ignoreSaveOnClose boolean

Deprecated. Use ignoreSavedLayout instead.

intents Intent[]
keywords string[]

An array of keywords that can help discovering the application easier

launcherApp string

Name of the application to be used to launch this app.

name string

Name of the application. Should be unique.

noDelayedRestore boolean

If true, the application will always be restored directly when restoring workspaces (no delayed or lazy restore for this app).

requiresSSO boolean

This option is valid for system and auto start applications and if it is true, they will auto start after a successful SSO login. Note that user applications are always initialized (and this way auto started) after SSO login, so this option is useless for them.

reuseInLayouts boolean

If true and the app is part of a hibernated Layout, one or more of its available instances will be reused when resuming another Layout that contains the same app.

runPriority number

If the runPriority property is missing or is zero, the application is considered to be low priority, i.e. all current applications will be low priority until someone changes/sets their runPriority configurations.

saveMultipleInstances boolean

When false, only the last application (or activity) instance will be saved in the default (startup) layout. When true, all instances will be saved.

service boolean

If true, the application will not be closed when saving and restoring a layout.

shell boolean

This option is valid for system applications and if true, the application will start after Glue42 Desktop initialization. Usually, this is a container based web UI application which acts as a Glue42 Desktop client.

shortcut string

Will be registered as global shortcut and will start the app or focus it.

shutdownApplicationName string

Specify another application to be started in order to shut down the current application instances.

sortOrder number

Defines the (ascending) order used by Glue42 Desktop when sending the user applications list to its clients.

supportEmails string[]

Emails of the owners of the application

suspendMetrics boolean

If true, the application won't publish any metrics.

title string

Title used when visualizing the application.

tooltip string

Tooltip (extended description) that will be used when visualizing the application.

type "window" | "activity" | "exe" | "node" | "canvas" | "workspaces" | "webGroup" | "clickonce" | "citrix" | "childWindow"

Type of the application.

version string

Version of the application.

ImportResultobject

Properties

Property Type Default Required Description
errors { app: string; error: string; }[]
imported string[]

InMemoryStoreobject

Methods

  • clear
  • export
  • import
  • remove

clearmethod

Signature

() => Promise<void>

Description

Removes all applications from the store

exportmethod

Signature

() => Promise<Definition[]>

Description

Exports all known application definitions from the in memory store

importmethod

Signature

(definitions: Definition[], mode?: "replace" | "merge") => Promise<ImportResult>

Description

Imports the provided collection of application definitions.

Parameters

Name Type Required Description
definitions Definition[]

A collection of application definition objects to be imported.

mode "replace" | "merge"

Import mode, by default it is "replace". "replace" mode replaces all existing definitions with the provided collection, "merge" mode adds (if new) or updates (if already existing) the provided definitions.

removemethod

Signature

(name: string) => Promise<void>

Description

Removes an app definition. If removed successfully, this will fire an event that can be handled with the onAppRemoved() method.

Parameters

Name Type Required Description
name string

The name of the application to be removed.

Instanceobject

Description

Object describing an application instance

Properties

Property Type Default Required Description
activity Glue42

Returns the activity object if the instance is part of an activity.

activityId string

The activity ID (only if the apps is part of an activity).

Available since version 3.0.8
activityInstances Instance[]

Returns the instances of the other windows in the activity if this instance is part of an activity.

Available since version 3.0.8
activityOwnerInstance Instance

Returns the instance of the owner window of the activity if this instance is part of an activity.

Available since version 3.0.8
agm Partial<Instance>

Interop instance. Use this to invoke Interop methods for that instance.

application Application

The application object of that instance.

context object

The starting context of the instance.

id string

Instance ID.

inActivity boolean

If true, the instance is running as part of an activity.

Available since version 3.0.8
isActivityInstance boolean

Whether the application instance is an activity instance.

Available since version 3.0.8
isSingleWindowApp boolean

If true, the instance is running as a single window application (not part of an activity).

Available since version 3.0.8
title string

Title of the instance.

window GDWindow

The window associated with the instance (as an object from the Window Management API). If the application instance is an activity instance, this is undefined.

Available since version 3.0.8

Methods

  • activate
  • getContext
  • getWindow
  • onAgmReady
  • onStopped
  • stop

activatemethod

Signature

() => Promise<InvocationResult<any>>

Description

Activates the instance.

getContextmethod

Signature

() => Promise<object>

getWindowmethod

Signature

() => Promise<GDWindow>

Description

Retrieves the window object corresponding to that instance

Available since version 3.6.7

onAgmReadymethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies when the Interop library is ready to be used.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback function to handle the event. Receives the instance as an argument.

onStoppedmethod

Signature

(callback: (instance: Instance) => any) => UnsubscribeFunction

Description

Notifies when the instance is stopped.

Parameters

Name Type Required Description
callback (instance: Instance) => any

Callback function to handle the event. Receives the instance as an argument.

stopmethod

Signature

() => Promise<void>

Description

Stops the instance.

Intentobject

Description

An intent definition.

Properties

Property Type Default Required Description
contexts string[]

A comma separated list of the types of contexts the intent offered by the application can process, here the first part of the context type is the namespace e.g."fdc3.contact, org.symphony.contact".

customConfig object

Custom configuration for the intent that may be required for a particular desktop agent.

displayName string

An optional display name for the intent that may be used in UI instead of the name.

name string

The name of the intent to 'launch'. In this case the name of an Intent supported by an Application.

resultType string

Metadata describing the return type of the callback which handles the intent. May be a type name, the string "channel" (which indicates that the app will return a channel) or a string indicating a channel that returns a specific type, e.g. "channel<fdc3.instrument>"

LegacyAppConfigPropertiesobject

Description

Legacy application configuration options.

Properties

Property Type Default Required Description
activityType string

Activity type (if the application is in an activity).

allowMultiple boolean

If true, multiple instances of the app can be started.

autoStart boolean

Whether to auto start the application.

caption string

Caption for the application.

container string

Container identifier.

hidden boolean

PropertiesObjectobject

Description

Generic object for passing properties, settings, etc., in the for of key/value pairs.

ShuttingDownEventArgsobject

Properties

Property Type Default Required Description
initiator Instance
reason string
restarting boolean
  • © 2023 Glue42
  • Home
  • Privacy policy
  • Contact Sales
  • Glue42.com
  • Tick42.com
  • Overview
  • API
  • Application
  • ApplicationStartOptions
  • AppManager
  • Definition
  • ImportResult
  • InMemoryStore
  • Instance
  • Intent
  • LegacyAppConfigProperties
  • PropertiesObject
  • ShuttingDownEventArgs
Navigate
Go