Kanał Eventarc.
Podpis:
export declare class Channel
Właściwości
| Właściwość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| allowedEventTypes (Dopuszczalne typy zdarzeń) | ciąg znaków[] | Lista typów wydarzeń, które można publikować na tym kanale. Pozostałe typy zdarzeń są ignorowane. | |
| eventarc | Eventarc | Instancja usługi Eventarc powiązana z bieżącym Channel. |
|
| name | ciąg znaków | Nazwa kanału podana podczas jego tworzenia. Jeśli kanał nie został określony, zwracana jest domyślna nazwa kanału („locations/us-central1/channels/firebase”). |
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| publish(events) | Publikuje przesłane zdarzenia na tym kanale. Jeśli kanał został utworzony za pomocą funkcji allowedEventTypes, a typu zdarzenia nie ma na tej liście, zdarzenie zostanie zignorowane. |
Channel.allowedEventTypes
Lista typów wydarzeń, które można publikować na tym kanale. Pozostałe typy zdarzeń są ignorowane.
Podpis:
readonly allowedEventTypes?: string[];
Channel.eventarc
Instancja usługi Eventarc powiązana z bieżącym zasobem Channel.
Podpis:
get eventarc(): Eventarc;
Przykład
var app = channel.eventarc;
Nazwa.kanału
Nazwa kanału podana podczas jego tworzenia. Jeśli kanał nie został określony, zwracana jest domyślna nazwa kanału („locations/us-central1/channels/firebase”).
Podpis:
get name(): string;
Channel.publish()
Publikuje przesłane zdarzenia na tym kanale. Jeśli kanał został utworzony za pomocą funkcji allowedEventTypes, a typu zdarzenia nie ma na tej liście, zdarzenie zostanie zignorowane.
Podpis:
publish(events: CloudEvent | CloudEvent[]): Promise<void>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| wydarzenia | CloudEvent | CloudEvent[] | CloudEvent do opublikowania w kanale. |
Zwroty:
Obietnica<void>