Class

com.gu.contentapi.client.model

Content

Related Doc: package model

Permalink

case class Content(id: String, sectionId: Option[String], sectionName: Option[String], webPublicationDateOption: Option[DateTime], webTitle: String, webUrl: String, apiUrl: String, fields: Option[Map[String, String]] = None, tags: List[Tag] = Nil, elements: Option[List[Element]], references: List[Reference] = Nil, isExpired: Option[Boolean] = None, blocks: Option[Blocks] = None, rights: Option[Rights] = None, crossword: Option[Crossword] = None) extends ContentType with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, ContentType, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Content
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ContentType
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Content(id: String, sectionId: Option[String], sectionName: Option[String], webPublicationDateOption: Option[DateTime], webTitle: String, webUrl: String, apiUrl: String, fields: Option[Map[String, String]] = None, tags: List[Tag] = Nil, elements: Option[List[Element]], references: List[Reference] = Nil, isExpired: Option[Boolean] = None, blocks: Option[Blocks] = None, rights: Option[Rights] = None, crossword: Option[Crossword] = None)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val apiUrl: String

    Permalink

    Full url on which full information about this content can be found on the content api.

    Full url on which full information about this content can be found on the content api. You need to access this to find, e.g. related content for the item.

    Definition Classes
    ContentContentType
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val blocks: Option[Blocks]

    Permalink
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val crossword: Option[Crossword]

    Permalink
  9. val elements: Option[List[Element]]

    Permalink

    New representation to elements (assets lists) only returns if show-elements("all") or show-elements("image") is specified

    New representation to elements (assets lists) only returns if show-elements("all") or show-elements("image") is specified

    Definition Classes
    ContentContentType
  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. val fields: Option[Map[String, String]]

    Permalink

    Optional field list containing other variable information about this content.

    Optional field list containing other variable information about this content. (see safeFields for a more usable accessor). Fields are only returned if you specify showFields("xxx") on the request with either a comma separated list of fields or "all".

    Note that the set of fields returned vary per item of content, and may vary over time as the api evolves (although we will make every effort to maintain compatibility, we do not promise it).

    Definition Classes
    ContentContentType
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. val id: String

    Permalink

    The id of this item of content: this should always be the path to the item on www.theguardian.com

    The id of this item of content: this should always be the path to the item on www.theguardian.com

    Definition Classes
    ContentContentType
  15. val isExpired: Option[Boolean]

    Permalink

    Set to true if the rights to this content have expired.

    Set to true if the rights to this content have expired. Expired content is only available to internal users.

    Definition Classes
    ContentContentType
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. val references: List[Reference]

    Permalink

    List of references associated with the content.

    List of references associated with the content. References are strings that identify things beyond the content api. A good example is an isbn number, which associates a piece of content with a book.

    Use showReferences passing in the the type of reference you want to see or 'all' to see all references.

    Definition Classes
    ContentContentType
  21. val rights: Option[Rights]

    Permalink
  22. def safeFields: Map[String, String]

    Permalink
    Definition Classes
    ContentType
  23. val sectionId: Option[String]

    Permalink

    Section is usually provided: some content (such as user help information) does not belong to any section so this will be None

    Section is usually provided: some content (such as user help information) does not belong to any section so this will be None

    Definition Classes
    ContentContentType
  24. val sectionName: Option[String]

    Permalink

    The display name of the section.

    The display name of the section. Will be None iff sectionId is None.

    Definition Classes
    ContentContentType
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. val tags: List[Tag]

    Permalink

    List of tags associated with this content.

    List of tags associated with this content.

    Only returned if you specify showTags("xxx") on the request with either a comma separated list of tag types or "all".

    The order of tags is significant; tags towards the top of the list are considered editorially more important than those towards the end.

    Definition Classes
    ContentContentType
  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. lazy val webPublicationDate: DateTime

    Permalink

    The date and time when this content was published to the web.

    The date and time when this content was published to the web. Note that editors can set this field manually so does not necessarily exactly match when it actually appeared on the web. Current convention is that when "significant updates" are made to a story the web publication date is updated.

    Definition Classes
    ContentContentType
  31. val webPublicationDateOption: Option[DateTime]

    Permalink
  32. val webTitle: String

    Permalink

    Short description of this item of content.

    Short description of this item of content.

    Definition Classes
    ContentContentType
  33. val webUrl: String

    Permalink

    Full url on which the content can be found on www.theguardian.com

    Full url on which the content can be found on www.theguardian.com

    Definition Classes
    ContentContentType

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ContentType

Inherited from AnyRef

Inherited from Any

Ungrouped