Channel class

Eventarc 渠道。

签名

export declare class Channel 

属性

属性 修饰符 类型 说明
allowedEventTypes 字符串[] 此渠道允许发布的事件类型列表。其他事件类型会被忽略。
eventarc Eventarc 与当前 Channel 关联的 Eventarc 服务实例。
name 字符串 在创建频道时提供的频道名称。如果未指定,则返回默认渠道名称(“locations/us-central1/channels/firebase”)。

方法

方法 修饰符 说明
publish(events) 将提供的事件发布到此渠道。如果渠道是使用 allowedEventTypes 创建的,且事件类型不在该列表中,则系统会忽略该事件。

Channel.allowedEventTypes 类型

此渠道允许发布的事件类型列表。其他事件类型会被忽略。

签名

readonly allowedEventTypes?: string[];

Channel.eventarc

与当前 Channel 关联的 Eventarc 服务实例。

签名

get eventarc(): Eventarc;

示例

var app = channel.eventarc;

频道名称

在创建频道时提供的频道名称。如果未指定,则返回默认渠道名称(“locations/us-central1/channels/firebase”)。

签名

get name(): string;

Channel.publish()

将提供的事件发布到此渠道。如果渠道是使用 allowedEventTypes 创建的,且事件类型不在该列表中,则系统会忽略该事件。

签名

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

参数

参数 类型 说明
活动 CloudEvent |CloudEvent[] 要发布到渠道的 CloudEvent。

返回

承诺<void>