trait Page extends ThriftStruct with Product9[Url, Option[Set[String]], Option[Platform], Option[String], Option[String], Option[Set[String]], Option[Set[String]], Option[Set[Tag]], Option[Podcast]] with HasThriftStructCodec3[Page] with Serializable

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

Linear Supertypes
Serializable, HasThriftStructCodec3[Page], Product9[Url, Option[Set[String]], Option[Platform], Option[String], Option[String], Option[Set[String]], Option[Set[String]], Option[Set[Tag]], Option[Podcast]], scala.Product, Equals, ThriftStruct, AnyRef, Any
Known Subclasses
Immutable, Proxy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Page
  2. Serializable
  3. HasThriftStructCodec3
  4. Product9
  5. Product
  6. Equals
  7. ThriftStruct
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def campaignCodes: Option[Set[String]]

    The values of all of the CMP and INTCMP parameters

  2. abstract def contentTypes: Option[Set[String]]

    Returns some approximation of the content type, generated by the serving platform.

    Returns some approximation of the content type, generated by the serving platform.

    Currently, next-gen produces a maximum of one entry whereas R2 generates a number of varying entries. Native mobile apps produce nothing. There is little consistency between the strings that the platforms report.

    As a result, you are strongly advised not to make use of this field unless you have a really good reason to do so. It will likely be removed at some point in the future.

  3. abstract def platform: Option[Platform]

    The platform that served this page.

    The platform that served this page. Marked as optional because when new platforms are added and your thrift definition hasn't been updated, this will become empty. *

  4. abstract def podcast: Option[Podcast]

    Additional information for pageviews that refer to a podcast

  5. abstract def publicationDate: Option[String]

    For most content pages, the publication date of the content, in ISO date format "YYYY-MM-DD" e.g.

    For most content pages, the publication date of the content, in ISO date format "YYYY-MM-DD" e.g. 2014-01-20

    Note this is currently extracted from the url, though in the future more advanced techiniques may be used to calculate this data.

    Fronts will never have a publication date.

  6. abstract def renderedComponents: Option[Set[String]]

    The set of component names that were rendered on this page.

    The set of component names that were rendered on this page. Currently only reported by next-gen, this can be used to validate the effectiveness of particular components.

  7. abstract def section: Option[String]

    The section id of the page.

    The section id of the page.

    Network front pages (e.g. "/uk") are assigned to a section named "/" (a single slash).

    Note this is currently extracted from the url, though in the future more advanced techiniques may be used to caluclate this data.

    Will always be undefined for non www.theguardian.com urls.

  8. abstract def tags: Option[Set[Tag]]

    The set of tags that were rendered on this page.

    The set of tags that were rendered on this page. This field is being tracked from June 2016.

  9. abstract def url: Url

    Url of the page served

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: Url
    Definition Classes
    Page → Product9
  5. def _2: Option[Set[String]]
    Definition Classes
    Page → Product9
  6. def _3: Option[Platform]
    Definition Classes
    Page → Product9
  7. def _4: Option[String]
    Definition Classes
    Page → Product9
  8. def _5: Option[String]
    Definition Classes
    Page → Product9
  9. def _6: Option[Set[String]]
    Definition Classes
    Page → Product9
  10. def _7: Option[Set[String]]
    Definition Classes
    Page → Product9
  11. def _8: Option[Set[Tag]]
    Definition Classes
    Page → Product9
  12. def _9: Option[Podcast]
    Definition Classes
    Page → Product9
  13. def _codec: ThriftStructCodec3[Page]
    Definition Classes
    Page → HasThriftStructCodec3
  14. def _passthroughFields: Map[Short, TFieldBlob]
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def canEqual(other: Any): Boolean
    Definition Classes
    Page → Equals
  17. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  18. def copy(url: Url = this.url, campaignCodes: Option[Set[String]] = this.campaignCodes, platform: Option[Platform] = this.platform, section: Option[String] = this.section, publicationDate: Option[String] = this.publicationDate, contentTypes: Option[Set[String]] = this.contentTypes, renderedComponents: Option[Set[String]] = this.renderedComponents, tags: Option[Set[Tag]] = this.tags, podcast: Option[Podcast] = this.podcast, _passthroughFields: Map[Short, TFieldBlob] = this._passthroughFields): Page
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(other: Any): Boolean
    Definition Classes
    Page → Equals → AnyRef → Any
  21. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. 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.

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

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

  25. def hashCode(): Int
    Definition Classes
    Page → AnyRef → Any
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. def productArity: Int
    Definition Classes
    Page → Product9 → Product
  31. def productElement(n: Int): Any
    Definition Classes
    Page → Product9 → Product
  32. def productIterator: Iterator[Any]
    Definition Classes
    Product
  33. def productPrefix: String
    Definition Classes
    Page → Product
  34. def setField(_blob: TFieldBlob): Page

    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.

  35. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    Page → AnyRef → Any
  37. def toTuple: (Url, Option[Set[String]], Option[Platform], Option[String], Option[String], Option[Set[String]], Option[Set[String]], Option[Set[Tag]], Option[Podcast])
  38. def unsetCampaignCodes: Page
  39. def unsetContentTypes: Page
  40. def unsetField(_fieldId: Short): Page

    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.

  41. def unsetPlatform: Page
  42. def unsetPodcast: Page
  43. def unsetPublicationDate: Page
  44. def unsetRenderedComponents: Page
  45. def unsetSection: Page
  46. def unsetTags: Page
  47. def unsetUrl: Page

    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.

  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  51. def write(_oprot: TProtocol): Unit
    Definition Classes
    Page → ThriftStruct

Inherited from Serializable

Inherited from HasThriftStructCodec3[Page]

Inherited from Product9[Url, Option[Set[String]], Option[Platform], Option[String], Option[String], Option[Set[String]], Option[Set[String]], Option[Set[Tag]], Option[Podcast]]

Inherited from scala.Product

Inherited from Equals

Inherited from ThriftStruct

Inherited from AnyRef

Inherited from Any

Ungrouped