chrome.app.runtime

説明

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

型

ActionData

Chrome 54 以降

プロパティ

  • actionType

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

    string（省略可）

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

  • isKioskSession

    ブール値（省略可）

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

  • isPublicSession

    ブール値（省略可）

    Chrome 47 以降

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

  • items

    LaunchItem[] 省略可

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

  • referrerUrl

    string（省略可）

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

  • source

    LaunchSource 省略可

    アプリの起動元。

  • url

    string（省略可）

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

LaunchItem

プロパティ

  • エントリ

    エントリ

    アイテムのエントリ。

  • type

    string（省略可）

    ファイルの MIME タイプ。

LaunchSource

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

列挙型

"command_line"

"url_handler"

"management_api"

"kiosk"

"test"

"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