Channel class

Canal Eventarc.

Assinatura:

export declare class Channel 

Propriedades

Propriedade Modificadores Tipo Descrição
tipos de eventos permitidos corda[] Lista de tipos de eventos permitidos por este canal para publicação. Outros tipos de eventos são ignorados.
Eventarc Eventarc A instância de serviço Eventarc associada ao Channel atual.
nome corda O nome do canal fornecido durante a criação do canal. Se não for especificado, o nome padrão do canal será retornado ('locations/us-central1/channels/firebase').

Métodos

Método Modificadores Descrição
publicar (eventos) Publica eventos fornecidos neste canal. Se o canal foi criado com allowedEventTypes e o tipo de evento não estiver nessa lista, o evento será ignorado.

Canal.allowedEventTypes

Lista de tipos de eventos permitidos por este canal para publicação. Outros tipos de eventos são ignorados.

Assinatura:

readonly allowedEventTypes?: string[];

Canal.eventarc

A instância de serviço Eventarc associada ao Channel atual .

Assinatura:

get eventarc(): Eventarc;

Exemplo

var app = channel.eventarc;

Nome do canal

O nome do canal fornecido durante a criação do canal. Se não for especificado, o nome padrão do canal será retornado ('locations/us-central1/channels/firebase').

Assinatura:

get name(): string;

Canal.publish()

Publica eventos fornecidos neste canal. Se o canal foi criado com allowedEventTypes e o tipo de evento não estiver nessa lista, o evento será ignorado.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
eventos Evento na nuvem | Evento na nuvem [] CloudEvent para publicar no canal.

Retorna:

Promessa<void>