Package com.batch.android.module

Class BatchModule

    • Constructor Summary

      Constructors 
      Constructor Description
      BatchModule()  

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void batchContextBecameAvailable​(android.content.Context applicationContext)
      Called by Batch as soon as a context is available in the runtimeManager For convenience, the application context is available as a parameter.
      void batchDidStart()
      Called by Batch right after batch start
      NB : Same context and activity that in willStart but with the new state State.READY set
      void batchDidStop()
      Called by Batch right after batch stop
      NB : No context or activity are available
      void batchIsFinishing()
      Called by Batch before switching to State.FINISHING
      NB : Context and activity are still available from the runtimeManager
      void batchWillStart()
      Called by Batch before batch start
      NB : Context & activity are already available from the runtimeManager
      void batchWillStop()
      Called by Batch before switching to State.OFF
      NB : Context is still available from runtimeManager (not activity)
      abstract java.lang.String getId()
      ID of the module
      abstract int getState()
      Should return the state of the module (usually 0 for deactivated, 1 for activated)

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BatchModule

        public BatchModule()

    • Method Detail

      • getId

        public abstract java.lang.String getId()
        ID of the module
        Returns:

      • getState

        public abstract int getState()
        Should return the state of the module (usually 0 for deactivated, 1 for activated)
        Returns:

      • batchContextBecameAvailable

        public void batchContextBecameAvailable​(@NonNull
                                        android.content.Context applicationContext)
        Called by Batch as soon as a context is available in the runtimeManager For convenience, the application context is available as a parameter. LocalBroadcastManager is also up.

      • batchWillStart

        public void batchWillStart()
        Called by Batch before batch start
        NB : Context & activity are already available from the runtimeManager

      • batchDidStart

        public void batchDidStart()
        Called by Batch right after batch start
        NB : Same context and activity that in willStart but with the new state State.READY set

      • batchIsFinishing

        public void batchIsFinishing()
        Called by Batch before switching to State.FINISHING
        NB : Context and activity are still available from the runtimeManager

      • batchWillStop

        public void batchWillStop()
        Called by Batch before switching to State.OFF
        NB : Context is still available from runtimeManager (not activity)

      • batchDidStop

        public void batchDidStop()
        Called by Batch right after batch stop
        NB : No context or activity are available