Telepítés létrehozása vagy felülírása

Cikk
05/26/2023

Ez a metódus létrehoz vagy felülír egy telepítést.

Kérés

Metódus	Kérés URI-ja	HTTP-verzió
PUT	`https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01`	HTTP/1.1

Kérésfejlécek

Az alábbi táblázat a szükséges és nem kötelező kérelemfejléceket ismerteti.

Kérelem fejléce	Leírás
Content-Type	application/json
Engedélyezés	A Service Bus használatával történő közös hozzáférésű aláírás-hitelesítésben megadott módon létrehozott SAS-jogkivonat.
x-ms-version	2015-01

A kérés törzse

Az alábbi táblázat a telepítések JSON-kérelemtörzsének tulajdonságait ismerteti:

Név	Típus	Kötelező	Csak olvasható	Description
installationId	Sztring	Igen	Nem	Globálisan egyedi azonosító sztring
userID	Sztring	Nem	Nem	Egyéni sztring, amely alfanumerikus karakterek és -_@#.:=kombinációját tartalmazza. A UserID és a telepítési azonosító között egy-többhöz kapcsolat van (azaz egy felhasználói azonosító több telepítéshez is társítható)
lastActiveOn	Sztring	Nem	Igen	Az a dátum, amikor a telepítést a PNS inaktiválta.
expirationTime	Sztring	Nem	Igen	A W3C DTF, YYYY-MM-DDThh:mmTZD (például 1997-07-16T19:20+01:00)) dátumot és időt tartalmazó sztring, amelyben a regisztráció lejár. Az érték a létrehozás vagy frissítés központi szintjén állítható be, és alapértelmezés szerint soha nem jár le (9999-12-31T23:59:59).
lastUpdate	Sztring	Frissítéskor figyelmen kívül hagyva. Olvasáskor visszaadva.	Yes	A telepítés utolsó frissítésének dátuma W3C formátumban.
platform	Sztring	Igen	Nem	Lehet {APNS, WNS, MPNS, ADM, GCM}.
pushChannel	Sztring	Igen	Nem	A telepítés PNS-leírója (ha a WNS-t és az ApplicationTile ChannelUri-t használja).
expiredPushChannel	Logikai	Frissítéskor figyelmen kívül hagyva. Olvasáskor visszaadva.	Yes	Ez a paraméter akkor jelenik `true` meg, ha a PNS lejárt a csatornán.
tags	Sztringek tömbje	Nem	Nem	Címkék tömbje. A címkék a központi specifikációkban meghatározott sztringek.
sablonok	JSON-objektum	Nem	Nem	Egy JSON-objektum, amely a templateNames és a sablon leírásának szótárát jelöli.
Sablonok. {name}	Sztring	Nem	Nem	Sablont képviselő JSON-objektum.
Sablonok. {name}.body	Sztring	Igen, ha a sablon jelen van	No	Sablon az értesítési hasznos adatok törzséhez.
Sablonok. {name}.headers	JSON-objektum	Nem. Csak akkor lehet jelen, ha a platform WNS vagy MPNS.	No	A JSON-objektum, ahol minden tulajdonság fejlécnév, az érték pedig sablonkifejezés.
Sablonok. {name}.expiry	Sztring	Nem. Csak akkor lehet jelen, ha a platform apns	No	A W3D dátumformátumban kiértékelt sablonkifejezés.
Sablonok. {name}.tags	Sztringek tömbje	Nem	Nem	A sablon címkéinek tömbje.
secondaryTiles	JSON-objektum	Nem. Csak akkor lehet jelen, ha a platform wns.	No	A tileId és a secondaryTiles objektumok szótárát tartalmazó JSON-objektum.
secondaryTile. {tileId}	JSON-objektum	Nem	Nem	JSON-objektum másodlagos csempék leküldési tulajdonságaival.
secondaryTile. {tileId}.pushChannel	Sztring	Igen, ha a tileId jelen van	No	ChannelUri másodlagos csempéhez.
secondaryTile. {tileId}.tags	Sztringek tömbje	Nem	Nem	Címkék a másodlagos csempére irányuló natív értesítésekhez.
secondaryTile. {tileId}.templates	JSON-objektum	Nem	Nem	Ugyanaz, mint a templates tulajdonság, de minden másodlagos csempe esetében.

Vegye figyelembe a következő szempontokat:

A JSON-ban az elemek sorrendje nem fontos.
A sablon törzsének JSON-nak kell lennie az APNS, a GCM és az ADM esetében.
A sablon törzsének XML-nek kell lennie a WNS-hez és az MPNS-hez (kivéve nyersen).
A WNS-sablonoknak tartalmazniuk kell az X-WNS-type fejlécet.
Az MPNS-sablonoknak kompatibilis fejlécekkel kell rendelkezniük a leküldéses értesítések küldése Windows Phone-telefon 8-hoz című cikkben leírtak szerint.

Néhány JSON-példa következik.

Példa az APNS-ben való regisztrációra:

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

Megjegyzés

A Címkék elem nem kötelező.

Példa a natív regisztrációra a WNS-ben, beleértve egy sablont és címkék nélkül:

{ 
    "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"] 
            } 

        } 
}

Számos lehetséges elem vázlistázása

{ 
    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"] 
                    } 
                } 
            } 
        }
}

Reagálás

A válasz egy HTTP-állapotkódot és válaszfejléceket tartalmaz.

Válaszkódok

Code	Description
200	A telepítés sikeresen várólistára került, és a háttérben van feldolgozva.
400	A telepítés nem hozható létre/írható felül, mert a kérés helytelenül lett formázva.
401	Engedélyezési hiba. A hozzáférési kulcs helytelen volt.
403	Túl sok telepítés van ebben a névtérben – A telepítések nem jöttek létre.

Az állapotkódokkal kapcsolatos információkért lásd: Állapot- és hibakódok.

Válaszfejlécek

Válaszfejléc	Description
Tartalomtípus	application/json
Tartalom helye	A telepítés helye formátumban: `https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>`

Választörzs

Nincsenek.

Lásd még:

Telepítés olvasása
Telepítés frissítése telepítési azonosító alapján
Telepítés törlése

Share via