aiogram/.butcher/methods/editChatInviteLink/entity.json
Alex Root Junior f6020476e6
Update schema
2023-03-11 17:43:01 +02:00

65 lines
3.7 KiB
JSON

{
"meta": {},
"group": {
"title": "Available methods",
"anchor": "available-methods"
},
"object": {
"anchor": "editchatinvitelink",
"name": "editChatInviteLink",
"description": "Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.",
"html_description": "<p>Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a <a href=\"#chatinvitelink\">ChatInviteLink</a> object.</p>",
"rst_description": "Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.",
"annotations": [
{
"type": "Integer or String",
"required": true,
"description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"html_description": "<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"name": "chat_id"
},
{
"type": "String",
"required": true,
"description": "The invite link to edit",
"html_description": "<td>The invite link to edit</td>",
"rst_description": "The invite link to edit\n",
"name": "invite_link"
},
{
"type": "String",
"required": false,
"description": "Invite link name; 0-32 characters",
"html_description": "<td>Invite link name; 0-32 characters</td>",
"rst_description": "Invite link name; 0-32 characters\n",
"name": "name"
},
{
"type": "Integer",
"required": false,
"description": "Point in time (Unix timestamp) when the link will expire",
"html_description": "<td>Point in time (Unix timestamp) when the link will expire</td>",
"rst_description": "Point in time (Unix timestamp) when the link will expire\n",
"name": "expire_date"
},
{
"type": "Integer",
"required": false,
"description": "The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999",
"html_description": "<td>The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999</td>",
"rst_description": "The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999\n",
"name": "member_limit"
},
{
"type": "Boolean",
"required": false,
"description": "True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified",
"html_description": "<td><em>True</em>, if users joining the chat via the link need to be approved by chat administrators. If <em>True</em>, <em>member_limit</em> can't be specified</td>",
"rst_description": ":code:`True`, if users joining the chat via the link need to be approved by chat administrators. If :code:`True`, *member_limit* can't be specified\n",
"name": "creates_join_request"
}
],
"category": "methods"
}
}