Office.DelayDeliveryTime interface

Pacote:

outlook

O DelayDeliveryTime objeto permite-lhe gerir a data e hora de entrega atrasadas de uma mensagem.

Comentários

[ Conjunto de API: Caixa de Correio 1.13 ]

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

Modo Outlook aplicável: Compose

Métodos

getAsync(options, callback)	Obtém a data e hora de entrega de uma mensagem.
getAsync(callback)	Obtém a data e hora de entrega de uma mensagem.
setAsync(datetime, options, callback)	Define a data e hora de entrega de uma mensagem.
setAsync(datetime, callback)	Define a data e hora de entrega de uma mensagem.

Detalhes do método

getAsync(options, callback)

Obtém a data e hora de entrega de uma mensagem.

getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void): void;

Parâmetros

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. A data e hora de entrega de uma mensagem são devolvidas na asyncResult.value propriedade . Se ainda não tiver sido definida uma data de entrega numa mensagem, 0 é devolvido.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.13 ]

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

Modo Outlook aplicável: Compose

getAsync(callback)

Obtém a data e hora de entrega de uma mensagem.

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

Parâmetros

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. A data e hora de entrega de uma mensagem são devolvidas na asyncResult.value propriedade . Se ainda não tiver sido definida uma data de entrega numa mensagem, 0 é devolvido.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.13 ]

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

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/delay-message-delivery.yaml

// This snippet gets the delivery date and time of a message.
Office.context.mailbox.item.delayDeliveryTime.getAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  const deliveryDate = asyncResult.value;
  if (deliveryDate === 0) {
    console.log("Your message will be delivered immediately when you select Send.");
  } else {
    const date = new Date(deliveryDate);
    console.log(`Message delivery date and time: ${date.toString()}`);
  }
});

setAsync(datetime, options, callback)

Define a data e hora de entrega de uma mensagem.

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

Parâmetros

datetime

Date

A data e hora futuras em que a mensagem deve ser enviada.

options

Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. Quaisquer erros encontrados serão fornecidos na propriedade asyncResult.error.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.13 ]

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

Modo Outlook aplicável: Compose

Importante:

• Quando item.delayDeliveryTime.setAsync é utilizado para agendar a entrega de uma mensagem, o atraso é processado no servidor. Isto permite que a mensagem seja enviada mesmo que o cliente do Outlook não esteja em execução. No Outlook clássico no Windows, a mensagem não aparece na pasta Caixa de Saída , pelo que não poderá editar a mensagem ou cancelar a entrega após selecionar Enviar. Só poderá rever a mensagem a partir da pasta Itens Enviados . No Outlook na Web, no Mac e no novo Outlook no Windows, a mensagem é apresentada na pasta Rascunhos até à hora de entrega agendada. Enquanto estiver na pasta Rascunhos , poderá editar a mensagem antes de ser enviada. Para saber mais, consulte Gerir a data e hora de entrega de uma mensagem.

• O setAsync método não é suportado numa mensagem atualmente carregada com o loadItemByIdAsync método . Para obter mais informações, consulte Ativar o seu suplemento do Outlook em várias mensagens.

Erros:

• InvalidFormatError - O formato do objeto de dados especificado não é válido.

setAsync(datetime, callback)

Define a data e hora de entrega de uma mensagem.

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

Parâmetros

datetime

Date

A data e hora futuras em que a mensagem deve ser enviada.

callback

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

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro, asyncResult, que é um Office.AsyncResult objeto. Quaisquer erros encontrados serão fornecidos na propriedade asyncResult.error.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.13 ]

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

Modo Outlook aplicável: Compose

Importante:

• Quando item.delayDeliveryTime.setAsync é utilizado para agendar a entrega de uma mensagem, o atraso é processado no servidor. Isto permite que a mensagem seja enviada mesmo que o cliente do Outlook não esteja em execução. No Outlook clássico no Windows, a mensagem não aparece na pasta Caixa de Saída , pelo que não poderá editar a mensagem ou cancelar a entrega após selecionar Enviar. Só poderá rever a mensagem a partir da pasta Itens Enviados . No Outlook na Web, no Mac e no novo Outlook no Windows, a mensagem é apresentada na pasta Rascunhos até à hora de entrega agendada. Enquanto estiver na pasta Rascunhos , poderá editar a mensagem antes de ser enviada. Para saber mais, consulte Gerir a data e hora de entrega de uma mensagem.

• O setAsync método não é suportado numa mensagem atualmente carregada com o loadItemByIdAsync método . Para obter mais informações, consulte Ativar o seu suplemento do Outlook em várias mensagens.

Erros:

• InvalidFormatError - O formato do objeto de dados especificado não é válido.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/delay-message-delivery.yaml

function setDeliveryDate(minutes) {
  // This snippet sets the delivery date and time of a message.
  const currentTime = new Date().getTime();
  const milliseconds = totalDelay * 60000;
  const timeDelay = new Date(currentTime + milliseconds);
  Office.context.mailbox.item.delayDeliveryTime.setAsync(timeDelay, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log(asyncResult.error.message);
      return;
    }

    if (minutes === 1440) {
      console.log(`Delayed delivery by an additional one day.`);
    } else {
      console.log(`Delayed delivery by an additional ${minutes} minutes.`);
    }
  });
}