Browse Source

Updated channel api docs to reflect room type changes.

pull/192/head
Simon Eisenmann 10 years ago
parent
commit
aefdbdac6c
  1. 28
      doc/CHANNELING-API.txt

28
doc/CHANNELING-API.txt

@ -162,9 +162,10 @@ Special purpose documents for channling
{ {
Type: "Hello", Type: "Hello",
Hello: { Hello: {
Version: "1.0.0", "Version": "1.0.0",
Ua: "Test client 1.0", "Ua": "Test client 1.0",
Id: "", "Name": "",
"Type": "",
"Credentials": {...} "Credentials": {...}
} }
} }
@ -179,7 +180,10 @@ Special purpose documents for channling
Version : Channel protocol version (string). Version : Channel protocol version (string).
Ua : User agent description (string). Ua : User agent description (string).
Id : Room id. The default Room has the empty string Id ("") (string). Name : Room name. The default Room has the empty string name ("") (string).
Type : Room type. Use empty string to let the server select the
default type.
Id : Same as 'Name' (kept for compatibility).
Credentials : An optional RoomCredentials document containing room Credentials : An optional RoomCredentials document containing room
authentication information. See the Room document for authentication information. See the Room document for
information on how such credentials should be handled after information on how such credentials should be handled after
@ -218,10 +222,10 @@ Special purpose documents for channling
Keys under Welcome: Keys under Welcome:
Room: Contains the current state of the room, see the description of Room : Contains the current state of the room, see the description of
the Room document for more details. the Room document for more details.
Users: Contains the user list for the room, see the description of Users : Contains the user list for the room, see the description of
the Users document for more details. the Users document for more details.
RoomCredentials RoomCredentials
@ -241,7 +245,7 @@ Special purpose documents for channling
Room Room
{ {
"Type": "Room", "Type": "room-type",
"Name": "room-name-here" "Name": "room-name-here"
"Credentials": {...} "Credentials": {...}
} }
@ -256,8 +260,10 @@ Special purpose documents for channling
Keys under Room: Keys under Room:
Name : The human readable ID of the room, currently must be globally Type : The room type. This field should only be send to alter
unique. the room type. It will always contain the type of the room
when returned by the server.
Name : The human readable name of the room.
Credentials : Optional authentication information for the room, see the Credentials : Optional authentication information for the room, see the
documentation of the RoomCredentials document for more documentation of the RoomCredentials document for more
details. This field shall only be present when sending or details. This field shall only be present when sending or

Loading…
Cancel
Save