Intents

An object, which exposes the Intents Resolver API.

Whether to use Intents Resolver UI to handle raising an intent. The UI provides the user with a list of all available applications and running instances which can handle the raised intent. Default value: true

Specify your custom application name for Intents Resolver UI which will open when io.intents.raise() is invoked. If not provided, Intents API will use the default Intents Resolver UI application to handle raising an intent with multiple handlers

Timeout to wait for response from Intents Resolver UI

List of Intent handlers that satisfy the filter criteria.

List of objects describing the Intents associated with the specified Intent handler.

List of application names which will be used as a filter criteria

List of context types with which the Intent handlers work to be used as filter criteria.

Intent name to be used a filter criterion.

Flag indicating whether the Intents Resolver UI will open to provide the user with the list of valid Intent handlers.

Result type returned by the Intent handlers to be used as a filter criterion.

Interval in milliseconds to wait for the filterHandlers() method to resolve if more than one Intent handler is available and the Intents Resolver UI is enabled.

Title for the search operation that will be provided to the Intents Resolver UI.

The set of IntentHandler that provide an implementation for the intent and can be used to handle an intent request.

The name of the intent, such as "CreateCall".

The context data used as an argument by the intent implementation.

The name of a typed, documented data structure such as "Person", "Team", "Instrument", "Order", etc. It is the application developers' job to agree on a protocol to follow.

The name of the context type to be used in the lookup.

The name of the intent to be used in the lookup.

The type of the intent result to be used in the lookup.

The name of the application which registered this intent implementation, as specified in the application configuration.

The context types this handler supports.

The human-readable name of the intent handler, as specified in the intent definition.

The id of the running application instance.

The window's title of the running application instance.

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>"

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 addIntentListener().

If true, the previously saved Intent handler for this Intent (if any) will be cleared.

The context type and data that will be provided to the intent implementation's handler.

List of Intent Handlers which will be provided to the user via Intents Resolver UI. If the Resolver is disabled or there's only one handler in the array, raise() will resolve with the first application or instance in the collection.

The name of the intent to be raised.

Start up options that will be used when a new instance of an application needs to be started to handle the intent request.

Тhe target of the raised intent. Valid values are: startNew - will start a new instance of an application that can handle the intent. reuse - a running instance of an application will handle the intent. { app: "AppName" } - will start a new instance of the "AppName" application (iff it can handle it) that will handle the intent. { instance: "i-123-1" } - the running application instance with instanceId "i-123-1" will handle the intent (iff it can handle it).

Timeout to wait for 'raise' method to resolve.

Whether to wait for the Intents Resolver UI to choose a handler for the raised intent. If set to true, the timer starts after there's a chosen handler from the user. Otherwise, the start point is the beginning of the raise invocation.

The intent implementation that handled the intent.

The arguments that were used to raise the intent with.

The data returned by the intent implementation when handling the intent.

Details about the app instance that opened the Intents Resolver UI.

Criteria for filtering the available Intent handlers. Available only if the filterHandlers() method was used to open the Intents Resolver UI.

Name of the raised Intent.

Version of the Intents Resolver API.

Name of the app that opened the Intents Resolver UI.

Title of the app that opened the Intents Resolver UI.

ID of the Interop instance of the app that opened the Intents Resolver UI.

Icon of the Intent handler app.

Name of the Intent handler app.

Title of the Intent handler.

ID of the Intent handler app instance.

Use this property to supply the name of the Intent when the Intents Resolver UI is opened via the filterHandlers() method and you want to save the Intent handler for that Intent. If the Intents Resolver UI is opened via the raise() method, it isn't necessary to explicitly provide the Intent name here, as specifying an Intent name is mandatory when using the raise() method.

If true, the chosen Intent handler will be saved as a handler for the raised Intent. If the handler is saved, the next time the same Intent is raised, the Intents Resolver UI won't open and the saved handler will be used automatically.