Package 

Class OtaService

  • All Implemented Interfaces:
    
public class OtaService

    Entry point for ota capabilities.

    Initialize with application context and SDKOptions before calling other APIs. Call shutdown or dispose when the feature is no longer needed.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      static synchronized void initialize(Context context, SDKOptions sdkOptions, OtaServiceSettings otaServiceSettings) Initializes the SDK component with the supplied configuration.
      static synchronized void initialize(Context context, SDKOptions sdkOptions) Initializes the SDK component with the supplied configuration.
      static synchronized void shutdown() Stop this service and release all of its resources.
      static synchronized void reset() Clear all existing areas with OTA data.
      static synchronized HomeAreaClient getHomeAreaClient() Gets an instance of HomeAreaClient.
      static synchronized SubRegionAreaClient getSubRegionAreaClient() Gets an instance of SubRegionAreaClient.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • initialize

         static synchronized void initialize(Context context, SDKOptions sdkOptions, OtaServiceSettings otaServiceSettings)

        Initializes the SDK component with the supplied configuration.

        Must be called once before other APIs on this type.

        Parameters:
        context - Android application context; must not be null
        sdkOptions - SDK credentials, cache paths, and device identifiers
        otaServiceSettings - ota service settings

      • initialize

         static synchronized void initialize(Context context, SDKOptions sdkOptions)

        Initializes the SDK component with the supplied configuration.

        Must be called once before other APIs on this type.

        Parameters:
        context - Android application context; must not be null
        sdkOptions - SDK credentials, cache paths, and device identifiers

      • shutdown

         static synchronized void shutdown()

        Stop this service and release all of its resources.

        Ongoing OTA data update would be aborted if there is any. After shutdown() is called, this service eventually stops functioning and future actions on any of its interfaces/clients can lead to undefined behaviors.

      • reset

         static synchronized void reset()

        Clear all existing areas with OTA data.

        Ongoing OTA data update would be aborted if there is any. Note: initialize need be called before calling this method.