Class SettingsParameters

  • All Implemented Interfaces:

    
    public class SettingsParameters
    
                        

    This Class holds the basic settings parameters There are ApplicationId, deviceID, applicationVersion,backendURL, and version of the server

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
      SettingsParameters(String backendUrl, String applicationId) Constructor for settings parameter.
      SettingsParameters(String backendUrl, String applicationId, String deviceId) Constructor for settings parameter.
      SettingsParameters(String backendUrl, String applicationId, String deviceId, String applicationVersion) Constructor for settings parameter.
      SettingsParameters(String backendUrl, String applicationId, String deviceId, String applicationVersion, String apiKey) Constructor for settings parameter.
      SettingsParameters(Context context, AppConfig appConfig) Constructor for settings parameter.
      SettingsParameters(Context context, AppConfig appConfig, String apiKey) Constructor for settings parameter.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Constructor Detail

      • SettingsParameters

        SettingsParameters(String backendUrl, String applicationId)
        Constructor for settings parameter.
        Parameters:
        backendUrl - the backend Url to the server
        applicationId - the application Id name
      • SettingsParameters

        SettingsParameters(String backendUrl, String applicationId, String deviceId)
        Constructor for settings parameter.
        Parameters:
        backendUrl - the backend Url to the server
        applicationId - the application Id name
        deviceId - the device Id value
      • SettingsParameters

        SettingsParameters(String backendUrl, String applicationId, String deviceId, String applicationVersion)
        Constructor for settings parameter.
        Parameters:
        backendUrl - the backend Url to the server
        applicationId - the application Id name
        deviceId - the device Id value
        applicationVersion - Application Version
      • SettingsParameters

        SettingsParameters(String backendUrl, String applicationId, String deviceId, String applicationVersion, String apiKey)
        Constructor for settings parameter.
        Parameters:
        backendUrl - the backend Url to the server
        applicationId - the application Id name
        deviceId - the device Id value
        applicationVersion - Application Version
        apiKey - the api key
      • SettingsParameters

        SettingsParameters(Context context, AppConfig appConfig)
        Constructor for settings parameter.
        Parameters:
        context - Android application context
        appConfig - AppConfig object
      • SettingsParameters

        SettingsParameters(Context context, AppConfig appConfig, String apiKey)
        Constructor for settings parameter.
        Parameters:
        context - Android application context
        appConfig - AppConfig object
        apiKey - the api key
    • Method Detail

      • equals

         boolean equals(Object obj)
      • getBackendUrl

        @NonNull() String getBackendUrl()

        Get backend Url

        Returns:

        the backendUrl without ending slash(/) character

      • getApplicationVersion

        @Nullable() String getApplicationVersion()

        Get the Service version

        Returns:

        Version of the application

      • getApplicationId

        @NonNull() String getApplicationId()

        Get the application Id

        Returns:

        application Id used

      • getDeviceId

        @Nullable() String getDeviceId()

        Get device Id

        Returns:

        device Id string

      • getSdkVersion

        @NonNull() String getSdkVersion()

        Get BTP sdk version

        Returns:

        BTP sdk version

      • getApiKey

        @Nullable() String getApiKey()

        Get api key

        Returns:

        api key

      • getClientAppId

        @Nullable() String getClientAppId()

        Get client app id

        Returns:

        client app id

      • setApiKey

         void setApiKey(@Nullable() String apiKey)

        Set api key

        Parameters:
        apiKey - value for api key