Cafeyn Group SDK

core/co.cafeyn.cgs.api.model/Enrichment

Enrichment

sealed class Enrichment

Represents an issue enrichment.

Parameters

issueId

identifier of the issue this enrichment belongs to

page

page number this enrichment belongs to

width

this enrichment width, as a fraction of the page width (0.0 to 1.0)

height

this enrichment height, as a fraction of the page height (0.0 to 1.0)

top

this enrichment top position, as a fraction of the page height (0.0 to 1.0)

left

this enrichment left position, as a fraction of the page width (0.0 to 1.0)

target

this enrichment target: the URL for a Link, the article id for an Article

Inheritors

Types

class Article : Enrichment

Article enrichment A long press on it allows the user to open it

class Link : Enrichment

Link enrichment A click on it allows the user to open it

class Unknown : Enrichment

An enrichment of a type this version of the SDK does not know about. The reader skips it.

Properties

val height: Double

val issueId: IssueId

val left: Double

val target: String

val top: Double

val width: Double

Functions

operator override fun equals(other: Any?): Boolean

Structural, and only within one subtype: discriminating on javaClass rather than on the seven fields alone is what keeps a Link from equalling an Article at the same coordinates, since all three carry an identical field set.

override fun hashCode(): Int

Consistent with equals, subtype included — but keyed on the class name, never the class. Class inherits the identity hash, which is drawn afresh each time the process starts, so folding it in would give a hash that does not survive a restart. String.hashCode is specified, so this one is the same on every run.

override fun toString(): String

Every property, for logs and crash reports.