ToastNotification クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
トースト通知のコンテンツ、関連するメタデータとイベント、有効期限を定義します。
public ref class ToastNotification sealed
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Notifications.IToastNotificationFactory, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
class ToastNotification final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Notifications.IToastNotificationFactory, 65536, "Windows.Foundation.UniversalApiContract")]
class ToastNotification final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Notifications.IToastNotificationFactory, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ToastNotification final
[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.Notifications.IToastNotificationFactory), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
public sealed class ToastNotification
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.Notifications.IToastNotificationFactory), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class ToastNotification
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.Notifications.IToastNotificationFactory), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ToastNotification
function ToastNotification(content)
Public NotInheritable Class ToastNotification
- 継承
- 属性
Windows の要件
デバイス ファミリ |
Windows 10 (10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox で導入)
|
API contract |
Windows.Foundation.UniversalApiContract (v1.0 で導入)
|
注釈
アプリでトースト通知を実装する方法については、「 C# アプリからローカル トースト通知を送信する」を参照してください。
トースト通知のアプリのアクティブ化を処理するためのガイダンス:
- UWP アプリケーションでは、トースト のアクティブ化を処理するために OnActivated を使用する必要があります。
- WinRT ビルド 19041 以降では、パッケージ 化されたアプリ (外部の場所を持つパッケージ アプリを含む) は、詳細については、アクティブ化を処理するために ToastNotificationActionTriggerを使用できます。
- デスクトップ アプリでは、[ デスクトップ - ローカル トーストの送信] に従って COM のアクティブ化を使用できます。
- アクティブ化オプションがアプリケーションに適合しない場合は、このドキュメントの例に従って、イベント ハンドラーを適切に使用してください。
バージョン履歴
Windows のバージョン | SDK バージョン | 追加された値 |
---|---|---|
1607 | 14393 | NotificationMirroring |
1607 | 14393 | RemoteId |
1703 | 15063 | Data |
1703 | 15063 | 優先度 |
1903 | 18362 | ExpiresOnReboot |
コンストラクター
ToastNotification(XmlDocument) |
ToastNotification の新しいインスタンスを作成して初期化します。 |
プロパティ
Content |
現在のトースト通知を定義する XML を取得します。 |
Data |
トースト通知の状態に関する追加情報を取得または設定します。 |
ExpirationTime |
トースト通知を表示しない時間を取得または設定します。 |
ExpiresOnReboot |
再起動後もトースト通知が通知センターに残るかどうかを示します。 |
Group |
通知のグループ識別子を取得または設定します。 |
NotificationMirroring |
通知ミラーリングを許可するかどうかを指定する値を取得または設定します。 |
Priority |
トースト通知の優先度を取得または設定します。 |
RemoteId |
通知のリモート ID を取得または設定します。これにより、システムはこの通知を別のデバイスで生成された別の通知と関連付けることができます。 |
SuppressPopup |
トーストのポップアップ UI をユーザーの画面に表示するかどうかを取得または設定します。 |
Tag |
通知 グループ内のこの通知の一意識別子を取得または設定します。 |
イベント
Activated |
ユーザーがクリックまたはタッチでトースト通知をアクティブ化したときに発生します。 実行中のアプリは、このイベントをサブスクライブします。 |
Dismissed |
トースト通知が有効期限切れになったり、ユーザーによって明示的に無視されたりして画面を離れると発生します。 実行中のアプリは、このイベントをサブスクライブします。 |
Failed |
Windows がトースト通知を生成しようとしたときにエラーが発生したときに発生します。 実行中のアプリは、このイベントをサブスクライブします。 |
適用対象
こちらもご覧ください
- Toast notifications sample (トースト通知のサンプル)
- デスクトップ アプリからのトースト通知の送信サンプル
- トースト XML スキーマ
- タイル、バッジ、通知
- クイック スタート: トースト通知の送信
- クイック スタート: トースト プッシュ通知の送信
- クイック スタート: デスクトップからトースト通知を送信する
- トースト通知のガイドラインとチェックリスト
- トースト通知からのアクティブ化を処理する方法
- トースト通知をオプトインする方法
- トースト通知をスケジュールする方法
- AppUserModelID を使用して、デスクトップ トースト通知を有効にする方法
- トースト テンプレート カタログ
- トースト オーディオ オプション