ScenePerformActionForShortcutItemEventData

Defined in: application/application-interfaces.ts

iOS event data for the scenePerformActionForShortcutItem event, raised when a home screen quick action targets a scene.

Replaces the applicationPerformActionForShortcutItemCompletionHandler app delegate callback, which UIKit no longer calls once the app adopts scenes.

Extends ​

• SceneEventData

Properties ​

android? ​

optional android?: any;

Defined in: application/application-interfaces.ts

Gets the native Android event arguments. Valid only when running on Android.

Inherited from ​

SceneEventData.android

completionHandler ​

completionHandler: (handled: boolean) => void;

Defined in: application/application-interfaces.ts

Reports back to iOS whether the action was handled. Only the first call is delivered; later ones are ignored.

Unless a legacy applicationPerformActionForShortcutItemCompletionHandler handler is registered — in which case that handler owns the result — the action is reported as unhandled as soon as the listeners return, so a listener that wants to report otherwise must call this before returning.

Parameters ​

Returns ​

void

connectionOptions? ​

optional connectionOptions?: UISceneConnectionOptions;

Defined in: application/application-interfaces.ts

Scene connection options (for sceneWillConnect event).

Inherited from ​

SceneEventData.connectionOptions

eventName ​

eventName: string;

Defined in: application/application-interfaces.ts

The name of the event.

Inherited from ​

SceneEventData.eventName

ios? ​

optional ios?: any;

Defined in: application/application-interfaces.ts

Gets the native iOS event arguments. Valid only when running on iOS.

Inherited from ​

SceneEventData.ios

object ​

object: any;

Defined in: application/application-interfaces.ts

The instance that has raised the event.

Inherited from ​

SceneEventData.object

scene? ​

optional scene?: UIWindowScene;

Defined in: application/application-interfaces.ts

The UIWindowScene instance associated with this event.

Inherited from ​

SceneEventData.scene

shortcutItem ​

shortcutItem: UIApplicationShortcutItem;

Defined in: application/application-interfaces.ts

The quick action the user selected.

uiWindow? ​

optional uiWindow?: UIWindow;

Defined in: application/application-interfaces.ts

The UIWindow associated with this scene (if applicable).

Inherited from ​

SceneEventData.uiWindow

userInfo? ​

optional userInfo?: NSDictionary<any, any>;

Defined in: application/application-interfaces.ts

Additional user info from the notification.

Inherited from ​

SceneEventData.userInfo

window? ​

optional window?: NativeWindow;

Defined in: application/application-interfaces.ts

The NativeWindow the scene belongs to, when one is registered for it.

Inherited from ​

SceneEventData.window