Skip to main content

Represents a request to raise an intent.

Properties (8)

Property Type Default Required Description
clearSavedHandler⚓︎ boolean false x

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

context⚓︎ IntentContext x x

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

handlers⚓︎ IntentHandler[] x x

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.

intent⚓︎ string x

The name of the intent to be raised.

options⚓︎ ApplicationStartOptions x x

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

target⚓︎ "startNew" | "reuse" | { app?: string; instance?: string } x x

Т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⚓︎ number : 90000 x

Timeout to wait for 'raise' method to resolve.

waitUserResponseIndefinitely⚓︎ boolean : false x

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.