From 1e60498207d4a3f0638a4cefbb7ed15157c11f14 Mon Sep 17 00:00:00 2001 From: yago Date: Tue, 7 Jul 2015 22:11:54 +0200 Subject: [PATCH] Generated README --- README.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dbaab75..5bc9239 100644 --- a/README.md +++ b/README.md @@ -52,11 +52,13 @@ Returns basic information about the bot in form of a `User` object. ## setWebHook(url) -Specify a url to receive incoming updates via an outgoing webHook. +Specify an url to receive incoming updates via an outgoing webHook. + +See: https://core.telegram.org/bots/api#setwebhook ### Params: -* **String** *url* URL +* **String** *url* URL where Telegram will make HTTP Post. Leave empty to delete webHook. ## getUpdates([timeout], [limit], [offset]) @@ -136,18 +138,37 @@ See: https://core.telegram.org/bots/api#sendaudio * **Promise** +## sendDocument(chatId, A, [options]) + +Send Document + +See: https://core.telegram.org/bots/api#sendDocument + +### Params: + +* **Number|String** *chatId* Unique identifier for the message recipient +* **String|stream.Stream** *A* file path or a Stream. Can also be a `file_id` previously uploaded. +* **Object** *[options]* Additional Telegram query options + +### Return: + +* **Promise** ## sendChatAction(chatId, action) -Send chat action. Type of `action` to broadcast. `typing` for text messages, `upload_photo` for photos, `record_video` or `upload_video` for videos, `record_audio` or `upload_audio` for audio files, `upload_document` for general files, `find_location` for location data. +Send chat action. +`typing` for text messages, +`upload_photo` for photos, `record_video` or `upload_video` for videos, +`record_audio` or `upload_audio` for audio files, `upload_document` for general files, +`find_location` for location data. See: https://core.telegram.org/bots/api#sendchataction ### Params: * **Number|String** *chatId* Unique identifier for the message recipient -* **String** *action* Type of action to broadcast. +* **String** *action* Type of action to broadcast. ### Return: -* **Promise** +* **Promise**