Skip to main content

Interface: Backlink

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:71

Backlink record

Properties​

$type?​

optional $type: "pub.chive.backlink.list#backlink"

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:72


containerName?​

optional containerName: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:102

Name of the record at containerUri, resolved at read time. Absent where the container has not been indexed, in which case the link is still offered without a name.


containerUri?​

optional containerUri: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:100

A record the source record sits inside, where its service renders it there. Semble draws a card inside a collection, which is where a reader actually sees it, so a Semble card names the collection holding it.


context?​

optional context: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:88

Optional context about the backlink


contextDetail?​

optional contextDetail: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:92

The source record's description, where it has one distinct from its title. Kept apart from context so the two are not run together into a single sentence.


contextLabel?​

optional contextLabel: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:90

A typed field the source record carries alongside its text, such as a Margin annotation's motivation or a Cosmik connection's relation. Kept apart from context so a reader is not shown structured data as the opening words of a sentence.


deleted​

deleted: boolean

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:110

Whether the backlink has been deleted


id​

id: number

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:74

Backlink ID


indexedAt​

indexedAt: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:108

Timestamp when the backlink was indexed


relatedTitle?​

optional relatedTitle: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:106

Title of the record named by relatedUri, resolved at read time when that record is an eprint Chive has indexed. Absent for an end Chive does not hold, which is then shown by its address.


relatedUri?​

optional relatedUri: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:104

The other thing the source record joined this eprint to, where it names one. A Cosmik connection is an edge between two entities, so a card that shows only the note omits half of what the record says; this carries the end that is not this eprint, as an AT-URI or a URL.


sourceAvatar?​

optional sourceAvatar: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:98

Avatar of the account the source record belongs to, resolved at read time alongside sourceHandle. Served by the account's own profile service, not by Chive.


sourceDisplayName?​

optional sourceDisplayName: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:96

Display name of the account the source record belongs to, resolved at read time alongside sourceHandle.


sourceHandle?​

optional sourceHandle: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:94

Handle of the account the source record belongs to, resolved at read time. Some applications address a record by its author's handle rather than their DID -- Margin's annotation pages are margin.at/{handle}/annotation/{rkey} and answer "Not found" to a DID -- so a link to the record on its own service cannot be built from the AT-URI alone.


sourceType​

sourceType: string & object | "other" | "cosmik.collection" | "leaflet.list" | "bluesky.post" | "bluesky.embed"

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:78

Type of the source record


sourceUri​

sourceUri: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:76

AT-URI of the source record


targetUri​

targetUri: string

Defined in: web/lib/api/generated/types/pub/chive/backlink/list.ts:86

AT-URI of the target eprint