通知资源类型 (已弃用)
命名空间:microsoft.graph
重要
Microsoft Graph 通知 API 已弃用,将在 2022 年 1 月底停止返回数据。 有关其他通知体验,请参阅 Microsoft Azure 通知中心,并查看此博客文章了解详细信息。
表示由面向指定用户的应用服务器发布的通知。 通知存储在 Microsoft Graph 中,并分发到用户拥有的不同设备终结点。
通知可以是可由操作系统 (Windows、Android 和 iOS 平台) 解释的视觉通知有效负载。 它也可以是 (rawContent) 的数据有效负载, (应用客户端(包括 Web) ),然后确定每个设备上的相应用户体验。 这通常是在本地生成的视觉通知 UI,对应于原始数据有效负载中的内容。
当用户对视觉通知执行操作时,应用客户端随后可以使用客户端通知 SDK 更新 Microsoft Graph 中相应通知源的状态,例如,通过将通知标记为已消除。 然后,更新将分发到所有其他应用客户端终结点,客户端相应地处理更改,例如,通过关闭通知来防止用户看到冗余信息。 即使通过通知 SDK 将其标记为已消除) 通知历史记录,应用客户端也可在 (过期之前访问同一 通知资源。
注意
通知状态更新(如已读或已消除)不会扇出到 Web 终结点。 这是因为跨各种浏览器的 Web 推送需要向用户显示可视 Toast 通知。 由于状态更改没有相应的视觉内容,因此仅针对面向 Windows、iOS 或 Android 平台的通知将其扇出。
方法
方法 | 返回类型 | 说明 |
---|---|---|
(弃用) Create并发送通知 | 通知 | Create并发送通知。 |
属性
属性 | 类型 | 说明 |
---|---|---|
targetHostName | String | 表示给定用户的调用服务要向其发布通知的应用的主机名。 如果面向 Web 终结点 (看到 targetPolicy.platformTypes) ,请确保 targetHostName 与在应用程序 JSON 属性的客户端上创建订阅时使用的名称相同。 |
appNotificationId | String | 由应用服务器设置的通知的唯一 ID,用于标识和定位单个通知。 |
groupName | String | 此通知所属的组的名称。 它由开发人员设置,用于将通知分组在一起。 |
targetPolicy | targetPolicyEndpoints | 目标策略对象处理应针对给定用户的 windows、iOS、Android 和 WebPush) (终结点类型的通知传递策略。 |
payload | payloadTypes | 这是原始或可视用户通知的数据内容,该通知将传递到接收此通知的应用客户端并由其使用。 |
displayTimeToLive | Int32 | 设置此通知内容在每个平台的通知查看器中保留) (的时间(以秒为单位)。 例如,当通知传递到 Windows 设备时,此属性的值将传递给 ToastNotification.ExpirationTime,这决定了 Toast 通知在用户的 Windows 操作中心中的保留时间。 |
expirationDateTime | DateTimeOffset | 使用 ISO 8601 格式设置用户通知的 UTC 到期日期和时间 (例如,2019 年 1 月 1 日午夜 UTC 如下所示: '2019-01-01T00:00:00Z' ) 。 时间结束后,通知将完全从 Microsoft Graph 通知源存储中删除,并且不再是通知历史记录的一部分。 最大值为 30 天。 |
priority | string | 指示原始用户通知的优先级。 默认情况下,视觉通知以高优先级发送。 有效值为 None 、High 和 Low 。 |
fallbackPolicy | fallbackpolicy | 可选的回退策略对象仅处理 iOS 终结点的通知回退策略,设计为用于由于平台特定限制 (例如节电模式) ,可能无法传递到设备的高优先级原始通知。 |
关系
无。
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"targetHostName": "String",
"appNotificationId": "String (identifier)",
"groupName": "String",
"targetPolicy": {"@odata.type": "microsoft.graph.targetPolicyEndpoints"},
"payload": {"@odata.type": "microsoft.graph.payloadTypes"},
"displayTimeToLive": 1024,
"expirationDateTime": "String (timestamp)",
"priority": "string",
"fallbackPolicy": {"@odata.type": "microsoft.graph.fallbackpolicy"}
}