イブンタークチャンネル。
サイン:
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 をチャネルに公開します。 |
戻り値:
約束<無効>