NotificationSubscriptionUpdateParameters interface
기존 구독을 업데이트하기 위한 매개 변수입니다. 구독은 일치하는 이벤트에 대한 조건과 해당 이벤트에 대해 구독 구독자에게 알림을 받는 방법을 정의합니다. 참고: 업데이트할 필드만 설정해야 합니다.
속성
| admin |
구독에 대한 관리자 관리 설정입니다. 구독자가 그룹인 구독에만 적용됩니다. |
| channel | 구독에 의해 트리거된 알림을 배달하기 위한 채널입니다. |
| description | 구독에 대한 설명이 업데이트되었습니다. 일반적으로 구독의 ID를 지정하는 데 도움이 되는 필터 조건을 설명합니다. |
| filter | 구독에 대한 일치 조건입니다. ExpressionFilter |
| scope | 새 구독과 일치하기 위해 이벤트를 게시해야 하는 컨테이너입니다. 지정하지 않으면 기본값은 현재 호스트(일반적으로 현재 계정 또는 프로젝트 컬렉션)입니다. 예를 들어 프로젝트 A로 범위가 지정된 구독은 프로젝트 B에서 게시된 이벤트에 대한 알림을 생성하지 않습니다. |
| status | 구독의 상태가 업데이트되었습니다. 일반적으로 구독을 사용하거나 사용하지 않도록 설정하는 데 사용됩니다. |
| status |
업데이트된 상태에 대한 자세한 정보를 제공하는 선택적 메시지입니다. |
| user |
구독에 대한 사용자 관리 설정입니다. 구독자가 그룹인 구독에만 적용됩니다. 일반적으로 그룹 구독에서 사용자를 옵트인하거나 옵트아웃하는 데 사용됩니다. |
속성 세부 정보
adminSettings
구독에 대한 관리자 관리 설정입니다. 구독자가 그룹인 구독에만 적용됩니다.
adminSettings: SubscriptionAdminSettings속성 값
channel
description
구독에 대한 설명이 업데이트되었습니다. 일반적으로 구독의 ID를 지정하는 데 도움이 되는 필터 조건을 설명합니다.
description: string속성 값
string
filter
scope
새 구독과 일치하기 위해 이벤트를 게시해야 하는 컨테이너입니다. 지정하지 않으면 기본값은 현재 호스트(일반적으로 현재 계정 또는 프로젝트 컬렉션)입니다. 예를 들어 프로젝트 A로 범위가 지정된 구독은 프로젝트 B에서 게시된 이벤트에 대한 알림을 생성하지 않습니다.
scope: SubscriptionScope속성 값
status
구독의 상태가 업데이트되었습니다. 일반적으로 구독을 사용하거나 사용하지 않도록 설정하는 데 사용됩니다.
status: SubscriptionStatus속성 값
statusMessage
업데이트된 상태에 대한 자세한 정보를 제공하는 선택적 메시지입니다.
statusMessage: string속성 값
string
userSettings
구독에 대한 사용자 관리 설정입니다. 구독자가 그룹인 구독에만 적용됩니다. 일반적으로 그룹 구독에서 사용자를 옵트인하거나 옵트아웃하는 데 사용됩니다.
userSettings: SubscriptionUserSettings