Vytvoření nebo přepsání instalace

Článek
05/26/2023

Tato metoda vytvoří nebo přepíše instalaci.

Žádost

Metoda	Identifikátor URI žádosti	Verze PROTOKOLU HTTP
PUT	`https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01`	HTTP/1.1

Hlavičky požadavku

Následující tabulka popisuje požadované a volitelné hlavičky požadavků.

Hlavička požadavku	Popis
Typ obsahu	application/json
Autorizace	Token SAS se vygeneruje tak, jak je uvedeno v části Ověřování pomocí sdíleného přístupového podpisu se službou Service Bus.
x-ms-version	2015-01

Text požadavku

Následující tabulka popisuje vlastnosti textu požadavku JSON pro instalace:

Název	Typ	Vyžadováno	Jen pro čtení	Popis
installationId	Řetězec	Yes	No	Globálně jedinečný řetězec identifikátoru
ID uživatele	Řetězec	No	No	Vlastní řetězec obsahující kombinaci alfanumerických znaků a -_@#.:=. Mezi ID uživatele a ID instalace existuje relace 1:N (tj. jedno ID uživatele může být přidruženo k více instalacím).
lastActiveOn	Řetězec	No	Yes	Datum, kdy byla instalace deaktivována službou PNS.
expirationTime	Řetězec	No	Yes	Řetězec obsahující datum a čas ve W3C DTF, YYYY-MM-DDThh:mmTZD (například 1997-07-16T19:20+01:00)), ve kterém platnost registrace vyprší. Hodnotu lze nastavit na úrovni centra při vytváření nebo aktualizaci a ve výchozím nastavení nikdy nevyprší platnost (9999-12-31T23:59:59).
Lastupdate	Řetězec	Při aktualizaci se ignoruje. Vráceno při čtení.	Yes	Datum poslední aktualizace této instalace ve formátu W3C
platforma	Řetězec	Yes	No	Může to být {APNS, WNS, MPNS, ADM, GCM}.
pushChannel	Řetězec	Yes	No	Popisovač PNS pro tuto instalaci (pokud používáte WNS a ChannelUri applicationTile).
expiredPushChannel	Logická hodnota	Při aktualizaci se ignoruje. Vráceno při čtení.	Yes	Tento parametr je `true` , pokud vypršela platnost kanálu PNS.
tags	Pole řetězců	No	No	Pole značek. Značky jsou řetězce definované ve specifikacích centra.
šablony	Objekt JSON	No	No	Objekt JSON představující slovník templateNames k popisu šablony.
Šablony. {name}	Řetězec	No	No	Objekt JSON představující šablonu
Šablony. {name}.body	Řetězec	Ano, pokud je šablona k dispozici	No	Šablona pro text datové části oznámení.
Šablony. {name}.headers	Objekt JSON	No. Může být k dispozici pouze v případě, že je platforma WNS nebo MPNS.	No	Objekt JSON, kde každá vlastnost je název záhlaví a hodnota je výraz šablony.
Šablony. {name}.expiry	Řetězec	No. Může být k dispozici pouze v případě, že je platforma apns.	No	Výraz šablony, který se vyhodnocuje ve formátu data W3D.
Šablony. {name}.tags	Pole řetězců	No	No	Pole značek pro tuto šablonu
secondaryTiles	Objekt JSON	No. Může být k dispozici pouze v případě, že je platforma wns.	No	Objekt JSON obsahující slovník objektů tileId a secondaryTiles.
secondaryTile. {tileId}	Objekt JSON	No	No	Objekt JSON s vlastnostmi nabízených oznámení pro sekundární dlaždice
secondaryTile. {tileId}.pushChannel	Řetězec	Ano, pokud je k dispozici id dlaždice	No	ChannelUri pro sekundární dlaždici.
secondaryTile. {tileId}.tags	Pole řetězců	No	No	Značky nativních oznámení na sekundární dlaždici
secondaryTile. {tileId}.templates	Objekt JSON	No	No	Stejné jako vlastnost templates, ale pro každou sekundární dlaždici.

Je třeba počítat s následujícím:

Ve formátu JSON není pořadí prvků důležité.
Tělo šablony musí být JSON pro APNS, GCM a ADM.
Tělo šablony musí být XML pro WNS a MPNS (s výjimkou nezpracovaných).
Šablony služby WNS musí obsahovat hlavičku X-WNS-Type.
Šablony pro MPNS musí mít kompatibilní hlavičky, jak je popsáno v tématu Odesílání nabízených oznámení pro Windows Phone 8.

Následují některé příklady JSON.

Příklad registrace v APNS:

{ 
    "installationId": "12234", 
    "userID": "MyAmazingUser",
    "tags": ["foo", "bar"], 
    "platform": "apns", 
    "pushChannel": "ABCDEF-123456-…" 
}

Poznámka

Element Tags je volitelný.

Příklad nativní registrace ve službě WNS, včetně šablony a bez značek:

{ 
    "installationId": "12234", 
    "userID": "MyAmazingUser",
    "platform": "wns", 
    "pushChannel": "https://db3...", 
    "templates": { 
        "myTemplate" : { 
            body : '<toast><visual lang="en-US"><binding template="ToastTest01"><text id="1">$myTextProp1</text></binding></visual></tile>',
            headers: { "X-WNS-Type": "wns/toast" }, 
            "tags": ["foo", "bar"] 
            } 

        } 
}

Seznam kostry s mnoha možnými prvky

{ 
    installationId: "", 
    userID: "",
    expirationTime: "", 
    tags: ["foo", "bar"],
    lastUpdate: "", 
    user: "", 
    advertisingId: "", 
    appId: "" 
    platform: "", 
    pushChannel: "", 

    templates: { 
        "templateName1" : { 
            body: "", 
            headers: { "X-WNS-Type": "wns/tile" }, 
            expiration: "",
            tags: ["foo", "bar"] 
            } 
        } 

    secondaryTiles: { 
        "tileId1": { 
            pushChannel: "", 
            tags: ["foo", "bar"], 

            templates: { 
                "otherTemplate": { 
                    bodyTemplate: "", 
                    headers: { ... }, 
                    tags: ["foo"] 
                    } 
                } 
            } 
        }
}

Odpověď

Odpověď obsahuje stavový kód HTTP a sadu hlaviček odpovědi.

Kódy odpovědí

Kód	Description
200	Instalace byla úspěšně zařazena do fronty a je zpracována na pozadí.
400	Instalaci nelze vytvořit nebo přepsat, protože požadavek byl poškozen.
401	Chyba autorizace. Přístupový klíč byl nesprávný.
403	Příliš mnoho instalací v tomto oboru názvů – Instalace se nevytvořily.

Informace o stavových kódech najdete v tématu Stavové kódy a kódy chyb.

Hlavičky odpovědi

Hlavička odpovědi	Popis
Typ obsahu	application/json
Umístění obsahu	Umístění instalace ve formátu: `https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>`

Text odpovědi

Žádné

Viz také

Čtení instalace
Aktualizace instalace podle ID instalace
Odstranění instalace

Sdílet prostřednictvím