Скачивание и установка обновлений пакетов из Store
Начиная с Windows 10 версии 1607, можно использовать методы класса StoreContext в пространстве имен Windows.Services.Store, чтобы программным способом проверить наличие обновлений пакета для текущего приложения в Microsoft Store, а затем скачать и установить обновленные пакеты. Можно также запрашивать пакеты, которые были помечены как обязательные в Центре партнеров, и отключать функциональные возможности в приложении, пока обязательное обновление не будет установлено.
Дополнительные методы StoreContext, представленные в Windows 10 версии 1803, позволяют скачивать и устанавливать обновления пакетов автоматически (не отображая пользовательский интерфейс уведомления пользователю), удалять дополнительный пакет и получать информацию о пакетах в очереди на скачивание и установку для вашего приложения.
Эти функции помогают автоматически поддерживать базу пользователей в актуальном состоянии, используя последние версии приложения, дополнительные пакеты и сопутствующие услуги в Store.
Скачивание и установка обновлений пакета с разрешения пользователя
В этом примере кода показано, как использовать метод GetAppAndOptionalStorePackageUpdatesAsync, чтобы обнаружить все доступные обновления пакетов в Store, а затем вызвать метод RequestDownloadAndInstallStorePackageUpdatesAsync для скачивания и установки обновлений. При использовании этого метода для скачивания и установки обновлений ОС отображает диалоговое окно с запросом разрешения пользователя, прежде чем скачивать обновления.
Примечание.
Эти методы поддерживают обязательные и необязательные пакеты для вашего приложения. Необязательные пакеты удобно использовать для надстроек загружаемого содержимого (DLC), так как они позволяют разделить большое приложение при наличии ограничений на размер или доставить любое дополнительное содержимое отдельно от основного приложения. Получение разрешения на отправку приложения, использующего дополнительные пакеты (включая надстройки DLC) в Store, описано в разделе Поддержка разработчиков для Windows.
В коде этого примера предполагается следующее:
- Код выполняется в контексте страницы.
- Страница содержит индикатор ProgressBar с именем
downloadProgressBar
, чтобы предоставить состояние для операции скачивания. - Файл кода содержит оператор using для пространств имен Windows.Services.Store, Windows.Threading.Tasks и Windows.UI.Popups.
- Приложение — это однопользовательское приложение, которое запускается только в контексте пользователя, запускающего приложение. Для многопользовательского приложения используйте метод GetForUser, чтобы получить объект StoreContext вместо метода GetDefault.
private StoreContext context = null;
public async Task DownloadAndInstallAllUpdatesAsync()
{
if (context == null)
{
context = StoreContext.GetDefault();
}
// Get the updates that are available.
IReadOnlyList<StorePackageUpdate> updates =
await context.GetAppAndOptionalStorePackageUpdatesAsync();
if (updates.Count > 0)
{
// Alert the user that updates are available and ask for their consent
// to start the updates.
MessageDialog dialog = new MessageDialog(
"Download and install updates now? This may cause the application to exit.", "Download and Install?");
dialog.Commands.Add(new UICommand("Yes"));
dialog.Commands.Add(new UICommand("No"));
IUICommand command = await dialog.ShowAsync();
if (command.Label.Equals("Yes", StringComparison.CurrentCultureIgnoreCase))
{
// Download and install the updates.
IAsyncOperationWithProgress<StorePackageUpdateResult, StorePackageUpdateStatus> downloadOperation =
context.RequestDownloadAndInstallStorePackageUpdatesAsync(updates);
// The Progress async method is called one time for each step in the download
// and installation process for each package in this request.
downloadOperation.Progress = async (asyncInfo, progress) =>
{
await this.Dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal,
() =>
{
downloadProgressBar.Value = progress.PackageDownloadProgress;
});
};
StorePackageUpdateResult result = await downloadOperation.AsTask();
}
}
}
Примечание.
Чтобы только скачать доступные обновления пакетов (не устанавливая их), воспользуйтесь методом RequestDownloadStorePackageUpdatesAsync.
Отображение информации о ходе скачивания и установки
При вызове метода RequestDownloadStorePackageUpdatesAsync или RequestDownloadAndInstallStorePackageUpdatesAsync можно назначить обработчик Progress, который будет вызываться один раз для каждого шага при скачивании (или скачивании и установке) для каждого пакета в этом запросе. Обработчик получает объект StorePackageUpdateStatus, который предоставляет сведения о пакете обновления, создавшем уведомление о ходе выполнения. В предыдущем примере используется поле PackageDownloadProgress объекта StorePackageUpdateStatus для отображения хода выполнения скачивания и установки.
Учтите, что при вызове RequestDownloadAndInstallStorePackageUpdatesAsync для скачивания и установки обновлений пакета в одной операции значение поля PackageDownloadProgress увеличивается с 0,0 до 0,8 во время скачивания для пакета, а затем увеличивается с 0,8 до 1,0 во время установки. Поэтому при сопоставлении процента, показанного в специальном интерфейсе хода выполнения для значения поля PackageDownloadProgress, ваш интерфейс будет отображать 80 %, когда скачивание пакета закончится, а ОС отобразит диалоговое окно установки. Если вы хотите, чтобы специальный интерфейс хода выполнения отображал 100 %, когда пакет будет скачан и готов к установке, вы можете изменить код и назначить 100 % для интерфейса хода выполнения, когда значение поля PackageDownloadProgress достигнет 0,8.
Скачивание и установка всех обновлений пакетов автоматически
Начиная с Windows 10 версии 1803, можно использовать методы TrySilentDownloadStorePackageUpdatesAsync и TrySilentDownloadAndInstallStorePackageUpdatesAsync для автоматического скачивания и установки обновлений пакетов, не отображая пользовательский интерфейс уведомления пользователю. Эта операция завершится успешно, только если пользователь включил параметр Обновлять приложения автоматически в Store и не подключен к сети с лимитным тарифным планом. Прежде чем вызывать эти методы, нужно проверить свойство CanSilentlyDownloadStorePackageUpdates, чтобы определить, выполнены ли эти условия в настоящее время.
В этом примере кода показано, как использовать метод GetAppAndOptionalStorePackageUpdatesAsync, чтобы обнаружить все доступные обновления пакетов, а затем вызвать методы TrySilentDownloadStorePackageUpdatesAsync и TrySilentDownloadAndInstallStorePackageUpdatesAsync для автоматического скачивания и установки обновлений.
В коде этого примера предполагается следующее:
- В файле кода используется оператор using для пространств имен Windows.Services.Store и System.Threading.Tasks.
- Приложение — это однопользовательское приложение, которое запускается только в контексте пользователя, запускающего приложение. Для многопользовательского приложения используйте метод GetForUser, чтобы получить объект StoreContext вместо метода GetDefault.
Примечание.
Методы IsNowAGoodTimeToRestartApp, RetryDownloadAndInstallLater и RetryInstallLater, вызываемые в коде в этом примере, являются методами-заполнителями, которые реализуются по мере надобности в соответствии со структурой вашего приложения.
private StoreContext context = null;
public async Task DownloadAndInstallAllUpdatesInBackgroundAsync()
{
if (context == null)
{
context = StoreContext.GetDefault();
}
// Get the updates that are available.
IReadOnlyList<StorePackageUpdate> storePackageUpdates =
await context.GetAppAndOptionalStorePackageUpdatesAsync();
if (storePackageUpdates.Count > 0)
{
if (!context.CanSilentlyDownloadStorePackageUpdates)
{
return;
}
// Start the silent downloads and wait for the downloads to complete.
StorePackageUpdateResult downloadResult =
await context.TrySilentDownloadStorePackageUpdatesAsync(storePackageUpdates);
switch (downloadResult.OverallState)
{
case StorePackageUpdateState.Completed:
// The download has completed successfully. At this point, confirm whether your app
// can restart now and then install the updates (for example, you might only install
// packages silently if your app has been idle for a certain period of time). The
// IsNowAGoodTimeToRestartApp method is not implemented in this example, you should
// implement it as needed for your own app.
if (IsNowAGoodTimeToRestartApp())
{
await InstallUpdate(storePackageUpdates);
}
else
{
// Retry/reschedule the installation later. The RetryInstallLater method is not
// implemented in this example, you should implement it as needed for your own app.
RetryInstallLater();
return;
}
break;
// If the user cancelled the download or you can't perform the download for some other
// reason (for example, Wi-Fi might have been turned off and the device is now on
// a metered network) try again later. The RetryDownloadAndInstallLater method is not
// implemented in this example, you should implement it as needed for your own app.
case StorePackageUpdateState.Canceled:
case StorePackageUpdateState.ErrorLowBattery:
case StorePackageUpdateState.ErrorWiFiRecommended:
case StorePackageUpdateState.ErrorWiFiRequired:
case StorePackageUpdateState.OtherError:
RetryDownloadAndInstallLater();
return;
default:
break;
}
}
}
private async Task InstallUpdate(IReadOnlyList<StorePackageUpdate> storePackageUpdates)
{
// Start the silent installation of the packages. Because the packages have already
// been downloaded in the previous method, the following line of code just installs
// the downloaded packages.
StorePackageUpdateResult downloadResult =
await context.TrySilentDownloadAndInstallStorePackageUpdatesAsync(storePackageUpdates);
switch (downloadResult.OverallState)
{
// If the user cancelled the installation or you can't perform the installation
// for some other reason, try again later. The RetryInstallLater method is not
// implemented in this example, you should implement it as needed for your own app.
case StorePackageUpdateState.Canceled:
case StorePackageUpdateState.ErrorLowBattery:
case StorePackageUpdateState.OtherError:
RetryInstallLater();
return;
default:
break;
}
}
Обязательные обновления пакетов
При создании отправки пакета для приложения, которое нацелено на Windows 10 версии 1607 или более поздней версии, можно пометить пакет как обязательный и указать дату и время, когда он становится таковым. Если это свойство задано и приложение обнаружит, что обновление пакета доступно, приложение может определить, является ли пакет обновления обязательным, и изменить свой режим работы до тех пор, пока обновление не будет установлено (например, приложение может отключить определенные компоненты).
Примечание.
Обязательный статус обновления пакета не реализуется корпорацией Майкрософт принудительно, и ОС не предоставляет пользовательский интерфейс, указывающий пользователям, что обязательное обновление приложения необходимо установить. Разработчики предназначены для применения обязательных обновлений приложений в собственном коде.
Чтобы пометить отправку пакета как обязательную:
- Войдите в Центр партнеров и перейдите на страницу обзора своего приложения.
- Щелкните имя отправки, содержащей обновление пакета, которое требуется сделать обязательным.
- Перейдите на страницу "Пакеты" для отправки. В нижней части этой страницы выберите " Сделать это обновление обязательным ", а затем выберите день и время, в течение которого обновление пакета становится обязательным. Этот параметр применяется ко всем пакетам UWP в отправке.
Дополнительные сведения об этом см. в разделе Отправка пакетов приложений.
Примечание.
Если создается тестовый пакет, можно пометить пакеты как обязательные, воспользовавшись аналогичным элементом пользовательского интерфейса на странице Пакеты тестируемой возможности. В этом случае обязательное обновление пакета применяется только к клиентам, которые входят в группу полетов.
Пример кода для обязательных пакетов
В следующем примере кода показано, как определить, являются ли пакеты обновления обязательными. Как правило, вы должны изменить уровень работы приложения правильно для пользователя, если обязательное обновление пакета не успешно скачивание или установка.
private StoreContext context = null;
// Downloads and installs package updates in separate steps.
public async Task DownloadAndInstallAllUpdatesAsync()
{
if (context == null)
{
context = StoreContext.GetDefault();
}
// Get the updates that are available.
IReadOnlyList<StorePackageUpdate> updates =
await context.GetAppAndOptionalStorePackageUpdatesAsync();
if (updates.Count != 0)
{
// Download the packages.
bool downloaded = await DownloadPackageUpdatesAsync(updates);
if (downloaded)
{
// Install the packages.
await InstallPackageUpdatesAsync(updates);
}
}
}
// Helper method for downloading package updates.
private async Task<bool> DownloadPackageUpdatesAsync(IEnumerable<StorePackageUpdate> updates)
{
bool downloadedSuccessfully = false;
IAsyncOperationWithProgress<StorePackageUpdateResult, StorePackageUpdateStatus> downloadOperation =
this.context.RequestDownloadStorePackageUpdatesAsync(updates);
// The Progress async method is called one time for each step in the download process for each
// package in this request.
downloadOperation.Progress = async (asyncInfo, progress) =>
{
await this.Dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal,
() =>
{
downloadProgressBar.Value = progress.PackageDownloadProgress;
});
};
StorePackageUpdateResult result = await downloadOperation.AsTask();
switch (result.OverallState)
{
case StorePackageUpdateState.Completed:
downloadedSuccessfully = true;
break;
default:
// Get the failed updates.
var failedUpdates = result.StorePackageUpdateStatuses.Where(
status => status.PackageUpdateState != StorePackageUpdateState.Completed);
// See if any failed updates were mandatory
if (updates.Any(u => u.Mandatory && failedUpdates.Any(
failed => failed.PackageFamilyName == u.Package.Id.FamilyName)))
{
// At least one of the updates is mandatory. Perform whatever actions you
// want to take for your app: for example, notify the user and disable
// features in your app.
HandleMandatoryPackageError();
}
break;
}
return downloadedSuccessfully;
}
// Helper method for installing package updates.
private async Task InstallPackageUpdatesAsync(IEnumerable<StorePackageUpdate> updates)
{
IAsyncOperationWithProgress<StorePackageUpdateResult, StorePackageUpdateStatus> installOperation =
this.context.RequestDownloadAndInstallStorePackageUpdatesAsync(updates);
// The package updates were already downloaded separately, so this method skips the download
// operation and only installs the updates; no download progress notifications are provided.
StorePackageUpdateResult result = await installOperation.AsTask();
switch (result.OverallState)
{
case StorePackageUpdateState.Completed:
break;
default:
// Get the failed updates.
var failedUpdates = result.StorePackageUpdateStatuses.Where(
status => status.PackageUpdateState != StorePackageUpdateState.Completed);
// See if any failed updates were mandatory
if (updates.Any(u => u.Mandatory && failedUpdates.Any(failed => failed.PackageFamilyName == u.Package.Id.FamilyName)))
{
// At least one of the updates is mandatory, so tell the user.
HandleMandatoryPackageError();
}
break;
}
}
// Helper method for handling the scenario where a mandatory package update fails to
// download or install. Add code to this method to perform whatever actions you want
// to take, such as notifying the user and disabling features in your app.
private void HandleMandatoryPackageError()
{
}
Удаление дополнительных пакетов
Начиная с Windows 10 версии 1803, можно использовать методы RequestUninstallStorePackageAsync или RequestUninstallStorePackageByStoreIdAsync, чтобы удалить дополнительный пакет (включая пакет DLC) для текущего приложения. Например, если у вас есть приложение с содержимым, которое установлено с помощью дополнительных пакетов, можно предоставить пользовательский интерфейс, который позволяет удалять дополнительные пакеты, чтобы освободить место на диске.
В следующем примере кода показан вызов метода RequestUninstallStorePackageAsync. В коде из этого примера предполагается следующее:
- В файле кода используется оператор using для пространств имен Windows.Services.Store и System.Threading.Tasks.
- Приложение — это однопользовательское приложение, которое запускается только в контексте пользователя, запускающего приложение. Для многопользовательского приложения используйте метод GetForUser, чтобы получить объект StoreContext вместо метода GetDefault.
public async Task UninstallPackage(Windows.ApplicationModel.Package package)
{
if (context == null)
{
context = StoreContext.GetDefault();
}
var storeContext = StoreContext.GetDefault();
IAsyncOperation<StoreUninstallStorePackageResult> uninstallOperation =
storeContext.RequestUninstallStorePackageAsync(package);
// At this point, you can update your app UI to show that the package
// is installing.
uninstallOperation.Completed += (asyncInfo, status) =>
{
StoreUninstallStorePackageResult result = uninstallOperation.GetResults();
switch (result.Status)
{
case StoreUninstallStorePackageStatus.Succeeded:
{
// Update your app UI to show the package as uninstalled.
break;
}
default:
{
// Update your app UI to show that the package uninstall failed.
break;
}
}
};
}
Получение сведений об очереди скачивания
Начиная с Windows 10 версии 1803, можно использовать методы GetAssociatedStoreQueueItemsAsync и GetStoreQueueItemsAsync для получения информации о пакетах, которые сейчас находятся в очереди скачивания и установки из Store. Эти методы удобны, если ваше приложение или игра поддерживает большие дополнительные пакеты (включая DLC), скачивание и установка которых может занять несколько часов или дней, и вы хотите эффективно действовать в случае, когда клиент закрывает ваше приложение или игру до завершения скачивания и установки. Когда пользователь снова запустит приложение или игру, код может использовать эти методы, чтобы получить информацию о состоянии пакетов, которые до сих пор находятся в очереди скачивания и установки, чтобы пользователю можно было показать статус каждого пакета.
В следующем примере кода показано, как вызывать метод GetAssociatedStoreQueueItemsAsync, чтобы получить список текущих обновлений пакета для текущего приложения и извлечь сведения о статусе для каждого пакета. В коде из этого примера предполагается следующее:
- В файле кода используется оператор using для пространств имен Windows.Services.Store и System.Threading.Tasks.
- Приложение — это однопользовательское приложение, которое запускается только в контексте пользователя, запускающего приложение. Для многопользовательского приложения используйте метод GetForUser, чтобы получить объект StoreContext вместо метода GetDefault.
Примечание.
Методы MarkUpdateInProgressInUI, RemoveItemFromUI, MarkInstallCompleteInUI, MarkInstallErrorInUI и MarkInstallPausedInUI, вызываемые в коде в этом примере, являются методами-заполнителями, которые реализуются по мере надобности в соответствии со структурой вашего приложения.
private StoreContext context = null;
private async Task GetQueuedInstallItemsAndBuildInitialStoreUI()
{
if (context == null)
{
context = StoreContext.GetDefault();
}
// Get the Store packages in the install queue.
IReadOnlyList<StoreQueueItem> storeUpdateItems = await context.GetAssociatedStoreQueueItemsAsync();
foreach (StoreQueueItem storeItem in storeUpdateItems)
{
// In this example we only care about package updates.
if (storeItem.InstallKind != StoreQueueItemKind.Update)
continue;
StoreQueueItemStatus currentStatus = storeItem.GetCurrentStatus();
StoreQueueItemState installState = currentStatus.PackageInstallState;
StoreQueueItemExtendedState extendedInstallState =
currentStatus.PackageInstallExtendedState;
// Handle the StatusChanged event to display current status to the customer.
storeItem.StatusChanged += StoreItem_StatusChanged;
switch (installState)
{
// Download and install are still in progress, so update the status for this
// item and provide the extended state info. The following methods are not
// implemented in this example; you should implement them as needed for your
// app's UI.
case StoreQueueItemState.Active:
MarkUpdateInProgressInUI(storeItem, extendedInstallState);
break;
case StoreQueueItemState.Canceled:
RemoveItemFromUI(storeItem);
break;
case StoreQueueItemState.Completed:
MarkInstallCompleteInUI(storeItem);
break;
case StoreQueueItemState.Error:
MarkInstallErrorInUI(storeItem);
break;
case StoreQueueItemState.Paused:
MarkInstallPausedInUI(storeItem, installState, extendedInstallState);
break;
}
}
}
private void StoreItem_StatusChanged(StoreQueueItem sender, object args)
{
StoreQueueItemStatus currentStatus = sender.GetCurrentStatus();
StoreQueueItemState installState = currentStatus.PackageInstallState;
StoreQueueItemExtendedState extendedInstallState = currentStatus.PackageInstallExtendedState;
switch (installState)
{
// Download and install are still in progress, so update the status for this
// item and provide the extended state info. The following methods are not
// implemented in this example; you should implement them as needed for your
// app's UI.
case StoreQueueItemState.Active:
MarkUpdateInProgressInUI(sender, extendedInstallState);
break;
case StoreQueueItemState.Canceled:
RemoveItemFromUI(sender);
break;
case StoreQueueItemState.Completed:
MarkInstallCompleteInUI(sender);
break;
case StoreQueueItemState.Error:
MarkInstallErrorInUI(sender);
break;
case StoreQueueItemState.Paused:
MarkInstallPausedInUI(sender, installState, extendedInstallState);
break;
}
}