Поделиться через

Office.AppointmentForm interface

Пакет:
outlook

Объект AppointmentForm используется для доступа к выбранной встрече.

Комментарии

Минимальный уровень разрешений: ограниченный

Применимый режим Outlook: Compose или чтение

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-new-appointment.yaml

const start = new Date();
const end = new Date();
end.setHours(start.getHours() + 1);

// The async version is only available starting with requirement set 1.9,
// and provides a callback when the new appointment form has been created.
Office.context.mailbox.displayNewAppointmentFormAsync(
  {
    requiredAttendees: ["bob@contoso.com"],
    optionalAttendees: ["sam@contoso.com"],
    start: start,
    end: end,
    location: "Home",
    subject: "meeting",
    resources: ["projector@contoso.com"],
    body: "Hello World!"
  },
  function(asyncResult) {
    console.log(JSON.stringify(asyncResult));
  }
);

Свойства

body

Получает объект, предоставляющий методы для работы с основным текстом элемента.
end

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

Свойство end представлено в виде значения даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования end значения свойства в локальные значения даты и времени клиента.

Режим чтения

Свойство end возвращает объект Date.

Режим создания

Свойство end возвращает объект Time.

Если вы задаете время окончания с помощью метода Time.setAsync, необходимо использовать метод convertToUtcClientTime для преобразования местного времени на клиенте в формат UTC для сервера.
location

Получает или задает место встречи.

Режим чтения

Свойство location возвращает строку, содержащую сведения о месте встречи.

Режим создания

Свойство location возвращает объект Location, предоставляющий методы, которые используются для получения и задания места встречи.
optionalAttendees

Предоставляет доступ к необязательным участникам события. Тип объекта и уровень доступа зависят от режима текущего элемента.

Режим чтения

Свойство optionalAttendees возвращает массив, содержащий объект EmailAddressDetails для каждого необязательного участника собрания. Ограничения на размер коллекции:

  • Веб-браузер, новый пользовательский интерфейс Mac, Android: нет ограничений

  • Windows (новая и классическая версия): 500 членов

  • Windows (классическая версия , начиная с версии 2511 (сборка 19426.20000)): 1000 элементов

  • Классический пользовательский интерфейс Mac: 100 элементов

Режим создания

Свойство optionalAttendees возвращает объект Recipients, который предоставляет методы для получения или обновления необязательных участников собрания. Однако в зависимости от клиента или платформы (например, Windows, Mac и т. д.) могут применяться ограничения на количество получателей, которые можно получить или обновить. Дополнительные сведения см. в объекте Recipients .
requiredAttendees

Предоставляет доступ к обязательным участникам события. Тип объекта и уровень доступа зависят от режима текущего элемента.

Режим чтения

Свойство requiredAttendees возвращает массив, содержащий объект EmailAddressDetails для каждого обязательного участника собрания. Ограничения на размер коллекции:

  • Веб-браузер, новый пользовательский интерфейс Mac, Android: нет ограничений

  • Windows: 500 членов

  • Windows (классическая версия , начиная с версии 2511 (сборка 19426.20000)): 1000 элементов

  • Классический пользовательский интерфейс Mac: 100 элементов

Режим создания

Свойство requiredAttendees возвращает объект Recipients, предоставляющий методы, с помощью которых можно получить или обновить сведения об обязательных участниках собрания. Однако в зависимости от клиента или платформы (например, Windows, Mac и т. д.) могут применяться ограничения на количество получателей, которые можно получить или обновить. Дополнительные сведения см. в объекте Recipients .
resources

Предоставляет доступ к ресурсам события. Возвращает массив строк, содержащий ресурсы, необходимые для встречи.
start

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

Свойство start представлено в виде значения даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования значения в локальные дату и время клиента.

Режим чтения

Свойство start возвращает объект Date.

Режим создания

Свойство start возвращает объект Time.

Если вы задаете время начала с помощью метода Time.setAsync, необходимо использовать метод convertToUtcClientTime для преобразования местного времени на клиенте в формат UTC для сервера.
subject

Получает или задает описание, которое отображается в поле темы элемента.

Свойство subject получает или задает всю тему элемента для отправки с почтового сервера.

Режим чтения

Свойство subject возвращает строку. Используйте свойство , normalizedSubject чтобы получить субъект без всех начальных префиксов, таких как RE: и FW:.

Режим создания

Свойство subject возвращает объект Subject, который предоставляет методы для получения и задания темы.

Сведения о свойстве

body

Получает объект, предоставляющий методы для работы с основным текстом элемента.

body: Body | string;

Значение свойства

Office.Body | string

Комментарии

[ Набор API: Почтовый ящик 1.1 ]

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

end

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

Свойство end представлено в виде значения даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования end значения свойства в локальные значения даты и времени клиента.

Режим чтения

Свойство end возвращает объект Date.

Режим создания

Свойство end возвращает объект Time.

Если вы задаете время окончания с помощью метода Time.setAsync, необходимо использовать метод convertToUtcClientTime для преобразования местного времени на клиенте в формат UTC для сервера.

end: Time | Date;

Значение свойства

Office.Time | Date

Комментарии

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

location

Получает или задает место встречи.

Режим чтения

Свойство location возвращает строку, содержащую сведения о месте встречи.

Режим создания

Свойство location возвращает объект Location, предоставляющий методы, которые используются для получения и задания места встречи.

location: Location | string;

Значение свойства

Office.Location | string

Комментарии

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

optionalAttendees

Предоставляет доступ к необязательным участникам события. Тип объекта и уровень доступа зависят от режима текущего элемента.

Режим чтения

Свойство optionalAttendees возвращает массив, содержащий объект EmailAddressDetails для каждого необязательного участника собрания. Ограничения на размер коллекции:

  • Веб-браузер, новый пользовательский интерфейс Mac, Android: нет ограничений

  • Windows (новая и классическая версия): 500 членов

  • Windows (классическая версия , начиная с версии 2511 (сборка 19426.20000)): 1000 элементов

  • Классический пользовательский интерфейс Mac: 100 элементов

Режим создания

Свойство optionalAttendees возвращает объект Recipients, который предоставляет методы для получения или обновления необязательных участников собрания. Однако в зависимости от клиента или платформы (например, Windows, Mac и т. д.) могут применяться ограничения на количество получателей, которые можно получить или обновить. Дополнительные сведения см. в объекте Recipients .

optionalAttendees: Recipients[] | EmailAddressDetails[];

Значение свойства

Office.Recipients[] | Office.EmailAddressDetails[]

Комментарии

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

requiredAttendees

Предоставляет доступ к обязательным участникам события. Тип объекта и уровень доступа зависят от режима текущего элемента.

Режим чтения

Свойство requiredAttendees возвращает массив, содержащий объект EmailAddressDetails для каждого обязательного участника собрания. Ограничения на размер коллекции:

  • Веб-браузер, новый пользовательский интерфейс Mac, Android: нет ограничений

  • Windows: 500 членов

  • Windows (классическая версия , начиная с версии 2511 (сборка 19426.20000)): 1000 элементов

  • Классический пользовательский интерфейс Mac: 100 элементов

Режим создания

Свойство requiredAttendees возвращает объект Recipients, предоставляющий методы, с помощью которых можно получить или обновить сведения об обязательных участниках собрания. Однако в зависимости от клиента или платформы (например, Windows, Mac и т. д.) могут применяться ограничения на количество получателей, которые можно получить или обновить. Дополнительные сведения см. в объекте Recipients .

requiredAttendees: Recipients[] | EmailAddressDetails[];

Значение свойства

Office.Recipients[] | Office.EmailAddressDetails[]

Комментарии

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

resources

Предоставляет доступ к ресурсам события. Возвращает массив строк, содержащий ресурсы, необходимые для встречи.

resources: string[];

Значение свойства

string[]

Комментарии

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

start

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

Свойство start представлено в виде значения даты и времени в формате UTC. Метод можно использовать для convertToLocalClientTime преобразования значения в локальные дату и время клиента.

Режим чтения

Свойство start возвращает объект Date.

Режим создания

Свойство start возвращает объект Time.

Если вы задаете время начала с помощью метода Time.setAsync, необходимо использовать метод convertToUtcClientTime для преобразования местного времени на клиенте в формат UTC для сервера.

start: Time | Date;

Значение свойства

Office.Time | Date

Комментарии

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение

subject

Получает или задает описание, которое отображается в поле темы элемента.

Свойство subject получает или задает всю тему элемента для отправки с почтового сервера.

Режим чтения

Свойство subject возвращает строку. Используйте свойство , normalizedSubject чтобы получить субъект без всех начальных префиксов, таких как RE: и FW:.

Режим создания

Свойство subject возвращает объект Subject, который предоставляет методы для получения и задания темы.

subject: Subject | string;

Значение свойства

Office.Subject | string

Комментарии

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: Compose или чтение