Тип ресурса уведомления (не рекомендуется)
Пространство имен: microsoft.graph
Важно!
API уведомлений Microsoft Graph не рекомендуется и прекратит возвращать данные к концу января 2022 г. Дополнительные сведения см. в Центрах уведомлений Microsoft Azure и в этой записи блога.
Представляет уведомление, опубликованное сервером приложений, предназначенное для указанного пользователя. Уведомление хранится в Microsoft Graph и распространяется на разные конечные точки устройства, принадлежащие пользователю.
Уведомление может быть полезными данными визуального уведомления, которые могут интерпретироваться операционной системой (платформы Windows, Android и iOS). Это также могут быть полезные данные (rawContent), которые доставляются и обрабатываются клиентами приложений (включая веб-сайт), которые затем определяют соответствующий пользовательский интерфейс на каждом устройстве. Обычно это пользовательский интерфейс визуального уведомления, созданный локально, который соответствует содержимому в исходных полезных данных.
Когда пользователь работает с визуальным уведомлением, клиент приложения может затем использовать пакет SDK для уведомлений на стороне клиента для обновления состояния соответствующего веб-канала уведомлений в Microsoft Graph, например, помечая уведомление как отклоненное. Затем обновление будет распространено на все остальные конечные точки клиента приложения, и клиенты обработают изменение соответствующим образом, например путем закрытия уведомления, чтобы предотвратить появление пользователем избыточной информации. Клиенты приложений могут получить доступ к тому же ресурсу уведомлений позже до истечения срока его действия (даже после того, как он помечается как отклоненный), как журнал уведомлений, через пакет SDK для уведомлений.
Примечание.
Обновления состояния уведомлений, такие как чтение или отклонение, не будут передаваться в веб-конечные точки. Это связано с тем, что при отправке веб-уведомлений в различных браузерах пользователю должны отображаться визуальные всплывающие уведомления. Так как изменения состояния не имеют соответствующего визуального содержимого, они будут использоваться только для уведомлений, предназначенных для платформ Windows, iOS или Android.
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Create и отправка уведомления (не рекомендуется) | Уведомления | Create и отправить уведомление. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| targetHostName | String | Представляет имя узла приложения, которому вызывающая служба хочет опубликовать уведомление, для данного пользователя. При выборе целевых веб-конечных точек (см . targetPolicy.platformTypes) убедитесь, что targetHostName совпадает с именем, используемым при создании подписки на стороне клиента в свойстве JSON приложения. |
| appNotificationId | String | Уникальный идентификатор, заданный сервером приложений уведомления, который используется для идентификации и назначения отдельного уведомления. |
| Groupname | String | Имя группы, к которой принадлежит это уведомление. Он устанавливается разработчиком для группировки уведомлений. |
| targetPolicy | targetPolicyEndpoints | Объект целевой политики обрабатывает политику доставки уведомлений для типов конечных точек, которые должны быть целевыми (Windows, iOS, Android и WebPush) для данного пользователя. |
| payload | полезные типы | Это содержимое данных необработанного или визуального уведомления пользователя, которое будет доставлено и использовано клиентом приложения, получающим это уведомление. |
| displayTimeToLive | Int32 | Задает продолжительное (в секундах) содержимое этого уведомления в средстве просмотра уведомлений каждой платформы. Например, при доставке уведомления на устройство Windows значение этого свойства передается в ToastNotification.ExpirationTime, который определяет, как долго всплывающее уведомление остается в центре уведомлений Windows пользователя. |
| expirationDateTime | DateTimeOffset | Задает дату и время окончания срока действия уведомления пользователя в формате ISO 8601 в формате UTC (например, полночь в формате UTC 1 января 2019 г. будет выглядеть следующим образом: '2019-01-01T00:00:00Z'). По истечении времени уведомление полностью удаляется из хранилища веб-канала уведомлений Microsoft Graph и больше не входит в журнал уведомлений. Максимальное значение — 30 дней. |
| priority | string | Указывает приоритет необработанного уведомления пользователя. По умолчанию визуальные уведомления отправляются с высоким приоритетом. Допустимые значения: None, High и Low. |
| 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"}
}