Channel class

Kênh Eventarc.

Chữ ký:

export declare class Channel 

Thuộc tính

Tài sản Công cụ sửa đổi Loại Mô tả
cho phépEventTypes chuỗi[] Danh sách các loại sự kiện mà kênh này cho phép xuất bản. Các loại sự kiện khác sẽ bị bỏ qua.
eventarc Eventarc Thực thể dịch vụ Eventarc được liên kết với Channel hiện tại.
name chuỗi Tên kênh như được cung cấp trong quá trình tạo kênh. Nếu không được chỉ định, tên kênh mặc định sẽ được trả về ("locations/us-central1/channel/firebase").

Phương thức

Phương thức Công cụ sửa đổi Mô tả
publish(sự kiện) Đăng các sự kiện được cung cấp lên kênh này. Nếu kênh được tạo bằng allowedEventTypes và loại sự kiện không có trong danh sách đó, thì sự kiện sẽ bị bỏ qua.

Channel.AllowedEventTypes

Danh sách các loại sự kiện mà kênh này cho phép xuất bản. Các loại sự kiện khác sẽ bị bỏ qua.

Chữ ký:

readonly allowedEventTypes?: string[];

Kênh.eventarc

Thực thể dịch vụ Eventarc được liên kết với Channel hiện tại.

Chữ ký:

get eventarc(): Eventarc;

Ví dụ

var app = channel.eventarc;

Tên kênh

Tên kênh như được cung cấp trong quá trình tạo kênh. Nếu không được chỉ định, tên kênh mặc định sẽ được trả về ("locations/us-central1/channel/firebase").

Chữ ký:

get name(): string;

Channel.publish()

Đăng các sự kiện được cung cấp lên kênh này. Nếu kênh được tạo bằng allowedEventTypes và loại sự kiện không có trong danh sách đó, thì sự kiện sẽ bị bỏ qua.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
sự kiện CloudEvent | CloudEvent[] CloudEvent để xuất bản lên kênh.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>