Package com.eidu.integration

Class RunLearningUnitResult

java.lang.Object
com.eidu.integration.RunLearningUnitResult
public class RunLearningUnitResult extends Object
This class represents the result of a learning unit run and should be used to deliver the result to the EIDU app.

Depending on how the run ended, this class can be instantiated with one of the methods ofSuccess(java.lang.Float, long, java.lang.String, java.util.List<com.eidu.integration.ResultItem>), ofAbort(java.lang.Float, long, java.lang.String, java.util.List<com.eidu.integration.ResultItem>), ofTimeoutInactivity(java.lang.Float, long, java.lang.String, java.util.List<com.eidu.integration.ResultItem>), ofTimeUp(java.lang.Float, long, java.lang.String, java.util.List<com.eidu.integration.ResultItem>), ofError(java.lang.Float, long, java.lang.String, java.lang.String, java.util.List<com.eidu.integration.ResultItem>).

Then, toIntent() should be used to instantiate an Intent to be passed to Activity.setResult(int, Intent) before finishing the activity.

  • Field Details

    • version

      public final int version

    • resultType

      @NonNull public final RunLearningUnitResult.ResultType resultType
      The reason why this run ended.

    • score

      @Nullable public final Float score
      Optional. A score between 0.0f and 1.0f that describes how the learner did up to the point in time when the unit ended. value of 0.0f should indicate that the learner gave only incorrect answers, whereas a value of 1.0f should indicate the the learner gave only correct answers.

      In case the nature of the learning unit was such that there was no possibility to give an incorrect answer, the score must be 1.0f.

      Only in case it's impossible to compute a meaningful score may this value be null. Learning app developers are strongly encouraged to try hard to compute meaningful scores in as many cases as possible, in order to provide the maximum amount of information for personalisation and analytics.

    • foregroundDurationInMs

      public final long foregroundDurationInMs
      The amount of time that the user spent with the learning unit at the end of the run. This must exclude any amount of time that the learning app was in the background (because the user navigated away from it, for example using the Android home button or because a different app forced itself into the foreground), and it should exclude time spent for loading and any transition animations.

    • additionalData

      @Nullable public final String additionalData
      Optional. An arbitrary string that the learning app would like to associate with the usage data that the EIDU app reports. It will be made available to the learning app manufacturer for data analysis purposes. It must not contain any sensitive data (e.g. device identifiers).

      This is useful because learning apps should not rely on (and should not attempt to take advantage of) Internet connectivity.

    • errorDetails

      @Nullable public final String errorDetails
      Optional. If resultType is RunLearningUnitResult.ResultType.Error, this should contain any available diagnostic information, e.g. an exception with a stack trace.

      This information will be reported to EIDU for diagnostic purposes. It must not contain any sensitive data (e.g. device identifiers).

    • items

      @Nullable public final List<ResultItem> items
      Optional. A list of items describing the user interactions during a learning unit run in detail. See the documentation of ResultItem for details.

      Note that a null value signifies that no sensible representation of interactions is available, whereas an empty list signifies that no interactions occurred.

  • Method Details