Channel class

イブンタークチャンネル。

サイン:

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 をチャネルに公開します。

戻り値:

約束<無効>