Read what the reader has read
folio_readsRead the reader's read record to tell whether they have seen a passage or what is new on a page. Returns documents read under a folder, or a document's blocks with the versions read and the marks its page shows.
Instructions
Read the reader's read record. For a folder, or with no path, every document read under it and when it was last read; for a document, each block with the version the reader read and when, and the marks its page shows. Use it to tell whether the reader has seen a passage or what is new to them on a page; for the list of documents changed since read use folio_changes. It reveals the reader's reading. While the reader pauses sharing in Folio, it answers only {paused: true, message}. Answers {documents: [{path, at: ISO time}]} for a folder, or for a document {blocks: [{id, kind, source, lines, version, read: {version, at: ISO time} or null}], marks: [{source, id, mark: new or changed, before and after: the text as read and as it is, data: embeds whose data changed - a mark from data alone has no before or after, at: ISO time, parts: the rows, items or lines marked in a table, list or code block}], removed: [{source, id, text, after and before: the ids it stood between, at: ISO time}], links: [{source, id, url, state: changed or gone}], upstream: [{path, how, at}], version}. A list cut to fit one answer adds omitted, the entries each list left out, and narrow, how to ask for less.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | A document, relative to the served folder or absolute under it, such as notes/plan.md, or a folder ending in /; omit for every document read |