Eventarc class
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-07-29 UTC.
[null,null,["Last updated 2022-07-29 UTC."],[],[],null,["# Eventarc class\n\nEventarc service bound to the provided app.\n\n**Signature:** \n\n export declare class Eventarc \n\nProperties\n----------\n\n| Property | Modifiers | Type | Description |\n|----------------------------------------------------------|-----------|------|-------------------------------------------------------------------------------------------------------------|\n| [app](./firebase-admin.eventarc.eventarc.md#eventarcapp) | | App | The [App](./firebase-admin.app.app.md#app_interface) associated with the current Eventarc service instance. |\n\nMethods\n-------\n\n| Method | Modifiers | Description |\n|---------------------------------------------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [channel(name, options)](./firebase-admin.eventarc.eventarc.md#eventarcchannel) | | 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}` |\n| [channel(options)](./firebase-admin.eventarc.eventarc.md#eventarcchannel) | | Create a reference to the default Firebase channel: `locations/us-central1/channels/firebase` |\n\nEventarc.app\n------------\n\nThe [App](./firebase-admin.app.app.md#app_interface) associated with the current Eventarc service instance.\n\n**Signature:** \n\n get app(): App;\n\n### Example\n\n var app = eventarc.app;\n\nEventarc.channel()\n------------------\n\nCreates a reference to the Eventarc channel using the provided channel resource name. The channel resource name can be either:\n\n- A fully qualified channel resource name: `projects/{project}/locations/{location}/channels/{channel-id}`\n\n- 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}`\n\n- A partial channel ID, in which case the runtime project ID of the function and `us-central1` as location is used: `{channel-id}`\n\n**Signature:** \n\n channel(name: string, options?: ChannelOptions): Channel;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|----------------------------------------------------------------------------------------|---------------------------------------|\n| name | string | Channel resource name. |\n| options | [ChannelOptions](./firebase-admin.eventarc.channeloptions.md#channeloptions_interface) | (optional) additional channel options |\n\n**Returns:**\n\n[Channel](./firebase-admin.eventarc.channel.md#channel_class)\n\nAn Eventarc channel reference for publishing events.\n\nEventarc.channel()\n------------------\n\nCreate a reference to the default Firebase channel: `locations/us-central1/channels/firebase`\n\n**Signature:** \n\n channel(options?: ChannelOptions): Channel;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|----------------------------------------------------------------------------------------|---------------------------------------|\n| options | [ChannelOptions](./firebase-admin.eventarc.channeloptions.md#channeloptions_interface) | (optional) additional channel options |\n\n**Returns:**\n\n[Channel](./firebase-admin.eventarc.channel.md#channel_class)\n\nEventarc channel reference for publishing events."]]
