Office.Time interface

  • Referência
Pacote:
outlook

O Time objeto é retornado como a propriedade inicial ou final de um compromisso no modo de composição.

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Métodos

getAsync(options, callback)

Obtém a hora de início ou de término de um compromisso.

A data e a hora são fornecidas como um Date objeto na asyncResult.value propriedade. O valor está no Tempo Universal Coordenado (UTC). Você pode converter a hora UTC na hora do cliente local usando o convertToLocalClientTime método.
getAsync(callback)

Obtém a hora de início ou de término de um compromisso.

A data e a hora são fornecidas como um Date objeto na asyncResult.value propriedade. O valor está no Tempo Universal Coordenado (UTC). Você pode converter a hora UTC na hora do cliente local usando o convertToLocalClientTime método.
setAsync(dateTime, options, callback)

Define a hora de início ou de término de um compromisso.

Se o setAsync método for chamado na propriedade inicial, a end propriedade será ajustada para manter a duração do compromisso conforme definido anteriormente. Se o método setAsync for chamado na propriedade end, a duração do compromisso será ampliada para a nova hora de término.

A hora deve estar em UTC; você pode obter o horário UTC correto usando o método convertToUtcClientTime.

Importante: no cliente Windows, você não pode usar esse método para atualizar o início ou o fim de uma recorrência.
setAsync(dateTime, callback)

Define a hora de início ou de término de um compromisso.

Se o setAsync método for chamado na propriedade inicial, a end propriedade será ajustada para manter a duração do compromisso conforme definido anteriormente. Se o método setAsync for chamado na propriedade end, a duração do compromisso será ampliada para a nova hora de término.

A hora deve estar em UTC; você pode obter o horário UTC correto usando o método convertToUtcClientTime.

Importante: no cliente Windows, você não pode usar esse método para atualizar o início ou o fim de uma recorrência.

Detalhes do método

getAsync(options, callback)

Obtém a hora de início ou de término de um compromisso.

A data e a hora são fornecidas como um Date objeto na asyncResult.value propriedade. O valor está no Tempo Universal Coordenado (UTC). Você pode converter a hora UTC na hora do cliente local usando o convertToLocalClientTime método.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Date>) => 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<Date>) => 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. A value propriedade do resultado é um Date objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

getAsync(callback)

Obtém a hora de início ou de término de um compromisso.

A data e a hora são fornecidas como um Date objeto na asyncResult.value propriedade. O valor está no Tempo Universal Coordenado (UTC). Você pode converter a hora UTC na hora do cliente local usando o convertToLocalClientTime método.

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

Parâmetros

callback

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

Quando o método é concluído, a função passada no parâmetro de retorno de chamada é chamada com um único parâmetro do tipo Office.AsyncResult. A value propriedade do resultado é um Date objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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/90-other-item-apis/get-set-start-appointment-organizer.yaml

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment starts: ${result.value}`);
});

setAsync(dateTime, options, callback)

Define a hora de início ou de término de um compromisso.

Se o setAsync método for chamado na propriedade inicial, a end propriedade será ajustada para manter a duração do compromisso conforme definido anteriormente. Se o método setAsync for chamado na propriedade end, a duração do compromisso será ampliada para a nova hora de término.

A hora deve estar em UTC; você pode obter o horário UTC correto usando o método convertToUtcClientTime.

Importante: no cliente Windows, você não pode usar esse método para atualizar o início ou o fim de uma recorrência.

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

Parâmetros

dateTime

Date

Um objeto de data e hora em UTC (Horário Universal Coordenado).

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 do tipo Office.AsyncResult. Se a configuração de data e hora falhar, a propriedade asyncResult.error conterá um código de erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Erros:

  • InvalidEndTime: a hora de término do compromisso é antes da hora de início do compromisso.

Exemplos

const startTime = new Date("3/14/2015");
const options = {
    // Pass information that can be used in the callback.
    asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.start.setAsync(startTime, options, function(result) {
    if (result.error) {
        console.debug(result.error);
    } else {
        // Access the asyncContext that was passed to the setAsync method.
        console.debug("Start Time " + result.asyncContext.verb);
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml

const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set start date and time to ${start}`);
});

...

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Get start date failed with message ${result.error.message}`);
    return;
  }

  const end = result.value; // Set end to current start date and time.
  end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
  Office.context.mailbox.item.end.setAsync(end, (result) => {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Set end date failed with message ${result.error.message}`);
      return;
    }
    console.log(`Successfully set end date and time to ${end}`);
  });
});

setAsync(dateTime, callback)

Define a hora de início ou de término de um compromisso.

Se o setAsync método for chamado na propriedade inicial, a end propriedade será ajustada para manter a duração do compromisso conforme definido anteriormente. Se o método setAsync for chamado na propriedade end, a duração do compromisso será ampliada para a nova hora de término.

A hora deve estar em UTC; você pode obter o horário UTC correto usando o método convertToUtcClientTime.

Importante: no cliente Windows, você não pode usar esse método para atualizar o início ou o fim de uma recorrência.

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

Parâmetros

dateTime

Date

Um objeto de data e hora em UTC (Horário Universal Coordenado).

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 do tipo Office.AsyncResult. Se a configuração de data e hora falhar, a propriedade asyncResult.error conterá um código de erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.1 ]

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

Modo outlook aplicável: compose

Erros:

  • InvalidEndTime: a hora de término do compromisso é antes da hora de início do compromisso.