Show this workbook's session.
OptionalsessionId: string
The id the host addresses this workbook by. Defaults to the workbook's own id.
Dismiss the bound session's prompt. What was answered so far goes back with the cancel.
Answer the step on screen of the bound session's prompt. Answering here or in the grid is the same thing.
OptionaloptionId: string
The option chosen; omitted to acknowledge a step that has none.
A single-question prompt is sent at once. With several, the answer is recorded and the next step comes up; the answers go together on submitPrompt.
Clear the agent's working cursor, as Esc does. Returns whether there was one.
Dismiss one finding. The cursor moves to the one that takes its place.
Dismiss every finding and question finding in the bound session.
Make a finding current and reveal it. A stale or unknown id does nothing; a working one is only revealed.
Move to the next finding (wrapping) and reveal it.
OptionalfromId: string
Step from this finding instead of the current one — a chip's own arrows walk from that chip, wherever the user scrolled to.
Move to the previous finding (wrapping) and reveal it. See next for fromId.
OptionalfromId: stringShow another step of the bound session's prompt. Answers given stay until changed.
Bring an address into view without touching the selection.
Select an address — for a link to the cells the user clicks (the prompt's range).
Record where the prompt's first question is on screen, so its dialog can open there. Set once: the dialog opens where its question was, then stays wherever the user puts it.
Record the step on screen's answer in the user's own words ("Other"), as they type. It does not move on or send — the user may write several lines; submitPrompt sends. Blank text leaves the step unanswered.
Send the prompt's answers. Only once every question has one.
Someone else working in the view: their findings, their working cursor, their prompt and status, for one session. The findings are the workbook's range annotations, written with the session as their
source, fed by the host'shighlightevents and read back here so the views see one snapshot.Remarks
Shows one session: the workbook passed to bind. A
highlightfor a session that is not bound yet is kept until it is (the workbook may still be loading); one for another session is dropped, since there is nothing to draw it on.The host hears about dismissals from the annotation store's events, so a dismissal from the grid's tag, from a list, or from a command reaches it the same way.