Official Content

RemoteConfig external object allows interacting with a remote configuration service to fetch new configuration values and apply them, and also to read the values for a given configuration.

RemoteConfigEO_Location RemoteConfigEO_Details

Properties

LastSuccessfulFetch property

Indicates the timestamp of the last time the configuration was fetched successfully from the server.

Return value DateTime

Note:

  • if the Remote Configuration Property is set to None, or if the values haven’t been fetched yet, it returns the empty DateTime. If the last fetch resulted in an error, the DateTime returned corresponds to the previous fetch.
  • this property also takes into account fetch operations performed automátically.

LastFetchStatus property

Returns the last fetch status.

Return value FetchStatus

Methods

HasValue method

Returns True if there is a value with the given key (being it a default value or a value fetched from the server), False otherwise.

Return value Boolean
Parameters Key: VarChar(40)

GetStringValue method

Returns the configured value for the given key as a String.

Return value VarChar(200)
Parameters Key: VarChar(40)

Considerations:

  • If the value has been fetched from the server, it returns that value. If not, the default value is returned. If there is no value from the server, nor a default value, the empty String is returned.
  • If the Remote Configuration Provider is set to None, this method returns the empty string.

GetIntegerValue method

Returns the configured value for the given key as a number without decimals.

Return value Numeric(9.0)
Parameters Key: VarChar(40)

Considerations: same consideration as from GetStringValue apply.

GetDecimalValue method

Returns the configured value for the given key as a number with decimals.

Return value Numeric(12.3)
Parameters Key: VarChar(40)

Considerations: same consideration as from GetStringValue apply.

GetBooleanValue method

Returns the configured value for the given key as boolean.

Return value Boolean
Parameters Key: VarChar(40)

Considerations: same consideration as from GetStringValue apply.

GetDateValue method

Returns the configured value for the given key as a date.

Return value Date
Parameters Key: VarChar(40)

Considerations: same consideration as from GetStringValue apply.

GetDatetimeValue

Returns the configured value for the given key as a date-time.

Return value DateTime
Parameters Key: VarChar(40)

Considerations: same consideration as from GetStringValue apply.

Fetch method

Tries to get the values synchronically from the server. Returns True if successful, False otherwise.

Return value Boolean
Parameters (none)

If the Remote Configuration Provider is set to None, this method returns False and finishes immediately.

Apply method

Tries to apply the values fetched by the last fetch operation (being it automatic or manual). Returns True if successful, False otherwise.

Return value Boolean
Parameters (none)

If the Remote Configuration Provider is set to None or if there are no fetched values, this method returns False and finishes immediately.

Domains

FetchStatus domain

Enumerated domain returned by the LastFetchStatus property.

Value Description
None The Fetch operation has never been performed
Sucess The last Fecth operation ended successfuly
Failure The last Fecth operation could not be completed

Code Examples

See the Examples section in Remote Configuration in Native Mobile apps.

Scope

Platforms  Native Mobile (Android, iOS)

Availability

This external object is available as form GeneXus 17 upgrade 4.

See also


Last update: February 2024 | © GeneXus. All rights reserved. GeneXus Powered by Globant