Channel class

کانال Eventarc.

امضا:

export declare class Channel 

خواص

ویژگی اصلاح کننده ها تایپ کنید شرح
allowEventTypes رشته[] فهرست انواع رویدادهای مجاز توسط این کانال برای انتشار. انواع دیگر رویدادها نادیده گرفته می شوند.
eventtarc رویدادارک نمونه سرویس Eventarc مرتبط با Channel فعلی.
نام رشته نام کانال همانطور که در هنگام ایجاد کانال ارائه شد. اگر مشخص نشده بود، نام کانال پیش‌فرض برگردانده می‌شود ('locations/us-central1/channels/firebase').

مواد و روش ها

روش اصلاح کننده ها شرح
انتشار (رویدادها) رویدادهای ارائه شده را در این کانال منتشر می کند. اگر کانال با allowedEventTypes ایجاد شده باشد و نوع رویداد در آن لیست نباشد، رویداد نادیده گرفته می‌شود.

Channel.allowedEventTypes

فهرست انواع رویدادهای مجاز توسط این کانال برای انتشار. انواع دیگر رویدادها نادیده گرفته می شوند.

امضا:

readonly allowedEventTypes?: string[];

Channel.eventarc

نمونه سرویس Eventarc مرتبط با Channel فعلی .

امضا:

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 برای انتشار در کانال.

برمی گرداند:

قول<باطل>