Class PathConfiguration
-
- All Implemented Interfaces:
public final class PathConfigurationProvides the ability to load, parse, and retrieve url path properties from the app's JSON configuration file.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classPathConfiguration.LocationRepresents the location of the app's path configuration JSON file(s).
public final classPathConfiguration.LoaderOptionsLoader options when fetching remote path configuration files from your server.
-
Method Summary
Modifier and Type Method Description final StateFlow<PathConfigurationLoadState>getLoadState()A StateFlow that emits the current state of the path configuration loading process. final HashMap<String, Object>getSettings()Gets the top-level settings specified in the app's path configuration. final Unitload(Context context, PathConfiguration.Location location, PathConfiguration.LoaderOptions options)Loads and parses the specified configuration file(s) from their local and/or remote locations. final HashMap<String, Object>properties(String location)Retrieve the path properties based on the cascading rules in your path configuration. -
-
Method Detail
-
getLoadState
final StateFlow<PathConfigurationLoadState> getLoadState()
A StateFlow that emits the current state of the path configuration loading process. Observe this to know when the configuration has been loaded and from which source (bundled asset, cached remote, or fresh remote).
-
getSettings
final HashMap<String, Object> getSettings()
Gets the top-level settings specified in the app's path configuration. The settings are map of key/value
Stringitems.
-
load
final Unit load(Context context, PathConfiguration.Location location, PathConfiguration.LoaderOptions options)
Loads and parses the specified configuration file(s) from their local and/or remote locations.
-
properties
final HashMap<String, Object> properties(String location)
Retrieve the path properties based on the cascading rules in your path configuration.
- Parameters:
location- The absolute url to match against the configuration's rules.- Returns:
The map of key/value
Stringproperties
-
-
-
-