evento: deltaevent: delta

Namespace: microsoft.graphNamespace: microsoft.graph

Obtenha um conjunto de eventos que foram adicionados, excluídos ou atualizados em um calendarView (um intervalo de eventos) do calendário principal do usuário.Get a set of events that have been added, deleted, or updated in a calendarView (a range of events) of the user's primary calendar.

A chamada de função delta para eventos é semelhante a uma solicitação GET /calendarview por um intervalo de dados no calendário principal do usuário, exceto ao aplicar tokens de estado de forma apropriada em uma ou mais dessas chamadas, você pode consultar alterações incrementais no modo de exibição de calendário. Isso permite manter e sincronizar um armazenamento local de eventos do usuário no calendário principal, sem precisar buscar todos os eventos do calendário do servidor de cada vez.A delta function call for events is similar to a GET /calendarview request for a range of dates in the user's primary calendar, except that by appropriately applying state tokens in one or more of these calls, you can query for incremental changes in that calender view. This allows you to maintain and synchronize a local store of a user's events in the primary calendar, without having to fetch all the events of that calendar from the server every time.

PermissõesPermissions

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permissãoPermission type Permissões (da com menos para a com mais privilégios)Permissions (from least to most privileged)
Delegado (conta corporativa ou de estudante)Delegated (work or school account) Calendars.ReadCalendars.Read
Delegado (conta pessoal da Microsoft)Delegated (personal Microsoft account) Calendars.ReadCalendars.Read
AplicativoApplication Calendars.ReadCalendars.Read

Solicitação HTTPHTTP request

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

Parâmetros de consultaQuery parameters

O controle de alterações em eventos corresponde a uma série 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 porção do token da URL nextLink ou deltaLink fornecida na resposta. Você só precisa especificar os parâmetros de consulta desejados uma vez antecipados. Em solicitações subsequentes, basta copiar e aplicar a URL nextLink ou deltaLink da resposta anterior já que essa URL inclui os parâmetros codificados desejados.Tracking changes in events incurs a round of one or more delta function calls. If you use any query parameter (other than $deltatoken and $skiptoken), you must specify it in the initial delta request. Microsoft Graph automatically encodes any specified parameters into the token portion of the nextLink or deltaLink URL provided in the response. You only need to specify any desired query parameters once upfront. In subsequent requests, simply copy and apply the nextLink or deltaLink URL from the previous response, as that URL already includes the encoded, desired parameters.

Parâmetro de consultaQuery parameter TipoType DescriçãoDescription
startDateTimestartDateTime StringString A data e a hora de início do intervalo de tempo, representadas no formato ISO 8601. Por exemplo, "2015-11-08T19:00:00.0000000".The start date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T19:00:00.0000000".
endDateTimeendDateTime StringString A data e a hora de término do intervalo de tempo, representadas no formato ISO 8601. Por exemplo, "2015-11-08T20:00:00.0000000".The end date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T20:00:00.0000000".
$deltatoken$deltatoken stringstring Um token de estado retornado na URL deltaLink da chamada de função delta anterior do mesmo modo de exibição de calendário, indicando a conclusão da série de controle de alterações. Salve e aplique toda a URL deltaLink, incluindo esse token na primeira solicitação da próxima série de controle do modo de exibição de calendário.A state token returned in the deltaLink URL of the previous delta function call for the same calendar view, indicating the completion of that round of change tracking. Save and apply the entire deltaLink URL including this token in the first request of the next round of change tracking for that calendar view.
$skiptoken$skiptoken stringstring Um token de estado retornado na URL nextLink da chamada de função delta anterior indicando que não há mais alterações a serem controladas no mesmo modo de exibição de calendário.A state token returned in the nextLink URL of the previous delta function call, indicating there are further changes to be tracked in the same calendar view.

Quando você faz uma consulta delta em um modo de exibição de calendário, espera obter todas as propriedades que obteria normalmente de uma solicitação GET /calendarview. O $select não é compatível nesse caso.When you do a delta query on a calendar view, expect to get all the properties you'd normally get from a GET /calendarview request. $select is not supported in this case.

Cabeçalhos de solicitaçãoRequest headers

NomeName TipoType DescriçãoDescription
AutorizaçãoAuthorization stringstring {token} de portador. Obrigatório.Bearer {token}. Required.
Content-TypeContent-Type stringstring application/json. Obrigatório.application/json. Required.
PreferirPrefer cadeia de caracteresstring odata.maxpagesize={x}. Opcional.odata.maxpagesize={x}. Optional.
PreferirPrefer stringstring {Fuso horário}. Opcional, supõe-se o UTC se estiver ausente.{Time zone}. Optional, UTC assumed if absent.

RespostaResponse

Se bem-sucedido, este método retorna o código de resposta 200 OK e uma coleção de objetos event no corpo da resposta.If successful, this method returns a 200 OK response code and event collection object in the response body.

ExemploExample

SolicitaçãoRequest

O exemplo a seguir mostra como fazer uma única chamada de função delta e limitar o número máximo de eventos no corpo da resposta a 2.The following example shows how to make a single delta function call, and limit the maximum number of events in the response body to 2.

Para controlar as alterações em um modo de exibição de calendário, você faz uma ou mais chamadas de função delta, com os tokens de estado apropriados, para obter o conjunto de alterações incrementais desde a última consulta delta.To track changes in a calendar view, you would make one or more delta function calls, with appropriate state tokens, to get the set of incremental changes since the last delta query.

GET https://graph.microsoft.com/v1.0/me/calendarView/delta?startdatetime={start_datetime}&enddatetime={end_datetime}

Prefer: odata.maxpagesize=2
RespostaResponse

Se a solicitação for bem-sucedida, a resposta incluiria um token de estado, que é um skipToken (em um cabeçalho de resposta _@odata.nextLink_) ou um deltaToken (em um cabeçalho de resposta _@odata.deltaLink_). Respectivamente, elas indicam se você deverá continuar com a série ou se já concluiu a obtenção de todas as alterações dessa série.If the request is successful, the response would include a state token, which is either a skipToken (in an _@odata.nextLink_ response header) or a deltaToken (in an _@odata.deltaLink_ response header). Respectively, they indicate whether you should continue with the round or you have completed getting all the changes for that round.

A resposta abaixo mostra um skipToken em um cabeçalho de resposta _@odata.nextLink_.The response below shows a skipToken in an _@odata.nextLink_ response header.

Observação: o objeto response mostrado aqui pode estar truncado por motivos de concisão. Todas as propriedades serão retornadas de uma chamada real.Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/me/calendarView/delta?$skiptoken={_skipToken_}",
  "value": [
    {
      "originalStartTimeZone": "originalStartTimeZone-value",
      "originalEndTimeZone": "originalEndTimeZone-value",
      "responseStatus": {
        "response": "response-value",
        "time": "datetime-value"
      },
      "iCalUId": "iCalUId-value",
      "reminderMinutesBeforeStart": 99,
      "isReminderOn": true
    }
  ]
}

Confira tambémSee also