Reference · the tools · gateway
read_topic
Read a topic's messages
What it does
Read the messages on a topic, oldest first. With a pull subscription (its number), what it has not had yet, and it moves on past them. Otherwise those after a message id (after), or the last few.
What it needs to know
- topic
- The topic.
- subscription · optional
- A pull subscription on this topic: read what it has not had, and move it on.
- after · optional
- Only messages after this id.
- limit · optional
- At most this many. Default 20.
- box · optional
- Which box: its name and account, "home.frank" or "jordan.northwind", or just "home" when only one of your boxes is called that. Omit it for your current box (switch_box changes it; list_boxes says which it is).
- session_box · optional
- The box this session runs on, if it runs on one of yours: its name, as the on-box instructions give it ("frankh90.hemlane"). With it, a call that names no box is checked against your current box.
Where it lands
On one of your boxes: the one named in box, or your default box when none is named.