chrome.notifications

説明

chrome.notifications API を使用すると、テンプレートを使用してリッチ通知を作成し、システムトレイにその通知を表示できます。

権限

notifications

型

NotificationBitmap

NotificationButton

プロパティ

  • iconUrl

    文字列（省略可）

    <ph type="x-smartling-placeholder"></ph> Chrome 59 以降、サポートが終了しています

    Mac OS X ユーザーにはボタン アイコンが表示されません。

  • title

    文字列

NotificationItem

プロパティ

  • メッセージ

    文字列

    このアイテムに関する補足情報。

  • title

    文字列

    リスト通知の 1 つのアイテムのタイトル。

NotificationOptions

プロパティ

  • appIconMaskUrl

    文字列（省略可）

    <ph type="x-smartling-placeholder"></ph> Chrome 59 以降、サポートが終了しています

    アプリアイコンのマスクは、Mac OS X ユーザーには表示されません。

    アプリアイコン マスクの URL。URL には iconUrl と同じ制限が適用されます。

    画像のアルファ チャンネルのみが考慮されるため、アプリアイコン マスクはアルファ チャンネルに配置する必要があります。

  • buttons

    NotificationButton[] オプション

    最大 2 つの通知操作ボタンのテキストとアイコン。

  • contextMessage

    文字列（省略可）

    別の通知コンテンツを、フォントの太さを下げたままにします。

  • eventTime

    数値（省略可）

    通知に関連付けられているタイムスタンプ。エポックからのミリ秒単位の経過時間（例: Date.now() + n）。

  • iconUrl

    文字列（省略可）

    送信者のアバター、アプリアイコン、画像通知のサムネイルへの URL。

    URL には、データ URL、blob URL、またはこの拡張機能の .crx ファイル内のリソースに対する相対 URL を指定できます。

    **注:**この値は notifications.create() メソッドに必要です。

  • imageUrl

    文字列（省略可）

    <ph type="x-smartling-placeholder"></ph> Chrome 59 以降、サポートが終了しています

    Mac OS X ユーザーにはイメージは表示されません。

    画像タイプ通知の画像サムネイルの URL。URL には iconUrl と同じ制限が適用されます。

  • isClickable

    ブール値（省略可）

    <ph type="x-smartling-placeholder"></ph> Chrome 67 以降非推奨

    この UI ヒントは Chrome 67 で無視される

  • アイテム

    NotificationItem[] はオプション

    複数アイテムの通知用のアイテム。Mac OS X を使用している場合は、最初の項目のみが表示されます。

  • メッセージ

    文字列（省略可）

    メインの通知内容。

    **注:**この値は notifications.create() メソッドに必要です。

  • priority

    数値（省略可）

    優先度の範囲は -2 ～ 2 です。-2 が最も低い優先度です。2 が最高です。デフォルトはゼロです。通知センターをサポートしていないプラットフォーム（Windows、Linux、Mac）では、-2 と -1 を指定するとエラーになります。これらの優先度を持つ通知はまったく表示されないためです。

  • 再生状況

    数値（省略可）

    現在の進捗状況の範囲は 0 ～ 100 です。

  • requireInteraction

    ブール値（省略可）

    Chrome 50 以降

    ユーザーが通知を有効にするか終了するまで、通知を表示したままにすることを示します。デフォルトは false です。

  • サイレント

    ブール値（省略可）

    Chrome 70 以降

    通知の表示中に音やバイブレーションを鳴らさないことを示します。デフォルトは false です。

  • title

    文字列（省略可）

    通知のタイトル（例: メールの送信者名）。

    **注:**この値は notifications.create() メソッドに必要です。

  • type

    TemplateType（省略可）

    表示する通知のタイプ。notifications.create メソッドでは必須です。

PermissionLevel

列挙型

"granted"
アプリや拡張機能からの通知を表示することをユーザーが選択したことを示します。これはインストール時のデフォルトです。

"denied"
ユーザーがアプリまたは拡張機能からの通知を表示しないよう選択していることを示します。

TemplateType

列挙型

"basic"
アイコン、タイトル、メッセージ、展開されたメッセージ、最大 2 つのボタンが含まれます。

"image"
アイコン、タイトル、メッセージ、展開済みメッセージ、画像、最大 2 つのボタンが含まれます。

"リスト"
アイコン、タイトル、メッセージ、アイテム、最大 2 つのボタンが含まれます。Mac OS X ユーザーには最初の項目のみが表示されます。

"progress"
アイコン、タイトル、メッセージ、進行状況、最大 2 つのボタンが含まれます。

メソッド

clear()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

指定した通知を消去します。

パラメータ

  • notificationId

    文字列

    消去する通知の ID。これは notifications.create メソッドによって返されます。

  • callback

    関数（省略可）

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

    (wasCleared: boolean) => void

    • wasCleared

      ブール値

戻り値

  • Promise&lt;boolean&gt;

    Chrome 116 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

create()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
)

通知を作成して表示します。

パラメータ

  • notificationId

    文字列（省略可）

    通知の ID。未設定または空の場合、ID が自動的に生成されます。既存の通知と一致する場合、このメソッドは、作成オペレーションを続行する前に、まずその通知を消去します。識別子は 500 文字以下にする必要があります。

    Chrome 42 より前のバージョンでは、notificationId パラメータが必須です。

  • オプション

    NotificationOptions

    通知の内容。

  • callback

    関数（省略可）

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

    (notificationId: string) => void

    • notificationId

      文字列

戻り値

  • Promise<文字列>

    Chrome 116 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getAll()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.notifications.getAll(
  callback?: function,
)

このアプリまたは拡張機能のすべての通知を取得します。

パラメータ

  • callback

    関数（省略可）

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

    (notifications: object) => void

    • 通知

      オブジェクト

戻り値

  • Promise&lt;object&gt;

    Chrome 116 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getPermissionLevel()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.notifications.getPermissionLevel(
  callback?: function,
)

ユーザーがこのアプリまたは拡張機能からの通知を有効にしているかどうかを取得します。

パラメータ

戻り値

  • Promise&lt;PermissionLevel&gt;

    Chrome 116 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

update()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
)

既存の通知を更新します。

パラメータ

  • notificationId

    文字列

    更新する通知の ID。これは notifications.create メソッドによって返されます。

  • オプション

    NotificationOptions

    更新する通知の内容。

  • callback

    関数（省略可）

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

    (wasUpdated: boolean) => void

    • wasUpdated

      ブール値

戻り値

  • Promise&lt;boolean&gt;

    Chrome 116 以降

    Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

イベント

onButtonClicked

chrome.notifications.onButtonClicked.addListener(
  callback: function,
)

ユーザーが通知内のボタンを押しました。

パラメータ

  • callback

    関数

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

    (notificationId: string, buttonIndex: number) => void

    • notificationId

      文字列

    • buttonIndex

      数値

onClicked

chrome.notifications.onClicked.addListener(
  callback: function,
)

ユーザーが通知のボタン以外の領域をクリックした。

パラメータ

  • callback

    関数

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

    (notificationId: string) => void

    • notificationId

      文字列

onClosed

chrome.notifications.onClosed.addListener(
  callback: function,
)

システムまたはユーザーの操作によって閉じられた通知。

パラメータ

  • callback

    関数

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

    (notificationId: string, byUser: boolean) => void

    • notificationId

      文字列

    • byUser

      ブール値

onPermissionLevelChanged

chrome.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

ユーザーが権限レベルを変更する。Chrome 47 の時点で、このイベントをディスパッチする UI は ChromeOS でのみご利用いただけます。

パラメータ

onShowSettings

<ph type="x-smartling-placeholder"></ph> Chrome 65 以降非推奨
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

カスタム通知設定ボタンのサポートは終了しました。

ユーザーがアプリの通知設定のリンクをクリックしました。Chrome 47 の時点で、このイベントをディスパッチする UI は ChromeOS でのみご利用いただけます。この UI は、Chrome 65 の時点で ChromeOS からも削除されました。

パラメータ

  • callback

    関数

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

    () => void