Channel class

Канал Эвентарк.

Подпись:

export declare class Channel 

Характеристики

Свойство Модификаторы Тип Описание
разрешенные типы событий нить[] Список типов событий, разрешенных данным каналом для публикации. Другие типы событий игнорируются.
событие Эвентарк Экземпляр службы Eventarc , связанный с текущим Channel .
имя нить Имя канала, указанное при создании канала. Если оно не указано, возвращается имя канала по умолчанию («locations/us-central1/channels/firebase»).

Методы

Метод Модификаторы Описание
публиковать(события) Публикации предоставили события на этом канале. Если канал был создан с allowedEventTypes и тип события отсутствует в этом списке, событие игнорируется.

Канал.allowedEventTypes

Список типов событий, разрешенных данным каналом для публикации. Другие типы событий игнорируются.

Подпись:

readonly allowedEventTypes?: string[];

Канал.eventarc

Экземпляр службы Eventarc , связанный с текущим Channel . .

Подпись:

get eventarc(): Eventarc;

Пример

var app = channel.eventarc;

Название канала

Имя канала, указанное при создании канала. Если оно не указано, возвращается имя канала по умолчанию («locations/us-central1/channels/firebase»).

Подпись:

get name(): string;

Канал.публикация()

Публикации предоставили события на этом канале. Если канал был создан с allowedEventTypes и тип события отсутствует в этом списке, событие игнорируется.

Подпись:

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

Параметры

Параметр Тип Описание
события Облачное событие | CloudEvent [] CloudEvent для публикации в канале.

Возврат:

Обещание<void>