Продолжение активности пользователей даже на разных устройствах

  • Статья

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

Примечание

С июля 2021 г. пользователи, у которых журнал действий синхронизирован на всех устройствах с Windows с использованием учетной записи Майкрософт (MSA), больше не смогут отправлять новые действия в представлении временной шкалы. У таких пользователей по-прежнему будет возможность использовать временную шкалу и просматривать историю действий (сведения о последних приложениях, веб-сайтах и файлах) на своем локальном компьютере. Это не затронет учетные записи, подключенные к AAD.

Действия пользователя и временная шкала

В течение дня мы используем разные устройства. Мы пользуемся телефоном в автобусе, ПК в течение дня, а затем телефоном или планшетом в вечернее время. Начиная с Windows 10 сборки 1803 или более поздней версии, при создании действия пользователя это действие отображается на временной шкале Windows и в функции "Забрать, где я закончил" Кортаны. Временная шкала — расширенное представление задач, использующее преимущества активности пользователя для отображения ваших действий в хронологическом порядке. Она также может включать ваши действия на разных устройствах.

Образ Windows временная шкала

Аналогичным образом, привязка телефона к ПК под управлением Windows позволит продолжить работу на устройствах с Android или iOS.

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

При обращении к UserActivity путем вызова метод UserActivity.CreateSession система создает запись в журнале, указывающую время начала и окончания для этого UserActivity. По мере повторных обращений к UserActivity в журнал добавляются новые записи.

Добавление действий пользователя в приложение

UserActivity — это единица взаимодействия с пользователем в Windows. Она состоит из трех частей: URI, используемый для активации приложения, к которому относится действие, визуальные элементы и метаданные, которые описывают действие.

  1. ActivationUri используется, чтобы возобновить работу приложения в определенном контексте. Как правило, эта ссылка принимает форму обработчика протокола для схемы (например, "my-app://page2?action=edit") или AppUriHandler (например, http://contoso.com/page2?action=edit).
  2. VisualElements предоставляет класс, который позволяет пользователю визуально распознать действие с помощью названия, описания или элементов адаптивной карты.
  3. Наконец, Содержимое — объект для хранения метаданных для этого действия, которые могут использоваться для группировки и получения действий в определенном контексте. Зачастую оно принимает форму данных https://schema.org.

Добавление UserActivity в приложение:

  1. Создайте объекты UserActivity при изменении контекста пользователя в приложении (например, навигация по странице, новый уровень игры и т. п.)
  2. Заполните объекты UserActivity минимальным набором обязательных полей: ActivityId, ActivationUri и UserActivity.VisualElements.DisplayText.
  3. Добавьте собственный обработчик схемы для вашего приложения, чтобы его можно было повторно активировать с помощью UserActivity.

UserActivity можно интегрировать в приложение с помощью нескольких строк кода. Например, предположим, что этот код расположен в MainPage.xaml.cs, в классе MainPage (обратите внимание: предполагается using Windows.ApplicationModel.UserActivities;):

UserActivitySession _currentActivity;
private async Task GenerateActivityAsync()
{
    // Get the default UserActivityChannel and query it for our UserActivity. If the activity doesn't exist, one is created.
    UserActivityChannel channel = UserActivityChannel.GetDefault();
    UserActivity userActivity = await channel.GetOrCreateUserActivityAsync("MainPage");
 
    // Populate required properties
    userActivity.VisualElements.DisplayText = "Hello Activities";
    userActivity.ActivationUri = new Uri("my-app://page2?action=edit");
     
    //Save
    await userActivity.SaveAsync(); //save the new metadata
 
    // Dispose of any current UserActivitySession, and create a new one.
    _currentActivity?.Dispose();
    _currentActivity = userActivity.CreateSession();
}

В первой строке указанного выше метода GenerateActivityAsync() происходит получение UserActivityChannel пользователя. Это канал, в котором будут публиковаться действия в приложении. Следующая строка запрашивает канал действия под названием MainPage.

  • Приложение должно именовать действия таким образом, чтобы при входе пользователя в определенное расположение в приложении создавался тот же идентификатор. Например, если ваше приложение имеет страничную структуру, используйте идентификатор для страницы, а если документную, используйте имя документа (или хэш имени).
  • При наличии в канале действия с тем же идентификатором это действие будет возвращено из канала с заданным для UserActivity.State значением Published). Если действий с таким же именем нет, новое действие возвращается с заданным для UserActivity.State значением New.
  • Действия относятся к приложению. Вам не нужно беспокоиться о конфликтах идентификатора действия с идентификаторами в других приложениях.

После получения или создания userActivity укажите два других обязательных поля: UserActivity.VisualElements.DisplayTextи UserActivity.ActivationUri.

Затем сохраните метаданные UserActivity, вызвав SaveAsync, и, наконец, CreateSession, что возвращает UserActivitySession. UserActivitySession — это объект, который можно использовать для управления, когда пользователь фактически взаимодействует с UserActivity. Например, мы вызываем Dispose() для UserActivitySession, когда пользователь покидает страницу. В приведенном выше примере мы также вызываем Dispose() для _currentActivity перед вызовом CreateSession(). Это обусловлено тем, что мы сделали _currentActivity полем-участником нашей страницы и хотим остановить все выполняемые действия перед запуском нового (обратите внимание: ? — условный оператор null, который проверяет на null, прежде чем выполнять доступ к элементу).

Поскольку в этом случае ActivationUri является нестандартной схемой, необходима также регистрация протокола в манифесте приложения. Это делается в XML-файле Package.appmanifest или с помощью конструктора.

Чтобы внести изменения с помощью конструктора, дважды щелкните файл Package.appmanifest в проекте для запуска конструктора, выберите вкладку Объявления и добавьте определение Протокола. Единственным свойством, которое должно быть заполнено в данный момент, является Имя. Оно должно соответствовать URI, указанному выше, my-app.

Теперь нам необходимо написать код, чтобы сообщить приложению, что делать, когда оно активируется при помощи протокола. Мы переопределим метод OnActivated в App.xaml.cs для передачи URI на главную страницу следующим образом:

protected override void OnActivated(IActivatedEventArgs e)
{
    if (e.Kind == ActivationKind.Protocol)
    {
        var uriArgs = e as ProtocolActivatedEventArgs;
        if (uriArgs != null)
        {
            if (uriArgs.Uri.Host == "page2")
            {
                // Navigate to the 2nd page of the  app
            }
        }
    }
    Window.Current.Activate();
}

Что этот код делает — определяет, было ли приложение активировано при помощи протокола. Если это так, затем он ищет, что приложение должно сделать для возобновления задачи, ради которой оно активировано. Будучи простым приложением, единственным действием, которое оно возобновляет, является размещение вас на вторичной странице при появлении приложения.

Используйте адаптивные карты для улучшения работы с временной шкалой

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

Адаптивный карта]

Пример строки JSON с полезными данными адаптивной карты:

{ 
  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", 
  "type": "AdaptiveCard", 
  "version": "1.0",
  "backgroundImage": "https://winblogs.azureedge.net/win/2017/11/eb5d872c743f8f54b957ff3f5ef3066b.jpg", 
  "body": [ 
    { 
      "type": "Container", 
      "items": [ 
        { 
          "type": "TextBlock", 
          "text": "Windows Blog", 
          "weight": "bolder", 
          "size": "large", 
          "wrap": true, 
          "maxLines": 3 
        }, 
        { 
          "type": "TextBlock", 
          "text": "Training Haiti’s radiologists: St. Louis doctor takes her teaching global", 
          "size": "default", 
          "wrap": true, 
          "maxLines": 3 
        } 
      ] 
    } 
  ]
}

Добавьте полезные данные адаптивной карты как строку JSON в UserActivity следующим образом:

activity.VisualElements.Content = 
Windows.UI.Shell.AdaptiveCardBuilder.CreateAdaptiveCardFromJson(jsonCardText); // where jsonCardText is a JSON string that represents the card

Интеграция между различными платформами и службами

Если ваше приложение работает на разных платформах (например, на Android и iOS) или хранит данные состояния пользователя в облаке, можно опубликовать UserActivities через Microsoft Graph. После проверки подлинности вашего приложения или службы с помощью учетной записи Майкрософт требуется всего два простых вызова REST для создания объектов Действие и Журнал с использованием тех же данных, что и выше.

Итоги

Можно использовать API UserActivity, чтобы ваше приложение отображалось на временной шкале и в Кортане.

Основные API-интерфейсы