chrome.app.runtime

説明

chrome.app.runtime API を使用してアプリのライフサイクルを管理します。アプリ ランタイムは、アプリのインストールを管理し、イベントページを制御します。また、アプリをいつでもシャットダウンできます。

型

EmbedRequest

プロパティ

  • データ

    任意（省略可）

    埋め込まれるアプリが埋め込みの決定を行う際に使用できる、デベロッパーが指定するオプションのデータ。

  • embedderId

    文字列

  • allow

    void

    embedderId がこのアプリを <appview> 要素に埋め込むことを許可します。url には、埋め込むコンテンツを指定します。

    allow 関数は次のようになります。 

    (url: string) => {...}

    • URL

      文字列

  • 拒否

    void

    embedderId がこのアプリを <appview> 要素に埋め込むのを防ぎます。

    deny 関数は次のようになります。 

    () => {...}

LaunchData

プロパティ

  • id

    文字列 省略可

    アプリが呼び出されるファイルまたは URL ハンドラの ID。ハンドラ ID は、マニフェストの file_handlers ディクショナリまたは url_handlers ディクショナリの最上位キーです。

  • isKioskSession

    ブール値（省略可）

    アプリが ChromeOS キオスク セッションで起動されているかどうか。

  • isPublicSession

    ブール値（省略可）

    Chrome 47 以降

    アプリが ChromeOS 公開セッションで起動されているかどうか。

  • アイテム

    LaunchItem[] 省略可

    file_handlers マニフェスト キー内の一致するファイル ハンドラによってトリガーされる onLaunched イベントのファイル エントリ。

  • referrerUrl

    文字列 省略可

    url_handlers マニフェストキー内の一致する URL ハンドラによってトリガーされた onLaunched イベントのリファラ URL。

  • ソース

    LaunchSource（省略可）

    アプリの起動元。

  • URL

    文字列 省略可

    url_handlers マニフェストキー内の一致する URL ハンドラによってトリガーされた onLaunched イベントの URL。

LaunchItem

プロパティ

  • 必要事項を入力します。

    エントリ

    商品アイテムのエントリ。

  • type

    文字列 省略可

    ファイルの MIME タイプ。

LaunchSource

アプリ起動元の列挙。これは、components/services/app_service/public/mojom/types.mojom の AppLaunchSource と、extensions/browser/api/app_runtime/app_runtime_api.cc の GetLaunchSourceEnum() と同期する必要があります。この列挙は UMA ヒストグラムで使用されるため、エントリの並べ替えや削除は行わないでください。

列挙型

「untracked」

"app_launcher"

"new_tab_page"

「reload」

「再起動」アイコン

"load_and_launch"

"command_line"

"file_handler"

"url_handler"

"system_tray"

"about_page"

「キーボード」

"extensions_page"

"management_api"

「ephemeral_app」

「background」

「kiosk」

"chrome_internal"

「test」

"installed_notification"

"context_menu"

「arc」

"intent_url"

"app_home_page"

"focus_mode"

「sparky」

イベント

onEmbedRequested

chrome.app.runtime.onEmbedRequested.addListener(
  callback: function,
)

埋め込みアプリがこのアプリの埋め込みをリクエストしたときに発生します。このイベントは、フラグ --enable-app-view を使用してデベロッパー チャンネルでのみ使用できます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (request: EmbedRequest) => void

onLaunched

chrome.app.runtime.onLaunched.addListener(
  callback: function,
)

ランチャーからアプリが起動されたときに呼び出されます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (launchData?: LaunchData) => void

onRestarted

chrome.app.runtime.onRestarted.addListener(
  callback: function,
)

Chrome の起動時に、Chrome が最後にシャットダウンされたときに実行されていたアプリに対して、または他の理由でアプリが以前の状態から再起動するようにリクエストされたときに（例: ユーザーがアプリの保持ファイルへのアクセス権を取り消すと、ランタイムがアプリを再起動します）呼び出されます。このような状況でアプリに onRestarted ハンドラがない場合、代わりに onLaunched イベントが送信されます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    () => void