Office.IsAllDayEvent interface

Pacote:

outlook

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Fornece métodos para obter e definir o status do evento durante todo o dia de uma reunião em um suplemento do Outlook.

Comentários

[ Conjunto de API: visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compose

Métodos

getAsync(options, callback)	Obtém o valor booliano que indica se o evento é o dia todo ou não.
getAsync(callback)	Obtém o valor booliano que indica se o evento é o dia todo ou não.
setAsync(isAllDayEvent, options, callback)	Define o status do evento durante todo o dia de um compromisso.
setAsync(isAllDayEvent, callback)	Define o status do evento durante todo o dia de um compromisso.

Detalhes do método

getAsync(options, callback)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém o valor booliano que indica se o evento é o dia todo ou não.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Parâmetros

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<boolean>) => void

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compose

getAsync(callback)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém o valor booliano que indica se o evento é o dia todo ou não.

getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Parâmetros

callback

(asyncResult: Office.AsyncResult<boolean>) => void

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compose

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/calendar-properties-apis.yaml

Office.context.mailbox.item.isAllDayEvent.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Is this an all-day event? " + asyncResult.value);
  } else {
    console.log("Failed to get if this is an all-day event. Error: " + JSON.stringify(asyncResult.error));
  }
});

setAsync(isAllDayEvent, options, callback)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Define o status do evento durante todo o dia de um compromisso.

setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

isAllDayEvent

boolean

valor booliano para definir o status do evento durante todo o dia.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: visualização da caixa de correio ]

Se um compromisso for marcado como um evento durante todo o dia: – a hora de início e término será marcada como 12:00 (assim como na interface do usuário do Outlook). A hora de início retornará às 12h e o horário de término será às 00h do dia seguinte.

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/calendar-properties-apis.yaml

Office.context.mailbox.item.isAllDayEvent.setAsync(true, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Failed to set all-day event: " + JSON.stringify(asyncResult.error));
  } else {
    console.log("Appointment set to all-day event.");
  }
});

setAsync(isAllDayEvent, callback)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Define o status do evento durante todo o dia de um compromisso.

setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

isAllDayEvent

boolean

valor booliano para definir o status do evento durante todo o dia.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: visualização da caixa de correio ]

Se um compromisso for marcado como um evento durante todo o dia: – a hora de início e término será marcada como 12:00 (assim como na interface do usuário do Outlook). A hora de início retornará às 12h e o horário de término será às 00h do dia seguinte.

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose