telegram-bot-bash/doc/6_reference.md

220 lines
2.1 KiB
Markdown
Raw Normal View History

2019-04-15 09:49:13 +00:00
## Bashbot functions reference
### Send, forward, delete Messages
2019-04-15 10:52:38 +00:00
##### send_action
*usage:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
*example:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
##### send_normal_message
*usage:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
*example:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
##### send_markdown_message
*usage:*
*example:*
##### send_html_message
*usage:*
*example:*
##### forward
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
----
2019-04-15 10:52:38 +00:00
##### send_message
Send Message is only used to process the output of interactive chats an background jobs.
I reccommend to use the more dedicated send_xxx_message() functions above.
*usage:*
*example:* see [Usage](2_usage.md#send_message) and [Advanced Usage](3_advanced.md#Interactive-Chats)
2019-04-15 09:49:13 +00:00
----
2019-04-15 10:52:38 +00:00
##### delete_message
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
----
2019-04-15 10:52:38 +00:00
##### answer_inline_query
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
----
### File, Location, Venu, keyboards
2019-04-15 10:52:38 +00:00
##### get_file
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
##### send_file
*usage:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
*example:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
##### send_location
*usage:*
*example:*
##### send_venue
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
----
2019-04-15 10:52:38 +00:00
##### send_keyboard
*usage:*
*example:*
##### remove_keyboard
*usage:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
*example:*
2019-04-15 09:49:13 +00:00
### Manage users
2019-04-15 10:52:38 +00:00
##### kick_chat_member
*usage:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
*example:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
##### unban_chat_member
*usage:*
*example:*
##### leave_chat
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
----
2019-04-15 10:52:38 +00:00
##### user_is_creator
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
##### user_is_admin
*usage:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
*example:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
##### user_is_botadmin
*usage:*
*example:*
##### user_is_allowed
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
### Interactive and backgound jobs
2019-04-15 10:52:38 +00:00
##### startproc
*usage:*
*example:*
##### checkproc
*usage:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
*example:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
##### killproc
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
----
2019-04-15 10:52:38 +00:00
##### background
*usage:*
*example:*
##### checkback
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
##### killback
*usage:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
*example:*
2019-04-15 09:49:13 +00:00
### Bashbot internal
2019-04-15 10:52:38 +00:00
These function are for internal use only and must not used for your bot commands.
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
##### send_text
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
----
2019-04-15 10:52:38 +00:00
##### JsonDecode
*usage:*
*example:*
##### JsonGetString
*usage:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
*example:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
##### JsonGetValue
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
----
2019-04-15 10:52:38 +00:00
##### get_chat_member_status
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
----
2019-04-15 10:52:38 +00:00
##### process_client
*usage:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
*example:*
##### process_updates
*usage:*
*example:*
2019-04-15 09:49:13 +00:00
----
2019-04-15 10:52:38 +00:00
##### getBotName
*usage:*
*example:*
##### inproc
*usage:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
*example:*
2019-04-15 09:49:13 +00:00
2019-04-15 10:52:38 +00:00
#### $$VERSION$$ v0.6-rc1-6-ge18b200
2019-04-15 09:49:13 +00:00