Merge pull request #52 from talis/ELE-6258-AddMissingElevateEvents

ELE-6258: Add missing Elevate annotation events

topics/event-classes.md

@@ -70,6 +70,8 @@ This page is broken up into sections for different areas of Talis Aspire.
 | `player.view` | A resource was opened in the player by a student. `digitisation.view` is also recorded by the Talis Elevate player when the content has originated from Copyright Clearance. This is in addition to `player.view`. |  [<i class="yes fas fa-check-circle"><span class="sr-only">Available</span></i><br> View definition](timeseries.html#player-view)  |  <i class="no fas fa-times-circle"><span class="sr-only">Not available</span></i>  |
 | `player.view.contributors` <span class="deprecated">DEPRECATED</span> | A resource was opened in the player by a contributor (academic, teaching assistant) |  [<i class="yes fas fa-check-circle"><span class="sr-only">Available</span></i><br> View definition](timeseries.html#player-view-contributors)  |  <i class="no fas fa-times-circle"><span class="sr-only">Not available</span></i>  |
 | `player.annotate.createannotation` | A new annotation (comment thread) was created by a user |  [<i class="yes fas fa-check-circle"><span class="sr-only">Available</span></i><br> View definition](timeseries.html#player-annotate-createannotation)  |  <i class="no fas fa-times-circle"><span class="sr-only">Not available</span></i>  |
+| `player.annotate.createannotation.highlight` | A new highlight annotation was created by a user |  [<i class="yes fas fa-check-circle"><span class="sr-only">Available</span></i><br> View definition](timeseries.html#player-annotate-createannotation)  |  <i class="no fas fa-times-circle"><span class="sr-only">Not available</span></i>  |
+| `player.annotate.createannotation.pin` | A new pindrop annotation was created by a user |  [<i class="yes fas fa-check-circle"><span class="sr-only">Available</span></i><br> View definition](timeseries.html#player-annotate-createannotation)  |  <i class="no fas fa-times-circle"><span class="sr-only">Not available</span></i>  |
 | `player.annotate.createannotation.classcomment` | A new class annotation (comment thread) was created by a user |  [<i class="yes fas fa-check-circle"><span class="sr-only">Available</span></i><br> View definition](timeseries.html#player-annotate-createannotation)  |  <i class="no fas fa-times-circle"><span class="sr-only">Not available</span></i>  |
 | `player.annotate.createannotation.personalnote` | A new personal annotation (private note) was created by a user |  [<i class="yes fas fa-check-circle"><span class="sr-only">Available</span></i><br> View definition](timeseries.html#player-annotate-createannotation)  |  <i class="no fas fa-times-circle"><span class="sr-only">Not available</span></i>  |
 | `player.annotate.createannotation.anonymouscomment` | A new anonymous annotation (comment thread) was created by a user |  [<i class="yes fas fa-check-circle"><span class="sr-only">Available</span></i><br> View definition](timeseries.html#player-annotate-createannotation)  |  <i class="no fas fa-times-circle"><span class="sr-only">Not available</span></i>  |

topics/timeseries.md

@@ -177,11 +177,16 @@ A contributor is a user other than the owner of the content being viewed, and ty
 <br/>
 <a name="player-annotate-createannotation"></a>
 
-### Events with class `player.annotate.createannotation`, `player.annotate.createannotation.classcomment`, `player.annotate.createannotation.personalnote`, `player.annotate.createannotation.anonymouscomment`
+### Events with class `player.annotate.createannotation`, `player.annotate.createannotation.highlight`, `player.annotate.createannotation.pin`, `player.annotate.createannotation.classcomment`, `player.annotate.createannotation.personalnote`, `player.annotate.createannotation.anonymouscomment`
 
 A user has added a comment to a Talis Elevate player resource.
 
-`player.annotate.createannotation` includes a count of events for all of the sub classes `player.annotate.createannotation.classcomment`, `player.annotate.createannotation.personalnote`, `player.annotate.createannotation.anonymouscomment`. Counting all four classes will result in counting events twice.
+A `player.annotate.createannotation` is emitted for every comment created. The sub-class events `player.annotate.createannotation.highlight`, `player.annotate.createannotation.pin`,`player.annotate.createannotation.classcomment`, `player.annotate.createannotation.personalnote`, `player.annotate.createannotation.anonymouscomment` are emitted in addition to the `player.annotate.createannotation` event, to indicate the type of annotation created.
+Each `player.annotate.createannotation` event will be accompanied by:
+- either a `player.annotate.createannotation.highlight` or a `player.annotate.createannotation.pin` event
+- either a `player.annotate.createannotation.classcomment`, a `player.annotate.createannotation.personalnote`, or a `player.annotate.createannotation.anonymouscomment` event
+
+When aggregating event counts, these groups of sub-classes should be treated as distinct sets, to avoid counting the same event multiple times.
 
 Replies to initial comments are counted in a separate event `player.annotate.createreply`.