Eventarc class

Eventarc service bound to the provided app.

Signature:

export declare class Eventarc

Properties

Property Modifiers Type Description
app App The App associated with the current Eventarc service instance.

Methods

Method Modifiers Description
channel(name, options) Creates a reference to the Eventarc channel using the provided channel resource name. The channel resource name can be either:- A fully qualified channel resource name: projects/{project}/locations/{location}/channels/{channel-id}- A partial resource name with location and channel ID, in which case the runtime project ID of the function is used: locations/{location}/channels/{channel-id}- A partial channel ID, in which case the runtime project ID of the function and us-central1 as location is used: {channel-id}
channel(options) Create a reference to the default Firebase channel: locations/us-central1/channels/firebase

Eventarc.app

The App associated with the current Eventarc service instance.

Signature:

get app(): App;

Example

var app = eventarc.app;

Eventarc.channel()

Creates a reference to the Eventarc channel using the provided channel resource name. The channel resource name can be either:

  • A fully qualified channel resource name: projects/{project}/locations/{location}/channels/{channel-id}

  • A partial resource name with location and channel ID, in which case the runtime project ID of the function is used: locations/{location}/channels/{channel-id}

  • A partial channel ID, in which case the runtime project ID of the function and us-central1 as location is used: {channel-id}

Signature:

channel(name: string, options?: ChannelOptions): Channel;

Parameters

Parameter Type Description
name string Channel resource name.
options ChannelOptions (optional) additional channel options

Returns:

Channel

An Eventarc channel reference for publishing events.

Eventarc.channel()

Create a reference to the default Firebase channel: locations/us-central1/channels/firebase

Signature:

channel(options?: ChannelOptions): Channel;

Parameters

Parameter Type Description
options ChannelOptions (optional) additional channel options

Returns:

Channel

Eventarc channel reference for publishing events.