chrome.app.runtime
- Description
Use the
chrome.app.runtime
API to manage the app lifecycle. The app runtime manages app installation, controls the event page, and can shut down the app at anytime.
Summary
- Types
- Events
Types
ActionData
Since Chrome 54.
Properties
- actionTypestring "new_note"
EmbedRequest
Properties
- allowfunction
Allows
embedderId
to embed this app in an <appview> element. Theurl
specifies the content to embed.The allow function looks like this:
allow(url: string) => {...}
- urlstring
- dataany optional
Optional developer specified data that the app to be embedded can use when making an embedding decision.
- denyfunction
Prevents
embedderId
from embedding this app in an <appview> element.The deny function looks like this:
deny() => {...}
- embedderIdstring
LaunchData
Properties
- actionDataActionData optional
Since Chrome 54.
Contains data that specifies the
ActionType
this app was launched with. This is null if the app was not launched with a specific action intent. - idstring optional
The ID of the file or URL handler that the app is being invoked with. Handler IDs are the top-level keys in the
file_handlers
and/orurl_handlers
dictionaries in the manifest. - isKioskSessionboolean optional
Whether the app is being launched in a Chrome OS kiosk session.
- isPublicSessionboolean optional
Since Chrome 47.
Whether the app is being launched in a Chrome OS public session.
- itemsLaunchItem[] optional
The file entries for the
onLaunched
event triggered by a matching file handler in thefile_handlers
manifest key. - referrerUrlstring optional
The referrer URL for the
onLaunched
event triggered by a matching URL handler in theurl_handlers
manifest key. - sourceLaunchSource optional
Since Chrome 40.
Where the app is launched from.
- urlstring optional
The URL for the
onLaunched
event triggered by a matching URL handler in theurl_handlers
manifest key.
LaunchItem
Properties
- entryEntry
Entry for the item.
- typestring optional
The MIME type of the file.
ActionType
Since Chrome 54.
An app can be launched with a specific action in mind, for example, to create a new note. The type of action the app was launched with is available inside of the actionData
field from the LaunchData instance.
Enum
"new_note"
LaunchSource
Since Chrome 40.
Enumeration of app launch sources. This should be kept in sync with AppLaunchSource in components/services/app_service/public/mojom/types.mojom, and GetLaunchSourceEnum() in extensions/browser/api/app_runtime/app_runtime_api.cc. Note the enumeration is used in UMA histogram so entries should not be re-ordered or removed.
Enum
"untracked"
, "app_launcher"
, "new_tab_page"
, "reload"
, "restart"
, "load_and_launch"
, "command_line"
, "file_handler"
, "url_handler"
, "system_tray"
, "about_page"
, "keyboard"
, "extensions_page"
, "management_api"
, "ephemeral_app"
, "background"
, "kiosk"
, "chrome_internal"
, "test"
, "installed_notification"
, "context_menu"
, "arc"
, or "intent_url"
Events
onEmbedRequested
app.runtime.onEmbedRequested.addListener(listener: function)
Fired when an embedding app requests to embed this app. This event is only available on dev channel with the flag --enable-app-view.
Event
- listenerfunction
The listener parameter should be a function that looks like this:
(request: EmbedRequest) => {...}
- request
onLaunched
app.runtime.onLaunched.addListener(listener: function)
Fired when an app is launched from the launcher.
Event
- listenerfunction
The listener parameter should be a function that looks like this:
(launchData: LaunchData) => {...}
- launchData
onRestarted
app.runtime.onRestarted.addListener(listener: function)
Fired at Chrome startup to apps that were running when Chrome last shut down, or when apps have been requested to restart from their previous state for other reasons (e.g. when the user revokes access to an app's retained files the runtime will restart the app). In these situations if apps do not have an onRestarted
handler they will be sent an onLaunched
event instead.
Event
- listenerfunction
The listener parameter should be a function that looks like this:
() => {...}