主要磁贴 API

使用主要磁贴 API 可以检查你的应用当前是否已固定到“开始”菜单,并请求固定应用的主要磁贴。

重要

需要创意者更新:目标必须为 SDK 15063,并且必须运行版本 15063 或更高版本才能使用主要磁贴 API。

重要 APIStartScreenManager 类ContainsAppListEntryAsyncRequestAddAppListEntryAsync

何时使用主要磁贴 API

你尽了很大努力为你的应用的主要磁贴设计出色的体验,现在你有机会要求用户将其固定到“开始”菜单。 但在我们深入探讨代码之前,你在设计体验时需要牢记以下几点:

  • 务必使用明确的“固定动态磁贴”行动号召在应用中制作无干扰并且可轻松消除的 UX。
  • 务必在要求用户固定磁贴前明确解释你的应用的动态磁贴值。
  • 如果你的应用的磁贴已经固定或设备不支持,不要要求用户固定它(后面有更多信息)。
  • 不要反复要求用户固定你的应用的磁贴(用户可能会生气)。
  • 没有显式用户交互或当你的应用最小化/未打开时不要调用固定 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
}

检查“开始”菜单是否支持你的应用

根据当前“开始”菜单以及你的应用类型,将你的应用固定到当前“开始”屏幕可能不受支持。 只有桌面版和移动版支持将主要磁贴固定到“开始”菜单。 因此,在显示任何固定 UI 或执行任何固定代码前,你需要先检查当前“开始”屏幕是否支持你的应用。 如果不支持,则不要提示用户固定磁贴。

// 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);

固定你的主要磁贴

如果你的主要磁贴当前未固定,并且“开始”菜单支持它,你可以向用户显示提示,告诉他们可以固定你的主要磁贴。

注意

如果你的应用位于前台,则必须从 UI 线程调用此 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);

资源