Skip to main content

Interface: IBacklinkService

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

Backlink service interface.

Remarks​

Tracks backlinks from ATProto ecosystem apps (Semble, Leaflet, WhiteWind, Bluesky) that reference Chive preprints. All data is rebuildable from firehose (ATProto compliant).

Since​

0.1.0

Methods​

createBacklink(data): Promise<Backlink>

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

Creates a new backlink.

Parameters​

data​

Backlink data

context​

string

sourceType​

BacklinkSourceType

sourceUri​

string

targetUri​

string

Returns​

Promise<Backlink>

Created backlink

deleteBacklink(sourceUri): Promise<void>

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

Marks a backlink as deleted.

Parameters​

sourceUri​

string

AT-URI of the source record

Returns​

Promise<void>

getBacklinks(targetUri, options?): Promise<{ backlinks: Backlink[]; cursor: string; }>

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

Gets backlinks for a preprint.

Parameters​

targetUri​

string

AT-URI of the preprint

options?​

Filter options

cursor​

string

limit​

number

sourceType​

BacklinkSourceType

Returns​

Promise<{ backlinks: Backlink[]; cursor: string; }>

Backlinks matching criteria

getCounts()​

getCounts(targetUri): Promise<BacklinkCounts>

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

Gets aggregated backlink counts for a preprint.

Parameters​

targetUri​

string

AT-URI of the preprint

Returns​

Promise<BacklinkCounts>

Aggregated counts

updateCounts()​

updateCounts(targetUri): Promise<void>

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

Updates cached counts for a preprint.

Parameters​

targetUri​

string

AT-URI of the preprint

Returns​

Promise<void>