Тип ресурса visualInfo
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Сложный тип для представления свойства visualElements в объекте действия .
Каждое действие пользователя будет отображаться на временной шкале в виде адаптивной карточки. Разработчикам приложений рекомендуется предоставить пользовательскую карточку, которая отражает суть действий, которые были в вашем приложении. Это возможно путем предоставления пользовательской карточки JSON в свойстве содержимого.
Помимо визуальных метаданных с адаптивной карточкой, приложение может указать метаданные содержимого — данные, которые используются для создания выводов о действиях пользователя, чтобы предложить новые действия для повторного взаимодействия в будущем. Это возможно с помощью свойства contentInfo действия для предоставления объекта JSON, который использует свойства schema.org для описания содержимого.
Если пользовательская карточка не указана, будет создана простая карточка с помощью свойств displayText и description. Пользовательские карточки рекомендуются для демонстрации лучшего содержимого из вашего приложения.
Свойства
Свойство | Тип | Описание |
---|---|---|
displayText | String | Обязательный. Краткое текстовое описание уникального действия пользователя (например, имя документа в случаях, когда действие относится к созданию документа) |
description | String | Необязательный параметр. Более длинное текстовое описание уникального действия пользователя (например, имя документа, первое предложение и/или метаданные) |
backgroundColor | String | Необязательный параметр. Цвет фона, используемый для отрисовки действия в пользовательском интерфейсе— цвет фирменной символики для источника действия приложения. Должен быть допустимым шестнадцатеричным цветом |
содержимое | Нетипизированный объект JSON | Необязательный параметр. Пользовательский фрагмент данных — объект JSON, используемый для предоставления пользовательского содержимого для отрисовки действия в пользовательском интерфейсе оболочки Windows. |
приписывание | imageInfo | Необязательный параметр. Объект JSON, используемый для представления значка, который представляет приложение, используемое для создания действия |
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"@data.type": "microsoft.graph.visualInfo",
"attribution": {
"@odata.type": "microsoft.graph.imageInfo",
"iconUrl": "String (URL)",
"alternateText": "String",
"addImageQuery": "boolean"
},
"description": "String",
"backgroundColor": "String",
"displayText": "String",
"content": {
"@data.type": "microsoft.graph.Json"
}
}