contact: delta

Namespace: microsoft.graph

Dient zum Abrufen eines Satzes von Kontakten, die einem bestimmten Ordner hinzugefügt bzw. daraus gelöscht oder darin aktualisiert wurden.

Ein Delta-Funktionsaufruf für Kontakte in einem Ordner ähnelt einer GET-Anforderung, mit dem Unterschied, dass Sie durch entsprechende Anwendung von Zustandstoken in einem oder mehreren dieser Aufrufe inkrementelle Änderungen in den Kontakten in diesem Ordner abfragen können. Auf diese Weise können Sie einen lokalen Speicher der Kontakte eines Benutzers verwalten und synchronisieren, ohne jedes Mal den gesamten Satz von Kontakten vom Server abrufen zu müssen.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

HTTP-Anforderung

GET /me/contactFolders/{id}/contacts/delta
GET /users/{id}/contactFolders/{id}/contacts/delta

Abfrageparameter

Das Nachverfolgen von Änderungen an Kontakten führt zu einer Runde von einem oder mehreren Delta-Funktionsaufrufen. Wenn Sie Abfrageparameter (außer $deltatoken und $skiptoken) verwenden, müssen Sie sie in der ursprünglichen Delta-Anforderung angeben. Microsoft Graph codiert automatisch alle angegebenen Parameter in den Tokenteil der in der Antwort enthaltenen @odata.nextLink- oder @odata.deltaLink-URL. Sie müssen alle gewünschten Abfrageparameter nur einmal im Vorfeld angeben. In nachfolgenden Anforderungen einfach die @odata.nextLink@odata.deltaLink oder-URL aus der vorherigen Antwort kopieren und anwenden, da diese URL bereits die codierten, gewünschten Parameter enthält.

OData-Abfrageparameter

• Sie können wie bei jeder GET-Anforderung den Abfrageparameter $select verwenden, um zwecks Leistungsoptimierung nur die benötigten Eigenschaften anzugeben. Die Eigenschaft id wird immer zurückgegeben.

Anforderungsheader

Antwort

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und das contact-Sammlungsobjekt im Antworttext zurückgegeben.

Beispiel

Anforderung

Das folgende Beispiel zeigt, wie Sie einen einzelnen delta-Funktionsaufruf ausführen, den $select-Parameter verwenden, um nur die Eigenschaft displayName jedes Kontakts abzurufen, und die maximale Anzahl von Kontakten im Antworttext auf 2 beschränken.

Zum Nachverfolgen von Änderungen an den Kontakten in einem Ordner führen Sie einen oder mehrere delta-Funktionsaufrufe mit entsprechenden Statustoken aus, um den Satz der inkrementellen Änderungen seit der letzten Delta-Abfrage abzurufen.

Sie können ein ähnliches Beispiel finden, das zeigt, wie Sie die Statustoken verwenden, um Änderungen in den Nachrichten eines E-Mail-Ordners nachzuverfolgen: Abrufen inkrementeller Änderungen an Nachrichten in einem Ordner. Die Hauptunterschiede zwischen der Nachverfolgung von Kontakten und der Nachverfolgung von Nachrichten in einem Ordner liegen in den Delta-Abfrageanforderungs-URLs und den Abfrageantworten, die eher Kontakte als Nachrichtensammlungen zurückgeben.

GET https://graph.microsoft.com/beta/me/contactFolders/{id}/contacts/delta?$select=displayName

Prefer: odata.maxpagesize=2

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/me/contactFolders/{id}/contacts/delta')
	.version('beta')
	.select('displayName')
	.get();

Antwort

Wenn die Anforderung erfolgreich ist, enthält die Antwort ein Statustoken, entweder ein skipToken
(in einem @odata.nextLink-Antwortheader ) oder einem deltaToken (in einem @odata.deltaLink-Antwortheader ). Sie zeigen jeweils an, ob Sie mit der Runde fortfahren sollten oder ob Sie alle Änderungen für diese Runde erhalten haben.

Die Antwort unten zeigt ein skipToken in einem @odata.nextLink-Antwortheader.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt sein.

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

{
  "@odata.nextLink":"https://graph.microsoft.com/beta/me/contactfolders/{id}/contacts/delta?$skiptoken={_skipToken_}",
  "value": [
    {
      "parentFolderId": "parentFolderId-value",
      "birthday": "2016-10-19T10:37:00Z",
      "fileAs": "fileAs-value",
      "displayName": "displayName-value",
      "givenName": "givenName-value",
      "initials": "initials-value"
    }
  ]
}

Verwandte Inhalte

• Microsoft Graph-Delta-Abfrage
• Inkrementelle Änderungen an Nachrichten in einem Ordner abrufen