ChannelHostReads
ChannelHostReads =
object
Defined in: types/channel-types/index.ts:341
Read-only introspection getters the core injects for a channel that exposes an
API/UI (the HTTP surface today). Every getter reads state that already exists
in-process — nothing computes anything new — so these can’t come from env.
Returns are unknown/primitive by design, to keep this contract free of any
domain types. Tokens are never exposed.
Every getter but health takes the caller’s Principal and returns only
what belongs to that person (the common wiki area included) and what they’re
offered (the manifest); the channel authenticates, the core decides what the
person can see. For someone the core doesn’t admit, a getter answers null.
Properties
Section titled “Properties”conversation
Section titled “conversation”conversation: (
principal,sessionKey,limit,offset?) =>Promise<unknown>
Defined in: types/channel-types/index.ts:345
A conversation’s durable verbatim transcript, chronological, paginated; empty unless sessionKey is one of the person’s own.
Parameters
Section titled “Parameters”principal
Section titled “principal”sessionKey
Section titled “sessionKey”string
number
offset?
Section titled “offset?”string
Returns
Section titled “Returns”Promise<unknown>
conversations
Section titled “conversations”conversations: (
principal,limit) =>Promise<unknown>
Defined in: types/channel-types/index.ts:347
The person’s conversations, most-recently-active first.
Parameters
Section titled “Parameters”principal
Section titled “principal”number
Returns
Section titled “Returns”Promise<unknown>
health
Section titled “health”health: () =>
Promise<unknown>
Defined in: types/channel-types/index.ts:355
Returns
Section titled “Returns”Promise<unknown>
manifest
Section titled “manifest”manifest: (
principal) =>Promise<unknown>
Defined in: types/channel-types/index.ts:342
Parameters
Section titled “Parameters”principal
Section titled “principal”Returns
Section titled “Returns”Promise<unknown>
optionalme?: (principal) =>Promise<unknown>
Defined in: types/channel-types/index.ts:357
Who the caller is to the core: { name, language, timeZone }, how they asked to be called, the language and the time zone they saved, null for what they never said (timeZone absent on an older core). Absent on an older core.
Parameters
Section titled “Parameters”principal
Section titled “principal”Returns
Section titled “Returns”Promise<unknown>
memoryScroll
Section titled “memoryScroll”memoryScroll: (
principal,collection,limit,offset?) =>Promise<unknown>
Defined in: types/channel-types/index.ts:353
A page of the person’s points in collection, or null when it isn’t a collection kept per person.
Parameters
Section titled “Parameters”principal
Section titled “principal”collection
Section titled “collection”string
number
offset?
Section titled “offset?”string
Returns
Section titled “Returns”Promise<unknown>
pendingConfirmations
Section titled “pendingConfirmations”pendingConfirmations: (
principal) =>Promise<unknown>
Defined in: types/channel-types/index.ts:343
Parameters
Section titled “Parameters”principal
Section titled “principal”Returns
Section titled “Returns”Promise<unknown>
toolLog
Section titled “toolLog”toolLog: (
principal) =>Promise<unknown>
Defined in: types/channel-types/index.ts:354
Parameters
Section titled “Parameters”principal
Section titled “principal”Returns
Section titled “Returns”Promise<unknown>
wikiGrep
Section titled “wikiGrep”wikiGrep: (
principal,pattern) =>Promise<unknown>
Defined in: types/channel-types/index.ts:351
Parameters
Section titled “Parameters”principal
Section titled “principal”pattern
Section titled “pattern”string
Returns
Section titled “Returns”Promise<unknown>
wikiList
Section titled “wikiList”wikiList: (
principal) =>Promise<unknown>
Defined in: types/channel-types/index.ts:348
Parameters
Section titled “Parameters”principal
Section titled “principal”Returns
Section titled “Returns”Promise<unknown>
wikiRead
Section titled “wikiRead”wikiRead: (
principal,path) =>Promise<unknown>
Defined in: types/channel-types/index.ts:350
The file at path as the person names it (curated/..., personal/...), or null when it isn’t among what they can see.
Parameters
Section titled “Parameters”principal
Section titled “principal”string
Returns
Section titled “Returns”Promise<unknown>