Eventarc 频道。
签名:
export declare class Channel
特性
财产 | 修饰符 | 类型 | 描述 |
---|---|---|---|
允许的事件类型 | 细绳[] | 此通道允许发布的事件类型列表。其他事件类型将被忽略。 | |
事件弧 | 事件弧 | 与当前Channel 关联的Eventarc服务实例。 | |
姓名 | 细绳 | 创建频道期间提供的频道名称。如果未指定,则返回默认通道名称('locations/us-central1/channels/firebase')。 |
方法
方法 | 修饰符 | 描述 |
---|---|---|
发布(事件) | 将提供的事件发布到此频道。如果通道是使用allowedEventTypes 创建的,并且事件类型不在该列表中,则该事件将被忽略。 |
Channel.allowedEventTypes
此通道允许发布的事件类型列表。其他事件类型将被忽略。
签名:
readonly allowedEventTypes?: string[];
通道.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。 |
返回:
承诺<无效>