Small improvement in documentation

This commit is contained in:
Benoit Marty 2020-04-21 00:29:02 +02:00
parent c1acb1af66
commit 59280ed18e
2 changed files with 5 additions and 3 deletions

View file

@ -38,10 +38,10 @@ When the client receives the new information, it immediately sends another reque
This effectively emulates a server push feature. This effectively emulates a server push feature.
The HTTP long Polling can be fine tuned in the **SDK** using two parameters: The HTTP long Polling can be fine tuned in the **SDK** using two parameters:
* timout (Sync request timeout) * timeout (Sync request timeout)
* delay (Delay between each sync) * delay (Delay between each sync)
**timeout** is a server paramter, defined by: **timeout** is a server parameter, defined by:
``` ```
The maximum time to wait, in milliseconds, before returning this request.` The maximum time to wait, in milliseconds, before returning this request.`
If no events (or other data) become available before this time elapses, the server will return a response with empty fields. If no events (or other data) become available before this time elapses, the server will return a response with empty fields.

View file

@ -57,7 +57,7 @@ We get credential (200)
```json ```json
{ {
"user_id": "@benoit0816:matrix.org", "user_id": "@alice:matrix.org",
"access_token": "MDAxOGxvY2F0aW9uIG1hdHREDACTEDb2l0MDgxNjptYXRyaXgub3JnCjAwMTZjaWQgdHlwZSA9IGFjY2VzcwowMDIxY2lkIG5vbmNlID0gfnYrSypfdTtkNXIuNWx1KgowMDJmc2lnbmF0dXJlIOsh1XqeAkXexh4qcofl_aR4kHJoSOWYGOhE7-ubX-DZCg", "access_token": "MDAxOGxvY2F0aW9uIG1hdHREDACTEDb2l0MDgxNjptYXRyaXgub3JnCjAwMTZjaWQgdHlwZSA9IGFjY2VzcwowMDIxY2lkIG5vbmNlID0gfnYrSypfdTtkNXIuNWx1KgowMDJmc2lnbmF0dXJlIOsh1XqeAkXexh4qcofl_aR4kHJoSOWYGOhE7-ubX-DZCg",
"home_server": "matrix.org", "home_server": "matrix.org",
"device_id": "GTVREDALBF", "device_id": "GTVREDALBF",
@ -128,6 +128,8 @@ We get the credentials (200)
} }
``` ```
It's worth noting that the response from the homeserver contains the userId of Alice.
### Login with Msisdn ### Login with Msisdn
Not supported yet in RiotX Not supported yet in RiotX