Pencere öğesi sağlayıcısı ActivateApplication protokolü

Bu makalede , ActivateApplication etkinleştirme türünü kullanan pencere öğeleri sağlayıcıları için komut satırı etkinleştirme parametrelerinin biçimi açıklanmaktadır.

Important

Pencere öğesi sağlayıcıları, Pencere öğesi sağlayıcısı bildirim dosyasında Pencere öğesi sağlayıcı paketi bildirim XML biçiminde açıklandığı gibi bir etkinleştirme yöntemi belirtir. Pencere öğesi sağlayıcılarının CreateInstance etkinleştirme türünü kullanması ve ActivateApplication etkinleştirme yöntemini kullanmak yerine IWidgetProvider arabirim yöntemlerini kullanarak pencere öğesi konak isteklerine yanıt vermesi önerilir. Bu makaledeki bilgiler eksiksizlik için verilmiştir ve çoğu pencere öğesi sağlayıcısı uygulaması tarafından kullanılması önerilmez.

ActivateApplication’daki bağımsız değişkenler dizesi ve base64url kodlaması

Pencere öğesi sağlayıcısı etkinleştirildiğinde, komut satırı argümanlarında base64url kodlamasından önce --widget-call= öneki bulunur.

--widget-call=[base64url]

Örneğin, içindeki base64url bölümü

--widget-call=ew0KICAgICJXaWRnZXRDYWxsIjoiQ3JlYXRlV2lkZ2V0IiwNCiAgICAiV2lkZ2V0Q29udGV4dCI6ew0KICAgICAgICAiSWQiOiI5ODU4MjEwOS1jNmJmLTQzNzItODlkNi04OWY1N2ViNzU0ZjYiLA0KICAgICAgICAiRGVmaW5pdGlvbk5hbWUiOiJQV0FfQ291bnRpbmdfV2lkZ2V0IiwNCiAgICAgICAgIlNpemUiOiJMYXJnZSINCiAgICB9DQp9

olarak kodu çözülür

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

Komut satırı biçim ayrıntıları

Json komut satırı şu yöntemlere IWidgetProvider çağrıları kodlar:

    interface IWidgetProvider
    {
        void CreateWidget(WidgetContext widgetContext);
        void DeleteWidget(String widgetId);
        void OnActionInvoked(WidgetCallInvokedArgs actionInvokedArgs);
        void OnWidgetContextChanged(WidgetContextChangedArgs contextChangedArgs);
    }

Her etkinleştirme bir yöntem çağrısını temsil eder. Json nesnesinin yöntem adına sahip bir WidgetCall değeri ve ardından her parametre için büyük harf dışında parametre adı olarak adlandırılan bir değeri vardır. Her parametre, JSON nesnesine <değişken adı, değer> çifti olarak eşlenir. Örneğin, CreateWidget yönteminin WidgetContext widgetContext parametresi için, WidgetContext şu şekilde tanımlanır:

    runtimeclass WidgetContext
    {
        String Id { get; };
        String DefinitionId{ get; };
        String Size { get; };
    };

Note

Pencere öğesi sağlayıcıları, gelecekte ek parametrelerin eklendiği durumu işlemek için beklenmeyen parametre değerlerini yoksamalıdır.

Pencere öğesi sağlayıcısı CreateWidget API çağrısı, JSON nesnesi olarak düzenlenir:

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

Nesne, her zaman WidgetCall değerini ve IWidgetProvider yöntemi tarafından belirtildiği gibi tüm parametre değerlerini içerir.

Marshalled nesne örnekleri

Widget JSON nesnesi oluşturma

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

Pencere Öğesi Json nesnesini silme

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

OnActionInvoked JSON Nesnesi

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

Json Nesnesini Etkinleştirme

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

Json Nesnesini Devre Dışı Bırak

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

OnWidgetContextChanged JSON Nesnesi

Örneğin, WidgetSizeMedium olarak değiştiğinde bir WidgetContextChanged olayı tetiklenir.

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