Office.Time interface
Объект Time возвращается в качестве свойства start или end встречи в режиме создания.
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Используется
Методы
| get |
Получает время начала или окончания встречи. Дата и время предоставляются в качестве |
| get |
Получает время начала или окончания встречи. Дата и время предоставляются в качестве |
| set |
Задает время начала или окончания встречи.
Время необходимо указать в формате UTC. Правильное время в формате UTC можно получить с помощью метода Важно! В клиенте Windows этот метод нельзя использовать для обновления начала или окончания повторения. |
| set |
Задает время начала или окончания встречи.
Время необходимо указать в формате UTC. Правильное время в формате UTC можно получить с помощью метода Важно! В клиенте 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
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
getAsync(callback)
Получает время начала или окончания встречи.
Дата и время предоставляются в качестве Date объекта в свойстве asyncResult.value . Значение приводится в формате UTC. Время в формате UTC можно преобразовать в локальное клиентское convertToLocalClientTime время с помощью метода .
getAsync(callback: (asyncResult: Office.AsyncResult<Date>) => void): void;
Параметры
- callback
-
(asyncResult: Office.AsyncResult<Date>) => void
После завершения метода функция, переданная в параметре обратного вызова, вызывается с одним параметром типа Office.AsyncResult. Свойство value результата — объект Date .
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение элемента
Применимый режим Outlook: Compose
Примеры
// 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;
}
const time = result.value;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});
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
Литерал объекта, содержащий одно или несколько следующих свойств:- asyncContext: разработчики могут предоставить любой объект, к которому они хотят получить доступ в функции обратного вызова.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром типа Office.AsyncResult. Если не удается задать дату и время, свойство asyncResult.error будет содержать код ошибки.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose
Ошибки:
-
InvalidEndTime: время окончания встречи до начала встречи.
Примеры
// 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)
Задает время начала или окончания встречи.
setAsync Если метод вызывается для свойства start, end свойство будет изменено, чтобы сохранить длительность встречи, как было задано ранее. Если для свойства setAsync вызывается метод end, продолжительность встречи будет расширена до нового времени окончания.
Время необходимо указать в формате UTC. Правильное время в формате UTC можно получить с помощью метода convertToUtcClientTime.
Важно! В клиенте Windows этот метод нельзя использовать для обновления начала или окончания повторения.
setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Параметры
- dateTime
-
Date
Объект даты и времени в формате UTC.
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
Необязательный параметр. После завершения метода функция, переданная в callback параметре, вызывается с одним параметром типа Office.AsyncResult. Если не удается задать дату и время, свойство asyncResult.error будет содержать код ошибки.
Возвращаемое значение
void
Комментарии
Минимальный уровень разрешений: чтение и запись элемента
Применимый режим Outlook: Compose
Ошибки:
-
InvalidEndTime: время окончания встречи до начала встречи.