chrome.app.runtime

説明

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

型

ActionData

Chrome 54 以降

プロパティ

  • actionType

    "new_note"

ActionType

Chrome 54 以降

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

価値

"new_note"

EmbedRequest

プロパティ

  • データ

    任意

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

  • embedderId

    string

  • allow

    void

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

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

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

    • URL

      string

  • 拒否

    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 の公開セッションで起動されているかどうか。

  • items

    LaunchItem[] 省略可

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

  • referrerUrl

    文字列（省略可）

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

  • source

    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"

"restart"

"load_and_launch"

"command_line"

"file_handler"

"url_handler"

"system_tray"

"about_page"

"extensions_page"

"management_api"

"ephemeral_app"

"test"

"arc"

"intent_url"

"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