Channel class

Eventarc 頻道。

簽名:

export declare class Channel 

特性

財產修飾符類型描述
允許的事件類型細繩[]此通道允許發布的事件類型清單。其他事件類型將被忽略。
事件弧事件弧與目前Channel關聯的Eventarc服務實例。
姓名細繩建立頻道期間提供的頻道名稱。如果未指定,則傳回預設通道名稱('locations/us-central1/channels/firebase')。

方法

方法修飾符描述
發布(事件)將提供的事件發佈到此頻道。如果通道是使用allowedEventTypes建立的,且事件類型不在該清單中,則該事件將被忽略。

Channel.allowedEventTypes

此通道允許發布的事件類型清單。其他事件類型將被忽略。

簽名:

readonly allowedEventTypes?: string[];

頻道.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。

返回:

承諾<無效>