Channel class

Saluran Eventarc.

Tanda Tangan:

export declare class Channel 

Properti

Properti	Pengubah	Jenis	Deskripsi
AllowedEventTypes		{i>string<i}[]	Daftar jenis acara yang diizinkan oleh channel ini untuk dipublikasikan. Jenis peristiwa lainnya akan diabaikan.
eventarc		Eventarc	Instance layanan Eventarc yang terkait dengan Channel saat ini.
name		string	Nama channel seperti yang diberikan selama pembuatan channel. Jika tidak ditetapkan, nama saluran default akan ditampilkan ('locations/us-central1/channels/firebase').

Metode

Metode	Pengubah	Deskripsi
publikasikan(acara)		Memublikasikan peristiwa yang disediakan ke saluran ini. Jika saluran dibuat dengan allowedEventTypes dan jenis peristiwa tidak ada dalam daftar tersebut, peristiwa akan diabaikan.

Channel.AllowedEventTypes

Daftar jenis acara yang diizinkan oleh channel ini untuk dipublikasikan. Jenis peristiwa lainnya akan diabaikan.

Tanda Tangan:

readonly allowedEventTypes?: string[];

Channel.eventarc

Instance layanan Eventarc yang terkait dengan Channel saat ini.

Tanda Tangan:

get eventarc(): Eventarc;

Contoh

var app = channel.eventarc;

Nama.saluran

Nama channel seperti yang diberikan selama pembuatan channel. Jika tidak ditetapkan, nama saluran default akan ditampilkan ('locations/us-central1/channels/firebase').

Tanda Tangan:

get name(): string;

Channel.publish()

Memublikasikan peristiwa yang disediakan ke saluran ini. Jika saluran dibuat dengan allowedEventTypes dan jenis peristiwa tidak ada dalam daftar tersebut, peristiwa akan diabaikan.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
acara	CloudEvent | CloudEvent[]	CloudEvent yang akan dipublikasikan ke saluran.

Hasil:

Janji<void>