Classes
| Class | Description |
|---|---|
| RemoteConfig | The Firebase RemoteConfig service interface. |
Functions
| Function | Description |
|---|---|
| getRemoteConfig(app) | Gets the service for the default app or a given app.getRemoteConfig() can be called with no arguments to access the default app's service or as getRemoteConfig(app) to access the service associated with a specific app. |
Interfaces
| Interface | Description |
|---|---|
| ExplicitParameterValue | Interface representing an explicit parameter value. |
| InAppDefaultValue | Interface representing an in-app-default value. |
| ListVersionsOptions | Interface representing options for Remote Config list versions operation. |
| ListVersionsResult | Interface representing a list of Remote Config template versions. |
| RemoteConfigCondition | Interface representing a Remote Config condition. A condition targets a specific group of users. A list of these conditions make up part of a Remote Config template. |
| RemoteConfigParameter | Interface representing a Remote Config parameter. At minimum, a defaultValue or a conditionalValues entry must be present for the parameter to have any effect. |
| RemoteConfigParameterGroup | Interface representing a Remote Config parameter group. Grouping parameters is only for management purposes and does not affect client-side fetching of parameter values. |
| RemoteConfigTemplate | Interface representing a Remote Config template. |
| RemoteConfigUser | Interface representing a Remote Config user. |
| Version | Interface representing a Remote Config template version. Output only, except for the version description. Contains metadata about a particular version of the Remote Config template. All fields are set at the time the specified Remote Config template is published. A version's description field may be specified in publishTemplate calls. |
Type Aliases
| Type Alias | Description |
|---|---|
| RemoteConfigParameterValue | Type representing a Remote Config parameter value. A RemoteConfigParameterValue could be either an ExplicitParameterValue or an InAppDefaultValue. |
| TagColor | Colors that are associated with conditions for display purposes. |
getRemoteConfig()
Gets the service for the default app or a given app.
getRemoteConfig() can be called with no arguments to access the default app's service or as getRemoteConfig(app) to access the service associated with a specific app.
Signature:
export declare function getRemoteConfig(app?: App): RemoteConfig;
Parameters
| Parameter | Type | Description |
|---|---|---|
| app | App | Optional app for which to return the RemoteConfig service. If not provided, the default RemoteConfig service is returned. The default RemoteConfig service if no app is provided, or the RemoteConfig service associated with the provided app. |
Returns:
Example 1
// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();
Example 2
// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);
RemoteConfigParameterValue
Type representing a Remote Config parameter value. A RemoteConfigParameterValue could be either an ExplicitParameterValue or an InAppDefaultValue.
Signature:
export declare type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;
TagColor
Colors that are associated with conditions for display purposes.
Signature:
export declare type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';