Class PathConfiguration.Location

  • All Implemented Interfaces:

    
    public final class PathConfiguration.Location
    
                        

    Represents the location of the app's path configuration JSON file(s).

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final String getAssetFilePath() The location of the locally bundled configuration file.
      final String getRemoteFileUrl() The location of the remote configuration file on your server.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • PathConfiguration.Location

        PathConfiguration.Location(String assetFilePath, String remoteFileUrl)
    • Method Detail

      • getAssetFilePath

         final String getAssetFilePath()

        The location of the locally bundled configuration file. Providing a local configuration file is highly recommended, so your app's configuration is available immediately at startup. This must be located in the app's assets directory. For example, a configuration located in assets/json/configuration.json would specify the path without the assets prefix: "json/configuration.json".

      • getRemoteFileUrl

         final String getRemoteFileUrl()

        The location of the remote configuration file on your server. This file must be publicly available via a GET request. The file will be automatically downloaded and cached at app startup. This location must be the full url of the JSON file, for example: "https://web.example.com/demo/json/configuration.json"