Channel class

Chaîne Eventarc.

Signature:

export declare class Channel 

Propriétés

Propriété	Modificateurs	Taper	Description
Types d'événements autorisés		chaîne[]	Liste des types d'événements autorisés par ce canal pour la publication. Les autres types d'événements sont ignorés.
arc événementiel		Arc Événementiel	L'instance de service Eventarc associée au Channel actuel.
nom		chaîne	Le nom de la chaîne tel que fourni lors de la création de la chaîne. S'il n'a pas été spécifié, le nom du canal par défaut est renvoyé (« locations/us-central1/channels/firebase »).

Méthodes

Méthode	Modificateurs	Description
publier(événements)		Publie les événements fournis sur cette chaîne. Si le canal a été créé avec allowedEventTypes et que le type d'événement ne figure pas dans cette liste, l'événement est ignoré.

Channel.allowedEventTypes

Liste des types d'événements autorisés par ce canal pour la publication. Les autres types d'événements sont ignorés.

Signature:

readonly allowedEventTypes?: string[];

Canal.eventarc

L'instance de service Eventarc associée au Channel actuel .

Signature:

get eventarc(): Eventarc;

Exemple

var app = channel.eventarc;

Nom du canal

Le nom de la chaîne tel que fourni lors de la création de la chaîne. S'il n'a pas été spécifié, le nom du canal par défaut est renvoyé (« locations/us-central1/channels/firebase »).

Signature:

get name(): string;

Canal.publier()

Publie les événements fournis sur cette chaîne. Si le canal a été créé avec allowedEventTypes et que le type d'événement ne figure pas dans cette liste, l'événement est ignoré.

Signature:

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

Paramètres

Paramètre	Taper	Description
événements	Événement Cloud | Événement Cloud []	CloudEvent à publier sur le canal.

Retour:

Promesse<vide>