Skip to content
This repository has been archived by the owner on Mar 1, 2018. It is now read-only.

Commit

Permalink
Clarify the state activity type
Browse files Browse the repository at this point in the history
  • Loading branch information
danopia committed Jul 11, 2013
1 parent d03d6e6 commit 4b8edc1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Most packets have a similar base structure, consisting of:
* `act`: Topic activity. Such activity is usually transient to the server. Activity has a `type` extra. Some common types:
* `msg`: Most common type. Used to mean a normal message has been sent, and is in the `data` extra. May refer to a previous message by ID using the `context` extra.
* `action`: Like `msg`, except displayed like IRC `/me`, that is, prefixed with the sender's username.
* `state`: May be used to convey typing state. Should only be used in smaller channels or otherwise when indicated by some channel flag. The extra `typing` would be `yes`, `no`, or `hastext` (as in, text has been entered, but the user is not actively adding to it).
* `state`: May be used to convey typing state. Should only be used in smaller channels or otherwise when indicated by some channel flag. The `typing` extra would be `true` or `false`, and the `hastext` extra would also be boolean (as in, text has been entered, but the user is not actively adding to it). If either is absent, they're assumed false.
* `revise`: Like `msg`, has `data` and `context`; however, instead of replying to a message, `revise` requests to replace the older message's data. If a client decides to honor the revision (using criteria such as being by the same user and a certain timeframe ago), it should visually convey that the message was modified, with some way to view past revisions.

### Example Welcome flow
Expand Down

0 comments on commit 4b8edc1

Please sign in to comment.