NotificationSubscriptionUpdateParameters interface
Параметры для обновления существующей подписки. Подписка определяет критерии сопоставления событий и уведомления подписчика подписки об этих событиях. Примечание. Необходимо задать только обновляемые поля.
Свойства
| admin |
Параметры, управляемые администратором для подписки. Применяется только к подпискам, в которых подписчик является группой. |
| channel | Канал для доставки уведомлений, активированных подпиской. |
| description | Обновлено описание подписки. Обычно описывает критерии фильтрации, помогающие удостоверению подписки. |
| filter | Критерии соответствия для подписки. ExpressionFilter |
| scope | Контейнер, в котором события должны быть опубликованы для сопоставления новой подпиской. Если он не указан, по умолчанию используется текущий узел (обычно текущая учетная запись или коллекция проектов). Например, подписка, ограниченная проектом A, не будет создавать уведомления о событиях, опубликованных из проекта B. |
| status | Обновлено состояние подписки. Обычно используется для включения или отключения подписки. |
| status |
Необязательное сообщение, которое содержит дополнительные сведения об обновленном состоянии. |
| user |
Параметры, управляемые пользователем для подписки. Применяется только к подпискам, в которых подписчик является группой. Обычно используется для согласия или отказа пользователя от подписки на группу. |
Сведения о свойстве
adminSettings
Параметры, управляемые администратором для подписки. Применяется только к подпискам, в которых подписчик является группой.
adminSettings: SubscriptionAdminSettings
Значение свойства
channel
Канал для доставки уведомлений, активированных подпиской.
channel: ISubscriptionChannel
Значение свойства
description
Обновлено описание подписки. Обычно описывает критерии фильтрации, помогающие удостоверению подписки.
description: string
Значение свойства
string
filter
Критерии соответствия для подписки. ExpressionFilter
filter: ISubscriptionFilter
Значение свойства
scope
Контейнер, в котором события должны быть опубликованы для сопоставления новой подпиской. Если он не указан, по умолчанию используется текущий узел (обычно текущая учетная запись или коллекция проектов). Например, подписка, ограниченная проектом A, не будет создавать уведомления о событиях, опубликованных из проекта B.
scope: SubscriptionScope
Значение свойства
status
Обновлено состояние подписки. Обычно используется для включения или отключения подписки.
status: SubscriptionStatus
Значение свойства
statusMessage
Необязательное сообщение, которое содержит дополнительные сведения об обновленном состоянии.
statusMessage: string
Значение свойства
string
userSettings
Параметры, управляемые пользователем для подписки. Применяется только к подпискам, в которых подписчик является группой. Обычно используется для согласия или отказа пользователя от подписки на группу.
userSettings: SubscriptionUserSettings