Skip to main content

Module change_token

Module change_token 

Source
Expand description

A task’s change token on a GitHub board: what Task::version holds here, and the one ordering of two of them.

docs/plugin-protocol.md §4.13d is the specification: the five parts the token is built from, the change kinds each covers member by member, and why a token waits for its task to settle. What is here is how this module holds to it. Each part is selected by every list, search and detail read already, so the token costs no request; an item missing any part — a draft, or an item this process wrote and has not read back — gives none. order says how two tokens of one issue stand to each other, and an item whose later time is within SETTLED of the response’s Date, or read from a response without one, gives no token.

Structs§

Parts
What one token of this plugin is made of.

Constants§

PREFIX
What every token this plugin gives starts with, so a reader can tell it from another plugin’s.
SETTLED
How long before the response that read it an item must last have changed for its token to be given.

Functions§

order
How the version a of one issue stands to its version b: Greater when a is the later, Less when it is the earlier, Equal when nothing the token covers changed between them — and None when either is not a token of this plugin, or the two cannot both be versions of one issue read in order.
settled
Whether an issue last changed at issue, whose board item last changed at item, had settled by served — the Date of the response that read it — so its token may be given.
spell
The token these parts spell.