Canal Eventarc.
Firma:
export declare class Channel
Propiedades
| Propiedad | Modificadores | Tipo | Descripción |
|---|---|---|---|
| tipos de eventos permitidos | cadena[] | Lista de tipos de eventos permitidos por este canal para su publicación. Se ignoran otros tipos de eventos. | |
| eventarco | Eventarc | La instancia del servicio Eventarc asociada con el Channel actual. | |
| nombre | cadena | El nombre del canal tal como se proporcionó durante la creación del canal. Si no se especificó, se devuelve el nombre del canal predeterminado ('locations/us-central1/channels/firebase'). |
Métodos
| Método | Modificadores | Descripción |
|---|---|---|
| publicar (eventos) | Publica eventos proporcionados en este canal. Si el canal se creó con allowedEventTypes y el tipo de evento no está en esa lista, el evento se ignora. |
Canal.allowedEventTypes
Lista de tipos de eventos permitidos por este canal para su publicación. Se ignoran otros tipos de eventos.
Firma:
readonly allowedEventTypes?: string[];
Canal.eventarc
La instancia del servicio Eventarc asociada con el Channel actual. .
Firma:
get eventarc(): Eventarc;
Ejemplo
var app = channel.eventarc;
Nombre del Canal
El nombre del canal tal como se proporcionó durante la creación del canal. Si no se especificó, se devuelve el nombre del canal predeterminado ('locations/us-central1/channels/firebase').
Firma:
get name(): string;
Canal.publicar()
Publica eventos proporcionados en este canal. Si el canal se creó con allowedEventTypes y el tipo de evento no está en esa lista, el evento se ignora.
Firma:
publish(events: CloudEvent | CloudEvent[]): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| eventos | Evento en la nube | evento en la nube [] | CloudEvent para publicar en el canal. |
Devoluciones:
Promesa<nulo>