remoteConfig namespace
Stay organized with collections
Save and categorize content based on your preferences.
Functions
Interfaces
Interface |
Description |
ConfigUpdateData |
The data within Firebase Remote Config update events. |
ConfigUser |
All the fields associated with the person/service account that wrote a Remote Config template. |
Type Aliases
Type Alias |
Description |
ConfigUpdateOrigin |
What type of update was associated with the Remote Config template version. |
ConfigUpdateType |
Where the Remote Config update action originated. |
remoteConfig.onConfigUpdated()
Event handler which triggers when data is updated in a Remote Config.
Signature:
export declare function onConfigUpdated(handler: (event: CloudEvent<ConfigUpdateData>) => any | Promise<any>): CloudFunction<CloudEvent<ConfigUpdateData>>;
Parameters
Parameter |
Type |
Description |
handler |
(event: CloudEvent<ConfigUpdateData>) => any | Promise<any> |
Event handler which is run every time a Remote Config update occurs. |
Returns:
CloudFunction<CloudEvent<ConfigUpdateData>>
A function that you can export and deploy.
remoteConfig.onConfigUpdated()
Event handler which triggers when data is updated in a Remote Config.
Signature:
export declare function onConfigUpdated(opts: EventHandlerOptions, handler: (event: CloudEvent<ConfigUpdateData>) => any | Promise<any>): CloudFunction<CloudEvent<ConfigUpdateData>>;
Parameters
Parameter |
Type |
Description |
opts |
EventHandlerOptions |
Options that can be set on an individual event-handling function. |
handler |
(event: CloudEvent<ConfigUpdateData>) => any | Promise<any> |
Event handler which is run every time a Remote Config update occurs. |
Returns:
CloudFunction<CloudEvent<ConfigUpdateData>>
A function that you can export and deploy.
remoteConfig.ConfigUpdateOrigin
What type of update was associated with the Remote Config template version.
Signature:
export type ConfigUpdateOrigin =
/** Catch-all for unrecognized values. */
"REMOTE_CONFIG_UPDATE_ORIGIN_UNSPECIFIED"
/** The update came from the Firebase UI. */
| "CONSOLE"
/** The update came from the Remote Config REST API. */
| "REST_API"
/** The update came from the Firebase Admin Node SDK. */
| "ADMIN_SDK_NODE";
remoteConfig.ConfigUpdateType
Where the Remote Config update action originated.
Signature:
export type ConfigUpdateType =
/** Catch-all for unrecognized enum values */
"REMOTE_CONFIG_UPDATE_TYPE_UNSPECIFIED"
/** A regular incremental update */
| "INCREMENTAL_UPDATE"
/** A forced update. The ETag was specified as "*" in an UpdateRemoteConfigRequest request or the "Force Update" button was pressed on the console */
| "FORCED_UPDATE"
/** A rollback to a previous Remote Config template */
| "ROLLBACK";
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 2023-04-18 UTC.
[null,null,["Last updated 2023-04-18 UTC."],[],[],null,["# remoteConfig namespace\n\nFunctions\n---------\n\n| Function | Description |\n|----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|\n| [onConfigUpdated(handler)](./firebase-functions.remoteconfig.md#remoteconfigonconfigupdated) | Event handler which triggers when data is updated in a Remote Config. |\n| [onConfigUpdated(opts, handler)](./firebase-functions.remoteconfig.md#remoteconfigonconfigupdated) | Event handler which triggers when data is updated in a Remote Config. |\n\nInterfaces\n----------\n\n| Interface | Description |\n|------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|\n| [ConfigUpdateData](./firebase-functions.remoteconfig.configupdatedata.md#remoteconfigconfigupdatedata_interface) | The data within Firebase Remote Config update events. |\n| [ConfigUser](./firebase-functions.remoteconfig.configuser.md#remoteconfigconfiguser_interface) | All the fields associated with the person/service account that wrote a Remote Config template. |\n\nType Aliases\n------------\n\n| Type Alias | Description |\n|-------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|\n| [ConfigUpdateOrigin](./firebase-functions.remoteconfig.md#remoteconfigconfigupdateorigin) | What type of update was associated with the Remote Config template version. |\n| [ConfigUpdateType](./firebase-functions.remoteconfig.md#remoteconfigconfigupdatetype) | Where the Remote Config update action originated. |\n\nremoteConfig.onConfigUpdated()\n------------------------------\n\nEvent handler which triggers when data is updated in a Remote Config.\n\n**Signature:** \n\n export declare function onConfigUpdated(handler: (event: CloudEvent\u003cConfigUpdateData\u003e) =\u003e any | Promise\u003cany\u003e): CloudFunction\u003cCloudEvent\u003cConfigUpdateData\u003e\u003e;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|\n| handler | (event: [CloudEvent](./firebase-functions.cloudevent.md#cloudevent_interface)\\\u003c[ConfigUpdateData](./firebase-functions.remoteconfig.configupdatedata.md#remoteconfigconfigupdatedata_interface)\\\u003e) =\\\u003e any \\| Promise\\\u003cany\\\u003e | Event handler which is run every time a Remote Config update occurs. |\n\n**Returns:**\n\n[CloudFunction](./firebase-functions.cloudfunction.md#cloudfunction_interface)\\\u003c[CloudEvent](./firebase-functions.cloudevent.md#cloudevent_interface)\\\u003c[ConfigUpdateData](./firebase-functions.remoteconfig.configupdatedata.md#remoteconfigconfigupdatedata_interface)\\\u003e\\\u003e\n\nA function that you can export and deploy.\n\nremoteConfig.onConfigUpdated()\n------------------------------\n\nEvent handler which triggers when data is updated in a Remote Config.\n\n**Signature:** \n\n export declare function onConfigUpdated(opts: EventHandlerOptions, handler: (event: CloudEvent\u003cConfigUpdateData\u003e) =\u003e any | Promise\u003cany\u003e): CloudFunction\u003cCloudEvent\u003cConfigUpdateData\u003e\u003e;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|\n| opts | [EventHandlerOptions](./firebase-functions.eventhandleroptions.md#eventhandleroptions_interface) | Options that can be set on an individual event-handling function. |\n| handler | (event: [CloudEvent](./firebase-functions.cloudevent.md#cloudevent_interface)\\\u003c[ConfigUpdateData](./firebase-functions.remoteconfig.configupdatedata.md#remoteconfigconfigupdatedata_interface)\\\u003e) =\\\u003e any \\| Promise\\\u003cany\\\u003e | Event handler which is run every time a Remote Config update occurs. |\n\n**Returns:**\n\n[CloudFunction](./firebase-functions.cloudfunction.md#cloudfunction_interface)\\\u003c[CloudEvent](./firebase-functions.cloudevent.md#cloudevent_interface)\\\u003c[ConfigUpdateData](./firebase-functions.remoteconfig.configupdatedata.md#remoteconfigconfigupdatedata_interface)\\\u003e\\\u003e\n\nA function that you can export and deploy.\n\nremoteConfig.ConfigUpdateOrigin\n-------------------------------\n\nWhat type of update was associated with the Remote Config template version.\n\n**Signature:** \n\n export type ConfigUpdateOrigin = \n /** Catch-all for unrecognized values. */\n \"REMOTE_CONFIG_UPDATE_ORIGIN_UNSPECIFIED\"\n /** The update came from the Firebase UI. */\n | \"CONSOLE\"\n /** The update came from the Remote Config REST API. */\n | \"REST_API\"\n /** The update came from the Firebase Admin Node SDK. */\n | \"ADMIN_SDK_NODE\";\n\nremoteConfig.ConfigUpdateType\n-----------------------------\n\nWhere the Remote Config update action originated.\n\n**Signature:** \n\n export type ConfigUpdateType = \n /** Catch-all for unrecognized enum values */\n \"REMOTE_CONFIG_UPDATE_TYPE_UNSPECIFIED\"\n /** A regular incremental update */\n | \"INCREMENTAL_UPDATE\"\n /** A forced update. The ETag was specified as \"*\" in an UpdateRemoteConfigRequest request or the \"Force Update\" button was pressed on the console */\n | \"FORCED_UPDATE\"\n /** A rollback to a previous Remote Config template */\n | \"ROLLBACK\";"]]