WidgetManager.GetWidgetInfo(String) Método

Definição

Namespace:

Microsoft.Windows.Widgets.Providers

Obtém um objeto WidgetInfo que contém informações sobre o widget com a ID do widget fornecida, incluindo o modelo visual, o modelo de dados, o estado personalizado, a hora da última atualização e as informações de contexto do host do widget.

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

Parâmetros

widgetId

String

Platform::String

winrt::hstring

O identificador exclusivo do widget para o qual as informações são recuperadas.

Retornos

WidgetInfo

Um objeto WidgetInfo, se a ID especificada estiver associada a um widget associado ao aplicativo de chamada que não foi excluído; caso contrário, nulo.

Implementações

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)

Exemplos

O exemplo a seguir demonstra a recuperação de informações de widget para um dos widgets pertencentes ao aplicativo de chamada.

/*
* 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;
    }
}

Comentários

Esse método pode ser usado por provedores de widget ao lidar com uma solicitação associada a um widget não reconhecido para recuperar o último estado conhecido. Por exemplo, se você estiver armazenando os estados dos widgets na propriedade Microsoft.Windows.Widgets.Providers.WidgetUpdateRequestOptions.CustomState propriedade, poderá usar esse método durante a inicialização do provedor de widget para regenerar o estado dos widgets.