Canal de Eventarc.
Firma:
export declare class Channel
Propiedades
| Propiedad | Teclas modificadoras | Tipo | Descripción |
|---|---|---|---|
| allowedEventTypes | string[] | Es una lista de los tipos de eventos que permite su publicación este canal. Se ignoran otros tipos de eventos. | |
| eventarc | Eventarc | La instancia de servicio de Eventarc asociada con el Channel actual. |
|
| name | string | El nombre del canal tal como se proporcionó durante la creación del canal. Si no se especificó, se muestra el nombre del canal predeterminado (“locations/us-central1/channels/firebase”). |
Métodos
| Método | Teclas modificadoras | Descripción |
|---|---|---|
| publish(eventos) | Publica los eventos proporcionados en este canal. Si el canal se creó con allowedEventTypes y el tipo de evento no está en esa lista, se ignora el evento. |
Channel.allowedEventTypes
Es una lista de los tipos de eventos que permite su publicación este canal. Se ignoran otros tipos de eventos.
Firma:
readonly allowedEventTypes?: string[];
Channel.eventarc
La instancia de servicio de 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 muestra el nombre del canal predeterminado (“locations/us-central1/channels/firebase”).
Firma:
get name(): string;
Channel.publish()
Publica los eventos proporcionados en este canal. Si el canal se creó con allowedEventTypes y el tipo de evento no está en esa lista, se ignora el evento.
Firma:
publish(events: CloudEvent | CloudEvent[]): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| eventos | CloudEvent | CloudEvent | CloudEvent que se publicará en el canal. |
Muestra:
Promesa<void>