summary refs log tree commit diff
path: root/docs/client-server/howto.rst
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-08-20 16:45:59 +0100
committerKegan Dougal <kegan@matrix.org>2014-08-20 16:45:59 +0100
commit5048f4a915625ada6c98b9e574edaa9455e9442d (patch)
tree815f5efed42d2e49bb7012100414a45a6069627a /docs/client-server/howto.rst
parentAdded more jsfiddles. (diff)
downloadsynapse-5048f4a915625ada6c98b9e574edaa9455e9442d.tar.xz
Added final jsfiddle: an example app demonstrating most of the c2s api.
Diffstat (limited to 'docs/client-server/howto.rst')
-rw-r--r--docs/client-server/howto.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/client-server/howto.rst b/docs/client-server/howto.rst
index 433277000d..9ef4cb5f78 100644
--- a/docs/client-server/howto.rst
+++ b/docs/client-server/howto.rst
@@ -121,6 +121,8 @@ these rules may specify if you require an **invitation** from someone already in
 the room in order to **join the room**. In addition, you may also be able to 
 join a room **via a room alias** if one was set up.
 
+**Try out the fiddle: http://jsfiddle.net/og1xokcr/**
+
 Inviting a user to a room
 -------------------------
 You can directly invite a user to a room like so::
@@ -164,6 +166,8 @@ An event is some interesting piece of data that a client may be interested in.
 It can be a message in a room, a room invite, etc. There are many different ways
 of getting events, depending on what the client already knows.
 
+**Try out the fiddle: http://jsfiddle.net/5uk4dqe2/**
+
 Getting all state
 -----------------
 If the client doesn't know any information on the rooms the user is 
@@ -288,3 +292,12 @@ and then resume getting live state from a newer end token.
 NB: The timeout can be changed by adding a ``timeout`` query parameter, which is
 in milliseconds. A timeout of 0 will not block.
 
+
+Example application
+-------------------
+The following example demonstrates registration and login, live event streaming,
+creating and joining rooms, sending messages, getting member lists and getting 
+historical messages for a room. This covers most functionality of a messaging
+application.
+
+**Try out the fiddle: http://jsfiddle.net/L8r3o1wr/**