visualInfo 资源类型

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

用于表示活动对象中的 visualElements 属性的复杂类型。

每个用户活动将在时间线中显示为自适应卡片。 建议应用开发人员提供自定义卡片,以捕获应用中发生的活动的本质。 这可以通过在内容属性中提供自定义 JSON 卡实现。

除了具有自适应卡片的视觉元数据外,应用还可以指定内容元数据 - 用于对用户活动生成推理的数据,以便为将来的重新参与提供新活动。 通过使用活动的 contentInfo 属性提供 JSON 对象,该对象利用 schema.org 属性来描述内容,可以实现此目的。

如果未提供自定义卡,将使用 displayText 和 description 属性生成简单的卡。 建议使用自定义卡片来展示应用中的最佳内容。

属性

属性 类型 说明
displayText String 必填。 用户唯一活动的简短文本说明 (例如,在活动引用文档创建的情况下的文档名称)
说明 String 可选。 用户唯一活动的较长文本说明 (示例:文档名称、第一句和/或元数据)
backgroundColor String 可选。 用于在 UI 中呈现活动的背景色 - 活动的应用程序源的品牌颜色。 必须是有效的十六进制颜色
content 非类型化 JSON 对象 可选。 自定义数据片段 - 用于提供自定义内容以在 Windows Shell UI 中呈现活动的 JSON 对象
归 因 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"
    }
}