Compartir a través de

Office.DelayDeliveryTime interface

  • Referencia
Paquete:
outlook

El DelayDeliveryTime objeto permite administrar la fecha y hora de entrega retrasada de un mensaje.

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose

Métodos

getAsync(options, callback)

Obtiene la fecha y hora de entrega de un mensaje.
getAsync(callback)

Obtiene la fecha y hora de entrega de un mensaje.
setAsync(datetime, options, callback)

Establece la fecha y hora de entrega de un mensaje.
setAsync(datetime, callback)

Establece la fecha y hora de entrega de un mensaje.

Detalles del método

getAsync(options, callback)

Obtiene la fecha y hora de entrega de un mensaje.

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

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . La fecha y hora de entrega de un mensaje se devuelven en la asyncResult.value propiedad . Si aún no se ha establecido una fecha de entrega en un mensaje, 0 se devuelve en su lugar.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose

getAsync(callback)

Obtiene la fecha y hora de entrega de un mensaje.

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

Parámetros

callback

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . La fecha y hora de entrega de un mensaje se devuelven en la asyncResult.value propiedad . Si aún no se ha establecido una fecha de entrega en un mensaje, 0 se devuelve en su lugar.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose

Ejemplos

// 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)

Establece la fecha y hora de entrega de un mensaje.

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

Parámetros

datetime

Date

Fecha y hora futuras en que se debe enviar el mensaje.

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . Cualquier error que se detecte se proporcionará en la propiedad asyncResult.error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Compose

Importante: Cuando item.delayDeliveryTime.setAsync se usa para programar la entrega de un mensaje, el retraso se procesa en el servidor. Esto permite enviar el mensaje incluso si el cliente de Outlook no se está ejecutando. En Outlook clásico en Windows, el mensaje no aparece en la carpeta Bandeja de salida , por lo que no podrá editar el mensaje ni cancelar su entrega después de seleccionar Enviar. Solo podrá revisar el mensaje desde la carpeta Elementos enviados . En Outlook en la Web, en Mac y en la nueva Outlook en Windows, el mensaje aparece en la carpeta Borradores hasta el tiempo de entrega programado. Mientras esté en la carpeta Borradores , podrá editar el mensaje antes de enviarlo. Para más información, consulte Administración de la fecha y hora de entrega de un mensaje.

Errores:

  • InvalidFormatError - El formato del objeto de datos especificado no es válido.

setAsync(datetime, callback)

Establece la fecha y hora de entrega de un mensaje.

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

Parámetros

datetime

Date

Fecha y hora futuras en que se debe enviar el mensaje.

callback

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . Cualquier error que se detecte se proporcionará en la propiedad asyncResult.error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.13 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Compose

Importante: Cuando item.delayDeliveryTime.setAsync se usa para programar la entrega de un mensaje, el retraso se procesa en el servidor. Esto permite enviar el mensaje incluso si el cliente de Outlook no se está ejecutando. En Outlook clásico en Windows, el mensaje no aparece en la carpeta Bandeja de salida , por lo que no podrá editar el mensaje ni cancelar su entrega después de seleccionar Enviar. Solo podrá revisar el mensaje desde la carpeta Elementos enviados . En Outlook en la Web, en Mac y en la nueva Outlook en Windows, el mensaje aparece en la carpeta Borradores hasta el tiempo de entrega programado. Mientras esté en la carpeta Borradores , podrá editar el mensaje antes de enviarlo. Para más información, consulte Administración de la fecha y hora de entrega de un mensaje.

Errores:

  • InvalidFormatError - El formato del objeto de datos especificado no es válido.

Ejemplos

// 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.`);
    }
  });
}