Поделиться через


WidgetManager.GetWidgetInfo(String) Метод

Определение

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

public:
 virtual WidgetInfo ^ GetWidgetInfo(Platform::String ^ widgetId) = GetWidgetInfo;
WidgetInfo GetWidgetInfo(winrt::hstring const& widgetId);
public WidgetInfo GetWidgetInfo(string widgetId);
function getWidgetInfo(widgetId)
Public Function GetWidgetInfo (widgetId As String) As WidgetInfo

Параметры

widgetId
String

Platform::String

winrt::hstring

Уникальный идентификатор мини-приложения, для которого извлекается информация.

Возвращаемое значение

Объект WidgetInfo, если указанный идентификатор связан с мини-приложением, связанным с вызывающим приложением, которое не было удалено; в противном случае значение NULL.

Реализации

M:Microsoft.Windows.Widgets.Providers.IWidgetManager.GetWidgetInfo(System.String) M:Microsoft.Windows.Widgets.Providers.IWidgetManager.GetWidgetInfo(Platform::String) M:Microsoft.Windows.Widgets.Providers.IWidgetManager.GetWidgetInfo(winrt::hstring)

Примеры

В следующем примере показано получение сведений о мини-приложении для одного из мини-приложений, принадлежащих вызывающей приложению.

/*
* Sample output:
* Id: {5E3D9EDF-13A6-4185-902B-5997AE0411A5}
* Template: {
    "type": "AdaptiveCard",
    "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
    "version": "1.5"
    "body": [
        {
            "type": "TextBlock",
            "text": "${greeting}!"
        }
    ]
}
* Data: {"count": "3"}
* CustomState: 3
* DefinitionName: clickCounter
*/
using namespace std;
using namespace winrt;
using namespace Microsoft::Windows::Widgets::Providers;

class WidgetManagerOperations
{
    void PrintInfoOfWidget(hstring myWidgetId)
    {
        WidgetManager widgetManager = WidgetManager::GetDefault();

        WidgetInfo widgetInfo = widgetManager.GetWidgetInfo(myWidgetId);
        wcout << L"Id - " << L": " << widgetInfo.WidgetContext().Id().c_str() << endl;
        wcout << L"Template: " << widgetInfo.Template().c_str() << endl;
        wcout << L"Data: " << widgetInfo.Data().c_str() << endl;
        wcout << L"CustomState: " << widgetInfo.CustomState().c_str() << endl;
        wcout << L"DefinitionName: " << widgetInfo.WidgetContext().DefinitionName().c_str() << endl;
    }
}

Комментарии

Этот метод можно использовать поставщиками мини-приложений при обработке запроса, связанного с нераспознанным мини-приложением, для восстановления последнего известного состояния. Например, если вы сохраняете состояния мини-приложений в свойстве Microsoft.Windows.Widgets.Providers.WidgetUpdateRequestOptions.CustomState, этот метод можно использовать во время инициализации поставщика мини-приложений для повторного создания состояния мини-приложений.

Применяется к