ToastNotificationManager クラス

  • リファレンス

定義

名前空間:
Windows.UI.Notifications
編集

トースト通知を発生させるために使用する ToastNotifier オブジェクトを作成します。 このクラスは、通知で使用するためにそのコンテンツをカスタマイズできるように、システム提供のトースト テンプレートの XML コンテンツへのアクセスも提供します。

public ref class ToastNotificationManager abstract sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
class ToastNotificationManager final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ToastNotificationManager final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
public static class ToastNotificationManager
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public static class ToastNotificationManager
Public Class ToastNotificationManager
継承
Object Platform::Object IInspectable ToastNotificationManager
属性
ContractVersionAttribute ThreadingAttribute MarshalingBehaviorAttribute

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 で導入)

例

次の例では、 GetTemplateContent メソッドや CreateToastNotifier メソッドの使用など、テキストと画像を含むトースト通知を作成して送信する方法を示します。

var notifications = Windows.UI.Notifications;

// Get the toast notification manager for the current app.
var notificationManager = notifications.ToastNotificationManager;

// The getTemplateContent method returns a Windows.Data.Xml.Dom.XmlDocument object
// that contains the toast notification XML content.
var template = notifications.toastTemplateType.toastImageAndText01;
var toastXml = notificationManager.getTemplateContent(notifications.ToastTemplateType[template]);

// You can use the methods from the XML document to specify the required elements for the toast.
var images = toastXml.getElementsByTagName("image");
images[0].setAttribute("src", "images/toastImageAndText.png");

var textNodes = toastXml.getElementsByTagName("text");
textNodes.forEach(function (value, index) {
    var textNumber = index + 1;
    var text = "";
    for (var j = 0; j < 10; j++) {
        text += "Text input " + /*@static_cast(String)*/textNumber + " ";
    }
    value.appendChild(toastXml.createTextNode(text));
});

// Create a toast notification from the XML, then create a ToastNotifier object
// to send the toast.
var toast = new notifications.ToastNotification(toastXml);

notificationManager.createToastNotifier().show(toast);

注釈

デスクトップ アプリからのトースト通知の送信

一般に、デスクトップ アプリからトースト通知を送信することは、UWP アプリから送信するのと同じです。 ただし、次の違いと要件に注意する必要があります。

  • デスクトップ アプリでトーストを表示するには、アプリのスタート画面にショートカットが必要です。
  • ショートカットには AppUserModelID が必要です。
  • デスクトップ アプリではトーストをスケジュールできません。

詳細については、以下のトピックを参照してください。

バージョン履歴

Windows のバージョン SDK バージョン 追加された値
1607 14393 ConfigureNotificationMirroring
1607 14393 GetForUser
1703 15063 GetDefault

プロパティ

History

ToastNotificationHistory オブジェクトを取得します。

メソッド

ConfigureNotificationMirroring(NotificationMirroring)

通知ミラーリングを許可するかどうかを指定します。 通知ミラーリングを使用すると、複数のデバイスで通知をブロードキャストできます。
CreateToastNotifier()

呼び出し元アプリケーションにバインドされた ToastNotification の新しいインスタンスを作成して初期化します。これにより、そのアプリにトースト通知を生成できます。
CreateToastNotifier(String)

指定したアプリ (通常は同じパッケージ内の別のアプリ) にバインドされた ToastNotification の新しいインスタンスを作成して初期化します。
GetDefault()

現在のユーザーのトースト通知マネージャーを取得します。
GetForUser(User)

指定したユーザーのトースト通知マネージャーを取得します。
GetTemplateContent(ToastTemplateType)

通知で使用できるようにカスタマイズできるように、定義済みのトースト テンプレートの 1 つの XML コンテンツを取得します。

適用対象

こちらもご覧ください