Channel class

Kanał Eventarc.

Podpis:

export declare class Channel 

Nieruchomości

Nieruchomość Modyfikatory Typ Opis
dozwolone typy zdarzeń strunowy[] Lista typów wydarzeń dozwolonych przez ten kanał do publikowania. Inne typy zdarzeń są ignorowane.
wydarzenierc Eventarc Instancja usługi Eventarc powiązana z bieżącym Channel .
nazwa strunowy Nazwa kanału podana podczas tworzenia kanału. Jeżeli nie zostało to określone, zwracana jest domyślna nazwa kanału („locations/us-central1/channels/firebase”).

Metody

metoda Modyfikatory Opis
publikować(wydarzenia) Publikuje udostępnione wydarzenia na tym kanale. Jeśli kanał został utworzony z allowedEventTypes i typu zdarzenia nie ma na tej liście, zdarzenie zostanie zignorowane.

Channel.allowedEventTypes

Lista typów wydarzeń dozwolonych przez ten kanał do publikowania. Inne typy zdarzeń są ignorowane.

Podpis:

readonly allowedEventTypes?: string[];

Kanał.eventarc

Instancja usługi Eventarc powiązana z bieżącym Channel .

Podpis:

get eventarc(): Eventarc;

Przykład

var app = channel.eventarc;

Nazwa kanału

Nazwa kanału podana podczas tworzenia kanału. Jeżeli nie zostało to określone, zwracana jest domyślna nazwa kanału („locations/us-central1/channels/firebase”).

Podpis:

get name(): string;

Kanał.publikuj()

Publikuje udostępnione wydarzenia na tym kanale. Jeśli kanał został utworzony z allowedEventTypes i typu zdarzenia nie ma na tej liście, zdarzenie zostanie zignorowane.

Podpis:

publish(events: CloudEvent | CloudEvent[]): Promise<void>;

Parametry

Parametr Typ Opis
wydarzenia Wydarzenie w chmurze | Wydarzenie w chmurze [] CloudEvent do opublikowania na kanale.

Zwroty:

Obietnica<pusta>