Intents

API for controlling the Intents Resolver UI app.

The types of predefined data structures with which the app can work.

Description for the Intent.

Display name of the Intent. Can be used in context menus or other UI elements to visualize the Intent.

Icon for the Intent to be displayed in a UI.

Name of the Intent to register.

The type of predefined data structure which the Intent handler returns.

If true, will enable using the Intents Resolver UI for handling raised Intents. The Intents Resolver UI provides the user with a list of all available apps and running instances which can handle the raised Intent. In case there is only one Intent handler available, it will be automatically selected for handling the raised Intent, without displaying the Intents Resolver UI to the user.

Specify the name of your custom Intents Resolver app to be used for raised Intents. If not provided, the Intents API will use the default Intents Resolver UI app.

Interval in milliseconds to wait for a response from the 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 app 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 as 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.

Collection of objects describing Intent handler implementations for the Intent.

Name of the Intent.

Data passed as an argument to the Intent handler implementation.

Type of the predefined data structure.

The type of predefined data structure with which the Intent handler works.

Name of the Intent to retrieve.

The type of predefined data structure which the Intent handler returns.

User-friendly description of the app, as specified in the app configuration.

Icon of the app that has registered the Intent handler, as specified in the app configuration.

Name of the app that has registered the Intent, as specified in the app configuration.

Title of the app that has registered the Intent, as specified in the app configuration.

The types of predefined data structures with which the Intent handler works.

Display name of the Intent, as specified in the Intent definition.

ID of the running app instance.

Title of the app window.

The type of predefined data structure which the Intent handler returns.

The type of the Intent handler - an app declared as an Intent handler via its configuration, or a running instance of an app. Dynamically registered Intent handlers are considered running instances.

The types of predefined data structures with which the app can work.

Description for the Intent.

Display name of the Intent. Can be used in context menus or other UI elements to visualize the Intent.

Icon for the Intent to be displayed in a UI.

Name of the Intent to register.

The type of predefined data structure which the Intent handler returns.

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

Context data that will be provided to the Intent handler.

Collection of Intent handlers that can be presented to the user via an Intents Resolver UI. If there isn't an Intents Resolver app available (or if the list consists of only one handler), the first member of the collection will be used as an Intent handler.

Name of the intent to raise.

Settings that will be passed to the newly started app instance, if such is to be used as an Intent handler.

Target for the raised Intent. Use "startNew" to start a new instance of the first available Intent handler. Use "reuse" to reuse the first available running instance of an Intent handler. Will fall back to "startNew" if there are no running instances available. Use an object with optional app and instance properties to target specific apps or app instances. The app property accepts an app name, the instance property - an ID of a running app instance. Provide a value for the app property to start a new instance of a specific Intent handler app. Provide a value for the instance property to reuse a specific running instance of an Intent handler. If both app and instance are set, instance will take precedence.

Interval in milliseconds to wait for the raise() method to resolve when raising an Intent.

If true, the framework will wait for the user to choose a handler for the raised Intent from the Intents Resolver UI before starting the timeout specified in the timeout property of the Intent request. Otherwise, the timeout will start when the raise() method is invoked.

The Intent handler implementation used for handling the Intent.

The IntentRequest object used for raising the Intent.

Data returned by the Intent handler implementation.

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.