Channel class

Eventarc チャネル。

署名:

export declare class Channel 

プロパティ

プロパティ	修飾キー	タイプ	説明
allowedEventTypes		string[]	このチャンネルでの公開が許可されているイベントタイプのリスト。他のイベントタイプは無視されます。
eventarc		Eventarc	現在の Channel に関連付けられている Eventarc サービス インスタンス。
name		文字列	チャンネル作成時に指定されたチャンネル名。指定しなかった場合は、デフォルトのチャネル名（locations/us-central1/channels/firebase）が返されます。

メソッド

メソッド	修飾キー	説明
publish(events)		提供されたイベントをこのチャネルに公開します。チャンネルが 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>