Freigeben über


Abrufen inkrementeller Änderungen an Ereignissen in einer Kalenderansicht

Mithilfe von Delta Query können Sie neue, aktualisierte oder gelöschte Ereignisse in einem bestimmten Kalender oder in einer definierten Sammlung von Ereignissen (als Kalenderansicht) im Kalender abrufen. In diesem Artikel wird Letzteres beschrieben: Das Abrufen inkrementeller Änderungen an Ereignissen in einer Kalenderansicht.

Hinweis

Die Funktion für erstere , also das Abrufen inkrementeller Änderungen an Ereignissen in einem Kalender, der nicht an einen festen Anfangs- und Enddatumsbereich gebunden ist, ist derzeit nur in der Betaversion verfügbar. Weitere Informationen finden Sie im Thema zur Delta-Funktion.

Eine Kalenderansicht ist eine Auflistung von Ereignissen in einem Datums-/Uhrzeitbereich (.. /me/calendarView) aus dem Standardkalender oder einem anderen angegebenen Kalender eines Benutzers oder aus einem Gruppenkalender. Die zurückgegebenen Ereignisse können einzelne Instanzen, Vorkommen und Ausnahmen einer Serie enthalten. Mit Delta-Daten können Sie einen lokalen Speicher für Ereignisse eines Benutzers pflegen und synchronisieren, ohne dass Sie jedes Mal den gesamten Ereignissatz vom Server abrufen müssen.

Die Delta-Abfrage unterstützt die vollständige Synchronisierung, die alle Ereignisse in der angegebenen Kalenderansicht abruft, und die inkrementelle Synchronisierung, die nur die Ereignisse abruft, die seit der letzten Synchronisierung in der Kalenderansicht geändert wurden. In der Regel führen Sie zunächst eine vollständige Synchronisierung durch und rufen anschließend regelmäßig inkrementelle Änderungen an dieser Kalenderansicht ab.

Nachverfolgen von Ereignisänderungen in einer Kalenderansicht

Delta-Abfragen für Ereignisse in einer Kalenderansicht sind spezifisch für einen Kalender und Datums-/Uhrzeitbereich, die Sie angeben. Um die Änderungen in mehreren Kalendern nachzuverfolgen, müssen Sie jeden Kalender einzeln verfolgen.

Das Nachverfolgen von Ereignisänderungen in einer Kalenderansicht ist in der Regel eine Runde aus einer oder mehreren GET-Anforderungen mit der Delta-Funktion. Die ursprüngliche GET-Anforderung wird ähnlich wie das Auflisten einer Kalenderansicht durchgeführt, außer dass die folgende Delta-Funktion eingeschlossen wird. Im Folgenden finden Sie die anfängliche GET-Deltaanforderung einer Kalenderanzeige im Standardkalender des angemeldeten Benutzers:

GET /me/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}

Eine GET-Anforderung mit der delta-Funktion gibt Folgendes zurück:

  • Ein @odata.nextLink-Objekt, das eine URL mit einem delta-Funktionsaufruf und einem $skipToken-Objekt enthält, oder
  • Ein @odata.deltaLink-Objekt, das eine URL mit einem delta-Funktionsaufruf und einem $deltaToken-Objekt enthält.

Diese Token sind Statustoken, die die Parameter startDateTime und endDateTime sowie alle anderen Abfrageparameter in der GET-Anforderung der ursprünglichen Delta-Abfrage codieren. Diese Parameter müssen in nachfolgenden Anforderungen nicht berücksichtigt werden, da Sie in den Token codiert sind.

Zustandstoken sind für den Client nicht transparent. Um mit einer Änderungsnachverfolgung fortzufahren, kopieren Sie die von der letzten GET-Anforderung zurückgegebene @odata.nextLink- oder @odata.deltaLink-URL einfach und wenden sie auf den nächsten delta-Funktionsaufruf für dieselbe Kalenderansicht an. @odata.deltaLink (in einer Antwort zurückgegeben), bedeutet, dass die aktuelle Runde der Änderungsnachverfolgung abgeschlossen ist. Sie können die @odata.deltaLink-URL für die nächste Runde speichern und verwenden.

Im Beispiel finden Sie Informationen zur Verwendung der URLs @odata.nextLink und @odata.deltaLink.

Verwenden von Abfrageparametern in einer Delta-Abfrage für eine Kalenderansicht

  • Schließen Sie die Parameter startDateTime und endDateTime ein, um einen Datums-/Uhrzeitbereich für Ihre Kalenderansicht zu definieren.
  • $select wird nicht unterstützt.

Optionaler Anforderungsheader

Jede GET-Anforderung der Delta-Abfrage gibt eine Sammlung aus einem oder mehreren Ereignissen in der Antwort zurück. Sie können optional den Anforderungsheader, Prefer: odata.maxpagesize={x}, angeben, um die maximale Anzahl an Ereignissen in einer Antwort festzulegen.

Beispiel: Ereignisse in einer Kalenderansicht synchronisieren

Das folgende Beispiel zeigt eine Reihe von 3 Anforderungen zum Synchronisieren des Standardkalenders eines Benutzers in einem bestimmten Zeitbereich. Es gibt 5 Ereignisse in dieser Kalenderansicht.

Aus Platzgründen wird in den Beispielantworten nur eine Untergruppe der Eigenschaften eines Ereignisses angezeigt. In einem tatsächlichen Aufruf werden die meiste Ereigniseigenschaften zurückgegeben.

Sehen Sie sich an, was Sie in der nächsten Runde tun werden.

Schritt 1: Beispiel für ursprüngliche Anforderung

In diesem Beispiel wird die angegebene Kalenderansicht im Standardkalender des angemeldeten Benutzers zum ersten Mal synchronisiert, sodass die ursprüngliche Synchronisierungsanforderung kein Zustandstoken enthält. In dieser Runde werden alle Ereignisse in dieser Kalenderansicht zurückgegeben.

Die erste Anforderung gibt Folgendes an:

  • Datum-/Uhrzeitwerte für die Parameter startDateTime und endDateTime.
  • Den optionalen Anforderungsheader, odata.maxpagesize, der gleichzeitig 2 Ereignisse zurückgibt.
GET https://graph.microsoft.com/v1.0/me/calendarView/delta?startdatetime=2016-12-01T00:00:00Z&enddatetime=2016-12-30T00:00:00Z HTTP/1.1
Prefer: odata.maxpagesize=2

Beispiel für ursprüngliche Antwort

Die Antwort enthält zwei Ereignisse und einen @odata.nextLink-Antwortheader mit einem skipToken. Die @odata.nextLink-URL gibt an, dass in der Kalenderansicht weitere Ereignisse abgerufen werden können.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#Collection(event)",
    "@odata.nextLink":"https://graph.microsoft.com/v1.0/me/calendarView/delta?$skiptoken=R0usmcCM996atia_s",
    "value":[
        {
            "@odata.type":"#microsoft.graph.event",
            "@odata.etag":"W/\"EZ9r3czxY0m2jz8c45czkwAAFXcvIQ==\"",
            "subject":"Plan shopping list",
            "body":{
                "contentType":"html",
                "content":""
            },
            "start":{
                "dateTime":"2016-12-09T20:30:00.0000000",
                "timeZone":"UTC"
            },
            "end":{
                "dateTime":"2016-12-09T22:00:00.0000000",
                "timeZone":"UTC"
            },
            "attendees":[

            ],
            "organizer":{
                "emailAddress":{
                    "name":"Samantha Booth",
                    "address":"samanthab@contoso.com"
                }
            },
            "id":"AAMkADNVxRAAA="
        },
        {
            "@odata.type":"#microsoft.graph.event",
            "@odata.etag":"W/\"EZ9r3czxY0m2jz8c45czkwAAFXcvIg==\"",
            "subject":"Pick up car",
            "body":{
                "contentType":"html",
                "content":""
            },
            "start":{
                "dateTime":"2016-12-10T01:00:00.0000000",
                "timeZone":"UTC"
            },
            "end":{
                "dateTime":"2016-12-10T02:00:00.0000000",
                "timeZone":"UTC"
            },
            "attendees":[

            ],
            "organizer":{
                "emailAddress":{
                    "name":"Samantha Booth",
                    "address":"samanthab@contoso.com"
                }
            },
            "id":"AAMkADVxSAAA="
        }
    ]
}

Schritt 2: Beispiel für zweite Anforderung

Die zweite Anforderung gibt die aus der vorherigen Antwort zurückgegebene @odata.nextLink-URL an. Beachten Sie, dass sie nicht dieselben Parameter startDateTime und endDateTime wie in der ursprünglichen Anforderung angeben muss, da das skipToken in der @odata.nextLink-URL diese codiert und einschließt.

GET https://graph.microsoft.com/v1.0/me/calendarView/delta?$skiptoken=R0usmcCM996atia_s HTTP/1.1
Prefer: odata.maxpagesize=2

Beispiel für zweite Antwort

Die zweite Antwort gibt die nächsten 2 Ereignisse in der Kalenderansicht und ein weiteres @odata.nextLink, was bedeutet, dass weitere abzurufende Ereignisse in der Kalenderansicht vorhanden sind.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#Collection(event)",
    "@odata.nextLink":"https://graph.microsoft.com/v1.0/me/calendarView/delta?$skiptoken=R0usmci39OQxqJrxK4",
    "value":[
        {
            "@odata.type":"#microsoft.graph.event",
            "@odata.etag":"W/\"EZ9r3czxY0m2jz8c45czkwAAFXcvIw==\"",
            "subject":"Get food",
            "body":{
                "contentType":"html",
                "content":""
            },
            "start":{
                "dateTime":"2016-12-10T19:30:00.0000000",
                "timeZone":"UTC"
            },
            "end":{
                "dateTime":"2016-12-10T21:30:00.0000000",
                "timeZone":"UTC"
            },
            "attendees":[

            ],
            "organizer":{
                "emailAddress":{
                    "name":"Samantha Booth",
                    "address":"samanthab@contoso.com"
                }
            },
            "id":"AAMkADVxTAAA="
        },
        {
            "@odata.type":"#microsoft.graph.event",
            "@odata.etag":"W/\"EZ9r3czxY0m2jz8c45czkwAAFXcvJA==\"",
            "subject":"Prepare food",
            "body":{
                "contentType":"html",
                "content":""
            },
            "start":{
                "dateTime":"2016-12-10T22:00:00.0000000",
                "timeZone":"UTC"
            },
            "end":{
                "dateTime":"2016-12-11T00:00:00.0000000",
                "timeZone":"UTC"
            },
            "attendees":[

            ],
            "organizer":{
                "emailAddress":{
                    "name":"Samantha Booth",
                    "address":"samanthab@contoso.com"
                }
            },
            "id":"AAMkADVxUAAA="
        }
    ]
}

Schritt 3: Beispiel für dritte Anforderung

Die dritte Anforderung verwendet weiterhin das neueste aus der letzten Synchronisierungsanforderung zurückgegebene @odata.nextLink.

GET https://graph.microsoft.com/v1.0/me/calendarView/delta?$skiptoken=R0usmci39OQxqJrxK4 HTTP/1.1
Prefer: odata.maxpagesize=2

Beispiel für dritte und letzte Antwort

Die dritte Antwort gibt das einzige in dem Ordner verbleibende Ereignis in der Kalenderansicht sowie eine @odata.deltaLink-URL zurück, was bedeutet, dass die Synchronisierung für diese Kalenderansicht momentan abgeschlossen ist. Speichern und verwenden Sie die @odata.deltaLink-URL, um diese Kalenderansicht in der nächsten Runde zu synchronisieren.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#Collection(event)",
    "@odata.deltaLink":"https://graph.microsoft.com/v1.0/me/calendarView/delta?$deltatoken=R0usmcMDNGg0J1E",
    "value":[
        {
            "@odata.type":"#microsoft.graph.event",
            "@odata.etag":"W/\"EZ9r3czxY0m2jz8c45czkwAALZu97g==\"",
            "subject":"Rest!",
            "body":{
                "contentType":"html",
                "content":""
            },
            "start":{
                "dateTime":"2016-12-12T02:00:00.0000000",
                "timeZone":"UTC"
            },
            "end":{
                "dateTime":"2016-12-12T07:30:00.0000000",
                "timeZone":"UTC"
            },
            "location":{
                "displayName":"Home"
            },
            "attendees":[

            ],
            "organizer":{
                "emailAddress":{
                    "name":"Samantha Booth",
                    "address":"samanthab@contoso.com"
                }
            },
            "id":"AAMkADj1HuAAA="
        }
    ]
}

Die nächste Runde: Beispiel für erste Anforderung

Mit dem @odata.deltaLink aus der letzten Anforderung in der letzten Runde können Sie nur die Ereignisse abrufen, die sich seitdem in dieser Kalenderansicht geändert haben (durch Hinzufügung, Löschung oder Aktualisierung). Ihre erste Anforderung in der nächsten Runde sieht folgendermaßen aus, sofern Sie die gleiche maximale Seitengröße in der Antwort beibehalten möchten:

GET https://graph.microsoft.com/v1.0/me/calendarView/delta?$deltatoken=R0usmcMDNGg0J1E HTTP/1.1
Prefer: odata.maxpagesize=2

Die nächste Runde: Beispiel für erste Antwort

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#Collection(event)",
    "@odata.deltaLink":"https://graph.microsoft.com/v1.0/me/calendarView/delta?$deltatoken=R0usmcFuQtZdtpk4",
    "value":[
        {
            "@odata.type": "#microsoft.graph.event",
            "id": "AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQLkRkXbBznTvAADb6ytyAAA=",
            "@removed": {
                "reason": "deleted"
            }
        },
        {
            "@odata.type":"#microsoft.graph.event",
            "@odata.etag":"W/\"EZ9r3czxY0m2jz8c45czkwAALZu97w==\"",
            "subject":"Attend service",
            "body":{
                "contentType":"html",
                "content":""
            },
            "start":{
                "dateTime":"2016-12-25T06:00:00.0000000",
                "timeZone":"UTC"
            },
            "end":{
                "dateTime":"2016-12-25T07:30:00.0000000",
                "timeZone":"UTC"
            },
            "location":{
                "displayName":"Chapel of Saint Ignatius",
                "address":{
                    "street":"900 Broadway",
                    "city":"Seattle",
                    "state":"WA",
                    "countryOrRegion":"United States",
                    "postalCode":""
                },
                "coordinates":{
                    "latitude":47.6105,
                    "longitude":-122.321
                }
            },
            "attendees":[

            ],
            "organizer":{
                "emailAddress":{
                    "name":"Samantha Booth",
                    "address":"samanthab@contoso.com"
                }
            },
            "id":"AAMkADj1HvAAA="
        }
    ]
}