chrome.app.runtime

説明

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

型

EmbedRequest

プロパティ

  • データ

    any 省略可

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

  • embedderId

    文字列

  • allow

    void

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

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

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

    • URL

      文字列

  • 拒否

    void

    embedderId がこのアプリを <appview> 要素に埋め込めないようにします。

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

    () => {...}

LaunchData

プロパティ

  • id

    文字列 省略可

    アプリの呼び出しに使用されるファイルまたは URL ハンドラの ID。ハンドラ ID は、マニフェストの file_handlers 辞書または url_handlers 辞書の最上位キーです。

  • isKioskSession

    boolean 省略可

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

  • isPublicSession

    boolean 省略可

    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"

「再読み込み」

「再起動」

"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"

"intent_url"

"app_home_page"

"focus_mode"

「sparky」

イベント

onEmbedRequested

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

埋め込みアプリがこのアプリの埋め込みをリクエストしたときに呼び出されます。このイベントは、--enable-app-view フラグを指定した Dev チャンネルでのみ使用できます。

パラメータ

  • 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