Loop/Architecture/Data Channels: Difference between revisions

← Older edit

Loop/Architecture/Data Channels (view source)

Revision as of 14:30, 25 August 2015

390 bytes added , 25 August 2015

no edit summary

AdamRoach

Confirmed users

632

edits

@@ Line 20: / Line 20: @@
 == Format of Data ==
-Data sent across the data channel should be encoded in standard JSON format. Implementations should not fail if additional fields are sent within a message.
+The format of the data will vary for different channels, according to the requirements for data across that channel.
-It is envisioned that all Loop messages for a data channel will have a contentType field specifying the type of message. Hence the message may be ignored if the contentType is not supported. ''It may be necessary in future to add a feature detection capability.''
+=== "Text" Data Channel ===
-Individual data types have their own structures.
+Data sent across the "text" data channel should be encoded in standard JSON format.
-=== Text Messages ===
+Individual data types shall have their own defined structures, with contentType being the type of message.
+Notes:
+* Implementations should ignore messages with an unknown contentType, this is for forward compatibility.
+** ''It may be necessary in furture to have a capability detection system.''
+* Implementations should not fail if additional fields are sent within an known message content type.
+==== Text Messages ====
    {
@@ Line 38: / Line 46: @@
 * sentTimestamp: An ISO encoded date
-Note: Implementations are expected to handle their own received timestamp, so that messages are displayed in the correct order e.g. in case of clock skew across the two machines.
+Notes for implementations:
+* Implementations shall handle security concerns around not processing embedded HTML.
+* Implementations should handle their own received timestamp, so that messages are displayed in the correct order e.g. in case of clock skew across the two machines.
+* Implementations should handle linkifying URLs when the message is displayed. These shall not affect the transmitted content.