Skip to main content

Interface: Backlink

Defined in: src/types/interfaces/plugin.interface.ts:1502

Backlink record from an external ATProto application.

Since​

0.1.0

Properties​

containerName?​

readonly optional containerName: string

Defined in: src/types/interfaces/plugin.interface.ts:1580

Name of the record at Backlink.containerUri, where it is indexed.

containerUri?​

readonly optional containerUri: string

Defined in: src/types/interfaces/plugin.interface.ts:1577

A record the source record sits inside.

Remarks​

Semble draws a card within a collection, which is where a reader actually sees it. Resolved at read time from the membership index.

context?​

readonly optional context: string

Defined in: src/types/interfaces/plugin.interface.ts:1526

Optional context (e.g., collection title, post text).

contextDetail?​

readonly optional contextDetail: string

Defined in: src/types/interfaces/plugin.interface.ts:1545

The source record's description, where it has one distinct from its title.

Remarks​

Joined onto the title with a colon -- which is what the Leaflet and standard.site plugins did -- the two read as a single run-on sentence.

contextLabel?​

readonly optional contextLabel: string

Defined in: src/types/interfaces/plugin.interface.ts:1536

A typed field the source record carries alongside its text.

Remarks​

A Margin annotation's motivation, a Cosmik connection's relation. Kept apart from Backlink.context because it is not prose: prefixed onto the text, it reached the eprint page as the opening words of a title.

deleted​

readonly deleted: boolean

Defined in: src/types/interfaces/plugin.interface.ts:1590

Whether the source record has been deleted.

id​

readonly id: number

Defined in: src/types/interfaces/plugin.interface.ts:1506

Internal database ID.

indexedAt​

readonly indexedAt: Date

Defined in: src/types/interfaces/plugin.interface.ts:1585

When this backlink was indexed.

relatedTitle?​

readonly optional relatedTitle: string

Defined in: src/types/interfaces/plugin.interface.ts:1568

Title of the record named by Backlink.relatedUri.

Remarks​

Resolved at read time from Chive's own index, and so present only where the other end is an eprint Chive holds. Not stored beside relatedUri: a copy taken at index time would go stale the first time the paper was retitled.

relatedUri?​

readonly optional relatedUri: string

Defined in: src/types/interfaces/plugin.interface.ts:1557

The other thing the source record joined this eprint to.

Remarks​

A Cosmik connection is an edge between two entities, so a card showing only its note omits half of what the record says. This carries the end that is not this eprint -- an AT-URI where the source named a record, a URL otherwise, since the things connections join are often DOIs or catalogue pages rather than ATProto records.

sourceType​

readonly sourceType: BacklinkSourceType

Defined in: src/types/interfaces/plugin.interface.ts:1516

Type of backlink source.

sourceUri​

readonly sourceUri: string

Defined in: src/types/interfaces/plugin.interface.ts:1511

AT-URI of the source record (e.g., Cosmik collection).

targetUri​

readonly targetUri: string

Defined in: src/types/interfaces/plugin.interface.ts:1521

AT-URI of the target eprint.