New Web Services for mod_chat

Note: Version number is bumped because new web services are added into the Mobile app service and into the mod_chat list of external functions.

1. Create inside a course a new Chat activity
2. Enrol two users in that course as students (student1 and student2)
3. Log in as the student and visit the url
4. As admin, enable "Mobile services": Plugins ► Web Services ► Mobile
5. Create a Token for the student1
   • Click on Site administration ► Plugins ► Web services ► Manage tokens
6. Access to the chat with the student2 user in the Moodle web interface
7. Next, you can do a CURL REST call simulating a WS client with the student1 user token.
8. You should try to perform all the requests quickly since there is a timeout and the student1 will be logged off the chat it not recent activity is detected.
   • You need to replace the wstoken, chatid (the chat instance value) and the URL of your moodle instance

     curl 'http://localhost/m/stable_master/webservice/rest/server.php?moodlewsrestformat=json' --data 'chatid=1&wsfunction=mod_chat_login_user&wstoken=a70d553bbaf6d9b260a9e5c701b3c46e' --compressed

9. Confirm that
   • The previous call returns a chatsid value (alpha numeric value)
10. With the student2 write something in the chat in the Web interface
11. Now, try to retrieve the latest chat messages (you have to use your chatsid value)

    curl 'http://localhost/m/stable_master/webservice/rest/server.php?moodlewsrestformat=json' --data 'chatsid=K4N3l6X1isS1sDWNDt8GHfJ3N8GSkj1x&wsfunction=mod_chat_get_chat_latest_messages&wstoken=a70d553bbaf6d9b260a9e5c701b3c46e' --compressed

12. You can append " | python -m "json.tool"" to the command for formatting the output, you will receive and object containing the latest messages and your new timestamp (chatnewlasttime)
13. Now, to avoid the chat timeout, you can keep the latest curl request running in a shell doing:

    watch "curl 'http://localhost/m/stable_master/webservice/rest/server.php?moodlewsrestformat=json' --data 'chatsid=K4N3l6X1isS1sDWNDt8GHfJ3N8GSkj1x&wsfunction=mod_chat_get_chat_latest_messages&wstoken=a70d553bbaf6d9b260a9e5c701b3c46e'"

14. Now, you can retrieve the list of participants in the chat

    curl 'http://localhost/m/stable_master/webservice/rest/server.php?moodlewsrestformat=json' --data 'chatsid=K4N3l6X1isS1sDWNDt8GHfJ3N8GSkj1x&wsfunction=mod_chat_get_chat_users&wstoken=a70d553bbaf6d9b260a9e5c701b3c46e' --compressed | python -m "json.tool"

    • Confirm that the user list contains all the users in the chat
15. Finally, you can send messages

    curl 'http://localhost/m/stable_master/webservice/rest/server.php?moodlewsrestformat=json' --data 'chatsid=K4N3l6X1isS1sDWNDt8GHfJ3N8GSkj1x&messagetext=Testingmessage&wsfunction=mod_chat_send_chat_message&wstoken=a70d553bbaf6d9b260a9e5c701b3c46e' --compressed | python -m "json.tool"

    • You must confirm that the messages are displayed in the web interface