Тип ресурсов openTypeExtension (открытые расширения)

  • Статья

Пространство имен: microsoft.graph

Представляет открытые расширения (также известные как расширения открытого типа и ранее известные как расширения данных Office 365), параметр расширяемости, позволяющий напрямую добавлять нетипизированные свойства в ресурс в Microsoft Graph.

Любое открытое расширение, добавленное к ресурсу, отображается в свойстве навигации расширений. Каждое расширение имеет свойство extensionName , которое является единственным предопределенным, записываемым свойством для всех расширений, а также пользовательскими данными. Чтобы обеспечить уникальность имен расширений, можно использовать формат обратных DNS, который зависит от принадлежащего вам домена, например com.contoso.ContactInfo. Не используйте домен Майкрософт (com.microsoft или com.onmicrosoft) в имени расширения.

Производный от абстрактного типа расширения.

Открытые расширения поддерживаются в следующих ресурсах:

Примечание. * Из-за существующего ограничения службы делегаты не могут создавать открытые события, добавляемые расширениями, в общих календарях почтовых ящиков. Попытка сделать это приведет к ответу ErrorAccessDenied.

Дополнительные сведения о расширяемости Microsoft Graph, включая ограничения для открытых расширений, см. в разделе Добавление настраиваемых свойств к ресурсам с помощью расширений и Добавление настраиваемых данных для пользователей с помощью открытых расширений.

Специальные рекомендации для Outlook

Каждое открытое расширение в ресурсе Outlook (событие, сообщение или личный контакт) хранится в свойстве MAPI с именем. Создавая открытые расширения для Outlook, учитывайте, что именованные свойства MAPI в почтовом ящике пользователя — это ограниченный ресурс. Когда квота именованных свойств пользователя исчерпана, вы больше не сможете создать именованные свойства для этого пользователя. Это может привести к неожиданным действиям пользователей, для работы которых необходимы именованные свойства.

Руководствуйтесь приведенными ниже рекомендациями при создании открытых расширений в ресурсах Outlook.

  • Создайте минимум необходимых расширений. Большинству приложений должно потребоваться не более одного расширения. Расширения не имеют определенных свойств или структуры, поэтому в одном расширении можно хранить несколько значений.
  • Избегайте несогласованного именования расширений (например, на основании вводимых пользователями данных и т. д.). При каждом создании открытого расширения с новым именем, которое ранее не использовалось в почтовом ящике пользователя, создается новое свойство MAPI с именем. При удалении расширения именованное свойство не удаляется.

Использование открытых расширений (для ресурсов Outlook) или расширенных свойств

Открытые расширения — рекомендуемое решение для большинства сценариев, предполагающих хранение пользовательских данных и доступ к ним. Однако если вам нужно получить доступ к пользовательским данным для свойств MAPI Outlook, которые еще не предоставляются через метаданные Microsoft API Graph, можно использовать расширенные свойства и его REST API. Вы можете проверить, какие свойства предоставляются с помощью метаданных, на странице https://graph.microsoft.com/v1.0/$metadata.

Методы

Метод Возвращаемый тип Описание
Создание openTypeExtension(в существующем экземпляре ресурса) или новый объект todoTask, todoTaskListcontact, event, message, post, todoTask или todoTaskList , содержащий объект openTypeExtension. Создание объекта openTypeExtension в существующем или новом экземпляре ресурса.
Get openTypeExtension Чтение свойств и связей объекта openTypeExtension.
Update openTypeExtension Обновление объекта openTypeExtension.
Delete Нет Удаление объекта openTypeExtension.

Свойства

Свойство Тип Описание
extensionName String Уникальный текстовый идентификатор для модуля обработки данных открытого типа. Необязательный параметр.
id String Полный идентификатор, в котором сцеплены тип расширения и свойство extensionName. Только для чтения.

Идентификатор должен быть определен во время операции Create одним из следующих способов:
  • Явно определите свойство id в тексте запроса.
  • Определите свойство extensionName в тексте запроса, и Microsoft Graph автоматически присваивает то же значение свойству id .
    • В последующих обновлениях можно изменить значение свойства extensionName на значение, отличное от значения идентификатора .
    • В последующих обновлениях при указании только свойства id в тексте запроса свойство extensionName автоматически удаляется из открытого расширения.

Связи

Нет

Представление JSON

В следующем представлении JSON показан тип ресурса.

{
  "extensionName": "string",
  "id": "String (identifier)"
}

Связанные материалы