BadgeNotification クラス

  • リファレンス

定義

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

タイルのバッジ オーバーレイに対する更新のコンテンツ、関連付けられたメタデータ、有効期限を定義します。 バッジには、1 から 99 までの数値または ステータス グリフを表示できます。

public ref class BadgeNotification sealed
/// [Windows.Foundation.Metadata.Activatable(Windows.UI.Notifications.IBadgeNotificationFactory, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
class BadgeNotification 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.IBadgeNotificationFactory, 65536, "Windows.Foundation.UniversalApiContract")]
class BadgeNotification 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.IBadgeNotificationFactory, 65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class BadgeNotification final
[Windows.Foundation.Metadata.Activatable(typeof(Windows.UI.Notifications.IBadgeNotificationFactory), 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 BadgeNotification
[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.IBadgeNotificationFactory), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class BadgeNotification
[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.IBadgeNotificationFactory), 65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class BadgeNotification
function BadgeNotification(content)
Public NotInheritable Class BadgeNotification
継承
Object Platform::Object IInspectable BadgeNotification
属性
ActivatableAttribute 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 で導入)

例

次のコード例では、 BadgeNotification メソッドを使用して数値バッジ通知を作成します。 このメソッドを使用して値を "0" に設定すると、バッジがクリアされます。

var Notifications = Windows.UI.Notifications;

var badgeXml = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber);
var badgeAttributes = badgeXml.getElementsByTagName("badge");
badgeAttributes[0].setAttribute("value", "26");

// Create a badge notification from XML
var badgeNotification = new Notifications.badgeNotification(badgeXml);

次のコード例では、 BadgeNotification メソッドを使用してグリフ バッジ通知を作成します。 このメソッドを使用して値を "none" に設定すると、バッジがクリアされます。

var Notifications = Windows.UI.Notifications;

var badgeXml = Notifications.BadgeUpdateManager.getTemplateContent(Notifications.BadgeTemplateType.badgeNumber);
var badgeAttributes = badgeXml.getElementsByTagName("badge");
badgeAttributes[0].setAttribute("value", "alert");

// Create a badge notification from XML
var badgeNotification = new Notifications.badgeNotification(badgeXml);

コンストラクター

BadgeNotification(XmlDocument)

BadgeNotification の新しいインスタンスを作成して初期化します。

プロパティ

Content

タイルのバッジとして使用される値またはグリフを定義する XML を取得します。
ExpirationTime

Windows がタイルからバッジを削除する時間を取得または設定します。 既定では、ローカル バッジ通知の有効期限は切れず、プッシュ、定期的、スケジュールされたバッジ通知は 3 日後に期限切れになります。 古いコンテンツを避けるために有効期限を明示的に設定することをお勧めします。

適用対象

こちらもご覧ください