todoTaskList: delta

Namespace: microsoft.graph

Obtenha um conjunto de recursos todoTaskList que foram adicionados, eliminados ou removidos no Microsoft To Do.

Uma chamada de função delta para todoTaskList é semelhante a um pedido GET, exceto que ao aplicar adequadamente tokens de estado numa ou mais destas chamadas, pode consultar alterações incrementais no todoTaskList. Isto permite-lhe manter e sincronizar um arquivo local do todoTaskList de um utilizador sem ter de obter sempre todo o todoTaskList do servidor.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Solicitação HTTP

GET /me/todo/lists/delta
GET /users/{id|userPrincipalName}/todo/lists/delta

Parâmetros de consulta

O registo de alterações nos recursos todoTaskList incorre numa ronda de uma ou mais chamadas de função delta . Se você usar qualquer parâmetro de consulta (diferente de $deltatoken e $skiptoken), especifique-o na primeira solicitação delta. O Microsoft Graph codifica automaticamente todos os parâmetros especificados na parte do token da URL @odata.nextLink ou @odata.deltaLink fornecida na resposta. Você só precisa especificar uma vez os parâmetros de consulta desejados antecipadamente. Nos pedidos subsequentes, basta copiar e aplicar o @odata.nextLink URL ou @odata.deltaLink da resposta anterior, uma vez que esse URL já inclui os parâmetros codificados e pretendidos.

Parâmetros de consulta OData

Você pode usar um parâmetro de consulta $select como em qualquer solicitação GET para especificar somente as propriedades necessárias para obter melhor desempenho. A propriedade id sempre será retornada.

Cabeçalhos de solicitação

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto de coleção todoTaskList no corpo da resposta.

Exemplo

Solicitação

O exemplo seguinte mostra como fazer uma chamada de função delta inicial e limitar o número máximo de todoTaskList no corpo da resposta a 2.

Para controlar as alterações na todoTaskList, faria uma ou mais chamadas de função delta , com tokens de estado adequados, para obter o conjunto de alterações incrementais desde a última consulta delta.

As diferenças main entre controlar todoTaskList e controlar os recursos todoTask numa lista estão nos URLs do pedido de consulta delta e as respostas de consulta que devolvem todoTaskList em vez de todoTask collections.

GET https://graph.microsoft.com/v1.0/me/todo/lists/delta

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Todo.Lists.Delta.GetAsDeltaGetResponseAsync();

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
delta, err := graphClient.Me().Todo().Lists().Delta().GetAsDeltaGetResponse(context.Background(), nil)

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.me().todo().lists().delta().get();

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/me/todo/lists/delta')
	.get();

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->todo()->lists()->delta()->get()->wait();

Import-Module Microsoft.Graph.Users

# A UPN can also be used as -UserId.
Get-MgUserTodoListDelta -UserId $userId

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.me.todo.lists.delta.get()

Resposta

Se a solicitação for bem-sucedida, a resposta incluiria um token de estado que é um skipToken
(num cabeçalho de resposta @odata.nextLink ) ou num deltaToken (num cabeçalho de resposta @odata.deltaLink ). Respetivamente, indicam se deve continuar com a ronda ou se concluiu a obtenção de todas as alterações para essa ronda.

A resposta abaixo mostra um skipToken em um cabeçalho de resposta @odata.nextLink.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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

{
  "@odata.deltaLink":"https://graph.microsoft.com/v1.0/me/todo/lists/delta?$skiptoken=ldfdgdgfoT5csv4k99nvQqyku0jaGqMhc6XyFff5qQTQ7RJOr",
  "value": [
    {
      "@odata.etag":"W/\"4rfRVIPi9EqXgDbc8U7HGwADLLQ93w==\"",
         "displayName":"List1",
         "isOwner":true,
         "isShared":false,
         "wellknownListName":"none",
         "id":"AQMkADMwNTcyZjQzLTdkMGItNDdjMy04ZTYwLTJhYmUzNGI5ZD"
    }
  ]
}

Conteúdo relacionado

• Consulta delta do Microsoft Graph