Doc: add linkInteractionToken description

Add documentation for the Schema:Popups' linkInteractionToken property
in the EventLogging reducer.

https://meta.wikimedia.org/wiki/Schema:Popups

Bug: T203013
Change-Id: I7fc872beda284ef8639ad036ddeb9efc8581a452
This commit is contained in:
Stephen Niedzielski 2018-09-04 13:46:33 -06:00 committed by Jdlrobson
parent 53d1a2c329
commit 16004549cf
2 changed files with 4 additions and 0 deletions

Binary file not shown.

View file

@ -42,6 +42,10 @@ function getBaseData( bootAction ) {
* * `pageTitleHover` and `namespaceIdHover`; and
* * `previewType` and `perceivedWait`, if a preview has been shown.
*
* The linkInteractionToken is renewed on each new preview dwelling unlike the pageToken which has a
* lifespan tied to the pageview. It is erroneous to use the same linkInteractionToken across
* multiple previews even if the previews are for the same link.
*
* @param {Object} interaction
* @param {Object} actionData Data specific to the action, e.g. see
* {@link module:reducers/eventLogging~createClosingEvent `createClosingEvent`}