Интерфейсы API для работы с основными плитками

  • Статья

Интерфейсы API основной плитки позволяют проверить, закреплено ли ваше приложение в меню "Пуск" и закрепить основную плитку вашего приложения.

Важно!

Требуется обновление Creators Update. Для использования основных API-интерфейсов плитки необходимо использовать пакет SDK 15063 и выполнять сборку 15063 или более позднюю версию.

Важные API-интерфейсы: класс StartScreenManager, ContainsAppListEntryAsync, RequestAddAppListEntryAsync

Когда следует использовать API-интерфейсы основной плитки

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

  • Проектируйте плавные и легко исчезающие элементы в приложении с помощью четкого вызова действия "Pin Live Tile".
  • Ясно опишите значение живой плитки приложения, перед тем как просить пользователя закрепить ее.
  • Не просите пользователя закрепить плитку приложения, если плитка уже закреплена или устройство не поддерживает ее (дополнительные сведения ниже).
  • Не просите пользователя много раз закрепить плитку вашего приложения (ему, скорее всего, это не понравится).
  • Не вызывайте API закрепления без явного взаимодействия с пользователем или при сворачивании либо неоткрытии приложения.

Проверка на наличие API

Если ваше приложение поддерживает более ранние версии Windows 10, необходимо проверить, доступны ли эти API-интерфейсы основной плитки. Вы можете сделать это с помощью ApiInformation. Если интерфейсы API основной плитки недоступны, исключите любые вызовы API.

if (ApiInformation.IsTypePresent("Windows.UI.StartScreen.StartScreenManager"))
{
    // Primary tile API's supported!
}
else
{
    // Older version of Windows, no primary tile API's
}

Узнайте, поддерживает ли меню "Пуск" приложение

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

// Get your own app list entry
// (which is always the first app list entry assuming you are not a multi-app package)
AppListEntry entry = (await Package.Current.GetAppListEntriesAsync())[0];

// Check if Start supports your app
bool isSupported = StartScreenManager.GetDefault().SupportsAppListEntry(entry);

Проверка закрепления в настоящее время

Чтобы узнать, закреплена ли основная плитка в настоящее время в меню "Пуск", используйте метод ContainsAppListEntryAsync.

// Get your own app list entry
AppListEntry entry = (await Package.Current.GetAppListEntriesAsync())[0];

// Check if your app is currently pinned
bool isPinned = await StartScreenManager.GetDefault().ContainsAppListEntryAsync(entry);

Закрепление основной плитки

Если основная плитка не закреплена, и ваша плитка поддерживается меню "Пуск", вы можете показать совет пользователям относительно закрепления основной плитки.

Примечание

Необходимо вызвать этот API из потока пользовательского интерфейса, пока приложение находится на переднем плане, и этот API следует вызывать только после намеренного запроса на закрепление пользователем основной плитки (например, после нажатия кнопки "Да" в вашем совете о закреплении плитки).

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

Возвращается логическое значение, указывающее закреплена ли плитка на начальном экране. Если плитка уже закреплена, немедленно вернется значение true без отображения диалогового окна для пользователя. Если пользователь нажмет кнопку "Нет" в диалоговом окне или закрепление плитки на начальном экране не поддерживается, будет возвращено значение false. В противном случае, пользователь нажал кнопку "Да" и плитка была закреплена. API вернет значение true.

// Get your own app list entry
AppListEntry entry = (await Package.Current.GetAppListEntriesAsync())[0];

// And pin it to Start
bool isPinned = await StartScreenManager.GetDefault().RequestAddAppListEntryAsync(entry);

Ресурсы