NotificationSubscription interface
구독은 이벤트 일치 기준과 해당 이벤트에 대해 구독 구독자에게 알림을 받는 방법을 정의합니다.
속성
| admin |
구독에 대한 관리 관리되는 설정입니다. 구독자가 그룹인 경우에만 적용됩니다. |
| channel | 구독에 의해 트리거된 알림을 배달하기 위한 채널입니다. |
| description | 구독에 대한 설명입니다. 일반적으로 구독을 ID하는 데 도움이 되는 필터 조건을 설명합니다. |
| diagnostics | 이 구독에 대한 진단입니다. |
| extended |
다양한 컨텍스트, 사용자/그룹 컨텍스트에 대한 자세한 설명과 같은 추가 속성 |
| filter | 구독에 대한 일치 조건입니다. ExpressionFilter |
| flags | 구독을 자세히 설명하는 읽기 전용 표시기입니다. |
| id | 구독 ID입니다. |
| last |
구독을 마지막으로 수정(또는 만든) 사용자입니다. |
| modified |
구독이 마지막으로 수정된 날짜입니다. 구독이 만들어진 이후로 업데이트되지 않은 경우 이 값은 구독이 만들어진 시기를 나타냅니다. |
| permissions | 사용자가 이 구독에 대해 가지고 있는 권한입니다. |
| scope | 구독과 일치하기 위해 에서 이벤트를 게시해야 하는 컨테이너입니다. 비어 있는 경우 scope 현재 호스트(일반적으로 계정 또는 프로젝트 컬렉션)입니다. 예를 들어 프로젝트 A로 범위가 지정된 구독은 프로젝트 B에서 게시된 이벤트에 대한 알림을 생성하지 않습니다. |
| status | 구독의 상태입니다. 일반적으로 구독을 사용할지 여부를 나타냅니다. |
| status |
구독의 상태 대한 자세한 정보를 제공하는 메시지입니다. |
| subscriber | 구독의 필터 조건과 일치하는 이벤트에 대한 알림을 받을 사용자 또는 그룹입니다. |
| url | 구독의 REST API URL입니다. |
| user |
구독에 대한 사용자 관리 설정입니다. 구독자가 그룹인 경우에만 적용됩니다. 일반적으로 호출하는 사용자가 그룹 구독에서 옵트인 또는 옵트아웃되는지 여부를 나타내는 데 사용됩니다. |
속성 세부 정보
adminSettings
구독에 대한 관리 관리되는 설정입니다. 구독자가 그룹인 경우에만 적용됩니다.
adminSettings: SubscriptionAdminSettings속성 값
channel
description
구독에 대한 설명입니다. 일반적으로 구독을 ID하는 데 도움이 되는 필터 조건을 설명합니다.
description: string속성 값
string
diagnostics
extendedProperties
다양한 컨텍스트, 사용자/그룹 컨텍스트에 대한 자세한 설명과 같은 추가 속성
extendedProperties: {[key: string]: string}속성 값
{[key: string]: string}
filter
flags
id
구독 ID입니다.
id: string속성 값
string
lastModifiedBy
modifiedDate
구독이 마지막으로 수정된 날짜입니다. 구독이 만들어진 이후로 업데이트되지 않은 경우 이 값은 구독이 만들어진 시기를 나타냅니다.
modifiedDate: Date속성 값
Date
permissions
scope
구독과 일치하기 위해 에서 이벤트를 게시해야 하는 컨테이너입니다. 비어 있는 경우 scope 현재 호스트(일반적으로 계정 또는 프로젝트 컬렉션)입니다. 예를 들어 프로젝트 A로 범위가 지정된 구독은 프로젝트 B에서 게시된 이벤트에 대한 알림을 생성하지 않습니다.
scope: SubscriptionScope속성 값
status
statusMessage
구독의 상태 대한 자세한 정보를 제공하는 메시지입니다.
statusMessage: string속성 값
string
subscriber
url
구독의 REST API URL입니다.
url: string속성 값
string
userSettings
구독에 대한 사용자 관리 설정입니다. 구독자가 그룹인 경우에만 적용됩니다. 일반적으로 호출하는 사용자가 그룹 구독에서 옵트인 또는 옵트아웃되는지 여부를 나타내는 데 사용됩니다.
userSettings: SubscriptionUserSettings