provider di widget protocollo ActivateApplication

Questo articolo descrive il formato dei parametri di attivazione della riga di comando per i provider di widget che usano il tipo di attivazione ActivateApplication .

Importante

I provider di widget specificano un metodo di attivazione nel file manifesto del provider widget come descritto nel formato XML del manifesto del pacchetto del provider widget. È consigliabile che i provider di widget usino il tipo di attivazione CreateInstance e rispondano alle richieste host del widget usando i metodi di interfaccia IWidgetProvider invece di usare il metodo di attivazione ActivateApplication . Le informazioni contenute in questo articolo sono fornite per completezza e non sono consigliate per l'uso da parte della maggior parte delle implementazioni del provider di widget.

Stringa di argomenti nella codifica ActivateApplication e base64url

Quando il provider di widget viene attivato, la riga di comando avrà il prefisso --widget-call= prima della codifica base64url negli argomenti della riga di comando.

--widget-call=[base64url]

Ad esempio, la parte base64url in

--widget-call=ewogICAgIldpZGdldENhbGwiOiJDcmVhdGVXaWRnZXQiLAogICAgIldpZGdldENvbnRleHQiOnsKICAgICAgICAiSWQiOiI5ODU4MjEwOS1jNmJmLTQzNzItODlkNi04OWY1N2ViNzU0ZjYiLAogICAgICAgICJEZWZpbml0aW9uSWQiOiJQV0FfQ291bnRpbmdfV2lkZ2V0IiwKICAgICAgICAiU2l6ZSI6IkxhcmdlIgogICAgfQp9

viene decodificato in

{
    "WidgetCall":"CreateWidget",
    "WidgetContext":{
        "Id":"98582109-c6bf-4372-89d6-89f57eb754f6",
        "DefinitionId":"PWA_Counting_Widget",
        "Size":"Large"
    }
}

Dettagli del formato della riga di comando

La riga di comando JSON rappresenta le chiamate corrispondenti ai metodi IWidgetProvider . Lo pseudocodice seguente riepiloga tali metodi; non è una dichiarazione di interfaccia compilabile.

    interface IWidgetProvider
    {
        void CreateWidget(WidgetContext widgetContext);
        void DeleteWidget(String widgetId, String customState);
        void OnActionInvoked(WidgetActionInvokedArgs actionInvokedArgs);
        void OnWidgetContextChanged(WidgetContextChangedArgs contextChangedArgs);
        void Activate(WidgetContext widgetContext);
        void Deactivate(String widgetId);
    }

Ogni attivazione rappresenta una chiamata al metodo. L'oggetto JSON ha un valore WidgetCall con il nome del metodo e le proprietà contenenti i dati della chiamata. Negli esempi seguenti vengono illustrati i nomi delle proprietà di trasporto, incluso Args per gli oggetti argomento di callback.

Per un WidgetContextoggetto , il codice JSON contiene Id, DefinitionIde Size. Id identifica un'istanza del widget e DefinitionId identifica la definizione del manifest. Il codice JSON rappresenta Size come stringa, "Large"ad esempio ; la proprietà API WidgetContext.Size effettiva è un'enumerazione WidgetSize , non una stringa.

Note

I provider di widget devono ignorare i valori dei parametri imprevisti per gestire il caso in cui in futuro vengono aggiunti parametri aggiuntivi.

La chiamata API del provider CreateWidget di widget viene sottoposta a marshalling in un oggetto JSON:

{
    "WidgetCall":"CreateWidget",
    "WidgetContext":{
        "Id":"98582109-c6bf-4372-89d6-89f57eb754f6",
        "DefinitionId":"PWA_Counting_Widget",
        "Size":"Large"
    }
}

Usare il formato di trasporto JSON illustrato qui quando si gestiscono gli argomenti ActivateApplication , anziché considerare JSON come dichiarazione di interfaccia WinRT.

Esempi di oggetti serializzati

Creare un oggetto JSON Widget

{
    "WidgetCall":"CreateWidget",
    "WidgetContext":{
        "Id":"98582109-c6bf-4372-89d6-89f57eb754f6",
        "DefinitionId":"PWA_Counting_Widget",
        "Size":"Large"
    }
}

Elimina oggetto Json del widget

{
  "WidgetId": "1AC74363-177B-4CD2-995F-3B25AEEA3FF4",
  "WidgetCall": "DeleteWidget",
  "CustomState": "usedata"
}

Oggetto JSON OnActionInvoked

{
    "WidgetCall": "OnActionInvoked",
    "Args":{
        "Verb": "Verb String",
        "Data": "Data Details",
        "CustomState": "usedata",
        "WidgetContext": {
            "Id":"98582109-c6bf-4372-89d6-89f57eb754f6",
            "DefinitionId":"PWA_Counting_Widget",
            "Size":"Large"
        }
    }
}

Attivare l'oggetto Json

{
    "WidgetCall": "Activate",
    "WidgetContext": {
        "Id":"98582109-c6bf-4372-89d6-89f57eb754f6",
        "DefinitionId":"PWA_Counting_Widget",
        "Size":"Large"
    }
}

Disattiva oggetto Json

{
    "WidgetCall": "Deactivate",
    "WidgetId":"98582109-c6bf-4372-89d6-89f57eb754f6"
}

Oggetto JSON OnWidgetContextChanged

Ad esempio, quando WidgetSize cambia in Medium, viene attivato un WidgetContextChanged evento.

{
  "WidgetCall": "OnWidgetContextChanged",
  "Args":{
    "WidgetContext":{
            "Id":"98582109-c6bf-4372-89d6-89f57eb754f6",
            "DefinitionId":"PWA_Counting_Widget",
            "Size":"Medium"
        }
  }
}