Тип ресурса calendar
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет контейнер для ресурсов event. Это может быть календарь для пользователя или стандартный календарь для группы Microsoft 365.
Примечание. Существует несколько незначительных различий в способе взаимодействия с календарями пользователей и календарями групп:
- В ресурсе calendarGroup можно упорядочить только календари пользователей.
- Outlook автоматически принимает все приглашения на собрания от имени группы. Вы можете принимать, предварительно принимать или отклонять приглашения на собрания только для пользовательских календарей.
- Outlook не поддерживает напоминания о событиях группы. Напоминание можно отложить или отключить только для календарей пользователя.
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Список | Коллекция calendar | Получение всех пользовательских календарей или календарей из стандартной либо другой указанной группы календарей. |
| Создание | calendar | Создание календаря для пользователя в стандартной либо другой указанной группе календарей. |
| Получение | calendar | Получение свойств и связей объекта calendar. Это может быть календарь для пользователя или стандартный календарь для группы Microsoft 365. |
| Обновление | calendar | Обновление свойств объекта calendar. Это может быть календарь для пользователя или стандартный календарь для группы Microsoft 365. |
| удаление; | Нет | Удаление объекта calendar. |
| Удалить без возможности восстановления | Нет | Окончательно удалите папку календаря и удалите ее из почтового ящика. |
| Список представлений календаря | Коллекция event | Получение в представлении календаря повторений, исключений и отдельных экземпляров событий за определенный диапазон времени, указанных в основном календаре пользователя (../me/calendarView) или в другом заданном календаре. |
| Список событий | Коллекция event | Получение списка событий в календаре. В этом списке указаны единичные собрания и главные собрания в соответствующих сериях. |
| Создание события | event | Создание события в стандартном или указанном календаре. |
| Получение сведений о доступности | Коллекция scheduleInformation | Получение сведений о доступности коллекции пользователей, списков рассылки или ресурсов для определенного периода времени. |
| Поиск времени для собрания | meetingTimeSuggestionsResult | Предложение времени проведения собрания и местоположения с учетом доступности организатора и участников, а также ограничений по местоположению или времени. |
| Создание однозначного свойства | calendar | Создание одного или нескольких расширенных свойств с одним значением в новом или существующем календаре. |
| Получение однозначного свойства | calendar | Получение календарей, которые содержат расширенное свойство с одним значением, при помощи $expand или $filter. |
| Создание свойства с несколькими значениями | calendar | Создание одного или нескольких расширенных свойств с несколькими значениями в новом или существующем календаре. |
| Получение свойства с несколькими значениями | calendar | Получение календаря, который содержит расширенное свойство с несколькими значениями, при помощи $expand. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| allowedOnlineMeetingProviders | Коллекция onlineMeetingProviderType | Представляет поставщиков служб собраний по сети, которых можно использовать для создания собраний в этом календаре. Возможные значения: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness. |
| calendarGroupId | Строка | Объект calendarGroup для создания календаря. Если пользователь никогда явно не устанавливал группу для календаря, это свойство имеет значение NULL. |
| canEdit | Boolean | Значение true, если пользователь может вносить изменения в календарь, в противном случае — значение false. Это свойство имеет значение true для пользователя, создавшего календарь. Это свойство также имеет значение true для пользователей, которые совместно используют календарь и имеют доступ на запись через клиент Outlook или соответствующий ресурс calendarPermission. Только для чтения. |
| canShare | Boolean | Значение true, если у пользователя есть разрешение на совместное использование календаря, в противном случае — значение false. Только пользователь, создавший календарь, может предоставлять общий доступ к нему. Только для чтения. |
| canViewPrivateItems | Boolean | Значение true, если пользователь может читать элементы календаря, которые были помечены как частные, в противном случае — значение false. Это свойство задается через клиент Outlook или соответствующий ресурс calendarPermission. Только для чтения. |
| changeKey | String | Указывает версию объекта calendar. При каждом изменении календаря изменяется и changeKey. Благодаря этому Exchange может применять изменения к правильной версии объекта. Только для чтения. |
| color | calendarColor | Задает цветовую тему, отличающую этот календарь от других календарей в пользовательском интерфейсе. Возможные значения: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightRed, maxColor. |
| defaultOnlineMeetingProvider | onlineMeetingProviderType | Стандартный поставщик для собраний по сети, отправленных из этого календаря. Возможные значения: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness. |
| hexColor | String | Цвет календаря, представленный кодом из трех шестнадцатеричных значений в диапазоне от 00 до FF, которые обозначают красный, зеленый и синий компоненты цвета в цветовом пространстве RGB. Если пользователь не задал цвет календаря явным образом, это свойство будет пустым. |
| id | String | Уникальный идентификатор календаря. Только для чтения. |
| isDefaultCalendar | Boolean | Значение true, если это стандартный календарь, где новые события создаются по умолчанию. В противном случае — значение false. |
| isRemovable | Логический | Указывает, можно ли удалить этот календарь из почтового ящика пользователя. |
| IsShared | Boolean | Значение true, если пользователь поделился календарем с другими пользователями. В противном случае используется значение false. Только пользователь, создавший календарь, может им поделиться, поэтому свойства isShared и isSharedWithMe не могут иметь значения true для одного пользователя. Это свойство задается в том случае, если общий доступ предоставляется в клиенте Outlook; его можно сбросить, когда общий доступ отменяется через клиент или соответствующий ресурс calendarPermission. Только для чтения. |
| isSharedWithMe | Boolean | Значение true, если пользователю предоставлен общий доступ к этому календарю. В противном случае используется значение false. Для календаря владельца этому свойству всегда присвоено значение false. Это свойство задается в том случае, если общий доступ предоставляется в клиенте Outlook; его можно сбросить, когда общий доступ отменяется через клиент или соответствующий ресурс calendarPermission. Только для чтения. |
| isTallyingResponses | Логический | Указывает, поддерживает ли этот пользовательский календарь отслеживание ответов на приглашения на собрания. Только приглашения на собрания, отправленные из основных календарей пользователей, поддерживают отслеживание ответов на приглашения на собрания. |
| name | String | Имя календаря. |
| owner | emailAddress | Если это свойство задано, оно указывает на пользователя, создавшего или добавившего календарь. В календаре, созданном или добавленном пользователем, свойство owner установлено для этого пользователя. В календаре, который используется совместно с пользователем, свойство owner установлено для лица, предоставившего пользователю общий доступ к этому календарю. Только для чтения. |
Связи
| Связь | Тип | Описание |
|---|---|---|
| calendarPermissions | Коллекция calendarPermission | Разрешения пользователей, которым предоставлен доступ к календарю. |
| calendarView | Коллекция event | Представление календаря. Свойство навигации. Только для чтения. |
| events | Коллекция event | События в календаре. Свойство навигации. Только для чтения. |
| multiValueExtendedProperties | Коллекция multiValueLegacyExtendedProperty | Коллекция расширенных свойств с несколькими значениями, определенных для календаря. Только для чтения. Допускается значение null. |
| singleValueExtendedProperties | Коллекция singleValueLegacyExtendedProperty | Коллекция расширенных свойств с одним значением, определенных для календаря. Только для чтения. Допускается значение null. |
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"allowedOnlineMeetingProviders": ["string"],
"canEdit": "boolean",
"canShare": "boolean",
"canViewPrivateItems": "boolean",
"changeKey": "string",
"color": "String",
"defaultOnlineMeetingProvider": "string",
"hexColor": "String",
"id": "string (identifier)",
"isDefaultCalendar": "boolean",
"isRemovable": "boolean",
"isShared": "boolean",
"isSharedWithMe": "boolean",
"isTallyingResponses": "boolean",
"name": "string",
"owner": {"@odata.type": "microsoft.graph.emailAddress"}
}