Unity Action API

Introduction

Unity Action API offers a way to easily integrate with the Unity components outside of the application such as the Launcher, HUD, AppMenu and MessagingMenu.

Applications have internally different types of actions with different life-cycles. Some actions are application wide that are relevant and available throughout the whole life-cycle of the application. Other actions are context specific and only available when the application is in certain visual state, such as in image editing mode. See Action Contexts for more details.

Application can define application wide actions dynamically during runtime and as offline (jumplist) actions that are available even if the application is not running. Activating an offline action will launch the application when necessary.

Unity Action API can be used with three ways:

  • - using the Qt C++ API (see the C++ documentation)
  • - Using this QML API directly
  • - Using the UI Toolkit

UI Toolkit simplifies the ActionContext management and provides ActionManager as part of the MainView. See the UI Toolkit documentation for more details.

General Topics Reporting Bugs

If you find any problems with the or this documentation, please file a bug in Unity Action API Launchpad page

Components

Available through:

import Ubuntu.Unity.Action 1.0
Base Items

Action

The main action class.

ActionContext

ActionManager

PreviewAction

previewable action

Paramaters

PreviewRangeParameter

Non-Instantiable

PreviewParameter