Channel class

Canal do Eventarc.

Assinatura:

export declare class Channel 

Propriedades

Propriedade Modificadores Tipo Descrição
allowedEventTypes string[] Lista de tipos de evento 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.
name string O nome do canal conforme fornecido durante a criação dele. Se não tiver sido especificado, o nome padrão do canal será retornado ("locations/us-central1/channels/firebase").

Métodos

Método Modificadores Descrição
publicação(eventos) Publica os eventos fornecidos neste canal. Se o canal tiver sido criado com allowedEventTypes e o tipo de evento não estiver na lista, o evento será ignorado.

Channel.allowedEventTypes

Lista de tipos de evento 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 conforme fornecido durante a criação dele. Se não tiver sido especificado, o nome padrão do canal será retornado ("locations/us-central1/channels/firebase").

Assinatura:

get name(): string;

Channel.publish()

Publica os eventos fornecidos neste canal. Se o canal tiver sido criado com allowedEventTypes e o tipo de evento não estiver na lista, o evento será ignorado.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
events CloudEvent | Evento do Cloud[] CloudEvent a ser publicado no canal.

Retorna:

Promessa<void>