chrome.app.runtime

説明

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

型

ActionData

Chrome 54 以降

プロパティ

  • actionType

    "new_note"

ActionType

Chrome 54 以降

アプリは、新しいメモの作成など、特定のアクションを念頭に置いて起動できます。アプリが起動されたアクションのタイプは、LaunchData インスタンスの actionData フィールドで確認できます。

値

EmbedRequest

プロパティ

  • データ

    任意（省略可）

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

  • embedderId

    文字列

  • allow

    void

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

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

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

    • URL

      文字列

  • 拒否

    void

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

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

    () => {...}

LaunchData

プロパティ

  • actionData

    ActionData 省略可

    Chrome 54 以降

    このアプリの起動に使用された ActionType を指定するデータが含まれています。アプリが特定のアクション インテントで起動されていない場合は null になります。

  • 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 ヒストグラムでは列挙値が使用されるため、エントリの並べ替えや削除は行わないでください。

列挙型

"app_launcher"

"new_tab_page"

「再起動」アイコン

"command_line"

"extensions_page"

「test」

"app_home_page"

"focus_mode"

イベント

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