Skip to content

Commit 82f7be0

Browse files
chkuang-ga-maurice
chkuang-g
authored and
a-maurice
committed
Deprecate functions using configuration namespace in Remote Config
PiperOrigin-RevId: 242035672
1 parent c41ae0b commit 82f7be0

File tree

1 file changed

+90
-22
lines changed

1 file changed

+90
-22
lines changed

‎remote_config/src/include/firebase/remote_config.h

Lines changed: 90 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -240,8 +240,13 @@ void SetDefaults(const ConfigKeyValueVariant* defaults,
240240
/// @param number_of_defaults Number of elements in the defaults array.
241241
/// @param config_namespace Namespace these default values will be applied
242242
/// to.
243-
void SetDefaults(const ConfigKeyValueVariant* defaults,
244-
size_t number_of_defaults, const char* config_namespace);
243+
///
244+
/// @deprecated Support for configuration values in namespaces is deprecated.
245+
/// You can now only assign configuration values to the default namespace.
246+
/// Please use SetDefaults(defaults, number_of_defaults) instead.
247+
FIREBASE_DEPRECATED void SetDefaults(const ConfigKeyValueVariant* defaults,
248+
size_t number_of_defaults,
249+
const char* config_namespace);
245250
#endif // SWIG
246251

247252
/// @brief Sets the default values based on a string map.
@@ -265,8 +270,13 @@ void SetDefaults(const ConfigKeyValue* defaults, size_t number_of_defaults);
265270
/// @param number_of_defaults Number of elements in the defaults array.
266271
/// @param config_namespace Namespace these default values will be applied
267272
/// to.
268-
void SetDefaults(const ConfigKeyValue* defaults, size_t number_of_defaults,
269-
const char* config_namespace);
273+
///
274+
/// @deprecated Support for configuration values in namespaces is deprecated.
275+
/// You can now only assign configuration values to the default namespace.
276+
/// Please use SetDefaults(defaults, number_of_defaults) instead.
277+
FIREBASE_DEPRECATED void SetDefaults(const ConfigKeyValue* defaults,
278+
size_t number_of_defaults,
279+
const char* config_namespace);
270280

271281
/// @brief Retrieve an internal configuration setting.
272282
///
@@ -308,7 +318,12 @@ bool GetBoolean(const char* key);
308318
///
309319
/// @returns Value associated with the specified key converted to a boolean
310320
/// value.
311-
bool GetBoolean(const char* key, const char* config_namespace);
321+
///
322+
/// @deprecated Support for configuration values in namespaces is deprecated.
323+
/// You can now only retrieve configuration values from the default namespace.
324+
/// Please use GetBoolean(key) instead.
325+
FIREBASE_DEPRECATED bool GetBoolean(const char* key,
326+
const char* config_namespace);
312327

313328
/// @brief Returns the value associated with a key, converted to a bool.
314329
///
@@ -337,7 +352,13 @@ bool GetBoolean(const char* key, ValueInfo* info);
337352
///
338353
/// @returns Value associated with the specified key converted to a boolean
339354
/// value.
340-
bool GetBoolean(const char* key, const char* config_namespace, ValueInfo* info);
355+
///
356+
/// @deprecated Support for configuration values in namespaces is deprecated.
357+
/// You can now only retrieve configuration values from the default namespace.
358+
/// Please use GetBoolean(key, info) instead.
359+
FIREBASE_DEPRECATED bool GetBoolean(const char* key,
360+
const char* config_namespace,
361+
ValueInfo* info);
341362

342363
/// @brief Returns the value associated with a key, converted to a 64-bit
343364
/// integer.
@@ -356,7 +377,12 @@ int64_t GetLong(const char* key);
356377
///
357378
/// @returns Value associated with the specified key converted to a 64-bit
358379
/// integer.
359-
int64_t GetLong(const char* key, const char* config_namespace);
380+
///
381+
/// @deprecated Support for configuration values in namespaces is deprecated.
382+
/// You can now only retrieve configuration values from the default namespace.
383+
/// Please use GetLong(key) instead.
384+
FIREBASE_DEPRECATED int64_t GetLong(const char* key,
385+
const char* config_namespace);
360386

361387
/// @brief Returns the value associated with a key, converted to a 64-bit
362388
/// integer.
@@ -379,7 +405,13 @@ int64_t GetLong(const char* key, ValueInfo* info);
379405
///
380406
/// @returns Value associated with the specified key converted to a 64-bit
381407
/// integer.
382-
int64_t GetLong(const char* key, const char* config_namespace, ValueInfo* info);
408+
///
409+
/// @deprecated Support for configuration values in namespaces is deprecated.
410+
/// You can now only retrieve configuration values from the default namespace.
411+
/// Please use GetLong(key, info) instead.
412+
FIREBASE_DEPRECATED int64_t GetLong(const char* key,
413+
const char* config_namespace,
414+
ValueInfo* info);
383415

384416
/// @brief Returns the value associated with a key, converted to a double.
385417
///
@@ -394,7 +426,12 @@ double GetDouble(const char* key);
394426
/// @param[in] config_namespace Namespace to query for the key.
395427
///
396428
/// @returns Value associated with the specified key converted to a double.
397-
double GetDouble(const char* key, const char* config_namespace);
429+
///
430+
/// @deprecated Support for configuration values in namespaces is deprecated.
431+
/// You can now only retrieve configuration values from the default namespace.
432+
/// Please use GetDouble(key) instead.
433+
FIREBASE_DEPRECATED double GetDouble(const char* key,
434+
const char* config_namespace);
398435

399436
/// @brief Returns the value associated with a key, converted to a double.
400437
///
@@ -413,8 +450,13 @@ double GetDouble(const char* key, ValueInfo* info);
413450
/// value.
414451
///
415452
/// @returns Value associated with the specified key converted to a double.
416-
double GetDouble(const char* key, const char* config_namespace,
417-
ValueInfo* info);
453+
///
454+
/// @deprecated Support for configuration values in namespaces is deprecated.
455+
/// You can now only retrieve configuration values from the default namespace.
456+
/// Please use GetDouble(key, info) instead.
457+
FIREBASE_DEPRECATED double GetDouble(const char* key,
458+
const char* config_namespace,
459+
ValueInfo* info);
418460

419461
/// @brief Returns the value associated with a key, converted to a string.
420462
///
@@ -429,7 +471,12 @@ std::string GetString(const char* key);
429471
/// @param[in] config_namespace Namespace the api lives in
430472
///
431473
/// @return Value as a string associated with the specified key.
432-
std::string GetString(const char* key, const char* config_namespace);
474+
///
475+
/// @deprecated Support for configuration values in namespaces is deprecated.
476+
/// You can now only retrieve configuration values from the default namespace.
477+
/// Please use GetString(key) instead.
478+
FIREBASE_DEPRECATED std::string GetString(const char* key,
479+
const char* config_namespace);
433480

434481
/// @brief Returns the value associated with a key, converted to a string.
435482
///
@@ -446,8 +493,13 @@ std::string GetString(const char* key, ValueInfo* info);
446493
/// @param[in] config_namespace Namespace to query for the key.
447494
/// @param[out] info A return value, specifying the source of the returned
448495
/// value.
449-
std::string GetString(const char* key, const char* config_namespace,
450-
ValueInfo* info);
496+
///
497+
/// @deprecated Support for configuration values in namespaces is deprecated.
498+
/// You can now only retrieve configuration values from the default namespace.
499+
/// Please use GetString(key, info) instead.
500+
FIREBASE_DEPRECATED std::string GetString(const char* key,
501+
const char* config_namespace,
502+
ValueInfo* info);
451503

452504
/// @brief Returns the value associated with a key, as a vector of raw
453505
/// byte-data.
@@ -464,8 +516,12 @@ std::vector<unsigned char> GetData(const char* key);
464516
/// @param[in] config_namespace Namespace to query for the key.
465517
///
466518
/// @returns Vector of bytes.
467-
std::vector<unsigned char> GetData(const char* key,
468-
const char* config_namespace);
519+
///
520+
/// @deprecated Support for configuration values in namespaces is deprecated.
521+
/// You can now only retrieve configuration values from the default namespace.
522+
/// Please use GetData(key) instead.
523+
FIREBASE_DEPRECATED std::vector<unsigned char> GetData(
524+
const char* key, const char* config_namespace);
469525

470526
/// @brief Returns the value associated with a key, as a vector of raw
471527
/// byte-data.
@@ -486,9 +542,12 @@ std::vector<unsigned char> GetData(const char* key, ValueInfo* info);
486542
/// value.
487543
///
488544
/// @returns Vector of bytes.
489-
std::vector<unsigned char> GetData(const char* key,
490-
const char* config_namespace,
491-
ValueInfo* info);
545+
///
546+
/// @deprecated Support for configuration values in namespaces is deprecated.
547+
/// You can now only retrieve configuration values from the default namespace.
548+
/// Please use GetData(key, info) instead.
549+
FIREBASE_DEPRECATED std::vector<unsigned char> GetData(
550+
const char* key, const char* config_namespace, ValueInfo* info);
492551

493552
/// @brief Gets the set of keys that start with the given prefix, in the
494553
/// default namespace.
@@ -511,8 +570,12 @@ std::vector<std::string> GetKeysByPrefix(const char* prefix);
511570
/// @returns Set of Remote Config parameter keys that start with the specified
512571
/// prefix. Will return an empty set if there are no keys with the given
513572
/// prefix.
514-
std::vector<std::string> GetKeysByPrefix(const char* prefix,
515-
const char* config_namespace);
573+
///
574+
/// @deprecated Support for configuration values in namespaces is deprecated.
575+
/// You can now only retrieve configuration keys from the default namespace.
576+
/// Please use GetKeysByPrefix(prefix) instead.
577+
FIREBASE_DEPRECATED std::vector<std::string> GetKeysByPrefix(
578+
const char* prefix, const char* config_namespace);
516579

517580
/// @brief Gets the set of all keys in the default namespace.
518581
///
@@ -524,7 +587,12 @@ std::vector<std::string> GetKeys();
524587
/// @param[in] config_namespace The namespace in which to look up the keys.
525588
///
526589
/// @returns Set of all Remote Config parameter keys in the given namespace.
527-
std::vector<std::string> GetKeys(const char* config_namespace);
590+
///
591+
/// @deprecated Support for configuration values in namespaces is deprecated.
592+
/// You can now only retrieve configuration keys from the default namespace.
593+
/// Please use GetKeys() instead.
594+
FIREBASE_DEPRECATED std::vector<std::string> GetKeys(
595+
const char* config_namespace);
528596

529597
/// @brief Fetches config data from the server.
530598
///

0 commit comments

Comments
 (0)