Отправка локального уведомления на плитке

Основные плитки приложений в Windows 10 определяются в манифесте приложения, а вспомогательные плитки создаются программно и определяются кодом приложения. В этой статье описывается, как с помощью шаблонов адаптивных плиток отправлять локальное уведомление на плитке на основную и вспомогательную плитку. (Локальное уведомление — это уведомление, отправляемое из кода приложения, тогда как уведомление другого типа отправляется принудительно (push-уведомление) или поступает с веб-сервера).

Примечание

Узнайте о создании адаптивных плиток и схеме содержимого плиток.

 

Установка пакета NuGet

Мы рекомендуем устанавливать пакет библиотеки уведомлений NuGet, который упрощает процесс за счет создания полезных данных плитки с объектами вместо необработанных XML-данных.

Примеры встроенного кода в этой статье предназначены для C# с использованием библиотеки уведомлений. (Описание процесса создания собственного кода XML с его примерами без библиотеки уведомлений см. в конце статьи).

Добавление объявлений пространств имен

Чтобы получить доступ к API для работы с плитками, добавьте пространство имен Windows.UI.Notifications. Мы также рекомендуем добавлять пространство имен Microsoft.Toolkit.Uwp.Notifications, чтобы можно было использовать вспомогательные API для работы с плитками (чтобы получить доступ к этим API, необходимо установить пакет NuGet Библиотеки уведомлений).

using Windows.UI.Notifications;
using Microsoft.Toolkit.Uwp.Notifications; // Notifications library

Создание содержимого уведомления

В Windows 10 полезные данные плитки определяются с помощью шаблонов адаптивных плиток, которые позволяют создавать собственные визуальные макеты для уведомлений. (Дополнительные сведения об операциях, которые можно выполнять с адаптивными плитками, см. в статье Создание адаптивных плиток).

В этом примере кода создается содержимое адаптивной плитки для средних и широких плиток.

// In a real app, these would be initialized with actual data
string from = "Jennifer Parker";
string subject = "Photos from our trip";
string body = "Check out these awesome photos I took while in New Zealand!";
 
 
// Construct the tile content
TileContent content = new TileContent()
{
    Visual = new TileVisual()
    {
        TileMedium = new TileBinding()
        {
            Content = new TileBindingContentAdaptive()
            {
                Children =
                {
                    new AdaptiveText()
                    {
                        Text = from
                    },

                    new AdaptiveText()
                    {
                        Text = subject,
                        HintStyle = AdaptiveTextStyle.CaptionSubtle
                    },

                    new AdaptiveText()
                    {
                        Text = body,
                        HintStyle = AdaptiveTextStyle.CaptionSubtle
                    }
                }
            }
        },

        TileWide = new TileBinding()
        {
            Content = new TileBindingContentAdaptive()
            {
                Children =
                {
                    new AdaptiveText()
                    {
                        Text = from,
                        HintStyle = AdaptiveTextStyle.Subtitle
                    },

                    new AdaptiveText()
                    {
                        Text = subject,
                        HintStyle = AdaptiveTextStyle.CaptionSubtle
                    },

                    new AdaptiveText()
                    {
                        Text = body,
                        HintStyle = AdaptiveTextStyle.CaptionSubtle
                    }
                }
            }
        }
    }
};

При отображении на средней плитке содержимое уведомления выглядит следующим образом:

Создание уведомления на плитке

После создания содержимого уведомления необходимо создать новое уведомление TileNotification. Конструктор TileNotification принимает объект XmlDocument среды выполнения Windows, который можно получить из метода TileContent.GetXml с использованием Библиотеки уведомлений.

В этом примере кода создается уведомление для новой плитки.

// Create the tile notification
var notification = new TileNotification(content.GetXml());

Задание времени окончания срока действия уведомления (необязательно)

По умолчанию локальные уведомления на плитках и индикаторах событий не истекают, тогда как запланированные, периодические и push-уведомления истекают через три дня. Так как содержание плитки не должно сохраняться дольше, чем нужно, рекомендуется установить срок действия на все уведомления на плитках и индикаторах событий, используя время, значимое для вашего приложения.

В этом примере кода создается уведомление, срок действия которого истекает через десять минут, после чего оно удаляется из плитки.

tileNotification.ExpirationTime = DateTimeOffset.UtcNow.AddMinutes(10);

Отправка уведомления

Несмотря на то, что локальная отправка уведомления плитки является простым процессом, отправка уведомления на основную или вспомогательную плитку выполняется несколько иначе.

Основная плитка

Чтобы отправить уведомление на основную плитку, используйте TileUpdateManager для создания средства обновления основной плитки и отправьте уведомление, вызвав метод «Update». Независимо от того, отображается основная плитка приложения или нет, она всегда существует, таким образом на нее можно отправлять уведомления, даже если она не закреплена. Когда пользователь закрепит основную плитку, тогда и отобразятся отправленные вами уведомления.

В этом примере кода уведомление отправляется на основную плитку.

// Send the notification to the primary tile
TileUpdateManager.CreateTileUpdaterForApplication().Update(notification);

Вторичная плитка

Чтобы отправить уведомление на вспомогательную плитку, сначала убедитесь, что вспомогательная плитка существует. Если создать средство обновления плитки для вспомогательной плитки, которой не существует (например, если пользователь открепил вспомогательную плитку), будет выдано исключение. Вы можете использовать SecondaryTile.Exists(tileId), чтобы определить, закреплена ли вспомогательная плитка, а затем создать средство обновления плитки для вспомогательной плитки и отправить уведомление.

В этом примере кода уведомление отправляется на вспомогательную плитку.

// If the secondary tile is pinned
if (SecondaryTile.Exists("MySecondaryTile"))
{
    // Get its updater
    var updater = TileUpdateManager.CreateTileUpdaterForSecondaryTile("MySecondaryTile");
 
    // And send the notification
    updater.Update(notification);
}

Очистка уведомлений на плитке (необязательно)

В большинстве случаев после взаимодействия пользователя с этим содержимым уведомление необходимо очистить. Например, когда пользователь запускает ваше приложение, может потребоваться удалить все уведомления с плитки. Если уведомления зависят от времени, рекомендуется задать время окончания срока действия уведомления, а не выполнять непосредственно очистку уведомления.

В этом примере кода выполняется очистка уведомления плитки для основной плитки. То же самое можно сделать для дополнительных плиток, создав для них средство обновления плитки.

TileUpdateManager.CreateTileUpdaterForApplication().Clear();

Если для плитки включена очередь уведомлений, в которой имеются элементы, вызов метода Clear приводит к очистке очереди. Тем не менее уведомление нельзя очистить с помощью сервера приложений; уведомления может очищать только локальный код приложения.

Периодические или push-уведомления могут только добавлять новые уведомления или заменять существующие уведомления. Локальный вызов метода Clear очистит плитку независимо от типа уведомлений (push-уведомления, периодические или локальные уведомления). Запланированные уведомления, которые еще не появлялись, не очищаются с помощью этого метода.

Дальнейшие действия

Использование очереди уведомлений

Теперь, когда вы выполнили первое обновление плитки, вы можете расширить функциональность своей плитки, включив очередь уведомлений.

Другие методы доставки уведомлений

В этой статье описывается процесс отправки обновления плитки в виде уведомления. Чтобы изучить другие методы доставки уведомлений, включая запланированные, периодические и push-уведомления, см. раздел Доставка уведомлений.

Метод доставки XmlEncode

Если вы не используете Библиотеку уведомлений, этот метод доставки уведомлений является альтернативным решением.

public string XmlEncode(string text)
{
    StringBuilder builder = new StringBuilder();
    using (var writer = XmlWriter.Create(builder))
    {
        writer.WriteString(text);
    }

    return builder.ToString();
}

Примеры кода без библиотеки уведомлений

Если вы предпочитаете работать с необработанным кодом XML, а не с пакетом NuGet Библиотеки уведомлений, вместо первых трех примеров кода, приведенных в этой статье, используйте следующие альтернативные примеры кода. Остальные примеры кода можно использовать с Библиотекой уведомлений или с необработанным кодом XML.

Добавление объявлений пространств имен

using Windows.UI.Notifications;
using Windows.Data.Xml.Dom;

Создание содержимого уведомления

// In a real app, these would be initialized with actual data
string from = "Jennifer Parker";
string subject = "Photos from our trip";
string body = "Check out these awesome photos I took while in New Zealand!";
 
 
// TODO - all values need to be XML escaped
 
 
// Construct the tile content as a string
string content = $@"
<tile>
    <visual>
 
        <binding template='TileMedium'>
            <text>{from}</text>
            <text hint-style='captionSubtle'>{subject}</text>
            <text hint-style='captionSubtle'>{body}</text>
        </binding>
 
        <binding template='TileWide'>
            <text hint-style='subtitle'>{from}</text>
            <text hint-style='captionSubtle'>{subject}</text>
            <text hint-style='captionSubtle'>{body}</text>
        </binding>
 
    </visual>
</tile>";

Создание уведомления на плитке

// Load the string into an XmlDocument
XmlDocument doc = new XmlDocument();
doc.LoadXml(content);
 
// Then create the tile notification
var notification = new TileNotification(doc);

Связанные темы

• Создание адаптивных плиток
• Схема содержимого плитки
• Библиотека уведомлений
• Полный пример кода на GitHub
• Пространство имен Windows.UI.Notifications
• Использование очереди уведомлений (XAML)
• Доставка уведомлений