com.gu.contentapi.client.model

Block

case class Block(id: String, bodyHtml: String, bodyTextSummary: String, title: Option[String], attributes: Map[String, String], published: Boolean, createdDate: Option[DateTime], firstPublishedDate: Option[DateTime], publishedDate: Option[DateTime], lastModifiedDate: Option[DateTime], contributors: Seq[String], createdBy: Option[User], lastModifiedBy: Option[User], elements: Seq[BlockElement] = immutable.this.Nil) extends Product with Serializable

A block of content.

id

a unique ID

bodyHtml

the HTML body of the block

bodyTextSummary

the textual content of the block, with HTML tags stripped. This will not include any non-textual content such as pullquotes, tweet embeds, etc.

title

the block's title, if it has one

attributes

metadata about the block e.g. this will contain "keyEvent" -> "true" if the block is a key event, or "summary" -> "true" if it is a summary

published

whether this block is currently live

createdDate

the first time this block was created

firstPublishedDate

the first time this block was published

publishedDate

the last time this block was published

lastModifiedDate

the last time this block was modified

contributors

people who contributed to this block

createdBy

person who created this block

lastModifiedBy

person who last modified this block

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Block
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Block(id: String, bodyHtml: String, bodyTextSummary: String, title: Option[String], attributes: Map[String, String], published: Boolean, createdDate: Option[DateTime], firstPublishedDate: Option[DateTime], publishedDate: Option[DateTime], lastModifiedDate: Option[DateTime], contributors: Seq[String], createdBy: Option[User], lastModifiedBy: Option[User], elements: Seq[BlockElement] = immutable.this.Nil)

    id

    a unique ID

    bodyHtml

    the HTML body of the block

    bodyTextSummary

    the textual content of the block, with HTML tags stripped. This will not include any non-textual content such as pullquotes, tweet embeds, etc.

    title

    the block's title, if it has one

    attributes

    metadata about the block e.g. this will contain "keyEvent" -> "true" if the block is a key event, or "summary" -> "true" if it is a summary

    published

    whether this block is currently live

    createdDate

    the first time this block was created

    firstPublishedDate

    the first time this block was published

    publishedDate

    the last time this block was published

    lastModifiedDate

    the last time this block was modified

    contributors

    people who contributed to this block

    createdBy

    person who created this block

    lastModifiedBy

    person who last modified this block

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. val attributes: Map[String, String]

    metadata about the block e.

    metadata about the block e.g. this will contain "keyEvent" -> "true" if the block is a key event, or "summary" -> "true" if it is a summary

  8. val bodyHtml: String

    the HTML body of the block

  9. val bodyTextSummary: String

    the textual content of the block, with HTML tags stripped.

    the textual content of the block, with HTML tags stripped. This will not include any non-textual content such as pullquotes, tweet embeds, etc.

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. val contributors: Seq[String]

    people who contributed to this block

  12. val createdBy: Option[User]

    person who created this block

  13. val createdDate: Option[DateTime]

    the first time this block was created

  14. val elements: Seq[BlockElement]

  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. val firstPublishedDate: Option[DateTime]

    the first time this block was published

  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  19. val id: String

    a unique ID

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  21. val lastModifiedBy: Option[User]

    person who last modified this block

  22. val lastModifiedDate: Option[DateTime]

    the last time this block was modified

  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  24. final def notify(): Unit

    Definition Classes
    AnyRef

  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  26. val published: Boolean

    whether this block is currently live

  27. val publishedDate: Option[DateTime]

    the last time this block was published

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  29. val title: Option[String]

    the block's title, if it has one

  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped