Eventarc-Kanal.
Unterschrift:
export declare class Channel
Eigenschaften
| Eigentum | Modifikatoren | Typ | Beschreibung |
|---|---|---|---|
| erlaubteEventTypes | string[] | Liste der Ereignistypen, die dieser Kanal zur Veröffentlichung zulässt. Andere Ereignistypen werden ignoriert. | |
| Eventarc | Eventarc | Die Eventarc- Dienstinstanz, die dem aktuellen Channel zugeordnet ist. | |
| Name | Zeichenfolge | Der Kanalname, wie er bei der Kanalerstellung angegeben wurde. Wenn er nicht angegeben wurde, wird der Standardkanalname zurückgegeben („locations/us-central1/channels/firebase“). |
Methoden
| Methode | Modifikatoren | Beschreibung |
|---|---|---|
| veröffentlichen(Veranstaltungen) | Veröffentlicht bereitgestellte Ereignisse für diesen Kanal. Wenn der Kanal mit allowedEventTypes erstellt wurde und der Ereignistyp nicht in dieser Liste enthalten ist, wird das Ereignis ignoriert. |
Channel.allowedEventTypes
Liste der Ereignistypen, die dieser Kanal zur Veröffentlichung zulässt. Andere Ereignistypen werden ignoriert.
Unterschrift:
readonly allowedEventTypes?: string[];
Channel.eventarc
Die Eventarc- Dienstinstanz, die dem aktuellen Channel zugeordnet ist .
Unterschrift:
get eventarc(): Eventarc;
Beispiel
var app = channel.eventarc;
Kanal Name
Der Kanalname, wie er bei der Kanalerstellung angegeben wurde. Wenn er nicht angegeben wurde, wird der Standardkanalname zurückgegeben („locations/us-central1/channels/firebase“).
Unterschrift:
get name(): string;
Channel.publish()
Veröffentlicht bereitgestellte Ereignisse für diesen Kanal. Wenn der Kanal mit allowedEventTypes erstellt wurde und der Ereignistyp nicht in dieser Liste enthalten ist, wird das Ereignis ignoriert.
Unterschrift:
publish(events: CloudEvent | CloudEvent[]): Promise<void>;
Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Veranstaltungen | CloudEvent | CloudEvent [] | CloudEvent zur Veröffentlichung im Kanal. |
Kehrt zurück:
Versprechen<void>