Commit b39fbf26 by Alison Hodges

Added five more events with descriptions frm Blades

parent d87fa2ce
...@@ -11,6 +11,9 @@ Change Log ...@@ -11,6 +11,9 @@ Change Log
* - Date * - Date
- Change - Change
* - 05/20/14
- Added descriptions of five video- and problem-related events to the
:ref:`Tracking Logs` chapter.
* - 05/06/14 * - 05/06/14
- Added enrollment event types to the :ref:`Tracking Logs` chapter. - Added enrollment event types to the :ref:`Tracking Logs` chapter.
* - 05/05/14 * - 05/05/14
......
...@@ -493,7 +493,7 @@ The browser emits these events when a user works with a video. ...@@ -493,7 +493,7 @@ The browser emits these events when a user works with a video.
- YouTube ID of the video being watched (for example, FU3fCJNs94Y). - YouTube ID of the video being watched (for example, FU3fCJNs94Y).
* - ``currentTime`` * - ``currentTime``
- float - float
- Time the video was played at, in seconds. - Time the video was played, in seconds.
* - ``speed`` * - ``speed``
- string - string
- Video speed in use: '0.75', '1.0', '1.25', '1.50'. - Video speed in use: '0.75', '1.0', '1.25', '1.50'.
...@@ -552,34 +552,69 @@ playing speed for the video. ...@@ -552,34 +552,69 @@ playing speed for the video.
- -
- The speed that the user selected for the video to play. - The speed that the user selected for the video to play.
.. types needed ``load_video``
-----------------
.. ``load_video`` The browser emits ``load_video`` events when the video is fully rendered and ready to play.
.. -----------------
.. %%TBD ``event`` **Member Fields**:
.. The browser emits ``load_video`` events when . .. list-table::
:widths: 15 15 60
:header-rows: 1
.. ``event`` **Member Fields**: None * - Field
- Type
- Details
* - ``code``
- string
- The YouTube ID of the video being loaded (for example, OEyXaRPEzfM) or
'html5' for html5 video.
.. ``hide_transcript`` ``hide_transcript``
.. ------------------- -------------------
.. %%TBD The browser emits ``hide_transcript`` events when the user clicks **CC** to
suppress display of the video transcript.
.. The browser emits ``hide_transcript`` events when . ``event`` **Member Fields**:
.. ``event`` **Member Fields**: .. list-table::
:widths: 15 15 60
:header-rows: 1
.. ``show_transcript`` * - Field
.. -------------------- - Type
- Details
* - ``code``
- string
- The YouTube ID of the video being loaded (for example, OEyXaRPEzfM) or
'html5' for html5 video.
* - ``currentTime``
- float
- Time the video transcript was hidden, in seconds.
``show_transcript``
--------------------
.. %%TBD The browser emits ``show_transcript`` events when the user clicks **CC** to
display the video transcript.
.. The browser emits ``show_transcript`` events when .
.. ``event`` **Member Fields**: .. list-table::
:widths: 15 15 60
:header-rows: 1
* - Field
- Type
- Details
* - ``code``
- string
- The YouTube ID of the video being loaded (for example, OEyXaRPEzfM) or
'html5' for html5 video.
* - ``currentTime``
- float
- Time the video transcript was displayed, in seconds.
.. _pdf: .. _pdf:
...@@ -1268,16 +1303,27 @@ The server emits ``problem_check_fail`` events when a problem cannot be checked ...@@ -1268,16 +1303,27 @@ The server emits ``problem_check_fail`` events when a problem cannot be checked
- string - string
- 'closed', 'unreset' - 'closed', 'unreset'
.. ``problem_reset`` ``problem_reset``
.. ----------------------------- --------------------
.. no sample to check
.. The browser emits ``problem_reset`` events when a user resets a problem. The browser emits ``problem_reset`` events when a user clicks **Reset** to reset the answer to a problem.
.. %%is this an instructor initiated event?
.. return Logger.log('problem_reset', [_this.answers, response.contents], _this.id); .. return Logger.log('problem_reset', [_this.answers, response.contents], _this.id);
.. **Event Source**: Browser **Event Source**: Browser
.. ``event`` **Member Fields**: None ``event`` **Member Fields**:
.. list-table::
:widths: 15 15 60
:header-rows: 1
* - Field
- Type
- Details
* - ``answers``
- string
- The value reset by the user.
``problem_rescore`` ``problem_rescore``
----------------------------- -----------------------------
...@@ -1512,16 +1558,27 @@ The server emits ``save_problem_success`` events when a problem is saved success ...@@ -1512,16 +1558,27 @@ The server emits ``save_problem_success`` events when a problem is saved success
- dict - dict
- -
.. ``problem_graded`` ``problem_graded``
.. ------------------- -------------------
.. return Logger.log('problem_graded', [_this.answers, response.contents], _this.id);
.. %%TBD The server emits a ``problem_graded`` event each time a user clicks **Check**
for a problem and it is graded successfully.
.. The server emits a ``problem_graded`` event %%% ``event`` **Member Fields**:
.. return Logger.log('problem_graded', [_this.answers, response.contents], _this.id); .. list-table::
:widths: 15 15 60
:header-rows: 1
.. ``event`` **Member Fields**: The ``event`` field delivers the values entered for the problem component in Studio as a string. The display name, problem text, and choices or response field labels are included. * - Field
- Type
- Details
* - ``[answers, contents]``
- array
- ``answers`` provides the value checked by the user. ``contents`` delivers
the HTML entered for the problem in Studio, including the display name,
problem text, and choices or response field labels. The array includes
each problem in a problem component that has multiple problems.
.. _ora: .. _ora:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment