Notification
デスクトップ通知を作成します。
プロセス: Main
レンダラープロセスから通知を表示したい場合は、ウェブの Notification API を使用する必要があります
クラス: Notification
デスクトップ通知を作成します。
プロセス: Main
Notification
は EventEmitter を継承しています。
options
によって設定されたネイティブプロパティで新しい Notification
を生成します。
静的メソッド
Notification
クラスには、次の静的メソッドがあります。
Notification.isSupported()
戻り値 boolean
- 現在のシステムでデスクトップ通知がサポートされているかどうか。
new Notification([options])
インスタンスイベント
new Notification
で作成されたオブジェクトでは以下のイベントが発生します。
いくつかのイベントは特定のオペレーティングシステムでのみ利用可能で、そのように注記がつけられています。
イベント: 'show'
戻り値:
event
Event
ユーザに通知が表示されると発行されます。 注意として、通知は show()
メソッドを介すると複数回表示できるので、このイベントは複数回起こることがあります。
イベント: 'click'
戻り値:
event
Event
ユーザによって通知がクリックされたときに発行されます。
イベント: 'close'
戻り値:
event
Event
ユーザの手によって手動で通知が閉じられたときに発行されます。
このイベントは、通知が閉じられたすべての状況で発行されることは保証されていません。
イベント: 'reply' macOS
戻り値:
event
Eventreply
string - ユーザが埋め込み返信フィールドに入力した文字列.
hasReply: true
の通知上で、ユーザが "返信" ボタンをクリックしたときに発行されます。
イベント: 'action' macOS
戻り値:
event
Eventindex
number - アクティベートされたアクションのインデックス.
イベント: 'failed' Windows
戻り値:
event
Eventerror
string -show()
メソッドの実行中に発生したエラー。
ネイティブ通知の作成および表示でエラーに遭遇した場合に発生します。
インスタンスメソッド
new Notification()
コンストラクタで作成されたオブジェクトは、次のインスタンスメソッドを持っています。
notification.show()
即座にユーザーに通知を表示します。 ウェブの Notification API とは異なり、new Notification()
とインスタンス化するだけではユーザに即座に表示されません。 そこで代わりに、OS が表示する前にこのメソッドを呼び出す必要があります。
以前にその通知が表示されている場合、このメソッドはその通知を閉じ、同じプロパティを持つ新しい通知を作成します。
notification.close()
通知を閉じます。
インスタンスプロパティ
notification.title
通知のタイトルを表す string
プロパティ。
notification.subtitle
通知のサブタイトルを表す string
プロパティ。
notification.body
通知の本文を表す string
プロパティ。
notification.replyPlaceholder
通知の応答プレースホルダーを表す string
プロパティ。
notification.sound
通知音を表す string
プロパティ。
notification.closeButtonText
通知の閉じるボタンのテキストを表す string
プロパティ。
notification.silent
通知が無音かどうかを表す boolean
プロパティ。
notification.hasReply
通知に応答アクションがあるかどうかを表す boolean
プロパティ。
notification.urgency
Linux
通知の緊急度を表す string
プロパティ。 'normal'、'critical'、'low' のいずれかにできます。
省略値は 'low' - この詳細は NotifyUrgency を参照してください。
notification.timeoutType
Linux Windows
通知がタイムアウトする種別を表す string
プロパティ。 'default' か 'never' にできます。
timeoutType
が 'never' に設定されている場合、通知は自動的に閉じられません。 呼び出し元の API かユーザによって閉じられるまで開いたままになります。
notification.actions
通知のアクションを表す NotificationAction[] プロパティ。
notification.toastXml
Windows
string
型のプロパティで、通知のカスタム Toast XML を表します。
サウンドの再生
macOS では、通知が表示されたときに再生したいサウンドの名前を指定することができます。 カスタムサウンドファイルに加えて、(システム環境設定 > サウンド にある) デフォルトサウンドのいずれかを使用することができます。 サウンドファイルがアプリバンドル (YourApp.app/Contents/Resources
など) または以下のいずれかの場所にコピーされることに留意してください。
~/ライブラリ/Sounds
/ライブラリ/Sounds
/ネットワーク/ライブラリ/Sounds
/システム/ライブラリ/Sounds
より詳しくは、NSSound
ドキュメントを参照して下さい。