diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -6,6 +6,23 @@ In this context _basic_ means that the module currently consists of barely more The maintanance of these API wrappers is simplified by an appropriate _Scheme_ macro that reduces the implementation of new API methods to basically slightly rewriting the documentation. +## Documentation + +All _basic_ API wrappers are named the same as their method name and require the bot's token as their first argument. Further parameters are expected as named key value pairs. Note that the library currently only verifies that all required parameters are supplied at all while type verification is left to _Telegram's_ server side logic. + + (sendMessage token + chat_id: chat_id + text: text) + +All API wrappers return the raw deserialized JSON results as to not limit the options for further parsing unnecessarily. + +The only non-API wrapper provided by this library is `pollUpdates` which enables passing updates acquired via long polling of `getUpdates` to an arbitrary function as follows: + + (pollUpdates token + (lambda (u) + (begin (print-message u) + (echo-message u)))) + ## Example `example/echo.scm` implements a bot that echoes all messages back to their sender. |