NotificationSubscriptionCreateParameters interface
Parámetros para crear una nueva suscripción. Una suscripción define criterios para los eventos coincidentes y cómo se debe notificar al suscriptor de la suscripción sobre esos eventos.
Propiedades
| channel | Canal para entregar notificaciones desencadenadas por la nueva suscripción. |
| description | Breve descripción de la nueva suscripción. Normalmente se describen los criterios de filtro que ayudan a identificar la suscripción. |
| filter | Criterios de coincidencia para la nueva suscripción. ExpressionFilter |
| scope | Contenedor en el que se deben publicar eventos para que coincidan con la nueva suscripción. Si no se especifica, el valor predeterminado es el host actual (normalmente una cuenta o colección de proyectos). Por ejemplo, una suscripción cuyo ámbito es el proyecto A no generará notificaciones para eventos publicados desde el proyecto B. |
| subscriber | Usuario o grupo que recibirá notificaciones de eventos que coincidan con los criterios de filtro de la suscripción. Si no se especifica, el valor predeterminado es el usuario que realiza la llamada. |
Detalles de las propiedades
channel
Canal para entregar notificaciones desencadenadas por la nueva suscripción.
channel: ISubscriptionChannel
Valor de propiedad
description
Breve descripción de la nueva suscripción. Normalmente se describen los criterios de filtro que ayudan a identificar la suscripción.
description: string
Valor de propiedad
string
filter
Criterios de coincidencia para la nueva suscripción. ExpressionFilter
filter: ISubscriptionFilter
Valor de propiedad
scope
Contenedor en el que se deben publicar eventos para que coincidan con la nueva suscripción. Si no se especifica, el valor predeterminado es el host actual (normalmente una cuenta o colección de proyectos). Por ejemplo, una suscripción cuyo ámbito es el proyecto A no generará notificaciones para eventos publicados desde el proyecto B.
scope: SubscriptionScope
Valor de propiedad
subscriber
Usuario o grupo que recibirá notificaciones de eventos que coincidan con los criterios de filtro de la suscripción. Si no se especifica, el valor predeterminado es el usuario que realiza la llamada.
subscriber: IdentityRef