Package 

Class UpdateRequest

  • All Implemented Interfaces:
    
public class UpdateRequest
extends OtaRequest<REQ, RESP>

    Data class that represents a home area OTA data update request.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public class UpdateRequest.Builder

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      GeoPoint getCurrentLocation() Get the user's current location.
      Integer getTimeout() Get the maximal time(in seconds) allowed for this OTA data update to finish.
      AreaStatus execute() Executes a sync call to update the home area with OTA data.
      void asyncCall(Callback<AreaStatus> callback) Executes an async call to update the home area with OTA data.
      void cancel() Attempts to cancel the committed call.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getTimeout

         Integer getTimeout()

        Get the maximal time(in seconds) allowed for this OTA data update to finish.

        Adm service would aborts this OTA data update if its total time cost reaches this threshold. By default this setting's value is 1800 seconds(30 minutes).

      • execute

         AreaStatus execute()

        Executes a sync call to update the home area with OTA data.

      • asyncCall

         void asyncCall(Callback<AreaStatus> callback)

        Executes an async call to update the home area with OTA data.

        Parameters:
        callback - the Callback to fetch the response of the call

      • cancel

         void cancel()

        Attempts to cancel the committed call.