Channel class

ช่อง Eventarc

ลายเซ็น:

export declare class Channel 

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ คีย์ตัวปรับแต่ง ประเภท คำอธิบาย
allowedEventTypes สตริง[] รายการประเภทเหตุการณ์ที่ช่องนี้อนุญาตให้เผยแพร่ ระบบจะไม่สนใจเหตุการณ์ประเภทอื่นๆ
eventarc Eventarc อินสแตนซ์บริการ Eventarc ที่เชื่อมโยงกับ Channel ปัจจุบัน
name สตริง ชื่อช่องตามที่ระบุในระหว่างการสร้างช่อง หากไม่ระบุ ระบบจะแสดงผลชื่อช่องเริ่มต้น (('locations/us-central1/channels/firebase')

เมธอด

วิธีการ คีย์ตัวปรับแต่ง คำอธิบาย
เผยแพร่(กิจกรรม) เผยแพร่กิจกรรมที่มีให้ไปยังช่องนี้ หากสร้างช่องด้วย allowedEventTypes และมีประเภทเหตุการณ์ไม่อยู่ในรายการดังกล่าว ระบบจะไม่สนใจเหตุการณ์ดังกล่าว

Channel.allowedEventTypes

รายการประเภทเหตุการณ์ที่ช่องนี้อนุญาตให้เผยแพร่ ระบบจะไม่สนใจเหตุการณ์ประเภทอื่นๆ

ลายเซ็น:

readonly allowedEventTypes?: string[];

ช่อง.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 เพื่อเผยแพร่ไปยังช่อง

การคืนสินค้า:

คำมั่นสัญญา<โมฆะ>