Tag

Abstract Value Members

abstract def activeSponsorships: Option[Seq[Sponsorship]]

The currently active sponsorships for this tag
abstract def adBlockingLevel: Option[BlockingLevel]

Blocking level used to block ads when a tag is applied to content
abstract def campaignInformation: Option[CampaignInformation]

Any campaigninformation associated with this tag
abstract def capiSectionId: Option[String]

CAPI specific field containing their section id
abstract def comparableValue: String

The natural sort key used for ordering tag lists, puts surname first, removes 'the' etc.
abstract def contributionBlockingLevel: Option[BlockingLevel]

Blocking level used to block reader revenue asks when a tag is applied to content
abstract def contributorInformation: Option[ContributorInformation]

Any Contributor Information associated with this tag
abstract def description: Option[String]

a description of the tag, rendered on tag pages, this could be a topic precis or a contributor's profile
abstract def expired: Boolean

is this tag expired - only set to true on paid content tags
abstract def externalName: String

the publicly displayed name for the tag
abstract def footballCrest: Option[Image]

Football crest image
abstract def hidden: Boolean

the tag is not displayed on the site if hidden is true
abstract def id: Long

the id of the tag
abstract def internalName: String

the internal label for the tag
abstract def isMicrosite: Boolean

Is this tag a microsite tag? (In a microsite section when migrated)
abstract def legallySensitive: Boolean

legally sensitive tags surpress content showing related content and showing up in related content results
abstract def pageId: Long

the page id for the path as asigned by the path manager
abstract def paidContentInformation: Option[PaidContentInformation]

Any other paid content data for this tag
abstract def parents: Set[Long]

a set of parent tag ids.
a set of parent tag ids. NB a tag can have multiple parents, but more often the set will be empty
abstract def path: String

the path of the canonical page for this tag - also used as api identifier
abstract def podcastMetadata: Option[PodcastMetadata]

Any Podcast Metadata associated with this tag
abstract def publication: Option[Long]

the id of the publication this tag belongs to, generally used for newspaper_book type tags
abstract def publicationInformation: Option[PublicationInformation]

Any Publication Information associated with this tag (Only for Publication Tags)
abstract def references: Seq[Reference]

the reference mappings for this tag
abstract def section: Option[Long]

the id of the section this tag belongs to, if missing the tag is in the 'Global' pseudosection
abstract def slug: String

the tag owned url slug, the path is derived from this, the section and the tag type
abstract def sponsorshipId: Option[Long]

the id of the sponsorship for a paid content tag, for internal use external consumers should only use the activeSponsorships data
abstract def trackingInformation: Option[TrackingInformation]

Any trackinginformation associated with this tag
abstract def type: TagType

the type of this tag
abstract def updatedAt: Option[Long]

The time at which this tag was last updated

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
def _1: Long
def _10: String
def _11: Option[Long]
def _12: Option[Long]
def _13: Option[String]
def _14: Set[Long]
def _15: Seq[Reference]
def _16: Option[PodcastMetadata]
def _17: Option[ContributorInformation]
def _18: Option[PublicationInformation]
def _19: Boolean
def _2: String
def _20: Option[String]
def _21: Option[TrackingInformation]
def _22: Option[Long]
def _23: Option[Seq[Sponsorship]]
def _24: Option[Long]
def _25: Boolean
def _26: Option[PaidContentInformation]
def _27: Option[CampaignInformation]
def _28: Option[Image]
def _29: Option[BlockingLevel]
def _3: Long
def _30: Option[BlockingLevel]
def _4: TagType
def _5: String
def _6: String
def _7: String
def _8: Boolean
def _9: Boolean
def _codec: ValidatingThriftStructCodec3[Tag]

Definition Classes
Tag → ValidatingThriftStruct → HasThriftStructCodec3
def _passthroughFields: Map[Short, TFieldBlob]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def canEqual(other: Any): Boolean

Definition Classes
Tag → Equals
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def copy(id: Long = this.id, path: String = this.path, pageId: Long = this.pageId, type: TagType = this.`type`, internalName: String = this.internalName, externalName: String = this.externalName, slug: String = this.slug, hidden: Boolean = this.hidden, legallySensitive: Boolean = this.legallySensitive, comparableValue: String = this.comparableValue, section: Option[Long] = this.section, publication: Option[Long] = this.publication, description: Option[String] = this.description, parents: Set[Long] = this.parents, references: Seq[Reference] = this.references, podcastMetadata: Option[PodcastMetadata] = this.podcastMetadata, contributorInformation: Option[ContributorInformation] = this.contributorInformation, publicationInformation: Option[PublicationInformation] = this.publicationInformation, isMicrosite: Boolean = this.isMicrosite, capiSectionId: Option[String] = this.capiSectionId, trackingInformation: Option[TrackingInformation] = this.trackingInformation, updatedAt: Option[Long] = this.updatedAt, activeSponsorships: Option[Seq[Sponsorship]] = this.activeSponsorships, sponsorshipId: Option[Long] = this.sponsorshipId, expired: Boolean = this.expired, paidContentInformation: Option[PaidContentInformation] = this.paidContentInformation, campaignInformation: Option[CampaignInformation] = this.campaignInformation, footballCrest: Option[Image] = this.footballCrest, adBlockingLevel: Option[BlockingLevel] = this.adBlockingLevel, contributionBlockingLevel: Option[BlockingLevel] = this.contributionBlockingLevel, _passthroughFields: Map[Short, TFieldBlob] = this._passthroughFields): Tag
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(other: Any): Boolean

Definition Classes
Tag → Equals → AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
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.
def getFieldBlobs(ids: TraversableOnce[Short]): Map[Short, TFieldBlob]

Collects TCompactProtocol-encoded field values according to getFieldBlob into a map.
def hashCode(): Int

Definition Classes
Tag → AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def productArity: Int

Definition Classes
Tag → Product
def productElement(n: Int): Any

Definition Classes
Tag → Product
def productIterator: Iterator[Any]

Definition Classes
Product
def productPrefix: String

Definition Classes
Tag → Product
def setField(_blob: TFieldBlob): Tag

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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Tag → AnyRef → Any
def unsetActiveSponsorships: Tag
def unsetAdBlockingLevel: Tag
def unsetCampaignInformation: Tag
def unsetCapiSectionId: Tag
def unsetComparableValue: Tag
def unsetContributionBlockingLevel: Tag
def unsetContributorInformation: Tag
def unsetDescription: Tag
def unsetExpired: Tag
def unsetExternalName: Tag
def unsetField(_fieldId: Short): Tag

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.
def unsetFootballCrest: Tag
def unsetHidden: Tag
def unsetId: Tag

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.
def unsetInternalName: Tag
def unsetIsMicrosite: Tag
def unsetLegallySensitive: Tag
def unsetPageId: Tag
def unsetPaidContentInformation: Tag
def unsetParents: Tag
def unsetPath: Tag
def unsetPodcastMetadata: Tag
def unsetPublication: Tag
def unsetPublicationInformation: Tag
def unsetReferences: Tag
def unsetSection: Tag
def unsetSlug: Tag
def unsetSponsorshipId: Tag
def unsetTrackingInformation: Tag
def unsetType: Tag
def unsetUpdatedAt: Tag
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def write(_oprot: TProtocol): Unit

Definition Classes
Tag → ThriftStruct

Related Docs: object Tag | package tagmanagement

trait Tag extends ThriftStruct with Product with ValidatingThriftStruct[Tag] with Serializable

Abstract Value Members

abstract def activeSponsorships: Option[Seq[Sponsorship]]

abstract def adBlockingLevel: Option[BlockingLevel]

abstract def campaignInformation: Option[CampaignInformation]

abstract def capiSectionId: Option[String]

abstract def comparableValue: String

abstract def contributionBlockingLevel: Option[BlockingLevel]

abstract def contributorInformation: Option[ContributorInformation]

abstract def description: Option[String]

abstract def expired: Boolean

abstract def externalName: String

abstract def footballCrest: Option[Image]

abstract def hidden: Boolean

abstract def id: Long

abstract def internalName: String

abstract def isMicrosite: Boolean

abstract def legallySensitive: Boolean

abstract def pageId: Long

abstract def paidContentInformation: Option[PaidContentInformation]

abstract def parents: Set[Long]

abstract def path: String

abstract def podcastMetadata: Option[PodcastMetadata]

abstract def publication: Option[Long]

abstract def publicationInformation: Option[PublicationInformation]

abstract def references: Seq[Reference]

abstract def section: Option[Long]

abstract def slug: String

abstract def sponsorshipId: Option[Long]

abstract def trackingInformation: Option[TrackingInformation]

abstract def type: TagType

abstract def updatedAt: Option[Long]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def _1: Long

def _10: String

def _11: Option[Long]

def _12: Option[Long]

def _13: Option[String]

def _14: Set[Long]

def _15: Seq[Reference]

def _16: Option[PodcastMetadata]

def _17: Option[ContributorInformation]

def _18: Option[PublicationInformation]

def _19: Boolean

def _2: String

def _20: Option[String]

def _21: Option[TrackingInformation]

def _22: Option[Long]

def _23: Option[Seq[Sponsorship]]

def _24: Option[Long]

def _25: Boolean

def _26: Option[PaidContentInformation]

def _27: Option[CampaignInformation]

def _28: Option[Image]

def _29: Option[BlockingLevel]

def _3: Long

def _30: Option[BlockingLevel]

def _4: TagType

def _5: String

def _6: String

def _7: String

def _8: Boolean

def _9: Boolean

def _codec: ValidatingThriftStructCodec3[Tag]

def _passthroughFields: Map[Short, TFieldBlob]

final def asInstanceOf[T0]: T0

def canEqual(other: Any): Boolean

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(other: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getFieldBlob(_fieldId: Short): Option[TFieldBlob]

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

def hashCode(): Int