IntentHandlerinterface
Represents an implementation of an intent. Each intent handler can offer its own display name - this allows context menus built on the fly to display more user friendly options. For example, if there is an intent with a name "ShowNews", there could be a handler with display name "Show Bloomberg News" and another with display name "Show Reuters News". Handlers can optionally specify the context type they support, where the context type is the name of a typed, documented data structure such as "Person", "Team", "Instrument", "Order", etc. In the example above, both the Bloomberg and Reuters handlers would specify a context type "Instrument" and would expect to be raised with an instrument object conforming to an expected structure from both handlers. An intent handler must not necessarily specify a context type.
Properties (11)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| applicationDescription⚓︎ | string | x | x | x |
| applicationIcon⚓︎ | string | x | x | x |
| applicationName⚓︎ | string | x | The name of the application which registered this intent implementation, as specified in the application configuration. |
|
| applicationTitle⚓︎ | string | x | x | x |
| contextTypes⚓︎ | string[] | x | x | The context types this handler supports. |
| customConfig⚓︎ | { [key: string]: any } | x | x | Object containing custom configuration for the Intent handler provided via the app definition or dynamically. io.Connect Browser 4.2 |
| displayName⚓︎ | string | x | x | The human-readable name of the intent handler, as specified in the intent definition. |
| instanceId⚓︎ | string | x | x | The id of the running application instance. |
| instanceTitle⚓︎ | string | x | x | The window's title of the running application instance. |
| resultType⚓︎ | string | x | x | Result type 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>" |
| type⚓︎ | "app" | "instance" | x | The type of the handler.
"app" - An application that has declared itself as an implementor of the intent inside of its application definition.
"instance" - A running instance of an application that can handle the intent. Also includes dynamically added intents using |