Packages

trait Event extends ThriftStruct with Product22[EventType, String, Option[String], Option[Long], Int, Option[String], Option[String], Option[Source], Option[String], Option[RenderedAd], Option[BenchmarkData], Option[NetworkOperationData], Option[Long], Option[ScrollDepth], Option[MediaPlayback], Option[AbTestInfo], Option[Interaction], Option[Referrer], Option[Url], Option[Seq[String]], Option[ComponentEvent], Option[Acquisition]] with ValidatingThriftStruct[Event] with Serializable

Prefer the companion object's ophan.thrift.nativeapp.Event.apply for construction if you don't need to specify passthrough fields.

Linear Supertypes
Serializable, ValidatingThriftStruct[Event], HasThriftStructCodec3[Event], Product22[EventType, String, Option[String], Option[Long], Int, Option[String], Option[String], Option[Source], Option[String], Option[RenderedAd], Option[BenchmarkData], Option[NetworkOperationData], Option[Long], Option[ScrollDepth], Option[MediaPlayback], Option[AbTestInfo], Option[Interaction], Option[Referrer], Option[Url], Option[Seq[String]], Option[ComponentEvent], Option[Acquisition]], Product, Equals, ThriftStruct, AnyRef, Any
Known Subclasses
Immutable, Proxy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Event
  2. Serializable
  3. ValidatingThriftStruct
  4. HasThriftStructCodec3
  5. Product22
  6. Product
  7. Equals
  8. ThriftStruct
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def ab: Option[AbTestInfo]

    If populated, this event includes data about ab tests that the user was a member of

  2. abstract def acquisition: Option[Acquisition]

    If populated, this event includes data about an acquisition

  3. abstract def adLoad: Option[RenderedAd]

    Details about a rendered ad.

    Details about a rendered ad. Only applicable if eventType is AD_LOAD.

  4. abstract def ageMs: Int

    DEPRECATED - use ageMsLong instead

    DEPRECATED - use ageMsLong instead

    The i32 type is a 32-bit signed integer, so can only represent up to 2^31 milliseconds (24.9 days) of age without overflow - if a device is offline longer than a month we would get some weird 'future' events.

  5. abstract def ageMsLong: Option[Long]

    This is for reporting offline events.

    This is for reporting offline events.

    The number of milliseconds ago that the event occurred. (We deliberately don't use an absolute timestamp to avoid issues with clocks on mobile devices being incorrect)

    This number should be zero or a positive number, never negative (that would mean in the future!).

    If an event has just happened, set this value to 0.

  6. abstract def attentionMs: Option[Long]

    Attention time spent on this page view in milliseconds Only applicable if eventType is INTERACTION.

  7. abstract def benchmark: Option[BenchmarkData]

    Contains benchmark data.

    Contains benchmark data. Only applicable if eventType is PERFORMANCE.

  8. abstract def componentEvent: Option[ComponentEvent]

    If populated, this event includes data about components

  9. abstract def eventId: String

    Unique id associated with this specific event.

    Unique id associated with this specific event.

    You must make sure this is globally unqiue: ophan will only process one event per eventId.

  10. abstract def eventType: EventType

    The type of this event

  11. abstract def interaction: Option[Interaction]

    If populated, this event includes data about in-app interactions.

  12. abstract def media: Option[MediaPlayback]

    If populated, this event includes data about media playback

  13. abstract def networkOperation: Option[NetworkOperationData]

    Contains performance data for network based operations.

    Contains performance data for network based operations. Only applicable if eventType is NETWORK.

  14. abstract def path: Option[String]

    Represents the page that has been displayed.

    Represents the page that has been displayed. For content pages, this should the exact content api path with a "/" prefix. For other pages, this should be the path of the corresponding web page on theguardian.com.

    This is mandatory if eventType is VIEW.

  15. abstract def previousPath: Option[String]

    DEPRECATED - use referrer The referring path, i.e.

    DEPRECATED - use referrer The referring path, i.e. the path representing a page displyed on the app on which the user clicked a link to arrive at this page.

  16. abstract def pushNotificationId: Option[String]

    An id which we can link back to Pushy.

  17. abstract def referrer: Option[Referrer]

    If populated, contains information about the referrer/previous page in the apps.

  18. abstract def referringSource: Option[Source]

    DEPRECATED - use referrer The means by which the user arrived at this page.

  19. abstract def renderedComponents: Option[Seq[String]]

    If populated, contains information about the components present on the view.

    If populated, contains information about the components present on the view. Only applicable if eventType is VIEW.

  20. abstract def scrollDepth: Option[ScrollDepth]

    Details of how far through a page a user has scrolled Only applicable if eventType is INTERACTION.

  21. abstract def url: Option[Url]

    Represents the url of the page that has been displayed.

    Represents the url of the page that has been displayed. Only applicable if eventType is VIEW.

  22. abstract def viewId: Option[String]

    The id of this page view.

    The id of this page view. Defaults to the same as event Id which is fine for events of type View. However, AD_LOAD events must set this to be the same as the viewId of the of the page view on which this ad is shown.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def _1: EventType
    Definition Classes
    Event → Product22
  5. def _10: Option[RenderedAd]
    Definition Classes
    Event → Product22
  6. def _11: Option[BenchmarkData]
    Definition Classes
    Event → Product22
  7. def _12: Option[NetworkOperationData]
    Definition Classes
    Event → Product22
  8. def _13: Option[Long]
    Definition Classes
    Event → Product22
  9. def _14: Option[ScrollDepth]
    Definition Classes
    Event → Product22
  10. def _15: Option[MediaPlayback]
    Definition Classes
    Event → Product22
  11. def _16: Option[AbTestInfo]
    Definition Classes
    Event → Product22
  12. def _17: Option[Interaction]
    Definition Classes
    Event → Product22
  13. def _18: Option[Referrer]
    Definition Classes
    Event → Product22
  14. def _19: Option[Url]
    Definition Classes
    Event → Product22
  15. def _2: String
    Definition Classes
    Event → Product22
  16. def _20: Option[Seq[String]]
    Definition Classes
    Event → Product22
  17. def _21: Option[ComponentEvent]
    Definition Classes
    Event → Product22
  18. def _22: Option[Acquisition]
    Definition Classes
    Event → Product22
  19. def _3: Option[String]
    Definition Classes
    Event → Product22
  20. def _4: Option[Long]
    Definition Classes
    Event → Product22
  21. def _5: Int
    Definition Classes
    Event → Product22
  22. def _6: Option[String]
    Definition Classes
    Event → Product22
  23. def _7: Option[String]
    Definition Classes
    Event → Product22
  24. def _8: Option[Source]
    Definition Classes
    Event → Product22
  25. def _9: Option[String]
    Definition Classes
    Event → Product22
  26. def _codec: ValidatingThriftStructCodec3[Event]
    Definition Classes
    Event → ValidatingThriftStruct → HasThriftStructCodec3
  27. def _passthroughFields: Map[Short, TFieldBlob]
  28. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  29. def canEqual(other: Any): Boolean
    Definition Classes
    Event → Equals
  30. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  31. def copy(eventType: EventType = this.eventType, eventId: String = this.eventId, viewId: Option[String] = this.viewId, ageMsLong: Option[Long] = this.ageMsLong, ageMs: Int = this.ageMs, path: Option[String] = this.path, previousPath: Option[String] = this.previousPath, referringSource: Option[Source] = this.referringSource, pushNotificationId: Option[String] = this.pushNotificationId, adLoad: Option[RenderedAd] = this.adLoad, benchmark: Option[BenchmarkData] = this.benchmark, networkOperation: Option[NetworkOperationData] = this.networkOperation, attentionMs: Option[Long] = this.attentionMs, scrollDepth: Option[ScrollDepth] = this.scrollDepth, media: Option[MediaPlayback] = this.media, ab: Option[AbTestInfo] = this.ab, interaction: Option[Interaction] = this.interaction, referrer: Option[Referrer] = this.referrer, url: Option[Url] = this.url, renderedComponents: Option[Seq[String]] = this.renderedComponents, componentEvent: Option[ComponentEvent] = this.componentEvent, acquisition: Option[Acquisition] = this.acquisition, _passthroughFields: Map[Short, TFieldBlob] = this._passthroughFields): Event
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def equals(other: Any): Boolean
    Definition Classes
    Event → Equals → AnyRef → Any
  34. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. def getFieldBlob(_fieldId: Short): Option[TFieldBlob]

    Gets a field value encoded as a binary blob using TCompactProtocol.

    Gets a field value encoded as a binary blob using TCompactProtocol. If the specified field is present in the passthrough map, that value is returned. Otherwise, if the specified field is known and not optional and set to None, then the field is serialized and returned.

  37. def getFieldBlobs(ids: TraversableOnce[Short]): Map[Short, TFieldBlob]

    Collects TCompactProtocol-encoded field values according to getFieldBlob into a map.

  38. def hashCode(): Int
    Definition Classes
    Event → AnyRef → Any
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. def productArity: Int
    Definition Classes
    Event → Product22 → Product
  44. def productElement(n: Int): Any
    Definition Classes
    Event → Product22 → Product
  45. def productIterator: Iterator[Any]
    Definition Classes
    Product
  46. def productPrefix: String
    Definition Classes
    Event → Product
  47. def setField(_blob: TFieldBlob): Event

    Sets a field using a TCompactProtocol-encoded binary blob.

    Sets a field using a TCompactProtocol-encoded binary blob. If the field is a known field, the blob is decoded and the field is set to the decoded value. If the field is unknown and passthrough fields are enabled, then the blob will be stored in _passthroughFields.

  48. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  49. def toString(): String
    Definition Classes
    Event → AnyRef → Any
  50. def toTuple: (EventType, String, Option[String], Option[Long], Int, Option[String], Option[String], Option[Source], Option[String], Option[RenderedAd], Option[BenchmarkData], Option[NetworkOperationData], Option[Long], Option[ScrollDepth], Option[MediaPlayback], Option[AbTestInfo], Option[Interaction], Option[Referrer], Option[Url], Option[Seq[String]], Option[ComponentEvent], Option[Acquisition])
  51. def unsetAb: Event
  52. def unsetAcquisition: Event
  53. def unsetAdLoad: Event
  54. def unsetAgeMs: Event
  55. def unsetAgeMsLong: Event
  56. def unsetAttentionMs: Event
  57. def unsetBenchmark: Event
  58. def unsetComponentEvent: Event
  59. def unsetEventId: Event
  60. def unsetEventType: Event

    If the specified field is optional, it is set to None.

    If the specified field is optional, it is set to None. Otherwise, if the field is known, it is reverted to its default value; if the field is unknown, it is removed from the passthroughFields map, if present.

  61. def unsetField(_fieldId: Short): Event

    If the specified field is optional, it is set to None.

    If the specified field is optional, it is set to None. Otherwise, if the field is known, it is reverted to its default value; if the field is unknown, it is removed from the passthroughFields map, if present.

  62. def unsetInteraction: Event
  63. def unsetMedia: Event
  64. def unsetNetworkOperation: Event
  65. def unsetPath: Event
  66. def unsetPreviousPath: Event
  67. def unsetPushNotificationId: Event
  68. def unsetReferrer: Event
  69. def unsetReferringSource: Event
  70. def unsetRenderedComponents: Event
  71. def unsetScrollDepth: Event
  72. def unsetUrl: Event
  73. def unsetViewId: Event
  74. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  76. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  77. def write(_oprot: TProtocol): Unit
    Definition Classes
    Event → ThriftStruct

Inherited from Serializable

Inherited from ValidatingThriftStruct[Event]

Inherited from HasThriftStructCodec3[Event]

Inherited from Product22[EventType, String, Option[String], Option[Long], Int, Option[String], Option[String], Option[Source], Option[String], Option[RenderedAd], Option[BenchmarkData], Option[NetworkOperationData], Option[Long], Option[ScrollDepth], Option[MediaPlayback], Option[AbTestInfo], Option[Interaction], Option[Referrer], Option[Url], Option[Seq[String]], Option[ComponentEvent], Option[Acquisition]]

Inherited from Product

Inherited from Equals

Inherited from ThriftStruct

Inherited from AnyRef

Inherited from Any

Ungrouped