Channel class

Eventarc 管道。

簽名：

export declare class Channel

屬性

屬性 修飾符 類型 說明
allowedEventTypes string[] 這個頻道允許發布的事件類型清單。系統會忽略其他事件類型。
事件 Eventarc 與目前 Channel 相關聯的 Eventarc 服務執行個體。
name 字串 頻道建立時提供的頻道名稱。如未指定，則會傳回預設頻道名稱 (「locations/us-central1/channels/firebase」)。

方法

方法 修飾符 說明
publish(事件) 將提供的活動發布至這個頻道。如果使用 allowedEventTypes 建立管道，但事件類型不在清單中，系統會忽略該事件。

Channel.allowedEventTypes

這個頻道允許發布的事件類型清單。系統會忽略其他事件類型。

簽名：

readonly allowedEventTypes?: string[];

Channel.eventarc

與目前 Channel 相關聯的 Eventarc 服務執行個體。

簽名：

get eventarc(): Eventarc;

範例

var app = channel.eventarc;

管道名稱

頻道建立時提供的頻道名稱。如未指定，則會傳回預設頻道名稱 (「locations/us-central1/channels/firebase」)。

簽名：

get name(): string;

Channel.publish()

將提供的活動發布至這個頻道。如果使用 allowedEventTypes 建立管道，但事件類型不在清單中，系統會忽略該事件。

簽名：

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

參數

參數 類型 說明
活動 CloudEvent：CloudEvent[] 要發布至管道的 CloudEvent。

傳回：

承諾<void>