~whereswaldon/arborchat

ref: 5b1f9c99c54cb7a1fcfa7bc4a836acaa4781ee28 arborchat/specifications/twig-extensions/active-status/index.md -rw-r--r-- 986 bytes
5b1f9c99Chris Waldon doc: fix small typos in active status spec 3 months ago

#Active Status

Twig metadata which indicates whether or not a user is online. Field specification in spec.toml.

#Usage

An 'active status' message is designed to be sent as 'active' when a user connects to a forest, with the client sending an 'inactive' message upon exit. This minimizes the number of messages sent by the client. In case of unclean exits however, it is generally used in combination with expiration. E.g. send an active status message that is "live" for 5 minutes during client startup and every consecutive 5 minutes. In this case it is still recommended to send an "inactive" message during client shutdown/disconnect.

Active Status messages should also be invisible.

It is up to the client to keep a running map of users that have un-expired "active" messages to determine who is online. An example of one solution to this can be found in forest-ex.