Office.DelayDeliveryTime interface
O DelayDeliveryTime
objeto permite que você gerencie a data e a hora de entrega atrasadas de uma mensagem.
Comentários
[ Conjunto de API: Caixa de correio 1.13 ]
Nível mínimo de permissão: item de leitura
Modo outlook aplicável: compose
Métodos
get |
Obtém a data e a hora da entrega de uma mensagem. |
get |
Obtém a data e a hora da entrega de uma mensagem. |
set |
Define a data e a hora da entrega de uma mensagem. |
set |
Define a data e a hora da entrega de uma mensagem. |
Detalhes do método
getAsync(options, callback)
Obtém a data e a hora da 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 desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.
- callback
-
(asyncResult: Office.AsyncResult<Date | 0>) => void
Opcional. Quando o método é concluído, a função passada no callback
parâmetro é chamada com um único parâmetro, , asyncResult
que é um Office.AsyncResult
objeto. A data e a hora da entrega de uma mensagem são retornadas na asyncResult.value
propriedade. Se uma data de entrega ainda não tiver sido definida em uma mensagem, 0
será retornada.
Retornos
void
Comentários
[ Conjunto de API: Caixa de correio 1.13 ]
Nível mínimo de permissão: item de leitura
Modo outlook aplicável: compose
getAsync(callback)
Obtém a data e a hora da 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 é concluído, a função passada no callback
parâmetro é chamada com um único parâmetro, , asyncResult
que é um Office.AsyncResult
objeto. A data e a hora da entrega de uma mensagem são retornadas na asyncResult.value
propriedade. Se uma data de entrega ainda não tiver sido definida em uma mensagem, 0
será retornada.
Retornos
void
Comentários
[ Conjunto de API: Caixa de correio 1.13 ]
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/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 a hora da entrega de uma mensagem.
setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parâmetros
- datetime
-
Date
A data e a 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 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, , 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/gravação
Modo outlook aplicável: compose
Importante: quando item.delayDeliveryTime.setAsync
é usado para agendar a entrega de uma mensagem, o atraso é processado no servidor. Isso permite que a mensagem seja enviada mesmo que o cliente do Outlook não esteja em execução. No entanto, devido a isso, a mensagem não aparece na pasta Outbox , portanto, você não poderá editar a mensagem ou cancelar sua entrega depois de selecionar Enviar. Você só poderá examinar o painel da pasta Itens Enviados depois que a mensagem for enviada. Para saber mais, confira Gerenciar a data e a hora da entrega de uma mensagem.
Erros:
InvalidFormatError
- O formato do objeto de dados especificado não é válido.
setAsync(datetime, callback)
Define a data e a hora da entrega de uma mensagem.
setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parâmetros
- datetime
-
Date
A data e a hora futuras em que a mensagem deve ser enviada.
- 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, , 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/gravação
Modo outlook aplicável: compose
Importante: quando item.delayDeliveryTime.setAsync
é usado para agendar a entrega de uma mensagem, o atraso é processado no servidor. Isso permite que a mensagem seja enviada mesmo que o cliente do Outlook não esteja em execução. No entanto, devido a isso, a mensagem não aparece na pasta Outbox , portanto, você não poderá editar a mensagem ou cancelar sua entrega depois de selecionar Enviar. Você só poderá examinar o painel da pasta Itens Enviados depois que a mensagem for enviada. Para saber mais, confira Gerenciar a data e a hora da entrega de uma mensagem.
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.`);
}
});
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de