firebase-admin.eventarc package
Stay organized with collections
Save and categorize content based on your preferences.
Firebase Eventarc.
Functions
| Function |
Description |
| getEventarc(app) |
Gets the Eventarc service for the default app or a given app.getEventarc() can be called with no arguments to access the default app's Eventarc service or as getEventarc(app) to access the Eventarc service associated with specific app. |
Classes
| Class |
Description |
| Channel |
Eventarc Channel. |
| Eventarc |
Eventarc service bound to the provided app. |
Interfaces
Type Aliases
getEventarc(app)
Gets the Eventarc service for the default app or a given app.
getEventarc() can be called with no arguments to access the default app's Eventarc service or as getEventarc(app) to access the Eventarc service associated with specific app.
Signature:
export declare function getEventarc(app?: App): Eventarc;
Parameters
| Parameter |
Type |
Description |
| app |
App |
Optional app whose Eventarc service will be returned. If not provided, the default Eventarc service will be returned. |
Returns:
Eventarc
The default Eventarc service if no app is provided or the Eventarc service associated with the provided app.
Example 1
// Get the Eventarc service for the default app
const defaultEventarc = getEventarc();
Example 2
// Get the Eventarc service for a given app
const otherEventarc = getEventarc(otherApp);
CloudEventVersion
A CloudEvent version.
Signature:
export type CloudEventVersion = '1.0';
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 2024-04-16 UTC.
[null,null,["Last updated 2024-04-16 UTC."],[],[],null,["# firebase-admin.eventarc package\n\nFirebase Eventarc.\n\nFunctions\n---------\n\n| Function | Description |\n|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [getEventarc(app)](./firebase-admin.eventarc.md#geteventarc_8a40afc) | Gets the [Eventarc](./firebase-admin.eventarc.eventarc.md#eventarc_class) service for the default app or a given app.`getEventarc()` can be called with no arguments to access the default app's `Eventarc` service or as `getEventarc(app)` to access the `Eventarc` service associated with specific app. |\n\nClasses\n-------\n\n| Class | Description |\n|------------------------------------------------------------------|---------------------------------------------|\n| [Channel](./firebase-admin.eventarc.channel.md#channel_class) | Eventarc Channel. |\n| [Eventarc](./firebase-admin.eventarc.eventarc.md#eventarc_class) | Eventarc service bound to the provided app. |\n\nInterfaces\n----------\n\n| Interface | Description |\n|----------------------------------------------------------------------------------------|------------------------------------|\n| [ChannelOptions](./firebase-admin.eventarc.channeloptions.md#channeloptions_interface) | Channel options interface. |\n| [CloudEvent](./firebase-admin.eventarc.cloudevent.md#cloudevent_interface) | A CloudEvent describes event data. |\n\nType Aliases\n------------\n\n| Type Alias | Description |\n|---------------------------------------------------------------------|-----------------------|\n| [CloudEventVersion](./firebase-admin.eventarc.md#cloudeventversion) | A CloudEvent version. |\n\ngetEventarc(app)\n----------------\n\nGets the [Eventarc](./firebase-admin.eventarc.eventarc.md#eventarc_class) service for the default app or a given app.\n\n`getEventarc()` can be called with no arguments to access the default app's `Eventarc` service or as `getEventarc(app)` to access the `Eventarc` service associated with specific app.\n\n**Signature:** \n\n export declare function getEventarc(app?: App): Eventarc;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|------|---------------------------------------------------------------------------------------------------------------------------|\n| app | App | Optional app whose `Eventarc` service will be returned. If not provided, the default `Eventarc` service will be returned. |\n\n**Returns:**\n\n[Eventarc](./firebase-admin.eventarc.eventarc.md#eventarc_class)\n\nThe default `Eventarc` service if no app is provided or the `Eventarc` service associated with the provided app.\n\n### Example 1\n\n // Get the Eventarc service for the default app\n const defaultEventarc = getEventarc();\n\n### Example 2\n\n // Get the Eventarc service for a given app\n const otherEventarc = getEventarc(otherApp);\n\nCloudEventVersion\n-----------------\n\nA CloudEvent version.\n\n**Signature:** \n\n export type CloudEventVersion = '1.0';"]]
