Office.Time interface

Ссылка

Пакет:: outlook

Объект Time возвращается в качестве свойства start или end встречи в режиме создания.

Методы

getAsync(options, callback)	Получает время начала или окончания встречи. Дата и время предоставляются в качестве `Date` объекта в свойстве `asyncResult.value` . Значение приводится в формате UTC. Время в формате UTC можно преобразовать в локальное клиентское `convertToLocalClientTime` время с помощью метода .
getAsync(callback)	Получает время начала или окончания встречи. Дата и время предоставляются в качестве `Date` объекта в свойстве `asyncResult.value` . Значение приводится в формате UTC. Время в формате UTC можно преобразовать в локальное клиентское `convertToLocalClientTime` время с помощью метода .
setAsync(dateTime, options, callback)	Задает время начала или окончания встречи. `setAsync` Если метод вызывается для свойства start, `end` свойство будет изменено, чтобы сохранить длительность встречи, заданную ранее. Если для свойства `setAsync` вызывается метод `end`, продолжительность встречи будет расширена до нового времени окончания. Время необходимо указать в формате UTC. Правильное время в формате UTC можно получить с помощью метода `convertToUtcClientTime`. Важно! В клиенте Windows этот метод нельзя использовать для обновления начала или окончания повторения.
setAsync(dateTime, callback)	Задает время начала или окончания встречи. `setAsync` Если метод вызывается для свойства start, `end` свойство будет изменено, чтобы сохранить длительность встречи, заданную ранее. Если для свойства `setAsync` вызывается метод `end`, продолжительность встречи будет расширена до нового времени окончания. Время необходимо указать в формате UTC. Правильное время в формате UTC можно получить с помощью метода `convertToUtcClientTime`. Важно! В клиенте Windows этот метод нельзя использовать для обновления начала или окончания повторения.

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

getAsync(options, callback)

Получает время начала или окончания встречи.

Дата и время предоставляются в качестве Date объекта в свойстве asyncResult.value . Значение приводится в формате UTC. Время в формате UTC можно преобразовать в локальное клиентское convertToLocalClientTime время с помощью метода .

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

Параметры

options: Office.AsyncContextOptions

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

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

После завершения метода функция, переданная в callback параметре, вызывается с одним параметром типа Office.AsyncResult. Свойство value результата — объект Date .

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

void

getAsync(callback)

Получает время начала или окончания встречи.

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

Параметры

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

После завершения метода функция, переданная в параметре обратного вызова, вызывается с одним параметром типа Office.AsyncResult. Свойство value результата — объект Date .

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

void

Примеры

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

Задает время начала или окончания встречи.

setAsync Если метод вызывается для свойства start, end свойство будет изменено, чтобы сохранить длительность встречи, заданную ранее. Если для свойства setAsync вызывается метод end, продолжительность встречи будет расширена до нового времени окончания.

Время необходимо указать в формате UTC. Правильное время в формате UTC можно получить с помощью метода convertToUtcClientTime.

Важно! В клиенте Windows этот метод нельзя использовать для обновления начала или окончания повторения.

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

Параметры

dateTime: Date

Объект даты и времени в формате UTC.

options: Office.AsyncContextOptions

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

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

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

void

Примеры

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)

Задает время начала или окончания встречи.

Важно! В клиенте Windows этот метод нельзя использовать для обновления начала или окончания повторения.

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

Параметры

dateTime: Date

Объект даты и времени в формате UTC.

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

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

void

Office.Time interface

Комментарии

Методы

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

getAsync(options, callback)

Параметры

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

Комментарии

getAsync(callback)

Параметры

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

Комментарии

Примеры

setAsync(dateTime, options, callback)

Параметры

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

Комментарии

Примеры

setAsync(dateTime, callback)

Параметры

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

Комментарии

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

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