Office.DelayDeliveryTime interface

Возвращает дату и время доставки сообщения.

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

Параметры

options: Office.AsyncContextOptions

Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.

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

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . Дата и время доставки сообщения возвращаются в свойстве asyncResult.value . Если дата доставки еще не задана для сообщения, 0 возвращается вместо него.

Возвращаемое значение

void

Параметры

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

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . Дата и время доставки сообщения возвращаются в свойстве asyncResult.value . Если дата доставки еще не задана для сообщения, 0 возвращается вместо него.

Возвращаемое значение

void

Примеры

// 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: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Параметры

datetime: Date

Дата и время отправки сообщения в будущем.

options: Office.AsyncContextOptions

Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.

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

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . Все обнаруженные ошибки будут указаны в свойстве asyncResult.error.

Возвращаемое значение

void

Важно! Если item.delayDeliveryTime.setAsync используется для планирования доставки сообщения, задержка обрабатывается на сервере. Это позволяет отправлять сообщение, даже если клиент Outlook не запущен. Однако из-за этого сообщение не отображается в папке Исходящие , поэтому вы не сможете изменить сообщение или отменить его доставку после нажатия кнопки Отправить. Вы сможете просмотреть mesasge из папки Отправленные только после отправки сообщения. Дополнительные сведения см. в статье Управление датой и временем доставки сообщения.

Ошибки:

InvalidFormatError — недопустимый формат указанного объекта данных.

Задает дату и время доставки сообщения.

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

Параметры

datetime: Date

Дата и время отправки сообщения в будущем.

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

Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром Office.AsyncResult , asyncResultкоторый является объектом . Все обнаруженные ошибки будут указаны в свойстве asyncResult.error.

Возвращаемое значение

void

Важно! Если item.delayDeliveryTime.setAsync используется для планирования доставки сообщения, задержка обрабатывается на сервере. Это позволяет отправлять сообщение, даже если клиент Outlook не запущен. Однако из-за этого сообщение не отображается в папке Исходящие , поэтому вы не сможете изменить сообщение или отменить его доставку после нажатия кнопки Отправить. Вы сможете просмотреть mesasge из папки Отправленные только после отправки сообщения. Дополнительные сведения см. в статье Управление датой и временем доставки сообщения.

Ошибки:

InvalidFormatError — недопустимый формат указанного объекта данных.

Примеры

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

Комментарии

Методы

Сведения о методе

getAsync(options, callback)

Параметры

Возвращаемое значение

Комментарии

getAsync(callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

setAsync(datetime, options, callback)

Параметры

Возвращаемое значение

Комментарии

setAsync(datetime, callback)

Параметры

Возвращаемое значение

Комментарии

Примеры

Обратная связь

Дополнительные ресурсы