mirror of
https://github.com/tdlight-team/tdlight-telegram-bot-api.git
synced 2025-01-15 14:27:32 +01:00
Update readme
This commit is contained in:
parent
25d1ee172b
commit
33d8af02c2
42
README.md
42
README.md
@ -40,19 +40,36 @@ Get information about a message
|
|||||||
- `message_id` Message id
|
- `message_id` Message id
|
||||||
##### Returns `message`
|
##### Returns `message`
|
||||||
|
|
||||||
<!--TODO: Document the following methods:
|
Document the following methods:
|
||||||
#### Command `getparticipants`
|
#### Command `getparticipants`
|
||||||
(todo)
|
Get the member list of a supergroup or channel
|
||||||
##### Parameters
|
##### Parameters
|
||||||
- `(todo)`
|
- `chat_id` Chat id
|
||||||
##### Returns `(todo)`
|
- `filter` String, possible values are
|
||||||
|
`members`, `parameters`, `admins`, `administators`, `restricted`, `banned`, `bots`
|
||||||
|
- `offset` Number of users to skip
|
||||||
|
- `limit` The maximum number of users be returned; up to 200
|
||||||
|
|
||||||
|
##### Returns `ChatMember`
|
||||||
|
|
||||||
#### Command `deletemessages`
|
#### Command `deletemessages`
|
||||||
(todo)
|
Delete all the messages with message_id in range between `start` and `end`.
|
||||||
##### Parameters
|
The `start` parameter MUST be less than the `end` parameter
|
||||||
- `(todo)`
|
Both `start` and `end` must be positive non zero numbers
|
||||||
##### Returns `(todo)`
|
The method will always return `true` as a result, even if the messages cannot be deleted
|
||||||
|
This method does not work on private chat or normal groups
|
||||||
|
It is not suggested to delete more than 200 messages per call
|
||||||
|
|
||||||
|
**NOTE**
|
||||||
|
The maximum number of messages to be deleted in a single batch is determined by the `max-batch-operations` parameter and is 10000 by default
|
||||||
|
|
||||||
|
##### Parameters
|
||||||
|
- `chat_id` Chat id
|
||||||
|
- `start` First message id to delete
|
||||||
|
- `end` Last message id to delete
|
||||||
|
##### Returns `true`
|
||||||
|
|
||||||
|
<!--TODO:
|
||||||
#### Command `togglegroupinvites`
|
#### Command `togglegroupinvites`
|
||||||
(todo)
|
(todo)
|
||||||
##### Parameters
|
##### Parameters
|
||||||
@ -65,6 +82,8 @@ If enabled, allow only relative paths for files in local mode.
|
|||||||
#### Executable flag `insecure`
|
#### Executable flag `insecure`
|
||||||
Allow http connection in non-local mode
|
Allow http connection in non-local mode
|
||||||
|
|
||||||
|
#### Executable parameter `max-batch-operations`
|
||||||
|
maximum number of batch operations (default 10000)
|
||||||
|
|
||||||
<a name="modified-features"></a>
|
<a name="modified-features"></a>
|
||||||
### Modified features
|
### Modified features
|
||||||
@ -77,6 +96,13 @@ The `message` object now has two new fields:
|
|||||||
- `views`: how many views has the message (usually the views are shown only for channel messages)
|
- `views`: how many views has the message (usually the views are shown only for channel messages)
|
||||||
- `forwards`: how many times the message has been forwarded
|
- `forwards`: how many times the message has been forwarded
|
||||||
|
|
||||||
|
#### Object `ChatMember`
|
||||||
|
The `ChatMember` object now has two new fields:
|
||||||
|
- `joined_date`: integer, unix timestamp, when has the user joined
|
||||||
|
- `inviter`: `User`, the inviter
|
||||||
|
|
||||||
|
In addition, the member list now shows the full bot list (previously only the bot that executed the query was shown)
|
||||||
|
|
||||||
<a name="installation"></a>
|
<a name="installation"></a>
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user