Interface: IBacklinkService
Defined in: src/types/interfaces/plugin.interface.ts:1647
Backlink service interface.
Remarks
Tracks backlinks from ATProto ecosystem apps (Cosmik, Leaflet, standard.site, Bluesky) that reference Chive eprints. All data is rebuildable from firehose (ATProto compliant).
Since
0.1.0
Methods
createBacklink()
createBacklink(
data):Promise<Backlink>
Defined in: src/types/interfaces/plugin.interface.ts:1654
Creates a new backlink.
Parameters
data
Backlink data
context
string
contextDetail
string
The source record's description, kept apart from its title.
contextLabel
string
The source record's own typed field, when it has one.
relatedUri
string
The end of the source record that is not this eprint, when it names one.
sourceType
sourceUri
string
targetUri
string
Returns
Promise<Backlink>
Created backlink
deleteBacklink()
deleteBacklink(
sourceUri):Promise<void>
Defined in: src/types/interfaces/plugin.interface.ts:1672
Marks a backlink as deleted.
Parameters
sourceUri
string
AT-URI of the source record
Returns
Promise<void>
getBacklinks()
getBacklinks(
targetUri,options?):Promise<{backlinks:Backlink[];cursor:string; }>
Defined in: src/types/interfaces/plugin.interface.ts:1681
Gets backlinks for an eprint.
Parameters
targetUri
string
AT-URI of the eprint
options?
Filter options
cursor
string
limit
number
sourceType
Returns
Promise<{ backlinks: Backlink[]; cursor: string; }>
Backlinks matching criteria
getCounts()
getCounts(
targetUri):Promise<BacklinkCounts>
Defined in: src/types/interfaces/plugin.interface.ts:1696
Gets aggregated backlink counts for an eprint.
Parameters
targetUri
string
AT-URI of the eprint
Returns
Promise<BacklinkCounts>
Aggregated counts
updateCounts()
updateCounts(
targetUri):Promise<void>
Defined in: src/types/interfaces/plugin.interface.ts:1703
Updates cached counts for an eprint.
Parameters
targetUri
string
AT-URI of the eprint
Returns
Promise<void>