Constructor Detail

• CfLogModuleEvent.Builder

  CfLogModuleEvent.Builder(String module_id, Integer progress, String action, Object meta, Boolean update_immediately)

Method Detail

• getModule_id

   final String getModule_id()

• setModule_id

   final Unit setModule_id(String module_id)

• getProgress

   final Integer getProgress()

• setProgress

   final Unit setProgress(Integer progress)

• getAction

   final String getAction()

• setAction

   final Unit setAction(String action)

• setModuleId

   final <ERROR CLASS> setModuleId(String module_id)

  setModuleId is required to log moduleId for the module being opened by the user. module Id should be in a string format and must be in accordance to the catalog provided.

• setModuleProgress

   final <ERROR CLASS> setModuleProgress(Integer progress)

  setModuleProgress is required to pass current progress of the module which the user is viewing. Progress value is the percentage complete for the module that needs to passed as an integer.

• setModuleAction

   final <ERROR CLASS> setModuleAction(ModuleLogAction action)

  setModuleAction is required to set the Action type for the module event. SDK provides enum classes to support available log types. 1 main is view. SDK provides 2 approaches to log this event, one being enum type and the other is string type. Below is the function to log type using enum.

• setModuleAction

   final <ERROR CLASS> setModuleAction(String action)

  setModuleAction is required to set the Action type for the module event. SDK provides enum classes to support available log types. 1 main is view. SDK provides 2 approaches to log this event, one being enum type and the other is string type. Below is the function to log type using string. Remember to note that values provided using string should be the same as provided in enum or else the events will be discarded.

• setMeta

   final <ERROR CLASS> setMeta(Object meta)

  You can pass any type of value in setMeta. It is for developer and partners to log additional information with the log that they find would be helpful for logging and providing more context to the log. Default value for the meta is null.

• updateImmediately

   final <ERROR CLASS> updateImmediately(Boolean update_immediately)

  updateImmediately is responsible for updating the values ot the backend immediately. By default this is set to false or whatever the developer has set in the SDK initialisation block. This differs the time for which the logs will be logged, if true, the SDK will log the content instantly and if false it will wait till the end of user session which is whenever the app goes into background.

• build

   final <ERROR CLASS> build()

  build will validate all of the values provided and if passes will call the track function and queue the events based on it's updateImmediately value and also on the user's network resources.