Update TD scheme

This commit is contained in:
Daniil Gentili 2017-08-25 15:05:53 +02:00
parent cf22652968
commit da57215397
606 changed files with 9991 additions and 2410 deletions

View File

@ -1,20 +1,18 @@
--- ---
title: messageEntityBold title: messageEntityBold
description: Bold text description: messageEntityBold attributes, type and example
--- ---
## Constructor: messageEntityBold ## Constructor: messageEntityBold
[Back to constructors index](index.md) [Back to constructors index](index.md)
Bold text
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| |offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |length|[int](../types/int.md) | Yes|

View File

@ -1,20 +1,18 @@
--- ---
title: messageEntityBotCommand title: messageEntityBotCommand
description: Bot command beginning with / description: messageEntityBotCommand attributes, type and example
--- ---
## Constructor: messageEntityBotCommand ## Constructor: messageEntityBotCommand
[Back to constructors index](index.md) [Back to constructors index](index.md)
Bot command beginning with /
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| |offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |length|[int](../types/int.md) | Yes|

View File

@ -1,20 +1,18 @@
--- ---
title: messageEntityCode title: messageEntityCode
description: Text needs to be formatted as inside of code HTML tag description: messageEntityCode attributes, type and example
--- ---
## Constructor: messageEntityCode ## Constructor: messageEntityCode
[Back to constructors index](index.md) [Back to constructors index](index.md)
Text needs to be formatted as inside of code HTML tag
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| |offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |length|[int](../types/int.md) | Yes|

View File

@ -1,20 +1,18 @@
--- ---
title: messageEntityEmail title: messageEntityEmail
description: Email description: messageEntityEmail attributes, type and example
--- ---
## Constructor: messageEntityEmail ## Constructor: messageEntityEmail
[Back to constructors index](index.md) [Back to constructors index](index.md)
Email
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| |offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |length|[int](../types/int.md) | Yes|

View File

@ -1,20 +1,18 @@
--- ---
title: messageEntityHashtag title: messageEntityHashtag
description: Hashtag beginning with # description: messageEntityHashtag attributes, type and example
--- ---
## Constructor: messageEntityHashtag ## Constructor: messageEntityHashtag
[Back to constructors index](index.md) [Back to constructors index](index.md)
Hashtag beginning with #
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| |offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |length|[int](../types/int.md) | Yes|

View File

@ -1,20 +1,18 @@
--- ---
title: messageEntityItalic title: messageEntityItalic
description: Italic text description: messageEntityItalic attributes, type and example
--- ---
## Constructor: messageEntityItalic ## Constructor: messageEntityItalic
[Back to constructors index](index.md) [Back to constructors index](index.md)
Italic text
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| |offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |length|[int](../types/int.md) | Yes|

View File

@ -1,20 +1,18 @@
--- ---
title: messageEntityMention title: messageEntityMention
description: Mention of the user by his username description: messageEntityMention attributes, type and example
--- ---
## Constructor: messageEntityMention ## Constructor: messageEntityMention
[Back to constructors index](index.md) [Back to constructors index](index.md)
Mention of the user by his username
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| |offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |length|[int](../types/int.md) | Yes|

View File

@ -1,21 +1,19 @@
--- ---
title: messageEntityMentionName title: messageEntityMentionName
description: Mention of the user by some text description: messageEntityMentionName attributes, type and example
--- ---
## Constructor: messageEntityMentionName ## Constructor: messageEntityMentionName
[Back to constructors index](index.md) [Back to constructors index](index.md)
Mention of the user by some text
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| |offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |length|[int](../types/int.md) | Yes|
|user\_id|[int](../types/int.md) | Yes|Identifier of the mentioned user| |user\_id|[int](../types/int.md) | Yes|

View File

@ -1,21 +1,19 @@
--- ---
title: messageEntityTextUrl title: messageEntityTextUrl
description: Text description showed instead of the url description: messageEntityTextUrl attributes, type and example
--- ---
## Constructor: messageEntityTextUrl ## Constructor: messageEntityTextUrl
[Back to constructors index](index.md) [Back to constructors index](index.md)
Text description showed instead of the url
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| |offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |length|[int](../types/int.md) | Yes|
|url|[string](../types/string.md) | Yes|Url to be opened after link will be clicked| |url|[string](../types/string.md) | Yes|

View File

@ -1,20 +1,18 @@
--- ---
title: messageEntityUrl title: messageEntityUrl
description: Url beginning with http description: messageEntityUrl attributes, type and example
--- ---
## Constructor: messageEntityUrl ## Constructor: messageEntityUrl
[Back to constructors index](index.md) [Back to constructors index](index.md)
Url beginning with http
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| |offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |length|[int](../types/int.md) | Yes|

View File

@ -1,17 +1,19 @@
--- ---
title: pageBlockAnchor title: pageBlockAnchor
description: pageBlockAnchor attributes, type and example description: Invisible anchor on a page which can be used in a URL to open a page from the specified anchor
--- ---
## Constructor: pageBlockAnchor ## Constructor: pageBlockAnchor
[Back to constructors index](index.md) [Back to constructors index](index.md)
Invisible anchor on a page which can be used in a URL to open a page from the specified anchor
### Attributes: ### Attributes:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|name|[string](../types/string.md) | Yes| |name|[string](../types/string.md) | Yes|Name of the anchor|

View File

@ -1,17 +1,19 @@
--- ---
title: pageBlockCover title: pageBlockCover
description: pageBlockCover attributes, type and example description: Page cover
--- ---
## Constructor: pageBlockCover ## Constructor: pageBlockCover
[Back to constructors index](index.md) [Back to constructors index](index.md)
Page cover
### Attributes: ### Attributes:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|cover|[PageBlock](../types/PageBlock.md) | Yes| |cover|[PageBlock](../types/PageBlock.md) | Yes|The cover|

View File

@ -1,12 +1,18 @@
--- ---
title: pageBlockDivider title: pageBlockDivider
description: pageBlockDivider attributes, type and example description: An empty block separating parts of a page
--- ---
## Constructor: pageBlockDivider ## Constructor: pageBlockDivider
[Back to constructors index](index.md) [Back to constructors index](index.md)
An empty block separating parts of a page
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,17 +1,19 @@
--- ---
title: pageBlockParagraph title: pageBlockParagraph
description: pageBlockParagraph attributes, type and example description: A text paragraph
--- ---
## Constructor: pageBlockParagraph ## Constructor: pageBlockParagraph
[Back to constructors index](index.md) [Back to constructors index](index.md)
A text paragraph
### Attributes: ### Attributes:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|text|[RichText](../types/RichText.md) | Yes| |text|[RichText](../types/RichText.md) | Yes|Paragraph text|

View File

@ -1,18 +1,20 @@
--- ---
title: pageBlockPreformatted title: pageBlockPreformatted
description: pageBlockPreformatted attributes, type and example description: Preformatted text paragraph
--- ---
## Constructor: pageBlockPreformatted ## Constructor: pageBlockPreformatted
[Back to constructors index](index.md) [Back to constructors index](index.md)
Preformatted text paragraph
### Attributes: ### Attributes:
| Name | Type | Required | | Name | Type | Required | Description |
|----------|---------------|----------| |----------|---------------|----------|-------------|
|text|[RichText](../types/RichText.md) | Yes| |text|[RichText](../types/RichText.md) | Yes|Paragraph text|
|language|[string](../types/string.md) | Yes| |language|[string](../types/string.md) | Yes|Programming language for which the text should be formatted|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageCancelAction title: sendMessageCancelAction
description: User cancels typing description: sendMessageCancelAction attributes, type and example
--- ---
## Constructor: sendMessageCancelAction ## Constructor: sendMessageCancelAction
[Back to constructors index](index.md) [Back to constructors index](index.md)
User cancels typing
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageCancelAction title: sendMessageCancelAction
description: User cancels typing description: sendMessageCancelAction attributes, type and example
--- ---
## Constructor: sendMessageCancelAction\_17 ## Constructor: sendMessageCancelAction\_17
[Back to constructors index](index.md) [Back to constructors index](index.md)
User cancels typing
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageChooseContactAction title: sendMessageChooseContactAction
description: User chooses contact to send description: sendMessageChooseContactAction attributes, type and example
--- ---
## Constructor: sendMessageChooseContactAction ## Constructor: sendMessageChooseContactAction
[Back to constructors index](index.md) [Back to constructors index](index.md)
User chooses contact to send
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageChooseContactAction title: sendMessageChooseContactAction
description: User chooses contact to send description: sendMessageChooseContactAction attributes, type and example
--- ---
## Constructor: sendMessageChooseContactAction\_17 ## Constructor: sendMessageChooseContactAction\_17
[Back to constructors index](index.md) [Back to constructors index](index.md)
User chooses contact to send
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageGeoLocationAction title: sendMessageGeoLocationAction
description: User sends geolocation description: sendMessageGeoLocationAction attributes, type and example
--- ---
## Constructor: sendMessageGeoLocationAction ## Constructor: sendMessageGeoLocationAction
[Back to constructors index](index.md) [Back to constructors index](index.md)
User sends geolocation
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageGeoLocationAction title: sendMessageGeoLocationAction
description: User sends geolocation description: sendMessageGeoLocationAction attributes, type and example
--- ---
## Constructor: sendMessageGeoLocationAction\_17 ## Constructor: sendMessageGeoLocationAction\_17
[Back to constructors index](index.md) [Back to constructors index](index.md)
User sends geolocation
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageRecordVideoAction title: sendMessageRecordVideoAction
description: User records a video description: sendMessageRecordVideoAction attributes, type and example
--- ---
## Constructor: sendMessageRecordVideoAction ## Constructor: sendMessageRecordVideoAction
[Back to constructors index](index.md) [Back to constructors index](index.md)
User records a video
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageRecordVideoAction title: sendMessageRecordVideoAction
description: User records a video description: sendMessageRecordVideoAction attributes, type and example
--- ---
## Constructor: sendMessageRecordVideoAction\_17 ## Constructor: sendMessageRecordVideoAction\_17
[Back to constructors index](index.md) [Back to constructors index](index.md)
User records a video
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageTypingAction title: sendMessageTypingAction
description: User typing message description: sendMessageTypingAction attributes, type and example
--- ---
## Constructor: sendMessageTypingAction ## Constructor: sendMessageTypingAction
[Back to constructors index](index.md) [Back to constructors index](index.md)
User typing message
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageTypingAction title: sendMessageTypingAction
description: User typing message description: sendMessageTypingAction attributes, type and example
--- ---
## Constructor: sendMessageTypingAction\_17 ## Constructor: sendMessageTypingAction\_17
[Back to constructors index](index.md) [Back to constructors index](index.md)
User typing message
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,19 +1,17 @@
--- ---
title: sendMessageUploadDocumentAction title: sendMessageUploadDocumentAction
description: User uploads a document description: sendMessageUploadDocumentAction attributes, type and example
--- ---
## Constructor: sendMessageUploadDocumentAction ## Constructor: sendMessageUploadDocumentAction
[Back to constructors index](index.md) [Back to constructors index](index.md)
User uploads a document
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|progress|[int](../types/int.md) | Yes|Upload progress in percents| |progress|[int](../types/int.md) | Yes|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageUploadDocumentAction title: sendMessageUploadDocumentAction
description: User uploads a document description: sendMessageUploadDocumentAction attributes, type and example
--- ---
## Constructor: sendMessageUploadDocumentAction\_17 ## Constructor: sendMessageUploadDocumentAction\_17
[Back to constructors index](index.md) [Back to constructors index](index.md)
User uploads a document
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,19 +1,17 @@
--- ---
title: sendMessageUploadPhotoAction title: sendMessageUploadPhotoAction
description: User uploads a photo description: sendMessageUploadPhotoAction attributes, type and example
--- ---
## Constructor: sendMessageUploadPhotoAction ## Constructor: sendMessageUploadPhotoAction
[Back to constructors index](index.md) [Back to constructors index](index.md)
User uploads a photo
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|progress|[int](../types/int.md) | Yes|Upload progress in percents| |progress|[int](../types/int.md) | Yes|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageUploadPhotoAction title: sendMessageUploadPhotoAction
description: User uploads a photo description: sendMessageUploadPhotoAction attributes, type and example
--- ---
## Constructor: sendMessageUploadPhotoAction\_17 ## Constructor: sendMessageUploadPhotoAction\_17
[Back to constructors index](index.md) [Back to constructors index](index.md)
User uploads a photo
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -1,19 +1,17 @@
--- ---
title: sendMessageUploadVideoAction title: sendMessageUploadVideoAction
description: User uploads a video description: sendMessageUploadVideoAction attributes, type and example
--- ---
## Constructor: sendMessageUploadVideoAction ## Constructor: sendMessageUploadVideoAction
[Back to constructors index](index.md) [Back to constructors index](index.md)
User uploads a video
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required |
|----------|---------------|----------|-------------| |----------|---------------|----------|
|progress|[int](../types/int.md) | Yes|Upload progress in percents| |progress|[int](../types/int.md) | Yes|

View File

@ -1,18 +1,12 @@
--- ---
title: sendMessageUploadVideoAction title: sendMessageUploadVideoAction
description: User uploads a video description: sendMessageUploadVideoAction attributes, type and example
--- ---
## Constructor: sendMessageUploadVideoAction\_17 ## Constructor: sendMessageUploadVideoAction\_17
[Back to constructors index](index.md) [Back to constructors index](index.md)
User uploads a video
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

View File

@ -7,8 +7,6 @@ description: constructors and methods of type MessageEntity
Represent part of the message text which needs to be formatted in some unusual way
### Possible values (constructors): ### Possible values (constructors):
[messageEntityUnknown](../constructors/messageEntityUnknown.md) [messageEntityUnknown](../constructors/messageEntityUnknown.md)

View File

@ -7,6 +7,8 @@ description: constructors and methods of type PageBlock
Describes a block of web page instant view
### Possible values (constructors): ### Possible values (constructors):
[pageBlockUnsupported](../constructors/pageBlockUnsupported.md) [pageBlockUnsupported](../constructors/pageBlockUnsupported.md)

View File

@ -7,6 +7,8 @@ description: constructors and methods of type RichText
Describes a text inside web page instant view
### Possible values (constructors): ### Possible values (constructors):
[textEmpty](../constructors/textEmpty.md) [textEmpty](../constructors/textEmpty.md)

View File

@ -7,8 +7,6 @@ description: constructors and methods of type SendMessageAction
Notifies about activity in chat
### Possible values (constructors): ### Possible values (constructors):
[sendMessageTypingAction\_17](../constructors/sendMessageTypingAction_17.md) [sendMessageTypingAction\_17](../constructors/sendMessageTypingAction_17.md)

View File

@ -1,19 +1,19 @@
--- ---
title: accountTtl title: accountTtl
description: Contains infotmation about period of inactivity, after which the account of currently logged in user will be automatically deleted description: Contains information about period of inactivity, after which the account of currently logged in user will be automatically deleted
--- ---
## Constructor: accountTtl ## Constructor: accountTtl
[Back to constructors index](index.md) [Back to constructors index](index.md)
Contains infotmation about period of inactivity, after which the account of currently logged in user will be automatically deleted Contains information about period of inactivity, after which the account of currently logged in user will be automatically deleted
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|days|[int](../types/int.md) | Yes|Number of days of inactivity before account deletion, should be from 30 up to 366| |days|[int](../types/int.md) | Yes|Number of days of inactivity before account deletion, should be from 30 and up to 366|

View File

@ -13,6 +13,7 @@ Describes animation file. Animation should be encoded in gif or mp4 format
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|duration|[int](../types/int.md) | Yes|Duration of the animation in seconds as defined by sender|
|width|[int](../types/int.md) | Yes|Width of the animation| |width|[int](../types/int.md) | Yes|Width of the animation|
|height|[int](../types/int.md) | Yes|Height of the animation| |height|[int](../types/int.md) | Yes|Height of the animation|
|file\_name|[string](../types/string.md) | Yes|Original name of a file as defined by sender| |file\_name|[string](../types/string.md) | Yes|Original name of a file as defined by sender|

View File

@ -1,13 +1,13 @@
--- ---
title: authCodeTypeCall title: authCodeTypeCall
description: Code is delievered by voice call to the specified phone number description: Code is delivered by phone call to the specified phone number
--- ---
## Constructor: authCodeTypeCall ## Constructor: authCodeTypeCall
[Back to constructors index](index.md) [Back to constructors index](index.md)
Code is delievered by voice call to the specified phone number Code is delivered by phone call to the specified phone number
### Attributes: ### Attributes:

View File

@ -0,0 +1,25 @@
---
title: call
description: Describes a call
---
## Constructor: call
[Back to constructors index](index.md)
Describes a call
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|[int](../types/int.md) | Yes|Call identifier, not persistent|
|user\_id|[int](../types/int.md) | Yes|Peer user identifier|
|is\_outgoing|[Bool](../types/Bool.md) | Yes|True, if the call is outgoing|
|state|[CallState](../types/CallState.md) | Yes|Call state|
### Type: [Call](../types/Call.md)

View File

@ -0,0 +1,26 @@
---
title: callConnection
description: Describes address of UDP reflectors
---
## Constructor: callConnection
[Back to constructors index](index.md)
Describes address of UDP reflectors
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|[long](../types/long.md) | Yes|Reflector identifier|
|ip|[string](../types/string.md) | Yes|IPv4 reflector address|
|ipv6|[string](../types/string.md) | Yes|IPv6 reflector address|
|port|[int](../types/int.md) | Yes|Reflector port|
|peer\_tag|[bytes](../types/bytes.md) | Yes|Connection peer tag|
### Type: [CallConnection](../types/CallConnection.md)

View File

@ -0,0 +1,21 @@
---
title: callDiscardReasonDeclined
description: Call has ended before conversation begins. It was declined by the callee
---
## Constructor: callDiscardReasonDeclined
[Back to constructors index](index.md)
Call has ended before conversation begins. It was declined by the callee
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [CallDiscardReason](../types/CallDiscardReason.md)

View File

@ -0,0 +1,21 @@
---
title: callDiscardReasonDisconnected
description: Call has ended during conversation because users was disconnected
---
## Constructor: callDiscardReasonDisconnected
[Back to constructors index](index.md)
Call has ended during conversation because users was disconnected
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [CallDiscardReason](../types/CallDiscardReason.md)

View File

@ -0,0 +1,21 @@
---
title: callDiscardReasonEmpty
description: Call wasn't discarded or the reason is unknown
---
## Constructor: callDiscardReasonEmpty
[Back to constructors index](index.md)
Call wasn't discarded or the reason is unknown
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [CallDiscardReason](../types/CallDiscardReason.md)

View File

@ -0,0 +1,21 @@
---
title: callDiscardReasonHungUp
description: Call was hung up by the caller or by the callee
---
## Constructor: callDiscardReasonHungUp
[Back to constructors index](index.md)
Call was hung up by the caller or by the callee
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [CallDiscardReason](../types/CallDiscardReason.md)

View File

@ -0,0 +1,21 @@
---
title: callDiscardReasonMissed
description: Call has ended before conversation begins. It was cancelled by the caller or was missed by the callee
---
## Constructor: callDiscardReasonMissed
[Back to constructors index](index.md)
Call has ended before conversation begins. It was cancelled by the caller or was missed by the callee
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [CallDiscardReason](../types/CallDiscardReason.md)

View File

@ -0,0 +1,22 @@
---
title: callId
description: Contains call identifier
---
## Constructor: callId
[Back to constructors index](index.md)
Contains call identifier
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|[int](../types/int.md) | Yes|Call identifier|
### Type: [CallId](../types/CallId.md)

View File

@ -0,0 +1,25 @@
---
title: callProtocol
description: Specifies supported call protocols
---
## Constructor: callProtocol
[Back to constructors index](index.md)
Specifies supported call protocols
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|udp\_p2p|[Bool](../types/Bool.md) | Yes|True, if UDP peer to peer connections are supported|
|udp\_reflector|[Bool](../types/Bool.md) | Yes|True, if connection through UDP reflectors are supported|
|min\_layer|[int](../types/int.md) | Yes|Minimum supported layer, use 65|
|max\_layer|[int](../types/int.md) | Yes|Maximum supported layer, use 65|
### Type: [CallProtocol](../types/CallProtocol.md)

View File

@ -0,0 +1,24 @@
---
title: callStateDiscarded
description: Call has ended successfully
---
## Constructor: callStateDiscarded
[Back to constructors index](index.md)
Call has ended successfully
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|reason|[CallDiscardReason](../types/CallDiscardReason.md) | Yes|A reason, why call has ended|
|need\_rating|[Bool](../types/Bool.md) | Yes|If true, call rating should be sent to the server|
|need\_debug|[Bool](../types/Bool.md) | Yes|If true, call debug should be sent to the server|
### Type: [CallState](../types/CallState.md)

View File

@ -0,0 +1,22 @@
---
title: callStateError
description: Call has ended with an error
---
## Constructor: callStateError
[Back to constructors index](index.md)
Call has ended with an error
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|error|[error](../types/error.md) | Yes|The error. Error with the code 4005000 returned if an outgoing call is missed because of expired timeout|
### Type: [CallState](../types/CallState.md)

View File

@ -0,0 +1,21 @@
---
title: callStateExchangingKeys
description: Call is answered and encryption keys are exchanged
---
## Constructor: callStateExchangingKeys
[Back to constructors index](index.md)
Call is answered and encryption keys are exchanged
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [CallState](../types/CallState.md)

View File

@ -0,0 +1,21 @@
---
title: callStateHangingUp
description: Call is hanging up after discardCall is called
---
## Constructor: callStateHangingUp
[Back to constructors index](index.md)
Call is hanging up after discardCall is called
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [CallState](../types/CallState.md)

View File

@ -0,0 +1,23 @@
---
title: callStatePending
description: Call is pending for acception by a user
---
## Constructor: callStatePending
[Back to constructors index](index.md)
Call is pending for acception by a user
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|is\_created|[Bool](../types/Bool.md) | Yes|True, if the call is already created by the server|
|is\_received|[Bool](../types/Bool.md) | Yes|True, if the call is already received by the other party|
### Type: [CallState](../types/CallState.md)

View File

@ -0,0 +1,26 @@
---
title: callStateReady
description: Call is ready to use
---
## Constructor: callStateReady
[Back to constructors index](index.md)
Call is ready to use
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|protocol|[callProtocol](../types/callProtocol.md) | Yes|Call protocols supported by the peer|
|connections|Array of [callConnection](../constructors/callConnection.md) | Yes|Available UDP reflectors|
|config|[string](../types/string.md) | Yes|JSON-encoded call config|
|encryption\_key|[bytes](../types/bytes.md) | Yes|Call encryption key|
|emojis|Array of [string](../constructors/string.md) | Yes|Encryption key emojis fingerprint|
### Type: [CallState](../types/CallState.md)

View File

@ -1,13 +1,13 @@
--- ---
title: callbackQueryAnswer title: callbackQueryAnswer
description: Contains answer of the bot to the callback query description: Contains answer of a bot to a callback query
--- ---
## Constructor: callbackQueryAnswer ## Constructor: callbackQueryAnswer
[Back to constructors index](index.md) [Back to constructors index](index.md)
Contains answer of the bot to the callback query Contains answer of a bot to a callback query
### Attributes: ### Attributes:

View File

@ -1,8 +1,8 @@
--- ---
title: callbackQueryData title: callbackQueryPayloadData
description: Payload from a general callback button description: Payload from a general callback button
--- ---
## Constructor: callbackQueryData ## Constructor: callbackQueryPayloadData
[Back to constructors index](index.md) [Back to constructors index](index.md)
@ -13,7 +13,7 @@ Payload from a general callback button
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|data|[bytes](../types/bytes.md) | Yes|Data that was attached to the callback button as specified by the users client| |data|[bytes](../types/bytes.md) | Yes|Data that was attached to the callback button|

View File

@ -1,8 +1,8 @@
--- ---
title: callbackQueryGame title: callbackQueryPayloadGame
description: Payload from a game callback button description: Payload from a game callback button
--- ---
## Constructor: callbackQueryGame ## Constructor: callbackQueryPayloadGame
[Back to constructors index](index.md) [Back to constructors index](index.md)

View File

@ -21,7 +21,7 @@ Represents a channel with zero or more subscribers. There two different kinds of
|sign\_messages|[Bool](../types/Bool.md) | Yes|True, if messages sent to the channel should content information about the sender. If the channel is a supergroup, the field is meaningless| |sign\_messages|[Bool](../types/Bool.md) | Yes|True, if messages sent to the channel should content information about the sender. If the channel is a supergroup, the field is meaningless|
|is\_supergroup|[Bool](../types/Bool.md) | Yes|True, if channel is a supergroup and is not a broadcast| |is\_supergroup|[Bool](../types/Bool.md) | Yes|True, if channel is a supergroup and is not a broadcast|
|is\_verified|[Bool](../types/Bool.md) | Yes|True, if the channel is verified| |is\_verified|[Bool](../types/Bool.md) | Yes|True, if the channel is verified|
|restriction\_reason|[string](../types/string.md) | Yes|If non-empty, contains the reason, why access to this channel must be restricted. Format of the string is "{type}: {description}".-{type} contains type of the restriction and at least one of the suffixes "-all", "-ios", "-android", "-wp", which describes platforms on which access should be restricted. For example, "terms-ios-android". {description} contains human-readable description of the restriction, which can be showed to the user| |restriction\_reason|[string](../types/string.md) | Yes|If non-empty, contains the reason, why access to this channel must be restricted. Format of the string is "{type}: {description}". {type} contains type of the restriction and at least one of the suffixes "-all", "-ios", "-android", "-wp", which describes platforms on which access should be restricted. For example, "terms-ios-android". {description} contains human-readable description of the restriction, which can be showed to the user|

View File

@ -13,17 +13,17 @@ Gives full information about a channel
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|channel|[channel](../types/channel.md) | Yes|General info about the channel| |description|[string](../types/string.md) | Yes|Channel description|
|about|[string](../types/string.md) | Yes|Information about the channel|
|member\_count|[int](../types/int.md) | Yes|Channel member count, 0 if unknown| |member\_count|[int](../types/int.md) | Yes|Channel member count, 0 if unknown|
|administrator\_count|[int](../types/int.md) | Yes|Number of privileged users in the channel, 0 if unknown| |administrator\_count|[int](../types/int.md) | Yes|Number of privileged users in the channel, 0 if unknown|
|kicked\_count|[int](../types/int.md) | Yes|Number of users kicked from the channel, 0 if unknown| |restricted\_count|[int](../types/int.md) | Yes|Number of restricted users in the channel, 0 if unknown|
|banned\_count|[int](../types/int.md) | Yes|Number of users banned from the channel, 0 if unknown|
|can\_get\_members|[Bool](../types/Bool.md) | Yes|True, if members of the channel can be retrieved| |can\_get\_members|[Bool](../types/Bool.md) | Yes|True, if members of the channel can be retrieved|
|can\_set\_username|[Bool](../types/Bool.md) | Yes|True, if channel can be made public| |can\_set\_username|[Bool](../types/Bool.md) | Yes|True, if channel can be made public|
|invite\_link|[string](../types/string.md) | Yes|Invite link for this channel| |invite\_link|[string](../types/string.md) | Yes|Invite link for this channel|
|pinned\_message\_id|[long](../types/long.md) | Yes|Identifier of the pinned message in the channel chat, or 0 if none| |pinned\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the pinned message in the channel chat, or 0 if none|
|migrated\_from\_group\_id|[int](../types/int.md) | Yes|Identifier of the group, this supergroup migrated from, or 0 if none| |migrated\_from\_group\_id|[int](../types/int.md) | Yes|Identifier of the group, this supergroup migrated from, or 0 if none|
|migrated\_from\_max\_message\_id|[long](../types/long.md) | Yes|Identifier of last message in the group chat migrated from, or 0 if none| |migrated\_from\_max\_message\_id|[int53](../types/int53.md) | Yes|Identifier of last message in the group chat migrated from, or 0 if none|

View File

@ -1,21 +0,0 @@
---
title: channelMembersAdministrators
description: Return privileged members, i.e. creator, editors and moderators are returned
---
## Constructor: channelMembersAdministrators
[Back to constructors index](index.md)
Return privileged members, i.e. creator, editors and moderators are returned
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [ChannelMembersFilter](../types/ChannelMembersFilter.md)

View File

@ -1,13 +1,13 @@
--- ---
title: channelMembersBots title: channelMembersFilterAdministrators
description: Return bots in the channel description: Return creator and administrators
--- ---
## Constructor: channelMembersBots ## Constructor: channelMembersFilterAdministrators
[Back to constructors index](index.md) [Back to constructors index](index.md)
Return bots in the channel Return creator and administrators
### Attributes: ### Attributes:

View File

@ -0,0 +1,22 @@
---
title: channelMembersFilterBanned
description: Return banned from the channel users, administrators only
---
## Constructor: channelMembersFilterBanned
[Back to constructors index](index.md)
Return banned from the channel users, administrators only
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|query|[string](../types/string.md) | Yes|Query to search for|
### Type: [ChannelMembersFilter](../types/ChannelMembersFilter.md)

View File

@ -1,13 +1,13 @@
--- ---
title: channelMembersKicked title: channelMembersFilterBots
description: Return kicked from the channel description: Return bot members of the channel
--- ---
## Constructor: channelMembersKicked ## Constructor: channelMembersFilterBots
[Back to constructors index](index.md) [Back to constructors index](index.md)
Return kicked from the channel Return bot members of the channel
### Attributes: ### Attributes:

View File

@ -1,8 +1,8 @@
--- ---
title: channelMembersRecent title: channelMembersFilterRecent
description: Return recently active users in reverse chronological order description: Return recently active users in reverse chronological order
--- ---
## Constructor: channelMembersRecent ## Constructor: channelMembersFilterRecent
[Back to constructors index](index.md) [Back to constructors index](index.md)

View File

@ -0,0 +1,22 @@
---
title: channelMembersFilterRestricted
description: Return restricted channel members, administrators only
---
## Constructor: channelMembersFilterRestricted
[Back to constructors index](index.md)
Return restricted channel members, administrators only
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|query|[string](../types/string.md) | Yes|Query to search for|
### Type: [ChannelMembersFilter](../types/ChannelMembersFilter.md)

View File

@ -0,0 +1,22 @@
---
title: channelMembersFilterSearch
description: Searches for channel members using specified query
---
## Constructor: channelMembersFilterSearch
[Back to constructors index](index.md)
Searches for channel members using specified query
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|query|[string](../types/string.md) | Yes|Query to search for|
### Type: [ChannelMembersFilter](../types/ChannelMembersFilter.md)

View File

@ -1,22 +0,0 @@
---
title: channels
description: Contains list of channel identifiers
---
## Constructor: channels
[Back to constructors index](index.md)
Contains list of channel identifiers
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel\_ids|Array of [int](../constructors/int.md) | Yes|List of channel identifiers|
### Type: [Channels](../types/Channels.md)

View File

@ -13,18 +13,20 @@ Chat (private chat or group chat or channel chat)
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|id|[long](../types/long.md) | Yes|Chat unique identifier| |id|[int53](../types/int53.md) | Yes|Chat unique identifier|
|type|[ChatType](../types/ChatType.md) | Yes|Information about type of the chat|
|title|[string](../types/string.md) | Yes|Chat title| |title|[string](../types/string.md) | Yes|Chat title|
|photo|[chatPhoto](../types/chatPhoto.md) | Yes|Chat photo, nullable| |photo|[chatPhoto](../types/chatPhoto.md) | Yes|Chat photo, nullable|
|top\_message|[message](../types/message.md) | Yes|Last message in the chat, nullable| |top\_message|[message](../types/message.md) | Yes|Last message in the chat, nullable|
|order|[long](../types/long.md) | Yes|Parameter by descending of which chats are sorted in the chat list. If order of two chats is equal, then they need to be sorted by id also in descending order. If order == 0, position of the chat in the list is undetermined.| |order|[long](../types/long.md) | Yes|Parameter by descending of which chats are sorted in the chat list. If order of two chats is equal, then they need to be sorted by id also in descending order. If order == 0, position of the chat in the list is undetermined|
|is\_pinned|[Bool](../types/Bool.md) | Yes|True, if the chat is pinned|
|unread\_count|[int](../types/int.md) | Yes|Count of unread messages in the chat| |unread\_count|[int](../types/int.md) | Yes|Count of unread messages in the chat|
|last\_read\_inbox\_message\_id|[long](../types/long.md) | Yes|Identifier of last read incoming message| |last\_read\_inbox\_message\_id|[int53](../types/int53.md) | Yes|Identifier of last read incoming message|
|last\_read\_outbox\_message\_id|[long](../types/long.md) | Yes|Identifier of last read outgoing message| |last\_read\_outbox\_message\_id|[int53](../types/int53.md) | Yes|Identifier of last read outgoing message|
|notification\_settings|[notificationSettings](../types/notificationSettings.md) | Yes|Notification settings for this chat| |notification\_settings|[notificationSettings](../types/notificationSettings.md) | Yes|Notification settings for this chat|
|reply\_markup\_message\_id|[long](../types/long.md) | Yes|Identifier of the message from which reply markup need to be used or 0 if there is no default custom reply markup in the chat| |reply\_markup\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message from which reply markup need to be used or 0 if there is no default custom reply markup in the chat|
|draft\_message|[draftMessage](../types/draftMessage.md) | Yes|Draft of a message in the chat, nullable. parse_mode in input_message_text always will be null| |draft\_message|[draftMessage](../types/draftMessage.md) | Yes|Draft of a message in the chat, nullable. parse_mode in input_message_text always will be null|
|type|[ChatInfo](../types/ChatInfo.md) | Yes|Information about type of the chat| |client\_data|[string](../types/string.md) | Yes|Client specified data, associated with the chat. For example, chat position or local chat notification settings may be stored here. Persistent if message db is used|

View File

@ -0,0 +1,21 @@
---
title: chatActionCancel
description: User cancels previous action
---
## Constructor: chatActionCancel
[Back to constructors index](index.md)
User cancels previous action
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [ChatAction](../types/ChatAction.md)

View File

@ -1,8 +1,8 @@
--- ---
title: sendMessageChooseContactAction title: chatActionChoosingContact
description: User chooses contact to send description: User chooses contact to send
--- ---
## Constructor: sendMessageChooseContactAction ## Constructor: chatActionChoosingContact
[Back to constructors index](index.md) [Back to constructors index](index.md)
@ -16,6 +16,6 @@ User chooses contact to send
### Type: [SendMessageAction](../types/SendMessageAction.md) ### Type: [ChatAction](../types/ChatAction.md)

View File

@ -0,0 +1,21 @@
---
title: chatActionChoosingLocation
description: User chooses location or venue to send
---
## Constructor: chatActionChoosingLocation
[Back to constructors index](index.md)
User chooses location or venue to send
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [ChatAction](../types/ChatAction.md)

View File

@ -1,8 +1,8 @@
--- ---
title: sendMessageRecordVideoAction title: chatActionRecordingVideo
description: User records a video description: User records a video
--- ---
## Constructor: sendMessageRecordVideoAction ## Constructor: chatActionRecordingVideo
[Back to constructors index](index.md) [Back to constructors index](index.md)
@ -16,6 +16,6 @@ User records a video
### Type: [SendMessageAction](../types/SendMessageAction.md) ### Type: [ChatAction](../types/ChatAction.md)

View File

@ -0,0 +1,21 @@
---
title: chatActionRecordingVideoNote
description: User records video note
---
## Constructor: chatActionRecordingVideoNote
[Back to constructors index](index.md)
User records video note
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [ChatAction](../types/ChatAction.md)

View File

@ -1,8 +1,8 @@
--- ---
title: sendMessageRecordVoiceAction title: chatActionRecordingVoice
description: User records voice message description: User records voice message
--- ---
## Constructor: sendMessageRecordVoiceAction ## Constructor: chatActionRecordingVoice
[Back to constructors index](index.md) [Back to constructors index](index.md)
@ -16,6 +16,6 @@ User records voice message
### Type: [SendMessageAction](../types/SendMessageAction.md) ### Type: [ChatAction](../types/ChatAction.md)

View File

@ -1,8 +1,8 @@
--- ---
title: sendMessageStartPlayGameAction title: chatActionStartPlayingGame
description: User starts to play a game description: User starts to play a game
--- ---
## Constructor: sendMessageStartPlayGameAction ## Constructor: chatActionStartPlayingGame
[Back to constructors index](index.md) [Back to constructors index](index.md)
@ -16,6 +16,6 @@ User starts to play a game
### Type: [SendMessageAction](../types/SendMessageAction.md) ### Type: [ChatAction](../types/ChatAction.md)

View File

@ -0,0 +1,21 @@
---
title: chatActionTyping
description: User typing a message
---
## Constructor: chatActionTyping
[Back to constructors index](index.md)
User typing a message
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [ChatAction](../types/ChatAction.md)

View File

@ -1,8 +1,8 @@
--- ---
title: sendMessageUploadDocumentAction title: chatActionUploadingDocument
description: User uploads a document description: User uploads a document
--- ---
## Constructor: sendMessageUploadDocumentAction ## Constructor: chatActionUploadingDocument
[Back to constructors index](index.md) [Back to constructors index](index.md)
@ -17,6 +17,6 @@ User uploads a document
### Type: [SendMessageAction](../types/SendMessageAction.md) ### Type: [ChatAction](../types/ChatAction.md)

View File

@ -1,8 +1,8 @@
--- ---
title: sendMessageUploadPhotoAction title: chatActionUploadingPhoto
description: User uploads a photo description: User uploads a photo
--- ---
## Constructor: sendMessageUploadPhotoAction ## Constructor: chatActionUploadingPhoto
[Back to constructors index](index.md) [Back to constructors index](index.md)
@ -17,6 +17,6 @@ User uploads a photo
### Type: [SendMessageAction](../types/SendMessageAction.md) ### Type: [ChatAction](../types/ChatAction.md)

View File

@ -1,8 +1,8 @@
--- ---
title: sendMessageUploadVideoAction title: chatActionUploadingVideo
description: User uploads a video description: User uploads a video
--- ---
## Constructor: sendMessageUploadVideoAction ## Constructor: chatActionUploadingVideo
[Back to constructors index](index.md) [Back to constructors index](index.md)
@ -17,6 +17,6 @@ User uploads a video
### Type: [SendMessageAction](../types/SendMessageAction.md) ### Type: [ChatAction](../types/ChatAction.md)

View File

@ -0,0 +1,22 @@
---
title: chatActionUploadingVideoNote
description: User uploads a video note
---
## Constructor: chatActionUploadingVideoNote
[Back to constructors index](index.md)
User uploads a video note
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|progress|[int](../types/int.md) | Yes|Upload progress in percents|
### Type: [ChatAction](../types/ChatAction.md)

View File

@ -1,8 +1,8 @@
--- ---
title: sendMessageUploadVoiceAction title: chatActionUploadingVoice
description: User uploads voice message description: User uploads voice message
--- ---
## Constructor: sendMessageUploadVoiceAction ## Constructor: chatActionUploadingVoice
[Back to constructors index](index.md) [Back to constructors index](index.md)
@ -17,6 +17,6 @@ User uploads voice message
### Type: [SendMessageAction](../types/SendMessageAction.md) ### Type: [ChatAction](../types/ChatAction.md)

View File

@ -0,0 +1,25 @@
---
title: chatEvent
description: Represents a chat event
---
## Constructor: chatEvent
[Back to constructors index](index.md)
Represents a chat event
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|id|[long](../types/long.md) | Yes|Chat event identifier|
|date|[int](../types/int.md) | Yes|Date of the event, unix time|
|user\_id|[int](../types/int.md) | Yes|Identifier of a user who made the action|
|action|[ChatEventAction](../types/ChatEventAction.md) | Yes|Action done by the user|
### Type: [ChatEvent](../types/ChatEvent.md)

View File

@ -0,0 +1,23 @@
---
title: chatEventDescriptionChanged
description: Chat description changed
---
## Constructor: chatEventDescriptionChanged
[Back to constructors index](index.md)
Chat description changed
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|old\_description|[string](../types/string.md) | Yes|Old description value|
|new\_description|[string](../types/string.md) | Yes|New description value|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,22 @@
---
title: chatEventInvitesToggled
description: Supergroup channel chat anyone_can_invite setting was toggled
---
## Constructor: chatEventInvitesToggled
[Back to constructors index](index.md)
Supergroup channel chat anyone_can_invite setting was toggled
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|anyone\_can\_invite|[Bool](../types/Bool.md) | Yes|New value of anyone_can_invite|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,31 @@
---
title: chatEventLogFilters
description: Represents a set of filters used to obtain a chat event log
---
## Constructor: chatEventLogFilters
[Back to constructors index](index.md)
Represents a set of filters used to obtain a chat event log
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|message\_edits|[Bool](../types/Bool.md) | Yes|True, if message edits should be returned|
|message\_deletions|[Bool](../types/Bool.md) | Yes|True, if message deletions should be returned|
|message\_pins|[Bool](../types/Bool.md) | Yes|True, if message pins should be returned|
|member\_joins|[Bool](../types/Bool.md) | Yes|True, if chat member joins should be returned|
|member\_leaves|[Bool](../types/Bool.md) | Yes|True, if chat member leaves should be returned|
|member\_invites|[Bool](../types/Bool.md) | Yes|True, if chat member invites should be returned|
|member\_promotions|[Bool](../types/Bool.md) | Yes|True, if chat member promotions/demotions should be returned|
|member\_restrictions|[Bool](../types/Bool.md) | Yes|True, if chat member restrictions/unrestrictions including bans/unbans should be returned|
|info\_changes|[Bool](../types/Bool.md) | Yes|True, if changes of chat information should be returned|
|setting\_changes|[Bool](../types/Bool.md) | Yes|True, if changes of chat settings should be returned|
### Type: [ChatEventLogFilters](../types/ChatEventLogFilters.md)

View File

@ -0,0 +1,23 @@
---
title: chatEventMemberInvited
description: New chat member invited
---
## Constructor: chatEventMemberInvited
[Back to constructors index](index.md)
New chat member invited
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|user\_id|[int](../types/int.md) | Yes|New chat member user identifier|
|status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|New chat member status|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,21 @@
---
title: chatEventMemberJoined
description: New chat member joined
---
## Constructor: chatEventMemberJoined
[Back to constructors index](index.md)
New chat member joined
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,21 @@
---
title: chatEventMemberLeft
description: A chat member left
---
## Constructor: chatEventMemberLeft
[Back to constructors index](index.md)
A chat member left
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,24 @@
---
title: chatEventMemberPromoted
description: A chat member promoted to/demoted from administrators
---
## Constructor: chatEventMemberPromoted
[Back to constructors index](index.md)
A chat member promoted to/demoted from administrators
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|user\_id|[int](../types/int.md) | Yes|Chat member user identifier|
|old\_status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|Old chat member status|
|new\_status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|New chat member status|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,24 @@
---
title: chatEventMemberRestricted
description: A chat member restricted/unrestircted or banned/unbanned
---
## Constructor: chatEventMemberRestricted
[Back to constructors index](index.md)
A chat member restricted/unrestircted or banned/unbanned
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|user\_id|[int](../types/int.md) | Yes|Chat member user identifier|
|old\_status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|Old chat member status|
|new\_status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|New chat member status|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,22 @@
---
title: chatEventMessageDeleted
description: A message was deleted
---
## Constructor: chatEventMessageDeleted
[Back to constructors index](index.md)
A message was deleted
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|message|[message](../types/message.md) | Yes|Deleted message|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,23 @@
---
title: chatEventMessageEdited
description: A message was edited
---
## Constructor: chatEventMessageEdited
[Back to constructors index](index.md)
A message was edited
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|old\_message|[message](../types/message.md) | Yes|Message before edit|
|new\_message|[message](../types/message.md) | Yes|Message after edit|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,22 @@
---
title: chatEventMessagePinned
description: A message was pinned
---
## Constructor: chatEventMessagePinned
[Back to constructors index](index.md)
A message was pinned
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|message|[message](../types/message.md) | Yes|Pinned message|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,21 @@
---
title: chatEventMessageUnpinned
description: A message was unpinned
---
## Constructor: chatEventMessageUnpinned
[Back to constructors index](index.md)
A message was unpinned
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,23 @@
---
title: chatEventPhotoChanged
description: Chat photo changed
---
## Constructor: chatEventPhotoChanged
[Back to constructors index](index.md)
Chat photo changed
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|old\_photo|[chatPhoto](../types/chatPhoto.md) | Yes|Old photo value|
|new\_photo|[chatPhoto](../types/chatPhoto.md) | Yes|New photo value|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,22 @@
---
title: chatEventSignMessagesToggled
description: Broadcast channel chat sign_messages setting was toggled
---
## Constructor: chatEventSignMessagesToggled
[Back to constructors index](index.md)
Broadcast channel chat sign_messages setting was toggled
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|sign\_messages|[Bool](../types/Bool.md) | Yes|New value of sign_messages|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,23 @@
---
title: chatEventTitleChanged
description: Chat title changed
---
## Constructor: chatEventTitleChanged
[Back to constructors index](index.md)
Chat title changed
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|old\_title|[string](../types/string.md) | Yes|Old title value|
|new\_title|[string](../types/string.md) | Yes|New title value|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,23 @@
---
title: chatEventUsernameChanged
description: Chat username changed
---
## Constructor: chatEventUsernameChanged
[Back to constructors index](index.md)
Chat username changed
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|old\_username|[string](../types/string.md) | Yes|Old username value|
|new\_username|[string](../types/string.md) | Yes|New username value|
### Type: [ChatEventAction](../types/ChatEventAction.md)

View File

@ -0,0 +1,22 @@
---
title: chatEvents
description: Contains list of chat events
---
## Constructor: chatEvents
[Back to constructors index](index.md)
Contains list of chat events
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|events|Array of [chatEvent](../constructors/chatEvent.md) | Yes|The events|
### Type: [ChatEvents](../types/ChatEvents.md)

View File

@ -13,11 +13,11 @@ Contains information about chat invite link
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|chat\_id|[long](../types/long.md) | Yes|Chat identifier of the invite link or 0 if user is not a member of this chat| |chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the invite link or 0 if user is not a member of this chat|
|title|[string](../types/string.md) | Yes|Title of the chat| |title|[string](../types/string.md) | Yes|Title of the chat|
|photo|[chatPhoto](../types/chatPhoto.md) | Yes|Chat photo, nullable| |photo|[chatPhoto](../types/chatPhoto.md) | Yes|Chat photo, nullable|
|member\_count|[int](../types/int.md) | Yes|Total member count| |member\_count|[int](../types/int.md) | Yes|Total member count|
|members|Array of [user](../constructors/user.md) | Yes|Some chat members that may be known to the current user| |member\_user\_ids|Array of [int](../constructors/int.md) | Yes|User identifiers of some chat members that may be known to the current user|
|is\_group|[Bool](../types/Bool.md) | Yes|True, if the chat is a group chat| |is\_group|[Bool](../types/Bool.md) | Yes|True, if the chat is a group chat|
|is\_channel|[Bool](../types/Bool.md) | Yes|True, if the chat is a channel chat| |is\_channel|[Bool](../types/Bool.md) | Yes|True, if the chat is a channel chat|
|is\_public\_channel|[Bool](../types/Bool.md) | Yes|True, if the chat is a channel chat with set up username| |is\_public\_channel|[Bool](../types/Bool.md) | Yes|True, if the chat is a channel chat with set up username|

View File

@ -1,20 +1,20 @@
--- ---
title: chatMember title: chatMember
description: User with information about its chat joining/kicking description: User with information about its chat joining/leaving
--- ---
## Constructor: chatMember ## Constructor: chatMember
[Back to constructors index](index.md) [Back to constructors index](index.md)
User with information about its chat joining/kicking User with information about its chat joining/leaving
### Attributes: ### Attributes:
| Name | Type | Required | Description | | Name | Type | Required | Description |
|----------|---------------|----------|-------------| |----------|---------------|----------|-------------|
|user\_id|[int](../types/int.md) | Yes|User identifier of the chat member| |user\_id|[int](../types/int.md) | Yes|User identifier of the chat member|
|inviter\_user\_id|[int](../types/int.md) | Yes|Identifier of a user invited this member to/kicked this member from the chat, 0 if unknown| |inviter\_user\_id|[int](../types/int.md) | Yes|Identifier of a user invited/promoted/banned this member in the chat, 0 if unknown|
|join\_date|[int](../types/int.md) | Yes|Date the user has joined a chat, unix time| |join\_date|[int](../types/int.md) | Yes|Date the user has joined a chat, unix time|
|status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|Status of the member in the chat| |status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|Status of the member in the chat|
|bot\_info|[botInfo](../types/botInfo.md) | Yes|Information about bot if user is a bot, nullable. Can be null even for bot if bot is not a chat member| |bot\_info|[botInfo](../types/botInfo.md) | Yes|Information about bot if user is a bot, nullable. Can be null even for bot if bot is not a chat member|

Some files were not shown because too many files have changed in this diff Show More