protocol-format.rst 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. Transaction
  2. ===========
  3. Required keys:
  4. ============ =================== ===============================================
  5. Key Type Description
  6. ============ =================== ===============================================
  7. origin String DNS name of homeserver making this transaction.
  8. ts Integer Timestamp in milliseconds on originating
  9. homeserver when this transaction started.
  10. previous_ids List of Strings List of transactions that were sent immediately
  11. prior to this transaction.
  12. pdus List of Objects List of updates contained in this transaction.
  13. ============ =================== ===============================================
  14. PDU
  15. ===
  16. Required keys:
  17. ============ ================== ================================================
  18. Key Type Description
  19. ============ ================== ================================================
  20. context String Event context identifier
  21. origin String DNS name of homeserver that created this PDU.
  22. pdu_id String Unique identifier for PDU within the context for
  23. the originating homeserver.
  24. ts Integer Timestamp in milliseconds on originating
  25. homeserver when this PDU was created.
  26. pdu_type String PDU event type.
  27. prev_pdus List of Pairs The originating homeserver and PDU ids of the
  28. of Strings most recent PDUs the homeserver was aware of for
  29. this context when it made this PDU.
  30. depth Integer The maximum depth of the previous PDUs plus one.
  31. ============ ================== ================================================
  32. Keys for state updates:
  33. ================== ============ ================================================
  34. Key Type Description
  35. ================== ============ ================================================
  36. is_state Boolean True if this PDU is updating state.
  37. state_key String Optional key identifying the updated state within
  38. the context.
  39. power_level Integer The asserted power level of the user performing
  40. the update.
  41. min_update Integer The required power level needed to replace this
  42. update.
  43. prev_state_id String The homeserver of the update this replaces
  44. prev_state_origin String The PDU id of the update this replaces.
  45. user String The user updating the state.
  46. ================== ============ ================================================