Canal Eventarc.
Assinatura:
export declare class Channel
Propriedades
Propriedade | Modificadores | Modelo | 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 foi especificado, o nome do canal padrão é 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. |
Channel.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 foi especificado, o nome do canal padrão é retornado ('locations/us-central1/channels/firebase').
Assinatura:
get name(): string;
Canal.publicar()
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 | Modelo | Descrição |
---|---|---|
eventos | CloudEvent | CloudEvent [] | CloudEvent para publicar no canal. |
Devoluções:
Promessa<void>