trait Event extends ThriftStruct with scala.Product with HasThriftStructCodec3[Event] with Serializable

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

Linear Supertypes
Serializable, HasThriftStructCodec3[Event], scala.Product, Equals, ThriftStruct, AnyRef, Any
Known Subclasses
Immutable, Proxy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Event
  2. Serializable
  3. HasThriftStructCodec3
  4. Product
  5. Equals
  6. ThriftStruct
  7. AnyRef
  8. 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]

    Acquisition of one of our current products, eg Contribution, Membership, Reccuring Contribution

  3. abstract def ads: Option[AdInfo]

    If populated, this event includes advertising-related information

  4. abstract def altIds: Option[AltIds]

    Various other identifiers we may have to identify this user.

  5. abstract def attention: Option[AttentionTime]

    If populated, this event includes attention time data.

    If populated, this event includes attention time data. Note this will also be populated, typically with a value of zero, alongside a pageView value for page views generated by platforms that support attention time tracking.

  6. abstract def browserId: AssignedId

    The unqiue id associated with this browser.

    The unqiue id associated with this browser. Currently this is maintained by setting a cookie for web events, or otherwise determined for native apps.

  7. abstract def componentEvent: Option[ComponentEvent]

    An event relating to a component e.g.

    An event relating to a component e.g. a user clicking on the contribution CTA of an Epic component e.g. an Atom component being inserted into a page

  8. abstract def dt: Long

    The date time (in millis since epoch UTC) at which this event occurred.

  9. abstract def inPageClick: Option[InPageClick]

    If populated, this event includes data about a click that did not result in a page transition

  10. abstract def inPrivateBrowsingMode: Option[Boolean]

    Is this browser in private browsing mode?

    Is this browser in private browsing mode?

    i.e. incognito mode in Google Chrome = true

  11. abstract def interaction: Option[Interaction]

    If populated, includes data about in-page interactions.

  12. abstract def ipConnectivity: Option[IpConnectivity]

    If populated, includes data about IPv6 connectivity

  13. abstract def lazyComponents: Option[LazyComponents]

    If populated, this event includes data about components that were lazily loaded.

  14. abstract def media: Option[MediaPlayback]

    If populated, this event includes data about media playback

  15. abstract def outbrain: Option[Outbrain]

    If populated, indicates which Outbrain widget appeared on a page

  16. abstract def pageView: Option[PageView]

    If populated, this event represents a page view.

  17. abstract def pageViewId: String

    The page view for which this event is associated.

    The page view for which this event is associated. Ophan may send multiple events relating to the same page view, which may contain updates to any previously supplied data or new data. You should treat the one with the highest timestamp (dt) as the most accurate.

  18. abstract def perf: Option[WebPerformanceData]

    If populated, this event includes web performance load information

  19. abstract def quizEvent: Option[QuizEvent]

    If populated, this event includes data about a quiz event.

  20. abstract def receivedDt: Long

    The date time (in millis since epoc UTC) at which this event was received by ophan for processing.

    The date time (in millis since epoc UTC) at which this event was received by ophan for processing. For web generated events, this is the same as dt. For native mobile app generated events, it might not be.

  21. abstract def uniqueEventId: String

    Gloablly unique id associated with this event.

    Gloablly unique id associated with this event. Ophan never makes better than at-least-once delivery promises, so you must ensure that processing two events with the same uniqueEventId has no effect

  22. abstract def userId: Option[String]

    If the user is logged in, the identity user id.

    If the user is logged in, the identity user id. *

  23. abstract def visitId: Option[AssignedId]

    The unique id associated with this "visit".

    The unique id associated with this "visit". For web reports, the visit id is a refreshed session cookie that expires after 30 minutes of activity. Mobile apps do not currently set this value.

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: String
  5. def _10: Option[AttentionTime]
  6. def _11: Option[AdInfo]
  7. def _12: Option[WebPerformanceData]
  8. def _13: Option[MediaPlayback]
  9. def _14: Option[AbTestInfo]
  10. def _15: Option[LazyComponents]
  11. def _16: Option[QuizEvent]
  12. def _17: Option[InPageClick]
  13. def _18: Option[Outbrain]
  14. def _19: Option[Interaction]
  15. def _2: Long
  16. def _20: Option[Boolean]
  17. def _21: Option[IpConnectivity]
  18. def _22: Option[Acquisition]
  19. def _23: Option[ComponentEvent]
  20. def _3: Long
  21. def _4: String
  22. def _5: AssignedId
  23. def _6: Option[AssignedId]
  24. def _7: Option[String]
  25. def _8: Option[AltIds]
  26. def _9: Option[PageView]
  27. def _codec: ThriftStructCodec3[Event]
    Definition Classes
    Event → HasThriftStructCodec3
  28. def _passthroughFields: Map[Short, TFieldBlob]
  29. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  30. def canEqual(other: Any): Boolean
    Definition Classes
    Event → Equals
  31. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  32. def copy(uniqueEventId: String = this.uniqueEventId, dt: Long = this.dt, receivedDt: Long = this.receivedDt, pageViewId: String = this.pageViewId, browserId: AssignedId = this.browserId, visitId: Option[AssignedId] = this.visitId, userId: Option[String] = this.userId, altIds: Option[AltIds] = this.altIds, pageView: Option[PageView] = this.pageView, attention: Option[AttentionTime] = this.attention, ads: Option[AdInfo] = this.ads, perf: Option[WebPerformanceData] = this.perf, media: Option[MediaPlayback] = this.media, ab: Option[AbTestInfo] = this.ab, lazyComponents: Option[LazyComponents] = this.lazyComponents, quizEvent: Option[QuizEvent] = this.quizEvent, inPageClick: Option[InPageClick] = this.inPageClick, outbrain: Option[Outbrain] = this.outbrain, interaction: Option[Interaction] = this.interaction, inPrivateBrowsingMode: Option[Boolean] = this.inPrivateBrowsingMode, ipConnectivity: Option[IpConnectivity] = this.ipConnectivity, acquisition: Option[Acquisition] = this.acquisition, componentEvent: Option[ComponentEvent] = this.componentEvent, _passthroughFields: Map[Short, TFieldBlob] = this._passthroughFields): Event
  33. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def equals(other: Any): Boolean
    Definition Classes
    Event → Equals → AnyRef → Any
  35. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  37. 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.

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

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

  39. def hashCode(): Int
    Definition Classes
    Event → AnyRef → Any
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. def productArity: Int
    Definition Classes
    Event → Product
  45. def productElement(n: Int): Any
    Definition Classes
    Event → Product
  46. def productIterator: Iterator[Any]
    Definition Classes
    Product
  47. def productPrefix: String
    Definition Classes
    Event → Product
  48. 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.

  49. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  50. def toString(): String
    Definition Classes
    Event → AnyRef → Any
  51. def unsetAb: Event
  52. def unsetAcquisition: Event
  53. def unsetAds: Event
  54. def unsetAltIds: Event
  55. def unsetAttention: Event
  56. def unsetBrowserId: Event
  57. def unsetComponentEvent: Event
  58. def unsetDt: Event
  59. 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.

  60. def unsetInPageClick: Event
  61. def unsetInPrivateBrowsingMode: Event
  62. def unsetInteraction: Event
  63. def unsetIpConnectivity: Event
  64. def unsetLazyComponents: Event
  65. def unsetMedia: Event
  66. def unsetOutbrain: Event
  67. def unsetPageView: Event
  68. def unsetPageViewId: Event
  69. def unsetPerf: Event
  70. def unsetQuizEvent: Event
  71. def unsetReceivedDt: Event
  72. def unsetUniqueEventId: 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.

  73. def unsetUserId: Event
  74. def unsetVisitId: Event
  75. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  76. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  77. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  78. def write(_oprot: TProtocol): Unit
    Definition Classes
    Event → ThriftStruct

Inherited from Serializable

Inherited from HasThriftStructCodec3[Event]

Inherited from scala.Product

Inherited from Equals

Inherited from ThriftStruct

Inherited from AnyRef

Inherited from Any

Ungrouped