diff --git a/docs/API_docs/constructors/messageEntityBold.md b/docs/API_docs/constructors/messageEntityBold.md index 11cb06c5..cc3cab6d 100644 --- a/docs/API_docs/constructors/messageEntityBold.md +++ b/docs/API_docs/constructors/messageEntityBold.md @@ -1,20 +1,18 @@ --- title: messageEntityBold -description: Bold text +description: messageEntityBold attributes, type and example --- ## Constructor: messageEntityBold [Back to constructors index](index.md) -Bold text - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/messageEntityBotCommand.md b/docs/API_docs/constructors/messageEntityBotCommand.md index e0329dc5..d793ab58 100644 --- a/docs/API_docs/constructors/messageEntityBotCommand.md +++ b/docs/API_docs/constructors/messageEntityBotCommand.md @@ -1,20 +1,18 @@ --- title: messageEntityBotCommand -description: Bot command beginning with / +description: messageEntityBotCommand attributes, type and example --- ## Constructor: messageEntityBotCommand [Back to constructors index](index.md) -Bot command beginning with / - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/messageEntityCode.md b/docs/API_docs/constructors/messageEntityCode.md index f2f499a3..3063318e 100644 --- a/docs/API_docs/constructors/messageEntityCode.md +++ b/docs/API_docs/constructors/messageEntityCode.md @@ -1,20 +1,18 @@ --- title: messageEntityCode -description: Text needs to be formatted as inside of code HTML tag +description: messageEntityCode attributes, type and example --- ## Constructor: messageEntityCode [Back to constructors index](index.md) -Text needs to be formatted as inside of code HTML tag - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/messageEntityEmail.md b/docs/API_docs/constructors/messageEntityEmail.md index e280d9ff..7b6273df 100644 --- a/docs/API_docs/constructors/messageEntityEmail.md +++ b/docs/API_docs/constructors/messageEntityEmail.md @@ -1,20 +1,18 @@ --- title: messageEntityEmail -description: Email +description: messageEntityEmail attributes, type and example --- ## Constructor: messageEntityEmail [Back to constructors index](index.md) -Email - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/messageEntityHashtag.md b/docs/API_docs/constructors/messageEntityHashtag.md index a448772a..0475ae7c 100644 --- a/docs/API_docs/constructors/messageEntityHashtag.md +++ b/docs/API_docs/constructors/messageEntityHashtag.md @@ -1,20 +1,18 @@ --- title: messageEntityHashtag -description: Hashtag beginning with # +description: messageEntityHashtag attributes, type and example --- ## Constructor: messageEntityHashtag [Back to constructors index](index.md) -Hashtag beginning with # - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/messageEntityItalic.md b/docs/API_docs/constructors/messageEntityItalic.md index 063905d2..00973bb5 100644 --- a/docs/API_docs/constructors/messageEntityItalic.md +++ b/docs/API_docs/constructors/messageEntityItalic.md @@ -1,20 +1,18 @@ --- title: messageEntityItalic -description: Italic text +description: messageEntityItalic attributes, type and example --- ## Constructor: messageEntityItalic [Back to constructors index](index.md) -Italic text - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/messageEntityMention.md b/docs/API_docs/constructors/messageEntityMention.md index 1a81c8b0..15231c0d 100644 --- a/docs/API_docs/constructors/messageEntityMention.md +++ b/docs/API_docs/constructors/messageEntityMention.md @@ -1,20 +1,18 @@ --- title: messageEntityMention -description: Mention of the user by his username +description: messageEntityMention attributes, type and example --- ## Constructor: messageEntityMention [Back to constructors index](index.md) -Mention of the user by his username - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/messageEntityMentionName.md b/docs/API_docs/constructors/messageEntityMentionName.md index bb100fce..6f8d6da2 100644 --- a/docs/API_docs/constructors/messageEntityMentionName.md +++ b/docs/API_docs/constructors/messageEntityMentionName.md @@ -1,21 +1,19 @@ --- title: messageEntityMentionName -description: Mention of the user by some text +description: messageEntityMentionName attributes, type and example --- ## Constructor: messageEntityMentionName [Back to constructors index](index.md) -Mention of the user by some text - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| -|user\_id|[int](../types/int.md) | Yes|Identifier of the mentioned user| +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/messageEntityTextUrl.md b/docs/API_docs/constructors/messageEntityTextUrl.md index 975fff17..82f7e686 100644 --- a/docs/API_docs/constructors/messageEntityTextUrl.md +++ b/docs/API_docs/constructors/messageEntityTextUrl.md @@ -1,21 +1,19 @@ --- title: messageEntityTextUrl -description: Text description showed instead of the url +description: messageEntityTextUrl attributes, type and example --- ## Constructor: messageEntityTextUrl [Back to constructors index](index.md) -Text description showed instead of the url - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| -|url|[string](../types/string.md) | Yes|Url to be opened after link will be clicked| +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| +|url|[string](../types/string.md) | Yes| diff --git a/docs/API_docs/constructors/messageEntityUrl.md b/docs/API_docs/constructors/messageEntityUrl.md index 7508edf6..ca0a7dfa 100644 --- a/docs/API_docs/constructors/messageEntityUrl.md +++ b/docs/API_docs/constructors/messageEntityUrl.md @@ -1,20 +1,18 @@ --- title: messageEntityUrl -description: Url beginning with http +description: messageEntityUrl attributes, type and example --- ## Constructor: messageEntityUrl [Back to constructors index](index.md) -Url beginning with http - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/pageBlockAnchor.md b/docs/API_docs/constructors/pageBlockAnchor.md index 5f4a1246..8c648aba 100644 --- a/docs/API_docs/constructors/pageBlockAnchor.md +++ b/docs/API_docs/constructors/pageBlockAnchor.md @@ -1,17 +1,19 @@ --- 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 [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: -| Name | Type | Required | -|----------|---------------|----------| -|name|[string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|name|[string](../types/string.md) | Yes|Name of the anchor| diff --git a/docs/API_docs/constructors/pageBlockCover.md b/docs/API_docs/constructors/pageBlockCover.md index 55456fe1..fa8d0a37 100644 --- a/docs/API_docs/constructors/pageBlockCover.md +++ b/docs/API_docs/constructors/pageBlockCover.md @@ -1,17 +1,19 @@ --- title: pageBlockCover -description: pageBlockCover attributes, type and example +description: Page cover --- ## Constructor: pageBlockCover [Back to constructors index](index.md) +Page cover + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|cover|[PageBlock](../types/PageBlock.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|cover|[PageBlock](../types/PageBlock.md) | Yes|The cover| diff --git a/docs/API_docs/constructors/pageBlockDivider.md b/docs/API_docs/constructors/pageBlockDivider.md index 05080a18..d2bfbc92 100644 --- a/docs/API_docs/constructors/pageBlockDivider.md +++ b/docs/API_docs/constructors/pageBlockDivider.md @@ -1,12 +1,18 @@ --- title: pageBlockDivider -description: pageBlockDivider attributes, type and example +description: An empty block separating parts of a page --- ## Constructor: pageBlockDivider [Back to constructors index](index.md) +An empty block separating parts of a page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/pageBlockParagraph.md b/docs/API_docs/constructors/pageBlockParagraph.md index 4366f341..f03f6728 100644 --- a/docs/API_docs/constructors/pageBlockParagraph.md +++ b/docs/API_docs/constructors/pageBlockParagraph.md @@ -1,17 +1,19 @@ --- title: pageBlockParagraph -description: pageBlockParagraph attributes, type and example +description: A text paragraph --- ## Constructor: pageBlockParagraph [Back to constructors index](index.md) +A text paragraph + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|text|[RichText](../types/RichText.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Paragraph text| diff --git a/docs/API_docs/constructors/pageBlockPreformatted.md b/docs/API_docs/constructors/pageBlockPreformatted.md index 7d92da27..a2fefa9c 100644 --- a/docs/API_docs/constructors/pageBlockPreformatted.md +++ b/docs/API_docs/constructors/pageBlockPreformatted.md @@ -1,18 +1,20 @@ --- title: pageBlockPreformatted -description: pageBlockPreformatted attributes, type and example +description: Preformatted text paragraph --- ## Constructor: pageBlockPreformatted [Back to constructors index](index.md) +Preformatted text paragraph + ### Attributes: -| Name | Type | Required | -|----------|---------------|----------| -|text|[RichText](../types/RichText.md) | Yes| -|language|[string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Paragraph text| +|language|[string](../types/string.md) | Yes|Programming language for which the text should be formatted| diff --git a/docs/API_docs/constructors/sendMessageCancelAction.md b/docs/API_docs/constructors/sendMessageCancelAction.md index 1fa708fb..e0912b17 100644 --- a/docs/API_docs/constructors/sendMessageCancelAction.md +++ b/docs/API_docs/constructors/sendMessageCancelAction.md @@ -1,18 +1,12 @@ --- title: sendMessageCancelAction -description: User cancels typing +description: sendMessageCancelAction attributes, type and example --- ## Constructor: sendMessageCancelAction [Back to constructors index](index.md) -User cancels typing - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageCancelAction_17.md b/docs/API_docs/constructors/sendMessageCancelAction_17.md index cc1854f5..c5333102 100644 --- a/docs/API_docs/constructors/sendMessageCancelAction_17.md +++ b/docs/API_docs/constructors/sendMessageCancelAction_17.md @@ -1,18 +1,12 @@ --- title: sendMessageCancelAction -description: User cancels typing +description: sendMessageCancelAction attributes, type and example --- ## Constructor: sendMessageCancelAction\_17 [Back to constructors index](index.md) -User cancels typing - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageChooseContactAction.md b/docs/API_docs/constructors/sendMessageChooseContactAction.md index 33a6c19a..b26c05a2 100644 --- a/docs/API_docs/constructors/sendMessageChooseContactAction.md +++ b/docs/API_docs/constructors/sendMessageChooseContactAction.md @@ -1,18 +1,12 @@ --- title: sendMessageChooseContactAction -description: User chooses contact to send +description: sendMessageChooseContactAction attributes, type and example --- ## Constructor: sendMessageChooseContactAction [Back to constructors index](index.md) -User chooses contact to send - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageChooseContactAction_17.md b/docs/API_docs/constructors/sendMessageChooseContactAction_17.md index f3582c5c..61efb32f 100644 --- a/docs/API_docs/constructors/sendMessageChooseContactAction_17.md +++ b/docs/API_docs/constructors/sendMessageChooseContactAction_17.md @@ -1,18 +1,12 @@ --- title: sendMessageChooseContactAction -description: User chooses contact to send +description: sendMessageChooseContactAction attributes, type and example --- ## Constructor: sendMessageChooseContactAction\_17 [Back to constructors index](index.md) -User chooses contact to send - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageGeoLocationAction.md b/docs/API_docs/constructors/sendMessageGeoLocationAction.md index cf39f9e5..71d2cee0 100644 --- a/docs/API_docs/constructors/sendMessageGeoLocationAction.md +++ b/docs/API_docs/constructors/sendMessageGeoLocationAction.md @@ -1,18 +1,12 @@ --- title: sendMessageGeoLocationAction -description: User sends geolocation +description: sendMessageGeoLocationAction attributes, type and example --- ## Constructor: sendMessageGeoLocationAction [Back to constructors index](index.md) -User sends geolocation - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageGeoLocationAction_17.md b/docs/API_docs/constructors/sendMessageGeoLocationAction_17.md index bbec2aa3..a0791b5a 100644 --- a/docs/API_docs/constructors/sendMessageGeoLocationAction_17.md +++ b/docs/API_docs/constructors/sendMessageGeoLocationAction_17.md @@ -1,18 +1,12 @@ --- title: sendMessageGeoLocationAction -description: User sends geolocation +description: sendMessageGeoLocationAction attributes, type and example --- ## Constructor: sendMessageGeoLocationAction\_17 [Back to constructors index](index.md) -User sends geolocation - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageRecordVideoAction.md b/docs/API_docs/constructors/sendMessageRecordVideoAction.md index 36433ca4..5a08f180 100644 --- a/docs/API_docs/constructors/sendMessageRecordVideoAction.md +++ b/docs/API_docs/constructors/sendMessageRecordVideoAction.md @@ -1,18 +1,12 @@ --- title: sendMessageRecordVideoAction -description: User records a video +description: sendMessageRecordVideoAction attributes, type and example --- ## Constructor: sendMessageRecordVideoAction [Back to constructors index](index.md) -User records a video - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageRecordVideoAction_17.md b/docs/API_docs/constructors/sendMessageRecordVideoAction_17.md index fc5f040a..2879a155 100644 --- a/docs/API_docs/constructors/sendMessageRecordVideoAction_17.md +++ b/docs/API_docs/constructors/sendMessageRecordVideoAction_17.md @@ -1,18 +1,12 @@ --- title: sendMessageRecordVideoAction -description: User records a video +description: sendMessageRecordVideoAction attributes, type and example --- ## Constructor: sendMessageRecordVideoAction\_17 [Back to constructors index](index.md) -User records a video - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageTypingAction.md b/docs/API_docs/constructors/sendMessageTypingAction.md index bab75ee0..fc698a95 100644 --- a/docs/API_docs/constructors/sendMessageTypingAction.md +++ b/docs/API_docs/constructors/sendMessageTypingAction.md @@ -1,18 +1,12 @@ --- title: sendMessageTypingAction -description: User typing message +description: sendMessageTypingAction attributes, type and example --- ## Constructor: sendMessageTypingAction [Back to constructors index](index.md) -User typing message - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageTypingAction_17.md b/docs/API_docs/constructors/sendMessageTypingAction_17.md index 9573d055..27e40334 100644 --- a/docs/API_docs/constructors/sendMessageTypingAction_17.md +++ b/docs/API_docs/constructors/sendMessageTypingAction_17.md @@ -1,18 +1,12 @@ --- title: sendMessageTypingAction -description: User typing message +description: sendMessageTypingAction attributes, type and example --- ## Constructor: sendMessageTypingAction\_17 [Back to constructors index](index.md) -User typing message - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageUploadDocumentAction.md b/docs/API_docs/constructors/sendMessageUploadDocumentAction.md index 45be09b4..16b9a6db 100644 --- a/docs/API_docs/constructors/sendMessageUploadDocumentAction.md +++ b/docs/API_docs/constructors/sendMessageUploadDocumentAction.md @@ -1,19 +1,17 @@ --- title: sendMessageUploadDocumentAction -description: User uploads a document +description: sendMessageUploadDocumentAction attributes, type and example --- ## Constructor: sendMessageUploadDocumentAction [Back to constructors index](index.md) -User uploads a document - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|progress|[int](../types/int.md) | Yes|Upload progress in percents| +| Name | Type | Required | +|----------|---------------|----------| +|progress|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/sendMessageUploadDocumentAction_17.md b/docs/API_docs/constructors/sendMessageUploadDocumentAction_17.md index 3f7181e0..907c1570 100644 --- a/docs/API_docs/constructors/sendMessageUploadDocumentAction_17.md +++ b/docs/API_docs/constructors/sendMessageUploadDocumentAction_17.md @@ -1,18 +1,12 @@ --- title: sendMessageUploadDocumentAction -description: User uploads a document +description: sendMessageUploadDocumentAction attributes, type and example --- ## Constructor: sendMessageUploadDocumentAction\_17 [Back to constructors index](index.md) -User uploads a document - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageUploadPhotoAction.md b/docs/API_docs/constructors/sendMessageUploadPhotoAction.md index 8b155b22..702a3335 100644 --- a/docs/API_docs/constructors/sendMessageUploadPhotoAction.md +++ b/docs/API_docs/constructors/sendMessageUploadPhotoAction.md @@ -1,19 +1,17 @@ --- title: sendMessageUploadPhotoAction -description: User uploads a photo +description: sendMessageUploadPhotoAction attributes, type and example --- ## Constructor: sendMessageUploadPhotoAction [Back to constructors index](index.md) -User uploads a photo - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|progress|[int](../types/int.md) | Yes|Upload progress in percents| +| Name | Type | Required | +|----------|---------------|----------| +|progress|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/sendMessageUploadPhotoAction_17.md b/docs/API_docs/constructors/sendMessageUploadPhotoAction_17.md index f12f5a4c..ea2e856b 100644 --- a/docs/API_docs/constructors/sendMessageUploadPhotoAction_17.md +++ b/docs/API_docs/constructors/sendMessageUploadPhotoAction_17.md @@ -1,18 +1,12 @@ --- title: sendMessageUploadPhotoAction -description: User uploads a photo +description: sendMessageUploadPhotoAction attributes, type and example --- ## Constructor: sendMessageUploadPhotoAction\_17 [Back to constructors index](index.md) -User uploads a photo - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/constructors/sendMessageUploadVideoAction.md b/docs/API_docs/constructors/sendMessageUploadVideoAction.md index a002390b..75116eb5 100644 --- a/docs/API_docs/constructors/sendMessageUploadVideoAction.md +++ b/docs/API_docs/constructors/sendMessageUploadVideoAction.md @@ -1,19 +1,17 @@ --- title: sendMessageUploadVideoAction -description: User uploads a video +description: sendMessageUploadVideoAction attributes, type and example --- ## Constructor: sendMessageUploadVideoAction [Back to constructors index](index.md) -User uploads a video - ### Attributes: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|progress|[int](../types/int.md) | Yes|Upload progress in percents| +| Name | Type | Required | +|----------|---------------|----------| +|progress|[int](../types/int.md) | Yes| diff --git a/docs/API_docs/constructors/sendMessageUploadVideoAction_17.md b/docs/API_docs/constructors/sendMessageUploadVideoAction_17.md index 50078ade..769bccdb 100644 --- a/docs/API_docs/constructors/sendMessageUploadVideoAction_17.md +++ b/docs/API_docs/constructors/sendMessageUploadVideoAction_17.md @@ -1,18 +1,12 @@ --- title: sendMessageUploadVideoAction -description: User uploads a video +description: sendMessageUploadVideoAction attributes, type and example --- ## Constructor: sendMessageUploadVideoAction\_17 [Back to constructors index](index.md) -User uploads a video - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| diff --git a/docs/API_docs/types/MessageEntity.md b/docs/API_docs/types/MessageEntity.md index 0ae40dd8..22f1a0b4 100644 --- a/docs/API_docs/types/MessageEntity.md +++ b/docs/API_docs/types/MessageEntity.md @@ -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): [messageEntityUnknown](../constructors/messageEntityUnknown.md) diff --git a/docs/API_docs/types/PageBlock.md b/docs/API_docs/types/PageBlock.md index 2060e929..7d5b4941 100644 --- a/docs/API_docs/types/PageBlock.md +++ b/docs/API_docs/types/PageBlock.md @@ -7,6 +7,8 @@ description: constructors and methods of type PageBlock +Describes a block of web page instant view + ### Possible values (constructors): [pageBlockUnsupported](../constructors/pageBlockUnsupported.md) diff --git a/docs/API_docs/types/RichText.md b/docs/API_docs/types/RichText.md index 1d39c0a4..1d08f826 100644 --- a/docs/API_docs/types/RichText.md +++ b/docs/API_docs/types/RichText.md @@ -7,6 +7,8 @@ description: constructors and methods of type RichText +Describes a text inside web page instant view + ### Possible values (constructors): [textEmpty](../constructors/textEmpty.md) diff --git a/docs/API_docs/types/SendMessageAction.md b/docs/API_docs/types/SendMessageAction.md index a569167d..a8a75cd1 100644 --- a/docs/API_docs/types/SendMessageAction.md +++ b/docs/API_docs/types/SendMessageAction.md @@ -7,8 +7,6 @@ description: constructors and methods of type SendMessageAction -Notifies about activity in chat - ### Possible values (constructors): [sendMessageTypingAction\_17](../constructors/sendMessageTypingAction_17.md) diff --git a/docs/TD_docs/constructors/accountTtl.md b/docs/TD_docs/constructors/accountTtl.md index 017d031c..8272da27 100644 --- a/docs/TD_docs/constructors/accountTtl.md +++ b/docs/TD_docs/constructors/accountTtl.md @@ -1,19 +1,19 @@ --- 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 [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: | 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| diff --git a/docs/TD_docs/constructors/animation.md b/docs/TD_docs/constructors/animation.md index f8cea775..09f7b201 100644 --- a/docs/TD_docs/constructors/animation.md +++ b/docs/TD_docs/constructors/animation.md @@ -13,6 +13,7 @@ Describes animation file. Animation should be encoded in gif or mp4 format | 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| |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| diff --git a/docs/TD_docs/constructors/authCodeTypeCall.md b/docs/TD_docs/constructors/authCodeTypeCall.md index c46fec17..88761ca6 100644 --- a/docs/TD_docs/constructors/authCodeTypeCall.md +++ b/docs/TD_docs/constructors/authCodeTypeCall.md @@ -1,13 +1,13 @@ --- 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 [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: diff --git a/docs/TD_docs/constructors/call.md b/docs/TD_docs/constructors/call.md new file mode 100644 index 00000000..cdd83d33 --- /dev/null +++ b/docs/TD_docs/constructors/call.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callConnection.md b/docs/TD_docs/constructors/callConnection.md new file mode 100644 index 00000000..81ddb6a2 --- /dev/null +++ b/docs/TD_docs/constructors/callConnection.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callDiscardReasonDeclined.md b/docs/TD_docs/constructors/callDiscardReasonDeclined.md new file mode 100644 index 00000000..e316b7c8 --- /dev/null +++ b/docs/TD_docs/constructors/callDiscardReasonDeclined.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callDiscardReasonDisconnected.md b/docs/TD_docs/constructors/callDiscardReasonDisconnected.md new file mode 100644 index 00000000..75566102 --- /dev/null +++ b/docs/TD_docs/constructors/callDiscardReasonDisconnected.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callDiscardReasonEmpty.md b/docs/TD_docs/constructors/callDiscardReasonEmpty.md new file mode 100644 index 00000000..2e12b17a --- /dev/null +++ b/docs/TD_docs/constructors/callDiscardReasonEmpty.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callDiscardReasonHungUp.md b/docs/TD_docs/constructors/callDiscardReasonHungUp.md new file mode 100644 index 00000000..4ea4ed52 --- /dev/null +++ b/docs/TD_docs/constructors/callDiscardReasonHungUp.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callDiscardReasonMissed.md b/docs/TD_docs/constructors/callDiscardReasonMissed.md new file mode 100644 index 00000000..daf0a5e8 --- /dev/null +++ b/docs/TD_docs/constructors/callDiscardReasonMissed.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callId.md b/docs/TD_docs/constructors/callId.md new file mode 100644 index 00000000..cfda8c1f --- /dev/null +++ b/docs/TD_docs/constructors/callId.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callProtocol.md b/docs/TD_docs/constructors/callProtocol.md new file mode 100644 index 00000000..ae0c6777 --- /dev/null +++ b/docs/TD_docs/constructors/callProtocol.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callStateDiscarded.md b/docs/TD_docs/constructors/callStateDiscarded.md new file mode 100644 index 00000000..cd570640 --- /dev/null +++ b/docs/TD_docs/constructors/callStateDiscarded.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callStateError.md b/docs/TD_docs/constructors/callStateError.md new file mode 100644 index 00000000..83ccd707 --- /dev/null +++ b/docs/TD_docs/constructors/callStateError.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callStateExchangingKeys.md b/docs/TD_docs/constructors/callStateExchangingKeys.md new file mode 100644 index 00000000..64730b97 --- /dev/null +++ b/docs/TD_docs/constructors/callStateExchangingKeys.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callStateHangingUp.md b/docs/TD_docs/constructors/callStateHangingUp.md new file mode 100644 index 00000000..df7d74c6 --- /dev/null +++ b/docs/TD_docs/constructors/callStateHangingUp.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callStatePending.md b/docs/TD_docs/constructors/callStatePending.md new file mode 100644 index 00000000..2a540e16 --- /dev/null +++ b/docs/TD_docs/constructors/callStatePending.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callStateReady.md b/docs/TD_docs/constructors/callStateReady.md new file mode 100644 index 00000000..efdf29cc --- /dev/null +++ b/docs/TD_docs/constructors/callStateReady.md @@ -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) + + diff --git a/docs/TD_docs/constructors/callbackQueryAnswer.md b/docs/TD_docs/constructors/callbackQueryAnswer.md index 0afb9c23..837df9fd 100644 --- a/docs/TD_docs/constructors/callbackQueryAnswer.md +++ b/docs/TD_docs/constructors/callbackQueryAnswer.md @@ -1,13 +1,13 @@ --- title: callbackQueryAnswer -description: Contains answer of the bot to the callback query +description: Contains answer of a bot to a callback query --- ## Constructor: callbackQueryAnswer [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: diff --git a/docs/TD_docs/constructors/callbackQueryData.md b/docs/TD_docs/constructors/callbackQueryPayloadData.md similarity index 77% rename from docs/TD_docs/constructors/callbackQueryData.md rename to docs/TD_docs/constructors/callbackQueryPayloadData.md index a974e402..fb93acb5 100644 --- a/docs/TD_docs/constructors/callbackQueryData.md +++ b/docs/TD_docs/constructors/callbackQueryPayloadData.md @@ -1,8 +1,8 @@ --- -title: callbackQueryData +title: callbackQueryPayloadData description: Payload from a general callback button --- -## Constructor: callbackQueryData +## Constructor: callbackQueryPayloadData [Back to constructors index](index.md) @@ -13,7 +13,7 @@ Payload from a general callback button | 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| diff --git a/docs/TD_docs/constructors/callbackQueryGame.md b/docs/TD_docs/constructors/callbackQueryPayloadGame.md similarity index 85% rename from docs/TD_docs/constructors/callbackQueryGame.md rename to docs/TD_docs/constructors/callbackQueryPayloadGame.md index 51a544fc..3952396d 100644 --- a/docs/TD_docs/constructors/callbackQueryGame.md +++ b/docs/TD_docs/constructors/callbackQueryPayloadGame.md @@ -1,8 +1,8 @@ --- -title: callbackQueryGame +title: callbackQueryPayloadGame description: Payload from a game callback button --- -## Constructor: callbackQueryGame +## Constructor: callbackQueryPayloadGame [Back to constructors index](index.md) diff --git a/docs/TD_docs/constructors/channel.md b/docs/TD_docs/constructors/channel.md index 5accdb3c..cb67428d 100644 --- a/docs/TD_docs/constructors/channel.md +++ b/docs/TD_docs/constructors/channel.md @@ -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| |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| -|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| diff --git a/docs/TD_docs/constructors/channelFull.md b/docs/TD_docs/constructors/channelFull.md index bf27958b..d904a360 100644 --- a/docs/TD_docs/constructors/channelFull.md +++ b/docs/TD_docs/constructors/channelFull.md @@ -13,17 +13,17 @@ Gives full information about a channel | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel|[channel](../types/channel.md) | Yes|General info about the channel| -|about|[string](../types/string.md) | Yes|Information about the channel| +|description|[string](../types/string.md) | Yes|Channel description| |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| -|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\_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| -|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\_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| diff --git a/docs/TD_docs/constructors/channelMembersAdministrators.md b/docs/TD_docs/constructors/channelMembersAdministrators.md deleted file mode 100644 index 4a30445a..00000000 --- a/docs/TD_docs/constructors/channelMembersAdministrators.md +++ /dev/null @@ -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) - - diff --git a/docs/TD_docs/constructors/channelMembersBots.md b/docs/TD_docs/constructors/channelMembersFilterAdministrators.md similarity index 58% rename from docs/TD_docs/constructors/channelMembersBots.md rename to docs/TD_docs/constructors/channelMembersFilterAdministrators.md index 6061fb2f..2c2ae807 100644 --- a/docs/TD_docs/constructors/channelMembersBots.md +++ b/docs/TD_docs/constructors/channelMembersFilterAdministrators.md @@ -1,13 +1,13 @@ --- -title: channelMembersBots -description: Return bots in the channel +title: channelMembersFilterAdministrators +description: Return creator and administrators --- -## Constructor: channelMembersBots +## Constructor: channelMembersFilterAdministrators [Back to constructors index](index.md) -Return bots in the channel +Return creator and administrators ### Attributes: diff --git a/docs/TD_docs/constructors/channelMembersFilterBanned.md b/docs/TD_docs/constructors/channelMembersFilterBanned.md new file mode 100644 index 00000000..a0ba8cd7 --- /dev/null +++ b/docs/TD_docs/constructors/channelMembersFilterBanned.md @@ -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) + + diff --git a/docs/TD_docs/constructors/channelMembersKicked.md b/docs/TD_docs/constructors/channelMembersFilterBots.md similarity index 61% rename from docs/TD_docs/constructors/channelMembersKicked.md rename to docs/TD_docs/constructors/channelMembersFilterBots.md index 8d8bbd62..2a398416 100644 --- a/docs/TD_docs/constructors/channelMembersKicked.md +++ b/docs/TD_docs/constructors/channelMembersFilterBots.md @@ -1,13 +1,13 @@ --- -title: channelMembersKicked -description: Return kicked from the channel +title: channelMembersFilterBots +description: Return bot members of the channel --- -## Constructor: channelMembersKicked +## Constructor: channelMembersFilterBots [Back to constructors index](index.md) -Return kicked from the channel +Return bot members of the channel ### Attributes: diff --git a/docs/TD_docs/constructors/channelMembersRecent.md b/docs/TD_docs/constructors/channelMembersFilterRecent.md similarity index 82% rename from docs/TD_docs/constructors/channelMembersRecent.md rename to docs/TD_docs/constructors/channelMembersFilterRecent.md index 56b0a72b..601d1ee3 100644 --- a/docs/TD_docs/constructors/channelMembersRecent.md +++ b/docs/TD_docs/constructors/channelMembersFilterRecent.md @@ -1,8 +1,8 @@ --- -title: channelMembersRecent +title: channelMembersFilterRecent description: Return recently active users in reverse chronological order --- -## Constructor: channelMembersRecent +## Constructor: channelMembersFilterRecent [Back to constructors index](index.md) diff --git a/docs/TD_docs/constructors/channelMembersFilterRestricted.md b/docs/TD_docs/constructors/channelMembersFilterRestricted.md new file mode 100644 index 00000000..8c780472 --- /dev/null +++ b/docs/TD_docs/constructors/channelMembersFilterRestricted.md @@ -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) + + diff --git a/docs/TD_docs/constructors/channelMembersFilterSearch.md b/docs/TD_docs/constructors/channelMembersFilterSearch.md new file mode 100644 index 00000000..d5c12ed4 --- /dev/null +++ b/docs/TD_docs/constructors/channelMembersFilterSearch.md @@ -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) + + diff --git a/docs/TD_docs/constructors/channels.md b/docs/TD_docs/constructors/channels.md deleted file mode 100644 index 39a2c83b..00000000 --- a/docs/TD_docs/constructors/channels.md +++ /dev/null @@ -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) - - diff --git a/docs/TD_docs/constructors/chat.md b/docs/TD_docs/constructors/chat.md index 94b53d78..f63b1c49 100644 --- a/docs/TD_docs/constructors/chat.md +++ b/docs/TD_docs/constructors/chat.md @@ -13,18 +13,20 @@ Chat (private chat or group chat or channel chat) | 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| |photo|[chatPhoto](../types/chatPhoto.md) | Yes|Chat photo, 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| -|last\_read\_inbox\_message\_id|[long](../types/long.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\_inbox\_message\_id|[int53](../types/int53.md) | Yes|Identifier of last read incoming 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| -|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| -|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| diff --git a/docs/TD_docs/constructors/chatActionCancel.md b/docs/TD_docs/constructors/chatActionCancel.md new file mode 100644 index 00000000..68c1ab5e --- /dev/null +++ b/docs/TD_docs/constructors/chatActionCancel.md @@ -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) + + diff --git a/docs/TD_docs/constructors/sendMessageChooseContactAction.md b/docs/TD_docs/constructors/chatActionChoosingContact.md similarity index 63% rename from docs/TD_docs/constructors/sendMessageChooseContactAction.md rename to docs/TD_docs/constructors/chatActionChoosingContact.md index a299c7aa..bfc418a5 100644 --- a/docs/TD_docs/constructors/sendMessageChooseContactAction.md +++ b/docs/TD_docs/constructors/chatActionChoosingContact.md @@ -1,8 +1,8 @@ --- -title: sendMessageChooseContactAction +title: chatActionChoosingContact description: User chooses contact to send --- -## Constructor: sendMessageChooseContactAction +## Constructor: chatActionChoosingContact [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) diff --git a/docs/TD_docs/constructors/chatActionChoosingLocation.md b/docs/TD_docs/constructors/chatActionChoosingLocation.md new file mode 100644 index 00000000..f69c5cc7 --- /dev/null +++ b/docs/TD_docs/constructors/chatActionChoosingLocation.md @@ -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) + + diff --git a/docs/TD_docs/constructors/sendMessageRecordVideoAction.md b/docs/TD_docs/constructors/chatActionRecordingVideo.md similarity index 62% rename from docs/TD_docs/constructors/sendMessageRecordVideoAction.md rename to docs/TD_docs/constructors/chatActionRecordingVideo.md index 5546e9cb..bbb38411 100644 --- a/docs/TD_docs/constructors/sendMessageRecordVideoAction.md +++ b/docs/TD_docs/constructors/chatActionRecordingVideo.md @@ -1,8 +1,8 @@ --- -title: sendMessageRecordVideoAction +title: chatActionRecordingVideo description: User records a video --- -## Constructor: sendMessageRecordVideoAction +## Constructor: chatActionRecordingVideo [Back to constructors index](index.md) @@ -16,6 +16,6 @@ User records a video -### Type: [SendMessageAction](../types/SendMessageAction.md) +### Type: [ChatAction](../types/ChatAction.md) diff --git a/docs/TD_docs/constructors/chatActionRecordingVideoNote.md b/docs/TD_docs/constructors/chatActionRecordingVideoNote.md new file mode 100644 index 00000000..422d97cd --- /dev/null +++ b/docs/TD_docs/constructors/chatActionRecordingVideoNote.md @@ -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) + + diff --git a/docs/TD_docs/constructors/sendMessageRecordVoiceAction.md b/docs/TD_docs/constructors/chatActionRecordingVoice.md similarity index 63% rename from docs/TD_docs/constructors/sendMessageRecordVoiceAction.md rename to docs/TD_docs/constructors/chatActionRecordingVoice.md index 5be8b191..be9b2f7e 100644 --- a/docs/TD_docs/constructors/sendMessageRecordVoiceAction.md +++ b/docs/TD_docs/constructors/chatActionRecordingVoice.md @@ -1,8 +1,8 @@ --- -title: sendMessageRecordVoiceAction +title: chatActionRecordingVoice description: User records voice message --- -## Constructor: sendMessageRecordVoiceAction +## Constructor: chatActionRecordingVoice [Back to constructors index](index.md) @@ -16,6 +16,6 @@ User records voice message -### Type: [SendMessageAction](../types/SendMessageAction.md) +### Type: [ChatAction](../types/ChatAction.md) diff --git a/docs/TD_docs/constructors/sendMessageStartPlayGameAction.md b/docs/TD_docs/constructors/chatActionStartPlayingGame.md similarity index 62% rename from docs/TD_docs/constructors/sendMessageStartPlayGameAction.md rename to docs/TD_docs/constructors/chatActionStartPlayingGame.md index 1a29a6d6..1a133de6 100644 --- a/docs/TD_docs/constructors/sendMessageStartPlayGameAction.md +++ b/docs/TD_docs/constructors/chatActionStartPlayingGame.md @@ -1,8 +1,8 @@ --- -title: sendMessageStartPlayGameAction +title: chatActionStartPlayingGame description: User starts to play a game --- -## Constructor: sendMessageStartPlayGameAction +## Constructor: chatActionStartPlayingGame [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) diff --git a/docs/TD_docs/constructors/chatActionTyping.md b/docs/TD_docs/constructors/chatActionTyping.md new file mode 100644 index 00000000..10591ceb --- /dev/null +++ b/docs/TD_docs/constructors/chatActionTyping.md @@ -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) + + diff --git a/docs/TD_docs/constructors/sendMessageUploadDocumentAction.md b/docs/TD_docs/constructors/chatActionUploadingDocument.md similarity index 67% rename from docs/TD_docs/constructors/sendMessageUploadDocumentAction.md rename to docs/TD_docs/constructors/chatActionUploadingDocument.md index 30058710..9a92205c 100644 --- a/docs/TD_docs/constructors/sendMessageUploadDocumentAction.md +++ b/docs/TD_docs/constructors/chatActionUploadingDocument.md @@ -1,8 +1,8 @@ --- -title: sendMessageUploadDocumentAction +title: chatActionUploadingDocument description: User uploads a document --- -## Constructor: sendMessageUploadDocumentAction +## Constructor: chatActionUploadingDocument [Back to constructors index](index.md) @@ -17,6 +17,6 @@ User uploads a document -### Type: [SendMessageAction](../types/SendMessageAction.md) +### Type: [ChatAction](../types/ChatAction.md) diff --git a/docs/TD_docs/constructors/sendMessageUploadPhotoAction.md b/docs/TD_docs/constructors/chatActionUploadingPhoto.md similarity index 67% rename from docs/TD_docs/constructors/sendMessageUploadPhotoAction.md rename to docs/TD_docs/constructors/chatActionUploadingPhoto.md index bffd3197..7bcf01a6 100644 --- a/docs/TD_docs/constructors/sendMessageUploadPhotoAction.md +++ b/docs/TD_docs/constructors/chatActionUploadingPhoto.md @@ -1,8 +1,8 @@ --- -title: sendMessageUploadPhotoAction +title: chatActionUploadingPhoto description: User uploads a photo --- -## Constructor: sendMessageUploadPhotoAction +## Constructor: chatActionUploadingPhoto [Back to constructors index](index.md) @@ -17,6 +17,6 @@ User uploads a photo -### Type: [SendMessageAction](../types/SendMessageAction.md) +### Type: [ChatAction](../types/ChatAction.md) diff --git a/docs/TD_docs/constructors/sendMessageUploadVideoAction.md b/docs/TD_docs/constructors/chatActionUploadingVideo.md similarity index 67% rename from docs/TD_docs/constructors/sendMessageUploadVideoAction.md rename to docs/TD_docs/constructors/chatActionUploadingVideo.md index 9733d91b..9f9c2c78 100644 --- a/docs/TD_docs/constructors/sendMessageUploadVideoAction.md +++ b/docs/TD_docs/constructors/chatActionUploadingVideo.md @@ -1,8 +1,8 @@ --- -title: sendMessageUploadVideoAction +title: chatActionUploadingVideo description: User uploads a video --- -## Constructor: sendMessageUploadVideoAction +## Constructor: chatActionUploadingVideo [Back to constructors index](index.md) @@ -17,6 +17,6 @@ User uploads a video -### Type: [SendMessageAction](../types/SendMessageAction.md) +### Type: [ChatAction](../types/ChatAction.md) diff --git a/docs/TD_docs/constructors/chatActionUploadingVideoNote.md b/docs/TD_docs/constructors/chatActionUploadingVideoNote.md new file mode 100644 index 00000000..c376e9a6 --- /dev/null +++ b/docs/TD_docs/constructors/chatActionUploadingVideoNote.md @@ -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) + + diff --git a/docs/TD_docs/constructors/sendMessageUploadVoiceAction.md b/docs/TD_docs/constructors/chatActionUploadingVoice.md similarity index 68% rename from docs/TD_docs/constructors/sendMessageUploadVoiceAction.md rename to docs/TD_docs/constructors/chatActionUploadingVoice.md index 8c611430..0859bb80 100644 --- a/docs/TD_docs/constructors/sendMessageUploadVoiceAction.md +++ b/docs/TD_docs/constructors/chatActionUploadingVoice.md @@ -1,8 +1,8 @@ --- -title: sendMessageUploadVoiceAction +title: chatActionUploadingVoice description: User uploads voice message --- -## Constructor: sendMessageUploadVoiceAction +## Constructor: chatActionUploadingVoice [Back to constructors index](index.md) @@ -17,6 +17,6 @@ User uploads voice message -### Type: [SendMessageAction](../types/SendMessageAction.md) +### Type: [ChatAction](../types/ChatAction.md) diff --git a/docs/TD_docs/constructors/chatEvent.md b/docs/TD_docs/constructors/chatEvent.md new file mode 100644 index 00000000..446ea9d0 --- /dev/null +++ b/docs/TD_docs/constructors/chatEvent.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventDescriptionChanged.md b/docs/TD_docs/constructors/chatEventDescriptionChanged.md new file mode 100644 index 00000000..fdfa924a --- /dev/null +++ b/docs/TD_docs/constructors/chatEventDescriptionChanged.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventInvitesToggled.md b/docs/TD_docs/constructors/chatEventInvitesToggled.md new file mode 100644 index 00000000..3c04808d --- /dev/null +++ b/docs/TD_docs/constructors/chatEventInvitesToggled.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventLogFilters.md b/docs/TD_docs/constructors/chatEventLogFilters.md new file mode 100644 index 00000000..061c1d06 --- /dev/null +++ b/docs/TD_docs/constructors/chatEventLogFilters.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventMemberInvited.md b/docs/TD_docs/constructors/chatEventMemberInvited.md new file mode 100644 index 00000000..0a374904 --- /dev/null +++ b/docs/TD_docs/constructors/chatEventMemberInvited.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventMemberJoined.md b/docs/TD_docs/constructors/chatEventMemberJoined.md new file mode 100644 index 00000000..a7e4456b --- /dev/null +++ b/docs/TD_docs/constructors/chatEventMemberJoined.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventMemberLeft.md b/docs/TD_docs/constructors/chatEventMemberLeft.md new file mode 100644 index 00000000..d9f345e9 --- /dev/null +++ b/docs/TD_docs/constructors/chatEventMemberLeft.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventMemberPromoted.md b/docs/TD_docs/constructors/chatEventMemberPromoted.md new file mode 100644 index 00000000..51e9e46e --- /dev/null +++ b/docs/TD_docs/constructors/chatEventMemberPromoted.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventMemberRestricted.md b/docs/TD_docs/constructors/chatEventMemberRestricted.md new file mode 100644 index 00000000..37842044 --- /dev/null +++ b/docs/TD_docs/constructors/chatEventMemberRestricted.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventMessageDeleted.md b/docs/TD_docs/constructors/chatEventMessageDeleted.md new file mode 100644 index 00000000..2472428a --- /dev/null +++ b/docs/TD_docs/constructors/chatEventMessageDeleted.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventMessageEdited.md b/docs/TD_docs/constructors/chatEventMessageEdited.md new file mode 100644 index 00000000..ddd33c7c --- /dev/null +++ b/docs/TD_docs/constructors/chatEventMessageEdited.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventMessagePinned.md b/docs/TD_docs/constructors/chatEventMessagePinned.md new file mode 100644 index 00000000..63f5a062 --- /dev/null +++ b/docs/TD_docs/constructors/chatEventMessagePinned.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventMessageUnpinned.md b/docs/TD_docs/constructors/chatEventMessageUnpinned.md new file mode 100644 index 00000000..66676744 --- /dev/null +++ b/docs/TD_docs/constructors/chatEventMessageUnpinned.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventPhotoChanged.md b/docs/TD_docs/constructors/chatEventPhotoChanged.md new file mode 100644 index 00000000..3e1871b5 --- /dev/null +++ b/docs/TD_docs/constructors/chatEventPhotoChanged.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventSignMessagesToggled.md b/docs/TD_docs/constructors/chatEventSignMessagesToggled.md new file mode 100644 index 00000000..0de3652e --- /dev/null +++ b/docs/TD_docs/constructors/chatEventSignMessagesToggled.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventTitleChanged.md b/docs/TD_docs/constructors/chatEventTitleChanged.md new file mode 100644 index 00000000..25cc3f58 --- /dev/null +++ b/docs/TD_docs/constructors/chatEventTitleChanged.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEventUsernameChanged.md b/docs/TD_docs/constructors/chatEventUsernameChanged.md new file mode 100644 index 00000000..ab5360f0 --- /dev/null +++ b/docs/TD_docs/constructors/chatEventUsernameChanged.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatEvents.md b/docs/TD_docs/constructors/chatEvents.md new file mode 100644 index 00000000..f28bcb3a --- /dev/null +++ b/docs/TD_docs/constructors/chatEvents.md @@ -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) + + diff --git a/docs/TD_docs/constructors/chatInviteLinkInfo.md b/docs/TD_docs/constructors/chatInviteLinkInfo.md index bbd7696e..68c414e1 100644 --- a/docs/TD_docs/constructors/chatInviteLinkInfo.md +++ b/docs/TD_docs/constructors/chatInviteLinkInfo.md @@ -13,11 +13,11 @@ Contains information about chat invite link | 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| |photo|[chatPhoto](../types/chatPhoto.md) | Yes|Chat photo, nullable| |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\_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| diff --git a/docs/TD_docs/constructors/chatMember.md b/docs/TD_docs/constructors/chatMember.md index f95762ee..f4b1ecc2 100644 --- a/docs/TD_docs/constructors/chatMember.md +++ b/docs/TD_docs/constructors/chatMember.md @@ -1,20 +1,20 @@ --- title: chatMember -description: User with information about its chat joining/kicking +description: User with information about its chat joining/leaving --- ## Constructor: chatMember [Back to constructors index](index.md) -User with information about its chat joining/kicking +User with information about its chat joining/leaving ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |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| |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| diff --git a/docs/TD_docs/constructors/chatMemberStatusAdministrator.md b/docs/TD_docs/constructors/chatMemberStatusAdministrator.md new file mode 100644 index 00000000..c8795b8a --- /dev/null +++ b/docs/TD_docs/constructors/chatMemberStatusAdministrator.md @@ -0,0 +1,30 @@ +--- +title: chatMemberStatusAdministrator +description: User is a chat member with some additional priviledges. In groups, administrators can edit and delete other messages, add new members and ban unpriviledged members +--- +## Constructor: chatMemberStatusAdministrator +[Back to constructors index](index.md) + + + +User is a chat member with some additional priviledges. In groups, administrators can edit and delete other messages, add new members and ban unpriviledged members + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|can\_be\_edited|[Bool](../types/Bool.md) | Yes|True, if current user has rights to edit administrator privileges of that user| +|can\_change\_info|[Bool](../types/Bool.md) | Yes|True, if the administrator can change chat title, photo and other settings| +|can\_post\_messages|[Bool](../types/Bool.md) | Yes|True, if the administrator can create channel posts, broadcast channels only| +|can\_edit\_messages|[Bool](../types/Bool.md) | Yes|True, if the administrator can edit messages of other users, broadcast channels only| +|can\_delete\_messages|[Bool](../types/Bool.md) | Yes|True, if the administrator can delete messages of other users| +|can\_invite\_users|[Bool](../types/Bool.md) | Yes|True, if the administrator can invite new users to the chat| +|can\_restrict\_members|[Bool](../types/Bool.md) | Yes|True, if the administrator can restrict, ban or unban chat members| +|can\_pin\_messages|[Bool](../types/Bool.md) | Yes|True, if the administrator can pin messages, supergroup channels only| +|can\_promote\_members|[Bool](../types/Bool.md) | Yes|True, if the administrator can add new administrators with a subset of his own privileges or demote administrators directly or indirectly promoted by him| + + + +### Type: [ChatMemberStatus](../types/ChatMemberStatus.md) + + diff --git a/docs/TD_docs/constructors/chatMemberStatusBanned.md b/docs/TD_docs/constructors/chatMemberStatusBanned.md new file mode 100644 index 00000000..55bdf4ba --- /dev/null +++ b/docs/TD_docs/constructors/chatMemberStatusBanned.md @@ -0,0 +1,22 @@ +--- +title: chatMemberStatusBanned +description: User was banned (and obviously is not a chat member) and can't return to the chat or view messages +--- +## Constructor: chatMemberStatusBanned +[Back to constructors index](index.md) + + + +User was banned (and obviously is not a chat member) and can't return to the chat or view messages + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|banned\_until\_date|[int](../types/int.md) | Yes|Date when the user will be unbanned, 0 if never. Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time it considered to be banned forever| + + + +### Type: [ChatMemberStatus](../types/ChatMemberStatus.md) + + diff --git a/docs/TD_docs/constructors/chatMemberStatusCreator.md b/docs/TD_docs/constructors/chatMemberStatusCreator.md index 5f88b074..45055ebd 100644 --- a/docs/TD_docs/constructors/chatMemberStatusCreator.md +++ b/docs/TD_docs/constructors/chatMemberStatusCreator.md @@ -1,13 +1,13 @@ --- title: chatMemberStatusCreator -description: Creator of the chat, can delete any message, kick any user and add editors and moderators in channels +description: User is creator of the chat which has all administrator priviledges --- ## Constructor: chatMemberStatusCreator [Back to constructors index](index.md) -Creator of the chat, can delete any message, kick any user and add editors and moderators in channels +User is creator of the chat which has all administrator priviledges ### Attributes: diff --git a/docs/TD_docs/constructors/chatMemberStatusEditor.md b/docs/TD_docs/constructors/chatMemberStatusEditor.md deleted file mode 100644 index 5bd029c1..00000000 --- a/docs/TD_docs/constructors/chatMemberStatusEditor.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: chatMemberStatusEditor -description: In broadcast channels, member that can post messages to the broadcast channel and have moderator rights. In groups and supergroups, member that can add new members to the chat/kick unpriviledged members ---- -## Constructor: chatMemberStatusEditor -[Back to constructors index](index.md) - - - -In broadcast channels, member that can post messages to the broadcast channel and have moderator rights. In groups and supergroups, member that can add new members to the chat/kick unpriviledged members - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| - - - -### Type: [ChatMemberStatus](../types/ChatMemberStatus.md) - - diff --git a/docs/TD_docs/constructors/chatMemberStatusKicked.md b/docs/TD_docs/constructors/chatMemberStatusKicked.md deleted file mode 100644 index f7fe2cf8..00000000 --- a/docs/TD_docs/constructors/chatMemberStatusKicked.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: chatMemberStatusKicked -description: User was kicked from the chat (and obviously is not a chat member) ---- -## Constructor: chatMemberStatusKicked -[Back to constructors index](index.md) - - - -User was kicked from the chat (and obviously is not a chat member) - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| - - - -### Type: [ChatMemberStatus](../types/ChatMemberStatus.md) - - diff --git a/docs/TD_docs/constructors/chatMemberStatusMember.md b/docs/TD_docs/constructors/chatMemberStatusMember.md index bf0dd8cb..b2089674 100644 --- a/docs/TD_docs/constructors/chatMemberStatusMember.md +++ b/docs/TD_docs/constructors/chatMemberStatusMember.md @@ -1,13 +1,13 @@ --- title: chatMemberStatusMember -description: User is a member of the chat, but have no any additional privileges +description: User is a member of the chat, but have no any additional privileges or restrictions --- ## Constructor: chatMemberStatusMember [Back to constructors index](index.md) -User is a member of the chat, but have no any additional privileges +User is a member of the chat, but have no any additional privileges or restrictions ### Attributes: diff --git a/docs/TD_docs/constructors/chatMemberStatusModerator.md b/docs/TD_docs/constructors/chatMemberStatusModerator.md deleted file mode 100644 index ca15b81c..00000000 --- a/docs/TD_docs/constructors/chatMemberStatusModerator.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: chatMemberStatusModerator -description: Only for channels, member that can delete messages of unprivileged members and kick them ---- -## Constructor: chatMemberStatusModerator -[Back to constructors index](index.md) - - - -Only for channels, member that can delete messages of unprivileged members and kick them - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| - - - -### Type: [ChatMemberStatus](../types/ChatMemberStatus.md) - - diff --git a/docs/TD_docs/constructors/chatMemberStatusRestricted.md b/docs/TD_docs/constructors/chatMemberStatusRestricted.md new file mode 100644 index 00000000..c8e9b48d --- /dev/null +++ b/docs/TD_docs/constructors/chatMemberStatusRestricted.md @@ -0,0 +1,27 @@ +--- +title: chatMemberStatusRestricted +description: User has some additional restrictions in the chat. Unsupported in group chats and broadcast channels +--- +## Constructor: chatMemberStatusRestricted +[Back to constructors index](index.md) + + + +User has some additional restrictions in the chat. Unsupported in group chats and broadcast channels + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|is\_member|[Bool](../types/Bool.md) | Yes|True, if user is chat member| +|restricted\_until\_date|[int](../types/int.md) | Yes|Date when the user will be unrestricted, 0 if never. Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time it considered to be restricted forever| +|can\_send\_messages|[Bool](../types/Bool.md) | Yes|True, if the user can send text messages, contacts, locations and venues| +|can\_send\_media\_messages|[Bool](../types/Bool.md) | Yes|True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages| +|can\_send\_other\_messages|[Bool](../types/Bool.md) | Yes|True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages| +|can\_add\_web\_page\_previews|[Bool](../types/Bool.md) | Yes|True, if user may add web page preview to his messages, implies can_send_messages| + + + +### Type: [ChatMemberStatus](../types/ChatMemberStatus.md) + + diff --git a/docs/TD_docs/constructors/chatReportReasonOther.md b/docs/TD_docs/constructors/chatReportReasonOther.md new file mode 100644 index 00000000..0069027b --- /dev/null +++ b/docs/TD_docs/constructors/chatReportReasonOther.md @@ -0,0 +1,22 @@ +--- +title: chatReportReasonOther +description: Other reason provided by the user +--- +## Constructor: chatReportReasonOther +[Back to constructors index](index.md) + + + +Other reason provided by the user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Report text| + + + +### Type: [ChatReportReason](../types/ChatReportReason.md) + + diff --git a/docs/TD_docs/constructors/chatReportReasonPornography.md b/docs/TD_docs/constructors/chatReportReasonPornography.md new file mode 100644 index 00000000..bdfae825 --- /dev/null +++ b/docs/TD_docs/constructors/chatReportReasonPornography.md @@ -0,0 +1,21 @@ +--- +title: chatReportReasonPornography +description: The chat contains pornography messages +--- +## Constructor: chatReportReasonPornography +[Back to constructors index](index.md) + + + +The chat contains pornography messages + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [ChatReportReason](../types/ChatReportReason.md) + + diff --git a/docs/TD_docs/constructors/chatReportReasonSpam.md b/docs/TD_docs/constructors/chatReportReasonSpam.md new file mode 100644 index 00000000..de19c3a8 --- /dev/null +++ b/docs/TD_docs/constructors/chatReportReasonSpam.md @@ -0,0 +1,21 @@ +--- +title: chatReportReasonSpam +description: The chat contains spam messages +--- +## Constructor: chatReportReasonSpam +[Back to constructors index](index.md) + + + +The chat contains spam messages + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [ChatReportReason](../types/ChatReportReason.md) + + diff --git a/docs/TD_docs/constructors/chatReportReasonViolence.md b/docs/TD_docs/constructors/chatReportReasonViolence.md new file mode 100644 index 00000000..690ae7fb --- /dev/null +++ b/docs/TD_docs/constructors/chatReportReasonViolence.md @@ -0,0 +1,21 @@ +--- +title: chatReportReasonViolence +description: The chat contains violent messages +--- +## Constructor: chatReportReasonViolence +[Back to constructors index](index.md) + + + +The chat contains violent messages + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [ChatReportReason](../types/ChatReportReason.md) + + diff --git a/docs/TD_docs/constructors/channelChatInfo.md b/docs/TD_docs/constructors/chatTypeChannel.md similarity index 60% rename from docs/TD_docs/constructors/channelChatInfo.md rename to docs/TD_docs/constructors/chatTypeChannel.md index da8f8d86..e40e38cf 100644 --- a/docs/TD_docs/constructors/channelChatInfo.md +++ b/docs/TD_docs/constructors/chatTypeChannel.md @@ -1,8 +1,8 @@ --- -title: channelChatInfo +title: chatTypeChannel description: Chat with unlimited number of members --- -## Constructor: channelChatInfo +## Constructor: chatTypeChannel [Back to constructors index](index.md) @@ -13,10 +13,10 @@ Chat with unlimited number of members | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|channel|[channel](../types/channel.md) | Yes|Information about the chat| +|channel\_id|[int](../types/int.md) | Yes|Channel identifier| -### Type: [ChatInfo](../types/ChatInfo.md) +### Type: [ChatType](../types/ChatType.md) diff --git a/docs/TD_docs/constructors/groupChatInfo.md b/docs/TD_docs/constructors/chatTypeGroup.md similarity index 61% rename from docs/TD_docs/constructors/groupChatInfo.md rename to docs/TD_docs/constructors/chatTypeGroup.md index 56f1e9a7..1c639558 100644 --- a/docs/TD_docs/constructors/groupChatInfo.md +++ b/docs/TD_docs/constructors/chatTypeGroup.md @@ -1,8 +1,8 @@ --- -title: groupChatInfo +title: chatTypeGroup description: Chat with zero or more other users --- -## Constructor: groupChatInfo +## Constructor: chatTypeGroup [Back to constructors index](index.md) @@ -13,10 +13,10 @@ Chat with zero or more other users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|group|[group](../types/group.md) | Yes|Information about the chat| +|group\_id|[int](../types/int.md) | Yes|Group identifier| -### Type: [ChatInfo](../types/ChatInfo.md) +### Type: [ChatType](../types/ChatType.md) diff --git a/docs/TD_docs/constructors/chatTypePrivate.md b/docs/TD_docs/constructors/chatTypePrivate.md new file mode 100644 index 00000000..78b448b6 --- /dev/null +++ b/docs/TD_docs/constructors/chatTypePrivate.md @@ -0,0 +1,22 @@ +--- +title: chatTypePrivate +description: Ordinary chat with a user +--- +## Constructor: chatTypePrivate +[Back to constructors index](index.md) + + + +Ordinary chat with a user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User identifier| + + + +### Type: [ChatType](../types/ChatType.md) + + diff --git a/docs/TD_docs/constructors/chatTypeSecret.md b/docs/TD_docs/constructors/chatTypeSecret.md new file mode 100644 index 00000000..2fd7542e --- /dev/null +++ b/docs/TD_docs/constructors/chatTypeSecret.md @@ -0,0 +1,22 @@ +--- +title: chatTypeSecret +description: Secret chat with a user +--- +## Constructor: chatTypeSecret +[Back to constructors index](index.md) + + + +Secret chat with a user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|secret\_chat\_id|[int](../types/int.md) | Yes|Secret chat identifier| + + + +### Type: [ChatType](../types/ChatType.md) + + diff --git a/docs/TD_docs/constructors/chats.md b/docs/TD_docs/constructors/chats.md index 670b97d6..73ca2be7 100644 --- a/docs/TD_docs/constructors/chats.md +++ b/docs/TD_docs/constructors/chats.md @@ -1,19 +1,19 @@ --- title: chats -description: Contains list of chats +description: Represents list of chats --- ## Constructor: chats [Back to constructors index](index.md) -Contains list of chats +Represents list of chats ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chats|Array of [chat](../constructors/chat.md) | Yes|List of chats| +|chat\_ids|Array of [int53](../constructors/int53.md) | Yes|List of chat identifiers| diff --git a/docs/TD_docs/constructors/connectionStateConnecting.md b/docs/TD_docs/constructors/connectionStateConnecting.md new file mode 100644 index 00000000..0ab028cb --- /dev/null +++ b/docs/TD_docs/constructors/connectionStateConnecting.md @@ -0,0 +1,21 @@ +--- +title: connectionStateConnecting +description: Establishing connection to Telegram servers +--- +## Constructor: connectionStateConnecting +[Back to constructors index](index.md) + + + +Establishing connection to Telegram servers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [ConnectionState](../types/ConnectionState.md) + + diff --git a/docs/TD_docs/constructors/connectionStateConnectingToProxy.md b/docs/TD_docs/constructors/connectionStateConnectingToProxy.md new file mode 100644 index 00000000..c217dd45 --- /dev/null +++ b/docs/TD_docs/constructors/connectionStateConnectingToProxy.md @@ -0,0 +1,21 @@ +--- +title: connectionStateConnectingToProxy +description: Establishing connection to set up proxy server +--- +## Constructor: connectionStateConnectingToProxy +[Back to constructors index](index.md) + + + +Establishing connection to set up proxy server + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [ConnectionState](../types/ConnectionState.md) + + diff --git a/docs/TD_docs/constructors/connectionStateReady.md b/docs/TD_docs/constructors/connectionStateReady.md new file mode 100644 index 00000000..f74b803f --- /dev/null +++ b/docs/TD_docs/constructors/connectionStateReady.md @@ -0,0 +1,21 @@ +--- +title: connectionStateReady +description: There is a working connection to the Telegram servers +--- +## Constructor: connectionStateReady +[Back to constructors index](index.md) + + + +There is a working connection to the Telegram servers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [ConnectionState](../types/ConnectionState.md) + + diff --git a/docs/TD_docs/constructors/connectionStateUpdating.md b/docs/TD_docs/constructors/connectionStateUpdating.md new file mode 100644 index 00000000..5e3cedd7 --- /dev/null +++ b/docs/TD_docs/constructors/connectionStateUpdating.md @@ -0,0 +1,21 @@ +--- +title: connectionStateUpdating +description: Downloading date received, while client was offline +--- +## Constructor: connectionStateUpdating +[Back to constructors index](index.md) + + + +Downloading date received, while client was offline + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [ConnectionState](../types/ConnectionState.md) + + diff --git a/docs/TD_docs/constructors/connectionStateWaitingForNetwork.md b/docs/TD_docs/constructors/connectionStateWaitingForNetwork.md new file mode 100644 index 00000000..335df0c6 --- /dev/null +++ b/docs/TD_docs/constructors/connectionStateWaitingForNetwork.md @@ -0,0 +1,21 @@ +--- +title: connectionStateWaitingForNetwork +description: Waiting for network to be available. Use SetNetworkType to change available network type +--- +## Constructor: connectionStateWaitingForNetwork +[Back to constructors index](index.md) + + + +Waiting for network to be available. Use SetNetworkType to change available network type + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [ConnectionState](../types/ConnectionState.md) + + diff --git a/docs/TD_docs/constructors/customRequestResult.md b/docs/TD_docs/constructors/customRequestResult.md new file mode 100644 index 00000000..c28607b4 --- /dev/null +++ b/docs/TD_docs/constructors/customRequestResult.md @@ -0,0 +1,22 @@ +--- +title: customRequestResult +description: Contains result of a custom request +--- +## Constructor: customRequestResult +[Back to constructors index](index.md) + + + +Contains result of a custom request + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|result|[string](../types/string.md) | Yes|JSON-serialized result| + + + +### Type: [CustomRequestResult](../types/CustomRequestResult.md) + + diff --git a/docs/TD_docs/constructors/apnsDeviceToken.md b/docs/TD_docs/constructors/deviceTokenApns.md similarity index 65% rename from docs/TD_docs/constructors/apnsDeviceToken.md rename to docs/TD_docs/constructors/deviceTokenApns.md index e294caeb..aeaf102d 100644 --- a/docs/TD_docs/constructors/apnsDeviceToken.md +++ b/docs/TD_docs/constructors/deviceTokenApns.md @@ -1,8 +1,8 @@ --- -title: apnsDeviceToken +title: deviceTokenApns description: Token for APNS --- -## Constructor: apnsDeviceToken +## Constructor: deviceTokenApns [Back to constructors index](index.md) @@ -13,7 +13,7 @@ Token for APNS | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token|[string](../types/string.md) | Yes|The token| +|token|[string](../types/string.md) | Yes|The token, may be empty to unregister device| diff --git a/docs/TD_docs/constructors/blackberryDeviceToken.md b/docs/TD_docs/constructors/deviceTokenBlackberry.md similarity index 66% rename from docs/TD_docs/constructors/blackberryDeviceToken.md rename to docs/TD_docs/constructors/deviceTokenBlackberry.md index 765ee4f9..2e30311a 100644 --- a/docs/TD_docs/constructors/blackberryDeviceToken.md +++ b/docs/TD_docs/constructors/deviceTokenBlackberry.md @@ -1,8 +1,8 @@ --- -title: blackberryDeviceToken +title: deviceTokenBlackberry description: Token for Blackberry Push Service --- -## Constructor: blackberryDeviceToken +## Constructor: deviceTokenBlackberry [Back to constructors index](index.md) @@ -13,7 +13,7 @@ Token for Blackberry Push Service | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token|[string](../types/string.md) | Yes|The token| +|token|[string](../types/string.md) | Yes|The token, may be empty to unregister device| diff --git a/docs/TD_docs/constructors/gcmDeviceToken.md b/docs/TD_docs/constructors/deviceTokenGcm.md similarity index 65% rename from docs/TD_docs/constructors/gcmDeviceToken.md rename to docs/TD_docs/constructors/deviceTokenGcm.md index 171f8f19..7d88c8e3 100644 --- a/docs/TD_docs/constructors/gcmDeviceToken.md +++ b/docs/TD_docs/constructors/deviceTokenGcm.md @@ -1,8 +1,8 @@ --- -title: gcmDeviceToken +title: deviceTokenGcm description: Token for GCM --- -## Constructor: gcmDeviceToken +## Constructor: deviceTokenGcm [Back to constructors index](index.md) @@ -13,7 +13,7 @@ Token for GCM | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token|[string](../types/string.md) | Yes|The token| +|token|[string](../types/string.md) | Yes|The token, may be empty to unregister device| diff --git a/docs/TD_docs/constructors/mpnsDeviceToken.md b/docs/TD_docs/constructors/deviceTokenMpns.md similarity index 65% rename from docs/TD_docs/constructors/mpnsDeviceToken.md rename to docs/TD_docs/constructors/deviceTokenMpns.md index 781ae488..7b4129bb 100644 --- a/docs/TD_docs/constructors/mpnsDeviceToken.md +++ b/docs/TD_docs/constructors/deviceTokenMpns.md @@ -1,8 +1,8 @@ --- -title: mpnsDeviceToken +title: deviceTokenMpns description: Token for MPNS --- -## Constructor: mpnsDeviceToken +## Constructor: deviceTokenMpns [Back to constructors index](index.md) @@ -13,7 +13,7 @@ Token for MPNS | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token|[string](../types/string.md) | Yes|The token| +|token|[string](../types/string.md) | Yes|The token, may be empty to unregister device| diff --git a/docs/TD_docs/constructors/deviceTokenSet.md b/docs/TD_docs/constructors/deviceTokenSet.md deleted file mode 100644 index 1b716df8..00000000 --- a/docs/TD_docs/constructors/deviceTokenSet.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: deviceTokenSet -description: Contains list of device tokens ---- -## Constructor: deviceTokenSet -[Back to constructors index](index.md) - - - -Contains list of device tokens - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|tokens|Array of [DeviceToken](../constructors/DeviceToken.md) | Yes|List of tokens| - - - -### Type: [DeviceTokenSet](../types/DeviceTokenSet.md) - - diff --git a/docs/TD_docs/constructors/simplePushDeviceToken.md b/docs/TD_docs/constructors/deviceTokenSimplePush.md similarity index 64% rename from docs/TD_docs/constructors/simplePushDeviceToken.md rename to docs/TD_docs/constructors/deviceTokenSimplePush.md index 24550efd..ccf80615 100644 --- a/docs/TD_docs/constructors/simplePushDeviceToken.md +++ b/docs/TD_docs/constructors/deviceTokenSimplePush.md @@ -1,8 +1,8 @@ --- -title: simplePushDeviceToken +title: deviceTokenSimplePush description: Token for simple push --- -## Constructor: simplePushDeviceToken +## Constructor: deviceTokenSimplePush [Back to constructors index](index.md) @@ -13,7 +13,7 @@ Token for simple push | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token|[string](../types/string.md) | Yes|The token| +|token|[string](../types/string.md) | Yes|The token, may be empty to unregister device| diff --git a/docs/TD_docs/constructors/ubuntuPhoneDeviceToken.md b/docs/TD_docs/constructors/deviceTokenUbuntuPhone.md similarity index 65% rename from docs/TD_docs/constructors/ubuntuPhoneDeviceToken.md rename to docs/TD_docs/constructors/deviceTokenUbuntuPhone.md index 309c68b8..55adf886 100644 --- a/docs/TD_docs/constructors/ubuntuPhoneDeviceToken.md +++ b/docs/TD_docs/constructors/deviceTokenUbuntuPhone.md @@ -1,8 +1,8 @@ --- -title: ubuntuPhoneDeviceToken +title: deviceTokenUbuntuPhone description: Token for Ubuntu Push Service --- -## Constructor: ubuntuPhoneDeviceToken +## Constructor: deviceTokenUbuntuPhone [Back to constructors index](index.md) @@ -13,7 +13,7 @@ Token for Ubuntu Push Service | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token|[string](../types/string.md) | Yes|The token| +|token|[string](../types/string.md) | Yes|The token, may be empty to unregister device| diff --git a/docs/TD_docs/constructors/draftMessage.md b/docs/TD_docs/constructors/draftMessage.md index c0f033f0..cadccf76 100644 --- a/docs/TD_docs/constructors/draftMessage.md +++ b/docs/TD_docs/constructors/draftMessage.md @@ -13,7 +13,7 @@ Contains information about draft of a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|reply\_to\_message\_id|[long](../types/long.md) | Yes|Identifier of a message to reply to or 0| +|reply\_to\_message\_id|[int53](../types/int53.md) | Yes|Identifier of a message to reply to or 0| |input\_message\_text|[InputMessageContent](../types/InputMessageContent.md) | Yes|Content of a draft message, always should be of a type inputMessageText| diff --git a/docs/TD_docs/constructors/error.md b/docs/TD_docs/constructors/error.md index df14311a..92e98a8d 100644 --- a/docs/TD_docs/constructors/error.md +++ b/docs/TD_docs/constructors/error.md @@ -13,7 +13,7 @@ Object of this type may be returned on every function call in case of the error | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[int](../types/int.md) | Yes|Error code, maybe changed in the future| +|code|[int](../types/int.md) | Yes|Error code, maybe changed in the future. If code == 406, error message should not be processed in any way and shouldn't be showed to the user| |message|[string](../types/string.md) | Yes|Error message, may be changed in the future| diff --git a/docs/TD_docs/constructors/file.md b/docs/TD_docs/constructors/file.md index 50857143..4c0a1b39 100644 --- a/docs/TD_docs/constructors/file.md +++ b/docs/TD_docs/constructors/file.md @@ -13,10 +13,14 @@ Represents a file | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[int](../types/int.md) | Yes|Unique file identifier, 0 for empty file| -|persistent\_id|[string](../types/string.md) | Yes|Persistent file identifier, if exists. Can be used across application restarts or even other devices for current logged user. If begins with "http: " or "https: ", it is HTTP URL of the file. Currently, TDLib is unable to download files if only they URL is known| +|id|[int](../types/int.md) | Yes|Unique file identifier| +|persistent\_id|[string](../types/string.md) | Yes|Persistent file identifier, if exists. Can be used across application restarts or even other devices for current logged user. If begins with "http: " or "https: ", it is HTTP URL of the file. Currently, TDLib is unable to download files if only they URL is known. If downloadFile is called on a such file or it is sended to a secret chat TDLib starts file generation process by sending to the client updateFileGenerationStart with HTTP URL in the original_path and "#url#" as conversion string. Client supposed to generate the file by downloading it to the specified location| |size|[int](../types/int.md) | Yes|File size, 0 if unknown| -|path|[string](../types/string.md) | Yes|Local path to the file, if available| +|is\_being\_downloaded|[Bool](../types/Bool.md) | Yes|True, if the file is currently being downloaded| +|local\_size|[int](../types/int.md) | Yes|Size of locally available part of the file. If size != 0 && local_size == size, full file is available locally| +|is\_being\_uploaded|[Bool](../types/Bool.md) | Yes|True, if the file is currently being uploaded| +|remote\_size|[int](../types/int.md) | Yes|Size of remotely available part of the file. If size != 0 && remote_size == size, the file is available remotely| +|path|[string](../types/string.md) | Yes|Local path to the available file part, may be empty| diff --git a/docs/TD_docs/constructors/fileTypeAnimation.md b/docs/TD_docs/constructors/fileTypeAnimation.md new file mode 100644 index 00000000..5c04ccf1 --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeAnimation.md @@ -0,0 +1,21 @@ +--- +title: fileTypeAnimation +description: File is an animation +--- +## Constructor: fileTypeAnimation +[Back to constructors index](index.md) + + + +File is an animation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeAudio.md b/docs/TD_docs/constructors/fileTypeAudio.md new file mode 100644 index 00000000..064eda2b --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeAudio.md @@ -0,0 +1,21 @@ +--- +title: fileTypeAudio +description: File is an audio +--- +## Constructor: fileTypeAudio +[Back to constructors index](index.md) + + + +File is an audio + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeDocument.md b/docs/TD_docs/constructors/fileTypeDocument.md new file mode 100644 index 00000000..8903702e --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeDocument.md @@ -0,0 +1,21 @@ +--- +title: fileTypeDocument +description: File is a document +--- +## Constructor: fileTypeDocument +[Back to constructors index](index.md) + + + +File is a document + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeNone.md b/docs/TD_docs/constructors/fileTypeNone.md new file mode 100644 index 00000000..96ec4c0d --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeNone.md @@ -0,0 +1,21 @@ +--- +title: fileTypeNone +description: Data is not a file +--- +## Constructor: fileTypeNone +[Back to constructors index](index.md) + + + +Data is not a file + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypePhoto.md b/docs/TD_docs/constructors/fileTypePhoto.md new file mode 100644 index 00000000..51f53d71 --- /dev/null +++ b/docs/TD_docs/constructors/fileTypePhoto.md @@ -0,0 +1,21 @@ +--- +title: fileTypePhoto +description: File is a photo +--- +## Constructor: fileTypePhoto +[Back to constructors index](index.md) + + + +File is a photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeProfilePhoto.md b/docs/TD_docs/constructors/fileTypeProfilePhoto.md new file mode 100644 index 00000000..95c6c2a3 --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeProfilePhoto.md @@ -0,0 +1,21 @@ +--- +title: fileTypeProfilePhoto +description: File is a profile photo +--- +## Constructor: fileTypeProfilePhoto +[Back to constructors index](index.md) + + + +File is a profile photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeSecret.md b/docs/TD_docs/constructors/fileTypeSecret.md new file mode 100644 index 00000000..15444ee0 --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeSecret.md @@ -0,0 +1,21 @@ +--- +title: fileTypeSecret +description: File sent to a secret chat +--- +## Constructor: fileTypeSecret +[Back to constructors index](index.md) + + + +File sent to a secret chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeSecretThumb.md b/docs/TD_docs/constructors/fileTypeSecretThumb.md new file mode 100644 index 00000000..6fc1387a --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeSecretThumb.md @@ -0,0 +1,21 @@ +--- +title: fileTypeSecretThumb +description: File is a thumbnail of a file from a secret chat +--- +## Constructor: fileTypeSecretThumb +[Back to constructors index](index.md) + + + +File is a thumbnail of a file from a secret chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeSticker.md b/docs/TD_docs/constructors/fileTypeSticker.md new file mode 100644 index 00000000..e9ce234d --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeSticker.md @@ -0,0 +1,21 @@ +--- +title: fileTypeSticker +description: File is a sticker +--- +## Constructor: fileTypeSticker +[Back to constructors index](index.md) + + + +File is a sticker + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeThumb.md b/docs/TD_docs/constructors/fileTypeThumb.md new file mode 100644 index 00000000..4a240e18 --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeThumb.md @@ -0,0 +1,21 @@ +--- +title: fileTypeThumb +description: File is a thumbnail of another file +--- +## Constructor: fileTypeThumb +[Back to constructors index](index.md) + + + +File is a thumbnail of another file + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeUnknown.md b/docs/TD_docs/constructors/fileTypeUnknown.md new file mode 100644 index 00000000..b05fd135 --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeUnknown.md @@ -0,0 +1,21 @@ +--- +title: fileTypeUnknown +description: File type is yet unknown +--- +## Constructor: fileTypeUnknown +[Back to constructors index](index.md) + + + +File type is yet unknown + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeVideo.md b/docs/TD_docs/constructors/fileTypeVideo.md new file mode 100644 index 00000000..d2ba0dff --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeVideo.md @@ -0,0 +1,21 @@ +--- +title: fileTypeVideo +description: File is a video +--- +## Constructor: fileTypeVideo +[Back to constructors index](index.md) + + + +File is a video + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeVideoNote.md b/docs/TD_docs/constructors/fileTypeVideoNote.md new file mode 100644 index 00000000..69ef809c --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeVideoNote.md @@ -0,0 +1,21 @@ +--- +title: fileTypeVideoNote +description: File is a video note +--- +## Constructor: fileTypeVideoNote +[Back to constructors index](index.md) + + + +File is a video note + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeVoice.md b/docs/TD_docs/constructors/fileTypeVoice.md new file mode 100644 index 00000000..0c545cb0 --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeVoice.md @@ -0,0 +1,21 @@ +--- +title: fileTypeVoice +description: File is a voice audio +--- +## Constructor: fileTypeVoice +[Back to constructors index](index.md) + + + +File is a voice audio + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/fileTypeWallpaper.md b/docs/TD_docs/constructors/fileTypeWallpaper.md new file mode 100644 index 00000000..294911b4 --- /dev/null +++ b/docs/TD_docs/constructors/fileTypeWallpaper.md @@ -0,0 +1,21 @@ +--- +title: fileTypeWallpaper +description: File is a wallpaper +--- +## Constructor: fileTypeWallpaper +[Back to constructors index](index.md) + + + +File is a wallpaper + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [FileType](../types/FileType.md) + + diff --git a/docs/TD_docs/constructors/foundMessages.md b/docs/TD_docs/constructors/foundMessages.md new file mode 100644 index 00000000..d27f7fb4 --- /dev/null +++ b/docs/TD_docs/constructors/foundMessages.md @@ -0,0 +1,23 @@ +--- +title: foundMessages +description: Contains list of found by search messages +--- +## Constructor: foundMessages +[Back to constructors index](index.md) + + + +Contains list of found by search messages + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|messages|Array of [message](../constructors/message.md) | Yes|List of messages| +|next\_from\_search\_id|[long](../types/long.md) | Yes|Value to pass as from_search_id to get more results| + + + +### Type: [FoundMessages](../types/FoundMessages.md) + + diff --git a/docs/TD_docs/constructors/game.md b/docs/TD_docs/constructors/game.md index af180fa1..5696572d 100644 --- a/docs/TD_docs/constructors/game.md +++ b/docs/TD_docs/constructors/game.md @@ -14,10 +14,10 @@ Describes a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |id|[long](../types/long.md) | Yes|Game id| -|short\_name|[string](../types/string.md) | Yes|Game short name, to share a game use a URL https: telegram.me/{bot_username}?game={game_short_name}| +|short\_name|[string](../types/string.md) | Yes|Game short name, to share a game use a URL https: t.me/{bot_username}?game={game_short_name}| |title|[string](../types/string.md) | Yes|Game title| |text|[string](../types/string.md) | Yes|Game text, usually containing game scoreboards| -|text\_entities|Array of [MessageEntity](../constructors/MessageEntity.md) | Yes|Entities contained in the text| +|text\_entities|Array of [textEntity](../constructors/textEntity.md) | Yes|Entities contained in the text| |description|[string](../types/string.md) | Yes|Game description| |photo|[photo](../types/photo.md) | Yes|Game photo| |animation|[animation](../types/animation.md) | Yes|Game animation, nullable| diff --git a/docs/TD_docs/constructors/group.md b/docs/TD_docs/constructors/group.md index 76d383cf..d16d6fe2 100644 --- a/docs/TD_docs/constructors/group.md +++ b/docs/TD_docs/constructors/group.md @@ -16,7 +16,7 @@ Represents a group of zero or more other users |id|[int](../types/int.md) | Yes|Group identifier| |member\_count|[int](../types/int.md) | Yes|Group member count| |status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|Status of the current user in the group| -|anyone\_can\_edit|[Bool](../types/Bool.md) | Yes|True, if all members granted editor rights in the group| +|everyone\_is\_administrator|[Bool](../types/Bool.md) | Yes|True, if all members granted administrator rights in the group| |is\_active|[Bool](../types/Bool.md) | Yes|True, if group is active| |migrated\_to\_channel\_id|[int](../types/int.md) | Yes|Identifier of channel (supergroup) to which this group was migrated or 0 if none| diff --git a/docs/TD_docs/constructors/groupFull.md b/docs/TD_docs/constructors/groupFull.md index 9f02da28..475a93c4 100644 --- a/docs/TD_docs/constructors/groupFull.md +++ b/docs/TD_docs/constructors/groupFull.md @@ -13,7 +13,6 @@ Gives full information about a group | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|group|[group](../types/group.md) | Yes|General info about the group| |creator\_user\_id|[int](../types/int.md) | Yes|User identifier of the group creator, 0 if unknown| |members|Array of [chatMember](../constructors/chatMember.md) | Yes|Group members| |invite\_link|[string](../types/string.md) | Yes|Invite link for this group, available only for group creator and only after it is generated at least once| diff --git a/docs/TD_docs/constructors/hashtags.md b/docs/TD_docs/constructors/hashtags.md new file mode 100644 index 00000000..98c2fd8b --- /dev/null +++ b/docs/TD_docs/constructors/hashtags.md @@ -0,0 +1,22 @@ +--- +title: hashtags +description: Contatins list of hashtags +--- +## Constructor: hashtags +[Back to constructors index](index.md) + + + +Contatins list of hashtags + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hashtags|Array of [string](../constructors/string.md) | Yes|List of hashtags| + + + +### Type: [Hashtags](../types/Hashtags.md) + + diff --git a/docs/TD_docs/constructors/importedContacts.md b/docs/TD_docs/constructors/importedContacts.md new file mode 100644 index 00000000..28bddc11 --- /dev/null +++ b/docs/TD_docs/constructors/importedContacts.md @@ -0,0 +1,23 @@ +--- +title: importedContacts +description: Represent result for ImportContacts request +--- +## Constructor: importedContacts +[Back to constructors index](index.md) + + + +Represent result for ImportContacts request + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_ids|Array of [int](../constructors/int.md) | Yes|User identifiers of imported contacts in the same order as they was specified in the request. 0 if contact is not yet registered| +|importer\_count|Array of [int](../constructors/int.md) | Yes|Number of users which imported corresponding contact. 0 for already registered users or if unavailable| + + + +### Type: [ImportedContacts](../types/ImportedContacts.md) + + diff --git a/docs/TD_docs/constructors/index.md b/docs/TD_docs/constructors/index.md index 7c3dabae..51c24189 100644 --- a/docs/TD_docs/constructors/index.md +++ b/docs/TD_docs/constructors/index.md @@ -8,14 +8,11 @@ description: List of constructors

[$accountTtl](../constructors/accountTtl.md) = \['days' => [int](../types/int.md), \]; *** -

[$animation](../constructors/animation.md) = \['width' => [int](../types/int.md), 'height' => [int](../types/int.md), 'file_name' => [string](../types/string.md), 'mime_type' => [string](../types/string.md), 'thumb' => [photoSize](../constructors/photoSize.md), 'animation' => [file](../constructors/file.md), \]; +

[$animation](../constructors/animation.md) = \['duration' => [int](../types/int.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), 'file_name' => [string](../types/string.md), 'mime_type' => [string](../types/string.md), 'thumb' => [photoSize](../constructors/photoSize.md), 'animation' => [file](../constructors/file.md), \]; ***

[$animations](../constructors/animations.md) = \['animations' => \[[animation](../constructors/animation.md)\], \]; -*** -

[$apnsDeviceToken](../constructors/apnsDeviceToken.md) = \['token' => [string](../types/string.md), \]; - ***

[$audio](../constructors/audio.md) = \['duration' => [int](../types/int.md), 'title' => [string](../types/string.md), 'performer' => [string](../types/string.md), 'file_name' => [string](../types/string.md), 'mime_type' => [string](../types/string.md), 'album_cover_thumb' => [photoSize](../constructors/photoSize.md), 'audio' => [file](../constructors/file.md), \]; @@ -46,69 +43,204 @@ description: List of constructors ***

[$authStateWaitPhoneNumber](../constructors/authStateWaitPhoneNumber.md) = \[\]; -*** -

[$blackberryDeviceToken](../constructors/blackberryDeviceToken.md) = \['token' => [string](../types/string.md), \]; - ***

[$botCommand](../constructors/botCommand.md) = \['command' => [string](../types/string.md), 'description' => [string](../types/string.md), \]; ***

[$botInfo](../constructors/botInfo.md) = \['description' => [string](../types/string.md), 'commands' => \[[botCommand](../constructors/botCommand.md)\], \]; +*** +

[$call](../constructors/call.md) = \['id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'is_outgoing' => [Bool](../types/Bool.md), 'state' => [CallState](../types/CallState.md), \]; + +*** +

[$callConnection](../constructors/callConnection.md) = \['id' => [long](../types/long.md), 'ip' => [string](../types/string.md), 'ipv6' => [string](../types/string.md), 'port' => [int](../types/int.md), 'peer_tag' => [bytes](../types/bytes.md), \]; + +*** +

[$callDiscardReasonDeclined](../constructors/callDiscardReasonDeclined.md) = \[\]; + +*** +

[$callDiscardReasonDisconnected](../constructors/callDiscardReasonDisconnected.md) = \[\]; + +*** +

[$callDiscardReasonEmpty](../constructors/callDiscardReasonEmpty.md) = \[\]; + +*** +

[$callDiscardReasonHungUp](../constructors/callDiscardReasonHungUp.md) = \[\]; + +*** +

[$callDiscardReasonMissed](../constructors/callDiscardReasonMissed.md) = \[\]; + +*** +

[$callId](../constructors/callId.md) = \['id' => [int](../types/int.md), \]; + +*** +

[$callProtocol](../constructors/callProtocol.md) = \['udp_p2p' => [Bool](../types/Bool.md), 'udp_reflector' => [Bool](../types/Bool.md), 'min_layer' => [int](../types/int.md), 'max_layer' => [int](../types/int.md), \]; + +*** +

[$callStateDiscarded](../constructors/callStateDiscarded.md) = \['reason' => [CallDiscardReason](../types/CallDiscardReason.md), 'need_rating' => [Bool](../types/Bool.md), 'need_debug' => [Bool](../types/Bool.md), \]; + +*** +

[$callStateError](../constructors/callStateError.md) = \['error' => [error](../constructors/error.md), \]; + +*** +

[$callStateExchangingKeys](../constructors/callStateExchangingKeys.md) = \[\]; + +*** +

[$callStateHangingUp](../constructors/callStateHangingUp.md) = \[\]; + +*** +

[$callStatePending](../constructors/callStatePending.md) = \['is_created' => [Bool](../types/Bool.md), 'is_received' => [Bool](../types/Bool.md), \]; + +*** +

[$callStateReady](../constructors/callStateReady.md) = \['protocol' => [callProtocol](../constructors/callProtocol.md), 'connections' => \[[callConnection](../constructors/callConnection.md)\], 'config' => [string](../types/string.md), 'encryption_key' => [bytes](../types/bytes.md), 'emojis' => \[[string](../types/string.md)\], \]; + ***

[$callbackQueryAnswer](../constructors/callbackQueryAnswer.md) = \['text' => [string](../types/string.md), 'show_alert' => [Bool](../types/Bool.md), 'url' => [string](../types/string.md), \]; *** -

[$callbackQueryData](../constructors/callbackQueryData.md) = \['data' => [bytes](../types/bytes.md), \]; +

[$callbackQueryPayloadData](../constructors/callbackQueryPayloadData.md) = \['data' => [bytes](../types/bytes.md), \]; *** -

[$callbackQueryGame](../constructors/callbackQueryGame.md) = \['game_short_name' => [string](../types/string.md), \]; +

[$callbackQueryPayloadGame](../constructors/callbackQueryPayloadGame.md) = \['game_short_name' => [string](../types/string.md), \]; ***

[$channel](../constructors/channel.md) = \['id' => [int](../types/int.md), 'username' => [string](../types/string.md), 'date' => [int](../types/int.md), 'status' => [ChatMemberStatus](../types/ChatMemberStatus.md), 'anyone_can_invite' => [Bool](../types/Bool.md), 'sign_messages' => [Bool](../types/Bool.md), 'is_supergroup' => [Bool](../types/Bool.md), 'is_verified' => [Bool](../types/Bool.md), 'restriction_reason' => [string](../types/string.md), \]; *** -

[$channelChatInfo](../constructors/channelChatInfo.md) = \['channel' => [channel](../constructors/channel.md), \]; +

[$channelFull](../constructors/channelFull.md) = \['description' => [string](../types/string.md), 'member_count' => [int](../types/int.md), 'administrator_count' => [int](../types/int.md), 'restricted_count' => [int](../types/int.md), 'banned_count' => [int](../types/int.md), 'can_get_members' => [Bool](../types/Bool.md), 'can_set_username' => [Bool](../types/Bool.md), 'invite_link' => [string](../types/string.md), 'pinned_message_id' => [int53](../constructors/int53.md), 'migrated_from_group_id' => [int](../types/int.md), 'migrated_from_max_message_id' => [int53](../constructors/int53.md), \]; *** -

[$channelFull](../constructors/channelFull.md) = \['channel' => [channel](../constructors/channel.md), 'about' => [string](../types/string.md), 'member_count' => [int](../types/int.md), 'administrator_count' => [int](../types/int.md), 'kicked_count' => [int](../types/int.md), 'can_get_members' => [Bool](../types/Bool.md), 'can_set_username' => [Bool](../types/Bool.md), 'invite_link' => [string](../types/string.md), 'pinned_message_id' => [long](../types/long.md), 'migrated_from_group_id' => [int](../types/int.md), 'migrated_from_max_message_id' => [long](../types/long.md), \]; +

[$channelMembersFilterAdministrators](../constructors/channelMembersFilterAdministrators.md) = \[\]; *** -

[$channelMembersAdministrators](../constructors/channelMembersAdministrators.md) = \[\]; +

[$channelMembersFilterBanned](../constructors/channelMembersFilterBanned.md) = \['query' => [string](../types/string.md), \]; *** -

[$channelMembersBots](../constructors/channelMembersBots.md) = \[\]; +

[$channelMembersFilterBots](../constructors/channelMembersFilterBots.md) = \[\]; *** -

[$channelMembersKicked](../constructors/channelMembersKicked.md) = \[\]; +

[$channelMembersFilterRecent](../constructors/channelMembersFilterRecent.md) = \[\]; *** -

[$channelMembersRecent](../constructors/channelMembersRecent.md) = \[\]; +

[$channelMembersFilterRestricted](../constructors/channelMembersFilterRestricted.md) = \['query' => [string](../types/string.md), \]; *** -

[$channels](../constructors/channels.md) = \['channel_ids' => \[[int](../types/int.md)\], \]; +

[$channelMembersFilterSearch](../constructors/channelMembersFilterSearch.md) = \['query' => [string](../types/string.md), \]; *** -

[$chat](../constructors/chat.md) = \['id' => [long](../types/long.md), 'title' => [string](../types/string.md), 'photo' => [chatPhoto](../constructors/chatPhoto.md), 'top_message' => [message](../constructors/message.md), 'order' => [long](../types/long.md), 'unread_count' => [int](../types/int.md), 'last_read_inbox_message_id' => [long](../types/long.md), 'last_read_outbox_message_id' => [long](../types/long.md), 'notification_settings' => [notificationSettings](../constructors/notificationSettings.md), 'reply_markup_message_id' => [long](../types/long.md), 'draft_message' => [draftMessage](../constructors/draftMessage.md), 'type' => [ChatInfo](../types/ChatInfo.md), \]; +

[$chat](../constructors/chat.md) = \['id' => [int53](../constructors/int53.md), 'type' => [ChatType](../types/ChatType.md), 'title' => [string](../types/string.md), 'photo' => [chatPhoto](../constructors/chatPhoto.md), 'top_message' => [message](../constructors/message.md), 'order' => [long](../types/long.md), 'is_pinned' => [Bool](../types/Bool.md), 'unread_count' => [int](../types/int.md), 'last_read_inbox_message_id' => [int53](../constructors/int53.md), 'last_read_outbox_message_id' => [int53](../constructors/int53.md), 'notification_settings' => [notificationSettings](../constructors/notificationSettings.md), 'reply_markup_message_id' => [int53](../constructors/int53.md), 'draft_message' => [draftMessage](../constructors/draftMessage.md), 'client_data' => [string](../types/string.md), \]; + +*** +

[$chatActionCancel](../constructors/chatActionCancel.md) = \[\]; + +*** +

[$chatActionChoosingContact](../constructors/chatActionChoosingContact.md) = \[\]; + +*** +

[$chatActionChoosingLocation](../constructors/chatActionChoosingLocation.md) = \[\]; + +*** +

[$chatActionRecordingVideo](../constructors/chatActionRecordingVideo.md) = \[\]; + +*** +

[$chatActionRecordingVideoNote](../constructors/chatActionRecordingVideoNote.md) = \[\]; + +*** +

[$chatActionRecordingVoice](../constructors/chatActionRecordingVoice.md) = \[\]; + +*** +

[$chatActionStartPlayingGame](../constructors/chatActionStartPlayingGame.md) = \[\]; + +*** +

[$chatActionTyping](../constructors/chatActionTyping.md) = \[\]; + +*** +

[$chatActionUploadingDocument](../constructors/chatActionUploadingDocument.md) = \['progress' => [int](../types/int.md), \]; + +*** +

[$chatActionUploadingPhoto](../constructors/chatActionUploadingPhoto.md) = \['progress' => [int](../types/int.md), \]; + +*** +

[$chatActionUploadingVideo](../constructors/chatActionUploadingVideo.md) = \['progress' => [int](../types/int.md), \]; + +*** +

[$chatActionUploadingVideoNote](../constructors/chatActionUploadingVideoNote.md) = \['progress' => [int](../types/int.md), \]; + +*** +

[$chatActionUploadingVoice](../constructors/chatActionUploadingVoice.md) = \['progress' => [int](../types/int.md), \]; + +*** +

[$chatEvent](../constructors/chatEvent.md) = \['id' => [long](../types/long.md), 'date' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'action' => [ChatEventAction](../types/ChatEventAction.md), \]; + +*** +

[$chatEventDescriptionChanged](../constructors/chatEventDescriptionChanged.md) = \['old_description' => [string](../types/string.md), 'new_description' => [string](../types/string.md), \]; + +*** +

[$chatEventInvitesToggled](../constructors/chatEventInvitesToggled.md) = \['anyone_can_invite' => [Bool](../types/Bool.md), \]; + +*** +

[$chatEventLogFilters](../constructors/chatEventLogFilters.md) = \['message_edits' => [Bool](../types/Bool.md), 'message_deletions' => [Bool](../types/Bool.md), 'message_pins' => [Bool](../types/Bool.md), 'member_joins' => [Bool](../types/Bool.md), 'member_leaves' => [Bool](../types/Bool.md), 'member_invites' => [Bool](../types/Bool.md), 'member_promotions' => [Bool](../types/Bool.md), 'member_restrictions' => [Bool](../types/Bool.md), 'info_changes' => [Bool](../types/Bool.md), 'setting_changes' => [Bool](../types/Bool.md), \]; + +*** +

[$chatEventMemberInvited](../constructors/chatEventMemberInvited.md) = \['user_id' => [int](../types/int.md), 'status' => [ChatMemberStatus](../types/ChatMemberStatus.md), \]; + +*** +

[$chatEventMemberJoined](../constructors/chatEventMemberJoined.md) = \[\]; + +*** +

[$chatEventMemberLeft](../constructors/chatEventMemberLeft.md) = \[\]; + +*** +

[$chatEventMemberPromoted](../constructors/chatEventMemberPromoted.md) = \['user_id' => [int](../types/int.md), 'old_status' => [ChatMemberStatus](../types/ChatMemberStatus.md), 'new_status' => [ChatMemberStatus](../types/ChatMemberStatus.md), \]; + +*** +

[$chatEventMemberRestricted](../constructors/chatEventMemberRestricted.md) = \['user_id' => [int](../types/int.md), 'old_status' => [ChatMemberStatus](../types/ChatMemberStatus.md), 'new_status' => [ChatMemberStatus](../types/ChatMemberStatus.md), \]; + +*** +

[$chatEventMessageDeleted](../constructors/chatEventMessageDeleted.md) = \['message' => [message](../constructors/message.md), \]; + +*** +

[$chatEventMessageEdited](../constructors/chatEventMessageEdited.md) = \['old_message' => [message](../constructors/message.md), 'new_message' => [message](../constructors/message.md), \]; + +*** +

[$chatEventMessagePinned](../constructors/chatEventMessagePinned.md) = \['message' => [message](../constructors/message.md), \]; + +*** +

[$chatEventMessageUnpinned](../constructors/chatEventMessageUnpinned.md) = \[\]; + +*** +

[$chatEventPhotoChanged](../constructors/chatEventPhotoChanged.md) = \['old_photo' => [chatPhoto](../constructors/chatPhoto.md), 'new_photo' => [chatPhoto](../constructors/chatPhoto.md), \]; + +*** +

[$chatEventSignMessagesToggled](../constructors/chatEventSignMessagesToggled.md) = \['sign_messages' => [Bool](../types/Bool.md), \]; + +*** +

[$chatEventTitleChanged](../constructors/chatEventTitleChanged.md) = \['old_title' => [string](../types/string.md), 'new_title' => [string](../types/string.md), \]; + +*** +

[$chatEventUsernameChanged](../constructors/chatEventUsernameChanged.md) = \['old_username' => [string](../types/string.md), 'new_username' => [string](../types/string.md), \]; + +*** +

[$chatEvents](../constructors/chatEvents.md) = \['events' => \[[chatEvent](../constructors/chatEvent.md)\], \]; ***

[$chatInviteLink](../constructors/chatInviteLink.md) = \['invite_link' => [string](../types/string.md), \]; *** -

[$chatInviteLinkInfo](../constructors/chatInviteLinkInfo.md) = \['chat_id' => [long](../types/long.md), 'title' => [string](../types/string.md), 'photo' => [chatPhoto](../constructors/chatPhoto.md), 'member_count' => [int](../types/int.md), 'members' => \[[user](../constructors/user.md)\], 'is_group' => [Bool](../types/Bool.md), 'is_channel' => [Bool](../types/Bool.md), 'is_public_channel' => [Bool](../types/Bool.md), 'is_supergroup_channel' => [Bool](../types/Bool.md), \]; +

[$chatInviteLinkInfo](../constructors/chatInviteLinkInfo.md) = \['chat_id' => [int53](../constructors/int53.md), 'title' => [string](../types/string.md), 'photo' => [chatPhoto](../constructors/chatPhoto.md), 'member_count' => [int](../types/int.md), 'member_user_ids' => \[[int](../types/int.md)\], 'is_group' => [Bool](../types/Bool.md), 'is_channel' => [Bool](../types/Bool.md), 'is_public_channel' => [Bool](../types/Bool.md), 'is_supergroup_channel' => [Bool](../types/Bool.md), \]; ***

[$chatMember](../constructors/chatMember.md) = \['user_id' => [int](../types/int.md), 'inviter_user_id' => [int](../types/int.md), 'join_date' => [int](../types/int.md), 'status' => [ChatMemberStatus](../types/ChatMemberStatus.md), 'bot_info' => [botInfo](../constructors/botInfo.md), \]; +*** +

[$chatMemberStatusAdministrator](../constructors/chatMemberStatusAdministrator.md) = \['can_be_edited' => [Bool](../types/Bool.md), 'can_change_info' => [Bool](../types/Bool.md), 'can_post_messages' => [Bool](../types/Bool.md), 'can_edit_messages' => [Bool](../types/Bool.md), 'can_delete_messages' => [Bool](../types/Bool.md), 'can_invite_users' => [Bool](../types/Bool.md), 'can_restrict_members' => [Bool](../types/Bool.md), 'can_pin_messages' => [Bool](../types/Bool.md), 'can_promote_members' => [Bool](../types/Bool.md), \]; + +*** +

[$chatMemberStatusBanned](../constructors/chatMemberStatusBanned.md) = \['banned_until_date' => [int](../types/int.md), \]; + ***

[$chatMemberStatusCreator](../constructors/chatMemberStatusCreator.md) = \[\]; -*** -

[$chatMemberStatusEditor](../constructors/chatMemberStatusEditor.md) = \[\]; - -*** -

[$chatMemberStatusKicked](../constructors/chatMemberStatusKicked.md) = \[\]; - ***

[$chatMemberStatusLeft](../constructors/chatMemberStatusLeft.md) = \[\]; @@ -116,7 +248,7 @@ description: List of constructors

[$chatMemberStatusMember](../constructors/chatMemberStatusMember.md) = \[\]; *** -

[$chatMemberStatusModerator](../constructors/chatMemberStatusModerator.md) = \[\]; +

[$chatMemberStatusRestricted](../constructors/chatMemberStatusRestricted.md) = \['is_member' => [Bool](../types/Bool.md), 'restricted_until_date' => [int](../types/int.md), 'can_send_messages' => [Bool](../types/Bool.md), 'can_send_media_messages' => [Bool](../types/Bool.md), 'can_send_other_messages' => [Bool](../types/Bool.md), 'can_add_web_page_previews' => [Bool](../types/Bool.md), \]; ***

[$chatMembers](../constructors/chatMembers.md) = \['total_count' => [int](../types/int.md), 'members' => \[[chatMember](../constructors/chatMember.md)\], \]; @@ -124,32 +256,137 @@ description: List of constructors ***

[$chatPhoto](../constructors/chatPhoto.md) = \['small' => [file](../constructors/file.md), 'big' => [file](../constructors/file.md), \]; +*** +

[$chatReportReasonOther](../constructors/chatReportReasonOther.md) = \['text' => [string](../types/string.md), \]; + +*** +

[$chatReportReasonPornography](../constructors/chatReportReasonPornography.md) = \[\]; + +*** +

[$chatReportReasonSpam](../constructors/chatReportReasonSpam.md) = \[\]; + +*** +

[$chatReportReasonViolence](../constructors/chatReportReasonViolence.md) = \[\]; + ***

[$chatReportSpamState](../constructors/chatReportSpamState.md) = \['can_report_spam' => [Bool](../types/Bool.md), \]; *** -

[$chats](../constructors/chats.md) = \['chats' => \[[chat](../constructors/chat.md)\], \]; +

[$chatTypeChannel](../constructors/chatTypeChannel.md) = \['channel_id' => [int](../types/int.md), \]; + +*** +

[$chatTypeGroup](../constructors/chatTypeGroup.md) = \['group_id' => [int](../types/int.md), \]; + +*** +

[$chatTypePrivate](../constructors/chatTypePrivate.md) = \['user_id' => [int](../types/int.md), \]; + +*** +

[$chatTypeSecret](../constructors/chatTypeSecret.md) = \['secret_chat_id' => [int](../types/int.md), \]; + +*** +

[$chats](../constructors/chats.md) = \['chat_ids' => \[[int53](../constructors/int53.md)\], \]; + +*** +

[$connectionStateConnecting](../constructors/connectionStateConnecting.md) = \[\]; + +*** +

[$connectionStateConnectingToProxy](../constructors/connectionStateConnectingToProxy.md) = \[\]; + +*** +

[$connectionStateReady](../constructors/connectionStateReady.md) = \[\]; + +*** +

[$connectionStateUpdating](../constructors/connectionStateUpdating.md) = \[\]; + +*** +

[$connectionStateWaitingForNetwork](../constructors/connectionStateWaitingForNetwork.md) = \[\]; ***

[$contact](../constructors/contact.md) = \['phone_number' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'user_id' => [int](../types/int.md), \]; *** -

[$deviceTokenSet](../constructors/deviceTokenSet.md) = \['tokens' => \[[DeviceToken](../types/DeviceToken.md)\], \]; +

[$customRequestResult](../constructors/customRequestResult.md) = \['result' => [string](../types/string.md), \]; + +*** +

[$deviceTokenApns](../constructors/deviceTokenApns.md) = \['token' => [string](../types/string.md), \]; + +*** +

[$deviceTokenBlackberry](../constructors/deviceTokenBlackberry.md) = \['token' => [string](../types/string.md), \]; + +*** +

[$deviceTokenGcm](../constructors/deviceTokenGcm.md) = \['token' => [string](../types/string.md), \]; + +*** +

[$deviceTokenMpns](../constructors/deviceTokenMpns.md) = \['token' => [string](../types/string.md), \]; + +*** +

[$deviceTokenSimplePush](../constructors/deviceTokenSimplePush.md) = \['token' => [string](../types/string.md), \]; + +*** +

[$deviceTokenUbuntuPhone](../constructors/deviceTokenUbuntuPhone.md) = \['token' => [string](../types/string.md), \]; ***

[$document](../constructors/document.md) = \['file_name' => [string](../types/string.md), 'mime_type' => [string](../types/string.md), 'thumb' => [photoSize](../constructors/photoSize.md), 'document' => [file](../constructors/file.md), \]; *** -

[$draftMessage](../constructors/draftMessage.md) = \['reply_to_message_id' => [long](../types/long.md), 'input_message_text' => [InputMessageContent](../types/InputMessageContent.md), \]; +

[$draftMessage](../constructors/draftMessage.md) = \['reply_to_message_id' => [int53](../constructors/int53.md), 'input_message_text' => [InputMessageContent](../types/InputMessageContent.md), \]; ***

[$error](../constructors/error.md) = \['code' => [int](../types/int.md), 'message' => [string](../types/string.md), \]; *** -

[$file](../constructors/file.md) = \['id' => [int](../types/int.md), 'persistent_id' => [string](../types/string.md), 'size' => [int](../types/int.md), 'path' => [string](../types/string.md), \]; +

[$file](../constructors/file.md) = \['id' => [int](../types/int.md), 'persistent_id' => [string](../types/string.md), 'size' => [int](../types/int.md), 'is_being_downloaded' => [Bool](../types/Bool.md), 'local_size' => [int](../types/int.md), 'is_being_uploaded' => [Bool](../types/Bool.md), 'remote_size' => [int](../types/int.md), 'path' => [string](../types/string.md), \]; *** -

[$game](../constructors/game.md) = \['id' => [long](../types/long.md), 'short_name' => [string](../types/string.md), 'title' => [string](../types/string.md), 'text' => [string](../types/string.md), 'text_entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'description' => [string](../types/string.md), 'photo' => [photo](../constructors/photo.md), 'animation' => [animation](../constructors/animation.md), \]; +

[$fileTypeAnimation](../constructors/fileTypeAnimation.md) = \[\]; + +*** +

[$fileTypeAudio](../constructors/fileTypeAudio.md) = \[\]; + +*** +

[$fileTypeDocument](../constructors/fileTypeDocument.md) = \[\]; + +*** +

[$fileTypeNone](../constructors/fileTypeNone.md) = \[\]; + +*** +

[$fileTypePhoto](../constructors/fileTypePhoto.md) = \[\]; + +*** +

[$fileTypeProfilePhoto](../constructors/fileTypeProfilePhoto.md) = \[\]; + +*** +

[$fileTypeSecret](../constructors/fileTypeSecret.md) = \[\]; + +*** +

[$fileTypeSecretThumb](../constructors/fileTypeSecretThumb.md) = \[\]; + +*** +

[$fileTypeSticker](../constructors/fileTypeSticker.md) = \[\]; + +*** +

[$fileTypeThumb](../constructors/fileTypeThumb.md) = \[\]; + +*** +

[$fileTypeUnknown](../constructors/fileTypeUnknown.md) = \[\]; + +*** +

[$fileTypeVideo](../constructors/fileTypeVideo.md) = \[\]; + +*** +

[$fileTypeVideoNote](../constructors/fileTypeVideoNote.md) = \[\]; + +*** +

[$fileTypeVoice](../constructors/fileTypeVoice.md) = \[\]; + +*** +

[$fileTypeWallpaper](../constructors/fileTypeWallpaper.md) = \[\]; + +*** +

[$foundMessages](../constructors/foundMessages.md) = \['messages' => \[[message](../constructors/message.md)\], 'next_from_search_id' => [long](../types/long.md), \]; + +*** +

[$game](../constructors/game.md) = \['id' => [long](../types/long.md), 'short_name' => [string](../types/string.md), 'title' => [string](../types/string.md), 'text' => [string](../types/string.md), 'text_entities' => \[[textEntity](../constructors/textEntity.md)\], 'description' => [string](../types/string.md), 'photo' => [photo](../constructors/photo.md), 'animation' => [animation](../constructors/animation.md), \]; ***

[$gameHighScore](../constructors/gameHighScore.md) = \['position' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'score' => [int](../types/int.md), \]; @@ -158,20 +395,23 @@ description: List of constructors

[$gameHighScores](../constructors/gameHighScores.md) = \['scores' => \[[gameHighScore](../constructors/gameHighScore.md)\], \]; *** -

[$gcmDeviceToken](../constructors/gcmDeviceToken.md) = \['token' => [string](../types/string.md), \]; +

[$group](../constructors/group.md) = \['id' => [int](../types/int.md), 'member_count' => [int](../types/int.md), 'status' => [ChatMemberStatus](../types/ChatMemberStatus.md), 'everyone_is_administrator' => [Bool](../types/Bool.md), 'is_active' => [Bool](../types/Bool.md), 'migrated_to_channel_id' => [int](../types/int.md), \]; *** -

[$group](../constructors/group.md) = \['id' => [int](../types/int.md), 'member_count' => [int](../types/int.md), 'status' => [ChatMemberStatus](../types/ChatMemberStatus.md), 'anyone_can_edit' => [Bool](../types/Bool.md), 'is_active' => [Bool](../types/Bool.md), 'migrated_to_channel_id' => [int](../types/int.md), \]; +

[$groupFull](../constructors/groupFull.md) = \['creator_user_id' => [int](../types/int.md), 'members' => \[[chatMember](../constructors/chatMember.md)\], 'invite_link' => [string](../types/string.md), \]; *** -

[$groupChatInfo](../constructors/groupChatInfo.md) = \['group' => [group](../constructors/group.md), \]; +

[$hashtags](../constructors/hashtags.md) = \['hashtags' => \[[string](../types/string.md)\], \]; *** -

[$groupFull](../constructors/groupFull.md) = \['group' => [group](../constructors/group.md), 'creator_user_id' => [int](../types/int.md), 'members' => \[[chatMember](../constructors/chatMember.md)\], 'invite_link' => [string](../types/string.md), \]; +

[$importedContacts](../constructors/importedContacts.md) = \['user_ids' => \[[int](../types/int.md)\], 'importer_count' => \[[int](../types/int.md)\], \]; ***

[$inlineKeyboardButton](../constructors/inlineKeyboardButton.md) = \['text' => [string](../types/string.md), 'type' => [InlineKeyboardButtonType](../types/InlineKeyboardButtonType.md), \]; +*** +

[$inlineKeyboardButtonTypeBuy](../constructors/inlineKeyboardButtonTypeBuy.md) = \[\]; + ***

[$inlineKeyboardButtonTypeCallback](../constructors/inlineKeyboardButtonTypeCallback.md) = \['data' => [bytes](../types/bytes.md), \]; @@ -188,13 +428,13 @@ description: List of constructors

[$inlineQueryResultAnimation](../constructors/inlineQueryResultAnimation.md) = \['id' => [string](../types/string.md), 'animation' => [animation](../constructors/animation.md), 'title' => [string](../types/string.md), \]; *** -

[$inlineQueryResultArticle](../constructors/inlineQueryResultArticle.md) = \['id' => [string](../types/string.md), 'url' => [string](../types/string.md), 'hide_url' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'thumb_url' => [string](../types/string.md), 'thumb_width' => [int](../types/int.md), 'thumb_height' => [int](../types/int.md), \]; +

[$inlineQueryResultArticle](../constructors/inlineQueryResultArticle.md) = \['id' => [string](../types/string.md), 'url' => [string](../types/string.md), 'hide_url' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'thumb' => [photoSize](../constructors/photoSize.md), \]; ***

[$inlineQueryResultAudio](../constructors/inlineQueryResultAudio.md) = \['id' => [string](../types/string.md), 'audio' => [audio](../constructors/audio.md), \]; *** -

[$inlineQueryResultContact](../constructors/inlineQueryResultContact.md) = \['id' => [string](../types/string.md), 'contact' => [contact](../constructors/contact.md), 'thumb_url' => [string](../types/string.md), 'thumb_width' => [int](../types/int.md), 'thumb_height' => [int](../types/int.md), \]; +

[$inlineQueryResultContact](../constructors/inlineQueryResultContact.md) = \['id' => [string](../types/string.md), 'contact' => [contact](../constructors/contact.md), 'thumb' => [photoSize](../constructors/photoSize.md), \]; ***

[$inlineQueryResultDocument](../constructors/inlineQueryResultDocument.md) = \['id' => [string](../types/string.md), 'document' => [document](../constructors/document.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), \]; @@ -203,7 +443,7 @@ description: List of constructors

[$inlineQueryResultGame](../constructors/inlineQueryResultGame.md) = \['id' => [string](../types/string.md), 'game' => [game](../constructors/game.md), \]; *** -

[$inlineQueryResultLocation](../constructors/inlineQueryResultLocation.md) = \['id' => [string](../types/string.md), 'location' => [location](../constructors/location.md), 'title' => [string](../types/string.md), 'thumb_url' => [string](../types/string.md), 'thumb_width' => [int](../types/int.md), 'thumb_height' => [int](../types/int.md), \]; +

[$inlineQueryResultLocation](../constructors/inlineQueryResultLocation.md) = \['id' => [string](../types/string.md), 'location' => [location](../constructors/location.md), 'title' => [string](../types/string.md), 'thumb' => [photoSize](../constructors/photoSize.md), \]; ***

[$inlineQueryResultPhoto](../constructors/inlineQueryResultPhoto.md) = \['id' => [string](../types/string.md), 'photo' => [photo](../constructors/photo.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), \]; @@ -212,7 +452,7 @@ description: List of constructors

[$inlineQueryResultSticker](../constructors/inlineQueryResultSticker.md) = \['id' => [string](../types/string.md), 'sticker' => [sticker](../constructors/sticker.md), \]; *** -

[$inlineQueryResultVenue](../constructors/inlineQueryResultVenue.md) = \['id' => [string](../types/string.md), 'venue' => [venue](../constructors/venue.md), 'thumb_url' => [string](../types/string.md), 'thumb_width' => [int](../types/int.md), 'thumb_height' => [int](../types/int.md), \]; +

[$inlineQueryResultVenue](../constructors/inlineQueryResultVenue.md) = \['id' => [string](../types/string.md), 'venue' => [venue](../constructors/venue.md), 'thumb' => [photoSize](../constructors/photoSize.md), \]; ***

[$inlineQueryResultVideo](../constructors/inlineQueryResultVideo.md) = \['id' => [string](../types/string.md), 'video' => [video](../constructors/video.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), \]; @@ -224,7 +464,13 @@ description: List of constructors

[$inlineQueryResults](../constructors/inlineQueryResults.md) = \['inline_query_id' => [long](../types/long.md), 'next_offset' => [string](../types/string.md), 'results' => \[[InlineQueryResult](../types/InlineQueryResult.md)\], 'switch_pm_text' => [string](../types/string.md), 'switch_pm_parameter' => [string](../types/string.md), \]; *** -

[$inputFileGenerated](../constructors/inputFileGenerated.md) = \['original_path' => [string](../types/string.md), 'conversion' => [string](../types/string.md), 'expected_size' => [int](../types/int.md), 'should_cache' => [Bool](../types/Bool.md), \]; +

[$inputCredentialsNew](../constructors/inputCredentialsNew.md) = \['data' => [string](../types/string.md), 'allow_save' => [Bool](../types/Bool.md), \]; + +*** +

[$inputCredentialsSaved](../constructors/inputCredentialsSaved.md) = \['saved_credentials_id' => [string](../types/string.md), \]; + +*** +

[$inputFileGenerated](../constructors/inputFileGenerated.md) = \['original_path' => [string](../types/string.md), 'conversion' => [string](../types/string.md), 'expected_size' => [int](../types/int.md), \]; ***

[$inputFileId](../constructors/inputFileId.md) = \['id' => [int](../types/int.md), \]; @@ -236,10 +482,10 @@ description: List of constructors

[$inputFilePersistentId](../constructors/inputFilePersistentId.md) = \['persistent_id' => [string](../types/string.md), \]; *** -

[$inputInlineQueryResultAnimatedGif](../constructors/inputInlineQueryResultAnimatedGif.md) = \['id' => [string](../types/string.md), 'title' => [string](../types/string.md), 'thumb_url' => [string](../types/string.md), 'gif_url' => [string](../types/string.md), 'gif_width' => [int](../types/int.md), 'gif_height' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'input_message_content' => [InputMessageContent](../types/InputMessageContent.md), \]; +

[$inputInlineQueryResultAnimatedGif](../constructors/inputInlineQueryResultAnimatedGif.md) = \['id' => [string](../types/string.md), 'title' => [string](../types/string.md), 'thumb_url' => [string](../types/string.md), 'gif_url' => [string](../types/string.md), 'gif_duration' => [int](../types/int.md), 'gif_width' => [int](../types/int.md), 'gif_height' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'input_message_content' => [InputMessageContent](../types/InputMessageContent.md), \]; *** -

[$inputInlineQueryResultAnimatedMpeg4](../constructors/inputInlineQueryResultAnimatedMpeg4.md) = \['id' => [string](../types/string.md), 'title' => [string](../types/string.md), 'thumb_url' => [string](../types/string.md), 'mpeg4_url' => [string](../types/string.md), 'mpeg4_width' => [int](../types/int.md), 'mpeg4_height' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'input_message_content' => [InputMessageContent](../types/InputMessageContent.md), \]; +

[$inputInlineQueryResultAnimatedMpeg4](../constructors/inputInlineQueryResultAnimatedMpeg4.md) = \['id' => [string](../types/string.md), 'title' => [string](../types/string.md), 'thumb_url' => [string](../types/string.md), 'mpeg4_url' => [string](../types/string.md), 'mpeg4_duration' => [int](../types/int.md), 'mpeg4_width' => [int](../types/int.md), 'mpeg4_height' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'input_message_content' => [InputMessageContent](../types/InputMessageContent.md), \]; ***

[$inputInlineQueryResultArticle](../constructors/inputInlineQueryResultArticle.md) = \['id' => [string](../types/string.md), 'url' => [string](../types/string.md), 'hide_url' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'thumb_url' => [string](../types/string.md), 'thumb_width' => [int](../types/int.md), 'thumb_height' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'input_message_content' => [InputMessageContent](../types/InputMessageContent.md), \]; @@ -275,7 +521,7 @@ description: List of constructors

[$inputInlineQueryResultVoice](../constructors/inputInlineQueryResultVoice.md) = \['id' => [string](../types/string.md), 'title' => [string](../types/string.md), 'voice_url' => [string](../types/string.md), 'voice_duration' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'input_message_content' => [InputMessageContent](../types/InputMessageContent.md), \]; *** -

[$inputMessageAnimation](../constructors/inputMessageAnimation.md) = \['animation' => [InputFile](../types/InputFile.md), 'thumb' => [InputThumb](../types/InputThumb.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), 'caption' => [string](../types/string.md), \]; +

[$inputMessageAnimation](../constructors/inputMessageAnimation.md) = \['animation' => [InputFile](../types/InputFile.md), 'thumb' => [InputThumb](../types/InputThumb.md), 'duration' => [int](../types/int.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), 'caption' => [string](../types/string.md), \]; ***

[$inputMessageAudio](../constructors/inputMessageAudio.md) = \['audio' => [InputFile](../types/InputFile.md), 'album_cover_thumb' => [InputThumb](../types/InputThumb.md), 'duration' => [int](../types/int.md), 'title' => [string](../types/string.md), 'performer' => [string](../types/string.md), 'caption' => [string](../types/string.md), \]; @@ -287,38 +533,50 @@ description: List of constructors

[$inputMessageDocument](../constructors/inputMessageDocument.md) = \['document' => [InputFile](../types/InputFile.md), 'thumb' => [InputThumb](../types/InputThumb.md), 'caption' => [string](../types/string.md), \]; *** -

[$inputMessageForwarded](../constructors/inputMessageForwarded.md) = \['from_chat_id' => [long](../types/long.md), 'message_id' => [long](../types/long.md), 'in_game_share' => [Bool](../types/Bool.md), \]; +

[$inputMessageForwarded](../constructors/inputMessageForwarded.md) = \['from_chat_id' => [int53](../constructors/int53.md), 'message_id' => [int53](../constructors/int53.md), 'in_game_share' => [Bool](../types/Bool.md), \]; ***

[$inputMessageGame](../constructors/inputMessageGame.md) = \['bot_user_id' => [int](../types/int.md), 'game_short_name' => [string](../types/string.md), \]; +*** +

[$inputMessageInvoice](../constructors/inputMessageInvoice.md) = \['invoice' => [invoice](../constructors/invoice.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo_url' => [string](../types/string.md), 'photo_size' => [int](../types/int.md), 'photo_width' => [int](../types/int.md), 'photo_height' => [int](../types/int.md), 'payload' => [bytes](../types/bytes.md), 'provider_token' => [string](../types/string.md), 'start_parameter' => [string](../types/string.md), \]; + ***

[$inputMessageLocation](../constructors/inputMessageLocation.md) = \['location' => [location](../constructors/location.md), \]; *** -

[$inputMessagePhoto](../constructors/inputMessagePhoto.md) = \['photo' => [InputFile](../types/InputFile.md), 'thumb' => [InputThumb](../types/InputThumb.md), 'added_sticker_file_ids' => \[[int](../types/int.md)\], 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), 'caption' => [string](../types/string.md), \]; +

[$inputMessagePhoto](../constructors/inputMessagePhoto.md) = \['photo' => [InputFile](../types/InputFile.md), 'thumb' => [InputThumb](../types/InputThumb.md), 'added_sticker_file_ids' => \[[int](../types/int.md)\], 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), 'caption' => [string](../types/string.md), 'ttl' => [int](../types/int.md), \]; ***

[$inputMessageSticker](../constructors/inputMessageSticker.md) = \['sticker' => [InputFile](../types/InputFile.md), 'thumb' => [InputThumb](../types/InputThumb.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), \]; *** -

[$inputMessageText](../constructors/inputMessageText.md) = \['text' => [string](../types/string.md), 'disable_web_page_preview' => [Bool](../types/Bool.md), 'clear_draft' => [Bool](../types/Bool.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'parse_mode' => [TextParseMode](../types/TextParseMode.md), \]; +

[$inputMessageText](../constructors/inputMessageText.md) = \['text' => [string](../types/string.md), 'disable_web_page_preview' => [Bool](../types/Bool.md), 'clear_draft' => [Bool](../types/Bool.md), 'entities' => \[[textEntity](../constructors/textEntity.md)\], 'parse_mode' => [TextParseMode](../types/TextParseMode.md), \]; ***

[$inputMessageVenue](../constructors/inputMessageVenue.md) = \['venue' => [venue](../constructors/venue.md), \]; *** -

[$inputMessageVideo](../constructors/inputMessageVideo.md) = \['video' => [InputFile](../types/InputFile.md), 'thumb' => [InputThumb](../types/InputThumb.md), 'added_sticker_file_ids' => \[[int](../types/int.md)\], 'duration' => [int](../types/int.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), 'caption' => [string](../types/string.md), \]; +

[$inputMessageVideo](../constructors/inputMessageVideo.md) = \['video' => [InputFile](../types/InputFile.md), 'thumb' => [InputThumb](../types/InputThumb.md), 'added_sticker_file_ids' => \[[int](../types/int.md)\], 'duration' => [int](../types/int.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), 'caption' => [string](../types/string.md), 'ttl' => [int](../types/int.md), \]; + +*** +

[$inputMessageVideoNote](../constructors/inputMessageVideoNote.md) = \['video_note' => [InputFile](../types/InputFile.md), 'thumb' => [InputThumb](../types/InputThumb.md), 'duration' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; ***

[$inputMessageVoice](../constructors/inputMessageVoice.md) = \['voice' => [InputFile](../types/InputFile.md), 'duration' => [int](../types/int.md), 'waveform' => [bytes](../types/bytes.md), 'caption' => [string](../types/string.md), \]; +*** +

[$inputSticker](../constructors/inputSticker.md) = \['png_sticker' => [InputFile](../types/InputFile.md), 'emojis' => [string](../types/string.md), 'mask_position' => [maskPosition](../constructors/maskPosition.md), \]; + ***

[$inputThumbGenerated](../constructors/inputThumbGenerated.md) = \['original_path' => [string](../types/string.md), 'conversion' => [string](../types/string.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), \]; ***

[$inputThumbLocal](../constructors/inputThumbLocal.md) = \['path' => [string](../types/string.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), \]; +*** +

[$invoice](../constructors/invoice.md) = \['currency' => [string](../types/string.md), 'prices' => \[[labeledPrice](../constructors/labeledPrice.md)\], 'is_test' => [Bool](../types/Bool.md), 'need_name' => [Bool](../types/Bool.md), 'need_phone_number' => [Bool](../types/Bool.md), 'need_email' => [Bool](../types/Bool.md), 'need_shipping_address' => [Bool](../types/Bool.md), 'is_flexible' => [Bool](../types/Bool.md), \]; + ***

[$keyboardButton](../constructors/keyboardButton.md) = \['text' => [string](../types/string.md), 'type' => [KeyboardButtonType](../types/KeyboardButtonType.md), \]; @@ -331,6 +589,9 @@ description: List of constructors ***

[$keyboardButtonTypeText](../constructors/keyboardButtonTypeText.md) = \[\]; +*** +

[$labeledPrice](../constructors/labeledPrice.md) = \['label' => [string](../types/string.md), 'amount' => [int53](../constructors/int53.md), \]; + ***

[$linkStateContact](../constructors/linkStateContact.md) = \[\]; @@ -344,22 +605,25 @@ description: List of constructors

[$location](../constructors/location.md) = \['latitude' => [double](../types/double.md), 'longitude' => [double](../types/double.md), \]; *** -

[$maskPosition](../constructors/maskPosition.md) = \['point' => [int](../types/int.md), 'x_shift' => [double](../types/double.md), 'y_shift' => [double](../types/double.md), 'zoom' => [double](../types/double.md), \]; +

[$maskPosition](../constructors/maskPosition.md) = \['point' => [int](../types/int.md), 'x_shift' => [double](../types/double.md), 'y_shift' => [double](../types/double.md), 'scale' => [double](../types/double.md), \]; *** -

[$message](../constructors/message.md) = \['id' => [long](../types/long.md), 'sender_user_id' => [int](../types/int.md), 'chat_id' => [long](../types/long.md), 'send_state' => [MessageSendState](../types/MessageSendState.md), 'can_be_edited' => [Bool](../types/Bool.md), 'can_be_deleted' => [Bool](../types/Bool.md), 'is_post' => [Bool](../types/Bool.md), 'date' => [int](../types/int.md), 'edit_date' => [int](../types/int.md), 'forward_info' => [MessageForwardInfo](../types/MessageForwardInfo.md), 'reply_to_message_id' => [long](../types/long.md), 'ttl' => [int](../types/int.md), 'ttl_expires_in' => [double](../types/double.md), 'via_bot_user_id' => [int](../types/int.md), 'views' => [int](../types/int.md), 'content' => [MessageContent](../types/MessageContent.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; +

[$message](../constructors/message.md) = \['id' => [int53](../constructors/int53.md), 'sender_user_id' => [int](../types/int.md), 'chat_id' => [int53](../constructors/int53.md), 'send_state' => [MessageSendState](../types/MessageSendState.md), 'can_be_edited' => [Bool](../types/Bool.md), 'can_be_forwarded' => [Bool](../types/Bool.md), 'can_be_deleted_only_for_self' => [Bool](../types/Bool.md), 'can_be_deleted_for_everyone' => [Bool](../types/Bool.md), 'is_post' => [Bool](../types/Bool.md), 'date' => [int](../types/int.md), 'edit_date' => [int](../types/int.md), 'forward_info' => [MessageForwardInfo](../types/MessageForwardInfo.md), 'reply_to_message_id' => [int53](../constructors/int53.md), 'ttl' => [int](../types/int.md), 'ttl_expires_in' => [double](../types/double.md), 'via_bot_user_id' => [int](../types/int.md), 'author_signature' => [string](../types/string.md), 'views' => [int](../types/int.md), 'content' => [MessageContent](../types/MessageContent.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; ***

[$messageAnimation](../constructors/messageAnimation.md) = \['animation' => [animation](../constructors/animation.md), 'caption' => [string](../types/string.md), \]; *** -

[$messageAudio](../constructors/messageAudio.md) = \['audio' => [audio](../constructors/audio.md), 'caption' => [string](../types/string.md), 'is_listened' => [Bool](../types/Bool.md), \]; +

[$messageAudio](../constructors/messageAudio.md) = \['audio' => [audio](../constructors/audio.md), 'caption' => [string](../types/string.md), \]; + +*** +

[$messageCall](../constructors/messageCall.md) = \['discard_reason' => [CallDiscardReason](../types/CallDiscardReason.md), 'duration' => [int](../types/int.md), \]; ***

[$messageChannelChatCreate](../constructors/messageChannelChatCreate.md) = \['title' => [string](../types/string.md), \]; *** -

[$messageChatAddMembers](../constructors/messageChatAddMembers.md) = \['members' => \[[user](../constructors/user.md)\], \]; +

[$messageChatAddMembers](../constructors/messageChatAddMembers.md) = \['member_user_ids' => \[[int](../types/int.md)\], \]; ***

[$messageChatChangePhoto](../constructors/messageChatChangePhoto.md) = \['photo' => [photo](../constructors/photo.md), \]; @@ -368,7 +632,7 @@ description: List of constructors

[$messageChatChangeTitle](../constructors/messageChatChangeTitle.md) = \['title' => [string](../types/string.md), \]; *** -

[$messageChatDeleteMember](../constructors/messageChatDeleteMember.md) = \['user' => [user](../constructors/user.md), \]; +

[$messageChatDeleteMember](../constructors/messageChatDeleteMember.md) = \['user_id' => [int](../types/int.md), \]; ***

[$messageChatDeletePhoto](../constructors/messageChatDeletePhoto.md) = \[\]; @@ -388,59 +652,35 @@ description: List of constructors ***

[$messageContact](../constructors/messageContact.md) = \['contact' => [contact](../constructors/contact.md), \]; +*** +

[$messageContactRegistered](../constructors/messageContactRegistered.md) = \[\]; + ***

[$messageDocument](../constructors/messageDocument.md) = \['document' => [document](../constructors/document.md), 'caption' => [string](../types/string.md), \]; *** -

[$messageEntityBold](../constructors/messageEntityBold.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; +

[$messageExpiredPhoto](../constructors/messageExpiredPhoto.md) = \[\]; *** -

[$messageEntityBotCommand](../constructors/messageEntityBotCommand.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; - -*** -

[$messageEntityCode](../constructors/messageEntityCode.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; - -*** -

[$messageEntityEmail](../constructors/messageEntityEmail.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; - -*** -

[$messageEntityHashtag](../constructors/messageEntityHashtag.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; - -*** -

[$messageEntityItalic](../constructors/messageEntityItalic.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; - -*** -

[$messageEntityMention](../constructors/messageEntityMention.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; - -*** -

[$messageEntityMentionName](../constructors/messageEntityMentionName.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), 'user_id' => [int](../types/int.md), \]; - -*** -

[$messageEntityPre](../constructors/messageEntityPre.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; - -*** -

[$messageEntityPreCode](../constructors/messageEntityPreCode.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), 'language' => [string](../types/string.md), \]; - -*** -

[$messageEntityTextUrl](../constructors/messageEntityTextUrl.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), 'url' => [string](../types/string.md), \]; - -*** -

[$messageEntityUrl](../constructors/messageEntityUrl.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), \]; +

[$messageExpiredVideo](../constructors/messageExpiredVideo.md) = \[\]; ***

[$messageForwardedFromUser](../constructors/messageForwardedFromUser.md) = \['sender_user_id' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; *** -

[$messageForwardedPost](../constructors/messageForwardedPost.md) = \['chat_id' => [long](../types/long.md), 'sender_user_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'message_id' => [long](../types/long.md), \]; +

[$messageForwardedPost](../constructors/messageForwardedPost.md) = \['chat_id' => [int53](../constructors/int53.md), 'author_signature' => [string](../types/string.md), 'date' => [int](../types/int.md), 'message_id' => [int53](../constructors/int53.md), \]; ***

[$messageGame](../constructors/messageGame.md) = \['game' => [game](../constructors/game.md), \]; *** -

[$messageGameScore](../constructors/messageGameScore.md) = \['game_message_id' => [long](../types/long.md), 'game_id' => [long](../types/long.md), 'score' => [int](../types/int.md), \]; +

[$messageGameScore](../constructors/messageGameScore.md) = \['game_message_id' => [int53](../constructors/int53.md), 'game_id' => [long](../types/long.md), 'score' => [int](../types/int.md), \]; *** -

[$messageGroupChatCreate](../constructors/messageGroupChatCreate.md) = \['title' => [string](../types/string.md), 'members' => \[[user](../constructors/user.md)\], \]; +

[$messageGroupChatCreate](../constructors/messageGroupChatCreate.md) = \['title' => [string](../types/string.md), 'member_user_ids' => \[[int](../types/int.md)\], \]; + +*** +

[$messageInvoice](../constructors/messageInvoice.md) = \['title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [photo](../constructors/photo.md), 'currency' => [string](../types/string.md), 'total_amount' => [int53](../constructors/int53.md), 'start_parameter' => [string](../types/string.md), 'is_test' => [Bool](../types/Bool.md), 'need_shipping_address' => [Bool](../types/Bool.md), 'receipt_message_id' => [int53](../constructors/int53.md), \]; ***

[$messageIsBeingSent](../constructors/messageIsBeingSent.md) = \[\]; @@ -457,11 +697,17 @@ description: List of constructors ***

[$messageLocation](../constructors/messageLocation.md) = \['location' => [location](../constructors/location.md), \]; +*** +

[$messagePaymentSuccessful](../constructors/messagePaymentSuccessful.md) = \['currency' => [string](../types/string.md), 'total_amount' => [int53](../constructors/int53.md), \]; + +*** +

[$messagePaymentSuccessfulBot](../constructors/messagePaymentSuccessfulBot.md) = \['currency' => [string](../types/string.md), 'total_amount' => [int53](../constructors/int53.md), 'invoice_payload' => [bytes](../types/bytes.md), 'shipping_option_id' => [string](../types/string.md), 'order_info' => [orderInfo](../constructors/orderInfo.md), 'telegram_payment_charge_id' => [string](../types/string.md), 'provider_payment_charge_id' => [string](../types/string.md), \]; + ***

[$messagePhoto](../constructors/messagePhoto.md) = \['photo' => [photo](../constructors/photo.md), 'caption' => [string](../types/string.md), \]; *** -

[$messagePinMessage](../constructors/messagePinMessage.md) = \['message_id' => [long](../types/long.md), \]; +

[$messagePinMessage](../constructors/messagePinMessage.md) = \['message_id' => [int53](../constructors/int53.md), \]; ***

[$messageScreenshotTaken](../constructors/messageScreenshotTaken.md) = \[\]; @@ -470,7 +716,7 @@ description: List of constructors

[$messageSticker](../constructors/messageSticker.md) = \['sticker' => [sticker](../constructors/sticker.md), \]; *** -

[$messageText](../constructors/messageText.md) = \['text' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'web_page' => [webPage](../constructors/webPage.md), \]; +

[$messageText](../constructors/messageText.md) = \['text' => [string](../types/string.md), 'entities' => \[[textEntity](../constructors/textEntity.md)\], 'web_page' => [webPage](../constructors/webPage.md), \]; ***

[$messageUnsupported](../constructors/messageUnsupported.md) = \[\]; @@ -481,6 +727,9 @@ description: List of constructors ***

[$messageVideo](../constructors/messageVideo.md) = \['video' => [video](../constructors/video.md), 'caption' => [string](../types/string.md), \]; +*** +

[$messageVideoNote](../constructors/messageVideoNote.md) = \['video_note' => [videoNote](../constructors/videoNote.md), 'is_viewed' => [Bool](../types/Bool.md), \]; + ***

[$messageVoice](../constructors/messageVoice.md) = \['voice' => [voice](../constructors/voice.md), 'caption' => [string](../types/string.md), 'is_listened' => [Bool](../types/Bool.md), \]; @@ -488,37 +737,130 @@ description: List of constructors

[$messages](../constructors/messages.md) = \['total_count' => [int](../types/int.md), 'messages' => \[[message](../constructors/message.md)\], \]; *** -

[$mpnsDeviceToken](../constructors/mpnsDeviceToken.md) = \['token' => [string](../types/string.md), \]; +

[$networkStatistics](../constructors/networkStatistics.md) = \['since_date' => [int](../types/int.md), 'entries' => \[[NetworkStatisticsEntry](../types/NetworkStatisticsEntry.md)\], \]; + +*** +

[$networkStatisticsEntryCall](../constructors/networkStatisticsEntryCall.md) = \['network_type' => [NetworkType](../types/NetworkType.md), 'sent_bytes' => [int53](../constructors/int53.md), 'received_bytes' => [int53](../constructors/int53.md), 'duration' => [double](../types/double.md), \]; + +*** +

[$networkStatisticsEntryFile](../constructors/networkStatisticsEntryFile.md) = \['file_type' => [FileType](../types/FileType.md), 'network_type' => [NetworkType](../types/NetworkType.md), 'sent_bytes' => [int53](../constructors/int53.md), 'received_bytes' => [int53](../constructors/int53.md), \]; + +*** +

[$networkTypeMobile](../constructors/networkTypeMobile.md) = \[\]; + +*** +

[$networkTypeMobileRoaming](../constructors/networkTypeMobileRoaming.md) = \[\]; + +*** +

[$networkTypeNone](../constructors/networkTypeNone.md) = \[\]; + +*** +

[$networkTypeOther](../constructors/networkTypeOther.md) = \[\]; + +*** +

[$networkTypeWiFi](../constructors/networkTypeWiFi.md) = \[\]; ***

[$notificationSettings](../constructors/notificationSettings.md) = \['mute_for' => [int](../types/int.md), 'sound' => [string](../types/string.md), 'show_preview' => [Bool](../types/Bool.md), \]; *** -

[$notificationSettingsForAllChats](../constructors/notificationSettingsForAllChats.md) = \[\]; +

[$notificationSettingsScopeAllChats](../constructors/notificationSettingsScopeAllChats.md) = \[\]; *** -

[$notificationSettingsForChat](../constructors/notificationSettingsForChat.md) = \['chat_id' => [long](../types/long.md), \]; +

[$notificationSettingsScopeChat](../constructors/notificationSettingsScopeChat.md) = \['chat_id' => [int53](../constructors/int53.md), \]; *** -

[$notificationSettingsForGroupChats](../constructors/notificationSettingsForGroupChats.md) = \[\]; +

[$notificationSettingsScopeGroupChats](../constructors/notificationSettingsScopeGroupChats.md) = \[\]; *** -

[$notificationSettingsForPrivateChats](../constructors/notificationSettingsForPrivateChats.md) = \[\]; +

[$notificationSettingsScopePrivateChats](../constructors/notificationSettingsScopePrivateChats.md) = \[\]; ***

[$ok](../constructors/ok.md) = \[\]; *** -

[$optionBoolean](../constructors/optionBoolean.md) = \['value' => [Bool](../types/Bool.md), \]; +

[$optionValueBoolean](../constructors/optionValueBoolean.md) = \['value' => [Bool](../types/Bool.md), \]; *** -

[$optionEmpty](../constructors/optionEmpty.md) = \[\]; +

[$optionValueEmpty](../constructors/optionValueEmpty.md) = \[\]; *** -

[$optionInteger](../constructors/optionInteger.md) = \['value' => [int](../types/int.md), \]; +

[$optionValueInteger](../constructors/optionValueInteger.md) = \['value' => [int](../types/int.md), \]; *** -

[$optionString](../constructors/optionString.md) = \['value' => [string](../types/string.md), \]; +

[$optionValueString](../constructors/optionValueString.md) = \['value' => [string](../types/string.md), \]; + +*** +

[$orderInfo](../constructors/orderInfo.md) = \['name' => [string](../types/string.md), 'phone_number' => [string](../types/string.md), 'email' => [string](../types/string.md), 'shipping_address' => [shippingAddress](../constructors/shippingAddress.md), \]; + +*** +

[$pageBlockAnchor](../constructors/pageBlockAnchor.md) = \['name' => [string](../types/string.md), \]; + +*** +

[$pageBlockAnimation](../constructors/pageBlockAnimation.md) = \['animation' => [animation](../constructors/animation.md), 'caption' => [RichText](../types/RichText.md), 'need_autoplay' => [Bool](../types/Bool.md), \]; + +*** +

[$pageBlockAudio](../constructors/pageBlockAudio.md) = \['audio' => [audio](../constructors/audio.md), 'caption' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockAuthorDate](../constructors/pageBlockAuthorDate.md) = \['author' => [RichText](../types/RichText.md), 'publish_date' => [int](../types/int.md), \]; + +*** +

[$pageBlockBlockQuote](../constructors/pageBlockBlockQuote.md) = \['text' => [RichText](../types/RichText.md), 'caption' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockChatLink](../constructors/pageBlockChatLink.md) = \['title' => [string](../types/string.md), 'photo' => [chatPhoto](../constructors/chatPhoto.md), 'username' => [string](../types/string.md), \]; + +*** +

[$pageBlockCollage](../constructors/pageBlockCollage.md) = \['page_blocks' => \[[PageBlock](../types/PageBlock.md)\], 'caption' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockCover](../constructors/pageBlockCover.md) = \['cover' => [PageBlock](../types/PageBlock.md), \]; + +*** +

[$pageBlockDivider](../constructors/pageBlockDivider.md) = \[\]; + +*** +

[$pageBlockEmbedded](../constructors/pageBlockEmbedded.md) = \['url' => [string](../types/string.md), 'html' => [string](../types/string.md), 'poster_photo' => [photo](../constructors/photo.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), 'caption' => [RichText](../types/RichText.md), 'is_full_width' => [Bool](../types/Bool.md), 'allow_scrolling' => [Bool](../types/Bool.md), \]; + +*** +

[$pageBlockEmbeddedPost](../constructors/pageBlockEmbeddedPost.md) = \['url' => [string](../types/string.md), 'author' => [string](../types/string.md), 'author_photo' => [photo](../constructors/photo.md), 'date' => [int](../types/int.md), 'page_blocks' => \[[PageBlock](../types/PageBlock.md)\], 'caption' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockFooter](../constructors/pageBlockFooter.md) = \['footer' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockHeader](../constructors/pageBlockHeader.md) = \['header' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockList](../constructors/pageBlockList.md) = \['items' => \[[RichText](../types/RichText.md)\], 'is_ordered' => [Bool](../types/Bool.md), \]; + +*** +

[$pageBlockParagraph](../constructors/pageBlockParagraph.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockPhoto](../constructors/pageBlockPhoto.md) = \['photo' => [photo](../constructors/photo.md), 'caption' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockPreformatted](../constructors/pageBlockPreformatted.md) = \['text' => [RichText](../types/RichText.md), 'language' => [string](../types/string.md), \]; + +*** +

[$pageBlockPullQuote](../constructors/pageBlockPullQuote.md) = \['text' => [RichText](../types/RichText.md), 'caption' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockSlideshow](../constructors/pageBlockSlideshow.md) = \['page_blocks' => \[[PageBlock](../types/PageBlock.md)\], 'caption' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockSubheader](../constructors/pageBlockSubheader.md) = \['subheader' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockSubtitle](../constructors/pageBlockSubtitle.md) = \['subtitle' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockTitle](../constructors/pageBlockTitle.md) = \['title' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockVideo](../constructors/pageBlockVideo.md) = \['video' => [video](../constructors/video.md), 'caption' => [RichText](../types/RichText.md), 'need_autoplay' => [Bool](../types/Bool.md), 'is_looped' => [Bool](../types/Bool.md), \]; ***

[$passwordRecoveryInfo](../constructors/passwordRecoveryInfo.md) = \['recovery_email_pattern' => [string](../types/string.md), \]; @@ -526,12 +868,27 @@ description: List of constructors ***

[$passwordState](../constructors/passwordState.md) = \['has_password' => [Bool](../types/Bool.md), 'password_hint' => [string](../types/string.md), 'has_recovery_email' => [Bool](../types/Bool.md), 'unconfirmed_recovery_email_pattern' => [string](../types/string.md), \]; +*** +

[$paymentForm](../constructors/paymentForm.md) = \['invoice' => [invoice](../constructors/invoice.md), 'url' => [string](../types/string.md), 'payments_provider' => [paymentsProviderStripe](../constructors/paymentsProviderStripe.md), 'saved_order_info' => [orderInfo](../constructors/orderInfo.md), 'saved_credentials' => [savedCredentials](../constructors/savedCredentials.md), 'can_save_credentials' => [Bool](../types/Bool.md), 'need_password' => [Bool](../types/Bool.md), \]; + +*** +

[$paymentReceipt](../constructors/paymentReceipt.md) = \['date' => [int](../types/int.md), 'payments_provider_user_id' => [int](../types/int.md), 'invoice' => [invoice](../constructors/invoice.md), 'order_info' => [orderInfo](../constructors/orderInfo.md), 'shipping_option' => [shippingOption](../constructors/shippingOption.md), 'credentials_title' => [string](../types/string.md), \]; + +*** +

[$paymentResult](../constructors/paymentResult.md) = \['success' => [Bool](../types/Bool.md), 'verification_url' => [string](../types/string.md), \]; + +*** +

[$paymentsProviderStripe](../constructors/paymentsProviderStripe.md) = \['publishable_key' => [string](../types/string.md), 'need_country' => [Bool](../types/Bool.md), 'need_zip' => [Bool](../types/Bool.md), 'need_cardholder_name' => [Bool](../types/Bool.md), \]; + ***

[$photo](../constructors/photo.md) = \['id' => [long](../types/long.md), 'has_stickers' => [Bool](../types/Bool.md), 'sizes' => \[[photoSize](../constructors/photoSize.md)\], \]; ***

[$photoSize](../constructors/photoSize.md) = \['type' => [string](../types/string.md), 'photo' => [file](../constructors/file.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), \]; +*** +

[$privacyKeyCall](../constructors/privacyKeyCall.md) = \[\]; + ***

[$privacyKeyChatInvite](../constructors/privacyKeyChatInvite.md) = \[\]; @@ -560,10 +917,16 @@ description: List of constructors

[$privacyRules](../constructors/privacyRules.md) = \['rules' => \[[PrivacyRule](../types/PrivacyRule.md)\], \]; *** -

[$privateChatInfo](../constructors/privateChatInfo.md) = \['user' => [user](../constructors/user.md), \]; +

[$profilePhoto](../constructors/profilePhoto.md) = \['id' => [long](../types/long.md), 'small' => [file](../constructors/file.md), 'big' => [file](../constructors/file.md), \]; *** -

[$profilePhoto](../constructors/profilePhoto.md) = \['id' => [long](../types/long.md), 'small' => [file](../constructors/file.md), 'big' => [file](../constructors/file.md), \]; +

[$proxyEmpty](../constructors/proxyEmpty.md) = \[\]; + +*** +

[$proxySocks5](../constructors/proxySocks5.md) = \['server' => [string](../types/string.md), 'port' => [int](../types/int.md), 'username' => [string](../types/string.md), 'password' => [string](../types/string.md), \]; + +*** +

[$publicMessageLink](../constructors/publicMessageLink.md) = \['url' => [string](../types/string.md), \]; ***

[$recoveryEmail](../constructors/recoveryEmail.md) = \['recovery_email' => [string](../types/string.md), \]; @@ -580,12 +943,45 @@ description: List of constructors ***

[$replyMarkupShowKeyboard](../constructors/replyMarkupShowKeyboard.md) = \['rows' => \[[keyboardButton>](../constructors/keyboardButton>.md)\], 'resize_keyboard' => [Bool](../types/Bool.md), 'one_time' => [Bool](../types/Bool.md), 'personal' => [Bool](../types/Bool.md), \]; +*** +

[$richTextBold](../constructors/richTextBold.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +

[$richTextConcatenation](../constructors/richTextConcatenation.md) = \['texts' => \[[RichText](../types/RichText.md)\], \]; + +*** +

[$richTextEmail](../constructors/richTextEmail.md) = \['text' => [RichText](../types/RichText.md), 'email' => [string](../types/string.md), \]; + +*** +

[$richTextFixed](../constructors/richTextFixed.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +

[$richTextItalic](../constructors/richTextItalic.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +

[$richTextPlain](../constructors/richTextPlain.md) = \['text' => [string](../types/string.md), \]; + +*** +

[$richTextStrikethrough](../constructors/richTextStrikethrough.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +

[$richTextUnderline](../constructors/richTextUnderline.md) = \['text' => [RichText](../types/RichText.md), \]; + +*** +

[$richTextUrl](../constructors/richTextUrl.md) = \['text' => [RichText](../types/RichText.md), 'url' => [string](../types/string.md), \]; + +*** +

[$savedCredentials](../constructors/savedCredentials.md) = \['id' => [string](../types/string.md), 'title' => [string](../types/string.md), \]; + ***

[$searchMessagesFilterAnimation](../constructors/searchMessagesFilterAnimation.md) = \[\]; ***

[$searchMessagesFilterAudio](../constructors/searchMessagesFilterAudio.md) = \[\]; +*** +

[$searchMessagesFilterCall](../constructors/searchMessagesFilterCall.md) = \[\]; + ***

[$searchMessagesFilterChatPhoto](../constructors/searchMessagesFilterChatPhoto.md) = \[\]; @@ -595,6 +991,9 @@ description: List of constructors ***

[$searchMessagesFilterEmpty](../constructors/searchMessagesFilterEmpty.md) = \[\]; +*** +

[$searchMessagesFilterMissedCall](../constructors/searchMessagesFilterMissedCall.md) = \[\]; + ***

[$searchMessagesFilterPhoto](../constructors/searchMessagesFilterPhoto.md) = \[\]; @@ -607,56 +1006,29 @@ description: List of constructors ***

[$searchMessagesFilterVideo](../constructors/searchMessagesFilterVideo.md) = \[\]; +*** +

[$searchMessagesFilterVideoNote](../constructors/searchMessagesFilterVideoNote.md) = \[\]; + ***

[$searchMessagesFilterVoice](../constructors/searchMessagesFilterVoice.md) = \[\]; *** -

[$secretChat](../constructors/secretChat.md) = \['id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'state' => [int](../types/int.md), 'is_outbound' => [Bool](../types/Bool.md), 'ttl' => [int](../types/int.md), 'key_hash' => [bytes](../types/bytes.md), \]; +

[$searchMessagesFilterVoiceAndVideoNote](../constructors/searchMessagesFilterVoiceAndVideoNote.md) = \[\]; *** -

[$secretChatInfo](../constructors/secretChatInfo.md) = \['secret_chat' => [secretChat](../constructors/secretChat.md), \]; +

[$secretChat](../constructors/secretChat.md) = \['id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'state' => [int](../types/int.md), 'is_outbound' => [Bool](../types/Bool.md), 'ttl' => [int](../types/int.md), 'key_hash' => [bytes](../types/bytes.md), 'layer' => [int](../types/int.md), \]; *** -

[$sendMessageCancelAction](../constructors/sendMessageCancelAction.md) = \[\]; - -*** -

[$sendMessageChooseContactAction](../constructors/sendMessageChooseContactAction.md) = \[\]; - -*** -

[$sendMessageGeoLocationAction](../constructors/sendMessageGeoLocationAction.md) = \[\]; - -*** -

[$sendMessageRecordVideoAction](../constructors/sendMessageRecordVideoAction.md) = \[\]; - -*** -

[$sendMessageRecordVoiceAction](../constructors/sendMessageRecordVoiceAction.md) = \[\]; - -*** -

[$sendMessageStartPlayGameAction](../constructors/sendMessageStartPlayGameAction.md) = \[\]; - -*** -

[$sendMessageTypingAction](../constructors/sendMessageTypingAction.md) = \[\]; - -*** -

[$sendMessageUploadDocumentAction](../constructors/sendMessageUploadDocumentAction.md) = \['progress' => [int](../types/int.md), \]; - -*** -

[$sendMessageUploadPhotoAction](../constructors/sendMessageUploadPhotoAction.md) = \['progress' => [int](../types/int.md), \]; - -*** -

[$sendMessageUploadVideoAction](../constructors/sendMessageUploadVideoAction.md) = \['progress' => [int](../types/int.md), \]; - -*** -

[$sendMessageUploadVoiceAction](../constructors/sendMessageUploadVoiceAction.md) = \['progress' => [int](../types/int.md), \]; - -*** -

[$session](../constructors/session.md) = \['id' => [long](../types/long.md), 'is_current' => [Bool](../types/Bool.md), 'app_id' => [int](../types/int.md), 'app_name' => [string](../types/string.md), 'app_version' => [string](../types/string.md), 'is_official_app' => [Bool](../types/Bool.md), 'device_model' => [string](../types/string.md), 'platform' => [string](../types/string.md), 'system_version' => [string](../types/string.md), 'date_created' => [int](../types/int.md), 'date_active' => [int](../types/int.md), 'ip' => [string](../types/string.md), 'country' => [string](../types/string.md), 'region' => [string](../types/string.md), \]; +

[$session](../constructors/session.md) = \['id' => [long](../types/long.md), 'is_current' => [Bool](../types/Bool.md), 'app_id' => [int](../types/int.md), 'app_name' => [string](../types/string.md), 'app_version' => [string](../types/string.md), 'is_official_app' => [Bool](../types/Bool.md), 'device_model' => [string](../types/string.md), 'platform' => [string](../types/string.md), 'system_version' => [string](../types/string.md), 'log_in_date' => [int](../types/int.md), 'last_active_date' => [int](../types/int.md), 'ip' => [string](../types/string.md), 'country' => [string](../types/string.md), 'region' => [string](../types/string.md), \]; ***

[$sessions](../constructors/sessions.md) = \['sessions' => \[[session](../constructors/session.md)\], \]; *** -

[$simplePushDeviceToken](../constructors/simplePushDeviceToken.md) = \['token' => [string](../types/string.md), \]; +

[$shippingAddress](../constructors/shippingAddress.md) = \['country_code' => [string](../types/string.md), 'state' => [string](../types/string.md), 'city' => [string](../types/string.md), 'street_line1' => [string](../types/string.md), 'street_line2' => [string](../types/string.md), 'post_code' => [string](../types/string.md), \]; + +*** +

[$shippingOption](../constructors/shippingOption.md) = \['id' => [string](../types/string.md), 'title' => [string](../types/string.md), 'prices' => \[[labeledPrice](../constructors/labeledPrice.md)\], \]; ***

[$sticker](../constructors/sticker.md) = \['set_id' => [long](../types/long.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), 'emoji' => [string](../types/string.md), 'is_mask' => [Bool](../types/Bool.md), 'mask_position' => [maskPosition](../constructors/maskPosition.md), 'thumb' => [photoSize](../constructors/photoSize.md), 'sticker' => [file](../constructors/file.md), \]; @@ -677,21 +1049,82 @@ description: List of constructors

[$stickers](../constructors/stickers.md) = \['stickers' => \[[sticker](../constructors/sticker.md)\], \]; *** -

[$test\_bytes](../constructors/test_bytes.md) = \['value' => [bytes](../types/bytes.md), \]; +

[$storageStatistics](../constructors/storageStatistics.md) = \['size' => [int53](../constructors/int53.md), 'count' => [int](../types/int.md), 'by_chat' => \[[storageStatisticsByChat](../constructors/storageStatisticsByChat.md)\], \]; -[$test\_empty](../constructors/test_empty.md) = \[\]; +*** +

[$storageStatisticsByChat](../constructors/storageStatisticsByChat.md) = \['chat_id' => [int53](../constructors/int53.md), 'size' => [int53](../constructors/int53.md), 'count' => [int](../types/int.md), 'by_file_type' => \[[storageStatisticsByFileType](../constructors/storageStatisticsByFileType.md)\], \]; -[$test\_int](../constructors/test_int.md) = \['value' => [int](../types/int.md), \]; +*** +

[$storageStatisticsByFileType](../constructors/storageStatisticsByFileType.md) = \['file_type' => [FileType](../types/FileType.md), 'size' => [int53](../constructors/int53.md), 'count' => [int](../types/int.md), \]; -[$test\_string](../constructors/test_string.md) = \['value' => [string](../types/string.md), \]; +*** +

[$storageStatisticsFast](../constructors/storageStatisticsFast.md) = \['files_size' => [int53](../constructors/int53.md), 'files_count' => [int](../types/int.md), 'database_size' => [int53](../constructors/int53.md), \]; -[$test\_vectorInt](../constructors/test_vectorInt.md) = \['value' => \[[int](../types/int.md)\], \]; +*** +

[$temporaryPasswordState](../constructors/temporaryPasswordState.md) = \['has_password' => [Bool](../types/Bool.md), 'valid_for' => [int](../types/int.md), \]; -[$test\_vectorIntObject](../constructors/test_vectorIntObject.md) = \['value' => \[[test\_Int](../types/test_Int.md)\], \]; +*** +

[$testBytes](../constructors/testBytes.md) = \['value' => [bytes](../types/bytes.md), \]; -[$test\_vectorString](../constructors/test_vectorString.md) = \['value' => \[[string](../types/string.md)\], \]; +*** +

[$testInt](../constructors/testInt.md) = \['value' => [int](../types/int.md), \]; -[$test\_vectorStringObject](../constructors/test_vectorStringObject.md) = \['value' => \[[test\_String](../types/test_String.md)\], \]; +*** +

[$testString](../constructors/testString.md) = \['value' => [string](../types/string.md), \]; + +*** +

[$testVectorInt](../constructors/testVectorInt.md) = \['value' => \[[int](../types/int.md)\], \]; + +*** +

[$testVectorIntObject](../constructors/testVectorIntObject.md) = \['value' => \[[testInt](../constructors/testInt.md)\], \]; + +*** +

[$testVectorString](../constructors/testVectorString.md) = \['value' => \[[string](../types/string.md)\], \]; + +*** +

[$testVectorStringObject](../constructors/testVectorStringObject.md) = \['value' => \[[testString](../constructors/testString.md)\], \]; + +*** +

[$text](../constructors/text.md) = \['text' => [string](../types/string.md), \]; + +*** +

[$textEntity](../constructors/textEntity.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.md), 'type' => [TextEntityType](../types/TextEntityType.md), \]; + +*** +

[$textEntityTypeBold](../constructors/textEntityTypeBold.md) = \[\]; + +*** +

[$textEntityTypeBotCommand](../constructors/textEntityTypeBotCommand.md) = \[\]; + +*** +

[$textEntityTypeCode](../constructors/textEntityTypeCode.md) = \[\]; + +*** +

[$textEntityTypeEmail](../constructors/textEntityTypeEmail.md) = \[\]; + +*** +

[$textEntityTypeHashtag](../constructors/textEntityTypeHashtag.md) = \[\]; + +*** +

[$textEntityTypeItalic](../constructors/textEntityTypeItalic.md) = \[\]; + +*** +

[$textEntityTypeMention](../constructors/textEntityTypeMention.md) = \[\]; + +*** +

[$textEntityTypeMentionName](../constructors/textEntityTypeMentionName.md) = \['user_id' => [int](../types/int.md), \]; + +*** +

[$textEntityTypePre](../constructors/textEntityTypePre.md) = \[\]; + +*** +

[$textEntityTypePreCode](../constructors/textEntityTypePreCode.md) = \['language' => [string](../types/string.md), \]; + +*** +

[$textEntityTypeTextUrl](../constructors/textEntityTypeTextUrl.md) = \['url' => [string](../types/string.md), \]; + +*** +

[$textEntityTypeUrl](../constructors/textEntityTypeUrl.md) = \[\]; ***

[$textParseModeHTML](../constructors/textParseModeHTML.md) = \[\]; @@ -700,46 +1133,67 @@ description: List of constructors

[$textParseModeMarkdown](../constructors/textParseModeMarkdown.md) = \[\]; *** -

[$ubuntuPhoneDeviceToken](../constructors/ubuntuPhoneDeviceToken.md) = \['token' => [string](../types/string.md), \]; +

[$topChatCategoryBots](../constructors/topChatCategoryBots.md) = \[\]; + +*** +

[$topChatCategoryCalls](../constructors/topChatCategoryCalls.md) = \[\]; + +*** +

[$topChatCategoryChannels](../constructors/topChatCategoryChannels.md) = \[\]; + +*** +

[$topChatCategoryGroups](../constructors/topChatCategoryGroups.md) = \[\]; + +*** +

[$topChatCategoryInlineBots](../constructors/topChatCategoryInlineBots.md) = \[\]; + +*** +

[$topChatCategoryUsers](../constructors/topChatCategoryUsers.md) = \[\]; ***

[$updateAuthState](../constructors/updateAuthState.md) = \['auth_state' => [AuthState](../types/AuthState.md), \]; +*** +

[$updateCall](../constructors/updateCall.md) = \['call' => [call](../constructors/call.md), \]; + ***

[$updateChannel](../constructors/updateChannel.md) = \['channel' => [channel](../constructors/channel.md), \]; *** -

[$updateChannelFull](../constructors/updateChannelFull.md) = \['channel_full' => [channelFull](../constructors/channelFull.md), \]; +

[$updateChannelFull](../constructors/updateChannelFull.md) = \['channel_id' => [int](../types/int.md), 'channel_full' => [channelFull](../constructors/channelFull.md), \]; *** -

[$updateChat](../constructors/updateChat.md) = \['chat' => [chat](../constructors/chat.md), \]; +

[$updateChatDraftMessage](../constructors/updateChatDraftMessage.md) = \['chat_id' => [int53](../constructors/int53.md), 'draft_message' => [draftMessage](../constructors/draftMessage.md), \]; *** -

[$updateChatDraftMessage](../constructors/updateChatDraftMessage.md) = \['chat_id' => [long](../types/long.md), 'draft_message' => [draftMessage](../constructors/draftMessage.md), \]; +

[$updateChatIsPinned](../constructors/updateChatIsPinned.md) = \['chat_id' => [int53](../constructors/int53.md), 'is_pinned' => [Bool](../types/Bool.md), \]; *** -

[$updateChatOrder](../constructors/updateChatOrder.md) = \['chat_id' => [long](../types/long.md), 'order' => [long](../types/long.md), \]; +

[$updateChatOrder](../constructors/updateChatOrder.md) = \['chat_id' => [int53](../constructors/int53.md), 'order' => [long](../types/long.md), \]; *** -

[$updateChatPhoto](../constructors/updateChatPhoto.md) = \['chat_id' => [long](../types/long.md), 'photo' => [chatPhoto](../constructors/chatPhoto.md), \]; +

[$updateChatPhoto](../constructors/updateChatPhoto.md) = \['chat_id' => [int53](../constructors/int53.md), 'photo' => [chatPhoto](../constructors/chatPhoto.md), \]; *** -

[$updateChatReadInbox](../constructors/updateChatReadInbox.md) = \['chat_id' => [long](../types/long.md), 'last_read_inbox_message_id' => [long](../types/long.md), 'unread_count' => [int](../types/int.md), \]; +

[$updateChatReadInbox](../constructors/updateChatReadInbox.md) = \['chat_id' => [int53](../constructors/int53.md), 'last_read_inbox_message_id' => [int53](../constructors/int53.md), 'unread_count' => [int](../types/int.md), \]; *** -

[$updateChatReadOutbox](../constructors/updateChatReadOutbox.md) = \['chat_id' => [long](../types/long.md), 'last_read_outbox_message_id' => [long](../types/long.md), \]; +

[$updateChatReadOutbox](../constructors/updateChatReadOutbox.md) = \['chat_id' => [int53](../constructors/int53.md), 'last_read_outbox_message_id' => [int53](../constructors/int53.md), \]; *** -

[$updateChatReplyMarkup](../constructors/updateChatReplyMarkup.md) = \['chat_id' => [long](../types/long.md), 'reply_markup_message_id' => [long](../types/long.md), \]; +

[$updateChatReplyMarkup](../constructors/updateChatReplyMarkup.md) = \['chat_id' => [int53](../constructors/int53.md), 'reply_markup_message_id' => [int53](../constructors/int53.md), \]; *** -

[$updateChatTitle](../constructors/updateChatTitle.md) = \['chat_id' => [long](../types/long.md), 'title' => [string](../types/string.md), \]; +

[$updateChatTitle](../constructors/updateChatTitle.md) = \['chat_id' => [int53](../constructors/int53.md), 'title' => [string](../types/string.md), \]; *** -

[$updateChatTopMessage](../constructors/updateChatTopMessage.md) = \['chat_id' => [long](../types/long.md), 'top_message' => [message](../constructors/message.md), \]; +

[$updateChatTopMessage](../constructors/updateChatTopMessage.md) = \['chat_id' => [int53](../constructors/int53.md), 'top_message' => [message](../constructors/message.md), \]; *** -

[$updateDeleteMessages](../constructors/updateDeleteMessages.md) = \['chat_id' => [long](../types/long.md), 'message_ids' => \[[long](../types/long.md)\], \]; +

[$updateConnectionState](../constructors/updateConnectionState.md) = \['state' => [ConnectionState](../types/ConnectionState.md), \]; + +*** +

[$updateDeleteMessages](../constructors/updateDeleteMessages.md) = \['chat_id' => [int53](../constructors/int53.md), 'message_ids' => \[[int53](../constructors/int53.md)\], \]; ***

[$updateFile](../constructors/updateFile.md) = \['file' => [file](../constructors/file.md), \]; @@ -760,26 +1214,44 @@ description: List of constructors

[$updateGroup](../constructors/updateGroup.md) = \['group' => [group](../constructors/group.md), \]; *** -

[$updateMessageContent](../constructors/updateMessageContent.md) = \['chat_id' => [long](../types/long.md), 'message_id' => [long](../types/long.md), 'new_content' => [MessageContent](../types/MessageContent.md), \]; +

[$updateGroupFull](../constructors/updateGroupFull.md) = \['group_id' => [int](../types/int.md), 'group_full' => [groupFull](../constructors/groupFull.md), \]; *** -

[$updateMessageEdited](../constructors/updateMessageEdited.md) = \['chat_id' => [long](../types/long.md), 'message_id' => [long](../types/long.md), 'edit_date' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; +

[$updateInstalledStickerSets](../constructors/updateInstalledStickerSets.md) = \['is_masks' => [Bool](../types/Bool.md), 'sticker_set_ids' => \[[long](../types/long.md)\], \]; *** -

[$updateMessageSendFailed](../constructors/updateMessageSendFailed.md) = \['chat_id' => [long](../types/long.md), 'message_id' => [long](../types/long.md), 'error_code' => [int](../types/int.md), 'error_message' => [string](../types/string.md), \]; +

[$updateMessageContent](../constructors/updateMessageContent.md) = \['chat_id' => [int53](../constructors/int53.md), 'message_id' => [int53](../constructors/int53.md), 'new_content' => [MessageContent](../types/MessageContent.md), \]; *** -

[$updateMessageSendSucceeded](../constructors/updateMessageSendSucceeded.md) = \['message' => [message](../constructors/message.md), 'old_message_id' => [long](../types/long.md), \]; +

[$updateMessageEdited](../constructors/updateMessageEdited.md) = \['chat_id' => [int53](../constructors/int53.md), 'message_id' => [int53](../constructors/int53.md), 'edit_date' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; *** -

[$updateMessageViews](../constructors/updateMessageViews.md) = \['chat_id' => [long](../types/long.md), 'message_id' => [long](../types/long.md), 'views' => [int](../types/int.md), \]; +

[$updateMessageSendAcknowledged](../constructors/updateMessageSendAcknowledged.md) = \['chat_id' => [int53](../constructors/int53.md), 'message_id' => [int53](../constructors/int53.md), \]; *** -

[$updateNewCallbackQuery](../constructors/updateNewCallbackQuery.md) = \['id' => [long](../types/long.md), 'sender_user_id' => [int](../types/int.md), 'chat_id' => [long](../types/long.md), 'message_id' => [long](../types/long.md), 'chat_instance' => [long](../types/long.md), 'payload' => [CallbackQueryPayload](../types/CallbackQueryPayload.md), \]; +

[$updateMessageSendFailed](../constructors/updateMessageSendFailed.md) = \['message' => [message](../constructors/message.md), 'old_message_id' => [int53](../constructors/int53.md), 'error_code' => [int](../types/int.md), 'error_message' => [string](../types/string.md), \]; + +*** +

[$updateMessageSendSucceeded](../constructors/updateMessageSendSucceeded.md) = \['message' => [message](../constructors/message.md), 'old_message_id' => [int53](../constructors/int53.md), \]; + +*** +

[$updateMessageViews](../constructors/updateMessageViews.md) = \['chat_id' => [int53](../constructors/int53.md), 'message_id' => [int53](../constructors/int53.md), 'views' => [int](../types/int.md), \]; + +*** +

[$updateNewCallbackQuery](../constructors/updateNewCallbackQuery.md) = \['id' => [long](../types/long.md), 'sender_user_id' => [int](../types/int.md), 'chat_id' => [int53](../constructors/int53.md), 'message_id' => [int53](../constructors/int53.md), 'chat_instance' => [long](../types/long.md), 'payload' => [CallbackQueryPayload](../types/CallbackQueryPayload.md), \]; + +*** +

[$updateNewChat](../constructors/updateNewChat.md) = \['chat' => [chat](../constructors/chat.md), \]; ***

[$updateNewChosenInlineResult](../constructors/updateNewChosenInlineResult.md) = \['sender_user_id' => [int](../types/int.md), 'user_location' => [location](../constructors/location.md), 'query' => [string](../types/string.md), 'result_id' => [string](../types/string.md), 'inline_message_id' => [string](../types/string.md), \]; +*** +

[$updateNewCustomEvent](../constructors/updateNewCustomEvent.md) = \['event' => [string](../types/string.md), \]; + +*** +

[$updateNewCustomQuery](../constructors/updateNewCustomQuery.md) = \['id' => [long](../types/long.md), 'data' => [string](../types/string.md), 'timeout' => [int](../types/int.md), \]; + ***

[$updateNewInlineCallbackQuery](../constructors/updateNewInlineCallbackQuery.md) = \['id' => [long](../types/long.md), 'sender_user_id' => [int](../types/int.md), 'inline_message_id' => [string](../types/string.md), 'chat_instance' => [long](../types/long.md), 'payload' => [CallbackQueryPayload](../types/CallbackQueryPayload.md), \]; @@ -787,11 +1259,20 @@ description: List of constructors

[$updateNewInlineQuery](../constructors/updateNewInlineQuery.md) = \['id' => [long](../types/long.md), 'sender_user_id' => [int](../types/int.md), 'user_location' => [location](../constructors/location.md), 'query' => [string](../types/string.md), 'offset' => [string](../types/string.md), \]; *** -

[$updateNewMessage](../constructors/updateNewMessage.md) = \['message' => [message](../constructors/message.md), 'disable_notification' => [Bool](../types/Bool.md), \]; +

[$updateNewMessage](../constructors/updateNewMessage.md) = \['message' => [message](../constructors/message.md), 'disable_notification' => [Bool](../types/Bool.md), 'contains_mention' => [Bool](../types/Bool.md), \]; + +*** +

[$updateNewPreCheckoutQuery](../constructors/updateNewPreCheckoutQuery.md) = \['id' => [long](../types/long.md), 'sender_user_id' => [int](../types/int.md), 'currency' => [string](../types/string.md), 'total_amount' => [int53](../constructors/int53.md), 'invoice_payload' => [bytes](../types/bytes.md), 'shipping_option_id' => [string](../types/string.md), 'order_info' => [orderInfo](../constructors/orderInfo.md), \]; + +*** +

[$updateNewShippingQuery](../constructors/updateNewShippingQuery.md) = \['id' => [long](../types/long.md), 'sender_user_id' => [int](../types/int.md), 'invoice_payload' => [string](../types/string.md), 'shipping_address' => [shippingAddress](../constructors/shippingAddress.md), \]; ***

[$updateNotificationSettings](../constructors/updateNotificationSettings.md) = \['scope' => [NotificationSettingsScope](../types/NotificationSettingsScope.md), 'notification_settings' => [notificationSettings](../constructors/notificationSettings.md), \]; +*** +

[$updateOpenMessageContent](../constructors/updateOpenMessageContent.md) = \['chat_id' => [int53](../constructors/int53.md), 'message_id' => [int53](../constructors/int53.md), \]; + ***

[$updateOption](../constructors/updateOption.md) = \['name' => [string](../types/string.md), 'value' => [OptionValue](../types/OptionValue.md), \]; @@ -802,7 +1283,7 @@ description: List of constructors

[$updateRecentStickers](../constructors/updateRecentStickers.md) = \['is_attached' => [Bool](../types/Bool.md), 'sticker_ids' => \[[int](../types/int.md)\], \]; *** -

[$updateSavedAnimations](../constructors/updateSavedAnimations.md) = \[\]; +

[$updateSavedAnimations](../constructors/updateSavedAnimations.md) = \['animation_ids' => \[[int](../types/int.md)\], \]; ***

[$updateSecretChat](../constructors/updateSecretChat.md) = \['secret_chat' => [secretChat](../constructors/secretChat.md), \]; @@ -810,9 +1291,6 @@ description: List of constructors ***

[$updateServiceNotification](../constructors/updateServiceNotification.md) = \['type' => [string](../types/string.md), 'content' => [MessageContent](../types/MessageContent.md), \]; -*** -

[$updateStickerSets](../constructors/updateStickerSets.md) = \['is_masks' => [Bool](../types/Bool.md), 'sticker_set_ids' => \[[long](../types/long.md)\], \]; - ***

[$updateTrendingStickerSets](../constructors/updateTrendingStickerSets.md) = \['sticker_sets' => [stickerSets](../constructors/stickerSets.md), \]; @@ -820,19 +1298,19 @@ description: List of constructors

[$updateUser](../constructors/updateUser.md) = \['user' => [user](../constructors/user.md), \]; *** -

[$updateUserAction](../constructors/updateUserAction.md) = \['chat_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'action' => [SendMessageAction](../types/SendMessageAction.md), \]; +

[$updateUserChatAction](../constructors/updateUserChatAction.md) = \['chat_id' => [int53](../constructors/int53.md), 'user_id' => [int](../types/int.md), 'action' => [ChatAction](../types/ChatAction.md), \]; *** -

[$updateUserBlocked](../constructors/updateUserBlocked.md) = \['user_id' => [int](../types/int.md), 'is_blocked' => [Bool](../types/Bool.md), \]; +

[$updateUserFull](../constructors/updateUserFull.md) = \['user_id' => [int](../types/int.md), 'user_full' => [userFull](../constructors/userFull.md), \]; ***

[$updateUserStatus](../constructors/updateUserStatus.md) = \['user_id' => [int](../types/int.md), 'status' => [UserStatus](../types/UserStatus.md), \]; *** -

[$user](../constructors/user.md) = \['id' => [int](../types/int.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'username' => [string](../types/string.md), 'phone_number' => [string](../types/string.md), 'status' => [UserStatus](../types/UserStatus.md), 'profile_photo' => [profilePhoto](../constructors/profilePhoto.md), 'my_link' => [LinkState](../types/LinkState.md), 'foreign_link' => [LinkState](../types/LinkState.md), 'is_verified' => [Bool](../types/Bool.md), 'restriction_reason' => [string](../types/string.md), 'have_access' => [Bool](../types/Bool.md), 'type' => [UserType](../types/UserType.md), \]; +

[$user](../constructors/user.md) = \['id' => [int](../types/int.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'username' => [string](../types/string.md), 'phone_number' => [string](../types/string.md), 'status' => [UserStatus](../types/UserStatus.md), 'profile_photo' => [profilePhoto](../constructors/profilePhoto.md), 'my_link' => [LinkState](../types/LinkState.md), 'foreign_link' => [LinkState](../types/LinkState.md), 'is_verified' => [Bool](../types/Bool.md), 'restriction_reason' => [string](../types/string.md), 'have_access' => [Bool](../types/Bool.md), 'type' => [UserType](../types/UserType.md), 'language_code' => [string](../types/string.md), \]; *** -

[$userFull](../constructors/userFull.md) = \['user' => [user](../constructors/user.md), 'is_blocked' => [Bool](../types/Bool.md), 'about' => [string](../types/string.md), 'common_chat_count' => [int](../types/int.md), 'bot_info' => [botInfo](../constructors/botInfo.md), \]; +

[$userFull](../constructors/userFull.md) = \['is_blocked' => [Bool](../types/Bool.md), 'can_be_called' => [Bool](../types/Bool.md), 'has_private_calls' => [Bool](../types/Bool.md), 'about' => [string](../types/string.md), 'common_chat_count' => [int](../types/int.md), 'bot_info' => [botInfo](../constructors/botInfo.md), \]; ***

[$userProfilePhotos](../constructors/userProfilePhotos.md) = \['total_count' => [int](../types/int.md), 'photos' => \[[photo](../constructors/photo.md)\], \]; @@ -868,7 +1346,10 @@ description: List of constructors

[$userTypeUnknown](../constructors/userTypeUnknown.md) = \[\]; *** -

[$users](../constructors/users.md) = \['total_count' => [int](../types/int.md), 'users' => \[[user](../constructors/user.md)\], \]; +

[$users](../constructors/users.md) = \['total_count' => [int](../types/int.md), 'user_ids' => \[[int](../types/int.md)\], \]; + +*** +

[$validatedOrderInfo](../constructors/validatedOrderInfo.md) = \['order_info_id' => [string](../types/string.md), 'shipping_options' => \[[shippingOption](../constructors/shippingOption.md)\], \]; ***

[$venue](../constructors/venue.md) = \['location' => [location](../constructors/location.md), 'title' => [string](../types/string.md), 'address' => [string](../types/string.md), 'provider' => [string](../types/string.md), 'id' => [string](../types/string.md), \]; @@ -876,15 +1357,21 @@ description: List of constructors ***

[$video](../constructors/video.md) = \['duration' => [int](../types/int.md), 'width' => [int](../types/int.md), 'height' => [int](../types/int.md), 'file_name' => [string](../types/string.md), 'mime_type' => [string](../types/string.md), 'has_stickers' => [Bool](../types/Bool.md), 'thumb' => [photoSize](../constructors/photoSize.md), 'video' => [file](../constructors/file.md), \]; +*** +

[$videoNote](../constructors/videoNote.md) = \['duration' => [int](../types/int.md), 'length' => [int](../types/int.md), 'thumb' => [photoSize](../constructors/photoSize.md), 'video' => [file](../constructors/file.md), \]; + ***

[$voice](../constructors/voice.md) = \['duration' => [int](../types/int.md), 'waveform' => [bytes](../types/bytes.md), 'mime_type' => [string](../types/string.md), 'voice' => [file](../constructors/file.md), \]; *** -

[$wallpaper](../constructors/wallpaper.md) = \['sizes' => \[[photoSize](../constructors/photoSize.md)\], 'color' => [int](../types/int.md), \]; +

[$wallpaper](../constructors/wallpaper.md) = \['id' => [int](../types/int.md), 'sizes' => \[[photoSize](../constructors/photoSize.md)\], 'color' => [int](../types/int.md), \]; ***

[$wallpapers](../constructors/wallpapers.md) = \['wallpapers' => \[[wallpaper](../constructors/wallpaper.md)\], \]; *** -

[$webPage](../constructors/webPage.md) = \['url' => [string](../types/string.md), 'display_url' => [string](../types/string.md), 'type' => [string](../types/string.md), 'site_name' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [photo](../constructors/photo.md), 'embed_url' => [string](../types/string.md), 'embed_type' => [string](../types/string.md), 'embed_width' => [int](../types/int.md), 'embed_height' => [int](../types/int.md), 'duration' => [int](../types/int.md), 'author' => [string](../types/string.md), 'animation' => [animation](../constructors/animation.md), 'audio' => [audio](../constructors/audio.md), 'document' => [document](../constructors/document.md), 'sticker' => [sticker](../constructors/sticker.md), 'video' => [video](../constructors/video.md), 'voice' => [voice](../constructors/voice.md), \]; +

[$webPage](../constructors/webPage.md) = \['url' => [string](../types/string.md), 'display_url' => [string](../types/string.md), 'type' => [string](../types/string.md), 'site_name' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [photo](../constructors/photo.md), 'embed_url' => [string](../types/string.md), 'embed_type' => [string](../types/string.md), 'embed_width' => [int](../types/int.md), 'embed_height' => [int](../types/int.md), 'duration' => [int](../types/int.md), 'author' => [string](../types/string.md), 'animation' => [animation](../constructors/animation.md), 'audio' => [audio](../constructors/audio.md), 'document' => [document](../constructors/document.md), 'sticker' => [sticker](../constructors/sticker.md), 'video' => [video](../constructors/video.md), 'video_note' => [videoNote](../constructors/videoNote.md), 'voice' => [voice](../constructors/voice.md), 'has_instant_view' => [Bool](../types/Bool.md), \]; + +*** +

[$webPageInstantView](../constructors/webPageInstantView.md) = \['page_blocks' => \[[PageBlock](../types/PageBlock.md)\], 'is_full' => [Bool](../types/Bool.md), \]; diff --git a/docs/TD_docs/constructors/inlineKeyboardButtonTypeBuy.md b/docs/TD_docs/constructors/inlineKeyboardButtonTypeBuy.md new file mode 100644 index 00000000..dbd7f1cc --- /dev/null +++ b/docs/TD_docs/constructors/inlineKeyboardButtonTypeBuy.md @@ -0,0 +1,21 @@ +--- +title: inlineKeyboardButtonTypeBuy +description: A button for buying, must be in the first column and row of the keyboard, can be attached only to a message with content of the type messageInvoice +--- +## Constructor: inlineKeyboardButtonTypeBuy +[Back to constructors index](index.md) + + + +A button for buying, must be in the first column and row of the keyboard, can be attached only to a message with content of the type messageInvoice + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [InlineKeyboardButtonType](../types/InlineKeyboardButtonType.md) + + diff --git a/docs/TD_docs/constructors/inlineQueryResultArticle.md b/docs/TD_docs/constructors/inlineQueryResultArticle.md index 0264d74f..9b67fb78 100644 --- a/docs/TD_docs/constructors/inlineQueryResultArticle.md +++ b/docs/TD_docs/constructors/inlineQueryResultArticle.md @@ -18,9 +18,7 @@ Represents link to an article or web page |hide\_url|[Bool](../types/Bool.md) | Yes|True, if url must be not shown| |title|[string](../types/string.md) | Yes|Title of the result| |description|[string](../types/string.md) | Yes|Short description of the result| -|thumb\_url|[string](../types/string.md) | Yes|Url of the result thumb, if exists| -|thumb\_width|[int](../types/int.md) | Yes|Thumb width, if known| -|thumb\_height|[int](../types/int.md) | Yes|Thumb height, if known| +|thumb|[photoSize](../types/photoSize.md) | Yes|Result thumb, nullable| diff --git a/docs/TD_docs/constructors/inlineQueryResultContact.md b/docs/TD_docs/constructors/inlineQueryResultContact.md index 946e9599..686f8da4 100644 --- a/docs/TD_docs/constructors/inlineQueryResultContact.md +++ b/docs/TD_docs/constructors/inlineQueryResultContact.md @@ -15,9 +15,7 @@ Represents user contact |----------|---------------|----------|-------------| |id|[string](../types/string.md) | Yes|Unique identifier of this result| |contact|[contact](../types/contact.md) | Yes|User contact| -|thumb\_url|[string](../types/string.md) | Yes|Url of the result thumb, if exists| -|thumb\_width|[int](../types/int.md) | Yes|Thumb width, if known| -|thumb\_height|[int](../types/int.md) | Yes|Thumb height, if known| +|thumb|[photoSize](../types/photoSize.md) | Yes|Result thumb, nullable| diff --git a/docs/TD_docs/constructors/inlineQueryResultLocation.md b/docs/TD_docs/constructors/inlineQueryResultLocation.md index cbf591cb..c76c74b3 100644 --- a/docs/TD_docs/constructors/inlineQueryResultLocation.md +++ b/docs/TD_docs/constructors/inlineQueryResultLocation.md @@ -16,9 +16,7 @@ Represents a point on the map |id|[string](../types/string.md) | Yes|Unique identifier of this result| |location|[location](../types/location.md) | Yes|The result| |title|[string](../types/string.md) | Yes|Title of the result| -|thumb\_url|[string](../types/string.md) | Yes|Url of the result thumb, if exists| -|thumb\_width|[int](../types/int.md) | Yes|Thumb width, if known| -|thumb\_height|[int](../types/int.md) | Yes|Thumb height, if known| +|thumb|[photoSize](../types/photoSize.md) | Yes|Result thumb, nullable| diff --git a/docs/TD_docs/constructors/inlineQueryResultVenue.md b/docs/TD_docs/constructors/inlineQueryResultVenue.md index 86d0e13d..f087ebae 100644 --- a/docs/TD_docs/constructors/inlineQueryResultVenue.md +++ b/docs/TD_docs/constructors/inlineQueryResultVenue.md @@ -15,9 +15,7 @@ Represents information about a venue |----------|---------------|----------|-------------| |id|[string](../types/string.md) | Yes|Unique identifier of this result| |venue|[venue](../types/venue.md) | Yes|The result| -|thumb\_url|[string](../types/string.md) | Yes|Url of the result thumb, if exists| -|thumb\_width|[int](../types/int.md) | Yes|Thumb width, if known| -|thumb\_height|[int](../types/int.md) | Yes|Thumb height, if known| +|thumb|[photoSize](../types/photoSize.md) | Yes|Result thumb, nullable| diff --git a/docs/TD_docs/constructors/inputCredentialsNew.md b/docs/TD_docs/constructors/inputCredentialsNew.md new file mode 100644 index 00000000..cfb35a85 --- /dev/null +++ b/docs/TD_docs/constructors/inputCredentialsNew.md @@ -0,0 +1,23 @@ +--- +title: inputCredentialsNew +description: User enters new credentials on payment provider web site +--- +## Constructor: inputCredentialsNew +[Back to constructors index](index.md) + + + +User enters new credentials on payment provider web site + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|data|[string](../types/string.md) | Yes|JSON-encoded data with credentials identifier from the payment provider| +|allow\_save|[Bool](../types/Bool.md) | Yes|True, if credentials identifier can be saved server-side| + + + +### Type: [InputCredentials](../types/InputCredentials.md) + + diff --git a/docs/TD_docs/constructors/inputCredentialsSaved.md b/docs/TD_docs/constructors/inputCredentialsSaved.md new file mode 100644 index 00000000..67938a00 --- /dev/null +++ b/docs/TD_docs/constructors/inputCredentialsSaved.md @@ -0,0 +1,22 @@ +--- +title: inputCredentialsSaved +description: User chooses previosly saved payment credentials. To use previously saved credentials user should have valid temporary password +--- +## Constructor: inputCredentialsSaved +[Back to constructors index](index.md) + + + +User chooses previosly saved payment credentials. To use previously saved credentials user should have valid temporary password + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|saved\_credentials\_id|[string](../types/string.md) | Yes|Identifier of saved credentials| + + + +### Type: [InputCredentials](../types/InputCredentials.md) + + diff --git a/docs/TD_docs/constructors/inputFileGenerated.md b/docs/TD_docs/constructors/inputFileGenerated.md index 6f026983..f8f8f145 100644 --- a/docs/TD_docs/constructors/inputFileGenerated.md +++ b/docs/TD_docs/constructors/inputFileGenerated.md @@ -16,7 +16,6 @@ File generated by the client |original\_path|[string](../types/string.md) | Yes|Local path to a file from which the file is generated, may be empty if there is no such file| |conversion|[string](../types/string.md) | Yes|String specifying conversion applied to the original file, should be persistent across application restart| |expected\_size|[int](../types/int.md) | Yes|Expected size of the generated file| -|should\_cache|[Bool](../types/Bool.md) | Yes|True, if result of the conversion should be cached persistently| diff --git a/docs/TD_docs/constructors/inputInlineQueryResultAnimatedGif.md b/docs/TD_docs/constructors/inputInlineQueryResultAnimatedGif.md index 060e5da6..77e889b8 100644 --- a/docs/TD_docs/constructors/inputInlineQueryResultAnimatedGif.md +++ b/docs/TD_docs/constructors/inputInlineQueryResultAnimatedGif.md @@ -17,6 +17,7 @@ Represents link to an animated gif |title|[string](../types/string.md) | Yes|Title of the result| |thumb\_url|[string](../types/string.md) | Yes|Url of the static result thumb (jpeg or gif), if exists| |gif\_url|[string](../types/string.md) | Yes|Url of the gif-file (file size must not exceed 1MB)| +|gif\_duration|[int](../types/int.md) | Yes|Duration of the gif in seconds| |gif\_width|[int](../types/int.md) | Yes|Width of the gif| |gif\_height|[int](../types/int.md) | Yes|Height of the gif| |reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Message reply markup, should be of type replyMarkupInlineKeyboard or null| diff --git a/docs/TD_docs/constructors/inputInlineQueryResultAnimatedMpeg4.md b/docs/TD_docs/constructors/inputInlineQueryResultAnimatedMpeg4.md index d0e21010..2887db01 100644 --- a/docs/TD_docs/constructors/inputInlineQueryResultAnimatedMpeg4.md +++ b/docs/TD_docs/constructors/inputInlineQueryResultAnimatedMpeg4.md @@ -17,6 +17,7 @@ Represents link to an animated (i.e. without sound) H.264/MPEG-4 AVC video |title|[string](../types/string.md) | Yes|Title of the result| |thumb\_url|[string](../types/string.md) | Yes|Url of the static result thumb (jpeg or gif), if exists| |mpeg4\_url|[string](../types/string.md) | Yes|Url of the mp4-file (file size must not exceed 1MB)| +|mpeg4\_duration|[int](../types/int.md) | Yes|Duration of the video in seconds| |mpeg4\_width|[int](../types/int.md) | Yes|Width of the video| |mpeg4\_height|[int](../types/int.md) | Yes|Height of the video| |reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Message reply markup, should be of type replyMarkupInlineKeyboard or null| diff --git a/docs/TD_docs/constructors/inputMessageAnimation.md b/docs/TD_docs/constructors/inputMessageAnimation.md index 19bde000..881b5e5a 100644 --- a/docs/TD_docs/constructors/inputMessageAnimation.md +++ b/docs/TD_docs/constructors/inputMessageAnimation.md @@ -15,6 +15,7 @@ Animation message |----------|---------------|----------|-------------| |animation|[InputFile](../types/InputFile.md) | Yes|Animation file to send| |thumb|[InputThumb](../types/InputThumb.md) | Yes|Animation thumb, if available| +|duration|[int](../types/int.md) | Yes|Duration of the animation in seconds| |width|[int](../types/int.md) | Yes|Width of the animation, may be replaced by the server| |height|[int](../types/int.md) | Yes|Height of the animation, may be replaced by the server| |caption|[string](../types/string.md) | Yes|Animation caption, 0-200 characters| diff --git a/docs/TD_docs/constructors/inputMessageAudio.md b/docs/TD_docs/constructors/inputMessageAudio.md index 0d89ef77..cc82dca2 100644 --- a/docs/TD_docs/constructors/inputMessageAudio.md +++ b/docs/TD_docs/constructors/inputMessageAudio.md @@ -15,7 +15,7 @@ Audio message |----------|---------------|----------|-------------| |audio|[InputFile](../types/InputFile.md) | Yes|Audio file to send| |album\_cover\_thumb|[InputThumb](../types/InputThumb.md) | Yes|Thumb of the album's cover, if available| -|duration|[int](../types/int.md) | Yes|Duration of audio in seconds, may be replaced by the server| +|duration|[int](../types/int.md) | Yes|Duration of the audio in seconds, may be replaced by the server| |title|[string](../types/string.md) | Yes|Title of the audio, 0-64 characters, may be replaced by the server| |performer|[string](../types/string.md) | Yes|Performer of the audio, 0-64 characters, may be replaced by the server| |caption|[string](../types/string.md) | Yes|Audio caption, 0-200 characters| diff --git a/docs/TD_docs/constructors/inputMessageForwarded.md b/docs/TD_docs/constructors/inputMessageForwarded.md index 4f1eabfe..f1beb67a 100644 --- a/docs/TD_docs/constructors/inputMessageForwarded.md +++ b/docs/TD_docs/constructors/inputMessageForwarded.md @@ -13,8 +13,8 @@ Forwarded message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|from\_chat\_id|[long](../types/long.md) | Yes|Chat identifier of the message to forward| -|message\_id|[long](../types/long.md) | Yes|Identifier of the message to forward| +|from\_chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the message to forward| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message to forward| |in\_game\_share|[Bool](../types/Bool.md) | Yes|Pass true to share a game message within a launched game, for Game messages only| diff --git a/docs/TD_docs/constructors/inputMessageInvoice.md b/docs/TD_docs/constructors/inputMessageInvoice.md new file mode 100644 index 00000000..6b7f2765 --- /dev/null +++ b/docs/TD_docs/constructors/inputMessageInvoice.md @@ -0,0 +1,31 @@ +--- +title: inputMessageInvoice +description: Message with an invoice, can be used only by bots and in private chats only +--- +## Constructor: inputMessageInvoice +[Back to constructors index](index.md) + + + +Message with an invoice, can be used only by bots and in private chats only + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|invoice|[invoice](../types/invoice.md) | Yes|The invoice| +|title|[string](../types/string.md) | Yes|Product title, 1-32 characters| +|description|[string](../types/string.md) | Yes|Product description, 0-255 characters| +|photo\_url|[string](../types/string.md) | Yes|Goods photo URL, optional| +|photo\_size|[int](../types/int.md) | Yes|Goods photo size| +|photo\_width|[int](../types/int.md) | Yes|Goods photo width| +|photo\_height|[int](../types/int.md) | Yes|Goods photo height| +|payload|[bytes](../types/bytes.md) | Yes|Invoice payload| +|provider\_token|[string](../types/string.md) | Yes|Payments provider token| +|start\_parameter|[string](../types/string.md) | Yes|Unique invoice bot start_parameter for generation of this invoice| + + + +### Type: [InputMessageContent](../types/InputMessageContent.md) + + diff --git a/docs/TD_docs/constructors/inputMessagePhoto.md b/docs/TD_docs/constructors/inputMessagePhoto.md index b4fe8e67..708f2baa 100644 --- a/docs/TD_docs/constructors/inputMessagePhoto.md +++ b/docs/TD_docs/constructors/inputMessagePhoto.md @@ -19,6 +19,7 @@ Photo message |width|[int](../types/int.md) | Yes|Photo width| |height|[int](../types/int.md) | Yes|Photo height| |caption|[string](../types/string.md) | Yes|Photo caption, 0-200 characters| +|ttl|[int](../types/int.md) | Yes|Photo TTL in seconds, 0-60. Non-zero TTL can be only specified in private chats| diff --git a/docs/TD_docs/constructors/inputMessageText.md b/docs/TD_docs/constructors/inputMessageText.md index 97dfccdd..66b13b2f 100644 --- a/docs/TD_docs/constructors/inputMessageText.md +++ b/docs/TD_docs/constructors/inputMessageText.md @@ -16,7 +16,7 @@ Text message |text|[string](../types/string.md) | Yes|Text to send| |disable\_web\_page\_preview|[Bool](../types/Bool.md) | Yes|Pass true to disable rich preview for link in the message text| |clear\_draft|[Bool](../types/Bool.md) | Yes|Pass true if chat draft message should be deleted| -|entities|Array of [MessageEntity](../constructors/MessageEntity.md) | Yes|Bold, Italic, Code, Pre, PreCode and TextUrl entities contained in the text. Non-bot users can't use TextUrl entities. Can't be used with non-null parse_mode| +|entities|Array of [textEntity](../constructors/textEntity.md) | Yes|Bold, Italic, Code, Pre, PreCode and TextUrl entities contained in the text. Non-bot users can't use TextUrl entities. Can't be used with non-null parse_mode| |parse\_mode|[TextParseMode](../types/TextParseMode.md) | Yes|Text parse mode, nullable. Can't be used along with enitities| diff --git a/docs/TD_docs/constructors/inputMessageVideo.md b/docs/TD_docs/constructors/inputMessageVideo.md index 6df81749..179e99e2 100644 --- a/docs/TD_docs/constructors/inputMessageVideo.md +++ b/docs/TD_docs/constructors/inputMessageVideo.md @@ -16,10 +16,11 @@ Video message |video|[InputFile](../types/InputFile.md) | Yes|Video to send| |thumb|[InputThumb](../types/InputThumb.md) | Yes|Video thumb, if available| |added\_sticker\_file\_ids|Array of [int](../constructors/int.md) | Yes|File identifiers of stickers added onto the video| -|duration|[int](../types/int.md) | Yes|Duration of video in seconds| +|duration|[int](../types/int.md) | Yes|Duration of the video in seconds| |width|[int](../types/int.md) | Yes|Video width| |height|[int](../types/int.md) | Yes|Video height| |caption|[string](../types/string.md) | Yes|Video caption, 0-200 characters| +|ttl|[int](../types/int.md) | Yes|Video TTL in seconds, 0-60. Non-zero TTL can be only specified in private chats| diff --git a/docs/TD_docs/constructors/inputMessageVideoNote.md b/docs/TD_docs/constructors/inputMessageVideoNote.md new file mode 100644 index 00000000..e0e54437 --- /dev/null +++ b/docs/TD_docs/constructors/inputMessageVideoNote.md @@ -0,0 +1,25 @@ +--- +title: inputMessageVideoNote +description: Video note message +--- +## Constructor: inputMessageVideoNote +[Back to constructors index](index.md) + + + +Video note message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|video\_note|[InputFile](../types/InputFile.md) | Yes|Video note to send| +|thumb|[InputThumb](../types/InputThumb.md) | Yes|Video thumb, if available| +|duration|[int](../types/int.md) | Yes|Duration of the video in seconds| +|length|[int](../types/int.md) | Yes|Video width and height, should be positive and not greater than 640| + + + +### Type: [InputMessageContent](../types/InputMessageContent.md) + + diff --git a/docs/TD_docs/constructors/inputMessageVoice.md b/docs/TD_docs/constructors/inputMessageVoice.md index 1e79579c..2b5d99f3 100644 --- a/docs/TD_docs/constructors/inputMessageVoice.md +++ b/docs/TD_docs/constructors/inputMessageVoice.md @@ -14,7 +14,7 @@ Voice message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |voice|[InputFile](../types/InputFile.md) | Yes|Voice file to send| -|duration|[int](../types/int.md) | Yes|Duration of voice in seconds| +|duration|[int](../types/int.md) | Yes|Duration of the voice in seconds| |waveform|[bytes](../types/bytes.md) | Yes|Waveform representation of the voice in 5-bit format| |caption|[string](../types/string.md) | Yes|Voice caption, 0-200 characters| diff --git a/docs/TD_docs/constructors/inputSticker.md b/docs/TD_docs/constructors/inputSticker.md new file mode 100644 index 00000000..cd1cf59d --- /dev/null +++ b/docs/TD_docs/constructors/inputSticker.md @@ -0,0 +1,24 @@ +--- +title: inputSticker +description: Description of a sticker which should be added to a sticker set +--- +## Constructor: inputSticker +[Back to constructors index](index.md) + + + +Description of a sticker which should be added to a sticker set + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|png\_sticker|[InputFile](../types/InputFile.md) | Yes|Png image with the sticker, must be up to 512 kilobytes in size and fit in 512x512 square| +|emojis|[string](../types/string.md) | Yes|Emojis corresponding to the sticker| +|mask\_position|[maskPosition](../types/maskPosition.md) | Yes|Position where the mask should be placed, nullable| + + + +### Type: [InputSticker](../types/InputSticker.md) + + diff --git a/docs/TD_docs/constructors/inputThumbGenerated.md b/docs/TD_docs/constructors/inputThumbGenerated.md index e34b2c90..f73204ac 100644 --- a/docs/TD_docs/constructors/inputThumbGenerated.md +++ b/docs/TD_docs/constructors/inputThumbGenerated.md @@ -1,13 +1,13 @@ --- title: inputThumbGenerated -description: Generated thumb +description: Generated thumb, should be less than 200KB --- ## Constructor: inputThumbGenerated [Back to constructors index](index.md) -Generated thumb +Generated thumb, should be less than 200KB ### Attributes: @@ -15,8 +15,8 @@ Generated thumb |----------|---------------|----------|-------------| |original\_path|[string](../types/string.md) | Yes|Path to the original file| |conversion|[string](../types/string.md) | Yes|String specifying conversion applied to the original file, should be persistent across application restart| -|width|[int](../types/int.md) | Yes|Thumb width, use 0 if unknown| -|height|[int](../types/int.md) | Yes|Thumb height, use 0 if unknown| +|width|[int](../types/int.md) | Yes|Thumb width, usually shouldn't excceed 90. Use 0 if unknown| +|height|[int](../types/int.md) | Yes|Thumb height, usually shouldn't excceed 90. Use 0 if unknown| diff --git a/docs/TD_docs/constructors/inputThumbLocal.md b/docs/TD_docs/constructors/inputThumbLocal.md index 32de17c3..1bff5916 100644 --- a/docs/TD_docs/constructors/inputThumbLocal.md +++ b/docs/TD_docs/constructors/inputThumbLocal.md @@ -13,9 +13,9 @@ Local file with the thumb | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|path|[string](../types/string.md) | Yes|Path to the file with the thumb| -|width|[int](../types/int.md) | Yes|Thumb width, use 0 if unknown| -|height|[int](../types/int.md) | Yes|Thumb height, use 0 if unknown| +|path|[string](../types/string.md) | Yes|Path to the file with the thumb, file should be less than 200KB| +|width|[int](../types/int.md) | Yes|Thumb width, usually shouldn't excceed 90. Use 0 if unknown| +|height|[int](../types/int.md) | Yes|Thumb height, usually shouldn't excceed 90. Use 0 if unknown| diff --git a/docs/TD_docs/constructors/invoice.md b/docs/TD_docs/constructors/invoice.md new file mode 100644 index 00000000..07b3c5ab --- /dev/null +++ b/docs/TD_docs/constructors/invoice.md @@ -0,0 +1,29 @@ +--- +title: invoice +description: Goods invoice +--- +## Constructor: invoice +[Back to constructors index](index.md) + + + +Goods invoice + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|currency|[string](../types/string.md) | Yes|ISO 4217 currency code| +|prices|Array of [labeledPrice](../constructors/labeledPrice.md) | Yes|List of objects used to calculate total price| +|is\_test|[Bool](../types/Bool.md) | Yes|True, if payment is test| +|need\_name|[Bool](../types/Bool.md) | Yes|True, if user's name is needed for payment| +|need\_phone\_number|[Bool](../types/Bool.md) | Yes|True, if user's phone number is needed for payment| +|need\_email|[Bool](../types/Bool.md) | Yes|True, if user's email is needed for payment| +|need\_shipping\_address|[Bool](../types/Bool.md) | Yes|True, if user's shipping address is needed for payment| +|is\_flexible|[Bool](../types/Bool.md) | Yes|True, if total price depends on shipping method| + + + +### Type: [Invoice](../types/Invoice.md) + + diff --git a/docs/TD_docs/constructors/labeledPrice.md b/docs/TD_docs/constructors/labeledPrice.md new file mode 100644 index 00000000..2a044982 --- /dev/null +++ b/docs/TD_docs/constructors/labeledPrice.md @@ -0,0 +1,23 @@ +--- +title: labeledPrice +description: Goods price portion +--- +## Constructor: labeledPrice +[Back to constructors index](index.md) + + + +Goods price portion + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|label|[string](../types/string.md) | Yes|Portion label| +|amount|[int53](../types/int53.md) | Yes|Currency amount in minimal quantity of the currency| + + + +### Type: [LabeledPrice](../types/LabeledPrice.md) + + diff --git a/docs/TD_docs/constructors/maskPosition.md b/docs/TD_docs/constructors/maskPosition.md index 766983fd..ad28c311 100644 --- a/docs/TD_docs/constructors/maskPosition.md +++ b/docs/TD_docs/constructors/maskPosition.md @@ -13,10 +13,10 @@ Position on a photo where a mask should be placed | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|point|[int](../types/int.md) | Yes|Part of a photo relative to which the mask should be placed. 0 - forehead, 1 - eyes, 2 - mouth, 3 - chin| -|x\_shift|[double](../types/double.md) | Yes|Shift by X-axis in pixels, from left to right| -|y\_shift|[double](../types/double.md) | Yes|Shift by Y-axis in pixels, from top to bottom| -|zoom|[double](../types/double.md) | Yes|Mask zoom coefficient| +|point|[int](../types/int.md) | Yes|Part of a face relative to which the mask should be placed. 0 - forehead, 1 - eyes, 2 - mouth, 3 - chin| +|x\_shift|[double](../types/double.md) | Yes|Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position| +|y\_shift|[double](../types/double.md) | Yes|Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.| +|scale|[double](../types/double.md) | Yes|Mask scaling coefficient. For example, 2.0 means double size| diff --git a/docs/TD_docs/constructors/message.md b/docs/TD_docs/constructors/message.md index 0a6a7459..50afad5e 100644 --- a/docs/TD_docs/constructors/message.md +++ b/docs/TD_docs/constructors/message.md @@ -13,20 +13,23 @@ Describes message | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|id|[long](../types/long.md) | Yes|Unique message identifier| -|sender\_user\_id|[int](../types/int.md) | Yes|Identifier of the user who sent the message, 0 if unknown. It can be unknown for channel posts which are not signed by the author| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| +|id|[int53](../types/int53.md) | Yes|Unique message identifier| +|sender\_user\_id|[int](../types/int.md) | Yes|Identifier of the user who sent the message, 0 if unknown. It is unknown for channel posts| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| |send\_state|[MessageSendState](../types/MessageSendState.md) | Yes|Information about sending state of the message| |can\_be\_edited|[Bool](../types/Bool.md) | Yes|True, if message can be edited| -|can\_be\_deleted|[Bool](../types/Bool.md) | Yes|True, if message can be deleted| +|can\_be\_forwarded|[Bool](../types/Bool.md) | Yes|True, if message can be forwarded| +|can\_be\_deleted\_only\_for\_self|[Bool](../types/Bool.md) | Yes|True, if message can be deleted only for self, other users will continue to see it| +|can\_be\_deleted\_for\_everyone|[Bool](../types/Bool.md) | Yes|True, if message can be deleted for everyone| |is\_post|[Bool](../types/Bool.md) | Yes|True, if message is channel post. All messages to broadcast channels are posts, all other messages are not posts| |date|[int](../types/int.md) | Yes|Date when message was sent, unix time| |edit\_date|[int](../types/int.md) | Yes|Date when message was edited last time, unix time| |forward\_info|[MessageForwardInfo](../types/MessageForwardInfo.md) | Yes|Information about initial message sender, nullable| -|reply\_to\_message\_id|[long](../types/long.md) | Yes|If non-zero, identifier of the message this message replies to, can be identifier of deleted message| -|ttl|[int](../types/int.md) | Yes|Message TTL for messages in secret chats in seconds, 0 if none. TDLib will send updateDeleteMessages when TTL expires| -|ttl\_expires\_in|[double](../types/double.md) | Yes|Time left for message ttl to expire in seconds| +|reply\_to\_message\_id|[int53](../types/int53.md) | Yes|If non-zero, identifier of the message this message replies to, can be identifier of deleted message| +|ttl|[int](../types/int.md) | Yes|Message TTL in seconds, 0 if none. TDLib will send updateDeleteMessages or updateMessageContent when TTL expires| +|ttl\_expires\_in|[double](../types/double.md) | Yes|Time left for message TTL to expire in seconds| |via\_bot\_user\_id|[int](../types/int.md) | Yes|If non-zero, user identifier of the bot this message is sent via| +|author\_signature|[string](../types/string.md) | Yes|For channel posts, optional author signature| |views|[int](../types/int.md) | Yes|Number of times this message was viewed| |content|[MessageContent](../types/MessageContent.md) | Yes|Content of the message| |reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Reply markup for the message, nullable| diff --git a/docs/TD_docs/constructors/messageAudio.md b/docs/TD_docs/constructors/messageAudio.md index 324afa7c..8e94d7c7 100644 --- a/docs/TD_docs/constructors/messageAudio.md +++ b/docs/TD_docs/constructors/messageAudio.md @@ -15,7 +15,6 @@ Audio message |----------|---------------|----------|-------------| |audio|[audio](../types/audio.md) | Yes|Message content| |caption|[string](../types/string.md) | Yes|Audio caption| -|is\_listened|[Bool](../types/Bool.md) | Yes|True, if the audio message was listened to| diff --git a/docs/TD_docs/constructors/messageCall.md b/docs/TD_docs/constructors/messageCall.md new file mode 100644 index 00000000..9ad524bf --- /dev/null +++ b/docs/TD_docs/constructors/messageCall.md @@ -0,0 +1,23 @@ +--- +title: messageCall +description: Message with an information about ended call +--- +## Constructor: messageCall +[Back to constructors index](index.md) + + + +Message with an information about ended call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|discard\_reason|[CallDiscardReason](../types/CallDiscardReason.md) | Yes|Call discard reason| +|duration|[int](../types/int.md) | Yes|Call duration in seconds| + + + +### Type: [MessageContent](../types/MessageContent.md) + + diff --git a/docs/TD_docs/constructors/messageChatAddMembers.md b/docs/TD_docs/constructors/messageChatAddMembers.md index a462de8d..e5c7ab9d 100644 --- a/docs/TD_docs/constructors/messageChatAddMembers.md +++ b/docs/TD_docs/constructors/messageChatAddMembers.md @@ -13,7 +13,7 @@ Chat members added | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|members|Array of [user](../constructors/user.md) | Yes|New chat member| +|member\_user\_ids|Array of [int](../constructors/int.md) | Yes|User identifiers of new chat members| diff --git a/docs/TD_docs/constructors/messageChatDeleteMember.md b/docs/TD_docs/constructors/messageChatDeleteMember.md index 773f1b3e..b137e625 100644 --- a/docs/TD_docs/constructors/messageChatDeleteMember.md +++ b/docs/TD_docs/constructors/messageChatDeleteMember.md @@ -13,7 +13,7 @@ Chat member deleted | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user|[user](../types/user.md) | Yes|Left or kicked chat member| +|user\_id|[int](../types/int.md) | Yes|User identifier of deleted chat memeber| diff --git a/docs/TD_docs/constructors/messageContactRegistered.md b/docs/TD_docs/constructors/messageContactRegistered.md new file mode 100644 index 00000000..8b744518 --- /dev/null +++ b/docs/TD_docs/constructors/messageContactRegistered.md @@ -0,0 +1,21 @@ +--- +title: messageContactRegistered +description: Contact has registered +--- +## Constructor: messageContactRegistered +[Back to constructors index](index.md) + + + +Contact has registered + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [MessageContent](../types/MessageContent.md) + + diff --git a/docs/TD_docs/constructors/messageEntityBold.md b/docs/TD_docs/constructors/messageEntityBold.md deleted file mode 100644 index 0bc4a13a..00000000 --- a/docs/TD_docs/constructors/messageEntityBold.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: messageEntityBold -description: Bold text ---- -## Constructor: messageEntityBold -[Back to constructors index](index.md) - - - -Bold text - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| - - - -### Type: [MessageEntity](../types/MessageEntity.md) - - diff --git a/docs/TD_docs/constructors/messageEntityEmail.md b/docs/TD_docs/constructors/messageEntityEmail.md deleted file mode 100644 index 39829c08..00000000 --- a/docs/TD_docs/constructors/messageEntityEmail.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: messageEntityEmail -description: Email ---- -## Constructor: messageEntityEmail -[Back to constructors index](index.md) - - - -Email - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| - - - -### Type: [MessageEntity](../types/MessageEntity.md) - - diff --git a/docs/TD_docs/constructors/messageEntityHashtag.md b/docs/TD_docs/constructors/messageEntityHashtag.md deleted file mode 100644 index 96f89145..00000000 --- a/docs/TD_docs/constructors/messageEntityHashtag.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: messageEntityHashtag -description: Hashtag beginning with # ---- -## Constructor: messageEntityHashtag -[Back to constructors index](index.md) - - - -Hashtag beginning with # - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| - - - -### Type: [MessageEntity](../types/MessageEntity.md) - - diff --git a/docs/TD_docs/constructors/messageEntityItalic.md b/docs/TD_docs/constructors/messageEntityItalic.md deleted file mode 100644 index 9a12697b..00000000 --- a/docs/TD_docs/constructors/messageEntityItalic.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: messageEntityItalic -description: Italic text ---- -## Constructor: messageEntityItalic -[Back to constructors index](index.md) - - - -Italic text - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| - - - -### Type: [MessageEntity](../types/MessageEntity.md) - - diff --git a/docs/TD_docs/constructors/messageEntityMention.md b/docs/TD_docs/constructors/messageEntityMention.md deleted file mode 100644 index 5b1995f0..00000000 --- a/docs/TD_docs/constructors/messageEntityMention.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: messageEntityMention -description: Mention of the user by his username ---- -## Constructor: messageEntityMention -[Back to constructors index](index.md) - - - -Mention of the user by his username - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| - - - -### Type: [MessageEntity](../types/MessageEntity.md) - - diff --git a/docs/TD_docs/constructors/messageEntityUrl.md b/docs/TD_docs/constructors/messageEntityUrl.md deleted file mode 100644 index 6dfb73e3..00000000 --- a/docs/TD_docs/constructors/messageEntityUrl.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: messageEntityUrl -description: Url beginning with http ---- -## Constructor: messageEntityUrl -[Back to constructors index](index.md) - - - -Url beginning with http - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| - - - -### Type: [MessageEntity](../types/MessageEntity.md) - - diff --git a/docs/TD_docs/constructors/messageExpiredPhoto.md b/docs/TD_docs/constructors/messageExpiredPhoto.md new file mode 100644 index 00000000..873d2f36 --- /dev/null +++ b/docs/TD_docs/constructors/messageExpiredPhoto.md @@ -0,0 +1,21 @@ +--- +title: messageExpiredPhoto +description: Photo message expired by TTL +--- +## Constructor: messageExpiredPhoto +[Back to constructors index](index.md) + + + +Photo message expired by TTL + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [MessageContent](../types/MessageContent.md) + + diff --git a/docs/TD_docs/constructors/messageExpiredVideo.md b/docs/TD_docs/constructors/messageExpiredVideo.md new file mode 100644 index 00000000..2781a717 --- /dev/null +++ b/docs/TD_docs/constructors/messageExpiredVideo.md @@ -0,0 +1,21 @@ +--- +title: messageExpiredVideo +description: Video message expired by TTL +--- +## Constructor: messageExpiredVideo +[Back to constructors index](index.md) + + + +Video message expired by TTL + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [MessageContent](../types/MessageContent.md) + + diff --git a/docs/TD_docs/constructors/messageForwardedPost.md b/docs/TD_docs/constructors/messageForwardedPost.md index 00d01057..3fd52ad3 100644 --- a/docs/TD_docs/constructors/messageForwardedPost.md +++ b/docs/TD_docs/constructors/messageForwardedPost.md @@ -13,10 +13,10 @@ Message is orifinally a channel post | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Identifier of a chat from which message is forwarded| -|sender\_user\_id|[int](../types/int.md) | Yes|User identifier of the original message sender, 0 if unknown| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of a chat from which message is forwarded| +|author\_signature|[string](../types/string.md) | Yes|Post author signature| |date|[int](../types/int.md) | Yes|Date when message was originally sent| -|message\_id|[long](../types/long.md) | Yes|Message identifier of the message from which the message is forwarded, 0 if unknown| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier of the message from which the message is forwarded, 0 if unknown| diff --git a/docs/TD_docs/constructors/messageGameScore.md b/docs/TD_docs/constructors/messageGameScore.md index 462c669f..0b2a620d 100644 --- a/docs/TD_docs/constructors/messageGameScore.md +++ b/docs/TD_docs/constructors/messageGameScore.md @@ -13,7 +13,7 @@ New high score was achieved in a game | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|game\_message\_id|[long](../types/long.md) | Yes|Identifier of the message with the game, can be identifier of the deleted message| +|game\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message with the game, can be identifier of the deleted message| |game\_id|[long](../types/long.md) | Yes|Identifier of the game, may be different from the games presented in the message with the game| |score|[int](../types/int.md) | Yes|New score| diff --git a/docs/TD_docs/constructors/messageGroupChatCreate.md b/docs/TD_docs/constructors/messageGroupChatCreate.md index 3eda672a..a3670adf 100644 --- a/docs/TD_docs/constructors/messageGroupChatCreate.md +++ b/docs/TD_docs/constructors/messageGroupChatCreate.md @@ -14,7 +14,7 @@ New group chat created | Name | Type | Required | Description | |----------|---------------|----------|-------------| |title|[string](../types/string.md) | Yes|Title of created group chat| -|members|Array of [user](../constructors/user.md) | Yes|Parcticipants of created group chat| +|member\_user\_ids|Array of [int](../constructors/int.md) | Yes|User identifiers of members of created group chat| diff --git a/docs/TD_docs/constructors/messageInvoice.md b/docs/TD_docs/constructors/messageInvoice.md new file mode 100644 index 00000000..6bc4ed3b --- /dev/null +++ b/docs/TD_docs/constructors/messageInvoice.md @@ -0,0 +1,30 @@ +--- +title: messageInvoice +description: Message with an invoice from a bot +--- +## Constructor: messageInvoice +[Back to constructors index](index.md) + + + +Message with an invoice from a bot + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[string](../types/string.md) | Yes|Goods title| +|description|[string](../types/string.md) | Yes|Goods description| +|photo|[photo](../types/photo.md) | Yes|Goods photo, nullable| +|currency|[string](../types/string.md) | Yes|Currency for goods price| +|total\_amount|[int53](../types/int53.md) | Yes|Goods total price in minimal quantity of the currency| +|start\_parameter|[string](../types/string.md) | Yes|Unique invoice bot start_parameter. To share an invoice use a URL https: t.me/{bot_username}?start={start_parameter}| +|is\_test|[Bool](../types/Bool.md) | Yes|True, if invoice is test| +|need\_shipping\_address|[Bool](../types/Bool.md) | Yes|True, if shipping address should be specified| +|receipt\_message\_id|[int53](../types/int53.md) | Yes|Identifier of message with receipt after the goods are paid| + + + +### Type: [MessageContent](../types/MessageContent.md) + + diff --git a/docs/TD_docs/constructors/messagePaymentSuccessful.md b/docs/TD_docs/constructors/messagePaymentSuccessful.md new file mode 100644 index 00000000..81955221 --- /dev/null +++ b/docs/TD_docs/constructors/messagePaymentSuccessful.md @@ -0,0 +1,23 @@ +--- +title: messagePaymentSuccessful +description: Payment completed +--- +## Constructor: messagePaymentSuccessful +[Back to constructors index](index.md) + + + +Payment completed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|currency|[string](../types/string.md) | Yes|Currency for goods price| +|total\_amount|[int53](../types/int53.md) | Yes|Goods total price in minimal quantity of the currency| + + + +### Type: [MessageContent](../types/MessageContent.md) + + diff --git a/docs/TD_docs/constructors/messagePaymentSuccessfulBot.md b/docs/TD_docs/constructors/messagePaymentSuccessfulBot.md new file mode 100644 index 00000000..3dc9df0f --- /dev/null +++ b/docs/TD_docs/constructors/messagePaymentSuccessfulBot.md @@ -0,0 +1,28 @@ +--- +title: messagePaymentSuccessfulBot +description: Bots only. Payment completed +--- +## Constructor: messagePaymentSuccessfulBot +[Back to constructors index](index.md) + + + +Bots only. Payment completed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|currency|[string](../types/string.md) | Yes|Currency for goods price| +|total\_amount|[int53](../types/int53.md) | Yes|Goods total price in minimal quantity of the currency| +|invoice\_payload|[bytes](../types/bytes.md) | Yes|Invoice payload| +|shipping\_option\_id|[string](../types/string.md) | Yes|Identifier of a choosed by user shipping option, may be empty if not applicable| +|order\_info|[orderInfo](../types/orderInfo.md) | Yes|Information about the order, nullable| +|telegram\_payment\_charge\_id|[string](../types/string.md) | Yes|Telegram payment identifier| +|provider\_payment\_charge\_id|[string](../types/string.md) | Yes|Provider payment identifier| + + + +### Type: [MessageContent](../types/MessageContent.md) + + diff --git a/docs/TD_docs/constructors/messagePinMessage.md b/docs/TD_docs/constructors/messagePinMessage.md index ac2351bb..06175ce8 100644 --- a/docs/TD_docs/constructors/messagePinMessage.md +++ b/docs/TD_docs/constructors/messagePinMessage.md @@ -13,7 +13,7 @@ Some message was pinned | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message\_id|[long](../types/long.md) | Yes|Identifier of the pinned message, can be identifier of the deleted message| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the pinned message, can be identifier of the deleted message| diff --git a/docs/TD_docs/constructors/messageScreenshotTaken.md b/docs/TD_docs/constructors/messageScreenshotTaken.md index 61d97c69..e206fce8 100644 --- a/docs/TD_docs/constructors/messageScreenshotTaken.md +++ b/docs/TD_docs/constructors/messageScreenshotTaken.md @@ -1,13 +1,13 @@ --- title: messageScreenshotTaken -description: Screenshot of messages in secret chat was taken +description: Screenshot of messages in the chat was taken --- ## Constructor: messageScreenshotTaken [Back to constructors index](index.md) -Screenshot of messages in secret chat was taken +Screenshot of messages in the chat was taken ### Attributes: diff --git a/docs/TD_docs/constructors/messageText.md b/docs/TD_docs/constructors/messageText.md index 6d8d9df1..0b423145 100644 --- a/docs/TD_docs/constructors/messageText.md +++ b/docs/TD_docs/constructors/messageText.md @@ -14,7 +14,7 @@ Text message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |text|[string](../types/string.md) | Yes|Text of the message| -|entities|Array of [MessageEntity](../constructors/MessageEntity.md) | Yes|Entities contained in the text| +|entities|Array of [textEntity](../constructors/textEntity.md) | Yes|Entities contained in the text| |web\_page|[webPage](../types/webPage.md) | Yes|Preview of a web page mentioned in the text, nullable| diff --git a/docs/TD_docs/constructors/messageVideoNote.md b/docs/TD_docs/constructors/messageVideoNote.md new file mode 100644 index 00000000..31dc321b --- /dev/null +++ b/docs/TD_docs/constructors/messageVideoNote.md @@ -0,0 +1,23 @@ +--- +title: messageVideoNote +description: Video note message +--- +## Constructor: messageVideoNote +[Back to constructors index](index.md) + + + +Video note message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|video\_note|[videoNote](../types/videoNote.md) | Yes|Message content| +|is\_viewed|[Bool](../types/Bool.md) | Yes|True, if the video note message was viewed| + + + +### Type: [MessageContent](../types/MessageContent.md) + + diff --git a/docs/TD_docs/constructors/networkStatistics.md b/docs/TD_docs/constructors/networkStatistics.md new file mode 100644 index 00000000..3406b42e --- /dev/null +++ b/docs/TD_docs/constructors/networkStatistics.md @@ -0,0 +1,23 @@ +--- +title: networkStatistics +description: Full list of available network statistics entries +--- +## Constructor: networkStatistics +[Back to constructors index](index.md) + + + +Full list of available network statistics entries + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|since\_date|[int](../types/int.md) | Yes|Date since which statistics are collected, unix time| +|entries|Array of [NetworkStatisticsEntry](../constructors/NetworkStatisticsEntry.md) | Yes|Network statistics entries| + + + +### Type: [NetworkStatistics](../types/NetworkStatistics.md) + + diff --git a/docs/TD_docs/constructors/networkStatisticsEntryCall.md b/docs/TD_docs/constructors/networkStatisticsEntryCall.md new file mode 100644 index 00000000..974be55e --- /dev/null +++ b/docs/TD_docs/constructors/networkStatisticsEntryCall.md @@ -0,0 +1,25 @@ +--- +title: networkStatisticsEntryCall +description: Contains information about total received and sent calls data +--- +## Constructor: networkStatisticsEntryCall +[Back to constructors index](index.md) + + + +Contains information about total received and sent calls data + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|network\_type|[NetworkType](../types/NetworkType.md) | Yes|Type of a network the data was sent through. Call setNetworkType to maintain actual network type| +|sent\_bytes|[int53](../types/int53.md) | Yes|Total number of sent bytes| +|received\_bytes|[int53](../types/int53.md) | Yes|Total number of received bytes| +|duration|[double](../types/double.md) | Yes|Total calls duration in seconds| + + + +### Type: [NetworkStatisticsEntry](../types/NetworkStatisticsEntry.md) + + diff --git a/docs/TD_docs/constructors/networkStatisticsEntryFile.md b/docs/TD_docs/constructors/networkStatisticsEntryFile.md new file mode 100644 index 00000000..f5c46b0f --- /dev/null +++ b/docs/TD_docs/constructors/networkStatisticsEntryFile.md @@ -0,0 +1,25 @@ +--- +title: networkStatisticsEntryFile +description: Contains information about total received and sent files data +--- +## Constructor: networkStatisticsEntryFile +[Back to constructors index](index.md) + + + +Contains information about total received and sent files data + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file\_type|[FileType](../types/FileType.md) | Yes|Type of a file the data is part of| +|network\_type|[NetworkType](../types/NetworkType.md) | Yes|Type of a network the data was sent through. Call setNetworkType to maintain actual network type| +|sent\_bytes|[int53](../types/int53.md) | Yes|Total number of sent bytes| +|received\_bytes|[int53](../types/int53.md) | Yes|Total number of received bytes| + + + +### Type: [NetworkStatisticsEntry](../types/NetworkStatisticsEntry.md) + + diff --git a/docs/TD_docs/constructors/networkTypeMobile.md b/docs/TD_docs/constructors/networkTypeMobile.md new file mode 100644 index 00000000..76a9d8f8 --- /dev/null +++ b/docs/TD_docs/constructors/networkTypeMobile.md @@ -0,0 +1,21 @@ +--- +title: networkTypeMobile +description: Mobile network +--- +## Constructor: networkTypeMobile +[Back to constructors index](index.md) + + + +Mobile network + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [NetworkType](../types/NetworkType.md) + + diff --git a/docs/TD_docs/constructors/networkTypeMobileRoaming.md b/docs/TD_docs/constructors/networkTypeMobileRoaming.md new file mode 100644 index 00000000..ac7ed506 --- /dev/null +++ b/docs/TD_docs/constructors/networkTypeMobileRoaming.md @@ -0,0 +1,21 @@ +--- +title: networkTypeMobileRoaming +description: Mobile roaming network +--- +## Constructor: networkTypeMobileRoaming +[Back to constructors index](index.md) + + + +Mobile roaming network + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [NetworkType](../types/NetworkType.md) + + diff --git a/docs/TD_docs/constructors/networkTypeNone.md b/docs/TD_docs/constructors/networkTypeNone.md new file mode 100644 index 00000000..ca1157a8 --- /dev/null +++ b/docs/TD_docs/constructors/networkTypeNone.md @@ -0,0 +1,21 @@ +--- +title: networkTypeNone +description: Network is not available +--- +## Constructor: networkTypeNone +[Back to constructors index](index.md) + + + +Network is not available + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [NetworkType](../types/NetworkType.md) + + diff --git a/docs/TD_docs/constructors/networkTypeOther.md b/docs/TD_docs/constructors/networkTypeOther.md new file mode 100644 index 00000000..b99cef2c --- /dev/null +++ b/docs/TD_docs/constructors/networkTypeOther.md @@ -0,0 +1,21 @@ +--- +title: networkTypeOther +description: Other network type, for example, Ethernet network +--- +## Constructor: networkTypeOther +[Back to constructors index](index.md) + + + +Other network type, for example, Ethernet network + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [NetworkType](../types/NetworkType.md) + + diff --git a/docs/TD_docs/constructors/networkTypeWiFi.md b/docs/TD_docs/constructors/networkTypeWiFi.md new file mode 100644 index 00000000..d641d1e0 --- /dev/null +++ b/docs/TD_docs/constructors/networkTypeWiFi.md @@ -0,0 +1,21 @@ +--- +title: networkTypeWiFi +description: Wi-Fi network +--- +## Constructor: networkTypeWiFi +[Back to constructors index](index.md) + + + +Wi-Fi network + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [NetworkType](../types/NetworkType.md) + + diff --git a/docs/TD_docs/constructors/notificationSettings.md b/docs/TD_docs/constructors/notificationSettings.md index 2836345d..071aa23b 100644 --- a/docs/TD_docs/constructors/notificationSettings.md +++ b/docs/TD_docs/constructors/notificationSettings.md @@ -13,7 +13,7 @@ Contains information about notification settings for chat or chats | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|mute\_for|[int](../types/int.md) | Yes|Time left before notifications will be unmuted| +|mute\_for|[int](../types/int.md) | Yes|Time left before notifications will be unmuted, seconds| |sound|[string](../types/string.md) | Yes|Audio file name for notifications, iPhone apps only| |show\_preview|[Bool](../types/Bool.md) | Yes|Display message text/media in notification| diff --git a/docs/TD_docs/constructors/notificationSettingsForAllChats.md b/docs/TD_docs/constructors/notificationSettingsScopeAllChats.md similarity index 79% rename from docs/TD_docs/constructors/notificationSettingsForAllChats.md rename to docs/TD_docs/constructors/notificationSettingsScopeAllChats.md index 63d6aa9b..c4c1e163 100644 --- a/docs/TD_docs/constructors/notificationSettingsForAllChats.md +++ b/docs/TD_docs/constructors/notificationSettingsScopeAllChats.md @@ -1,8 +1,8 @@ --- -title: notificationSettingsForAllChats +title: notificationSettingsScopeAllChats description: Notification settings applied to all chats --- -## Constructor: notificationSettingsForAllChats +## Constructor: notificationSettingsScopeAllChats [Back to constructors index](index.md) diff --git a/docs/TD_docs/constructors/notificationSettingsForChat.md b/docs/TD_docs/constructors/notificationSettingsScopeChat.md similarity index 71% rename from docs/TD_docs/constructors/notificationSettingsForChat.md rename to docs/TD_docs/constructors/notificationSettingsScopeChat.md index 1a86b9c1..eeaf7b1c 100644 --- a/docs/TD_docs/constructors/notificationSettingsForChat.md +++ b/docs/TD_docs/constructors/notificationSettingsScopeChat.md @@ -1,8 +1,8 @@ --- -title: notificationSettingsForChat +title: notificationSettingsScopeChat description: Notification settings applied to particular chat --- -## Constructor: notificationSettingsForChat +## Constructor: notificationSettingsScopeChat [Back to constructors index](index.md) @@ -13,7 +13,7 @@ Notification settings applied to particular chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| diff --git a/docs/TD_docs/constructors/notificationSettingsForGroupChats.md b/docs/TD_docs/constructors/notificationSettingsScopeGroupChats.md similarity index 83% rename from docs/TD_docs/constructors/notificationSettingsForGroupChats.md rename to docs/TD_docs/constructors/notificationSettingsScopeGroupChats.md index ed290a6a..abf24e0d 100644 --- a/docs/TD_docs/constructors/notificationSettingsForGroupChats.md +++ b/docs/TD_docs/constructors/notificationSettingsScopeGroupChats.md @@ -1,8 +1,8 @@ --- -title: notificationSettingsForGroupChats +title: notificationSettingsScopeGroupChats description: Notification settings applied to all group and broadcast channel chats (supergroup channels have no common settings) --- -## Constructor: notificationSettingsForGroupChats +## Constructor: notificationSettingsScopeGroupChats [Back to constructors index](index.md) diff --git a/docs/TD_docs/constructors/notificationSettingsForPrivateChats.md b/docs/TD_docs/constructors/notificationSettingsScopePrivateChats.md similarity index 78% rename from docs/TD_docs/constructors/notificationSettingsForPrivateChats.md rename to docs/TD_docs/constructors/notificationSettingsScopePrivateChats.md index f4ece9ce..710712b8 100644 --- a/docs/TD_docs/constructors/notificationSettingsForPrivateChats.md +++ b/docs/TD_docs/constructors/notificationSettingsScopePrivateChats.md @@ -1,8 +1,8 @@ --- -title: notificationSettingsForPrivateChats +title: notificationSettingsScopePrivateChats description: Notification settings applied to all private chats --- -## Constructor: notificationSettingsForPrivateChats +## Constructor: notificationSettingsScopePrivateChats [Back to constructors index](index.md) diff --git a/docs/TD_docs/constructors/optionBoolean.md b/docs/TD_docs/constructors/optionValueBoolean.md similarity index 84% rename from docs/TD_docs/constructors/optionBoolean.md rename to docs/TD_docs/constructors/optionValueBoolean.md index cfa61f44..c4e013eb 100644 --- a/docs/TD_docs/constructors/optionBoolean.md +++ b/docs/TD_docs/constructors/optionValueBoolean.md @@ -1,8 +1,8 @@ --- -title: optionBoolean +title: optionValueBoolean description: Boolean option --- -## Constructor: optionBoolean +## Constructor: optionValueBoolean [Back to constructors index](index.md) diff --git a/docs/TD_docs/constructors/optionEmpty.md b/docs/TD_docs/constructors/optionValueEmpty.md similarity index 85% rename from docs/TD_docs/constructors/optionEmpty.md rename to docs/TD_docs/constructors/optionValueEmpty.md index 40190818..f0203680 100644 --- a/docs/TD_docs/constructors/optionEmpty.md +++ b/docs/TD_docs/constructors/optionValueEmpty.md @@ -1,8 +1,8 @@ --- -title: optionEmpty +title: optionValueEmpty description: Unknown option or option having default value --- -## Constructor: optionEmpty +## Constructor: optionValueEmpty [Back to constructors index](index.md) diff --git a/docs/TD_docs/constructors/optionInteger.md b/docs/TD_docs/constructors/optionValueInteger.md similarity index 83% rename from docs/TD_docs/constructors/optionInteger.md rename to docs/TD_docs/constructors/optionValueInteger.md index c51cca81..c2c994a5 100644 --- a/docs/TD_docs/constructors/optionInteger.md +++ b/docs/TD_docs/constructors/optionValueInteger.md @@ -1,8 +1,8 @@ --- -title: optionInteger +title: optionValueInteger description: Integer option --- -## Constructor: optionInteger +## Constructor: optionValueInteger [Back to constructors index](index.md) diff --git a/docs/TD_docs/constructors/optionString.md b/docs/TD_docs/constructors/optionValueString.md similarity index 84% rename from docs/TD_docs/constructors/optionString.md rename to docs/TD_docs/constructors/optionValueString.md index 3be15016..9cfbf24f 100644 --- a/docs/TD_docs/constructors/optionString.md +++ b/docs/TD_docs/constructors/optionValueString.md @@ -1,8 +1,8 @@ --- -title: optionString +title: optionValueString description: String option --- -## Constructor: optionString +## Constructor: optionValueString [Back to constructors index](index.md) diff --git a/docs/TD_docs/constructors/orderInfo.md b/docs/TD_docs/constructors/orderInfo.md new file mode 100644 index 00000000..389e6c50 --- /dev/null +++ b/docs/TD_docs/constructors/orderInfo.md @@ -0,0 +1,25 @@ +--- +title: orderInfo +description: Order information +--- +## Constructor: orderInfo +[Back to constructors index](index.md) + + + +Order information + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|name|[string](../types/string.md) | Yes|User name| +|phone\_number|[string](../types/string.md) | Yes|User's phone number| +|email|[string](../types/string.md) | Yes|User email| +|shipping\_address|[shippingAddress](../types/shippingAddress.md) | Yes|User shipping address, nullable| + + + +### Type: [OrderInfo](../types/OrderInfo.md) + + diff --git a/docs/TD_docs/constructors/pageBlockAnchor.md b/docs/TD_docs/constructors/pageBlockAnchor.md new file mode 100644 index 00000000..f13a5bdd --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockAnchor.md @@ -0,0 +1,22 @@ +--- +title: pageBlockAnchor +description: Invisible anchor on a page which can be used in a URL to open a page from the specified anchor +--- +## Constructor: pageBlockAnchor +[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: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|name|[string](../types/string.md) | Yes|Name of the anchor| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockAnimation.md b/docs/TD_docs/constructors/pageBlockAnimation.md new file mode 100644 index 00000000..b546eec5 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockAnimation.md @@ -0,0 +1,24 @@ +--- +title: pageBlockAnimation +description: An animation +--- +## Constructor: pageBlockAnimation +[Back to constructors index](index.md) + + + +An animation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|animation|[animation](../types/animation.md) | Yes|The animation, nullable| +|caption|[RichText](../types/RichText.md) | Yes|Animation caption| +|need\_autoplay|[Bool](../types/Bool.md) | Yes|True, if the animation should be autoplayed| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockAudio.md b/docs/TD_docs/constructors/pageBlockAudio.md new file mode 100644 index 00000000..8ea4fa84 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockAudio.md @@ -0,0 +1,23 @@ +--- +title: pageBlockAudio +description: An audio +--- +## Constructor: pageBlockAudio +[Back to constructors index](index.md) + + + +An audio + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|audio|[audio](../types/audio.md) | Yes|The audio, nullable| +|caption|[RichText](../types/RichText.md) | Yes|Audio caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockAuthorDate.md b/docs/TD_docs/constructors/pageBlockAuthorDate.md new file mode 100644 index 00000000..2a4a6274 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockAuthorDate.md @@ -0,0 +1,23 @@ +--- +title: pageBlockAuthorDate +description: Author and publish date of a page +--- +## Constructor: pageBlockAuthorDate +[Back to constructors index](index.md) + + + +Author and publish date of a page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|author|[RichText](../types/RichText.md) | Yes|The author| +|publish\_date|[int](../types/int.md) | Yes|Date of article publish, unix time. 0 if unknown| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockBlockQuote.md b/docs/TD_docs/constructors/pageBlockBlockQuote.md new file mode 100644 index 00000000..9ec58a18 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockBlockQuote.md @@ -0,0 +1,23 @@ +--- +title: pageBlockBlockQuote +description: Block quote +--- +## Constructor: pageBlockBlockQuote +[Back to constructors index](index.md) + + + +Block quote + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Quote text| +|caption|[RichText](../types/RichText.md) | Yes|Quote caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockChatLink.md b/docs/TD_docs/constructors/pageBlockChatLink.md new file mode 100644 index 00000000..cd780939 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockChatLink.md @@ -0,0 +1,24 @@ +--- +title: pageBlockChatLink +description: A link to a chat +--- +## Constructor: pageBlockChatLink +[Back to constructors index](index.md) + + + +A link to a chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[string](../types/string.md) | Yes|Chat title| +|photo|[chatPhoto](../types/chatPhoto.md) | Yes|Chat photo, nullable| +|username|[string](../types/string.md) | Yes|Chat username by which all other information about the chat should be resolved| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockCollage.md b/docs/TD_docs/constructors/pageBlockCollage.md new file mode 100644 index 00000000..95b9539a --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockCollage.md @@ -0,0 +1,23 @@ +--- +title: pageBlockCollage +description: A collage +--- +## Constructor: pageBlockCollage +[Back to constructors index](index.md) + + + +A collage + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|page\_blocks|Array of [PageBlock](../constructors/PageBlock.md) | Yes|Collage item contents| +|caption|[RichText](../types/RichText.md) | Yes|Block caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockCover.md b/docs/TD_docs/constructors/pageBlockCover.md new file mode 100644 index 00000000..679dd627 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockCover.md @@ -0,0 +1,22 @@ +--- +title: pageBlockCover +description: Page cover +--- +## Constructor: pageBlockCover +[Back to constructors index](index.md) + + + +Page cover + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|cover|[PageBlock](../types/PageBlock.md) | Yes|The cover| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockDivider.md b/docs/TD_docs/constructors/pageBlockDivider.md new file mode 100644 index 00000000..c3597567 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockDivider.md @@ -0,0 +1,21 @@ +--- +title: pageBlockDivider +description: An empty block separating parts of a page +--- +## Constructor: pageBlockDivider +[Back to constructors index](index.md) + + + +An empty block separating parts of a page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockEmbedded.md b/docs/TD_docs/constructors/pageBlockEmbedded.md new file mode 100644 index 00000000..72f1e3e5 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockEmbedded.md @@ -0,0 +1,29 @@ +--- +title: pageBlockEmbedded +description: Embedded web page +--- +## Constructor: pageBlockEmbedded +[Back to constructors index](index.md) + + + +Embedded web page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Web page URL, if available| +|html|[string](../types/string.md) | Yes|HTML-markup of the embedded page| +|poster\_photo|[photo](../types/photo.md) | Yes|Poster photo if available, nullable| +|width|[int](../types/int.md) | Yes|Block width| +|height|[int](../types/int.md) | Yes|Block height| +|caption|[RichText](../types/RichText.md) | Yes|Block caption| +|is\_full\_width|[Bool](../types/Bool.md) | Yes|True, if the block should be full width| +|allow\_scrolling|[Bool](../types/Bool.md) | Yes|True, if scrolling should be allowed| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockEmbeddedPost.md b/docs/TD_docs/constructors/pageBlockEmbeddedPost.md new file mode 100644 index 00000000..b185ea33 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockEmbeddedPost.md @@ -0,0 +1,27 @@ +--- +title: pageBlockEmbeddedPost +description: Embedded post +--- +## Constructor: pageBlockEmbeddedPost +[Back to constructors index](index.md) + + + +Embedded post + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Web page URL| +|author|[string](../types/string.md) | Yes|Post author| +|author\_photo|[photo](../types/photo.md) | Yes|Post author photo| +|date|[int](../types/int.md) | Yes|Post date, unix time. 0 if unknown| +|page\_blocks|Array of [PageBlock](../constructors/PageBlock.md) | Yes|Post content| +|caption|[RichText](../types/RichText.md) | Yes|Post caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockFooter.md b/docs/TD_docs/constructors/pageBlockFooter.md new file mode 100644 index 00000000..6f69395c --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockFooter.md @@ -0,0 +1,22 @@ +--- +title: pageBlockFooter +description: Footer of a page +--- +## Constructor: pageBlockFooter +[Back to constructors index](index.md) + + + +Footer of a page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|footer|[RichText](../types/RichText.md) | Yes|The footer| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockHeader.md b/docs/TD_docs/constructors/pageBlockHeader.md new file mode 100644 index 00000000..f723d5c0 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockHeader.md @@ -0,0 +1,22 @@ +--- +title: pageBlockHeader +description: A header +--- +## Constructor: pageBlockHeader +[Back to constructors index](index.md) + + + +A header + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|header|[RichText](../types/RichText.md) | Yes|The header| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockList.md b/docs/TD_docs/constructors/pageBlockList.md new file mode 100644 index 00000000..65cc5eb1 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockList.md @@ -0,0 +1,23 @@ +--- +title: pageBlockList +description: List of texts +--- +## Constructor: pageBlockList +[Back to constructors index](index.md) + + + +List of texts + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|items|Array of [RichText](../constructors/RichText.md) | Yes|Texts| +|is\_ordered|[Bool](../types/Bool.md) | Yes|True, if items should be marked with numbers| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockParagraph.md b/docs/TD_docs/constructors/pageBlockParagraph.md new file mode 100644 index 00000000..c30f7606 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockParagraph.md @@ -0,0 +1,22 @@ +--- +title: pageBlockParagraph +description: A text paragraph +--- +## Constructor: pageBlockParagraph +[Back to constructors index](index.md) + + + +A text paragraph + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Paragraph text| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockPhoto.md b/docs/TD_docs/constructors/pageBlockPhoto.md new file mode 100644 index 00000000..7a959bcd --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockPhoto.md @@ -0,0 +1,23 @@ +--- +title: pageBlockPhoto +description: A photo +--- +## Constructor: pageBlockPhoto +[Back to constructors index](index.md) + + + +A photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|photo|[photo](../types/photo.md) | Yes|The photo, nullable| +|caption|[RichText](../types/RichText.md) | Yes|Photo caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockPreformatted.md b/docs/TD_docs/constructors/pageBlockPreformatted.md new file mode 100644 index 00000000..c442ca2e --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockPreformatted.md @@ -0,0 +1,23 @@ +--- +title: pageBlockPreformatted +description: Preformatted text paragraph +--- +## Constructor: pageBlockPreformatted +[Back to constructors index](index.md) + + + +Preformatted text paragraph + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Paragraph text| +|language|[string](../types/string.md) | Yes|Programming language for which the text should be formatted| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockPullQuote.md b/docs/TD_docs/constructors/pageBlockPullQuote.md new file mode 100644 index 00000000..434d4893 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockPullQuote.md @@ -0,0 +1,23 @@ +--- +title: pageBlockPullQuote +description: Pull quote +--- +## Constructor: pageBlockPullQuote +[Back to constructors index](index.md) + + + +Pull quote + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Quote text| +|caption|[RichText](../types/RichText.md) | Yes|Quote caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockSlideshow.md b/docs/TD_docs/constructors/pageBlockSlideshow.md new file mode 100644 index 00000000..dd42d9df --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockSlideshow.md @@ -0,0 +1,23 @@ +--- +title: pageBlockSlideshow +description: A slideshow +--- +## Constructor: pageBlockSlideshow +[Back to constructors index](index.md) + + + +A slideshow + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|page\_blocks|Array of [PageBlock](../constructors/PageBlock.md) | Yes|Slideshow item contents| +|caption|[RichText](../types/RichText.md) | Yes|Block caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockSubheader.md b/docs/TD_docs/constructors/pageBlockSubheader.md new file mode 100644 index 00000000..61e6ff7d --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockSubheader.md @@ -0,0 +1,22 @@ +--- +title: pageBlockSubheader +description: A subheader +--- +## Constructor: pageBlockSubheader +[Back to constructors index](index.md) + + + +A subheader + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|subheader|[RichText](../types/RichText.md) | Yes|The subheader| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockSubtitle.md b/docs/TD_docs/constructors/pageBlockSubtitle.md new file mode 100644 index 00000000..bb336363 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockSubtitle.md @@ -0,0 +1,22 @@ +--- +title: pageBlockSubtitle +description: Subtitle of a page +--- +## Constructor: pageBlockSubtitle +[Back to constructors index](index.md) + + + +Subtitle of a page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|subtitle|[RichText](../types/RichText.md) | Yes|The subtitle| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockTitle.md b/docs/TD_docs/constructors/pageBlockTitle.md new file mode 100644 index 00000000..14f2350c --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockTitle.md @@ -0,0 +1,22 @@ +--- +title: pageBlockTitle +description: Title of a page +--- +## Constructor: pageBlockTitle +[Back to constructors index](index.md) + + + +Title of a page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[RichText](../types/RichText.md) | Yes|The title| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/pageBlockVideo.md b/docs/TD_docs/constructors/pageBlockVideo.md new file mode 100644 index 00000000..9754fac3 --- /dev/null +++ b/docs/TD_docs/constructors/pageBlockVideo.md @@ -0,0 +1,25 @@ +--- +title: pageBlockVideo +description: A video +--- +## Constructor: pageBlockVideo +[Back to constructors index](index.md) + + + +A video + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|video|[video](../types/video.md) | Yes|The video, nullable| +|caption|[RichText](../types/RichText.md) | Yes|Video caption| +|need\_autoplay|[Bool](../types/Bool.md) | Yes|True, if the video should be autoplayed| +|is\_looped|[Bool](../types/Bool.md) | Yes|True, if the video is looped| + + + +### Type: [PageBlock](../types/PageBlock.md) + + diff --git a/docs/TD_docs/constructors/paymentForm.md b/docs/TD_docs/constructors/paymentForm.md new file mode 100644 index 00000000..dd71c657 --- /dev/null +++ b/docs/TD_docs/constructors/paymentForm.md @@ -0,0 +1,28 @@ +--- +title: paymentForm +description: Information about invoice payment form +--- +## Constructor: paymentForm +[Back to constructors index](index.md) + + + +Information about invoice payment form + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|invoice|[invoice](../types/invoice.md) | Yes|Full information about the invoice| +|url|[string](../types/string.md) | Yes|Payment form URL| +|payments\_provider|[paymentsProviderStripe](../types/paymentsProviderStripe.md) | Yes|Information about payment provider if available, to support it natively without opening the URL, nullable| +|saved\_order\_info|[orderInfo](../types/orderInfo.md) | Yes|Saved server-side order information, nullable| +|saved\_credentials|[savedCredentials](../types/savedCredentials.md) | Yes|Information about saved card credentials, nullable| +|can\_save\_credentials|[Bool](../types/Bool.md) | Yes|True, if the user can choose to save credentials| +|need\_password|[Bool](../types/Bool.md) | Yes|True, if the user will be able to save credentials if he set up a password| + + + +### Type: [PaymentForm](../types/PaymentForm.md) + + diff --git a/docs/TD_docs/constructors/paymentReceipt.md b/docs/TD_docs/constructors/paymentReceipt.md new file mode 100644 index 00000000..6ec9af1a --- /dev/null +++ b/docs/TD_docs/constructors/paymentReceipt.md @@ -0,0 +1,27 @@ +--- +title: paymentReceipt +description: Contains information about successful payment +--- +## Constructor: paymentReceipt +[Back to constructors index](index.md) + + + +Contains information about successful payment + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|date|[int](../types/int.md) | Yes|Payment date, unix time| +|payments\_provider\_user\_id|[int](../types/int.md) | Yes|User identifier of payments provider bot| +|invoice|[invoice](../types/invoice.md) | Yes|Information about the invoice| +|order\_info|[orderInfo](../types/orderInfo.md) | Yes|Order information, nullable| +|shipping\_option|[shippingOption](../types/shippingOption.md) | Yes|Chosen shipping option, nullable| +|credentials\_title|[string](../types/string.md) | Yes|Title of the saved credentials| + + + +### Type: [PaymentReceipt](../types/PaymentReceipt.md) + + diff --git a/docs/TD_docs/constructors/paymentResult.md b/docs/TD_docs/constructors/paymentResult.md new file mode 100644 index 00000000..0a2ed6ad --- /dev/null +++ b/docs/TD_docs/constructors/paymentResult.md @@ -0,0 +1,23 @@ +--- +title: paymentResult +description: Contains result of a payment query +--- +## Constructor: paymentResult +[Back to constructors index](index.md) + + + +Contains result of a payment query + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|success|[Bool](../types/Bool.md) | Yes|True, if payment request was successful. If false, verification_url will be not empty| +|verification\_url|[string](../types/string.md) | Yes|Url for additional payments credentials verification| + + + +### Type: [PaymentResult](../types/PaymentResult.md) + + diff --git a/docs/TD_docs/constructors/paymentsProviderStripe.md b/docs/TD_docs/constructors/paymentsProviderStripe.md new file mode 100644 index 00000000..a615f66b --- /dev/null +++ b/docs/TD_docs/constructors/paymentsProviderStripe.md @@ -0,0 +1,25 @@ +--- +title: paymentsProviderStripe +description: Stripe payments provider +--- +## Constructor: paymentsProviderStripe +[Back to constructors index](index.md) + + + +Stripe payments provider + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|publishable\_key|[string](../types/string.md) | Yes|Stripe API publishable key| +|need\_country|[Bool](../types/Bool.md) | Yes|True, if user country should be entered| +|need\_zip|[Bool](../types/Bool.md) | Yes|True, if user zip code should be entered| +|need\_cardholder\_name|[Bool](../types/Bool.md) | Yes|True, if cardholder name should be entered| + + + +### Type: [PaymentsProviderStripe](../types/PaymentsProviderStripe.md) + + diff --git a/docs/TD_docs/constructors/privacyKeyCall.md b/docs/TD_docs/constructors/privacyKeyCall.md new file mode 100644 index 00000000..0b972d9b --- /dev/null +++ b/docs/TD_docs/constructors/privacyKeyCall.md @@ -0,0 +1,21 @@ +--- +title: privacyKeyCall +description: Privacy key for managing ability to call the user +--- +## Constructor: privacyKeyCall +[Back to constructors index](index.md) + + + +Privacy key for managing ability to call the user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + diff --git a/docs/TD_docs/constructors/privateChatInfo.md b/docs/TD_docs/constructors/privateChatInfo.md deleted file mode 100644 index 34744d22..00000000 --- a/docs/TD_docs/constructors/privateChatInfo.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: privateChatInfo -description: Ordinary chat with one user ---- -## Constructor: privateChatInfo -[Back to constructors index](index.md) - - - -Ordinary chat with one user - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user|[user](../types/user.md) | Yes|Information about interlocutor| - - - -### Type: [ChatInfo](../types/ChatInfo.md) - - diff --git a/docs/TD_docs/constructors/proxyEmpty.md b/docs/TD_docs/constructors/proxyEmpty.md new file mode 100644 index 00000000..c479858c --- /dev/null +++ b/docs/TD_docs/constructors/proxyEmpty.md @@ -0,0 +1,21 @@ +--- +title: proxyEmpty +description: An empty proxy +--- +## Constructor: proxyEmpty +[Back to constructors index](index.md) + + + +An empty proxy + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [Proxy](../types/Proxy.md) + + diff --git a/docs/TD_docs/constructors/proxySocks5.md b/docs/TD_docs/constructors/proxySocks5.md new file mode 100644 index 00000000..dae92581 --- /dev/null +++ b/docs/TD_docs/constructors/proxySocks5.md @@ -0,0 +1,25 @@ +--- +title: proxySocks5 +description: A SOCKS5 proxy +--- +## Constructor: proxySocks5 +[Back to constructors index](index.md) + + + +A SOCKS5 proxy + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|server|[string](../types/string.md) | Yes|Proxy server ip address| +|port|[int](../types/int.md) | Yes|Proxy server port| +|username|[string](../types/string.md) | Yes|Username to log in| +|password|[string](../types/string.md) | Yes|Password to log in| + + + +### Type: [Proxy](../types/Proxy.md) + + diff --git a/docs/TD_docs/constructors/publicMessageLink.md b/docs/TD_docs/constructors/publicMessageLink.md new file mode 100644 index 00000000..b8849d69 --- /dev/null +++ b/docs/TD_docs/constructors/publicMessageLink.md @@ -0,0 +1,22 @@ +--- +title: publicMessageLink +description: Contains public HTTPS link to a message in a public channel +--- +## Constructor: publicMessageLink +[Back to constructors index](index.md) + + + +Contains public HTTPS link to a message in a public channel + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|The link| + + + +### Type: [PublicMessageLink](../types/PublicMessageLink.md) + + diff --git a/docs/TD_docs/constructors/richTextBold.md b/docs/TD_docs/constructors/richTextBold.md new file mode 100644 index 00000000..f25341d2 --- /dev/null +++ b/docs/TD_docs/constructors/richTextBold.md @@ -0,0 +1,22 @@ +--- +title: richTextBold +description: Bold rich text +--- +## Constructor: richTextBold +[Back to constructors index](index.md) + + + +Bold rich text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|The text| + + + +### Type: [RichText](../types/RichText.md) + + diff --git a/docs/TD_docs/constructors/richTextConcatenation.md b/docs/TD_docs/constructors/richTextConcatenation.md new file mode 100644 index 00000000..90bd154a --- /dev/null +++ b/docs/TD_docs/constructors/richTextConcatenation.md @@ -0,0 +1,22 @@ +--- +title: richTextConcatenation +description: Concatenation of rich texts +--- +## Constructor: richTextConcatenation +[Back to constructors index](index.md) + + + +Concatenation of rich texts + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|texts|Array of [RichText](../constructors/RichText.md) | Yes|The texts| + + + +### Type: [RichText](../types/RichText.md) + + diff --git a/docs/TD_docs/constructors/richTextEmail.md b/docs/TD_docs/constructors/richTextEmail.md new file mode 100644 index 00000000..3db643ef --- /dev/null +++ b/docs/TD_docs/constructors/richTextEmail.md @@ -0,0 +1,23 @@ +--- +title: richTextEmail +description: Rich text email link +--- +## Constructor: richTextEmail +[Back to constructors index](index.md) + + + +Rich text email link + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|The text| +|email|[string](../types/string.md) | Yes|The email| + + + +### Type: [RichText](../types/RichText.md) + + diff --git a/docs/TD_docs/constructors/richTextFixed.md b/docs/TD_docs/constructors/richTextFixed.md new file mode 100644 index 00000000..c43e9b36 --- /dev/null +++ b/docs/TD_docs/constructors/richTextFixed.md @@ -0,0 +1,22 @@ +--- +title: richTextFixed +description: Fixed width rich text +--- +## Constructor: richTextFixed +[Back to constructors index](index.md) + + + +Fixed width rich text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|The text| + + + +### Type: [RichText](../types/RichText.md) + + diff --git a/docs/TD_docs/constructors/richTextItalic.md b/docs/TD_docs/constructors/richTextItalic.md new file mode 100644 index 00000000..0a923a02 --- /dev/null +++ b/docs/TD_docs/constructors/richTextItalic.md @@ -0,0 +1,22 @@ +--- +title: richTextItalic +description: Italicized rich text +--- +## Constructor: richTextItalic +[Back to constructors index](index.md) + + + +Italicized rich text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|The text| + + + +### Type: [RichText](../types/RichText.md) + + diff --git a/docs/TD_docs/constructors/richTextPlain.md b/docs/TD_docs/constructors/richTextPlain.md new file mode 100644 index 00000000..016f5dcb --- /dev/null +++ b/docs/TD_docs/constructors/richTextPlain.md @@ -0,0 +1,22 @@ +--- +title: richTextPlain +description: Plain text +--- +## Constructor: richTextPlain +[Back to constructors index](index.md) + + + +Plain text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|The text| + + + +### Type: [RichText](../types/RichText.md) + + diff --git a/docs/TD_docs/constructors/richTextStrikethrough.md b/docs/TD_docs/constructors/richTextStrikethrough.md new file mode 100644 index 00000000..c6aff222 --- /dev/null +++ b/docs/TD_docs/constructors/richTextStrikethrough.md @@ -0,0 +1,22 @@ +--- +title: richTextStrikethrough +description: Striked through rich text +--- +## Constructor: richTextStrikethrough +[Back to constructors index](index.md) + + + +Striked through rich text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|The text| + + + +### Type: [RichText](../types/RichText.md) + + diff --git a/docs/TD_docs/constructors/richTextUnderline.md b/docs/TD_docs/constructors/richTextUnderline.md new file mode 100644 index 00000000..d79a7557 --- /dev/null +++ b/docs/TD_docs/constructors/richTextUnderline.md @@ -0,0 +1,22 @@ +--- +title: richTextUnderline +description: Underlined rich text +--- +## Constructor: richTextUnderline +[Back to constructors index](index.md) + + + +Underlined rich text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|The text| + + + +### Type: [RichText](../types/RichText.md) + + diff --git a/docs/TD_docs/constructors/richTextUrl.md b/docs/TD_docs/constructors/richTextUrl.md new file mode 100644 index 00000000..6df52310 --- /dev/null +++ b/docs/TD_docs/constructors/richTextUrl.md @@ -0,0 +1,23 @@ +--- +title: richTextUrl +description: Rich text URL link +--- +## Constructor: richTextUrl +[Back to constructors index](index.md) + + + +Rich text URL link + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|The text| +|url|[string](../types/string.md) | Yes|The URL| + + + +### Type: [RichText](../types/RichText.md) + + diff --git a/docs/TD_docs/constructors/savedCredentials.md b/docs/TD_docs/constructors/savedCredentials.md new file mode 100644 index 00000000..ba744d7d --- /dev/null +++ b/docs/TD_docs/constructors/savedCredentials.md @@ -0,0 +1,23 @@ +--- +title: savedCredentials +description: Information about saved card credentials +--- +## Constructor: savedCredentials +[Back to constructors index](index.md) + + + +Information about saved card credentials + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Unique identifier of the saved credentials| +|title|[string](../types/string.md) | Yes|Title of the saved credentials| + + + +### Type: [SavedCredentials](../types/SavedCredentials.md) + + diff --git a/docs/TD_docs/constructors/searchMessagesFilterCall.md b/docs/TD_docs/constructors/searchMessagesFilterCall.md new file mode 100644 index 00000000..0ab39325 --- /dev/null +++ b/docs/TD_docs/constructors/searchMessagesFilterCall.md @@ -0,0 +1,21 @@ +--- +title: searchMessagesFilterCall +description: Return only call messages +--- +## Constructor: searchMessagesFilterCall +[Back to constructors index](index.md) + + + +Return only call messages + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [SearchMessagesFilter](../types/SearchMessagesFilter.md) + + diff --git a/docs/TD_docs/constructors/searchMessagesFilterMissedCall.md b/docs/TD_docs/constructors/searchMessagesFilterMissedCall.md new file mode 100644 index 00000000..3dc967be --- /dev/null +++ b/docs/TD_docs/constructors/searchMessagesFilterMissedCall.md @@ -0,0 +1,21 @@ +--- +title: searchMessagesFilterMissedCall +description: Return only incoming call messages with missed/declined discard reason +--- +## Constructor: searchMessagesFilterMissedCall +[Back to constructors index](index.md) + + + +Return only incoming call messages with missed/declined discard reason + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [SearchMessagesFilter](../types/SearchMessagesFilter.md) + + diff --git a/docs/TD_docs/constructors/searchMessagesFilterVideoNote.md b/docs/TD_docs/constructors/searchMessagesFilterVideoNote.md new file mode 100644 index 00000000..3dda697b --- /dev/null +++ b/docs/TD_docs/constructors/searchMessagesFilterVideoNote.md @@ -0,0 +1,21 @@ +--- +title: searchMessagesFilterVideoNote +description: Return only video note messages +--- +## Constructor: searchMessagesFilterVideoNote +[Back to constructors index](index.md) + + + +Return only video note messages + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [SearchMessagesFilter](../types/SearchMessagesFilter.md) + + diff --git a/docs/TD_docs/constructors/searchMessagesFilterVoiceAndVideoNote.md b/docs/TD_docs/constructors/searchMessagesFilterVoiceAndVideoNote.md new file mode 100644 index 00000000..e3491fbe --- /dev/null +++ b/docs/TD_docs/constructors/searchMessagesFilterVoiceAndVideoNote.md @@ -0,0 +1,21 @@ +--- +title: searchMessagesFilterVoiceAndVideoNote +description: Return only voice and video note messages +--- +## Constructor: searchMessagesFilterVoiceAndVideoNote +[Back to constructors index](index.md) + + + +Return only voice and video note messages + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [SearchMessagesFilter](../types/SearchMessagesFilter.md) + + diff --git a/docs/TD_docs/constructors/secretChat.md b/docs/TD_docs/constructors/secretChat.md index 9a89f50e..41736503 100644 --- a/docs/TD_docs/constructors/secretChat.md +++ b/docs/TD_docs/constructors/secretChat.md @@ -18,7 +18,8 @@ Represents a secret chat |state|[int](../types/int.md) | Yes|State of the secret chat, 0 - yet not created, 1 - active, 2 - closed| |is\_outbound|[Bool](../types/Bool.md) | Yes|True if chat was created by the current logged in user, false otherwise| |ttl|[int](../types/int.md) | Yes|Current message TTL setting for the chat in seconds| -|key\_hash|[bytes](../types/bytes.md) | Yes|Hash of the current used key for comparison with the hash of the interlocutor's key. String of 36 bytes, which should be used to make a 12x12 square image with a color depth of 4. First 16 bytes should be used to make a central 8 * 8 square, left 20 bytes should be used to construct a border of width 2 around that square. -Alternatively first 32 bytes of the hash can be converted to hex and printed as 32 2-digit hex numbers.| +|key\_hash|[bytes](../types/bytes.md) | Yes|Hash of the current used key for comparison with the hash of the interlocutor's key. String of 36 bytes, which should be used to make a 12x12 square image with a color depth of 4. First 16 bytes should be used to make a central 8 * 8 square, left 20 bytes should be used to construct a border of width 2 around that square. Alternatively first 32 bytes of the hash can be converted to hex and printed as 32 2-digit hex numbers| +|layer|[int](../types/int.md) | Yes|Secret chat layer, determining features supported by other client. Video notes are supported if layer >= 66| diff --git a/docs/TD_docs/constructors/secretChatInfo.md b/docs/TD_docs/constructors/secretChatInfo.md deleted file mode 100644 index 16cde949..00000000 --- a/docs/TD_docs/constructors/secretChatInfo.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: secretChatInfo -description: Secret chat with one user ---- -## Constructor: secretChatInfo -[Back to constructors index](index.md) - - - -Secret chat with one user - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|secret\_chat|[secretChat](../types/secretChat.md) | Yes|Information about the chat| - - - -### Type: [ChatInfo](../types/ChatInfo.md) - - diff --git a/docs/TD_docs/constructors/sendMessageCancelAction.md b/docs/TD_docs/constructors/sendMessageCancelAction.md deleted file mode 100644 index bf2e7ac5..00000000 --- a/docs/TD_docs/constructors/sendMessageCancelAction.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: sendMessageCancelAction -description: User cancels typing ---- -## Constructor: sendMessageCancelAction -[Back to constructors index](index.md) - - - -User cancels typing - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| - - - -### Type: [SendMessageAction](../types/SendMessageAction.md) - - diff --git a/docs/TD_docs/constructors/sendMessageGeoLocationAction.md b/docs/TD_docs/constructors/sendMessageGeoLocationAction.md deleted file mode 100644 index 719cbe67..00000000 --- a/docs/TD_docs/constructors/sendMessageGeoLocationAction.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: sendMessageGeoLocationAction -description: User sends geolocation ---- -## Constructor: sendMessageGeoLocationAction -[Back to constructors index](index.md) - - - -User sends geolocation - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| - - - -### Type: [SendMessageAction](../types/SendMessageAction.md) - - diff --git a/docs/TD_docs/constructors/sendMessageTypingAction.md b/docs/TD_docs/constructors/sendMessageTypingAction.md deleted file mode 100644 index 0b2899c1..00000000 --- a/docs/TD_docs/constructors/sendMessageTypingAction.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: sendMessageTypingAction -description: User typing message ---- -## Constructor: sendMessageTypingAction -[Back to constructors index](index.md) - - - -User typing message - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| - - - -### Type: [SendMessageAction](../types/SendMessageAction.md) - - diff --git a/docs/TD_docs/constructors/session.md b/docs/TD_docs/constructors/session.md index 9b9ddd81..6aa4e0e3 100644 --- a/docs/TD_docs/constructors/session.md +++ b/docs/TD_docs/constructors/session.md @@ -22,8 +22,8 @@ Contains information about one session in some application used by the user |device\_model|[string](../types/string.md) | Yes|Model of a device application is runned on, provided by the application| |platform|[string](../types/string.md) | Yes|Operating system application is runned on, provided by the application| |system\_version|[string](../types/string.md) | Yes|Version of operating system application is runned on, provided by the application| -|date\_created|[int](../types/int.md) | Yes|Date the user has logged in, unix time| -|date\_active|[int](../types/int.md) | Yes|Date the session was used last time, unix time| +|log\_in\_date|[int](../types/int.md) | Yes|Date the user has logged in, unix time| +|last\_active\_date|[int](../types/int.md) | Yes|Date the session was used last time, unix time| |ip|[string](../types/string.md) | Yes|An ip address from which session was created in a human-readable format| |country|[string](../types/string.md) | Yes|Two-letter country code from which session was created based on the ip| |region|[string](../types/string.md) | Yes|Region code from which session was created based on the ip| diff --git a/docs/TD_docs/constructors/shippingAddress.md b/docs/TD_docs/constructors/shippingAddress.md new file mode 100644 index 00000000..8b47dec1 --- /dev/null +++ b/docs/TD_docs/constructors/shippingAddress.md @@ -0,0 +1,27 @@ +--- +title: shippingAddress +description: Describes shipping address +--- +## Constructor: shippingAddress +[Back to constructors index](index.md) + + + +Describes shipping address + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|country\_code|[string](../types/string.md) | Yes|Two letter ISO 3166-1 alpha-2 country code| +|state|[string](../types/string.md) | Yes|State if applicable| +|city|[string](../types/string.md) | Yes|City| +|street\_line1|[string](../types/string.md) | Yes|First line for the address| +|street\_line2|[string](../types/string.md) | Yes|Second line for the address| +|post\_code|[string](../types/string.md) | Yes|Address post code| + + + +### Type: [ShippingAddress](../types/ShippingAddress.md) + + diff --git a/docs/TD_docs/constructors/shippingOption.md b/docs/TD_docs/constructors/shippingOption.md new file mode 100644 index 00000000..6509144b --- /dev/null +++ b/docs/TD_docs/constructors/shippingOption.md @@ -0,0 +1,24 @@ +--- +title: shippingOption +description: One shipping option +--- +## Constructor: shippingOption +[Back to constructors index](index.md) + + + +One shipping option + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Shipping option identifier| +|title|[string](../types/string.md) | Yes|Option title| +|prices|Array of [labeledPrice](../constructors/labeledPrice.md) | Yes|List of objects used to calculate total shipping price| + + + +### Type: [ShippingOption](../types/ShippingOption.md) + + diff --git a/docs/TD_docs/constructors/stickerSet.md b/docs/TD_docs/constructors/stickerSet.md index b875be7f..2085c41e 100644 --- a/docs/TD_docs/constructors/stickerSet.md +++ b/docs/TD_docs/constructors/stickerSet.md @@ -17,7 +17,7 @@ Represents sticker set |title|[string](../types/string.md) | Yes|Title of the sticker set| |name|[string](../types/string.md) | Yes|Name of the sticker set| |is\_installed|[Bool](../types/Bool.md) | Yes|True if sticker set is installed by logged in user| -|is\_archived|[Bool](../types/Bool.md) | Yes|True if sticker set is archived| +|is\_archived|[Bool](../types/Bool.md) | Yes|True if sticker set is archived. A sticker set can't be installed and archived simultaneously| |is\_official|[Bool](../types/Bool.md) | Yes|True if sticker set is official| |is\_masks|[Bool](../types/Bool.md) | Yes|True if stickers in the set are masks| |is\_viewed|[Bool](../types/Bool.md) | Yes|True for viewed trending sticker set| diff --git a/docs/TD_docs/constructors/stickerSetInfo.md b/docs/TD_docs/constructors/stickerSetInfo.md index 4b99da08..1d6fc78b 100644 --- a/docs/TD_docs/constructors/stickerSetInfo.md +++ b/docs/TD_docs/constructors/stickerSetInfo.md @@ -17,12 +17,12 @@ Represents short information about sticker set |title|[string](../types/string.md) | Yes|Title of the sticker set| |name|[string](../types/string.md) | Yes|Name of the sticker set| |is\_installed|[Bool](../types/Bool.md) | Yes|True if sticker set is installed by logged in user| -|is\_archived|[Bool](../types/Bool.md) | Yes|True if sticker set is archived| +|is\_archived|[Bool](../types/Bool.md) | Yes|True if sticker set is archived. A sticker set can't be installed and archived simultaneously| |is\_official|[Bool](../types/Bool.md) | Yes|True if sticker set is official| |is\_masks|[Bool](../types/Bool.md) | Yes|True if stickers in the set are masks| |is\_viewed|[Bool](../types/Bool.md) | Yes|True for viewed trending sticker set| |size|[int](../types/int.md) | Yes|Total number of stickers in the set| -|covers|Array of [sticker](../constructors/sticker.md) | Yes|Up to 5 first stickers from the set depending on the context| +|covers|Array of [sticker](../constructors/sticker.md) | Yes|Up to 5 first stickers from the set depending on the context. If client needs more stickers it should request full sticker set| diff --git a/docs/TD_docs/constructors/storageStatistics.md b/docs/TD_docs/constructors/storageStatistics.md new file mode 100644 index 00000000..0dac26bc --- /dev/null +++ b/docs/TD_docs/constructors/storageStatistics.md @@ -0,0 +1,24 @@ +--- +title: storageStatistics +description: Contains exact storage usage statistics splitted by chats and file types +--- +## Constructor: storageStatistics +[Back to constructors index](index.md) + + + +Contains exact storage usage statistics splitted by chats and file types + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|size|[int53](../types/int53.md) | Yes|Total size of files| +|count|[int](../types/int.md) | Yes|Total number of files| +|by\_chat|Array of [storageStatisticsByChat](../constructors/storageStatisticsByChat.md) | Yes|Statistics splitted by chats| + + + +### Type: [StorageStatistics](../types/StorageStatistics.md) + + diff --git a/docs/TD_docs/constructors/storageStatisticsByChat.md b/docs/TD_docs/constructors/storageStatisticsByChat.md new file mode 100644 index 00000000..c681fe9d --- /dev/null +++ b/docs/TD_docs/constructors/storageStatisticsByChat.md @@ -0,0 +1,25 @@ +--- +title: storageStatisticsByChat +description: Contains storage usage statistics for the specific chat +--- +## Constructor: storageStatisticsByChat +[Back to constructors index](index.md) + + + +Contains storage usage statistics for the specific chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier, 0 if none| +|size|[int53](../types/int53.md) | Yes|Total size of files| +|count|[int](../types/int.md) | Yes|Total number of files| +|by\_file\_type|Array of [storageStatisticsByFileType](../constructors/storageStatisticsByFileType.md) | Yes|Statistics splitted by file types| + + + +### Type: [StorageStatisticsByChat](../types/StorageStatisticsByChat.md) + + diff --git a/docs/TD_docs/constructors/storageStatisticsByFileType.md b/docs/TD_docs/constructors/storageStatisticsByFileType.md new file mode 100644 index 00000000..f8fd0833 --- /dev/null +++ b/docs/TD_docs/constructors/storageStatisticsByFileType.md @@ -0,0 +1,24 @@ +--- +title: storageStatisticsByFileType +description: Contains storage usage statistics for the specific file type +--- +## Constructor: storageStatisticsByFileType +[Back to constructors index](index.md) + + + +Contains storage usage statistics for the specific file type + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file\_type|[FileType](../types/FileType.md) | Yes|The file type| +|size|[int53](../types/int53.md) | Yes|Total size of files| +|count|[int](../types/int.md) | Yes|Total number of files| + + + +### Type: [StorageStatisticsByFileType](../types/StorageStatisticsByFileType.md) + + diff --git a/docs/TD_docs/constructors/storageStatisticsFast.md b/docs/TD_docs/constructors/storageStatisticsFast.md new file mode 100644 index 00000000..89ac0c9d --- /dev/null +++ b/docs/TD_docs/constructors/storageStatisticsFast.md @@ -0,0 +1,24 @@ +--- +title: storageStatisticsFast +description: Contains approximate storage usage statistics, not containing files of Unknown type +--- +## Constructor: storageStatisticsFast +[Back to constructors index](index.md) + + + +Contains approximate storage usage statistics, not containing files of Unknown type + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|files\_size|[int53](../types/int53.md) | Yes|Approximate total size of files| +|files\_count|[int](../types/int.md) | Yes|Approximate number of files| +|database\_size|[int53](../types/int53.md) | Yes|Size of database| + + + +### Type: [StorageStatisticsFast](../types/StorageStatisticsFast.md) + + diff --git a/docs/TD_docs/constructors/temporaryPasswordState.md b/docs/TD_docs/constructors/temporaryPasswordState.md new file mode 100644 index 00000000..7095bfd7 --- /dev/null +++ b/docs/TD_docs/constructors/temporaryPasswordState.md @@ -0,0 +1,23 @@ +--- +title: temporaryPasswordState +description: Returns information about availability of temporary password, which should be used for payments +--- +## Constructor: temporaryPasswordState +[Back to constructors index](index.md) + + + +Returns information about availability of temporary password, which should be used for payments + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|has\_password|[Bool](../types/Bool.md) | Yes|True, if we have temporary password| +|valid\_for|[int](../types/int.md) | Yes|Time left before temporary password expires, seconds| + + + +### Type: [TemporaryPasswordState](../types/TemporaryPasswordState.md) + + diff --git a/docs/TD_docs/constructors/testBytes.md b/docs/TD_docs/constructors/testBytes.md new file mode 100644 index 00000000..9765d660 --- /dev/null +++ b/docs/TD_docs/constructors/testBytes.md @@ -0,0 +1,22 @@ +--- +title: testBytes +description: Tests only. A simple object containing just a bytes +--- +## Constructor: testBytes +[Back to constructors index](index.md) + + + +Tests only. A simple object containing just a bytes + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|[bytes](../types/bytes.md) | Yes|The bytes| + + + +### Type: [TestBytes](../types/TestBytes.md) + + diff --git a/docs/TD_docs/constructors/testInt.md b/docs/TD_docs/constructors/testInt.md new file mode 100644 index 00000000..9cc6f87a --- /dev/null +++ b/docs/TD_docs/constructors/testInt.md @@ -0,0 +1,22 @@ +--- +title: testInt +description: Tests only. A simple object containing just a number +--- +## Constructor: testInt +[Back to constructors index](index.md) + + + +Tests only. A simple object containing just a number + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|[int](../types/int.md) | Yes|The number| + + + +### Type: [TestInt](../types/TestInt.md) + + diff --git a/docs/TD_docs/constructors/testString.md b/docs/TD_docs/constructors/testString.md new file mode 100644 index 00000000..1704c412 --- /dev/null +++ b/docs/TD_docs/constructors/testString.md @@ -0,0 +1,22 @@ +--- +title: testString +description: Tests only. A simple object containing just a string +--- +## Constructor: testString +[Back to constructors index](index.md) + + + +Tests only. A simple object containing just a string + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|[string](../types/string.md) | Yes|The string| + + + +### Type: [TestString](../types/TestString.md) + + diff --git a/docs/TD_docs/constructors/testVectorInt.md b/docs/TD_docs/constructors/testVectorInt.md new file mode 100644 index 00000000..46c95579 --- /dev/null +++ b/docs/TD_docs/constructors/testVectorInt.md @@ -0,0 +1,22 @@ +--- +title: testVectorInt +description: Tests only. A simple object containing just a vector of numbers +--- +## Constructor: testVectorInt +[Back to constructors index](index.md) + + + +Tests only. A simple object containing just a vector of numbers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|Array of [int](../constructors/int.md) | Yes|The vector of numbers| + + + +### Type: [TestVectorInt](../types/TestVectorInt.md) + + diff --git a/docs/TD_docs/constructors/testVectorIntObject.md b/docs/TD_docs/constructors/testVectorIntObject.md new file mode 100644 index 00000000..58977342 --- /dev/null +++ b/docs/TD_docs/constructors/testVectorIntObject.md @@ -0,0 +1,22 @@ +--- +title: testVectorIntObject +description: Tests only. A simple object containing just a vector of objects containing a number +--- +## Constructor: testVectorIntObject +[Back to constructors index](index.md) + + + +Tests only. A simple object containing just a vector of objects containing a number + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|Array of [testInt](../constructors/testInt.md) | Yes|The vector of objects| + + + +### Type: [TestVectorIntObject](../types/TestVectorIntObject.md) + + diff --git a/docs/TD_docs/constructors/testVectorString.md b/docs/TD_docs/constructors/testVectorString.md new file mode 100644 index 00000000..ca04929e --- /dev/null +++ b/docs/TD_docs/constructors/testVectorString.md @@ -0,0 +1,22 @@ +--- +title: testVectorString +description: Tests only. A simple object containing just a vector of strings +--- +## Constructor: testVectorString +[Back to constructors index](index.md) + + + +Tests only. A simple object containing just a vector of strings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|Array of [string](../constructors/string.md) | Yes|The vector of strings| + + + +### Type: [TestVectorString](../types/TestVectorString.md) + + diff --git a/docs/TD_docs/constructors/testVectorStringObject.md b/docs/TD_docs/constructors/testVectorStringObject.md new file mode 100644 index 00000000..dda8e33a --- /dev/null +++ b/docs/TD_docs/constructors/testVectorStringObject.md @@ -0,0 +1,22 @@ +--- +title: testVectorStringObject +description: Tests only. A simple object containing just a vector of objects containing a string +--- +## Constructor: testVectorStringObject +[Back to constructors index](index.md) + + + +Tests only. A simple object containing just a vector of objects containing a string + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|Array of [testString](../constructors/testString.md) | Yes|The vector of objects| + + + +### Type: [TestVectorStringObject](../types/TestVectorStringObject.md) + + diff --git a/docs/TD_docs/constructors/test_bytes.md b/docs/TD_docs/constructors/test_bytes.md deleted file mode 100644 index 7565a072..00000000 --- a/docs/TD_docs/constructors/test_bytes.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.bytes -description: test_bytes attributes, type and example ---- -## Constructor: test.bytes -[Back to constructors index](index.md) - - - -### Attributes: - -| Name | Type | Required | -|----------|---------------|----------| -|value|[bytes](../types/bytes.md) | Yes| - - - -### Type: [test\_Bytes](../types/test_Bytes.md) - - diff --git a/docs/TD_docs/constructors/test_empty.md b/docs/TD_docs/constructors/test_empty.md deleted file mode 100644 index bf50ffc4..00000000 --- a/docs/TD_docs/constructors/test_empty.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: test.empty -description: test_empty attributes, type and example ---- -## Constructor: test.empty -[Back to constructors index](index.md) - - - - - - -### Type: [test\_Empty](../types/test_Empty.md) - - diff --git a/docs/TD_docs/constructors/test_int.md b/docs/TD_docs/constructors/test_int.md deleted file mode 100644 index a8fddc3d..00000000 --- a/docs/TD_docs/constructors/test_int.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.int -description: test_int attributes, type and example ---- -## Constructor: test.int -[Back to constructors index](index.md) - - - -### Attributes: - -| Name | Type | Required | -|----------|---------------|----------| -|value|[int](../types/int.md) | Yes| - - - -### Type: [test\_Int](../types/test_Int.md) - - diff --git a/docs/TD_docs/constructors/test_string.md b/docs/TD_docs/constructors/test_string.md deleted file mode 100644 index cf51f27a..00000000 --- a/docs/TD_docs/constructors/test_string.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.string -description: test_string attributes, type and example ---- -## Constructor: test.string -[Back to constructors index](index.md) - - - -### Attributes: - -| Name | Type | Required | -|----------|---------------|----------| -|value|[string](../types/string.md) | Yes| - - - -### Type: [test\_String](../types/test_String.md) - - diff --git a/docs/TD_docs/constructors/test_vectorInt.md b/docs/TD_docs/constructors/test_vectorInt.md deleted file mode 100644 index 62429351..00000000 --- a/docs/TD_docs/constructors/test_vectorInt.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.vectorInt -description: test_vectorInt attributes, type and example ---- -## Constructor: test.vectorInt -[Back to constructors index](index.md) - - - -### Attributes: - -| Name | Type | Required | -|----------|---------------|----------| -|value|Array of [int](../constructors/int.md) | Yes| - - - -### Type: [test\_VectorInt](../types/test_VectorInt.md) - - diff --git a/docs/TD_docs/constructors/test_vectorIntObject.md b/docs/TD_docs/constructors/test_vectorIntObject.md deleted file mode 100644 index b8a38ea7..00000000 --- a/docs/TD_docs/constructors/test_vectorIntObject.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.vectorIntObject -description: test_vectorIntObject attributes, type and example ---- -## Constructor: test.vectorIntObject -[Back to constructors index](index.md) - - - -### Attributes: - -| Name | Type | Required | -|----------|---------------|----------| -|value|Array of [test\_Int](../constructors/test_Int.md) | Yes| - - - -### Type: [test\_VectorIntObject](../types/test_VectorIntObject.md) - - diff --git a/docs/TD_docs/constructors/test_vectorString.md b/docs/TD_docs/constructors/test_vectorString.md deleted file mode 100644 index f2f75b89..00000000 --- a/docs/TD_docs/constructors/test_vectorString.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.vectorString -description: test_vectorString attributes, type and example ---- -## Constructor: test.vectorString -[Back to constructors index](index.md) - - - -### Attributes: - -| Name | Type | Required | -|----------|---------------|----------| -|value|Array of [string](../constructors/string.md) | Yes| - - - -### Type: [test\_VectorString](../types/test_VectorString.md) - - diff --git a/docs/TD_docs/constructors/test_vectorStringObject.md b/docs/TD_docs/constructors/test_vectorStringObject.md deleted file mode 100644 index 6c0dc3f4..00000000 --- a/docs/TD_docs/constructors/test_vectorStringObject.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.vectorStringObject -description: test_vectorStringObject attributes, type and example ---- -## Constructor: test.vectorStringObject -[Back to constructors index](index.md) - - - -### Attributes: - -| Name | Type | Required | -|----------|---------------|----------| -|value|Array of [test\_String](../constructors/test_String.md) | Yes| - - - -### Type: [test\_VectorStringObject](../types/test_VectorStringObject.md) - - diff --git a/docs/TD_docs/constructors/text.md b/docs/TD_docs/constructors/text.md new file mode 100644 index 00000000..02bc2d91 --- /dev/null +++ b/docs/TD_docs/constructors/text.md @@ -0,0 +1,22 @@ +--- +title: text +description: Contains some text +--- +## Constructor: text +[Back to constructors index](index.md) + + + +Contains some text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|The text| + + + +### Type: [Text](../types/Text.md) + + diff --git a/docs/TD_docs/constructors/messageEntityBotCommand.md b/docs/TD_docs/constructors/textEntity.md similarity index 50% rename from docs/TD_docs/constructors/messageEntityBotCommand.md rename to docs/TD_docs/constructors/textEntity.md index d51212f8..7578be1e 100644 --- a/docs/TD_docs/constructors/messageEntityBotCommand.md +++ b/docs/TD_docs/constructors/textEntity.md @@ -1,13 +1,13 @@ --- -title: messageEntityBotCommand -description: Bot command beginning with / +title: textEntity +description: Represent part of the text which needs to be formatted in some unusual way --- -## Constructor: messageEntityBotCommand +## Constructor: textEntity [Back to constructors index](index.md) -Bot command beginning with / +Represent part of the text which needs to be formatted in some unusual way ### Attributes: @@ -15,9 +15,10 @@ Bot command beginning with / |----------|---------------|----------|-------------| |offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| |length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| +|type|[TextEntityType](../types/TextEntityType.md) | Yes|Type of the entity| -### Type: [MessageEntity](../types/MessageEntity.md) +### Type: [TextEntity](../types/TextEntity.md) diff --git a/docs/TD_docs/constructors/textEntityTypeBold.md b/docs/TD_docs/constructors/textEntityTypeBold.md new file mode 100644 index 00000000..5193a8a4 --- /dev/null +++ b/docs/TD_docs/constructors/textEntityTypeBold.md @@ -0,0 +1,21 @@ +--- +title: textEntityTypeBold +description: Bold text +--- +## Constructor: textEntityTypeBold +[Back to constructors index](index.md) + + + +Bold text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TextEntityType](../types/TextEntityType.md) + + diff --git a/docs/TD_docs/constructors/textEntityTypeBotCommand.md b/docs/TD_docs/constructors/textEntityTypeBotCommand.md new file mode 100644 index 00000000..c3485ecb --- /dev/null +++ b/docs/TD_docs/constructors/textEntityTypeBotCommand.md @@ -0,0 +1,21 @@ +--- +title: textEntityTypeBotCommand +description: Bot command beginning with /. It shouldn't be highlighted if there is no bots in the chat +--- +## Constructor: textEntityTypeBotCommand +[Back to constructors index](index.md) + + + +Bot command beginning with /. It shouldn't be highlighted if there is no bots in the chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TextEntityType](../types/TextEntityType.md) + + diff --git a/docs/TD_docs/constructors/messageEntityCode.md b/docs/TD_docs/constructors/textEntityTypeCode.md similarity index 52% rename from docs/TD_docs/constructors/messageEntityCode.md rename to docs/TD_docs/constructors/textEntityTypeCode.md index ee26c632..7063dc64 100644 --- a/docs/TD_docs/constructors/messageEntityCode.md +++ b/docs/TD_docs/constructors/textEntityTypeCode.md @@ -1,8 +1,8 @@ --- -title: messageEntityCode +title: textEntityTypeCode description: Text needs to be formatted as inside of code HTML tag --- -## Constructor: messageEntityCode +## Constructor: textEntityTypeCode [Back to constructors index](index.md) @@ -13,11 +13,9 @@ Text needs to be formatted as inside of code HTML tag | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| -### Type: [MessageEntity](../types/MessageEntity.md) +### Type: [TextEntityType](../types/TextEntityType.md) diff --git a/docs/TD_docs/constructors/textEntityTypeEmail.md b/docs/TD_docs/constructors/textEntityTypeEmail.md new file mode 100644 index 00000000..25f0f79e --- /dev/null +++ b/docs/TD_docs/constructors/textEntityTypeEmail.md @@ -0,0 +1,21 @@ +--- +title: textEntityTypeEmail +description: Email +--- +## Constructor: textEntityTypeEmail +[Back to constructors index](index.md) + + + +Email + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TextEntityType](../types/TextEntityType.md) + + diff --git a/docs/TD_docs/constructors/textEntityTypeHashtag.md b/docs/TD_docs/constructors/textEntityTypeHashtag.md new file mode 100644 index 00000000..d28eabb7 --- /dev/null +++ b/docs/TD_docs/constructors/textEntityTypeHashtag.md @@ -0,0 +1,21 @@ +--- +title: textEntityTypeHashtag +description: Hashtag beginning with # +--- +## Constructor: textEntityTypeHashtag +[Back to constructors index](index.md) + + + +Hashtag beginning with # + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TextEntityType](../types/TextEntityType.md) + + diff --git a/docs/TD_docs/constructors/textEntityTypeItalic.md b/docs/TD_docs/constructors/textEntityTypeItalic.md new file mode 100644 index 00000000..428772ab --- /dev/null +++ b/docs/TD_docs/constructors/textEntityTypeItalic.md @@ -0,0 +1,21 @@ +--- +title: textEntityTypeItalic +description: Italic text +--- +## Constructor: textEntityTypeItalic +[Back to constructors index](index.md) + + + +Italic text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TextEntityType](../types/TextEntityType.md) + + diff --git a/docs/TD_docs/constructors/textEntityTypeMention.md b/docs/TD_docs/constructors/textEntityTypeMention.md new file mode 100644 index 00000000..2f6bc8ce --- /dev/null +++ b/docs/TD_docs/constructors/textEntityTypeMention.md @@ -0,0 +1,21 @@ +--- +title: textEntityTypeMention +description: Mention of the user by his username +--- +## Constructor: textEntityTypeMention +[Back to constructors index](index.md) + + + +Mention of the user by his username + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TextEntityType](../types/TextEntityType.md) + + diff --git a/docs/TD_docs/constructors/messageEntityMentionName.md b/docs/TD_docs/constructors/textEntityTypeMentionName.md similarity index 53% rename from docs/TD_docs/constructors/messageEntityMentionName.md rename to docs/TD_docs/constructors/textEntityTypeMentionName.md index 061bba90..f5b00ba3 100644 --- a/docs/TD_docs/constructors/messageEntityMentionName.md +++ b/docs/TD_docs/constructors/textEntityTypeMentionName.md @@ -1,8 +1,8 @@ --- -title: messageEntityMentionName +title: textEntityTypeMentionName description: Mention of the user by some text --- -## Constructor: messageEntityMentionName +## Constructor: textEntityTypeMentionName [Back to constructors index](index.md) @@ -13,12 +13,10 @@ Mention of the user by some text | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |user\_id|[int](../types/int.md) | Yes|Identifier of the mentioned user| -### Type: [MessageEntity](../types/MessageEntity.md) +### Type: [TextEntityType](../types/TextEntityType.md) diff --git a/docs/TD_docs/constructors/messageEntityPre.md b/docs/TD_docs/constructors/textEntityTypePre.md similarity index 52% rename from docs/TD_docs/constructors/messageEntityPre.md rename to docs/TD_docs/constructors/textEntityTypePre.md index 6fe68907..21c53b0f 100644 --- a/docs/TD_docs/constructors/messageEntityPre.md +++ b/docs/TD_docs/constructors/textEntityTypePre.md @@ -1,8 +1,8 @@ --- -title: messageEntityPre +title: textEntityTypePre description: Text needs to be formatted as inside of pre HTML tag --- -## Constructor: messageEntityPre +## Constructor: textEntityTypePre [Back to constructors index](index.md) @@ -13,11 +13,9 @@ Text needs to be formatted as inside of pre HTML tag | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| -### Type: [MessageEntity](../types/MessageEntity.md) +### Type: [TextEntityType](../types/TextEntityType.md) diff --git a/docs/TD_docs/constructors/messageEntityPreCode.md b/docs/TD_docs/constructors/textEntityTypePreCode.md similarity index 58% rename from docs/TD_docs/constructors/messageEntityPreCode.md rename to docs/TD_docs/constructors/textEntityTypePreCode.md index 714715ac..585d33ab 100644 --- a/docs/TD_docs/constructors/messageEntityPreCode.md +++ b/docs/TD_docs/constructors/textEntityTypePreCode.md @@ -1,8 +1,8 @@ --- -title: messageEntityPreCode +title: textEntityTypePreCode description: Text needs to be formatted as inside of pre and code HTML tags --- -## Constructor: messageEntityPreCode +## Constructor: textEntityTypePreCode [Back to constructors index](index.md) @@ -13,12 +13,10 @@ Text needs to be formatted as inside of pre and code HTML tags | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |language|[string](../types/string.md) | Yes|Language of code as defined by sender| -### Type: [MessageEntity](../types/MessageEntity.md) +### Type: [TextEntityType](../types/TextEntityType.md) diff --git a/docs/TD_docs/constructors/messageEntityTextUrl.md b/docs/TD_docs/constructors/textEntityTypeTextUrl.md similarity index 56% rename from docs/TD_docs/constructors/messageEntityTextUrl.md rename to docs/TD_docs/constructors/textEntityTypeTextUrl.md index f3c22afe..ac388378 100644 --- a/docs/TD_docs/constructors/messageEntityTextUrl.md +++ b/docs/TD_docs/constructors/textEntityTypeTextUrl.md @@ -1,8 +1,8 @@ --- -title: messageEntityTextUrl +title: textEntityTypeTextUrl description: Text description showed instead of the url --- -## Constructor: messageEntityTextUrl +## Constructor: textEntityTypeTextUrl [Back to constructors index](index.md) @@ -13,12 +13,10 @@ Text description showed instead of the url | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points| -|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points| |url|[string](../types/string.md) | Yes|Url to be opened after link will be clicked| -### Type: [MessageEntity](../types/MessageEntity.md) +### Type: [TextEntityType](../types/TextEntityType.md) diff --git a/docs/TD_docs/constructors/textEntityTypeUrl.md b/docs/TD_docs/constructors/textEntityTypeUrl.md new file mode 100644 index 00000000..cdc67e52 --- /dev/null +++ b/docs/TD_docs/constructors/textEntityTypeUrl.md @@ -0,0 +1,21 @@ +--- +title: textEntityTypeUrl +description: Url beginning with http +--- +## Constructor: textEntityTypeUrl +[Back to constructors index](index.md) + + + +Url beginning with http + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TextEntityType](../types/TextEntityType.md) + + diff --git a/docs/TD_docs/constructors/topChatCategoryBots.md b/docs/TD_docs/constructors/topChatCategoryBots.md new file mode 100644 index 00000000..a7f83f85 --- /dev/null +++ b/docs/TD_docs/constructors/topChatCategoryBots.md @@ -0,0 +1,21 @@ +--- +title: topChatCategoryBots +description: The category containing private chats with bot users +--- +## Constructor: topChatCategoryBots +[Back to constructors index](index.md) + + + +The category containing private chats with bot users + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TopChatCategory](../types/TopChatCategory.md) + + diff --git a/docs/TD_docs/constructors/topChatCategoryCalls.md b/docs/TD_docs/constructors/topChatCategoryCalls.md new file mode 100644 index 00000000..7fe6f31e --- /dev/null +++ b/docs/TD_docs/constructors/topChatCategoryCalls.md @@ -0,0 +1,21 @@ +--- +title: topChatCategoryCalls +description: The category containing chats frequently used for calls +--- +## Constructor: topChatCategoryCalls +[Back to constructors index](index.md) + + + +The category containing chats frequently used for calls + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TopChatCategory](../types/TopChatCategory.md) + + diff --git a/docs/TD_docs/constructors/topChatCategoryChannels.md b/docs/TD_docs/constructors/topChatCategoryChannels.md new file mode 100644 index 00000000..00cd8679 --- /dev/null +++ b/docs/TD_docs/constructors/topChatCategoryChannels.md @@ -0,0 +1,21 @@ +--- +title: topChatCategoryChannels +description: The category containing broadcast channel chats +--- +## Constructor: topChatCategoryChannels +[Back to constructors index](index.md) + + + +The category containing broadcast channel chats + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TopChatCategory](../types/TopChatCategory.md) + + diff --git a/docs/TD_docs/constructors/topChatCategoryGroups.md b/docs/TD_docs/constructors/topChatCategoryGroups.md new file mode 100644 index 00000000..974c0ee6 --- /dev/null +++ b/docs/TD_docs/constructors/topChatCategoryGroups.md @@ -0,0 +1,21 @@ +--- +title: topChatCategoryGroups +description: The category containing group chats and supergroup channel chats +--- +## Constructor: topChatCategoryGroups +[Back to constructors index](index.md) + + + +The category containing group chats and supergroup channel chats + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TopChatCategory](../types/TopChatCategory.md) + + diff --git a/docs/TD_docs/constructors/topChatCategoryInlineBots.md b/docs/TD_docs/constructors/topChatCategoryInlineBots.md new file mode 100644 index 00000000..1d742d3f --- /dev/null +++ b/docs/TD_docs/constructors/topChatCategoryInlineBots.md @@ -0,0 +1,21 @@ +--- +title: topChatCategoryInlineBots +description: The category containing chats with inline bots sorted by their usage in the inline mode +--- +## Constructor: topChatCategoryInlineBots +[Back to constructors index](index.md) + + + +The category containing chats with inline bots sorted by their usage in the inline mode + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TopChatCategory](../types/TopChatCategory.md) + + diff --git a/docs/TD_docs/constructors/topChatCategoryUsers.md b/docs/TD_docs/constructors/topChatCategoryUsers.md new file mode 100644 index 00000000..885735c1 --- /dev/null +++ b/docs/TD_docs/constructors/topChatCategoryUsers.md @@ -0,0 +1,21 @@ +--- +title: topChatCategoryUsers +description: The category containing private chats with non-bot users +--- +## Constructor: topChatCategoryUsers +[Back to constructors index](index.md) + + + +The category containing private chats with non-bot users + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + + +### Type: [TopChatCategory](../types/TopChatCategory.md) + + diff --git a/docs/TD_docs/constructors/updateChat.md b/docs/TD_docs/constructors/updateCall.md similarity index 52% rename from docs/TD_docs/constructors/updateChat.md rename to docs/TD_docs/constructors/updateCall.md index 9a122c53..24cbff46 100644 --- a/docs/TD_docs/constructors/updateChat.md +++ b/docs/TD_docs/constructors/updateCall.md @@ -1,19 +1,19 @@ --- -title: updateChat -description: Some date about chat has been changed +title: updateCall +description: Information about a call was updated --- -## Constructor: updateChat +## Constructor: updateCall [Back to constructors index](index.md) -Some date about chat has been changed +Information about a call was updated ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat|[chat](../types/chat.md) | Yes|New data about the chat| +|call|[call](../types/call.md) | Yes|New data about a call| diff --git a/docs/TD_docs/constructors/updateChannel.md b/docs/TD_docs/constructors/updateChannel.md index 7e91338d..77bfe1ff 100644 --- a/docs/TD_docs/constructors/updateChannel.md +++ b/docs/TD_docs/constructors/updateChannel.md @@ -1,13 +1,13 @@ --- title: updateChannel -description: Some data about a channel has been changed +description: Some data about a channel has been changed. This update is guaranteed to come before channel identifier is returned to the client, if library knows anything about the channel --- ## Constructor: updateChannel [Back to constructors index](index.md) -Some data about a channel has been changed +Some data about a channel has been changed. This update is guaranteed to come before channel identifier is returned to the client, if library knows anything about the channel ### Attributes: diff --git a/docs/TD_docs/constructors/updateChannelFull.md b/docs/TD_docs/constructors/updateChannelFull.md index bf9bed66..5dda3ab8 100644 --- a/docs/TD_docs/constructors/updateChannelFull.md +++ b/docs/TD_docs/constructors/updateChannelFull.md @@ -13,6 +13,7 @@ Some data from channelFull has been changed | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel identifier| |channel\_full|[channelFull](../types/channelFull.md) | Yes|New full information about the channel| diff --git a/docs/TD_docs/constructors/updateChatDraftMessage.md b/docs/TD_docs/constructors/updateChatDraftMessage.md index 673a35dd..622ee9ff 100644 --- a/docs/TD_docs/constructors/updateChatDraftMessage.md +++ b/docs/TD_docs/constructors/updateChatDraftMessage.md @@ -13,7 +13,7 @@ Chat draft has changed. Be aware that the update may come in the currently open | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| |draft\_message|[draftMessage](../types/draftMessage.md) | Yes|New chat draft_message, nullable| diff --git a/docs/TD_docs/constructors/updateChatIsPinned.md b/docs/TD_docs/constructors/updateChatIsPinned.md new file mode 100644 index 00000000..00bce6b4 --- /dev/null +++ b/docs/TD_docs/constructors/updateChatIsPinned.md @@ -0,0 +1,23 @@ +--- +title: updateChatIsPinned +description: Chat was pinned or unpinned +--- +## Constructor: updateChatIsPinned +[Back to constructors index](index.md) + + + +Chat was pinned or unpinned + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|is\_pinned|[Bool](../types/Bool.md) | Yes|New value of is_pinned| + + + +### Type: [Update](../types/Update.md) + + diff --git a/docs/TD_docs/constructors/updateChatOrder.md b/docs/TD_docs/constructors/updateChatOrder.md index 4db4f0ef..38a2106e 100644 --- a/docs/TD_docs/constructors/updateChatOrder.md +++ b/docs/TD_docs/constructors/updateChatOrder.md @@ -13,7 +13,7 @@ Order of the chat in the chat list has changed | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| |order|[long](../types/long.md) | Yes|New value of the order| diff --git a/docs/TD_docs/constructors/updateChatPhoto.md b/docs/TD_docs/constructors/updateChatPhoto.md index 7d049187..9a605d26 100644 --- a/docs/TD_docs/constructors/updateChatPhoto.md +++ b/docs/TD_docs/constructors/updateChatPhoto.md @@ -13,7 +13,7 @@ Chat photo was changed | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| |photo|[chatPhoto](../types/chatPhoto.md) | Yes|New chat photo, nullable| diff --git a/docs/TD_docs/constructors/updateChatReadInbox.md b/docs/TD_docs/constructors/updateChatReadInbox.md index 8084719f..86c31fc5 100644 --- a/docs/TD_docs/constructors/updateChatReadInbox.md +++ b/docs/TD_docs/constructors/updateChatReadInbox.md @@ -13,8 +13,8 @@ Some incoming messages was read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| -|last\_read\_inbox\_message\_id|[long](../types/long.md) | Yes|Identifier of last read incoming message| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|last\_read\_inbox\_message\_id|[int53](../types/int53.md) | Yes|Identifier of last read incoming message| |unread\_count|[int](../types/int.md) | Yes|Number of unread messages left in chat| diff --git a/docs/TD_docs/constructors/updateChatReadOutbox.md b/docs/TD_docs/constructors/updateChatReadOutbox.md index 6a178d4b..a3968308 100644 --- a/docs/TD_docs/constructors/updateChatReadOutbox.md +++ b/docs/TD_docs/constructors/updateChatReadOutbox.md @@ -13,8 +13,8 @@ Some outcoming messages was read | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| -|last\_read\_outbox\_message\_id|[long](../types/long.md) | Yes|Identifier of last read outgoing message| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|last\_read\_outbox\_message\_id|[int53](../types/int53.md) | Yes|Identifier of last read outgoing message| diff --git a/docs/TD_docs/constructors/updateChatReplyMarkup.md b/docs/TD_docs/constructors/updateChatReplyMarkup.md index 9a2e93ca..6d4a7fc4 100644 --- a/docs/TD_docs/constructors/updateChatReplyMarkup.md +++ b/docs/TD_docs/constructors/updateChatReplyMarkup.md @@ -13,8 +13,8 @@ Default chat reply markup has changed. It can happen because new message with re | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| -|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| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|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| diff --git a/docs/TD_docs/constructors/updateChatTitle.md b/docs/TD_docs/constructors/updateChatTitle.md index de5ca751..edd35836 100644 --- a/docs/TD_docs/constructors/updateChatTitle.md +++ b/docs/TD_docs/constructors/updateChatTitle.md @@ -1,19 +1,19 @@ --- title: updateChatTitle -description: Title of chat was changed +description: Title of the chat was changed --- ## Constructor: updateChatTitle [Back to constructors index](index.md) -Title of chat was changed +Title of the chat was changed ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| |title|[string](../types/string.md) | Yes|New chat title| diff --git a/docs/TD_docs/constructors/updateChatTopMessage.md b/docs/TD_docs/constructors/updateChatTopMessage.md index 75168964..bdee7662 100644 --- a/docs/TD_docs/constructors/updateChatTopMessage.md +++ b/docs/TD_docs/constructors/updateChatTopMessage.md @@ -1,19 +1,19 @@ --- title: updateChatTopMessage -description: Top message of the chat has changed +description: Top message of the chat has changed. If top_message is null then top message in the chat became unknown. Some new unknown messages might be added to the chat in that case --- ## Constructor: updateChatTopMessage [Back to constructors index](index.md) -Top message of the chat has changed +Top message of the chat has changed. If top_message is null then top message in the chat became unknown. Some new unknown messages might be added to the chat in that case ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| |top\_message|[message](../types/message.md) | Yes|New top message of the chat, nullable| diff --git a/docs/TD_docs/constructors/updateConnectionState.md b/docs/TD_docs/constructors/updateConnectionState.md new file mode 100644 index 00000000..3d12a50e --- /dev/null +++ b/docs/TD_docs/constructors/updateConnectionState.md @@ -0,0 +1,22 @@ +--- +title: updateConnectionState +description: Connection state has changed +--- +## Constructor: updateConnectionState +[Back to constructors index](index.md) + + + +Connection state has changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|state|[ConnectionState](../types/ConnectionState.md) | Yes|New connection state| + + + +### Type: [Update](../types/Update.md) + + diff --git a/docs/TD_docs/constructors/updateDeleteMessages.md b/docs/TD_docs/constructors/updateDeleteMessages.md index fec59737..a1b164ff 100644 --- a/docs/TD_docs/constructors/updateDeleteMessages.md +++ b/docs/TD_docs/constructors/updateDeleteMessages.md @@ -13,8 +13,8 @@ Some messages was deleted | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| -|message\_ids|Array of [long](../constructors/long.md) | Yes|Identifiers of deleted message| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|message\_ids|Array of [int53](../constructors/int53.md) | Yes|Identifiers of deleted message| diff --git a/docs/TD_docs/constructors/updateFile.md b/docs/TD_docs/constructors/updateFile.md index eaf38165..b60c8b8b 100644 --- a/docs/TD_docs/constructors/updateFile.md +++ b/docs/TD_docs/constructors/updateFile.md @@ -1,19 +1,19 @@ --- title: updateFile -description: File is downloaded/uploaded +description: Information about a file was updated --- ## Constructor: updateFile [Back to constructors index](index.md) -File is downloaded/uploaded +Information about a file was updated ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|file|[file](../types/file.md) | Yes|Synced file| +|file|[file](../types/file.md) | Yes|New data about a file| diff --git a/docs/TD_docs/constructors/updateFileGenerationFinish.md b/docs/TD_docs/constructors/updateFileGenerationFinish.md index 0ba40b8b..27c29316 100644 --- a/docs/TD_docs/constructors/updateFileGenerationFinish.md +++ b/docs/TD_docs/constructors/updateFileGenerationFinish.md @@ -1,13 +1,13 @@ --- title: updateFileGenerationFinish -description: File generation is finished +description: DEPRECATED. Use updateFile instead. File generation is finished --- ## Constructor: updateFileGenerationFinish [Back to constructors index](index.md) -File generation is finished +DEPRECATED. Use updateFile instead. File generation is finished ### Attributes: diff --git a/docs/TD_docs/constructors/updateFileProgress.md b/docs/TD_docs/constructors/updateFileProgress.md index c6caef7b..de50f2a4 100644 --- a/docs/TD_docs/constructors/updateFileProgress.md +++ b/docs/TD_docs/constructors/updateFileProgress.md @@ -1,13 +1,13 @@ --- title: updateFileProgress -description: File is partly downloaded/uploaded +description: DEPRECATED. Use updateFile instead. File is partly downloaded/uploaded --- ## Constructor: updateFileProgress [Back to constructors index](index.md) -File is partly downloaded/uploaded +DEPRECATED. Use updateFile instead. File is partly downloaded/uploaded ### Attributes: diff --git a/docs/TD_docs/constructors/updateGroup.md b/docs/TD_docs/constructors/updateGroup.md index e5bcf5cf..a578600f 100644 --- a/docs/TD_docs/constructors/updateGroup.md +++ b/docs/TD_docs/constructors/updateGroup.md @@ -1,13 +1,13 @@ --- title: updateGroup -description: Some data about a group has been changed +description: Some data about a group has been changed. This update is guaranteed to come before group identifier is returned to the client, if library knows anything about the group --- ## Constructor: updateGroup [Back to constructors index](index.md) -Some data about a group has been changed +Some data about a group has been changed. This update is guaranteed to come before group identifier is returned to the client, if library knows anything about the group ### Attributes: diff --git a/docs/TD_docs/constructors/updateGroupFull.md b/docs/TD_docs/constructors/updateGroupFull.md new file mode 100644 index 00000000..9fd018a0 --- /dev/null +++ b/docs/TD_docs/constructors/updateGroupFull.md @@ -0,0 +1,23 @@ +--- +title: updateGroupFull +description: Some data from groupFull has been changed +--- +## Constructor: updateGroupFull +[Back to constructors index](index.md) + + + +Some data from groupFull has been changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|group\_id|[int](../types/int.md) | Yes|Group identifier| +|group\_full|[groupFull](../types/groupFull.md) | Yes|New full information about the group| + + + +### Type: [Update](../types/Update.md) + + diff --git a/docs/TD_docs/constructors/updateStickerSets.md b/docs/TD_docs/constructors/updateInstalledStickerSets.md similarity index 79% rename from docs/TD_docs/constructors/updateStickerSets.md rename to docs/TD_docs/constructors/updateInstalledStickerSets.md index 64424512..df7d4539 100644 --- a/docs/TD_docs/constructors/updateStickerSets.md +++ b/docs/TD_docs/constructors/updateInstalledStickerSets.md @@ -1,8 +1,8 @@ --- -title: updateStickerSets +title: updateInstalledStickerSets description: List of installed sticker sets was updated --- -## Constructor: updateStickerSets +## Constructor: updateInstalledStickerSets [Back to constructors index](index.md) @@ -14,7 +14,7 @@ List of installed sticker sets was updated | Name | Type | Required | Description | |----------|---------------|----------|-------------| |is\_masks|[Bool](../types/Bool.md) | Yes|True, if list of installed mask sticker sets was updated| -|sticker\_set\_ids|Array of [long](../constructors/long.md) | Yes|New list of installed sticker sets| +|sticker\_set\_ids|Array of [long](../constructors/long.md) | Yes|New list of installed ordinary sticker sets| diff --git a/docs/TD_docs/constructors/updateMessageContent.md b/docs/TD_docs/constructors/updateMessageContent.md index 5d7735d5..a9962a23 100644 --- a/docs/TD_docs/constructors/updateMessageContent.md +++ b/docs/TD_docs/constructors/updateMessageContent.md @@ -1,20 +1,20 @@ --- title: updateMessageContent -description: Sent message gets new content +description: Message content has changed --- ## Constructor: updateMessageContent [Back to constructors index](index.md) -Sent message gets new content +Message content has changed ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| -|message\_id|[long](../types/long.md) | Yes|Message identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| |new\_content|[MessageContent](../types/MessageContent.md) | Yes|New message content| diff --git a/docs/TD_docs/constructors/updateMessageEdited.md b/docs/TD_docs/constructors/updateMessageEdited.md index be86f6a5..ac229463 100644 --- a/docs/TD_docs/constructors/updateMessageEdited.md +++ b/docs/TD_docs/constructors/updateMessageEdited.md @@ -13,8 +13,8 @@ Message was edited. Changes in the message content will come in a separate updat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| -|message\_id|[long](../types/long.md) | Yes|Message identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| |edit\_date|[int](../types/int.md) | Yes|Date the message was edited, unix time| |reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup, nullable| diff --git a/docs/TD_docs/constructors/updateMessageSendAcknowledged.md b/docs/TD_docs/constructors/updateMessageSendAcknowledged.md new file mode 100644 index 00000000..949d9f46 --- /dev/null +++ b/docs/TD_docs/constructors/updateMessageSendAcknowledged.md @@ -0,0 +1,23 @@ +--- +title: updateMessageSendAcknowledged +description: Message send request has reached Telegram server. It doesn't mean that message send will be successful or even that message send request will be processed. Update will not come, unless option "use_quick_ack" is set to true. The update may come many times for the same message +--- +## Constructor: updateMessageSendAcknowledged +[Back to constructors index](index.md) + + + +Message send request has reached Telegram server. It doesn't mean that message send will be successful or even that message send request will be processed. Update will not come, unless option "use_quick_ack" is set to true. The update may come many times for the same message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of sent message| +|message\_id|[int53](../types/int53.md) | Yes|Temporary message identifier| + + + +### Type: [Update](../types/Update.md) + + diff --git a/docs/TD_docs/constructors/updateMessageSendFailed.md b/docs/TD_docs/constructors/updateMessageSendFailed.md index 578791ab..116fae2b 100644 --- a/docs/TD_docs/constructors/updateMessageSendFailed.md +++ b/docs/TD_docs/constructors/updateMessageSendFailed.md @@ -1,20 +1,20 @@ --- title: updateMessageSendFailed -description: Message fails to send. Be aware that some being sent messages can be irrecoverably deleted and updateDeleteMessages will come instead of this update (or doesn't come at all if deletion was done by call to deleteMessages) +description: Message fails to send. Be aware that some being sent messages can be irrecoverably deleted and updateDeleteMessages will come instead of this update --- ## Constructor: updateMessageSendFailed [Back to constructors index](index.md) -Message fails to send. Be aware that some being sent messages can be irrecoverably deleted and updateDeleteMessages will come instead of this update (or doesn't come at all if deletion was done by call to deleteMessages) +Message fails to send. Be aware that some being sent messages can be irrecoverably deleted and updateDeleteMessages will come instead of this update ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| -|message\_id|[long](../types/long.md) | Yes|Message identifier| +|message|[message](../types/message.md) | Yes|Information about failed to send message| +|old\_message\_id|[int53](../types/int53.md) | Yes|Previous temporary message identifier| |error\_code|[int](../types/int.md) | Yes|Error code| |error\_message|[string](../types/string.md) | Yes|Error message| diff --git a/docs/TD_docs/constructors/updateMessageSendSucceeded.md b/docs/TD_docs/constructors/updateMessageSendSucceeded.md index 255808ae..0ad15324 100644 --- a/docs/TD_docs/constructors/updateMessageSendSucceeded.md +++ b/docs/TD_docs/constructors/updateMessageSendSucceeded.md @@ -13,8 +13,8 @@ Message is successfully sent | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|message|[message](../types/message.md) | Yes|Information about sent message. Usually only message identifier, date and content are changed, but some other fields may also change| -|old\_message\_id|[long](../types/long.md) | Yes|Previous temporary message identifier| +|message|[message](../types/message.md) | Yes|Information about sent message. Usually only message identifier, date and content are changed, but almost any other fields can also change| +|old\_message\_id|[int53](../types/int53.md) | Yes|Previous temporary message identifier| diff --git a/docs/TD_docs/constructors/updateMessageViews.md b/docs/TD_docs/constructors/updateMessageViews.md index c3100109..b3db2935 100644 --- a/docs/TD_docs/constructors/updateMessageViews.md +++ b/docs/TD_docs/constructors/updateMessageViews.md @@ -13,8 +13,8 @@ View count of the message has changed | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| -|message\_id|[long](../types/long.md) | Yes|Message identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| |views|[int](../types/int.md) | Yes|New value of view count| diff --git a/docs/TD_docs/constructors/updateNewCallbackQuery.md b/docs/TD_docs/constructors/updateNewCallbackQuery.md index 0698014a..407f48d4 100644 --- a/docs/TD_docs/constructors/updateNewCallbackQuery.md +++ b/docs/TD_docs/constructors/updateNewCallbackQuery.md @@ -15,8 +15,8 @@ Bots only. New incoming callback query |----------|---------------|----------|-------------| |id|[long](../types/long.md) | Yes|Unique query identifier| |sender\_user\_id|[int](../types/int.md) | Yes|Identifier of the user who sent the query| -|chat\_id|[long](../types/long.md) | Yes|Identifier of the chat, in which the query was sent| -|message\_id|[long](../types/long.md) | Yes|Identifier of the message, from which the query is originated| +|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat, in which the query was sent| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message, from which the query is originated| |chat\_instance|[long](../types/long.md) | Yes|Identifier, uniquely corresponding to the chat a message was sent to| |payload|[CallbackQueryPayload](../types/CallbackQueryPayload.md) | Yes|Query payload| diff --git a/docs/TD_docs/constructors/updateNewChat.md b/docs/TD_docs/constructors/updateNewChat.md new file mode 100644 index 00000000..ef73df92 --- /dev/null +++ b/docs/TD_docs/constructors/updateNewChat.md @@ -0,0 +1,22 @@ +--- +title: updateNewChat +description: New chat has been loaded/created. This update is guaranteed to come before chat identifier is returned to the client. Chat field changes will be reported through separate updates +--- +## Constructor: updateNewChat +[Back to constructors index](index.md) + + + +New chat has been loaded/created. This update is guaranteed to come before chat identifier is returned to the client. Chat field changes will be reported through separate updates + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat|[chat](../types/chat.md) | Yes|The chat| + + + +### Type: [Update](../types/Update.md) + + diff --git a/docs/TD_docs/constructors/updateNewCustomEvent.md b/docs/TD_docs/constructors/updateNewCustomEvent.md new file mode 100644 index 00000000..753301fe --- /dev/null +++ b/docs/TD_docs/constructors/updateNewCustomEvent.md @@ -0,0 +1,22 @@ +--- +title: updateNewCustomEvent +description: Bots only. New incoming event +--- +## Constructor: updateNewCustomEvent +[Back to constructors index](index.md) + + + +Bots only. New incoming event + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|event|[string](../types/string.md) | Yes|JSON-serialized event| + + + +### Type: [Update](../types/Update.md) + + diff --git a/docs/TD_docs/constructors/updateNewCustomQuery.md b/docs/TD_docs/constructors/updateNewCustomQuery.md new file mode 100644 index 00000000..608cfab4 --- /dev/null +++ b/docs/TD_docs/constructors/updateNewCustomQuery.md @@ -0,0 +1,24 @@ +--- +title: updateNewCustomQuery +description: Bots only. New incoming query +--- +## Constructor: updateNewCustomQuery +[Back to constructors index](index.md) + + + +Bots only. New incoming query + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Query identifier| +|data|[string](../types/string.md) | Yes|JSON-serialized query data| +|timeout|[int](../types/int.md) | Yes|Query timeout| + + + +### Type: [Update](../types/Update.md) + + diff --git a/docs/TD_docs/constructors/updateNewMessage.md b/docs/TD_docs/constructors/updateNewMessage.md index 13bbf384..f3227471 100644 --- a/docs/TD_docs/constructors/updateNewMessage.md +++ b/docs/TD_docs/constructors/updateNewMessage.md @@ -15,6 +15,7 @@ New message received, maybe outcoming message sent from other device |----------|---------------|----------|-------------| |message|[message](../types/message.md) | Yes|New message| |disable\_notification|[Bool](../types/Bool.md) | Yes|If true, notification about the message should be disabled| +|contains\_mention|[Bool](../types/Bool.md) | Yes|True, if the message contains mention of the current user| diff --git a/docs/TD_docs/constructors/updateNewPreCheckoutQuery.md b/docs/TD_docs/constructors/updateNewPreCheckoutQuery.md new file mode 100644 index 00000000..377800b6 --- /dev/null +++ b/docs/TD_docs/constructors/updateNewPreCheckoutQuery.md @@ -0,0 +1,28 @@ +--- +title: updateNewPreCheckoutQuery +description: Bots only. New incoming pre-checkout query. Contains full information about checkout +--- +## Constructor: updateNewPreCheckoutQuery +[Back to constructors index](index.md) + + + +Bots only. New incoming pre-checkout query. Contains full information about checkout + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Unique query identifier| +|sender\_user\_id|[int](../types/int.md) | Yes|Identifier of the user who sent the query| +|currency|[string](../types/string.md) | Yes|Currency for goods price| +|total\_amount|[int53](../types/int53.md) | Yes|Goods total price in minimal quantity of the currency| +|invoice\_payload|[bytes](../types/bytes.md) | Yes|Invoice payload| +|shipping\_option\_id|[string](../types/string.md) | Yes|Identifier of a choosed by user shipping option, may be empty if not applicable| +|order\_info|[orderInfo](../types/orderInfo.md) | Yes|Information about the order, nullable| + + + +### Type: [Update](../types/Update.md) + + diff --git a/docs/TD_docs/constructors/updateNewShippingQuery.md b/docs/TD_docs/constructors/updateNewShippingQuery.md new file mode 100644 index 00000000..7df52b02 --- /dev/null +++ b/docs/TD_docs/constructors/updateNewShippingQuery.md @@ -0,0 +1,25 @@ +--- +title: updateNewShippingQuery +description: Bots only. New incoming shipping query. Only for invoices with flexible price +--- +## Constructor: updateNewShippingQuery +[Back to constructors index](index.md) + + + +Bots only. New incoming shipping query. Only for invoices with flexible price + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Unique query identifier| +|sender\_user\_id|[int](../types/int.md) | Yes|Identifier of the user who sent the query| +|invoice\_payload|[string](../types/string.md) | Yes|Invoice payload| +|shipping\_address|[shippingAddress](../types/shippingAddress.md) | Yes|User shipping address| + + + +### Type: [Update](../types/Update.md) + + diff --git a/docs/TD_docs/constructors/updateOpenMessageContent.md b/docs/TD_docs/constructors/updateOpenMessageContent.md new file mode 100644 index 00000000..0568f7db --- /dev/null +++ b/docs/TD_docs/constructors/updateOpenMessageContent.md @@ -0,0 +1,23 @@ +--- +title: updateOpenMessageContent +description: Message content was opened. It makes voice messages listened, video note messages viewed and runs ttl timer +--- +## Constructor: updateOpenMessageContent +[Back to constructors index](index.md) + + + +Message content was opened. It makes voice messages listened, video note messages viewed and runs ttl timer + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| + + + +### Type: [Update](../types/Update.md) + + diff --git a/docs/TD_docs/constructors/updateRecentStickers.md b/docs/TD_docs/constructors/updateRecentStickers.md index d5dd2eed..166c5653 100644 --- a/docs/TD_docs/constructors/updateRecentStickers.md +++ b/docs/TD_docs/constructors/updateRecentStickers.md @@ -14,7 +14,7 @@ List of recently used stickers was updated | Name | Type | Required | Description | |----------|---------------|----------|-------------| |is\_attached|[Bool](../types/Bool.md) | Yes|True, if the list of stickers attached to photo or video files was updated, otherwise the list of sent stickers is updated| -|sticker\_ids|Array of [int](../constructors/int.md) | Yes|New list of recently used stickers| +|sticker\_ids|Array of [int](../constructors/int.md) | Yes|New list of file identifiers of recently used stickers| diff --git a/docs/TD_docs/constructors/updateSavedAnimations.md b/docs/TD_docs/constructors/updateSavedAnimations.md index 7a3de321..efa1e1d8 100644 --- a/docs/TD_docs/constructors/updateSavedAnimations.md +++ b/docs/TD_docs/constructors/updateSavedAnimations.md @@ -1,18 +1,19 @@ --- title: updateSavedAnimations -description: List of saved animations was updated. Need to drop saved animations cache if have some +description: List of saved animations was updated --- ## Constructor: updateSavedAnimations [Back to constructors index](index.md) -List of saved animations was updated. Need to drop saved animations cache if have some +List of saved animations was updated ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|animation\_ids|Array of [int](../constructors/int.md) | Yes|New list of file identifiers of saved animations| diff --git a/docs/TD_docs/constructors/updateSecretChat.md b/docs/TD_docs/constructors/updateSecretChat.md index 4e861ca7..9d26f149 100644 --- a/docs/TD_docs/constructors/updateSecretChat.md +++ b/docs/TD_docs/constructors/updateSecretChat.md @@ -1,13 +1,13 @@ --- title: updateSecretChat -description: Some data about a secret chat has been changed +description: Some data about a secret chat has been changed. This update is guaranteed to come before secret chat identifier is returned to the client, if library knows anything about the secret chat --- ## Constructor: updateSecretChat [Back to constructors index](index.md) -Some data about a secret chat has been changed +Some data about a secret chat has been changed. This update is guaranteed to come before secret chat identifier is returned to the client, if library knows anything about the secret chat ### Attributes: diff --git a/docs/TD_docs/constructors/updateUser.md b/docs/TD_docs/constructors/updateUser.md index 51e7c964..412f9398 100644 --- a/docs/TD_docs/constructors/updateUser.md +++ b/docs/TD_docs/constructors/updateUser.md @@ -1,13 +1,13 @@ --- title: updateUser -description: Some data about a user has been changed +description: Some data about a user has been changed. This update is guaranteed to come before user identifier is returned to the client, if library knows anything about the user --- ## Constructor: updateUser [Back to constructors index](index.md) -Some data about a user has been changed +Some data about a user has been changed. This update is guaranteed to come before user identifier is returned to the client, if library knows anything about the user ### Attributes: diff --git a/docs/TD_docs/constructors/updateUserAction.md b/docs/TD_docs/constructors/updateUserChatAction.md similarity index 50% rename from docs/TD_docs/constructors/updateUserAction.md rename to docs/TD_docs/constructors/updateUserChatAction.md index fc2d7d3b..1e0d49e6 100644 --- a/docs/TD_docs/constructors/updateUserAction.md +++ b/docs/TD_docs/constructors/updateUserChatAction.md @@ -1,21 +1,21 @@ --- -title: updateUserAction -description: Some chat activity +title: updateUserChatAction +description: User activity in the chat has changed --- -## Constructor: updateUserAction +## Constructor: updateUserChatAction [Back to constructors index](index.md) -Some chat activity +User activity in the chat has changed ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[long](../types/long.md) | Yes|Chat identifier| +|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| |user\_id|[int](../types/int.md) | Yes|Identifier of user doing action| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Action description| +|action|[ChatAction](../types/ChatAction.md) | Yes|Action description| diff --git a/docs/TD_docs/constructors/updateUserBlocked.md b/docs/TD_docs/constructors/updateUserFull.md similarity index 53% rename from docs/TD_docs/constructors/updateUserBlocked.md rename to docs/TD_docs/constructors/updateUserFull.md index 398ea48c..f260997e 100644 --- a/docs/TD_docs/constructors/updateUserBlocked.md +++ b/docs/TD_docs/constructors/updateUserFull.md @@ -1,20 +1,20 @@ --- -title: updateUserBlocked -description: User blocked/unblocked +title: updateUserFull +description: Some data from userFull has been changed --- -## Constructor: updateUserBlocked +## Constructor: updateUserFull [Back to constructors index](index.md) -User blocked/unblocked +Some data from userFull has been changed ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[int](../types/int.md) | Yes|User identifier| -|is\_blocked|[Bool](../types/Bool.md) | Yes|Is user blacklisted by current user| +|user\_full|[userFull](../types/userFull.md) | Yes|New full information about the user| diff --git a/docs/TD_docs/constructors/user.md b/docs/TD_docs/constructors/user.md index aa97a67b..16a6b51f 100644 --- a/docs/TD_docs/constructors/user.md +++ b/docs/TD_docs/constructors/user.md @@ -23,9 +23,10 @@ Represents user |my\_link|[LinkState](../types/LinkState.md) | Yes|Relationships from me to other user| |foreign\_link|[LinkState](../types/LinkState.md) | Yes|Relationships from other user to me| |is\_verified|[Bool](../types/Bool.md) | Yes|True, if user is verified| -|restriction\_reason|[string](../types/string.md) | Yes|If non-empty, contains the reason, why access to this user 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 user 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| |have\_access|[Bool](../types/Bool.md) | Yes|If false, the user is inaccessible and the only known information about it is inside this class. It can't be passed to any method except GetUser. Currently it can be false only for inaccessible authors of the channel posts| |type|[UserType](../types/UserType.md) | Yes|Type of the user| +|language\_code|[string](../types/string.md) | Yes|Bots only. IETF language tag of users language| diff --git a/docs/TD_docs/constructors/userFull.md b/docs/TD_docs/constructors/userFull.md index a5d22f2e..f698482e 100644 --- a/docs/TD_docs/constructors/userFull.md +++ b/docs/TD_docs/constructors/userFull.md @@ -13,9 +13,10 @@ Gives full information about a user (except full list of profile photos) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|user|[user](../types/user.md) | Yes|General info about the user| -|is\_blocked|[Bool](../types/Bool.md) | Yes|Is user blacklisted by current user| -|about|[string](../types/string.md) | Yes|Short user description| +|is\_blocked|[Bool](../types/Bool.md) | Yes|Is user blacklisted by the current user| +|can\_be\_called|[Bool](../types/Bool.md) | Yes|True, if the user can be called| +|has\_private\_calls|[Bool](../types/Bool.md) | Yes|True, if the user can't be called only because of his privacy settings| +|about|[string](../types/string.md) | Yes|Short user bio or bot share text| |common\_chat\_count|[int](../types/int.md) | Yes|Number of common chats between the user and current user, 0 for the current user| |bot\_info|[botInfo](../types/botInfo.md) | Yes|Information about bot if user is a bot, nullable| diff --git a/docs/TD_docs/constructors/users.md b/docs/TD_docs/constructors/users.md index 8487c2a4..9ed31b1f 100644 --- a/docs/TD_docs/constructors/users.md +++ b/docs/TD_docs/constructors/users.md @@ -1,20 +1,20 @@ --- title: users -description: Contains list of users +description: Represents list of users --- ## Constructor: users [Back to constructors index](index.md) -Contains list of users +Represents list of users ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |total\_count|[int](../types/int.md) | Yes|Approximate total count of found users| -|users|Array of [user](../constructors/user.md) | Yes|List of users| +|user\_ids|Array of [int](../constructors/int.md) | Yes|List of user identifiers| diff --git a/docs/TD_docs/constructors/validatedOrderInfo.md b/docs/TD_docs/constructors/validatedOrderInfo.md new file mode 100644 index 00000000..36a101c3 --- /dev/null +++ b/docs/TD_docs/constructors/validatedOrderInfo.md @@ -0,0 +1,23 @@ +--- +title: validatedOrderInfo +description: Contains temporary identifier of validated order information stored for an hour and available shipping options +--- +## Constructor: validatedOrderInfo +[Back to constructors index](index.md) + + + +Contains temporary identifier of validated order information stored for an hour and available shipping options + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|order\_info\_id|[string](../types/string.md) | Yes|Temporary identifier of order information| +|shipping\_options|Array of [shippingOption](../constructors/shippingOption.md) | Yes|Available shipping options| + + + +### Type: [ValidatedOrderInfo](../types/ValidatedOrderInfo.md) + + diff --git a/docs/TD_docs/constructors/videoNote.md b/docs/TD_docs/constructors/videoNote.md new file mode 100644 index 00000000..b651298f --- /dev/null +++ b/docs/TD_docs/constructors/videoNote.md @@ -0,0 +1,25 @@ +--- +title: videoNote +description: Describes video note. Video must have equal width and height, cropped to circle and stored in mpeg4 format +--- +## Constructor: videoNote +[Back to constructors index](index.md) + + + +Describes video note. Video must have equal width and height, cropped to circle and stored in mpeg4 format + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|duration|[int](../types/int.md) | Yes|Duration of the video in seconds as defined by sender| +|length|[int](../types/int.md) | Yes|Video width and height as defined by sender| +|thumb|[photoSize](../types/photoSize.md) | Yes|Video thumb as defined by sender, nullable| +|video|[file](../types/file.md) | Yes|File with the video| + + + +### Type: [VideoNote](../types/VideoNote.md) + + diff --git a/docs/TD_docs/constructors/voice.md b/docs/TD_docs/constructors/voice.md index 14b2fffc..e3cdf2a3 100644 --- a/docs/TD_docs/constructors/voice.md +++ b/docs/TD_docs/constructors/voice.md @@ -1,13 +1,13 @@ --- title: voice -description: Describes voice record. Voice must be encoded with Opus codec and must be stored inside Ogg container +description: Describes voice note. Voice must be encoded with Opus codec and must be stored inside Ogg container --- ## Constructor: voice [Back to constructors index](index.md) -Describes voice record. Voice must be encoded with Opus codec and must be stored inside Ogg container +Describes voice note. Voice must be encoded with Opus codec and must be stored inside Ogg container ### Attributes: diff --git a/docs/TD_docs/constructors/wallpaper.md b/docs/TD_docs/constructors/wallpaper.md index 0d68e758..3a1ea865 100644 --- a/docs/TD_docs/constructors/wallpaper.md +++ b/docs/TD_docs/constructors/wallpaper.md @@ -13,6 +13,7 @@ Contains information about one wallpaper | Name | Type | Required | Description | |----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Unique persistent wallpaper identifier| |sizes|Array of [photoSize](../constructors/photoSize.md) | Yes|Available variants of wallpaper of different sizes. These photos can be only downloaded and can't be sent in a message| |color|[int](../types/int.md) | Yes|Main color of wallpaper in RGB24, should be treated as background color if no photos are specified| diff --git a/docs/TD_docs/constructors/webPage.md b/docs/TD_docs/constructors/webPage.md index 0e71c5ce..5c533ceb 100644 --- a/docs/TD_docs/constructors/webPage.md +++ b/docs/TD_docs/constructors/webPage.md @@ -24,14 +24,16 @@ Describes web page preview |embed\_type|[string](../types/string.md) | Yes|MIME type of embedded preview, i.e. text/html or video/mp4| |embed\_width|[int](../types/int.md) | Yes|Width of embedded preview| |embed\_height|[int](../types/int.md) | Yes|Height of embedded preview| -|duration|[int](../types/int.md) | Yes|Duration of the content| +|duration|[int](../types/int.md) | Yes|Duration of the content in seconds| |author|[string](../types/string.md) | Yes|Author of the content| -|animation|[animation](../types/animation.md) | Yes|Preview as Animation if available, nullable| -|audio|[audio](../types/audio.md) | Yes|Preview as Audio if available, nullable| -|document|[document](../types/document.md) | Yes|Preview as Document if available (currently only for small pdf files and zip archives), nullable| -|sticker|[sticker](../types/sticker.md) | Yes|Preview as Sticker for small .webp files if available, nullable| -|video|[video](../types/video.md) | Yes|Preview as Video if available, nullable| -|voice|[voice](../types/voice.md) | Yes|Preview as Voice if available, nullable| +|animation|[animation](../types/animation.md) | Yes|Preview as an Animation if available, nullable| +|audio|[audio](../types/audio.md) | Yes|Preview as an Audio if available, nullable| +|document|[document](../types/document.md) | Yes|Preview as a Document if available (currently only for small pdf files and zip archives), nullable| +|sticker|[sticker](../types/sticker.md) | Yes|Preview as a Sticker for small .webp files if available, nullable| +|video|[video](../types/video.md) | Yes|Preview as a Video if available, nullable| +|video\_note|[videoNote](../types/videoNote.md) | Yes|Preview as a VideoNote if available, nullable| +|voice|[voice](../types/voice.md) | Yes|Preview as a Voice if available, nullable| +|has\_instant\_view|[Bool](../types/Bool.md) | Yes|True if web page has instant view| diff --git a/docs/TD_docs/constructors/webPageInstantView.md b/docs/TD_docs/constructors/webPageInstantView.md new file mode 100644 index 00000000..1044598c --- /dev/null +++ b/docs/TD_docs/constructors/webPageInstantView.md @@ -0,0 +1,23 @@ +--- +title: webPageInstantView +description: Describes instant view of a web page +--- +## Constructor: webPageInstantView +[Back to constructors index](index.md) + + + +Describes instant view of a web page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|page\_blocks|Array of [PageBlock](../constructors/PageBlock.md) | Yes|Content of the web page| +|is\_full|[Bool](../types/Bool.md) | Yes|True, if instant view contains full page. Network request may be needed to get full web page instant view| + + + +### Type: [WebPageInstantView](../types/WebPageInstantView.md) + + diff --git a/docs/TD_docs/methods/acceptCall.md b/docs/TD_docs/methods/acceptCall.md new file mode 100644 index 00000000..ddc22926 --- /dev/null +++ b/docs/TD_docs/methods/acceptCall.md @@ -0,0 +1,23 @@ +--- +title: acceptCall +description: Accepts incoming call +--- +## Method: acceptCall +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Accepts incoming call + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|call\_id|[int](../types/int.md) | Yes|Call identifier| +|protocol|[callProtocol](../types/callProtocol.md) | Yes|Description of supported by the client call protocols| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/addNetworkStatistics.md b/docs/TD_docs/methods/addNetworkStatistics.md new file mode 100644 index 00000000..07feecc8 --- /dev/null +++ b/docs/TD_docs/methods/addNetworkStatistics.md @@ -0,0 +1,22 @@ +--- +title: addNetworkStatistics +description: Adds specified data to data usage statistics. Can be called before authorization +--- +## Method: addNetworkStatistics +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Adds specified data to data usage statistics. Can be called before authorization + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|entry|[NetworkStatisticsEntry](../types/NetworkStatisticsEntry.md) | Yes|Network statistics entry with a data to add to statistics| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/addStickerToSet.md b/docs/TD_docs/methods/addStickerToSet.md new file mode 100644 index 00000000..1ded35a5 --- /dev/null +++ b/docs/TD_docs/methods/addStickerToSet.md @@ -0,0 +1,24 @@ +--- +title: addStickerToSet +description: Bots only. Adds new sticker to a set. Returns the sticker set +--- +## Method: addStickerToSet +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Bots only. Adds new sticker to a set. Returns the sticker set + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|Sticker set owner| +|name|[string](../types/string.md) | Yes|Sticker set name| +|sticker|[inputSticker](../types/inputSticker.md) | Yes|Sticker to add to the set| + + +### Return type: [StickerSet](../types/StickerSet.md) + diff --git a/docs/TD_docs/methods/answerCallbackQuery.md b/docs/TD_docs/methods/answerCallbackQuery.md index 78daa9bc..cfa51250 100644 --- a/docs/TD_docs/methods/answerCallbackQuery.md +++ b/docs/TD_docs/methods/answerCallbackQuery.md @@ -1,6 +1,6 @@ --- title: answerCallbackQuery -description: Bots only. Sets result of the callback query +description: Bots only. Sets result of a callback query --- ## Method: answerCallbackQuery [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Bots only. Sets result of the callback query YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Bots only. Sets result of the callback query +Bots only. Sets result of a callback query ### Params: diff --git a/docs/TD_docs/methods/answerCustomQuery.md b/docs/TD_docs/methods/answerCustomQuery.md new file mode 100644 index 00000000..caaa11ce --- /dev/null +++ b/docs/TD_docs/methods/answerCustomQuery.md @@ -0,0 +1,23 @@ +--- +title: answerCustomQuery +description: Bots only. Answers a custom query +--- +## Method: answerCustomQuery +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Bots only. Answers a custom query + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|custom\_query\_id|[long](../types/long.md) | Yes|Identifier of a custom query| +|data|[string](../types/string.md) | Yes|JSON-serialized answer to the query| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/answerInlineQuery.md b/docs/TD_docs/methods/answerInlineQuery.md index a39a0d48..9a5d47fa 100644 --- a/docs/TD_docs/methods/answerInlineQuery.md +++ b/docs/TD_docs/methods/answerInlineQuery.md @@ -1,6 +1,6 @@ --- title: answerInlineQuery -description: Bots only. Sets result of the inline query +description: Bots only. Sets result of an inline query --- ## Method: answerInlineQuery [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Bots only. Sets result of the inline query YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Bots only. Sets result of the inline query +Bots only. Sets result of an inline query ### Params: diff --git a/docs/TD_docs/methods/answerPreCheckoutQuery.md b/docs/TD_docs/methods/answerPreCheckoutQuery.md new file mode 100644 index 00000000..1c983dba --- /dev/null +++ b/docs/TD_docs/methods/answerPreCheckoutQuery.md @@ -0,0 +1,23 @@ +--- +title: answerPreCheckoutQuery +description: Bots only. Sets result of a pre checkout query +--- +## Method: answerPreCheckoutQuery +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Bots only. Sets result of a pre checkout query + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pre\_checkout\_query\_id|[long](../types/long.md) | Yes|Identifier of the pre-checkout query| +|error\_message|[string](../types/string.md) | Yes|Error message, empty on success| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/answerShippingQuery.md b/docs/TD_docs/methods/answerShippingQuery.md new file mode 100644 index 00000000..88077394 --- /dev/null +++ b/docs/TD_docs/methods/answerShippingQuery.md @@ -0,0 +1,24 @@ +--- +title: answerShippingQuery +description: Bots only. Sets result of a shipping query +--- +## Method: answerShippingQuery +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Bots only. Sets result of a shipping query + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|shipping\_query\_id|[long](../types/long.md) | Yes|Identifier of the shipping query| +|shipping\_options|Array of [shippingOption](../types/shippingOption.md) | Yes|Available shipping options| +|error\_message|[string](../types/string.md) | Yes|Error message, empty on success| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/cancelDownloadFile.md b/docs/TD_docs/methods/cancelDownloadFile.md index 134e6762..935b40ba 100644 --- a/docs/TD_docs/methods/cancelDownloadFile.md +++ b/docs/TD_docs/methods/cancelDownloadFile.md @@ -1,6 +1,6 @@ --- title: cancelDownloadFile -description: Stops file downloading. If file already downloaded do nothing. +description: Stops file downloading. If file is already downloaded, does nothing --- ## Method: cancelDownloadFile [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Stops file downloading. If file already downloaded do nothing. YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Stops file downloading. If file already downloaded do nothing. +Stops file downloading. If file is already downloaded, does nothing ### Params: diff --git a/docs/TD_docs/methods/cancelUploadFile.md b/docs/TD_docs/methods/cancelUploadFile.md new file mode 100644 index 00000000..7972da2a --- /dev/null +++ b/docs/TD_docs/methods/cancelUploadFile.md @@ -0,0 +1,22 @@ +--- +title: cancelUploadFile +description: Stops file uploading. Works only for files uploaded using uploadFile. For other files the behavior is undefined +--- +## Method: cancelUploadFile +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Stops file uploading. Works only for files uploaded using uploadFile. For other files the behavior is undefined + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file\_id|[int](../types/int.md) | Yes|Identifier of file to cancel upload| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/changeAbout.md b/docs/TD_docs/methods/changeAbout.md index 37468779..a3511d14 100644 --- a/docs/TD_docs/methods/changeAbout.md +++ b/docs/TD_docs/methods/changeAbout.md @@ -15,7 +15,7 @@ Changes about information of logged in user | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|about|[string](../types/string.md) | Yes|New value of userFull.about, 0-255 characters| +|about|[string](../types/string.md) | Yes|New value of userFull.about, 0-70 characters without line feeds| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChannelAbout.md b/docs/TD_docs/methods/changeChannelAbout.md deleted file mode 100644 index d88905bd..00000000 --- a/docs/TD_docs/methods/changeChannelAbout.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: changeChannelAbout -description: Changes information about the channel. Needs creator privileges in the broadcast channel or editor privileges in the supergroup channel ---- -## Method: changeChannelAbout -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - -Changes information about the channel. Needs creator privileges in the broadcast channel or editor privileges in the supergroup channel - -### Params: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| -|about|[string](../types/string.md) | Yes|New value of about, 0-255 characters| - - -### Return type: [Ok](../types/Ok.md) - diff --git a/docs/TD_docs/methods/changeChannelDescription.md b/docs/TD_docs/methods/changeChannelDescription.md new file mode 100644 index 00000000..65ae6c9e --- /dev/null +++ b/docs/TD_docs/methods/changeChannelDescription.md @@ -0,0 +1,23 @@ +--- +title: changeChannelDescription +description: Changes information about the channel. Needs appropriate rights in the channel +--- +## Method: changeChannelDescription +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Changes information about the channel. Needs appropriate rights in the channel + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| +|description|[string](../types/string.md) | Yes|New channel description, 0-255 characters| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/changeChatMemberStatus.md b/docs/TD_docs/methods/changeChatMemberStatus.md index b479be23..6db70f2f 100644 --- a/docs/TD_docs/methods/changeChatMemberStatus.md +++ b/docs/TD_docs/methods/changeChatMemberStatus.md @@ -1,6 +1,6 @@ --- title: changeChatMemberStatus -description: Changes status of the chat member, need appropriate privileges. In channel chats, user will be added to chat members if he is yet not a member and there is less than 200 members in the channel. - Status will not be changed until chat state will be synchronized with the server. Status will not be changed if application is killed before it can send request to the server +description: Changes status of the chat member, need appropriate privileges. This function is currently not suitable for adding new members to the chat, use addChatMember instead. Status will not be changed until chat state will be synchronized with the server. Status will not be changed if application is killed before it can send request to the server --- ## Method: changeChatMemberStatus [Back to methods index](index.md) @@ -9,14 +9,14 @@ description: Changes status of the chat member, need appropriate privileges. In YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Changes status of the chat member, need appropriate privileges. In channel chats, user will be added to chat members if he is yet not a member and there is less than 200 members in the channel. - Status will not be changed until chat state will be synchronized with the server. Status will not be changed if application is killed before it can send request to the server +Changes status of the chat member, need appropriate privileges. This function is currently not suitable for adding new members to the chat, use addChatMember instead. Status will not be changed until chat state will be synchronized with the server. Status will not be changed if application is killed before it can send request to the server ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| -|user\_id|[int](../types/int.md) | Yes|Identifier of the user to edit status, bots can be editors in the channel chats| +|user\_id|[int](../types/int.md) | Yes|Identifier of the user to edit status| |status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|New status of the member in the chat| diff --git a/docs/TD_docs/methods/changeChatPhoto.md b/docs/TD_docs/methods/changeChatPhoto.md index 044ed71d..c4cc9db1 100644 --- a/docs/TD_docs/methods/changeChatPhoto.md +++ b/docs/TD_docs/methods/changeChatPhoto.md @@ -1,6 +1,6 @@ --- title: changeChatPhoto -description: Changes chat photo. Photo can't be changed for private chats. Photo will not change until change will be synchronized with the server. Photo will not be changed if application is killed before it can send request to the server. - There will be update about change of the photo on success. Otherwise error will be returned +description: Changes chat photo. Works only for group and channel chats. Requires administrator rights in groups and appropriate administrator right in channels. Photo will not change before request to the server completes --- ## Method: changeChatPhoto [Back to methods index](index.md) @@ -9,14 +9,14 @@ description: Changes chat photo. Photo can't be changed for private chats. Photo YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Changes chat photo. Photo can't be changed for private chats. Photo will not change until change will be synchronized with the server. Photo will not be changed if application is killed before it can send request to the server. - There will be update about change of the photo on success. Otherwise error will be returned +Changes chat photo. Works only for group and channel chats. Requires administrator rights in groups and appropriate administrator right in channels. Photo will not change before request to the server completes ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| -|photo|[InputFile](../types/InputFile.md) | Yes|New chat photo. You can use zero InputFileId to delete photo. Files accessible only by HTTP URL are not acceptable| +|photo|[InputFile](../types/InputFile.md) | Yes|New chat photo. You can use zero InputFileId to delete chat photo. Files accessible only by HTTP URL are not acceptable| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChatTitle.md b/docs/TD_docs/methods/changeChatTitle.md index 83cee32f..f17c6ca6 100644 --- a/docs/TD_docs/methods/changeChatTitle.md +++ b/docs/TD_docs/methods/changeChatTitle.md @@ -1,6 +1,6 @@ --- title: changeChatTitle -description: Changes chat title. Title can't be changed for private chats. Title will not change until change will be synchronized with the server. Title will not be changed if application is killed before it can send request to the server. - There will be update about change of the title on success. Otherwise error will be returned +description: Changes chat title. Works only for group and channel chats. Requires administrator rights in groups and appropriate administrator right in channels. Title will not change before request to the server completes --- ## Method: changeChatTitle [Back to methods index](index.md) @@ -9,14 +9,14 @@ description: Changes chat title. Title can't be changed for private chats. Title YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Changes chat title. Title can't be changed for private chats. Title will not change until change will be synchronized with the server. Title will not be changed if application is killed before it can send request to the server. - There will be update about change of the title on success. Otherwise error will be returned +Changes chat title. Works only for group and channel chats. Requires administrator rights in groups and appropriate administrator right in channels. Title will not change before request to the server completes ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| -|title|[string](../types/string.md) | Yes|New title of a chat, 0-255 characters| +|title|[string](../types/string.md) | Yes|New title of the chat, 1-255 characters| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/updateStickerSet.md b/docs/TD_docs/methods/changeStickerSet.md similarity index 67% rename from docs/TD_docs/methods/updateStickerSet.md rename to docs/TD_docs/methods/changeStickerSet.md index ea12a5d3..2028f821 100644 --- a/docs/TD_docs/methods/updateStickerSet.md +++ b/docs/TD_docs/methods/changeStickerSet.md @@ -1,15 +1,15 @@ --- -title: updateStickerSet -description: Installs/uninstalls or enables/archives sticker set. Official sticker set can't be uninstalled, but it can be archived +title: changeStickerSet +description: Installs/uninstalls or enables/archives sticker set --- -## Method: updateStickerSet +## Method: changeStickerSet [Back to methods index](index.md) YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Installs/uninstalls or enables/archives sticker set. Official sticker set can't be uninstalled, but it can be archived +Installs/uninstalls or enables/archives sticker set ### Params: @@ -17,7 +17,7 @@ Installs/uninstalls or enables/archives sticker set. Official sticker set can't |----------|---------------|----------|-------------| |set\_id|[long](../types/long.md) | Yes|Identifier of the sticker set| |is\_installed|[Bool](../types/Bool.md) | Yes|New value of is_installed| -|is\_archived|[Bool](../types/Bool.md) | Yes|New value of is_archived| +|is\_archived|[Bool](../types/Bool.md) | Yes|New value of is_archived. A sticker set can't be installed and archived simultaneously| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/checkAuthBotToken.md b/docs/TD_docs/methods/checkAuthBotToken.md index 0a64364f..70a390d9 100644 --- a/docs/TD_docs/methods/checkAuthBotToken.md +++ b/docs/TD_docs/methods/checkAuthBotToken.md @@ -1,6 +1,6 @@ --- title: checkAuthBotToken -description: Check bot's authentication token to log in as a bot. Works only when authGetState returns authStateWaitPhoneNumber. Can be used instead of setAuthPhoneNumber and checkAuthCode to log in. Returns authStateOk on success +description: Check bot's authentication token to log in as a bot. Works only when getAuthState returns authStateWaitPhoneNumber. Can be used instead of setAuthPhoneNumber and checkAuthCode to log in. Returns authStateOk on success --- ## Method: checkAuthBotToken [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Check bot's authentication token to log in as a bot. Works only whe YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Check bot's authentication token to log in as a bot. Works only when authGetState returns authStateWaitPhoneNumber. Can be used instead of setAuthPhoneNumber and checkAuthCode to log in. Returns authStateOk on success +Check bot's authentication token to log in as a bot. Works only when getAuthState returns authStateWaitPhoneNumber. Can be used instead of setAuthPhoneNumber and checkAuthCode to log in. Returns authStateOk on success ### Params: diff --git a/docs/TD_docs/methods/checkAuthCode.md b/docs/TD_docs/methods/checkAuthCode.md index 4395faec..f2d480e4 100644 --- a/docs/TD_docs/methods/checkAuthCode.md +++ b/docs/TD_docs/methods/checkAuthCode.md @@ -1,6 +1,6 @@ --- title: checkAuthCode -description: Checks authentication code. Works only when authGetState returns authStateWaitCode. Returns authStateWaitPassword or authStateOk on success +description: Checks authentication code. Works only when getAuthState returns authStateWaitCode. Returns authStateWaitPassword or authStateOk on success --- ## Method: checkAuthCode [Back to methods index](index.md) @@ -9,13 +9,13 @@ description: Checks authentication code. Works only when authGetState returns au YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Checks authentication code. Works only when authGetState returns authStateWaitCode. Returns authStateWaitPassword or authStateOk on success +Checks authentication code. Works only when getAuthState returns authStateWaitCode. Returns authStateWaitPassword or authStateOk on success ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[string](../types/string.md) | Yes|Verification code from SMS, Telegram message, voice call or flash call| +|code|[string](../types/string.md) | Yes|Verification code from SMS, Telegram message, phone call or flash call| |first\_name|[string](../types/string.md) | Yes|User first name, if user is yet not registered, 1-255 characters| |last\_name|[string](../types/string.md) | Yes|Optional user last name, if user is yet not registered, 0-255 characters| diff --git a/docs/TD_docs/methods/checkAuthPassword.md b/docs/TD_docs/methods/checkAuthPassword.md index 1f7f52a6..ea3e73a3 100644 --- a/docs/TD_docs/methods/checkAuthPassword.md +++ b/docs/TD_docs/methods/checkAuthPassword.md @@ -1,6 +1,6 @@ --- title: checkAuthPassword -description: Checks password for correctness. Works only when authGetState returns authStateWaitPassword. Returns authStateOk on success +description: Checks password for correctness. Works only when getAuthState returns authStateWaitPassword. Returns authStateOk on success --- ## Method: checkAuthPassword [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Checks password for correctness. Works only when authGetState retur YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Checks password for correctness. Works only when authGetState returns authStateWaitPassword. Returns authStateOk on success +Checks password for correctness. Works only when getAuthState returns authStateWaitPassword. Returns authStateOk on success ### Params: diff --git a/docs/TD_docs/methods/checkChangePhoneNumberCode.md b/docs/TD_docs/methods/checkChangePhoneNumberCode.md index 676f9aed..fa7a78a0 100644 --- a/docs/TD_docs/methods/checkChangePhoneNumberCode.md +++ b/docs/TD_docs/methods/checkChangePhoneNumberCode.md @@ -15,7 +15,7 @@ Checks authentication code sent to change user's phone number. Returns authState | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|code|[string](../types/string.md) | Yes|Verification code from SMS, voice call or flash call| +|code|[string](../types/string.md) | Yes|Verification code from SMS, phone call or flash call| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/checkChatInviteLink.md b/docs/TD_docs/methods/checkChatInviteLink.md index 8b9c66be..a7892066 100644 --- a/docs/TD_docs/methods/checkChatInviteLink.md +++ b/docs/TD_docs/methods/checkChatInviteLink.md @@ -15,7 +15,7 @@ Checks chat invite link for validness and returns information about the correspo | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|invite\_link|[string](../types/string.md) | Yes|Invite link to check. Should begin with "https: telegram.me/joinchat/"| +|invite\_link|[string](../types/string.md) | Yes|Invite link to check. Should begin with "https: t.me/joinchat/", "https: telegram.me/joinchat/" or "https: telegram.dog/joinchat/"| ### Return type: [ChatInviteLinkInfo](../types/ChatInviteLinkInfo.md) diff --git a/docs/TD_docs/methods/createCall.md b/docs/TD_docs/methods/createCall.md new file mode 100644 index 00000000..ff0dc1fe --- /dev/null +++ b/docs/TD_docs/methods/createCall.md @@ -0,0 +1,23 @@ +--- +title: createCall +description: Creates new call +--- +## Method: createCall +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Creates new call + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|Identifier of user to call| +|protocol|[callProtocol](../types/callProtocol.md) | Yes|Description of supported by the client call protocols| + + +### Return type: [CallId](../types/CallId.md) + diff --git a/docs/TD_docs/methods/createNewChannelChat.md b/docs/TD_docs/methods/createNewChannelChat.md index 05afb95f..dce9c3cb 100644 --- a/docs/TD_docs/methods/createNewChannelChat.md +++ b/docs/TD_docs/methods/createNewChannelChat.md @@ -15,9 +15,9 @@ Creates new channel chat and send corresponding messageChannelChatCreate, return | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|title|[string](../types/string.md) | Yes|Title of new channel chat, 0-255 characters| +|title|[string](../types/string.md) | Yes|Title of new channel chat, 1-255 characters| |is\_supergroup|[Bool](../types/Bool.md) | Yes|True, if supergroup chat should be created| -|about|[string](../types/string.md) | Yes|Information about the channel, 0-255 characters| +|description|[string](../types/string.md) | Yes|Channel description, 0-255 characters| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createNewGroupChat.md b/docs/TD_docs/methods/createNewGroupChat.md index 62bcec06..2df598e2 100644 --- a/docs/TD_docs/methods/createNewGroupChat.md +++ b/docs/TD_docs/methods/createNewGroupChat.md @@ -16,7 +16,7 @@ Creates new group chat and send corresponding messageGroupChatCreate, returns cr | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_ids|Array of [int](../types/int.md) | Yes|Identifiers of users to add to the group| -|title|[string](../types/string.md) | Yes|Title of new group chat, 0-255 characters| +|title|[string](../types/string.md) | Yes|Title of new group chat, 1-255 characters| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createNewStickerSet.md b/docs/TD_docs/methods/createNewStickerSet.md new file mode 100644 index 00000000..261a153a --- /dev/null +++ b/docs/TD_docs/methods/createNewStickerSet.md @@ -0,0 +1,26 @@ +--- +title: createNewStickerSet +description: Bots only. Creates new sticker set. Returns created sticker set +--- +## Method: createNewStickerSet +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Bots only. Creates new sticker set. Returns created sticker set + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|Sticker set owner| +|title|[string](../types/string.md) | Yes|Sticker set title, 1-64 characters| +|name|[string](../types/string.md) | Yes|Sticker set name. Can contain only english letters, digits and underscores. Should end on *"_by_"*. ** is case insensitive, 1-64 characters| +|is\_masks|[Bool](../types/Bool.md) | Yes|True, is stickers are masks| +|stickers|Array of [inputSticker](../types/inputSticker.md) | Yes|List of stickers to add to the set| + + +### Return type: [StickerSet](../types/StickerSet.md) + diff --git a/docs/TD_docs/methods/createTemporaryPassword.md b/docs/TD_docs/methods/createTemporaryPassword.md new file mode 100644 index 00000000..ef0d4790 --- /dev/null +++ b/docs/TD_docs/methods/createTemporaryPassword.md @@ -0,0 +1,23 @@ +--- +title: createTemporaryPassword +description: Creates new temporary password for payments processing +--- +## Method: createTemporaryPassword +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Creates new temporary password for payments processing + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|password|[string](../types/string.md) | Yes|Persistent user password| +|valid\_for|[int](../types/int.md) | Yes|Time before temporary password will expire, seconds. Should be between 60 and 86400| + + +### Return type: [TemporaryPasswordState](../types/TemporaryPasswordState.md) + diff --git a/docs/TD_docs/methods/debugCall.md b/docs/TD_docs/methods/debugCall.md new file mode 100644 index 00000000..e60eecc9 --- /dev/null +++ b/docs/TD_docs/methods/debugCall.md @@ -0,0 +1,23 @@ +--- +title: debugCall +description: Sends call debug information +--- +## Method: debugCall +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Sends call debug information + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|call\_id|[int](../types/int.md) | Yes|Call identifier| +|debug|[string](../types/string.md) | Yes|Debug information in application specific format| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/deleteChatReplyMarkup.md b/docs/TD_docs/methods/deleteChatReplyMarkup.md index e8895939..45975ab8 100644 --- a/docs/TD_docs/methods/deleteChatReplyMarkup.md +++ b/docs/TD_docs/methods/deleteChatReplyMarkup.md @@ -16,7 +16,7 @@ Deletes default reply markup from chat. This method needs to be called after one | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| -|message\_id|[long](../types/long.md) | Yes|Message identifier of used keyboard| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier of used keyboard| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteFile.md b/docs/TD_docs/methods/deleteFile.md new file mode 100644 index 00000000..c3569655 --- /dev/null +++ b/docs/TD_docs/methods/deleteFile.md @@ -0,0 +1,22 @@ +--- +title: deleteFile +description: Deletes a file from TDLib file cache +--- +## Method: deleteFile +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Deletes a file from TDLib file cache + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file\_id|[int](../types/int.md) | Yes|Identifier of the file to delete| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/deleteMessages.md b/docs/TD_docs/methods/deleteMessages.md index 0cf687c8..74540649 100644 --- a/docs/TD_docs/methods/deleteMessages.md +++ b/docs/TD_docs/methods/deleteMessages.md @@ -1,6 +1,6 @@ --- title: deleteMessages -description: Deletes messages. UpdateDeleteMessages will not be sent for messages deleted through that function +description: Deletes messages --- ## Method: deleteMessages [Back to methods index](index.md) @@ -9,14 +9,15 @@ description: Deletes messages. UpdateDeleteMessages will not be sent for message YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Deletes messages. UpdateDeleteMessages will not be sent for messages deleted through that function +Deletes messages ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| -|message\_ids|Array of [long](../types/long.md) | Yes|Identifiers of messages to delete| +|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of messages to delete| +|revoke|[Bool](../types/Bool.md) | Yes|Pass true to try to delete sent messages for all chat members (may fail if messages are too old). Is always true for Channels and SecretChats| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteMessagesFromUser.md b/docs/TD_docs/methods/deleteMessagesFromUser.md index d5f569ca..678a7fa3 100644 --- a/docs/TD_docs/methods/deleteMessagesFromUser.md +++ b/docs/TD_docs/methods/deleteMessagesFromUser.md @@ -1,6 +1,6 @@ --- title: deleteMessagesFromUser -description: Deletes all messages in the chat sent by the specified user. Works only in supergroup channel chats, needs appropriate privileges +description: Deletes all messages in the chat sent by the specified user. Works only in supergroup channel chats, needs can_delete_messages administrator privileges --- ## Method: deleteMessagesFromUser [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Deletes all messages in the chat sent by the specified user. Works YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Deletes all messages in the chat sent by the specified user. Works only in supergroup channel chats, needs appropriate privileges +Deletes all messages in the chat sent by the specified user. Works only in supergroup channel chats, needs can_delete_messages administrator privileges ### Params: diff --git a/docs/TD_docs/methods/deleteRecentHashtag.md b/docs/TD_docs/methods/deleteRecentHashtag.md new file mode 100644 index 00000000..e40b2b8d --- /dev/null +++ b/docs/TD_docs/methods/deleteRecentHashtag.md @@ -0,0 +1,22 @@ +--- +title: deleteRecentHashtag +description: Deletes a hashtag from the list of recently used hashtags +--- +## Method: deleteRecentHashtag +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Deletes a hashtag from the list of recently used hashtags + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hashtag|[string](../types/string.md) | Yes|The hashtag to delete| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/deleteSavedCredentials.md b/docs/TD_docs/methods/deleteSavedCredentials.md new file mode 100644 index 00000000..7f50a1db --- /dev/null +++ b/docs/TD_docs/methods/deleteSavedCredentials.md @@ -0,0 +1,21 @@ +--- +title: deleteSavedCredentials +description: Deletes saved credentials for all payments provider bots +--- +## Method: deleteSavedCredentials +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Deletes saved credentials for all payments provider bots + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/getDeviceTokens.md b/docs/TD_docs/methods/deleteSavedOrderInfo.md similarity index 52% rename from docs/TD_docs/methods/getDeviceTokens.md rename to docs/TD_docs/methods/deleteSavedOrderInfo.md index 29821280..15a63eed 100644 --- a/docs/TD_docs/methods/getDeviceTokens.md +++ b/docs/TD_docs/methods/deleteSavedOrderInfo.md @@ -1,15 +1,15 @@ --- -title: getDeviceTokens -description: Returns list of used device tokens +title: deleteSavedOrderInfo +description: Deletes saved order info --- -## Method: getDeviceTokens +## Method: deleteSavedOrderInfo [Back to methods index](index.md) YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Returns list of used device tokens +Deletes saved order info ### Params: @@ -17,5 +17,5 @@ Returns list of used device tokens |----------|---------------|----------|-------------| -### Return type: [DeviceTokenSet](../types/DeviceTokenSet.md) +### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteStickerFromSet.md b/docs/TD_docs/methods/deleteStickerFromSet.md new file mode 100644 index 00000000..07e1640d --- /dev/null +++ b/docs/TD_docs/methods/deleteStickerFromSet.md @@ -0,0 +1,22 @@ +--- +title: deleteStickerFromSet +description: Bots only. Deletes a sticker from the set it belongs to. Sticker set should be created by the bot +--- +## Method: deleteStickerFromSet +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Bots only. Deletes a sticker from the set it belongs to. Sticker set should be created by the bot + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[InputFile](../types/InputFile.md) | Yes|The sticker| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/deleteTopChat.md b/docs/TD_docs/methods/deleteTopChat.md new file mode 100644 index 00000000..ed798b52 --- /dev/null +++ b/docs/TD_docs/methods/deleteTopChat.md @@ -0,0 +1,23 @@ +--- +title: deleteTopChat +description: Delete a chat from a list of frequently used chats. Supported only if chat info database is enabled +--- +## Method: deleteTopChat +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Delete a chat from a list of frequently used chats. Supported only if chat info database is enabled + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|category|[TopChatCategory](../types/TopChatCategory.md) | Yes|Category of frequently used chats| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/discardCall.md b/docs/TD_docs/methods/discardCall.md new file mode 100644 index 00000000..78819628 --- /dev/null +++ b/docs/TD_docs/methods/discardCall.md @@ -0,0 +1,25 @@ +--- +title: discardCall +description: Discards a call +--- +## Method: discardCall +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Discards a call + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|call\_id|[int](../types/int.md) | Yes|Call identifier| +|is\_disconnected|[Bool](../types/Bool.md) | Yes|True, if users was disconnected| +|duration|[int](../types/int.md) | Yes|Call duration in seconds| +|connection\_id|[long](../types/long.md) | Yes|Identifier of a connection used during the call| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/downloadFile.md b/docs/TD_docs/methods/downloadFile.md index bf00d80d..dce3585c 100644 --- a/docs/TD_docs/methods/downloadFile.md +++ b/docs/TD_docs/methods/downloadFile.md @@ -1,6 +1,6 @@ --- title: downloadFile -description: Asynchronously downloads file from cloud. Updates updateFileProgress will notify about download progress. Update updateFile will notify about successful download +description: Asynchronously downloads file from cloud. Updates updateFile will notify about download progress and successful download --- ## Method: downloadFile [Back to methods index](index.md) @@ -9,13 +9,14 @@ description: Asynchronously downloads file from cloud. Updates updateFileProgres YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Asynchronously downloads file from cloud. Updates updateFileProgress will notify about download progress. Update updateFile will notify about successful download +Asynchronously downloads file from cloud. Updates updateFile will notify about download progress and successful download ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |file\_id|[int](../types/int.md) | Yes|Identifier of file to download| +|priority|[int](../types/int.md) | Yes|Priority of download, 1-32. The higher priority, the earlier file will be downloaded. If priorities of two files are equal then the last one for which downloadFile is called will be downloaded first| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/editMessageCaption.md b/docs/TD_docs/methods/editMessageCaption.md index 1aa1189e..de4c22fa 100644 --- a/docs/TD_docs/methods/editMessageCaption.md +++ b/docs/TD_docs/methods/editMessageCaption.md @@ -16,7 +16,7 @@ Edits message content caption. Non-bots can edit message in a limited period of | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat the message belongs to| -|message\_id|[long](../types/long.md) | Yes|Identifier of the message| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| |reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. New message reply markup| |caption|[string](../types/string.md) | Yes|New message content caption, 0-200 characters| diff --git a/docs/TD_docs/methods/editMessageReplyMarkup.md b/docs/TD_docs/methods/editMessageReplyMarkup.md index 51a30adb..b74b01fd 100644 --- a/docs/TD_docs/methods/editMessageReplyMarkup.md +++ b/docs/TD_docs/methods/editMessageReplyMarkup.md @@ -16,7 +16,7 @@ Bots only. Edits message reply markup. Returns edited message after edit is comp | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat the message belongs to| -|message\_id|[long](../types/long.md) | Yes|Identifier of the message| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| |reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| diff --git a/docs/TD_docs/methods/editMessageText.md b/docs/TD_docs/methods/editMessageText.md index b184f3dc..dad44be4 100644 --- a/docs/TD_docs/methods/editMessageText.md +++ b/docs/TD_docs/methods/editMessageText.md @@ -16,7 +16,7 @@ Edits text of text or game message. Non-bots can edit message in a limited perio | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat the message belongs to| -|message\_id|[long](../types/long.md) | Yes|Identifier of the message| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| |reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. New message reply markup| |input\_message\_content|[InputMessageContent](../types/InputMessageContent.md) | Yes|New text content of the message. Should be of type InputMessageText| diff --git a/docs/TD_docs/methods/exportChatInviteLink.md b/docs/TD_docs/methods/exportChatInviteLink.md index 07ce41c1..b009f3e1 100644 --- a/docs/TD_docs/methods/exportChatInviteLink.md +++ b/docs/TD_docs/methods/exportChatInviteLink.md @@ -1,6 +1,6 @@ --- title: exportChatInviteLink -description: Generates new chat invite link, previously generated link is revoked. Available for group and channel chats. Only creator of the chat can export chat invite link +description: Generates new chat invite link, previously generated link is revoked. Available for group and channel chats. In groups can be called only by creator, in channels requires appropriate rights --- ## Method: exportChatInviteLink [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Generates new chat invite link, previously generated link is revoke YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Generates new chat invite link, previously generated link is revoked. Available for group and channel chats. Only creator of the chat can export chat invite link +Generates new chat invite link, previously generated link is revoked. Available for group and channel chats. In groups can be called only by creator, in channels requires appropriate rights ### Params: diff --git a/docs/TD_docs/methods/forwardMessages.md b/docs/TD_docs/methods/forwardMessages.md index da32cbf1..006054dc 100644 --- a/docs/TD_docs/methods/forwardMessages.md +++ b/docs/TD_docs/methods/forwardMessages.md @@ -16,8 +16,8 @@ Forwards previously sent messages. Returns forwarded messages in the same order | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Identifier of a chat to forward messages| -|from\_chat\_id|[long](../types/long.md) | Yes|Identifier of a chat to forward from| -|message\_ids|Array of [long](../types/long.md) | Yes|Identifiers of messages to forward| +|from\_chat\_id|[int53](../types/int53.md) | Yes|Identifier of a chat to forward from| +|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of messages to forward| |disable\_notification|[Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works if messages are forwarded to secret chat| |from\_background|[Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| diff --git a/docs/TD_docs/methods/getArchivedStickerSets.md b/docs/TD_docs/methods/getArchivedStickerSets.md index 728e2980..a9357a73 100644 --- a/docs/TD_docs/methods/getArchivedStickerSets.md +++ b/docs/TD_docs/methods/getArchivedStickerSets.md @@ -15,7 +15,7 @@ Returns list of archived sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to return masks, pass false to return stickers| +|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to return mask stickers sets, pass false to return ordinary sticker sets| |offset\_sticker\_set\_id|[long](../types/long.md) | Yes|Identifier of the sticker set from which return the result| |limit|[int](../types/int.md) | Yes|Maximum number of sticker sets to return| diff --git a/docs/TD_docs/methods/getCallbackQueryAnswer.md b/docs/TD_docs/methods/getCallbackQueryAnswer.md index 6c821554..31bb7bd4 100644 --- a/docs/TD_docs/methods/getCallbackQueryAnswer.md +++ b/docs/TD_docs/methods/getCallbackQueryAnswer.md @@ -1,6 +1,6 @@ --- title: getCallbackQueryAnswer -description: Sends callback query to a bot and returns answer to it. Unavailable for bots +description: Sends callback query to a bot and returns answer to it. Returns error with code 502 if bot fails to answer the query before query timeout expires. Unavailable for bots --- ## Method: getCallbackQueryAnswer [Back to methods index](index.md) @@ -9,14 +9,14 @@ description: Sends callback query to a bot and returns answer to it. Unavailable YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Sends callback query to a bot and returns answer to it. Unavailable for bots +Sends callback query to a bot and returns answer to it. Returns error with code 502 if bot fails to answer the query before query timeout expires. Unavailable for bots ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Identifier of the chat with a message| -|message\_id|[long](../types/long.md) | Yes|Identifier of the message, from which the query is originated| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message, from which the query is originated| |payload|[CallbackQueryPayload](../types/CallbackQueryPayload.md) | Yes|Query payload| diff --git a/docs/TD_docs/methods/getChannelMembers.md b/docs/TD_docs/methods/getChannelMembers.md index 39ee0f62..50a6a8ab 100644 --- a/docs/TD_docs/methods/getChannelMembers.md +++ b/docs/TD_docs/methods/getChannelMembers.md @@ -1,6 +1,6 @@ --- title: getChannelMembers -description: Returns information about channel members or kicked from channel users. Can be used only if channel_full->can_get_members == true +description: Returns information about channel members or banned users. Can be used only if channel_full->can_get_members == true. Administrator privileges may be additionally needed for some filters --- ## Method: getChannelMembers [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Returns information about channel members or kicked from channel us YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Returns information about channel members or kicked from channel users. Can be used only if channel_full->can_get_members == true +Returns information about channel members or banned users. Can be used only if channel_full->can_get_members == true. Administrator privileges may be additionally needed for some filters ### Params: diff --git a/docs/TD_docs/methods/getChatEventLog.md b/docs/TD_docs/methods/getChatEventLog.md new file mode 100644 index 00000000..4609a679 --- /dev/null +++ b/docs/TD_docs/methods/getChatEventLog.md @@ -0,0 +1,27 @@ +--- +title: getChatEventLog +description: Returns list of service actions taken by chat members and administrators in the last 48 hours, available only in channels. Requires administrator rights. Returns result in reverse chronological order, i. e. in order of decreasing event_id +--- +## Method: getChatEventLog +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns list of service actions taken by chat members and administrators in the last 48 hours, available only in channels. Requires administrator rights. Returns result in reverse chronological order, i. e. in order of decreasing event_id + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| +|query|[string](../types/string.md) | Yes|Search query to filter events| +|from\_event\_id|[long](../types/long.md) | Yes|Identifier of an event from which to return result, you can use 0 to get results from the latest events| +|limit|[int](../types/int.md) | Yes|Maximum number of events to return, can't be greater than 100| +|filters|[chatEventLogFilters](../types/chatEventLogFilters.md) | Yes|Types of events to return, defaults to all| +|user\_ids|Array of [int](../types/int.md) | Yes|User identifiers, which events to return, defaults to all users| + + +### Return type: [ChatEvents](../types/ChatEvents.md) + diff --git a/docs/TD_docs/methods/getChatHistory.md b/docs/TD_docs/methods/getChatHistory.md index b630abca..54381784 100644 --- a/docs/TD_docs/methods/getChatHistory.md +++ b/docs/TD_docs/methods/getChatHistory.md @@ -1,6 +1,6 @@ --- title: getChatHistory -description: Returns messages in a chat. Automatically calls openChat. Returns result in reverse chronological order, i.e. in order of decreasing message.message_id +description: Returns messages in a chat. Automatically calls openChat. Returns result in reverse chronological order, i.e. in order of decreasing message.message_id. Offline request if only_local is true --- ## Method: getChatHistory [Back to methods index](index.md) @@ -9,16 +9,17 @@ description: Returns messages in a chat. Automatically calls openChat. Returns r YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Returns messages in a chat. Automatically calls openChat. Returns result in reverse chronological order, i.e. in order of decreasing message.message_id +Returns messages in a chat. Automatically calls openChat. Returns result in reverse chronological order, i.e. in order of decreasing message.message_id. Offline request if only_local is true ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| -|from\_message\_id|[long](../types/long.md) | Yes|Identifier of the message near which we need a history, you can use 0 to get results from the beginning, i.e. from oldest to newest| +|from\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message near which we need a history, you can use 0 to get results from the beginning, i.e. from oldest to newest| |offset|[int](../types/int.md) | Yes|Specify 0 to get results exactly from from_message_id or negative offset to get specified message and some newer messages| |limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, should be positive and can't be greater than 100. If offset is negative, limit must be greater than -offset. There may be less than limit messages returned even the end of the history is not reached| +|only\_local|[Bool](../types/Bool.md) | Yes|Return only locally available messages without sending network requests| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/getChats.md b/docs/TD_docs/methods/getChats.md index 9fea93e6..dfaac36d 100644 --- a/docs/TD_docs/methods/getChats.md +++ b/docs/TD_docs/methods/getChats.md @@ -16,8 +16,8 @@ Returns list of chats in the right order, chats are sorted by (order, chat_id) i | Name | Type | Required | Description | |----------|---------------|----------|-------------| |offset\_order|[long](../types/long.md) | Yes|Chat order to return chats from| -|offset\_chat\_id|[long](../types/long.md) | Yes|Chat identifier to return chats from| -|limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned| +|offset\_chat\_id|[int53](../types/int53.md) | Yes|Chat identifier to return chats from| +|limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned. There may be less than limit chats returned even the end of the list is not reached| ### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/getCommonChats.md b/docs/TD_docs/methods/getCommonChats.md index 71dd6162..33fe3f8d 100644 --- a/docs/TD_docs/methods/getCommonChats.md +++ b/docs/TD_docs/methods/getCommonChats.md @@ -16,7 +16,7 @@ Returns list of common chats with an other given user. Chats are sorted by their | Name | Type | Required | Description | |----------|---------------|----------|-------------| |user\_id|[int](../types/int.md) | Yes|User identifier| -|offset\_chat\_id|[long](../types/long.md) | Yes|Chat identifier to return chats from, use 0 for the first request| +|offset\_chat\_id|[int53](../types/int53.md) | Yes|Chat identifier to return chats from, use 0 for the first request| |limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned, up to 100| diff --git a/docs/TD_docs/methods/getCreatedPublicChannels.md b/docs/TD_docs/methods/getCreatedPublicChats.md similarity index 50% rename from docs/TD_docs/methods/getCreatedPublicChannels.md rename to docs/TD_docs/methods/getCreatedPublicChats.md index 55783f6b..41897590 100644 --- a/docs/TD_docs/methods/getCreatedPublicChannels.md +++ b/docs/TD_docs/methods/getCreatedPublicChats.md @@ -1,15 +1,15 @@ --- -title: getCreatedPublicChannels -description: Returns list of created public channels +title: getCreatedPublicChats +description: Returns list of created public chats --- -## Method: getCreatedPublicChannels +## Method: getCreatedPublicChats [Back to methods index](index.md) YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Returns list of created public channels +Returns list of created public chats ### Params: @@ -17,5 +17,5 @@ Returns list of created public channels |----------|---------------|----------|-------------| -### Return type: [Channels](../types/Channels.md) +### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/getFilePersistent.md b/docs/TD_docs/methods/getFilePersistent.md index dba04502..00611123 100644 --- a/docs/TD_docs/methods/getFilePersistent.md +++ b/docs/TD_docs/methods/getFilePersistent.md @@ -1,6 +1,6 @@ --- title: getFilePersistent -description: Returns information about a file by its persistent id, offline request +description: Returns information about a file by its persistent id, offline request. May be used to register a URL as a file for further uploading or sending as message --- ## Method: getFilePersistent [Back to methods index](index.md) @@ -9,13 +9,14 @@ description: Returns information about a file by its persistent id, offline requ YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Returns information about a file by its persistent id, offline request +Returns information about a file by its persistent id, offline request. May be used to register a URL as a file for further uploading or sending as message ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |persistent\_file\_id|[string](../types/string.md) | Yes|Persistent identifier of the file to get| +|file\_type|[FileType](../types/FileType.md) | Yes|File type, if known| ### Return type: [File](../types/File.md) diff --git a/docs/TD_docs/methods/getGameHighScores.md b/docs/TD_docs/methods/getGameHighScores.md index 1233e99c..6d6e39da 100644 --- a/docs/TD_docs/methods/getGameHighScores.md +++ b/docs/TD_docs/methods/getGameHighScores.md @@ -16,7 +16,7 @@ Bots only. Returns game high scores and some part of the score table around of t | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat a message with the game belongs to| -|message\_id|[long](../types/long.md) | Yes|Identifier of the message| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| |user\_id|[int](../types/int.md) | Yes|User identifie| diff --git a/docs/TD_docs/methods/getInlineQueryResults.md b/docs/TD_docs/methods/getInlineQueryResults.md index cf404f95..f32c6736 100644 --- a/docs/TD_docs/methods/getInlineQueryResults.md +++ b/docs/TD_docs/methods/getInlineQueryResults.md @@ -1,6 +1,6 @@ --- title: getInlineQueryResults -description: Sends inline query to a bot and returns its results. Unavailable for bots +description: Sends inline query to a bot and returns its results. Returns error with code 502 if bot fails to answer the query before query timeout expires. Unavailable for bots --- ## Method: getInlineQueryResults [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Sends inline query to a bot and returns its results. Unavailable fo YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Sends inline query to a bot and returns its results. Unavailable for bots +Sends inline query to a bot and returns its results. Returns error with code 502 if bot fails to answer the query before query timeout expires. Unavailable for bots ### Params: diff --git a/docs/TD_docs/methods/getStickerSets.md b/docs/TD_docs/methods/getInstalledStickerSets.md similarity index 58% rename from docs/TD_docs/methods/getStickerSets.md rename to docs/TD_docs/methods/getInstalledStickerSets.md index 5e665d8a..96cc00c9 100644 --- a/docs/TD_docs/methods/getStickerSets.md +++ b/docs/TD_docs/methods/getInstalledStickerSets.md @@ -1,21 +1,21 @@ --- -title: getStickerSets -description: Returns list of installed sticker sets without archived sticker sets +title: getInstalledStickerSets +description: Returns list of installed sticker sets --- -## Method: getStickerSets +## Method: getInstalledStickerSets [Back to methods index](index.md) YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Returns list of installed sticker sets without archived sticker sets +Returns list of installed sticker sets ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to return masks, pass false to return stickers| +|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to return mask sticker sets, pass false to return ordinary sticker sets| ### Return type: [StickerSets](../types/StickerSets.md) diff --git a/docs/TD_docs/methods/getInviteText.md b/docs/TD_docs/methods/getInviteText.md new file mode 100644 index 00000000..afb4af15 --- /dev/null +++ b/docs/TD_docs/methods/getInviteText.md @@ -0,0 +1,21 @@ +--- +title: getInviteText +description: Returns invite text for invitation of new users +--- +## Method: getInviteText +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns invite text for invitation of new users + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [Text](../types/Text.md) + diff --git a/docs/TD_docs/methods/getMessage.md b/docs/TD_docs/methods/getMessage.md index bfc4922a..66514eec 100644 --- a/docs/TD_docs/methods/getMessage.md +++ b/docs/TD_docs/methods/getMessage.md @@ -16,7 +16,7 @@ Returns information about a message | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Identifier of the chat, message belongs to| -|message\_id|[long](../types/long.md) | Yes|Identifier of the message to get| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message to get| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/getMessages.md b/docs/TD_docs/methods/getMessages.md index a35deb82..256db652 100644 --- a/docs/TD_docs/methods/getMessages.md +++ b/docs/TD_docs/methods/getMessages.md @@ -16,7 +16,7 @@ Returns information about messages. If message is not found, returns null on the | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Identifier of the chat, messages belongs to| -|message\_ids|Array of [long](../types/long.md) | Yes|Identifiers of the messages to get| +|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of the messages to get| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/getNetworkStatistics.md b/docs/TD_docs/methods/getNetworkStatistics.md new file mode 100644 index 00000000..c7b6c67f --- /dev/null +++ b/docs/TD_docs/methods/getNetworkStatistics.md @@ -0,0 +1,22 @@ +--- +title: getNetworkStatistics +description: Returns network data usage statistics. Can be called before authorization +--- +## Method: getNetworkStatistics +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns network data usage statistics. Can be called before authorization + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|only\_current|[Bool](../types/Bool.md) | Yes|If true, returns only data for the current library launch| + + +### Return type: [NetworkStatistics](../types/NetworkStatistics.md) + diff --git a/docs/TD_docs/methods/getOption.md b/docs/TD_docs/methods/getOption.md index 9c7a4ae6..d55f306c 100644 --- a/docs/TD_docs/methods/getOption.md +++ b/docs/TD_docs/methods/getOption.md @@ -1,6 +1,6 @@ --- title: getOption -description: Returns value of an option by its name. See list of available options on https: core.telegram.org/tdlib/options +description: Returns value of an option by its name. See list of available options on https: core.telegram.org/tdlib/options. Can be called before authorization --- ## Method: getOption [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Returns value of an option by its name. See list of available optio YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Returns value of an option by its name. See list of available options on https: core.telegram.org/tdlib/options +Returns value of an option by its name. See list of available options on https: core.telegram.org/tdlib/options. Can be called before authorization ### Params: diff --git a/docs/TD_docs/methods/getPaymentForm.md b/docs/TD_docs/methods/getPaymentForm.md new file mode 100644 index 00000000..56b28bcd --- /dev/null +++ b/docs/TD_docs/methods/getPaymentForm.md @@ -0,0 +1,23 @@ +--- +title: getPaymentForm +description: Returns invoice payment form. The method should be called when user presses inlineKeyboardButtonBuy +--- +## Method: getPaymentForm +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns invoice payment form. The method should be called when user presses inlineKeyboardButtonBuy + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier of the Invoice message| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| + + +### Return type: [PaymentForm](../types/PaymentForm.md) + diff --git a/docs/TD_docs/methods/getPaymentReceipt.md b/docs/TD_docs/methods/getPaymentReceipt.md new file mode 100644 index 00000000..a60421e8 --- /dev/null +++ b/docs/TD_docs/methods/getPaymentReceipt.md @@ -0,0 +1,23 @@ +--- +title: getPaymentReceipt +description: Returns information about successful payment +--- +## Method: getPaymentReceipt +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns information about successful payment + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier of the PaymentSuccessful message| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| + + +### Return type: [PaymentReceipt](../types/PaymentReceipt.md) + diff --git a/docs/TD_docs/methods/getProxy.md b/docs/TD_docs/methods/getProxy.md new file mode 100644 index 00000000..43fe7f18 --- /dev/null +++ b/docs/TD_docs/methods/getProxy.md @@ -0,0 +1,21 @@ +--- +title: getProxy +description: Returns current set up proxy. Can be called before authorization +--- +## Method: getProxy +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns current set up proxy. Can be called before authorization + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [Proxy](../types/Proxy.md) + diff --git a/docs/TD_docs/methods/getPublicMessageLink.md b/docs/TD_docs/methods/getPublicMessageLink.md new file mode 100644 index 00000000..3ad23903 --- /dev/null +++ b/docs/TD_docs/methods/getPublicMessageLink.md @@ -0,0 +1,23 @@ +--- +title: getPublicMessageLink +description: Returns public HTTPS link to a message. Available only for messages in public channels +--- +## Method: getPublicMessageLink +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns public HTTPS link to a message. Available only for messages in public channels + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Identifier of the chat, message belongs to| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| + + +### Return type: [PublicMessageLink](../types/PublicMessageLink.md) + diff --git a/docs/TD_docs/methods/getSavedOrderInfo.md b/docs/TD_docs/methods/getSavedOrderInfo.md new file mode 100644 index 00000000..c90976fd --- /dev/null +++ b/docs/TD_docs/methods/getSavedOrderInfo.md @@ -0,0 +1,21 @@ +--- +title: getSavedOrderInfo +description: Returns saved order info if any +--- +## Method: getSavedOrderInfo +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns saved order info if any + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [OrderInfo](../types/OrderInfo.md) + diff --git a/docs/TD_docs/methods/getStickers.md b/docs/TD_docs/methods/getStickers.md index 9b834355..c2630671 100644 --- a/docs/TD_docs/methods/getStickers.md +++ b/docs/TD_docs/methods/getStickers.md @@ -1,6 +1,6 @@ --- title: getStickers -description: Returns stickers corresponding to given emoji +description: Returns stickers from installed ordinary sticker sets corresponding to the given emoji --- ## Method: getStickers [Back to methods index](index.md) @@ -9,13 +9,14 @@ description: Returns stickers corresponding to given emoji YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Returns stickers corresponding to given emoji +Returns stickers from installed ordinary sticker sets corresponding to the given emoji ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |emoji|[string](../types/string.md) | Yes|String representation of emoji. If empty, returns all known stickers| +|limit|[int](../types/int.md) | Yes|Maximum number of stickers to return| ### Return type: [Stickers](../types/Stickers.md) diff --git a/docs/TD_docs/methods/getStorageStatistics.md b/docs/TD_docs/methods/getStorageStatistics.md new file mode 100644 index 00000000..cc05a82c --- /dev/null +++ b/docs/TD_docs/methods/getStorageStatistics.md @@ -0,0 +1,22 @@ +--- +title: getStorageStatistics +description: Returns storage usage statistics +--- +## Method: getStorageStatistics +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns storage usage statistics + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_limit|[int](../types/int.md) | Yes|Maximum number of chats with biggest storage usage for which separate statistics should be returned. All other chats will be grouped in entries with chat_id == 0. If chat info database is not used, chat_limit is ignored and is always set to 0| + + +### Return type: [StorageStatistics](../types/StorageStatistics.md) + diff --git a/docs/TD_docs/methods/getStorageStatisticsFast.md b/docs/TD_docs/methods/getStorageStatisticsFast.md new file mode 100644 index 00000000..e519cde2 --- /dev/null +++ b/docs/TD_docs/methods/getStorageStatisticsFast.md @@ -0,0 +1,21 @@ +--- +title: getStorageStatisticsFast +description: Quickly returns approximate storage usage statistics +--- +## Method: getStorageStatisticsFast +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Quickly returns approximate storage usage statistics + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [StorageStatisticsFast](../types/StorageStatisticsFast.md) + diff --git a/docs/TD_docs/methods/getTemporaryPasswordState.md b/docs/TD_docs/methods/getTemporaryPasswordState.md new file mode 100644 index 00000000..a15355dd --- /dev/null +++ b/docs/TD_docs/methods/getTemporaryPasswordState.md @@ -0,0 +1,21 @@ +--- +title: getTemporaryPasswordState +description: Returns information about current temporary password +--- +## Method: getTemporaryPasswordState +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns information about current temporary password + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [TemporaryPasswordState](../types/TemporaryPasswordState.md) + diff --git a/docs/TD_docs/methods/getTermsOfService.md b/docs/TD_docs/methods/getTermsOfService.md new file mode 100644 index 00000000..dc718b50 --- /dev/null +++ b/docs/TD_docs/methods/getTermsOfService.md @@ -0,0 +1,21 @@ +--- +title: getTermsOfService +description: Returns terms of service. Can be called before authorization +--- +## Method: getTermsOfService +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns terms of service. Can be called before authorization + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [Text](../types/Text.md) + diff --git a/docs/TD_docs/methods/getTopChats.md b/docs/TD_docs/methods/getTopChats.md new file mode 100644 index 00000000..de36de13 --- /dev/null +++ b/docs/TD_docs/methods/getTopChats.md @@ -0,0 +1,23 @@ +--- +title: getTopChats +description: Returns a list of frequently used chats. Supported only if chat info database is enabled +--- +## Method: getTopChats +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns a list of frequently used chats. Supported only if chat info database is enabled + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|category|[TopChatCategory](../types/TopChatCategory.md) | Yes|Category of chats to return| +|limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned, at most 30| + + +### Return type: [Chats](../types/Chats.md) + diff --git a/docs/TD_docs/methods/getUserProfilePhotos.md b/docs/TD_docs/methods/getUserProfilePhotos.md index 3c8a5cd6..c41ee769 100644 --- a/docs/TD_docs/methods/getUserProfilePhotos.md +++ b/docs/TD_docs/methods/getUserProfilePhotos.md @@ -1,6 +1,6 @@ --- title: getUserProfilePhotos -description: Returns profile photos of the user. Result of this query can't be invalidated, so it must be used with care +description: Returns profile photos of the user. Result of this query may be outdated: some photos may be already deleted --- ## Method: getUserProfilePhotos [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Returns profile photos of the user. Result of this query can't be i YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Returns profile photos of the user. Result of this query can't be invalidated, so it must be used with care +Returns profile photos of the user. Result of this query may be outdated: some photos may be already deleted ### Params: diff --git a/docs/TD_docs/methods/getWebPageInstantView.md b/docs/TD_docs/methods/getWebPageInstantView.md new file mode 100644 index 00000000..f5b7f45e --- /dev/null +++ b/docs/TD_docs/methods/getWebPageInstantView.md @@ -0,0 +1,23 @@ +--- +title: getWebPageInstantView +description: Returns web page instant view if available. Returns error 404 if web page has no instant view +--- +## Method: getWebPageInstantView +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Returns web page instant view if available. Returns error 404 if web page has no instant view + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Web page URL| +|force\_full|[Bool](../types/Bool.md) | Yes|If true, full web page instant view will be returned| + + +### Return type: [WebPageInstantView](../types/WebPageInstantView.md) + diff --git a/docs/TD_docs/methods/getWebPagePreview.md b/docs/TD_docs/methods/getWebPagePreview.md index 44f82d5c..f3a9e5f1 100644 --- a/docs/TD_docs/methods/getWebPagePreview.md +++ b/docs/TD_docs/methods/getWebPagePreview.md @@ -1,6 +1,6 @@ --- title: getWebPagePreview -description: Get web page preview by text of the message. Do not call this function to often +description: Returns web page preview by text of the message. Do not call this function to often. Returns error 404 if web page has no preview --- ## Method: getWebPagePreview [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Get web page preview by text of the message. Do not call this funct YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Get web page preview by text of the message. Do not call this function to often +Returns web page preview by text of the message. Do not call this function to often. Returns error 404 if web page has no preview ### Params: diff --git a/docs/TD_docs/methods/importChatInviteLink.md b/docs/TD_docs/methods/importChatInviteLink.md index 074fe49b..a2119c7d 100644 --- a/docs/TD_docs/methods/importChatInviteLink.md +++ b/docs/TD_docs/methods/importChatInviteLink.md @@ -15,7 +15,7 @@ Imports chat invite link, adds current user to a chat if possible. Member will n | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|invite\_link|[string](../types/string.md) | Yes|Invite link to import. Should begin with "https: telegram.me/joinchat/"| +|invite\_link|[string](../types/string.md) | Yes|Invite link to import. Should begin with "https: t.me/joinchat/", "https: telegram.me/joinchat/" or "https: telegram.dog/joinchat/"| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/importContacts.md b/docs/TD_docs/methods/importContacts.md index 2cdff4c7..4f1d6bcb 100644 --- a/docs/TD_docs/methods/importContacts.md +++ b/docs/TD_docs/methods/importContacts.md @@ -1,6 +1,6 @@ --- title: importContacts -description: Adds new contacts/edits existing contacts, contacts user identifiers are ignored. Returns list of corresponding users in the same order as input contacts. If contact doesn't registered in Telegram, user with id == 0 will be returned +description: Adds new contacts/edits existing contacts, contacts user identifiers are ignored --- ## Method: importContacts [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Adds new contacts/edits existing contacts, contacts user identifier YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Adds new contacts/edits existing contacts, contacts user identifiers are ignored. Returns list of corresponding users in the same order as input contacts. If contact doesn't registered in Telegram, user with id == 0 will be returned +Adds new contacts/edits existing contacts, contacts user identifiers are ignored ### Params: @@ -18,5 +18,5 @@ Adds new contacts/edits existing contacts, contacts user identifiers are ignored |contacts|Array of [contact](../types/contact.md) | Yes|List of contacts to import/edit| -### Return type: [Users](../types/Users.md) +### Return type: [ImportedContacts](../types/ImportedContacts.md) diff --git a/docs/TD_docs/methods/index.md b/docs/TD_docs/methods/index.md index e5f80f4f..82600a77 100644 --- a/docs/TD_docs/methods/index.md +++ b/docs/TD_docs/methods/index.md @@ -28,12 +28,18 @@ $MadelineProto->[get_full_info](https://docs.madelineproto.xyz/get_full_info.htm $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); +*** +

$MadelineProto->[acceptCall](acceptCall.md)(\['call_id' => [int](../types/int.md), 'protocol' => [callProtocol](../constructors/callProtocol.md), \]) === [$Ok](../types/Ok.md) + ***

$MadelineProto->[addChatMember](addChatMember.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'user_id' => [int](../types/int.md), 'forward_limit' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[addChatMembers](addChatMembers.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'user_ids' => \[[int](../types/int.md)\], \]) === [$Ok](../types/Ok.md) +*** +

$MadelineProto->[addNetworkStatistics](addNetworkStatistics.md)(\['entry' => [NetworkStatisticsEntry](../types/NetworkStatisticsEntry.md), \]) === [$Ok](../types/Ok.md) + ***

$MadelineProto->[addRecentSticker](addRecentSticker.md)(\['is_attached' => [Bool](../types/Bool.md), 'sticker' => [InputFile](../types/InputFile.md), \]) === [$Stickers](../types/Stickers.md) @@ -43,18 +49,33 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); ***

$MadelineProto->[addSavedAnimation](addSavedAnimation.md)(\['animation' => [InputFile](../types/InputFile.md), \]) === [$Ok](../types/Ok.md) +*** +

$MadelineProto->[addStickerToSet](addStickerToSet.md)(\['user_id' => [int](../types/int.md), 'name' => [string](../types/string.md), 'sticker' => [inputSticker](../constructors/inputSticker.md), \]) === [$StickerSet](../types/StickerSet.md) + ***

$MadelineProto->[answerCallbackQuery](answerCallbackQuery.md)(\['callback_query_id' => [long](../types/long.md), 'text' => [string](../types/string.md), 'show_alert' => [Bool](../types/Bool.md), 'url' => [string](../types/string.md), 'cache_time' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) +*** +

$MadelineProto->[answerCustomQuery](answerCustomQuery.md)(\['custom_query_id' => [long](../types/long.md), 'data' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) + ***

$MadelineProto->[answerInlineQuery](answerInlineQuery.md)(\['inline_query_id' => [long](../types/long.md), 'is_personal' => [Bool](../types/Bool.md), 'results' => \[[InputInlineQueryResult](../types/InputInlineQueryResult.md)\], 'cache_time' => [int](../types/int.md), 'next_offset' => [string](../types/string.md), 'switch_pm_text' => [string](../types/string.md), 'switch_pm_parameter' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) +*** +

$MadelineProto->[answerPreCheckoutQuery](answerPreCheckoutQuery.md)(\['pre_checkout_query_id' => [long](../types/long.md), 'error_message' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[answerShippingQuery](answerShippingQuery.md)(\['shipping_query_id' => [long](../types/long.md), 'shipping_options' => \[[shippingOption](../constructors/shippingOption.md)\], 'error_message' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) + ***

$MadelineProto->[blockUser](blockUser.md)(\['user_id' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[cancelDownloadFile](cancelDownloadFile.md)(\['file_id' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) +*** +

$MadelineProto->[cancelUploadFile](cancelUploadFile.md)(\['file_id' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) + ***

$MadelineProto->[changeAbout](changeAbout.md)(\['about' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) @@ -62,7 +83,7 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[changeAccountTtl](changeAccountTtl.md)(\['ttl' => [accountTtl](../constructors/accountTtl.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[changeChannelAbout](changeChannelAbout.md)(\['channel_id' => [int](../types/int.md), 'about' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[changeChannelDescription](changeChannelDescription.md)(\['channel_id' => [int](../types/int.md), 'description' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[changeChannelUsername](changeChannelUsername.md)(\['channel_id' => [int](../types/int.md), 'username' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) @@ -88,6 +109,9 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); ***

$MadelineProto->[changePhoneNumber](changePhoneNumber.md)(\['phone_number' => [string](../types/string.md), 'allow_flash_call' => [Bool](../types/Bool.md), 'is_current_phone_number' => [Bool](../types/Bool.md), \]) === [$AuthState](../types/AuthState.md) +*** +

$MadelineProto->[changeStickerSet](changeStickerSet.md)(\['set_id' => [long](../types/long.md), 'is_installed' => [Bool](../types/Bool.md), 'is_archived' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) + ***

$MadelineProto->[changeUsername](changeUsername.md)(\['username' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) @@ -115,6 +139,9 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); ***

$MadelineProto->[closeSecretChat](closeSecretChat.md)(\['secret_chat_id' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) +*** +

$MadelineProto->[createCall](createCall.md)(\['user_id' => [int](../types/int.md), 'protocol' => [callProtocol](../constructors/callProtocol.md), \]) === [$CallId](../types/CallId.md) + ***

$MadelineProto->[createChannelChat](createChannelChat.md)(\['channel_id' => [int](../types/int.md), \]) === [$Chat](../types/Chat.md) @@ -122,7 +149,7 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[createGroupChat](createGroupChat.md)(\['group_id' => [int](../types/int.md), \]) === [$Chat](../types/Chat.md) *** -

$MadelineProto->[createNewChannelChat](createNewChannelChat.md)(\['title' => [string](../types/string.md), 'is_supergroup' => [Bool](../types/Bool.md), 'about' => [string](../types/string.md), \]) === [$Chat](../types/Chat.md) +

$MadelineProto->[createNewChannelChat](createNewChannelChat.md)(\['title' => [string](../types/string.md), 'is_supergroup' => [Bool](../types/Bool.md), 'description' => [string](../types/string.md), \]) === [$Chat](../types/Chat.md) ***

$MadelineProto->[createNewGroupChat](createNewGroupChat.md)(\['user_ids' => \[[int](../types/int.md)\], 'title' => [string](../types/string.md), \]) === [$Chat](../types/Chat.md) @@ -130,12 +157,21 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); ***

$MadelineProto->[createNewSecretChat](createNewSecretChat.md)(\['user_id' => [int](../types/int.md), \]) === [$Chat](../types/Chat.md) +*** +

$MadelineProto->[createNewStickerSet](createNewStickerSet.md)(\['user_id' => [int](../types/int.md), 'title' => [string](../types/string.md), 'name' => [string](../types/string.md), 'is_masks' => [Bool](../types/Bool.md), 'stickers' => \[[inputSticker](../constructors/inputSticker.md)\], \]) === [$StickerSet](../types/StickerSet.md) + ***

$MadelineProto->[createPrivateChat](createPrivateChat.md)(\['user_id' => [int](../types/int.md), \]) === [$Chat](../types/Chat.md) ***

$MadelineProto->[createSecretChat](createSecretChat.md)(\['secret_chat_id' => [int](../types/int.md), \]) === [$Chat](../types/Chat.md) +*** +

$MadelineProto->[createTemporaryPassword](createTemporaryPassword.md)(\['password' => [string](../types/string.md), 'valid_for' => [int](../types/int.md), \]) === [$TemporaryPasswordState](../types/TemporaryPasswordState.md) + +*** +

$MadelineProto->[debugCall](debugCall.md)(\['call_id' => [int](../types/int.md), 'debug' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) + ***

$MadelineProto->[deleteAccount](deleteAccount.md)(\['reason' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) @@ -146,13 +182,16 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[deleteChatHistory](deleteChatHistory.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'remove_from_chat_list' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[deleteChatReplyMarkup](deleteChatReplyMarkup.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [long](../types/long.md), \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[deleteChatReplyMarkup](deleteChatReplyMarkup.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[deleteContacts](deleteContacts.md)(\['user_ids' => \[[int](../types/int.md)\], \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[deleteMessages](deleteMessages.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_ids' => \[[long](../types/long.md)\], \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[deleteFile](deleteFile.md)(\['file_id' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[deleteMessages](deleteMessages.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_ids' => \[[int53](../constructors/int53.md)\], 'revoke' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[deleteMessagesFromUser](deleteMessagesFromUser.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'user_id' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) @@ -160,6 +199,9 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); ***

$MadelineProto->[deleteProfilePhoto](deleteProfilePhoto.md)(\['profile_photo_id' => [long](../types/long.md), \]) === [$Ok](../types/Ok.md) +*** +

$MadelineProto->[deleteRecentHashtag](deleteRecentHashtag.md)(\['hashtag' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) + ***

$MadelineProto->[deleteRecentSticker](deleteRecentSticker.md)(\['is_attached' => [Bool](../types/Bool.md), 'sticker' => [InputFile](../types/InputFile.md), \]) === [$Ok](../types/Ok.md) @@ -173,7 +215,22 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[deleteSavedAnimation](deleteSavedAnimation.md)(\['animation' => [InputFile](../types/InputFile.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[downloadFile](downloadFile.md)(\['file_id' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[deleteSavedCredentials](deleteSavedCredentials.md)(\[\]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[deleteSavedOrderInfo](deleteSavedOrderInfo.md)(\[\]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[deleteStickerFromSet](deleteStickerFromSet.md)(\['sticker' => [InputFile](../types/InputFile.md), \]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[deleteTopChat](deleteTopChat.md)(\['category' => [TopChatCategory](../types/TopChatCategory.md), 'chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[discardCall](discardCall.md)(\['call_id' => [int](../types/int.md), 'is_disconnected' => [Bool](../types/Bool.md), 'duration' => [int](../types/int.md), 'connection_id' => [long](../types/long.md), \]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[downloadFile](downloadFile.md)(\['file_id' => [int](../types/int.md), 'priority' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[editInlineMessageCaption](editInlineMessageCaption.md)(\['inline_message_id' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'caption' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) @@ -185,13 +242,13 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[editInlineMessageText](editInlineMessageText.md)(\['inline_message_id' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'input_message_content' => [InputMessageContent](../types/InputMessageContent.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[editMessageCaption](editMessageCaption.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [long](../types/long.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'caption' => [string](../types/string.md), \]) === [$Message](../types/Message.md) +

$MadelineProto->[editMessageCaption](editMessageCaption.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'caption' => [string](../types/string.md), \]) === [$Message](../types/Message.md) *** -

$MadelineProto->[editMessageReplyMarkup](editMessageReplyMarkup.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [long](../types/long.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]) === [$Message](../types/Message.md) +

$MadelineProto->[editMessageReplyMarkup](editMessageReplyMarkup.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]) === [$Message](../types/Message.md) *** -

$MadelineProto->[editMessageText](editMessageText.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [long](../types/long.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'input_message_content' => [InputMessageContent](../types/InputMessageContent.md), \]) === [$Message](../types/Message.md) +

$MadelineProto->[editMessageText](editMessageText.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'input_message_content' => [InputMessageContent](../types/InputMessageContent.md), \]) === [$Message](../types/Message.md) ***

$MadelineProto->[exportChatInviteLink](exportChatInviteLink.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$ChatInviteLink](../types/ChatInviteLink.md) @@ -200,7 +257,7 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[finishFileGeneration](finishFileGeneration.md)(\['generation_id' => [long](../types/long.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[forwardMessages](forwardMessages.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'from_chat_id' => [long](../types/long.md), 'message_ids' => \[[long](../types/long.md)\], 'disable_notification' => [Bool](../types/Bool.md), 'from_background' => [Bool](../types/Bool.md), \]) === [$Messages](../types/Messages.md) +

$MadelineProto->[forwardMessages](forwardMessages.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'from_chat_id' => [int53](../constructors/int53.md), 'message_ids' => \[[int53](../constructors/int53.md)\], 'disable_notification' => [Bool](../types/Bool.md), 'from_background' => [Bool](../types/Bool.md), \]) === [$Messages](../types/Messages.md) ***

$MadelineProto->[getAccountTtl](getAccountTtl.md)(\[\]) === [$AccountTtl](../types/AccountTtl.md) @@ -221,7 +278,7 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[getBlockedUsers](getBlockedUsers.md)(\['offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$Users](../types/Users.md) *** -

$MadelineProto->[getCallbackQueryAnswer](getCallbackQueryAnswer.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [long](../types/long.md), 'payload' => [CallbackQueryPayload](../types/CallbackQueryPayload.md), \]) === [$CallbackQueryAnswer](../types/CallbackQueryAnswer.md) +

$MadelineProto->[getCallbackQueryAnswer](getCallbackQueryAnswer.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), 'payload' => [CallbackQueryPayload](../types/CallbackQueryPayload.md), \]) === [$CallbackQueryAnswer](../types/CallbackQueryAnswer.md) ***

$MadelineProto->[getChannel](getChannel.md)(\['channel_id' => [int](../types/int.md), \]) === [$Channel](../types/Channel.md) @@ -236,7 +293,10 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[getChat](getChat.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$Chat](../types/Chat.md) *** -

$MadelineProto->[getChatHistory](getChatHistory.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'from_message_id' => [long](../types/long.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$Messages](../types/Messages.md) +

$MadelineProto->[getChatEventLog](getChatEventLog.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'query' => [string](../types/string.md), 'from_event_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), 'filters' => [chatEventLogFilters](../constructors/chatEventLogFilters.md), 'user_ids' => \[[int](../types/int.md)\], \]) === [$ChatEvents](../types/ChatEvents.md) + +*** +

$MadelineProto->[getChatHistory](getChatHistory.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'from_message_id' => [int53](../constructors/int53.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'only_local' => [Bool](../types/Bool.md), \]) === [$Messages](../types/Messages.md) ***

$MadelineProto->[getChatMember](getChatMember.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'user_id' => [int](../types/int.md), \]) === [$ChatMember](../types/ChatMember.md) @@ -245,25 +305,22 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[getChatReportSpamState](getChatReportSpamState.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$ChatReportSpamState](../types/ChatReportSpamState.md) *** -

$MadelineProto->[getChats](getChats.md)(\['offset_order' => [long](../types/long.md), 'offset_chat_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), \]) === [$Chats](../types/Chats.md) +

$MadelineProto->[getChats](getChats.md)(\['offset_order' => [long](../types/long.md), 'offset_chat_id' => [int53](../constructors/int53.md), 'limit' => [int](../types/int.md), \]) === [$Chats](../types/Chats.md) *** -

$MadelineProto->[getCommonChats](getCommonChats.md)(\['user_id' => [int](../types/int.md), 'offset_chat_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), \]) === [$Chats](../types/Chats.md) +

$MadelineProto->[getCommonChats](getCommonChats.md)(\['user_id' => [int](../types/int.md), 'offset_chat_id' => [int53](../constructors/int53.md), 'limit' => [int](../types/int.md), \]) === [$Chats](../types/Chats.md) *** -

$MadelineProto->[getCreatedPublicChannels](getCreatedPublicChannels.md)(\[\]) === [$Channels](../types/Channels.md) - -*** -

$MadelineProto->[getDeviceTokens](getDeviceTokens.md)(\[\]) === [$DeviceTokenSet](../types/DeviceTokenSet.md) +

$MadelineProto->[getCreatedPublicChats](getCreatedPublicChats.md)(\[\]) === [$Chats](../types/Chats.md) ***

$MadelineProto->[getFile](getFile.md)(\['file_id' => [int](../types/int.md), \]) === [$File](../types/File.md) *** -

$MadelineProto->[getFilePersistent](getFilePersistent.md)(\['persistent_file_id' => [string](../types/string.md), \]) === [$File](../types/File.md) +

$MadelineProto->[getFilePersistent](getFilePersistent.md)(\['persistent_file_id' => [string](../types/string.md), 'file_type' => [FileType](../types/FileType.md), \]) === [$File](../types/File.md) *** -

$MadelineProto->[getGameHighScores](getGameHighScores.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), \]) === [$GameHighScores](../types/GameHighScores.md) +

$MadelineProto->[getGameHighScores](getGameHighScores.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), 'user_id' => [int](../types/int.md), \]) === [$GameHighScores](../types/GameHighScores.md) ***

$MadelineProto->[getGroup](getGroup.md)(\['group_id' => [int](../types/int.md), \]) === [$Group](../types/Group.md) @@ -277,14 +334,23 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); ***

$MadelineProto->[getInlineQueryResults](getInlineQueryResults.md)(\['bot_user_id' => [int](../types/int.md), 'chat_id' => [InputPeer](../types/InputPeer.md), 'user_location' => [location](../constructors/location.md), 'query' => [string](../types/string.md), 'offset' => [string](../types/string.md), \]) === [$InlineQueryResults](../types/InlineQueryResults.md) +*** +

$MadelineProto->[getInstalledStickerSets](getInstalledStickerSets.md)(\['is_masks' => [Bool](../types/Bool.md), \]) === [$StickerSets](../types/StickerSets.md) + +*** +

$MadelineProto->[getInviteText](getInviteText.md)(\[\]) === [$Text](../types/Text.md) + ***

$MadelineProto->[getMe](getMe.md)(\[\]) === [$User](../types/User.md) *** -

$MadelineProto->[getMessage](getMessage.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [long](../types/long.md), \]) === [$Message](../types/Message.md) +

$MadelineProto->[getMessage](getMessage.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), \]) === [$Message](../types/Message.md) *** -

$MadelineProto->[getMessages](getMessages.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_ids' => \[[long](../types/long.md)\], \]) === [$Messages](../types/Messages.md) +

$MadelineProto->[getMessages](getMessages.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_ids' => \[[int53](../constructors/int53.md)\], \]) === [$Messages](../types/Messages.md) + +*** +

$MadelineProto->[getNetworkStatistics](getNetworkStatistics.md)(\['only_current' => [Bool](../types/Bool.md), \]) === [$NetworkStatistics](../types/NetworkStatistics.md) ***

$MadelineProto->[getNotificationSettings](getNotificationSettings.md)(\['scope' => [NotificationSettingsScope](../types/NotificationSettingsScope.md), \]) === [$NotificationSettings](../types/NotificationSettings.md) @@ -295,9 +361,21 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); ***

$MadelineProto->[getPasswordState](getPasswordState.md)(\[\]) === [$PasswordState](../types/PasswordState.md) +*** +

$MadelineProto->[getPaymentForm](getPaymentForm.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), \]) === [$PaymentForm](../types/PaymentForm.md) + +*** +

$MadelineProto->[getPaymentReceipt](getPaymentReceipt.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), \]) === [$PaymentReceipt](../types/PaymentReceipt.md) + ***

$MadelineProto->[getPrivacy](getPrivacy.md)(\['key' => [PrivacyKey](../types/PrivacyKey.md), \]) === [$PrivacyRules](../types/PrivacyRules.md) +*** +

$MadelineProto->[getProxy](getProxy.md)(\[\]) === [$Proxy](../types/Proxy.md) + +*** +

$MadelineProto->[getPublicMessageLink](getPublicMessageLink.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), \]) === [$PublicMessageLink](../types/PublicMessageLink.md) + ***

$MadelineProto->[getRecentInlineBots](getRecentInlineBots.md)(\[\]) === [$Users](../types/Users.md) @@ -310,6 +388,9 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); ***

$MadelineProto->[getSavedAnimations](getSavedAnimations.md)(\[\]) === [$Animations](../types/Animations.md) +*** +

$MadelineProto->[getSavedOrderInfo](getSavedOrderInfo.md)(\[\]) === [$OrderInfo](../types/OrderInfo.md) + ***

$MadelineProto->[getSecretChat](getSecretChat.md)(\['secret_chat_id' => [int](../types/int.md), \]) === [$SecretChat](../types/SecretChat.md) @@ -320,14 +401,26 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[getStickerSet](getStickerSet.md)(\['set_id' => [long](../types/long.md), \]) === [$StickerSet](../types/StickerSet.md) *** -

$MadelineProto->[getStickerSets](getStickerSets.md)(\['is_masks' => [Bool](../types/Bool.md), \]) === [$StickerSets](../types/StickerSets.md) +

$MadelineProto->[getStickers](getStickers.md)(\['emoji' => [string](../types/string.md), 'limit' => [int](../types/int.md), \]) === [$Stickers](../types/Stickers.md) *** -

$MadelineProto->[getStickers](getStickers.md)(\['emoji' => [string](../types/string.md), \]) === [$Stickers](../types/Stickers.md) +

$MadelineProto->[getStorageStatistics](getStorageStatistics.md)(\['chat_limit' => [int](../types/int.md), \]) === [$StorageStatistics](../types/StorageStatistics.md) + +*** +

$MadelineProto->[getStorageStatisticsFast](getStorageStatisticsFast.md)(\[\]) === [$StorageStatisticsFast](../types/StorageStatisticsFast.md) ***

$MadelineProto->[getSupportUser](getSupportUser.md)(\[\]) === [$User](../types/User.md) +*** +

$MadelineProto->[getTemporaryPasswordState](getTemporaryPasswordState.md)(\[\]) === [$TemporaryPasswordState](../types/TemporaryPasswordState.md) + +*** +

$MadelineProto->[getTermsOfService](getTermsOfService.md)(\[\]) === [$Text](../types/Text.md) + +*** +

$MadelineProto->[getTopChats](getTopChats.md)(\['category' => [TopChatCategory](../types/TopChatCategory.md), 'limit' => [int](../types/int.md), \]) === [$Chats](../types/Chats.md) + ***

$MadelineProto->[getTrendingStickerSets](getTrendingStickerSets.md)(\[\]) === [$StickerSets](../types/StickerSets.md) @@ -343,6 +436,9 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); ***

$MadelineProto->[getWallpapers](getWallpapers.md)(\[\]) === [$Wallpapers](../types/Wallpapers.md) +*** +

$MadelineProto->[getWebPageInstantView](getWebPageInstantView.md)(\['url' => [string](../types/string.md), 'force_full' => [Bool](../types/Bool.md), \]) === [$WebPageInstantView](../types/WebPageInstantView.md) + ***

$MadelineProto->[getWebPagePreview](getWebPagePreview.md)(\['message_text' => [string](../types/string.md), \]) === [$WebPage](../types/WebPage.md) @@ -350,7 +446,7 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[importChatInviteLink](importChatInviteLink.md)(\['invite_link' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[importContacts](importContacts.md)(\['contacts' => \[[contact](../constructors/contact.md)\], \]) === [$Users](../types/Users.md) +

$MadelineProto->[importContacts](importContacts.md)(\['contacts' => \[[contact](../constructors/contact.md)\], \]) === [$ImportedContacts](../types/ImportedContacts.md) ***

$MadelineProto->[migrateGroupChatToChannelChat](migrateGroupChatToChannelChat.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$Chat](../types/Chat.md) @@ -359,10 +455,19 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[openChat](openChat.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[openMessageContent](openMessageContent.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [long](../types/long.md), \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[openMessageContent](openMessageContent.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[pinChannelMessage](pinChannelMessage.md)(\['channel_id' => [int](../types/int.md), 'message_id' => [long](../types/long.md), 'disable_notification' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[optimizeStorage](optimizeStorage.md)(\['size' => [int53](../constructors/int53.md), 'ttl' => [int](../types/int.md), 'count' => [int](../types/int.md), 'immunity_delay' => [int](../types/int.md), 'file_types' => \[[FileType](../types/FileType.md)\], 'chat_ids' => \[[int53](../constructors/int53.md)\], 'exclude_chat_ids' => \[[int53](../constructors/int53.md)\], 'chat_limit' => [int](../types/int.md), \]) === [$StorageStatistics](../types/StorageStatistics.md) + +*** +

$MadelineProto->[pinChannelMessage](pinChannelMessage.md)(\['channel_id' => [int](../types/int.md), 'message_id' => [int53](../constructors/int53.md), 'disable_notification' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[processDcUpdate](processDcUpdate.md)(\['dc' => [string](../types/string.md), 'addr' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[rateCall](rateCall.md)(\['call_id' => [int](../types/int.md), 'rating' => [int](../types/int.md), 'comment' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[recoverAuthPassword](recoverAuthPassword.md)(\['recovery_code' => [string](../types/string.md), \]) === [$AuthState](../types/AuthState.md) @@ -374,10 +479,13 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[registerDevice](registerDevice.md)(\['device_token' => [DeviceToken](../types/DeviceToken.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[reorderStickerSets](reorderStickerSets.md)(\['is_masks' => [Bool](../types/Bool.md), 'sticker_set_ids' => \[[long](../types/long.md)\], \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[reorderInstalledStickerSets](reorderInstalledStickerSets.md)(\['is_masks' => [Bool](../types/Bool.md), 'sticker_set_ids' => \[[long](../types/long.md)\], \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[reportChannelSpam](reportChannelSpam.md)(\['channel_id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'message_ids' => \[[long](../types/long.md)\], \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[reportChannelSpam](reportChannelSpam.md)(\['channel_id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'message_ids' => \[[int53](../constructors/int53.md)\], \]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[reportChat](reportChat.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'reason' => [ChatReportReason](../types/ChatReportReason.md), \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[requestAuthPasswordRecovery](requestAuthPasswordRecovery.md)(\[\]) === [$AuthState](../types/AuthState.md) @@ -398,7 +506,16 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[resetAuth](resetAuth.md)(\['force' => [Bool](../types/Bool.md), \]) === [$AuthState](../types/AuthState.md) *** -

$MadelineProto->[searchChatMessages](searchChatMessages.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'query' => [string](../types/string.md), 'from_message_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), 'filter' => [SearchMessagesFilter](../types/SearchMessagesFilter.md), \]) === [$Messages](../types/Messages.md) +

$MadelineProto->[resetNetworkStatistics](resetNetworkStatistics.md)(\[\]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[searchCallMessages](searchCallMessages.md)(\['from_message_id' => [int53](../constructors/int53.md), 'limit' => [int](../types/int.md), 'only_missed' => [Bool](../types/Bool.md), \]) === [$Messages](../types/Messages.md) + +*** +

$MadelineProto->[searchChatMembers](searchChatMembers.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'query' => [string](../types/string.md), 'limit' => [int](../types/int.md), \]) === [$ChatMembers](../types/ChatMembers.md) + +*** +

$MadelineProto->[searchChatMessages](searchChatMessages.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'query' => [string](../types/string.md), 'sender_user_id' => [int](../types/int.md), 'from_message_id' => [int53](../constructors/int53.md), 'limit' => [int](../types/int.md), 'filter' => [SearchMessagesFilter](../types/SearchMessagesFilter.md), \]) === [$Messages](../types/Messages.md) ***

$MadelineProto->[searchChats](searchChats.md)(\['query' => [string](../types/string.md), 'limit' => [int](../types/int.md), \]) === [$Chats](../types/Chats.md) @@ -407,7 +524,10 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[searchContacts](searchContacts.md)(\['query' => [string](../types/string.md), 'limit' => [int](../types/int.md), \]) === [$Users](../types/Users.md) *** -

$MadelineProto->[searchMessages](searchMessages.md)(\['query' => [string](../types/string.md), 'offset_date' => [int](../types/int.md), 'offset_chat_id' => [long](../types/long.md), 'offset_message_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), \]) === [$Messages](../types/Messages.md) +

$MadelineProto->[searchHashtags](searchHashtags.md)(\['prefix' => [string](../types/string.md), 'limit' => [int](../types/int.md), \]) === [$Hashtags](../types/Hashtags.md) + +*** +

$MadelineProto->[searchMessages](searchMessages.md)(\['query' => [string](../types/string.md), 'offset_date' => [int](../types/int.md), 'offset_chat_id' => [int53](../constructors/int53.md), 'offset_message_id' => [int53](../constructors/int53.md), 'limit' => [int](../types/int.md), \]) === [$Messages](../types/Messages.md) ***

$MadelineProto->[searchPublicChat](searchPublicChat.md)(\['username' => [string](../types/string.md), \]) === [$Chat](../types/Chat.md) @@ -415,6 +535,9 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); ***

$MadelineProto->[searchPublicChats](searchPublicChats.md)(\['username_prefix' => [string](../types/string.md), \]) === [$Chats](../types/Chats.md) +*** +

$MadelineProto->[searchSecretMessages](searchSecretMessages.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'query' => [string](../types/string.md), 'from_search_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), 'filter' => [SearchMessagesFilter](../types/SearchMessagesFilter.md), \]) === [$FoundMessages](../types/FoundMessages.md) + ***

$MadelineProto->[searchStickerSet](searchStickerSet.md)(\['name' => [string](../types/string.md), \]) === [$StickerSet](../types/StickerSet.md) @@ -422,7 +545,7 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[sendBotStartMessage](sendBotStartMessage.md)(\['bot_user_id' => [int](../types/int.md), 'chat_id' => [InputPeer](../types/InputPeer.md), 'parameter' => [string](../types/string.md), \]) === [$Message](../types/Message.md) *** -

$MadelineProto->[sendChatAction](sendChatAction.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'action' => [SendMessageAction](../types/SendMessageAction.md), \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[sendChatAction](sendChatAction.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'action' => [ChatAction](../types/ChatAction.md), \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[sendChatScreenshotTakenNotification](sendChatScreenshotTakenNotification.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$Ok](../types/Ok.md) @@ -431,10 +554,16 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[sendChatSetTtlMessage](sendChatSetTtlMessage.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'ttl' => [int](../types/int.md), \]) === [$Message](../types/Message.md) *** -

$MadelineProto->[sendInlineQueryResultMessage](sendInlineQueryResultMessage.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'reply_to_message_id' => [long](../types/long.md), 'disable_notification' => [Bool](../types/Bool.md), 'from_background' => [Bool](../types/Bool.md), 'query_id' => [long](../types/long.md), 'result_id' => [string](../types/string.md), \]) === [$Message](../types/Message.md) +

$MadelineProto->[sendCustomRequest](sendCustomRequest.md)(\['method' => [string](../types/string.md), 'parameters' => [string](../types/string.md), \]) === [$CustomRequestResult](../types/CustomRequestResult.md) *** -

$MadelineProto->[sendMessage](sendMessage.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'reply_to_message_id' => [long](../types/long.md), 'disable_notification' => [Bool](../types/Bool.md), 'from_background' => [Bool](../types/Bool.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'input_message_content' => [InputMessageContent](../types/InputMessageContent.md), \]) === [$Message](../types/Message.md) +

$MadelineProto->[sendInlineQueryResultMessage](sendInlineQueryResultMessage.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'reply_to_message_id' => [int53](../constructors/int53.md), 'disable_notification' => [Bool](../types/Bool.md), 'from_background' => [Bool](../types/Bool.md), 'query_id' => [long](../types/long.md), 'result_id' => [string](../types/string.md), \]) === [$Message](../types/Message.md) + +*** +

$MadelineProto->[sendMessage](sendMessage.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'reply_to_message_id' => [int53](../constructors/int53.md), 'disable_notification' => [Bool](../types/Bool.md), 'from_background' => [Bool](../types/Bool.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'input_message_content' => [InputMessageContent](../types/InputMessageContent.md), \]) === [$Message](../types/Message.md) + +*** +

$MadelineProto->[sendPaymentForm](sendPaymentForm.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), 'order_info_id' => [string](../types/string.md), 'shipping_option_id' => [string](../types/string.md), 'credentials' => [InputCredentials](../types/InputCredentials.md), \]) === [$PaymentResult](../types/PaymentResult.md) ***

$MadelineProto->[setAlarm](setAlarm.md)(\['seconds' => [double](../types/double.md), \]) === [$Ok](../types/Ok.md) @@ -446,14 +575,20 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[setBotUpdatesStatus](setBotUpdatesStatus.md)(\['pending_update_count' => [int](../types/int.md), 'error_message' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[setFileGenerationProgress](setFileGenerationProgress.md)(\['generation_id' => [long](../types/long.md), 'ready' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[setChatClientData](setChatClientData.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'client_data' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[setGameScore](setGameScore.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [long](../types/long.md), 'edit_message' => [Bool](../types/Bool.md), 'user_id' => [int](../types/int.md), 'score' => [int](../types/int.md), 'force' => [Bool](../types/Bool.md), \]) === [$Message](../types/Message.md) +

$MadelineProto->[setFileGenerationProgress](setFileGenerationProgress.md)(\['generation_id' => [long](../types/long.md), 'size' => [int](../types/int.md), 'local_size' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[setGameScore](setGameScore.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), 'edit_message' => [Bool](../types/Bool.md), 'user_id' => [int](../types/int.md), 'score' => [int](../types/int.md), 'force' => [Bool](../types/Bool.md), \]) === [$Message](../types/Message.md) ***

$MadelineProto->[setInlineGameScore](setInlineGameScore.md)(\['inline_message_id' => [string](../types/string.md), 'edit_message' => [Bool](../types/Bool.md), 'user_id' => [int](../types/int.md), 'score' => [int](../types/int.md), 'force' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) +*** +

$MadelineProto->[setNetworkType](setNetworkType.md)(\['type' => [NetworkType](../types/NetworkType.md), \]) === [$Ok](../types/Ok.md) + ***

$MadelineProto->[setNotificationSettings](setNotificationSettings.md)(\['scope' => [NotificationSettingsScope](../types/NotificationSettingsScope.md), 'notification_settings' => [notificationSettings](../constructors/notificationSettings.md), \]) === [$Ok](../types/Ok.md) @@ -463,15 +598,24 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); ***

$MadelineProto->[setPassword](setPassword.md)(\['old_password' => [string](../types/string.md), 'new_password' => [string](../types/string.md), 'new_hint' => [string](../types/string.md), 'set_recovery_email' => [Bool](../types/Bool.md), 'new_recovery_email' => [string](../types/string.md), \]) === [$PasswordState](../types/PasswordState.md) +*** +

$MadelineProto->[setPinnedChats](setPinnedChats.md)(\['chat_ids' => \[[int53](../constructors/int53.md)\], \]) === [$Ok](../types/Ok.md) + ***

$MadelineProto->[setPrivacy](setPrivacy.md)(\['key' => [PrivacyKey](../types/PrivacyKey.md), 'rules' => [privacyRules](../constructors/privacyRules.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[setProfilePhoto](setProfilePhoto.md)(\['photo_path' => [string](../types/string.md), \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[setProfilePhoto](setProfilePhoto.md)(\['photo' => [InputFile](../types/InputFile.md), \]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[setProxy](setProxy.md)(\['proxy' => [Proxy](../types/Proxy.md), \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[setRecoveryEmail](setRecoveryEmail.md)(\['password' => [string](../types/string.md), 'new_recovery_email' => [string](../types/string.md), \]) === [$PasswordState](../types/PasswordState.md) +*** +

$MadelineProto->[setStickerPositionInSet](setStickerPositionInSet.md)(\['sticker' => [InputFile](../types/InputFile.md), 'position' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) + ***

$MadelineProto->[terminateAllOtherSessions](terminateAllOtherSessions.md)(\[\]) === [$Ok](../types/Ok.md) @@ -479,25 +623,40 @@ $MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)();

$MadelineProto->[terminateSession](terminateSession.md)(\['session_id' => [long](../types/long.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[test->callBytes](test_callBytes.md)(\['x' => [bytes](../types/bytes.md), \]) === [$test\_Bytes](../types/test_Bytes.md) +

$MadelineProto->[testCallBytes](testCallBytes.md)(\['x' => [bytes](../types/bytes.md), \]) === [$TestBytes](../types/TestBytes.md) -$MadelineProto->[test->callEmpty](test_callEmpty.md)(\[\]) === [$test\_Empty](../types/test_Empty.md) +*** +

$MadelineProto->[testCallEmpty](testCallEmpty.md)(\[\]) === [$Ok](../types/Ok.md) -$MadelineProto->[test->callString](test_callString.md)(\['x' => [string](../types/string.md), \]) === [$test\_String](../types/test_String.md) +*** +

$MadelineProto->[testCallString](testCallString.md)(\['x' => [string](../types/string.md), \]) === [$TestString](../types/TestString.md) -$MadelineProto->[test->callVectorInt](test_callVectorInt.md)(\['x' => \[[int](../types/int.md)\], \]) === [$test\_VectorInt](../types/test_VectorInt.md) +*** +

$MadelineProto->[testCallVectorInt](testCallVectorInt.md)(\['x' => \[[int](../types/int.md)\], \]) === [$TestVectorInt](../types/TestVectorInt.md) -$MadelineProto->[test->callVectorIntObject](test_callVectorIntObject.md)(\['x' => \[[test\_Int](../types/test_Int.md)\], \]) === [$test\_VectorIntObject](../types/test_VectorIntObject.md) +*** +

$MadelineProto->[testCallVectorIntObject](testCallVectorIntObject.md)(\['x' => \[[testInt](../constructors/testInt.md)\], \]) === [$TestVectorIntObject](../types/TestVectorIntObject.md) -$MadelineProto->[test->callVectorString](test_callVectorString.md)(\['x' => \[[string](../types/string.md)\], \]) === [$test\_VectorString](../types/test_VectorString.md) +*** +

$MadelineProto->[testCallVectorString](testCallVectorString.md)(\['x' => \[[string](../types/string.md)\], \]) === [$TestVectorString](../types/TestVectorString.md) -$MadelineProto->[test->callVectorStringObject](test_callVectorStringObject.md)(\['x' => \[[test\_String](../types/test_String.md)\], \]) === [$test\_VectorStringObject](../types/test_VectorStringObject.md) +*** +

$MadelineProto->[testCallVectorStringObject](testCallVectorStringObject.md)(\['x' => \[[testString](../constructors/testString.md)\], \]) === [$TestVectorStringObject](../types/TestVectorStringObject.md) -$MadelineProto->[test->forceGetDifference](test_forceGetDifference.md)(\[\]) === [$Ok](../types/Ok.md) +*** +

$MadelineProto->[testGetDifference](testGetDifference.md)(\[\]) === [$Ok](../types/Ok.md) -$MadelineProto->[test->squareInt](test_squareInt.md)(\['x' => [int](../types/int.md), \]) === [$test\_Int](../types/test_Int.md) +*** +

$MadelineProto->[testNetwork](testNetwork.md)(\[\]) === [$Ok](../types/Ok.md) -$MadelineProto->[test->testNet](test_testNet.md)(\[\]) === [$test\_Empty](../types/test_Empty.md) +*** +

$MadelineProto->[testSquareInt](testSquareInt.md)(\['x' => [int](../types/int.md), \]) === [$TestInt](../types/TestInt.md) + +*** +

$MadelineProto->[testUseError](testUseError.md)(\[\]) === [$Error](../types/Error.md) + +*** +

$MadelineProto->[testUseUpdate](testUseUpdate.md)(\[\]) === [$Update](../types/Update.md) ***

$MadelineProto->[toggleChannelInvites](toggleChannelInvites.md)(\['channel_id' => [int](../types/int.md), 'anyone_can_invite' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) @@ -506,7 +665,10 @@ $MadelineProto->[test->testNet](test_testNet.md)(\[\]) === [$test\_Empty](../typ

$MadelineProto->[toggleChannelSignMessages](toggleChannelSignMessages.md)(\['channel_id' => [int](../types/int.md), 'sign_messages' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[toggleGroupEditors](toggleGroupEditors.md)(\['group_id' => [int](../types/int.md), 'anyone_can_edit' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[toggleChatIsPinned](toggleChatIsPinned.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'is_pinned' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) + +*** +

$MadelineProto->[toggleGroupAdministrators](toggleGroupAdministrators.md)(\['group_id' => [int](../types/int.md), 'everyone_is_administrator' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[unblockUser](unblockUser.md)(\['user_id' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) @@ -515,10 +677,16 @@ $MadelineProto->[test->testNet](test_testNet.md)(\[\]) === [$test\_Empty](../typ

$MadelineProto->[unpinChannelMessage](unpinChannelMessage.md)(\['channel_id' => [int](../types/int.md), \]) === [$Ok](../types/Ok.md) *** -

$MadelineProto->[updateStickerSet](updateStickerSet.md)(\['set_id' => [long](../types/long.md), 'is_installed' => [Bool](../types/Bool.md), 'is_archived' => [Bool](../types/Bool.md), \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[uploadFile](uploadFile.md)(\['file' => [InputFile](../types/InputFile.md), 'file_type' => [FileType](../types/FileType.md), 'priority' => [int](../types/int.md), \]) === [$File](../types/File.md) *** -

$MadelineProto->[viewMessages](viewMessages.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_ids' => \[[long](../types/long.md)\], \]) === [$Ok](../types/Ok.md) +

$MadelineProto->[uploadStickerFile](uploadStickerFile.md)(\['user_id' => [int](../types/int.md), 'png_sticker' => [InputFile](../types/InputFile.md), \]) === [$File](../types/File.md) + +*** +

$MadelineProto->[validateOrderInfo](validateOrderInfo.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_id' => [int53](../constructors/int53.md), 'order_info' => [orderInfo](../constructors/orderInfo.md), 'allow_save' => [Bool](../types/Bool.md), \]) === [$ValidatedOrderInfo](../types/ValidatedOrderInfo.md) + +*** +

$MadelineProto->[viewMessages](viewMessages.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'message_ids' => \[[int53](../constructors/int53.md)\], \]) === [$Ok](../types/Ok.md) ***

$MadelineProto->[viewTrendingStickerSets](viewTrendingStickerSets.md)(\['sticker_set_ids' => \[[long](../types/long.md)\], \]) === [$Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/openMessageContent.md b/docs/TD_docs/methods/openMessageContent.md index 22fa4937..65f5c527 100644 --- a/docs/TD_docs/methods/openMessageContent.md +++ b/docs/TD_docs/methods/openMessageContent.md @@ -1,6 +1,6 @@ --- title: openMessageContent -description: Message content is opened, for example the user has opened a photo, a video, a document, a location or a venue or have listened to an audio or a voice message +description: Message content is opened, for example the user has opened a photo, a video, a document, a location or a venue or have listened to an audio or a voice message. You will receive updateOpenMessageContent if something has changed --- ## Method: openMessageContent [Back to methods index](index.md) @@ -9,14 +9,14 @@ description: Message content is opened, for example the user has opened a photo, YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Message content is opened, for example the user has opened a photo, a video, a document, a location or a venue or have listened to an audio or a voice message +Message content is opened, for example the user has opened a photo, a video, a document, a location or a venue or have listened to an audio or a voice message. You will receive updateOpenMessageContent if something has changed ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier of the message| -|message\_id|[long](../types/long.md) | Yes|Identifier of the message with opened content| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message with opened content| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/optimizeStorage.md b/docs/TD_docs/methods/optimizeStorage.md new file mode 100644 index 00000000..ec17f03d --- /dev/null +++ b/docs/TD_docs/methods/optimizeStorage.md @@ -0,0 +1,29 @@ +--- +title: optimizeStorage +description: Optimizes storage usage, i.e. deletes some files and return new storage usage statistics. Secret thumbnails can't be deleted +--- +## Method: optimizeStorage +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Optimizes storage usage, i.e. deletes some files and return new storage usage statistics. Secret thumbnails can't be deleted + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|size|[int53](../types/int53.md) | Yes|Limit on total size of files after deletion. Pass -1 to use default limit| +|ttl|[int](../types/int.md) | Yes|Limit on time passed since last access time (or creation time on some filesystems) to a file. Pass -1 to use default limit| +|count|[int](../types/int.md) | Yes|Limit on total count of files after deletion. Pass -1 to use default limit| +|immunity\_delay|[int](../types/int.md) | Yes|Number of seconds after creation of a file, it can't be delited. Pass -1 to use default value| +|file\_types|Array of [FileType](../types/FileType.md) | Yes|If not empty, only files with given types are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted| +|chat\_ids|Array of [int53](../types/int53.md) | Yes|If not empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat, for example profile photos| +|exclude\_chat\_ids|Array of [int53](../types/int53.md) | Yes|If not empty, files from the given chats are exluded. Use 0 as chat identifier to exclude all files not belonging to any chat, for example profile photos| +|chat\_limit|[int](../types/int.md) | Yes|Same as in getStorageStatistics. Affects only returned statistics| + + +### Return type: [StorageStatistics](../types/StorageStatistics.md) + diff --git a/docs/TD_docs/methods/pinChannelMessage.md b/docs/TD_docs/methods/pinChannelMessage.md index 2f1e38b1..4fed3023 100644 --- a/docs/TD_docs/methods/pinChannelMessage.md +++ b/docs/TD_docs/methods/pinChannelMessage.md @@ -1,6 +1,6 @@ --- title: pinChannelMessage -description: Pins a message in a supergroup channel chat. Needs editor privileges in the channel +description: Pins a message in a supergroup channel chat. Needs appropriate rights in the channel --- ## Method: pinChannelMessage [Back to methods index](index.md) @@ -9,14 +9,14 @@ description: Pins a message in a supergroup channel chat. Needs editor privilege YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Pins a message in a supergroup channel chat. Needs editor privileges in the channel +Pins a message in a supergroup channel chat. Needs appropriate rights in the channel ### Params: | Name | Type | Required | Description | |----------|---------------|----------|-------------| |channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| -|message\_id|[long](../types/long.md) | Yes|Identifier of the new pinned message| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the new pinned message| |disable\_notification|[Bool](../types/Bool.md) | Yes|True, if there should be no notification about the pinned message| diff --git a/docs/TD_docs/methods/processDcUpdate.md b/docs/TD_docs/methods/processDcUpdate.md new file mode 100644 index 00000000..6a795563 --- /dev/null +++ b/docs/TD_docs/methods/processDcUpdate.md @@ -0,0 +1,23 @@ +--- +title: processDcUpdate +description: Handles DC_UPDATE push service notification. Can be called before authorization +--- +## Method: processDcUpdate +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Handles DC_UPDATE push service notification. Can be called before authorization + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dc|[string](../types/string.md) | Yes|Value of 'dc' paramater of the notification| +|addr|[string](../types/string.md) | Yes|Value of 'addr' parameter of the notification| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/rateCall.md b/docs/TD_docs/methods/rateCall.md new file mode 100644 index 00000000..74d80003 --- /dev/null +++ b/docs/TD_docs/methods/rateCall.md @@ -0,0 +1,24 @@ +--- +title: rateCall +description: Sends call rating +--- +## Method: rateCall +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Sends call rating + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|call\_id|[int](../types/int.md) | Yes|Call identifier| +|rating|[int](../types/int.md) | Yes|Call rating, 1-5| +|comment|[string](../types/string.md) | Yes|Optional user comment if rating is less than 5| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/recoverAuthPassword.md b/docs/TD_docs/methods/recoverAuthPassword.md index b0a64c45..8cd2785d 100644 --- a/docs/TD_docs/methods/recoverAuthPassword.md +++ b/docs/TD_docs/methods/recoverAuthPassword.md @@ -1,6 +1,6 @@ --- title: recoverAuthPassword -description: Recovers password with recovery code sent to email. Works only when authGetState returns authStateWaitPassword. Returns authStateOk on success +description: Recovers password with recovery code sent to email. Works only when getAuthState returns authStateWaitPassword. Returns authStateOk on success --- ## Method: recoverAuthPassword [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Recovers password with recovery code sent to email. Works only when YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Recovers password with recovery code sent to email. Works only when authGetState returns authStateWaitPassword. Returns authStateOk on success +Recovers password with recovery code sent to email. Works only when getAuthState returns authStateWaitPassword. Returns authStateOk on success ### Params: diff --git a/docs/TD_docs/methods/reorderStickerSets.md b/docs/TD_docs/methods/reorderInstalledStickerSets.md similarity index 78% rename from docs/TD_docs/methods/reorderStickerSets.md rename to docs/TD_docs/methods/reorderInstalledStickerSets.md index 3f4fb6fc..f5d6f9e9 100644 --- a/docs/TD_docs/methods/reorderStickerSets.md +++ b/docs/TD_docs/methods/reorderInstalledStickerSets.md @@ -1,8 +1,8 @@ --- -title: reorderStickerSets +title: reorderInstalledStickerSets description: Changes the order of installed sticker sets --- -## Method: reorderStickerSets +## Method: reorderInstalledStickerSets [Back to methods index](index.md) @@ -15,7 +15,7 @@ Changes the order of installed sticker sets | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to change masks order, pass false to change stickers order| +|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to change mask sticker sets order, pass false to change ordinary sticker sets order| |sticker\_set\_ids|Array of [long](../types/long.md) | Yes|Identifiers of installed sticker sets in the new right order| diff --git a/docs/TD_docs/methods/reportChannelSpam.md b/docs/TD_docs/methods/reportChannelSpam.md index a4082d83..343049ff 100644 --- a/docs/TD_docs/methods/reportChannelSpam.md +++ b/docs/TD_docs/methods/reportChannelSpam.md @@ -17,7 +17,7 @@ Reports some supergroup channel messages from a user as spam messages |----------|---------------|----------|-------------| |channel\_id|[int](../types/int.md) | Yes|Channel identifier| |user\_id|[int](../types/int.md) | Yes|User identifier| -|message\_ids|Array of [long](../types/long.md) | Yes|Identifiers of messages sent in the supergroup by the user, the list should be non-empty| +|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of messages sent in the supergroup by the user, the list should be non-empty| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/reportChat.md b/docs/TD_docs/methods/reportChat.md new file mode 100644 index 00000000..99bb1381 --- /dev/null +++ b/docs/TD_docs/methods/reportChat.md @@ -0,0 +1,23 @@ +--- +title: reportChat +description: Reports chat to Telegram moderators. Can be used only for a channel chat or a private chat with a bot, because all other chats can't be checked by moderators +--- +## Method: reportChat +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Reports chat to Telegram moderators. Can be used only for a channel chat or a private chat with a bot, because all other chats can't be checked by moderators + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| +|reason|[ChatReportReason](../types/ChatReportReason.md) | Yes|Reason, the chat is reported| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/requestAuthPasswordRecovery.md b/docs/TD_docs/methods/requestAuthPasswordRecovery.md index f6ee9259..1c3f7f6e 100644 --- a/docs/TD_docs/methods/requestAuthPasswordRecovery.md +++ b/docs/TD_docs/methods/requestAuthPasswordRecovery.md @@ -1,6 +1,6 @@ --- title: requestAuthPasswordRecovery -description: Requests to send password recovery code to email. Works only when authGetState returns authStateWaitPassword. Returns authStateWaitPassword on success +description: Requests to send password recovery code to email. Works only when getAuthState returns authStateWaitPassword. Returns authStateWaitPassword on success --- ## Method: requestAuthPasswordRecovery [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Requests to send password recovery code to email. Works only when a YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Requests to send password recovery code to email. Works only when authGetState returns authStateWaitPassword. Returns authStateWaitPassword on success +Requests to send password recovery code to email. Works only when getAuthState returns authStateWaitPassword. Returns authStateWaitPassword on success ### Params: diff --git a/docs/TD_docs/methods/resendAuthCode.md b/docs/TD_docs/methods/resendAuthCode.md index f442bdff..ab0a13ee 100644 --- a/docs/TD_docs/methods/resendAuthCode.md +++ b/docs/TD_docs/methods/resendAuthCode.md @@ -1,6 +1,6 @@ --- title: resendAuthCode -description: Resends authentication code to the user. Works only when authGetState returns authStateWaitCode and next_code_type of result is not null. Returns authStateWaitCode on success +description: Resends authentication code to the user. Works only when getAuthState returns authStateWaitCode and next_code_type of result is not null. Returns authStateWaitCode on success --- ## Method: resendAuthCode [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Resends authentication code to the user. Works only when authGetSta YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Resends authentication code to the user. Works only when authGetState returns authStateWaitCode and next_code_type of result is not null. Returns authStateWaitCode on success +Resends authentication code to the user. Works only when getAuthState returns authStateWaitCode and next_code_type of result is not null. Returns authStateWaitCode on success ### Params: diff --git a/docs/TD_docs/methods/resetNetworkStatistics.md b/docs/TD_docs/methods/resetNetworkStatistics.md new file mode 100644 index 00000000..a5a78b19 --- /dev/null +++ b/docs/TD_docs/methods/resetNetworkStatistics.md @@ -0,0 +1,21 @@ +--- +title: resetNetworkStatistics +description: Resets all network data usage statistics to zero. Can be called before authorization +--- +## Method: resetNetworkStatistics +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Resets all network data usage statistics to zero. Can be called before authorization + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/searchCallMessages.md b/docs/TD_docs/methods/searchCallMessages.md new file mode 100644 index 00000000..111f86d8 --- /dev/null +++ b/docs/TD_docs/methods/searchCallMessages.md @@ -0,0 +1,24 @@ +--- +title: searchCallMessages +description: Searches for call messages. Returns result in reverse chronological order, i. e. in order of decreasing message_id +--- +## Method: searchCallMessages +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Searches for call messages. Returns result in reverse chronological order, i. e. in order of decreasing message_id + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|from\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message from which to search, you can use 0 to get results from beginning| +|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, can't be greater than 100. There may be less than limit messages returned even the end of the history is not reached filter| +|only\_missed|[Bool](../types/Bool.md) | Yes|If true, return only messages with missed calls| + + +### Return type: [Messages](../types/Messages.md) + diff --git a/docs/TD_docs/methods/searchChatMembers.md b/docs/TD_docs/methods/searchChatMembers.md new file mode 100644 index 00000000..79105221 --- /dev/null +++ b/docs/TD_docs/methods/searchChatMembers.md @@ -0,0 +1,24 @@ +--- +title: searchChatMembers +description: Searches for the specified query in the first name, last name and username among members of the specified chat. Requires administrator rights in broadcast channels +--- +## Method: searchChatMembers +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Searches for the specified query in the first name, last name and username among members of the specified chat. Requires administrator rights in broadcast channels + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| +|query|[string](../types/string.md) | Yes|Query to search for| +|limit|[int](../types/int.md) | Yes|Maximum number of users to be returned| + + +### Return type: [ChatMembers](../types/ChatMembers.md) + diff --git a/docs/TD_docs/methods/searchChatMessages.md b/docs/TD_docs/methods/searchChatMessages.md index 1472621a..862ad0fc 100644 --- a/docs/TD_docs/methods/searchChatMessages.md +++ b/docs/TD_docs/methods/searchChatMessages.md @@ -1,6 +1,6 @@ --- title: searchChatMessages -description: Searches for messages with given words in the chat. Returns result in reverse chronological order, i. e. in order of decreasimg message_id. Doesn't work in secret chats +description: Searches for messages with given words in the chat. Returns result in reverse chronological order, i. e. in order of decreasing message_id. Doesn't work in secret chats with non-empty query (searchSecretMessages should be used instead) or without enabled message database --- ## Method: searchChatMessages [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Searches for messages with given words in the chat. Returns result YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Searches for messages with given words in the chat. Returns result in reverse chronological order, i. e. in order of decreasimg message_id. Doesn't work in secret chats +Searches for messages with given words in the chat. Returns result in reverse chronological order, i. e. in order of decreasing message_id. Doesn't work in secret chats with non-empty query (searchSecretMessages should be used instead) or without enabled message database ### Params: @@ -17,8 +17,9 @@ Searches for messages with given words in the chat. Returns result in reverse ch |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier to search in| |query|[string](../types/string.md) | Yes|Query to search for| -|from\_message\_id|[long](../types/long.md) | Yes|Identifier of the message from which we need a history, you can use 0 to get results from beginning| -|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, can't be greater than 100| +|sender\_user\_id|[int](../types/int.md) | Yes|If not 0, only messages sent by the specified user will be returned. Doesn't supported in secret chats| +|from\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message from which we need a history, you can use 0 to get results from the beginning| +|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, can't be greater than 100. There may be less than limit messages returned even the end of the history is not reached| |filter|[SearchMessagesFilter](../types/SearchMessagesFilter.md) | Yes|Filter for content of searched messages| diff --git a/docs/TD_docs/methods/searchHashtags.md b/docs/TD_docs/methods/searchHashtags.md new file mode 100644 index 00000000..3e95cf96 --- /dev/null +++ b/docs/TD_docs/methods/searchHashtags.md @@ -0,0 +1,23 @@ +--- +title: searchHashtags +description: Searches for recently used hashtags by their prefix +--- +## Method: searchHashtags +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Searches for recently used hashtags by their prefix + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prefix|[string](../types/string.md) | Yes|Hashtag prefix to search for| +|limit|[int](../types/int.md) | Yes|Maximum number of hashtags to return| + + +### Return type: [Hashtags](../types/Hashtags.md) + diff --git a/docs/TD_docs/methods/searchMessages.md b/docs/TD_docs/methods/searchMessages.md index 4c56c5d0..32690ca0 100644 --- a/docs/TD_docs/methods/searchMessages.md +++ b/docs/TD_docs/methods/searchMessages.md @@ -17,9 +17,9 @@ Searches for messages in all chats except secret chats. Returns result in revers |----------|---------------|----------|-------------| |query|[string](../types/string.md) | Yes|Query to search for| |offset\_date|[int](../types/int.md) | Yes|Date of the message to search from, you can use 0 or any date in the future to get results from the beginning| -|offset\_chat\_id|[long](../types/long.md) | Yes|Chat identifier of the last found message or 0 for the first request| -|offset\_message\_id|[long](../types/long.md) | Yes|Message identifier of the last found message or 0 for the first request| -|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, can't be greater than 100| +|offset\_chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the last found message or 0 for the first request| +|offset\_message\_id|[int53](../types/int53.md) | Yes|Message identifier of the last found message or 0 for the first request| +|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, at most 100| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/searchSecretMessages.md b/docs/TD_docs/methods/searchSecretMessages.md new file mode 100644 index 00000000..e93798d8 --- /dev/null +++ b/docs/TD_docs/methods/searchSecretMessages.md @@ -0,0 +1,26 @@ +--- +title: searchSecretMessages +description: Searches for messages in secret chats. Returns result in reverse chronological order +--- +## Method: searchSecretMessages +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Searches for messages in secret chats. Returns result in reverse chronological order + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Identifier of a chat to search in. Specify 0 to search in all secret chats| +|query|[string](../types/string.md) | Yes|Query to search for. If empty, searchChatMessages should be used instead| +|from\_search\_id|[long](../types/long.md) | Yes|Identifier from the result of previous request, use 0 to get results from the beginning| +|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, can't be greater than 100| +|filter|[SearchMessagesFilter](../types/SearchMessagesFilter.md) | Yes|Filter for content of searched messages| + + +### Return type: [FoundMessages](../types/FoundMessages.md) + diff --git a/docs/TD_docs/methods/sendChatAction.md b/docs/TD_docs/methods/sendChatAction.md index db3051fa..d2caa09c 100644 --- a/docs/TD_docs/methods/sendChatAction.md +++ b/docs/TD_docs/methods/sendChatAction.md @@ -16,7 +16,7 @@ Sends notification about user activity in a chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Action description| +|action|[ChatAction](../types/ChatAction.md) | Yes|Action description| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md b/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md index 5b6ad3ff..b18804b2 100644 --- a/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md +++ b/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md @@ -1,6 +1,6 @@ --- title: sendChatScreenshotTakenNotification -description: Sends notification about screenshot taken in a chat. Works only in secret chats +description: Sends notification about screenshot taken in a chat. Works only in private and secret chats --- ## Method: sendChatScreenshotTakenNotification [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Sends notification about screenshot taken in a chat. Works only in YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Sends notification about screenshot taken in a chat. Works only in secret chats +Sends notification about screenshot taken in a chat. Works only in private and secret chats ### Params: diff --git a/docs/TD_docs/methods/sendCustomRequest.md b/docs/TD_docs/methods/sendCustomRequest.md new file mode 100644 index 00000000..c0df725c --- /dev/null +++ b/docs/TD_docs/methods/sendCustomRequest.md @@ -0,0 +1,23 @@ +--- +title: sendCustomRequest +description: Bots only. Sends custom request +--- +## Method: sendCustomRequest +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Bots only. Sends custom request + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|method|[string](../types/string.md) | Yes|Method name| +|parameters|[string](../types/string.md) | Yes|JSON-serialized method parameters| + + +### Return type: [CustomRequestResult](../types/CustomRequestResult.md) + diff --git a/docs/TD_docs/methods/sendInlineQueryResultMessage.md b/docs/TD_docs/methods/sendInlineQueryResultMessage.md index 910caeb7..e101ecde 100644 --- a/docs/TD_docs/methods/sendInlineQueryResultMessage.md +++ b/docs/TD_docs/methods/sendInlineQueryResultMessage.md @@ -16,7 +16,7 @@ Sends result of the inline query as a message. Returns sent message. UpdateChatT | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat to send message| -|reply\_to\_message\_id|[long](../types/long.md) | Yes|Identifier of a message to reply to or 0| +|reply\_to\_message\_id|[int53](../types/int53.md) | Yes|Identifier of a message to reply to or 0| |disable\_notification|[Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works in secret chats| |from\_background|[Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| |query\_id|[long](../types/long.md) | Yes|Identifier of the inline query| diff --git a/docs/TD_docs/methods/sendMessage.md b/docs/TD_docs/methods/sendMessage.md index 72d40fd5..029122ae 100644 --- a/docs/TD_docs/methods/sendMessage.md +++ b/docs/TD_docs/methods/sendMessage.md @@ -16,7 +16,7 @@ Sends a message. Returns sent message. UpdateChatTopMessage will not be sent, so | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat to send message| -|reply\_to\_message\_id|[long](../types/long.md) | Yes|Identifier of a message to reply to or 0| +|reply\_to\_message\_id|[int53](../types/int53.md) | Yes|Identifier of a message to reply to or 0| |disable\_notification|[Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works in secret chats| |from\_background|[Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| |reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. Markup for replying to message| diff --git a/docs/TD_docs/methods/sendPaymentForm.md b/docs/TD_docs/methods/sendPaymentForm.md new file mode 100644 index 00000000..025b9cf6 --- /dev/null +++ b/docs/TD_docs/methods/sendPaymentForm.md @@ -0,0 +1,26 @@ +--- +title: sendPaymentForm +description: Sends filled payment form to the bot for the final verification +--- +## Method: sendPaymentForm +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Sends filled payment form to the bot for the final verification + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier of the Invoice message| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| +|order\_info\_id|[string](../types/string.md) | Yes|Identifier returned by ValidateOrderInfo or empty string| +|shipping\_option\_id|[string](../types/string.md) | Yes|Identifier of a chosen shipping option, if applicable| +|credentials|[InputCredentials](../types/InputCredentials.md) | Yes|Credentials choosed by user for payment| + + +### Return type: [PaymentResult](../types/PaymentResult.md) + diff --git a/docs/TD_docs/methods/setAlarm.md b/docs/TD_docs/methods/setAlarm.md index 026812a9..caf3a391 100644 --- a/docs/TD_docs/methods/setAlarm.md +++ b/docs/TD_docs/methods/setAlarm.md @@ -1,6 +1,6 @@ --- title: setAlarm -description: Returns Ok after specified amount of the time passed +description: Returns Ok after specified amount of the time passed. Can be called before authorization --- ## Method: setAlarm [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Returns Ok after specified amount of the time passed YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Returns Ok after specified amount of the time passed +Returns Ok after specified amount of the time passed. Can be called before authorization ### Params: diff --git a/docs/TD_docs/methods/setAuthPhoneNumber.md b/docs/TD_docs/methods/setAuthPhoneNumber.md index f0193616..50b3631c 100644 --- a/docs/TD_docs/methods/setAuthPhoneNumber.md +++ b/docs/TD_docs/methods/setAuthPhoneNumber.md @@ -1,6 +1,6 @@ --- title: setAuthPhoneNumber -description: Sets user's phone number and sends authentication code to the user. Works only when authGetState returns authStateWaitPhoneNumber. If phone number is not recognized or another error has happened, returns an error. Otherwise returns authStateWaitCode +description: Sets user's phone number and sends authentication code to the user. Works only when getAuthState returns authStateWaitPhoneNumber. If phone number is not recognized or another error has happened, returns an error. Otherwise returns authStateWaitCode --- ## Method: setAuthPhoneNumber [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Sets user's phone number and sends authentication code to the user. YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Sets user's phone number and sends authentication code to the user. Works only when authGetState returns authStateWaitPhoneNumber. If phone number is not recognized or another error has happened, returns an error. Otherwise returns authStateWaitCode +Sets user's phone number and sends authentication code to the user. Works only when getAuthState returns authStateWaitPhoneNumber. If phone number is not recognized or another error has happened, returns an error. Otherwise returns authStateWaitCode ### Params: diff --git a/docs/TD_docs/methods/setChatClientData.md b/docs/TD_docs/methods/setChatClientData.md new file mode 100644 index 00000000..3f478040 --- /dev/null +++ b/docs/TD_docs/methods/setChatClientData.md @@ -0,0 +1,23 @@ +--- +title: setChatClientData +description: Changes client data associated with a chat +--- +## Method: setChatClientData +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Changes client data associated with a chat + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| +|client\_data|[string](../types/string.md) | Yes|New value of client_data| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/setFileGenerationProgress.md b/docs/TD_docs/methods/setFileGenerationProgress.md index d1fcba23..4492fa00 100644 --- a/docs/TD_docs/methods/setFileGenerationProgress.md +++ b/docs/TD_docs/methods/setFileGenerationProgress.md @@ -16,7 +16,8 @@ Next part of a file was generated | Name | Type | Required | Description | |----------|---------------|----------|-------------| |generation\_id|[long](../types/long.md) | Yes|Identifier of the generation process| -|ready|[int](../types/int.md) | Yes|Number of bytes already generated. Negative number means that generation has failed and should be terminated| +|size|[int](../types/int.md) | Yes|Full size of file in bytes, 0 if unknown.| +|local\_size|[int](../types/int.md) | Yes|Number of bytes already generated. Negative number means that generation has failed and should be terminated| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setGameScore.md b/docs/TD_docs/methods/setGameScore.md index e47eaeab..3b30695d 100644 --- a/docs/TD_docs/methods/setGameScore.md +++ b/docs/TD_docs/methods/setGameScore.md @@ -16,7 +16,7 @@ Bots only. Updates game score of the specified user in the game | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat a message with the game belongs to| -|message\_id|[long](../types/long.md) | Yes|Identifier of the message| +|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| |edit\_message|[Bool](../types/Bool.md) | Yes|True, if message should be edited| |user\_id|[int](../types/int.md) | Yes|User identifier| |score|[int](../types/int.md) | Yes|New score| diff --git a/docs/TD_docs/methods/setNetworkType.md b/docs/TD_docs/methods/setNetworkType.md new file mode 100644 index 00000000..666be2d9 --- /dev/null +++ b/docs/TD_docs/methods/setNetworkType.md @@ -0,0 +1,22 @@ +--- +title: setNetworkType +description: Sets current network type. Can be called before authorization. Call to this method forces reopening of all network connections mitigating delay in switching between different networks, so it should be called whenever network is changed even network type remains the same. Network type is used to check if library can use network at all and for collecting detailed network data usage statistics +--- +## Method: setNetworkType +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Sets current network type. Can be called before authorization. Call to this method forces reopening of all network connections mitigating delay in switching between different networks, so it should be called whenever network is changed even network type remains the same. Network type is used to check if library can use network at all and for collecting detailed network data usage statistics + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[NetworkType](../types/NetworkType.md) | Yes|New network type, defaults to networkTypeNone| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/setOption.md b/docs/TD_docs/methods/setOption.md index 3f774a34..d422abc6 100644 --- a/docs/TD_docs/methods/setOption.md +++ b/docs/TD_docs/methods/setOption.md @@ -1,6 +1,6 @@ --- title: setOption -description: Sets value of an option. See list of available options on https: core.telegram.org/tdlib/options. Only writable options can be set +description: Sets value of an option. See list of available options on https: core.telegram.org/tdlib/options. Only writable options can be set. Can be called before authorization --- ## Method: setOption [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Sets value of an option. See list of available options on https: co YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Sets value of an option. See list of available options on https: core.telegram.org/tdlib/options. Only writable options can be set +Sets value of an option. See list of available options on https: core.telegram.org/tdlib/options. Only writable options can be set. Can be called before authorization ### Params: diff --git a/docs/TD_docs/methods/setPinnedChats.md b/docs/TD_docs/methods/setPinnedChats.md new file mode 100644 index 00000000..d1be5077 --- /dev/null +++ b/docs/TD_docs/methods/setPinnedChats.md @@ -0,0 +1,22 @@ +--- +title: setPinnedChats +description: Changes list or order of pinned chats +--- +## Method: setPinnedChats +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Changes list or order of pinned chats + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_ids|Array of [int53](../types/int53.md) | Yes|New list of pinned chats| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/setProfilePhoto.md b/docs/TD_docs/methods/setProfilePhoto.md index ce64d2c2..058c4d07 100644 --- a/docs/TD_docs/methods/setProfilePhoto.md +++ b/docs/TD_docs/methods/setProfilePhoto.md @@ -15,7 +15,7 @@ Uploads new profile photo for logged in user. Photo will not change until change | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|photo\_path|[string](../types/string.md) | Yes|Path to new profile photo| +|photo|[InputFile](../types/InputFile.md) | Yes|Profile photo to set. inputFileId and inputFilePersistentId may be unsupported| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setProxy.md b/docs/TD_docs/methods/setProxy.md new file mode 100644 index 00000000..0af36a3e --- /dev/null +++ b/docs/TD_docs/methods/setProxy.md @@ -0,0 +1,22 @@ +--- +title: setProxy +description: Sets proxy server for network requests. Can be called before authorization +--- +## Method: setProxy +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Sets proxy server for network requests. Can be called before authorization + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|proxy|[Proxy](../types/Proxy.md) | Yes|The proxy to use. You can specify null to remove proxy server| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/setStickerPositionInSet.md b/docs/TD_docs/methods/setStickerPositionInSet.md new file mode 100644 index 00000000..dfa46b0f --- /dev/null +++ b/docs/TD_docs/methods/setStickerPositionInSet.md @@ -0,0 +1,23 @@ +--- +title: setStickerPositionInSet +description: Bots only. Changes position of a sticker in the set it belongs to. Sticker set should be created by the bot +--- +## Method: setStickerPositionInSet +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Bots only. Changes position of a sticker in the set it belongs to. Sticker set should be created by the bot + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[InputFile](../types/InputFile.md) | Yes|The sticker| +|position|[int](../types/int.md) | Yes|New sticker position in the set, zero-based| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/testCallBytes.md b/docs/TD_docs/methods/testCallBytes.md new file mode 100644 index 00000000..d4a6aec3 --- /dev/null +++ b/docs/TD_docs/methods/testCallBytes.md @@ -0,0 +1,22 @@ +--- +title: testCallBytes +description: Test request. Returns back received bytes +--- +## Method: testCallBytes +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Returns back received bytes + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|x|[bytes](../types/bytes.md) | Yes|Bytes to return| + + +### Return type: [TestBytes](../types/TestBytes.md) + diff --git a/docs/TD_docs/methods/testCallEmpty.md b/docs/TD_docs/methods/testCallEmpty.md new file mode 100644 index 00000000..be79418c --- /dev/null +++ b/docs/TD_docs/methods/testCallEmpty.md @@ -0,0 +1,21 @@ +--- +title: testCallEmpty +description: Test request. Does nothing +--- +## Method: testCallEmpty +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Does nothing + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/testCallString.md b/docs/TD_docs/methods/testCallString.md new file mode 100644 index 00000000..fe464ae9 --- /dev/null +++ b/docs/TD_docs/methods/testCallString.md @@ -0,0 +1,22 @@ +--- +title: testCallString +description: Test request. Returns back received string +--- +## Method: testCallString +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Returns back received string + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|x|[string](../types/string.md) | Yes|String to return| + + +### Return type: [TestString](../types/TestString.md) + diff --git a/docs/TD_docs/methods/testCallVectorInt.md b/docs/TD_docs/methods/testCallVectorInt.md new file mode 100644 index 00000000..3963ea3c --- /dev/null +++ b/docs/TD_docs/methods/testCallVectorInt.md @@ -0,0 +1,22 @@ +--- +title: testCallVectorInt +description: Test request. Returns back received vector of numbers +--- +## Method: testCallVectorInt +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Returns back received vector of numbers + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|x|Array of [int](../types/int.md) | Yes|Vector of numbers to return| + + +### Return type: [TestVectorInt](../types/TestVectorInt.md) + diff --git a/docs/TD_docs/methods/testCallVectorIntObject.md b/docs/TD_docs/methods/testCallVectorIntObject.md new file mode 100644 index 00000000..76c294bc --- /dev/null +++ b/docs/TD_docs/methods/testCallVectorIntObject.md @@ -0,0 +1,22 @@ +--- +title: testCallVectorIntObject +description: Test request. Returns back received vector of objects containing a number +--- +## Method: testCallVectorIntObject +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Returns back received vector of objects containing a number + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|x|Array of [testInt](../types/testInt.md) | Yes|Vector of objects to return| + + +### Return type: [TestVectorIntObject](../types/TestVectorIntObject.md) + diff --git a/docs/TD_docs/methods/testCallVectorString.md b/docs/TD_docs/methods/testCallVectorString.md new file mode 100644 index 00000000..ac1dfd08 --- /dev/null +++ b/docs/TD_docs/methods/testCallVectorString.md @@ -0,0 +1,22 @@ +--- +title: testCallVectorString +description: Test request. Returns back received vector of strings +--- +## Method: testCallVectorString +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Returns back received vector of strings + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|x|Array of [string](../types/string.md) | Yes|Vector of strings to return| + + +### Return type: [TestVectorString](../types/TestVectorString.md) + diff --git a/docs/TD_docs/methods/testCallVectorStringObject.md b/docs/TD_docs/methods/testCallVectorStringObject.md new file mode 100644 index 00000000..af9d7574 --- /dev/null +++ b/docs/TD_docs/methods/testCallVectorStringObject.md @@ -0,0 +1,22 @@ +--- +title: testCallVectorStringObject +description: Test request. Returns back received vector of objects containing a string +--- +## Method: testCallVectorStringObject +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Returns back received vector of objects containing a string + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|x|Array of [testString](../types/testString.md) | Yes|Vector of objects to return| + + +### Return type: [TestVectorStringObject](../types/TestVectorStringObject.md) + diff --git a/docs/TD_docs/methods/testGetDifference.md b/docs/TD_docs/methods/testGetDifference.md new file mode 100644 index 00000000..37e47883 --- /dev/null +++ b/docs/TD_docs/methods/testGetDifference.md @@ -0,0 +1,21 @@ +--- +title: testGetDifference +description: Test request. Forces updates.getDifference call to telegram servers +--- +## Method: testGetDifference +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Forces updates.getDifference call to telegram servers + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/testNetwork.md b/docs/TD_docs/methods/testNetwork.md new file mode 100644 index 00000000..1acb2920 --- /dev/null +++ b/docs/TD_docs/methods/testNetwork.md @@ -0,0 +1,21 @@ +--- +title: testNetwork +description: Test request. Sends simple network request to telegram servers +--- +## Method: testNetwork +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Sends simple network request to telegram servers + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/testSquareInt.md b/docs/TD_docs/methods/testSquareInt.md new file mode 100644 index 00000000..f1d907c3 --- /dev/null +++ b/docs/TD_docs/methods/testSquareInt.md @@ -0,0 +1,22 @@ +--- +title: testSquareInt +description: Test request. Returns squared received number +--- +## Method: testSquareInt +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Returns squared received number + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|x|[int](../types/int.md) | Yes|Number to square| + + +### Return type: [TestInt](../types/TestInt.md) + diff --git a/docs/TD_docs/methods/testUseError.md b/docs/TD_docs/methods/testUseError.md new file mode 100644 index 00000000..b15bd6c2 --- /dev/null +++ b/docs/TD_docs/methods/testUseError.md @@ -0,0 +1,21 @@ +--- +title: testUseError +description: Test request. Does nothing, ensures that the Error object is used +--- +## Method: testUseError +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Does nothing, ensures that the Error object is used + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [Error](../types/Error.md) + diff --git a/docs/TD_docs/methods/testUseUpdate.md b/docs/TD_docs/methods/testUseUpdate.md new file mode 100644 index 00000000..a8ab5892 --- /dev/null +++ b/docs/TD_docs/methods/testUseUpdate.md @@ -0,0 +1,21 @@ +--- +title: testUseUpdate +description: Test request. Does nothing, ensures that the Update object is used +--- +## Method: testUseUpdate +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Test request. Does nothing, ensures that the Update object is used + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| + + +### Return type: [Update](../types/Update.md) + diff --git a/docs/TD_docs/methods/test_callBytes.md b/docs/TD_docs/methods/test_callBytes.md deleted file mode 100644 index a48812c5..00000000 --- a/docs/TD_docs/methods/test_callBytes.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.callBytes -description: test.callBytes parameters, return type and example ---- -## Method: test.callBytes -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|x|[bytes](../types/bytes.md) | Yes| - - -### Return type: [test\_Bytes](../types/test_Bytes.md) - diff --git a/docs/TD_docs/methods/test_callEmpty.md b/docs/TD_docs/methods/test_callEmpty.md deleted file mode 100644 index b15031dc..00000000 --- a/docs/TD_docs/methods/test_callEmpty.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: test.callEmpty -description: test.callEmpty parameters, return type and example ---- -## Method: test.callEmpty -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - - - -### Return type: [test\_Empty](../types/test_Empty.md) - diff --git a/docs/TD_docs/methods/test_callString.md b/docs/TD_docs/methods/test_callString.md deleted file mode 100644 index 2dee6f3f..00000000 --- a/docs/TD_docs/methods/test_callString.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.callString -description: test.callString parameters, return type and example ---- -## Method: test.callString -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|x|[string](../types/string.md) | Yes| - - -### Return type: [test\_String](../types/test_String.md) - diff --git a/docs/TD_docs/methods/test_callVectorInt.md b/docs/TD_docs/methods/test_callVectorInt.md deleted file mode 100644 index 61345e7b..00000000 --- a/docs/TD_docs/methods/test_callVectorInt.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.callVectorInt -description: test.callVectorInt parameters, return type and example ---- -## Method: test.callVectorInt -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|x|Array of [int](../types/int.md) | Yes| - - -### Return type: [test\_VectorInt](../types/test_VectorInt.md) - diff --git a/docs/TD_docs/methods/test_callVectorIntObject.md b/docs/TD_docs/methods/test_callVectorIntObject.md deleted file mode 100644 index 3d59560a..00000000 --- a/docs/TD_docs/methods/test_callVectorIntObject.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.callVectorIntObject -description: test.callVectorIntObject parameters, return type and example ---- -## Method: test.callVectorIntObject -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|x|Array of [test\_Int](../types/test_Int.md) | Yes| - - -### Return type: [test\_VectorIntObject](../types/test_VectorIntObject.md) - diff --git a/docs/TD_docs/methods/test_callVectorString.md b/docs/TD_docs/methods/test_callVectorString.md deleted file mode 100644 index d249018c..00000000 --- a/docs/TD_docs/methods/test_callVectorString.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.callVectorString -description: test.callVectorString parameters, return type and example ---- -## Method: test.callVectorString -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|x|Array of [string](../types/string.md) | Yes| - - -### Return type: [test\_VectorString](../types/test_VectorString.md) - diff --git a/docs/TD_docs/methods/test_callVectorStringObject.md b/docs/TD_docs/methods/test_callVectorStringObject.md deleted file mode 100644 index 90c72204..00000000 --- a/docs/TD_docs/methods/test_callVectorStringObject.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.callVectorStringObject -description: test.callVectorStringObject parameters, return type and example ---- -## Method: test.callVectorStringObject -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|x|Array of [test\_String](../types/test_String.md) | Yes| - - -### Return type: [test\_VectorStringObject](../types/test_VectorStringObject.md) - diff --git a/docs/TD_docs/methods/test_forceGetDifference.md b/docs/TD_docs/methods/test_forceGetDifference.md deleted file mode 100644 index 3bccdcb0..00000000 --- a/docs/TD_docs/methods/test_forceGetDifference.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: test.forceGetDifference -description: test.forceGetDifference parameters, return type and example ---- -## Method: test.forceGetDifference -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - - - -### Return type: [Ok](../types/Ok.md) - diff --git a/docs/TD_docs/methods/test_squareInt.md b/docs/TD_docs/methods/test_squareInt.md deleted file mode 100644 index fdc1188a..00000000 --- a/docs/TD_docs/methods/test_squareInt.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: test.squareInt -description: test.squareInt parameters, return type and example ---- -## Method: test.squareInt -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|x|[int](../types/int.md) | Yes| - - -### Return type: [test\_Int](../types/test_Int.md) - diff --git a/docs/TD_docs/methods/test_testNet.md b/docs/TD_docs/methods/test_testNet.md deleted file mode 100644 index 94fae3f5..00000000 --- a/docs/TD_docs/methods/test_testNet.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: test.testNet -description: test.testNet parameters, return type and example ---- -## Method: test.testNet -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - - - -### Return type: [test\_Empty](../types/test_Empty.md) - diff --git a/docs/TD_docs/methods/toggleChannelInvites.md b/docs/TD_docs/methods/toggleChannelInvites.md index 0c36c63a..24077697 100644 --- a/docs/TD_docs/methods/toggleChannelInvites.md +++ b/docs/TD_docs/methods/toggleChannelInvites.md @@ -1,6 +1,6 @@ --- title: toggleChannelInvites -description: Gives or revokes right to invite new members to all current members of the channel. Needs creator privileges in the channel. Available only for supergroups +description: Gives or revokes right to invite new members to all current members of the channel. Needs appropriate rights in the channel. Available only for supergroups --- ## Method: toggleChannelInvites [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Gives or revokes right to invite new members to all current members YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Gives or revokes right to invite new members to all current members of the channel. Needs creator privileges in the channel. Available only for supergroups +Gives or revokes right to invite new members to all current members of the channel. Needs appropriate rights in the channel. Available only for supergroups ### Params: diff --git a/docs/TD_docs/methods/toggleChannelSignMessages.md b/docs/TD_docs/methods/toggleChannelSignMessages.md index 3aaf78ae..7ab4058e 100644 --- a/docs/TD_docs/methods/toggleChannelSignMessages.md +++ b/docs/TD_docs/methods/toggleChannelSignMessages.md @@ -1,6 +1,6 @@ --- title: toggleChannelSignMessages -description: Enables or disables sender signature on sent messages in the channel. Needs creator privileges in the channel. Not available for supergroups +description: Enables or disables sender signature on sent messages in the channel. Needs appropriate rights in the channel. Not available for supergroups --- ## Method: toggleChannelSignMessages [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Enables or disables sender signature on sent messages in the channe YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Enables or disables sender signature on sent messages in the channel. Needs creator privileges in the channel. Not available for supergroups +Enables or disables sender signature on sent messages in the channel. Needs appropriate rights in the channel. Not available for supergroups ### Params: diff --git a/docs/TD_docs/methods/toggleChatIsPinned.md b/docs/TD_docs/methods/toggleChatIsPinned.md new file mode 100644 index 00000000..444b4ea0 --- /dev/null +++ b/docs/TD_docs/methods/toggleChatIsPinned.md @@ -0,0 +1,23 @@ +--- +title: toggleChatIsPinned +description: Changes chat pinned state. You can pin up to getOption("pinned_chat_count_max") non-secret chats and the same number of secret chats +--- +## Method: toggleChatIsPinned +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Changes chat pinned state. You can pin up to getOption("pinned_chat_count_max") non-secret chats and the same number of secret chats + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| +|is\_pinned|[Bool](../types/Bool.md) | Yes|New value of is_pinned| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/toggleGroupAdministrators.md b/docs/TD_docs/methods/toggleGroupAdministrators.md new file mode 100644 index 00000000..4d619eaf --- /dev/null +++ b/docs/TD_docs/methods/toggleGroupAdministrators.md @@ -0,0 +1,23 @@ +--- +title: toggleGroupAdministrators +description: Gives or revokes all members of the group administrator rights. Needs creator privileges in the group +--- +## Method: toggleGroupAdministrators +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Gives or revokes all members of the group administrator rights. Needs creator privileges in the group + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|group\_id|[int](../types/int.md) | Yes|Identifier of the group| +|everyone\_is\_administrator|[Bool](../types/Bool.md) | Yes|New value of everyone_is_administrator| + + +### Return type: [Ok](../types/Ok.md) + diff --git a/docs/TD_docs/methods/toggleGroupEditors.md b/docs/TD_docs/methods/toggleGroupEditors.md deleted file mode 100644 index b3bf67ab..00000000 --- a/docs/TD_docs/methods/toggleGroupEditors.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: toggleGroupEditors -description: Gives or revokes all members of the group editor rights. Needs creator privileges in the group ---- -## Method: toggleGroupEditors -[Back to methods index](index.md) - - -YOU CANNOT USE THIS METHOD IN MADELINEPROTO - - -Gives or revokes all members of the group editor rights. Needs creator privileges in the group - -### Params: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|group\_id|[int](../types/int.md) | Yes|Identifier of the group| -|anyone\_can\_edit|[Bool](../types/Bool.md) | Yes|New value of anyone_can_edit| - - -### Return type: [Ok](../types/Ok.md) - diff --git a/docs/TD_docs/methods/unpinChannelMessage.md b/docs/TD_docs/methods/unpinChannelMessage.md index 77a5ed27..8811baf0 100644 --- a/docs/TD_docs/methods/unpinChannelMessage.md +++ b/docs/TD_docs/methods/unpinChannelMessage.md @@ -1,6 +1,6 @@ --- title: unpinChannelMessage -description: Removes pinned message in the supergroup channel. Needs editor privileges in the channel +description: Removes pinned message in the supergroup channel. Needs appropriate rights in the channel --- ## Method: unpinChannelMessage [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Removes pinned message in the supergroup channel. Needs editor priv YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Removes pinned message in the supergroup channel. Needs editor privileges in the channel +Removes pinned message in the supergroup channel. Needs appropriate rights in the channel ### Params: diff --git a/docs/TD_docs/methods/uploadFile.md b/docs/TD_docs/methods/uploadFile.md new file mode 100644 index 00000000..8c0f6618 --- /dev/null +++ b/docs/TD_docs/methods/uploadFile.md @@ -0,0 +1,24 @@ +--- +title: uploadFile +description: Asynchronously uploads file to the cloud without sending it in a message. Updates updateFile will notify about upload progress and successful upload. The file will not have persistent identifier until it will be sent in a message +--- +## Method: uploadFile +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Asynchronously uploads file to the cloud without sending it in a message. Updates updateFile will notify about upload progress and successful upload. The file will not have persistent identifier until it will be sent in a message + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[InputFile](../types/InputFile.md) | Yes|File to upload| +|file\_type|[FileType](../types/FileType.md) | Yes|File type| +|priority|[int](../types/int.md) | Yes|Priority of upload, 1-32. The higher priority, the earlier file will be uploaded. If priorities of two files are equal then the first one for which uploadFile is called will be uploaded first| + + +### Return type: [File](../types/File.md) + diff --git a/docs/TD_docs/methods/uploadStickerFile.md b/docs/TD_docs/methods/uploadStickerFile.md new file mode 100644 index 00000000..a3b97c9f --- /dev/null +++ b/docs/TD_docs/methods/uploadStickerFile.md @@ -0,0 +1,23 @@ +--- +title: uploadStickerFile +description: Bots only. Uploads a png image with a sticker. Returns uploaded file +--- +## Method: uploadStickerFile +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Bots only. Uploads a png image with a sticker. Returns uploaded file + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|Sticker file owner| +|png\_sticker|[InputFile](../types/InputFile.md) | Yes|Png image with the sticker, must be up to 512 kilobytes in size and fit in 512x512 square| + + +### Return type: [File](../types/File.md) + diff --git a/docs/TD_docs/methods/validateOrderInfo.md b/docs/TD_docs/methods/validateOrderInfo.md new file mode 100644 index 00000000..a7fd131d --- /dev/null +++ b/docs/TD_docs/methods/validateOrderInfo.md @@ -0,0 +1,25 @@ +--- +title: validateOrderInfo +description: Validates order information provided by the user and returns available shipping options for flexible invoice +--- +## Method: validateOrderInfo +[Back to methods index](index.md) + + +YOU CANNOT USE THIS METHOD IN MADELINEPROTO + + +Validates order information provided by the user and returns available shipping options for flexible invoice + +### Params: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier of the Invoice message| +|message\_id|[int53](../types/int53.md) | Yes|Message identifier| +|order\_info|[orderInfo](../types/orderInfo.md) | Yes|Order information, provided by the user| +|allow\_save|[Bool](../types/Bool.md) | Yes|True, if order information can be saved| + + +### Return type: [ValidatedOrderInfo](../types/ValidatedOrderInfo.md) + diff --git a/docs/TD_docs/methods/viewMessages.md b/docs/TD_docs/methods/viewMessages.md index 99cc61bb..c1b78336 100644 --- a/docs/TD_docs/methods/viewMessages.md +++ b/docs/TD_docs/methods/viewMessages.md @@ -16,7 +16,7 @@ Messages are viewed by the user. Many useful activities depends on message being | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier| -|message\_ids|Array of [long](../types/long.md) | Yes|Identifiers of viewed messages| +|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of viewed messages| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/viewTrendingStickerSets.md b/docs/TD_docs/methods/viewTrendingStickerSets.md index 7d6f034d..21d2243b 100644 --- a/docs/TD_docs/methods/viewTrendingStickerSets.md +++ b/docs/TD_docs/methods/viewTrendingStickerSets.md @@ -1,6 +1,6 @@ --- title: viewTrendingStickerSets -description: Trending sticker sets are viewed by the user +description: Informs that some trending sticker sets are viewed by the user --- ## Method: viewTrendingStickerSets [Back to methods index](index.md) @@ -9,7 +9,7 @@ description: Trending sticker sets are viewed by the user YOU CANNOT USE THIS METHOD IN MADELINEPROTO -Trending sticker sets are viewed by the user +Informs that some trending sticker sets are viewed by the user ### Params: diff --git a/docs/TD_docs/types/Call.md b/docs/TD_docs/types/Call.md new file mode 100644 index 00000000..16d0f4ce --- /dev/null +++ b/docs/TD_docs/types/Call.md @@ -0,0 +1,19 @@ +--- +title: Call +description: constructors and methods of type Call +--- +## Type: Call +[Back to types index](index.md) + + + +### Possible values (constructors): + +[call](../constructors/call.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/CallConnection.md b/docs/TD_docs/types/CallConnection.md new file mode 100644 index 00000000..40b61dc2 --- /dev/null +++ b/docs/TD_docs/types/CallConnection.md @@ -0,0 +1,19 @@ +--- +title: CallConnection +description: constructors and methods of type CallConnection +--- +## Type: CallConnection +[Back to types index](index.md) + + + +### Possible values (constructors): + +[callConnection](../constructors/callConnection.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/CallDiscardReason.md b/docs/TD_docs/types/CallDiscardReason.md new file mode 100644 index 00000000..7c9df54d --- /dev/null +++ b/docs/TD_docs/types/CallDiscardReason.md @@ -0,0 +1,29 @@ +--- +title: CallDiscardReason +description: constructors and methods of type CallDiscardReason +--- +## Type: CallDiscardReason +[Back to types index](index.md) + + + +Describes reason a call was discarded + +### Possible values (constructors): + +[callDiscardReasonEmpty](../constructors/callDiscardReasonEmpty.md) + +[callDiscardReasonMissed](../constructors/callDiscardReasonMissed.md) + +[callDiscardReasonDeclined](../constructors/callDiscardReasonDeclined.md) + +[callDiscardReasonDisconnected](../constructors/callDiscardReasonDisconnected.md) + +[callDiscardReasonHungUp](../constructors/callDiscardReasonHungUp.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/CallId.md b/docs/TD_docs/types/CallId.md new file mode 100644 index 00000000..98aacc27 --- /dev/null +++ b/docs/TD_docs/types/CallId.md @@ -0,0 +1,21 @@ +--- +title: CallId +description: constructors and methods of type CallId +--- +## Type: CallId +[Back to types index](index.md) + + + +### Possible values (constructors): + +[callId](../constructors/callId.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->createCall](../methods/createCall.md) + + + diff --git a/docs/TD_docs/types/CallProtocol.md b/docs/TD_docs/types/CallProtocol.md new file mode 100644 index 00000000..de0087ac --- /dev/null +++ b/docs/TD_docs/types/CallProtocol.md @@ -0,0 +1,19 @@ +--- +title: CallProtocol +description: constructors and methods of type CallProtocol +--- +## Type: CallProtocol +[Back to types index](index.md) + + + +### Possible values (constructors): + +[callProtocol](../constructors/callProtocol.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/CallState.md b/docs/TD_docs/types/CallState.md new file mode 100644 index 00000000..24e793d2 --- /dev/null +++ b/docs/TD_docs/types/CallState.md @@ -0,0 +1,31 @@ +--- +title: CallState +description: constructors and methods of type CallState +--- +## Type: CallState +[Back to types index](index.md) + + + +Describes current call state + +### Possible values (constructors): + +[callStatePending](../constructors/callStatePending.md) + +[callStateExchangingKeys](../constructors/callStateExchangingKeys.md) + +[callStateReady](../constructors/callStateReady.md) + +[callStateHangingUp](../constructors/callStateHangingUp.md) + +[callStateDiscarded](../constructors/callStateDiscarded.md) + +[callStateError](../constructors/callStateError.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/CallbackQueryPayload.md b/docs/TD_docs/types/CallbackQueryPayload.md index a6d843a3..a69e31c6 100644 --- a/docs/TD_docs/types/CallbackQueryPayload.md +++ b/docs/TD_docs/types/CallbackQueryPayload.md @@ -11,9 +11,9 @@ Represents payload of a callback query ### Possible values (constructors): -[callbackQueryData](../constructors/callbackQueryData.md) +[callbackQueryPayloadData](../constructors/callbackQueryPayloadData.md) -[callbackQueryGame](../constructors/callbackQueryGame.md) +[callbackQueryPayloadGame](../constructors/callbackQueryPayloadGame.md) diff --git a/docs/TD_docs/types/ChannelMembersFilter.md b/docs/TD_docs/types/ChannelMembersFilter.md index c581d06d..166bcf5e 100644 --- a/docs/TD_docs/types/ChannelMembersFilter.md +++ b/docs/TD_docs/types/ChannelMembersFilter.md @@ -11,13 +11,17 @@ Specifies kind of chat users to return in getChannelMembers ### Possible values (constructors): -[channelMembersRecent](../constructors/channelMembersRecent.md) +[channelMembersFilterRecent](../constructors/channelMembersFilterRecent.md) -[channelMembersAdministrators](../constructors/channelMembersAdministrators.md) +[channelMembersFilterAdministrators](../constructors/channelMembersFilterAdministrators.md) -[channelMembersKicked](../constructors/channelMembersKicked.md) +[channelMembersFilterSearch](../constructors/channelMembersFilterSearch.md) -[channelMembersBots](../constructors/channelMembersBots.md) +[channelMembersFilterRestricted](../constructors/channelMembersFilterRestricted.md) + +[channelMembersFilterBanned](../constructors/channelMembersFilterBanned.md) + +[channelMembersFilterBots](../constructors/channelMembersFilterBots.md) diff --git a/docs/TD_docs/types/Channels.md b/docs/TD_docs/types/Channels.md deleted file mode 100644 index 2caa0ee2..00000000 --- a/docs/TD_docs/types/Channels.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Channels -description: constructors and methods of type Channels ---- -## Type: Channels -[Back to types index](index.md) - - - -### Possible values (constructors): - -[channels](../constructors/channels.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->getCreatedPublicChannels](../methods/getCreatedPublicChannels.md) - - - diff --git a/docs/TD_docs/types/ChatAction.md b/docs/TD_docs/types/ChatAction.md new file mode 100644 index 00000000..7b8b5a09 --- /dev/null +++ b/docs/TD_docs/types/ChatAction.md @@ -0,0 +1,45 @@ +--- +title: ChatAction +description: constructors and methods of type ChatAction +--- +## Type: ChatAction +[Back to types index](index.md) + + + +Describes different types of activity in a chat + +### Possible values (constructors): + +[chatActionTyping](../constructors/chatActionTyping.md) + +[chatActionRecordingVideo](../constructors/chatActionRecordingVideo.md) + +[chatActionUploadingVideo](../constructors/chatActionUploadingVideo.md) + +[chatActionRecordingVoice](../constructors/chatActionRecordingVoice.md) + +[chatActionUploadingVoice](../constructors/chatActionUploadingVoice.md) + +[chatActionUploadingPhoto](../constructors/chatActionUploadingPhoto.md) + +[chatActionUploadingDocument](../constructors/chatActionUploadingDocument.md) + +[chatActionChoosingLocation](../constructors/chatActionChoosingLocation.md) + +[chatActionChoosingContact](../constructors/chatActionChoosingContact.md) + +[chatActionStartPlayingGame](../constructors/chatActionStartPlayingGame.md) + +[chatActionRecordingVideoNote](../constructors/chatActionRecordingVideoNote.md) + +[chatActionUploadingVideoNote](../constructors/chatActionUploadingVideoNote.md) + +[chatActionCancel](../constructors/chatActionCancel.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/ChatEvent.md b/docs/TD_docs/types/ChatEvent.md new file mode 100644 index 00000000..f9d46739 --- /dev/null +++ b/docs/TD_docs/types/ChatEvent.md @@ -0,0 +1,19 @@ +--- +title: ChatEvent +description: constructors and methods of type ChatEvent +--- +## Type: ChatEvent +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatEvent](../constructors/chatEvent.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/ChatEventAction.md b/docs/TD_docs/types/ChatEventAction.md new file mode 100644 index 00000000..2cd9bcf2 --- /dev/null +++ b/docs/TD_docs/types/ChatEventAction.md @@ -0,0 +1,49 @@ +--- +title: ChatEventAction +description: constructors and methods of type ChatEventAction +--- +## Type: ChatEventAction +[Back to types index](index.md) + + + +Represents a chat event + +### Possible values (constructors): + +[chatEventMessageEdited](../constructors/chatEventMessageEdited.md) + +[chatEventMessageDeleted](../constructors/chatEventMessageDeleted.md) + +[chatEventMessagePinned](../constructors/chatEventMessagePinned.md) + +[chatEventMessageUnpinned](../constructors/chatEventMessageUnpinned.md) + +[chatEventMemberJoined](../constructors/chatEventMemberJoined.md) + +[chatEventMemberLeft](../constructors/chatEventMemberLeft.md) + +[chatEventMemberInvited](../constructors/chatEventMemberInvited.md) + +[chatEventMemberPromoted](../constructors/chatEventMemberPromoted.md) + +[chatEventMemberRestricted](../constructors/chatEventMemberRestricted.md) + +[chatEventTitleChanged](../constructors/chatEventTitleChanged.md) + +[chatEventDescriptionChanged](../constructors/chatEventDescriptionChanged.md) + +[chatEventUsernameChanged](../constructors/chatEventUsernameChanged.md) + +[chatEventPhotoChanged](../constructors/chatEventPhotoChanged.md) + +[chatEventInvitesToggled](../constructors/chatEventInvitesToggled.md) + +[chatEventSignMessagesToggled](../constructors/chatEventSignMessagesToggled.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/ChatEventLogFilters.md b/docs/TD_docs/types/ChatEventLogFilters.md new file mode 100644 index 00000000..3f656b9f --- /dev/null +++ b/docs/TD_docs/types/ChatEventLogFilters.md @@ -0,0 +1,19 @@ +--- +title: ChatEventLogFilters +description: constructors and methods of type ChatEventLogFilters +--- +## Type: ChatEventLogFilters +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatEventLogFilters](../constructors/chatEventLogFilters.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/ChatEvents.md b/docs/TD_docs/types/ChatEvents.md new file mode 100644 index 00000000..4a087c35 --- /dev/null +++ b/docs/TD_docs/types/ChatEvents.md @@ -0,0 +1,21 @@ +--- +title: ChatEvents +description: constructors and methods of type ChatEvents +--- +## Type: ChatEvents +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatEvents](../constructors/chatEvents.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->getChatEventLog](../methods/getChatEventLog.md) + + + diff --git a/docs/TD_docs/types/ChatInfo.md b/docs/TD_docs/types/ChatInfo.md deleted file mode 100644 index 48c5bc89..00000000 --- a/docs/TD_docs/types/ChatInfo.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: ChatInfo -description: constructors and methods of type ChatInfo ---- -## Type: ChatInfo -[Back to types index](index.md) - - - -Describes type of a chat - -### Possible values (constructors): - -[privateChatInfo](../constructors/privateChatInfo.md) - -[groupChatInfo](../constructors/groupChatInfo.md) - -[channelChatInfo](../constructors/channelChatInfo.md) - -[secretChatInfo](../constructors/secretChatInfo.md) - - - -### Methods that return an object of this type (methods): - - - diff --git a/docs/TD_docs/types/ChatMemberStatus.md b/docs/TD_docs/types/ChatMemberStatus.md index fc62f047..ddd68809 100644 --- a/docs/TD_docs/types/ChatMemberStatus.md +++ b/docs/TD_docs/types/ChatMemberStatus.md @@ -13,15 +13,15 @@ Provides information about status of a member in the chat [chatMemberStatusCreator](../constructors/chatMemberStatusCreator.md) -[chatMemberStatusEditor](../constructors/chatMemberStatusEditor.md) - -[chatMemberStatusModerator](../constructors/chatMemberStatusModerator.md) +[chatMemberStatusAdministrator](../constructors/chatMemberStatusAdministrator.md) [chatMemberStatusMember](../constructors/chatMemberStatusMember.md) +[chatMemberStatusRestricted](../constructors/chatMemberStatusRestricted.md) + [chatMemberStatusLeft](../constructors/chatMemberStatusLeft.md) -[chatMemberStatusKicked](../constructors/chatMemberStatusKicked.md) +[chatMemberStatusBanned](../constructors/chatMemberStatusBanned.md) diff --git a/docs/TD_docs/types/ChatMembers.md b/docs/TD_docs/types/ChatMembers.md index 28419d86..0af1d340 100644 --- a/docs/TD_docs/types/ChatMembers.md +++ b/docs/TD_docs/types/ChatMembers.md @@ -15,6 +15,8 @@ description: constructors and methods of type ChatMembers ### Methods that return an object of this type (methods): +[$MadelineProto->searchChatMembers](../methods/searchChatMembers.md) + [$MadelineProto->getChannelMembers](../methods/getChannelMembers.md) diff --git a/docs/TD_docs/types/ChatReportReason.md b/docs/TD_docs/types/ChatReportReason.md new file mode 100644 index 00000000..95fe20a2 --- /dev/null +++ b/docs/TD_docs/types/ChatReportReason.md @@ -0,0 +1,27 @@ +--- +title: ChatReportReason +description: constructors and methods of type ChatReportReason +--- +## Type: ChatReportReason +[Back to types index](index.md) + + + +Describes a reason, why a chat is reported + +### Possible values (constructors): + +[chatReportReasonSpam](../constructors/chatReportReasonSpam.md) + +[chatReportReasonViolence](../constructors/chatReportReasonViolence.md) + +[chatReportReasonPornography](../constructors/chatReportReasonPornography.md) + +[chatReportReasonOther](../constructors/chatReportReasonOther.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/ChatType.md b/docs/TD_docs/types/ChatType.md new file mode 100644 index 00000000..8a86e475 --- /dev/null +++ b/docs/TD_docs/types/ChatType.md @@ -0,0 +1,27 @@ +--- +title: ChatType +description: constructors and methods of type ChatType +--- +## Type: ChatType +[Back to types index](index.md) + + + +Describes type of a chat + +### Possible values (constructors): + +[chatTypePrivate](../constructors/chatTypePrivate.md) + +[chatTypeGroup](../constructors/chatTypeGroup.md) + +[chatTypeChannel](../constructors/chatTypeChannel.md) + +[chatTypeSecret](../constructors/chatTypeSecret.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/Chats.md b/docs/TD_docs/types/Chats.md index c048a56f..e7d212fd 100644 --- a/docs/TD_docs/types/Chats.md +++ b/docs/TD_docs/types/Chats.md @@ -21,7 +21,11 @@ description: constructors and methods of type Chats [$MadelineProto->searchChats](../methods/searchChats.md) +[$MadelineProto->getTopChats](../methods/getTopChats.md) + [$MadelineProto->getCommonChats](../methods/getCommonChats.md) +[$MadelineProto->getCreatedPublicChats](../methods/getCreatedPublicChats.md) + diff --git a/docs/TD_docs/types/ConnectionState.md b/docs/TD_docs/types/ConnectionState.md new file mode 100644 index 00000000..d6723da8 --- /dev/null +++ b/docs/TD_docs/types/ConnectionState.md @@ -0,0 +1,29 @@ +--- +title: ConnectionState +description: constructors and methods of type ConnectionState +--- +## Type: ConnectionState +[Back to types index](index.md) + + + +Describes current state of the connection to Telegram servers + +### Possible values (constructors): + +[connectionStateWaitingForNetwork](../constructors/connectionStateWaitingForNetwork.md) + +[connectionStateConnectingToProxy](../constructors/connectionStateConnectingToProxy.md) + +[connectionStateConnecting](../constructors/connectionStateConnecting.md) + +[connectionStateUpdating](../constructors/connectionStateUpdating.md) + +[connectionStateReady](../constructors/connectionStateReady.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/CustomRequestResult.md b/docs/TD_docs/types/CustomRequestResult.md new file mode 100644 index 00000000..63adbd62 --- /dev/null +++ b/docs/TD_docs/types/CustomRequestResult.md @@ -0,0 +1,21 @@ +--- +title: CustomRequestResult +description: constructors and methods of type CustomRequestResult +--- +## Type: CustomRequestResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[customRequestResult](../constructors/customRequestResult.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->sendCustomRequest](../methods/sendCustomRequest.md) + + + diff --git a/docs/TD_docs/types/DeviceToken.md b/docs/TD_docs/types/DeviceToken.md index 51e0ec5a..364104eb 100644 --- a/docs/TD_docs/types/DeviceToken.md +++ b/docs/TD_docs/types/DeviceToken.md @@ -11,17 +11,17 @@ Represents a token for push notifications ### Possible values (constructors): -[apnsDeviceToken](../constructors/apnsDeviceToken.md) +[deviceTokenApns](../constructors/deviceTokenApns.md) -[gcmDeviceToken](../constructors/gcmDeviceToken.md) +[deviceTokenGcm](../constructors/deviceTokenGcm.md) -[mpnsDeviceToken](../constructors/mpnsDeviceToken.md) +[deviceTokenMpns](../constructors/deviceTokenMpns.md) -[simplePushDeviceToken](../constructors/simplePushDeviceToken.md) +[deviceTokenSimplePush](../constructors/deviceTokenSimplePush.md) -[ubuntuPhoneDeviceToken](../constructors/ubuntuPhoneDeviceToken.md) +[deviceTokenUbuntuPhone](../constructors/deviceTokenUbuntuPhone.md) -[blackberryDeviceToken](../constructors/blackberryDeviceToken.md) +[deviceTokenBlackberry](../constructors/deviceTokenBlackberry.md) diff --git a/docs/TD_docs/types/DeviceTokenSet.md b/docs/TD_docs/types/DeviceTokenSet.md deleted file mode 100644 index 52cb9170..00000000 --- a/docs/TD_docs/types/DeviceTokenSet.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: DeviceTokenSet -description: constructors and methods of type DeviceTokenSet ---- -## Type: DeviceTokenSet -[Back to types index](index.md) - - - -### Possible values (constructors): - -[deviceTokenSet](../constructors/deviceTokenSet.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->getDeviceTokens](../methods/getDeviceTokens.md) - - - diff --git a/docs/TD_docs/types/Error.md b/docs/TD_docs/types/Error.md index a3ab3577..4330d635 100644 --- a/docs/TD_docs/types/Error.md +++ b/docs/TD_docs/types/Error.md @@ -15,5 +15,7 @@ description: constructors and methods of type Error ### Methods that return an object of this type (methods): +[$MadelineProto->testUseError](../methods/testUseError.md) + diff --git a/docs/TD_docs/types/File.md b/docs/TD_docs/types/File.md index 4160c96c..c6314efa 100644 --- a/docs/TD_docs/types/File.md +++ b/docs/TD_docs/types/File.md @@ -19,5 +19,9 @@ description: constructors and methods of type File [$MadelineProto->getFilePersistent](../methods/getFilePersistent.md) +[$MadelineProto->uploadFile](../methods/uploadFile.md) + +[$MadelineProto->uploadStickerFile](../methods/uploadStickerFile.md) + diff --git a/docs/TD_docs/types/FileType.md b/docs/TD_docs/types/FileType.md new file mode 100644 index 00000000..1567db46 --- /dev/null +++ b/docs/TD_docs/types/FileType.md @@ -0,0 +1,49 @@ +--- +title: FileType +description: constructors and methods of type FileType +--- +## Type: FileType +[Back to types index](index.md) + + + +Represents type of a file + +### Possible values (constructors): + +[fileTypeNone](../constructors/fileTypeNone.md) + +[fileTypeAnimation](../constructors/fileTypeAnimation.md) + +[fileTypeAudio](../constructors/fileTypeAudio.md) + +[fileTypeDocument](../constructors/fileTypeDocument.md) + +[fileTypePhoto](../constructors/fileTypePhoto.md) + +[fileTypeProfilePhoto](../constructors/fileTypeProfilePhoto.md) + +[fileTypeSecret](../constructors/fileTypeSecret.md) + +[fileTypeSticker](../constructors/fileTypeSticker.md) + +[fileTypeThumb](../constructors/fileTypeThumb.md) + +[fileTypeUnknown](../constructors/fileTypeUnknown.md) + +[fileTypeVideo](../constructors/fileTypeVideo.md) + +[fileTypeVideoNote](../constructors/fileTypeVideoNote.md) + +[fileTypeVoice](../constructors/fileTypeVoice.md) + +[fileTypeWallpaper](../constructors/fileTypeWallpaper.md) + +[fileTypeSecretThumb](../constructors/fileTypeSecretThumb.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/FoundMessages.md b/docs/TD_docs/types/FoundMessages.md new file mode 100644 index 00000000..b86f2570 --- /dev/null +++ b/docs/TD_docs/types/FoundMessages.md @@ -0,0 +1,21 @@ +--- +title: FoundMessages +description: constructors and methods of type FoundMessages +--- +## Type: FoundMessages +[Back to types index](index.md) + + + +### Possible values (constructors): + +[foundMessages](../constructors/foundMessages.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->searchSecretMessages](../methods/searchSecretMessages.md) + + + diff --git a/docs/TD_docs/types/Hashtags.md b/docs/TD_docs/types/Hashtags.md new file mode 100644 index 00000000..431752df --- /dev/null +++ b/docs/TD_docs/types/Hashtags.md @@ -0,0 +1,21 @@ +--- +title: Hashtags +description: constructors and methods of type Hashtags +--- +## Type: Hashtags +[Back to types index](index.md) + + + +### Possible values (constructors): + +[hashtags](../constructors/hashtags.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->searchHashtags](../methods/searchHashtags.md) + + + diff --git a/docs/TD_docs/types/ImportedContacts.md b/docs/TD_docs/types/ImportedContacts.md new file mode 100644 index 00000000..14280187 --- /dev/null +++ b/docs/TD_docs/types/ImportedContacts.md @@ -0,0 +1,21 @@ +--- +title: ImportedContacts +description: constructors and methods of type ImportedContacts +--- +## Type: ImportedContacts +[Back to types index](index.md) + + + +### Possible values (constructors): + +[importedContacts](../constructors/importedContacts.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->importContacts](../methods/importContacts.md) + + + diff --git a/docs/TD_docs/types/InlineKeyboardButtonType.md b/docs/TD_docs/types/InlineKeyboardButtonType.md index 826fa265..4bb16289 100644 --- a/docs/TD_docs/types/InlineKeyboardButtonType.md +++ b/docs/TD_docs/types/InlineKeyboardButtonType.md @@ -19,6 +19,8 @@ Describes type of the inline keyboard button [inlineKeyboardButtonTypeSwitchInline](../constructors/inlineKeyboardButtonTypeSwitchInline.md) +[inlineKeyboardButtonTypeBuy](../constructors/inlineKeyboardButtonTypeBuy.md) + ### Methods that return an object of this type (methods): diff --git a/docs/TD_docs/types/InputCredentials.md b/docs/TD_docs/types/InputCredentials.md new file mode 100644 index 00000000..4314d44c --- /dev/null +++ b/docs/TD_docs/types/InputCredentials.md @@ -0,0 +1,23 @@ +--- +title: InputCredentials +description: constructors and methods of type InputCredentials +--- +## Type: InputCredentials +[Back to types index](index.md) + + + +Contains information about payment method chosen by user + +### Possible values (constructors): + +[inputCredentialsSaved](../constructors/inputCredentialsSaved.md) + +[inputCredentialsNew](../constructors/inputCredentialsNew.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/InputMessageContent.md b/docs/TD_docs/types/InputMessageContent.md index e4711f0f..f81b8dae 100644 --- a/docs/TD_docs/types/InputMessageContent.md +++ b/docs/TD_docs/types/InputMessageContent.md @@ -25,6 +25,8 @@ Content of a message to send [inputMessageVideo](../constructors/inputMessageVideo.md) +[inputMessageVideoNote](../constructors/inputMessageVideoNote.md) + [inputMessageVoice](../constructors/inputMessageVoice.md) [inputMessageLocation](../constructors/inputMessageLocation.md) @@ -35,6 +37,8 @@ Content of a message to send [inputMessageGame](../constructors/inputMessageGame.md) +[inputMessageInvoice](../constructors/inputMessageInvoice.md) + [inputMessageForwarded](../constructors/inputMessageForwarded.md) diff --git a/docs/TD_docs/types/InputSticker.md b/docs/TD_docs/types/InputSticker.md new file mode 100644 index 00000000..013f4eac --- /dev/null +++ b/docs/TD_docs/types/InputSticker.md @@ -0,0 +1,19 @@ +--- +title: InputSticker +description: constructors and methods of type InputSticker +--- +## Type: InputSticker +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputSticker](../constructors/inputSticker.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/Invoice.md b/docs/TD_docs/types/Invoice.md new file mode 100644 index 00000000..d9fb4ce8 --- /dev/null +++ b/docs/TD_docs/types/Invoice.md @@ -0,0 +1,19 @@ +--- +title: Invoice +description: constructors and methods of type Invoice +--- +## Type: Invoice +[Back to types index](index.md) + + + +### Possible values (constructors): + +[invoice](../constructors/invoice.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/LabeledPrice.md b/docs/TD_docs/types/LabeledPrice.md new file mode 100644 index 00000000..46e828a3 --- /dev/null +++ b/docs/TD_docs/types/LabeledPrice.md @@ -0,0 +1,19 @@ +--- +title: LabeledPrice +description: constructors and methods of type LabeledPrice +--- +## Type: LabeledPrice +[Back to types index](index.md) + + + +### Possible values (constructors): + +[labeledPrice](../constructors/labeledPrice.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/MessageContent.md b/docs/TD_docs/types/MessageContent.md index 5a3af2c3..f52b4e46 100644 --- a/docs/TD_docs/types/MessageContent.md +++ b/docs/TD_docs/types/MessageContent.md @@ -21,10 +21,16 @@ Content of a message [messagePhoto](../constructors/messagePhoto.md) +[messageExpiredPhoto](../constructors/messageExpiredPhoto.md) + [messageSticker](../constructors/messageSticker.md) [messageVideo](../constructors/messageVideo.md) +[messageExpiredVideo](../constructors/messageExpiredVideo.md) + +[messageVideoNote](../constructors/messageVideoNote.md) + [messageVoice](../constructors/messageVoice.md) [messageLocation](../constructors/messageLocation.md) @@ -35,6 +41,10 @@ Content of a message [messageGame](../constructors/messageGame.md) +[messageInvoice](../constructors/messageInvoice.md) + +[messageCall](../constructors/messageCall.md) + [messageGroupChatCreate](../constructors/messageGroupChatCreate.md) [messageChannelChatCreate](../constructors/messageChannelChatCreate.md) @@ -63,6 +73,12 @@ Content of a message [messageGameScore](../constructors/messageGameScore.md) +[messagePaymentSuccessful](../constructors/messagePaymentSuccessful.md) + +[messagePaymentSuccessfulBot](../constructors/messagePaymentSuccessfulBot.md) + +[messageContactRegistered](../constructors/messageContactRegistered.md) + [messageUnsupported](../constructors/messageUnsupported.md) diff --git a/docs/TD_docs/types/MessageEntity.md b/docs/TD_docs/types/MessageEntity.md deleted file mode 100644 index 57467ec1..00000000 --- a/docs/TD_docs/types/MessageEntity.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: MessageEntity -description: constructors and methods of type MessageEntity ---- -## Type: MessageEntity -[Back to types index](index.md) - - - -Represent part of the message text which needs to be formatted in some unusual way - -### Possible values (constructors): - -[messageEntityMention](../constructors/messageEntityMention.md) - -[messageEntityHashtag](../constructors/messageEntityHashtag.md) - -[messageEntityBotCommand](../constructors/messageEntityBotCommand.md) - -[messageEntityUrl](../constructors/messageEntityUrl.md) - -[messageEntityEmail](../constructors/messageEntityEmail.md) - -[messageEntityBold](../constructors/messageEntityBold.md) - -[messageEntityItalic](../constructors/messageEntityItalic.md) - -[messageEntityCode](../constructors/messageEntityCode.md) - -[messageEntityPre](../constructors/messageEntityPre.md) - -[messageEntityPreCode](../constructors/messageEntityPreCode.md) - -[messageEntityTextUrl](../constructors/messageEntityTextUrl.md) - -[messageEntityMentionName](../constructors/messageEntityMentionName.md) - - - -### Methods that return an object of this type (methods): - - - diff --git a/docs/TD_docs/types/Messages.md b/docs/TD_docs/types/Messages.md index a64487ea..adb63e8e 100644 --- a/docs/TD_docs/types/Messages.md +++ b/docs/TD_docs/types/Messages.md @@ -23,6 +23,8 @@ description: constructors and methods of type Messages [$MadelineProto->searchMessages](../methods/searchMessages.md) +[$MadelineProto->searchCallMessages](../methods/searchCallMessages.md) + [$MadelineProto->forwardMessages](../methods/forwardMessages.md) diff --git a/docs/TD_docs/types/NetworkStatistics.md b/docs/TD_docs/types/NetworkStatistics.md new file mode 100644 index 00000000..8b9a3d8f --- /dev/null +++ b/docs/TD_docs/types/NetworkStatistics.md @@ -0,0 +1,21 @@ +--- +title: NetworkStatistics +description: constructors and methods of type NetworkStatistics +--- +## Type: NetworkStatistics +[Back to types index](index.md) + + + +### Possible values (constructors): + +[networkStatistics](../constructors/networkStatistics.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->getNetworkStatistics](../methods/getNetworkStatistics.md) + + + diff --git a/docs/TD_docs/types/NetworkStatisticsEntry.md b/docs/TD_docs/types/NetworkStatisticsEntry.md new file mode 100644 index 00000000..a0db6bc3 --- /dev/null +++ b/docs/TD_docs/types/NetworkStatisticsEntry.md @@ -0,0 +1,23 @@ +--- +title: NetworkStatisticsEntry +description: constructors and methods of type NetworkStatisticsEntry +--- +## Type: NetworkStatisticsEntry +[Back to types index](index.md) + + + +Contains statistics about network usage + +### Possible values (constructors): + +[networkStatisticsEntryFile](../constructors/networkStatisticsEntryFile.md) + +[networkStatisticsEntryCall](../constructors/networkStatisticsEntryCall.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/NetworkType.md b/docs/TD_docs/types/NetworkType.md new file mode 100644 index 00000000..63f67364 --- /dev/null +++ b/docs/TD_docs/types/NetworkType.md @@ -0,0 +1,29 @@ +--- +title: NetworkType +description: constructors and methods of type NetworkType +--- +## Type: NetworkType +[Back to types index](index.md) + + + +Represents type of a network + +### Possible values (constructors): + +[networkTypeNone](../constructors/networkTypeNone.md) + +[networkTypeMobile](../constructors/networkTypeMobile.md) + +[networkTypeMobileRoaming](../constructors/networkTypeMobileRoaming.md) + +[networkTypeWiFi](../constructors/networkTypeWiFi.md) + +[networkTypeOther](../constructors/networkTypeOther.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/NotificationSettingsScope.md b/docs/TD_docs/types/NotificationSettingsScope.md index 5c216c0e..07e805bd 100644 --- a/docs/TD_docs/types/NotificationSettingsScope.md +++ b/docs/TD_docs/types/NotificationSettingsScope.md @@ -11,13 +11,13 @@ Describes kinds of chat for which notification settings are applied ### Possible values (constructors): -[notificationSettingsForChat](../constructors/notificationSettingsForChat.md) +[notificationSettingsScopeChat](../constructors/notificationSettingsScopeChat.md) -[notificationSettingsForPrivateChats](../constructors/notificationSettingsForPrivateChats.md) +[notificationSettingsScopePrivateChats](../constructors/notificationSettingsScopePrivateChats.md) -[notificationSettingsForGroupChats](../constructors/notificationSettingsForGroupChats.md) +[notificationSettingsScopeGroupChats](../constructors/notificationSettingsScopeGroupChats.md) -[notificationSettingsForAllChats](../constructors/notificationSettingsForAllChats.md) +[notificationSettingsScopeAllChats](../constructors/notificationSettingsScopeAllChats.md) diff --git a/docs/TD_docs/types/Ok.md b/docs/TD_docs/types/Ok.md index f8301c81..e005ef6d 100644 --- a/docs/TD_docs/types/Ok.md +++ b/docs/TD_docs/types/Ok.md @@ -15,6 +15,10 @@ description: constructors and methods of type Ok ### Methods that return an object of this type (methods): +[$MadelineProto->processDcUpdate](../methods/processDcUpdate.md) + +[$MadelineProto->deleteTopChat](../methods/deleteTopChat.md) + [$MadelineProto->addRecentlyFoundChat](../methods/addRecentlyFoundChat.md) [$MadelineProto->deleteRecentlyFoundChat](../methods/deleteRecentlyFoundChat.md) @@ -23,6 +27,8 @@ description: constructors and methods of type Ok [$MadelineProto->deleteChatHistory](../methods/deleteChatHistory.md) +[$MadelineProto->sendChatScreenshotTakenNotification](../methods/sendChatScreenshotTakenNotification.md) + [$MadelineProto->deleteMessages](../methods/deleteMessages.md) [$MadelineProto->deleteMessagesFromUser](../methods/deleteMessagesFromUser.md) @@ -37,14 +43,16 @@ description: constructors and methods of type Ok [$MadelineProto->answerCallbackQuery](../methods/answerCallbackQuery.md) +[$MadelineProto->answerShippingQuery](../methods/answerShippingQuery.md) + +[$MadelineProto->answerPreCheckoutQuery](../methods/answerPreCheckoutQuery.md) + [$MadelineProto->setInlineGameScore](../methods/setInlineGameScore.md) [$MadelineProto->deleteChatReplyMarkup](../methods/deleteChatReplyMarkup.md) [$MadelineProto->sendChatAction](../methods/sendChatAction.md) -[$MadelineProto->sendChatScreenshotTakenNotification](../methods/sendChatScreenshotTakenNotification.md) - [$MadelineProto->openChat](../methods/openChat.md) [$MadelineProto->closeChat](../methods/closeChat.md) @@ -59,33 +67,51 @@ description: constructors and methods of type Ok [$MadelineProto->changeChatDraftMessage](../methods/changeChatDraftMessage.md) +[$MadelineProto->toggleChatIsPinned](../methods/toggleChatIsPinned.md) + +[$MadelineProto->setChatClientData](../methods/setChatClientData.md) + [$MadelineProto->addChatMember](../methods/addChatMember.md) [$MadelineProto->addChatMembers](../methods/addChatMembers.md) [$MadelineProto->changeChatMemberStatus](../methods/changeChatMemberStatus.md) +[$MadelineProto->setPinnedChats](../methods/setPinnedChats.md) + [$MadelineProto->downloadFile](../methods/downloadFile.md) [$MadelineProto->cancelDownloadFile](../methods/cancelDownloadFile.md) +[$MadelineProto->cancelUploadFile](../methods/cancelUploadFile.md) + [$MadelineProto->setFileGenerationProgress](../methods/setFileGenerationProgress.md) [$MadelineProto->finishFileGeneration](../methods/finishFileGeneration.md) +[$MadelineProto->deleteFile](../methods/deleteFile.md) + [$MadelineProto->importChatInviteLink](../methods/importChatInviteLink.md) +[$MadelineProto->acceptCall](../methods/acceptCall.md) + +[$MadelineProto->discardCall](../methods/discardCall.md) + +[$MadelineProto->rateCall](../methods/rateCall.md) + +[$MadelineProto->debugCall](../methods/debugCall.md) + [$MadelineProto->blockUser](../methods/blockUser.md) [$MadelineProto->unblockUser](../methods/unblockUser.md) [$MadelineProto->deleteContacts](../methods/deleteContacts.md) -[$MadelineProto->updateStickerSet](../methods/updateStickerSet.md) +[$MadelineProto->changeStickerSet](../methods/changeStickerSet.md) [$MadelineProto->viewTrendingStickerSets](../methods/viewTrendingStickerSets.md) -[$MadelineProto->reorderStickerSets](../methods/reorderStickerSets.md) +[$MadelineProto->reorderInstalledStickerSets](../methods/reorderInstalledStickerSets.md) [$MadelineProto->deleteRecentSticker](../methods/deleteRecentSticker.md) @@ -95,6 +121,8 @@ description: constructors and methods of type Ok [$MadelineProto->deleteSavedAnimation](../methods/deleteSavedAnimation.md) +[$MadelineProto->deleteRecentHashtag](../methods/deleteRecentHashtag.md) + [$MadelineProto->setNotificationSettings](../methods/setNotificationSettings.md) [$MadelineProto->resetAllNotificationSettings](../methods/resetAllNotificationSettings.md) @@ -113,7 +141,7 @@ description: constructors and methods of type Ok [$MadelineProto->terminateAllOtherSessions](../methods/terminateAllOtherSessions.md) -[$MadelineProto->toggleGroupEditors](../methods/toggleGroupEditors.md) +[$MadelineProto->toggleGroupAdministrators](../methods/toggleGroupAdministrators.md) [$MadelineProto->changeChannelUsername](../methods/changeChannelUsername.md) @@ -121,7 +149,7 @@ description: constructors and methods of type Ok [$MadelineProto->toggleChannelSignMessages](../methods/toggleChannelSignMessages.md) -[$MadelineProto->changeChannelAbout](../methods/changeChannelAbout.md) +[$MadelineProto->changeChannelDescription](../methods/changeChannelDescription.md) [$MadelineProto->pinChannelMessage](../methods/pinChannelMessage.md) @@ -133,6 +161,10 @@ description: constructors and methods of type Ok [$MadelineProto->closeSecretChat](../methods/closeSecretChat.md) +[$MadelineProto->deleteSavedOrderInfo](../methods/deleteSavedOrderInfo.md) + +[$MadelineProto->deleteSavedCredentials](../methods/deleteSavedCredentials.md) + [$MadelineProto->registerDevice](../methods/registerDevice.md) [$MadelineProto->setPrivacy](../methods/setPrivacy.md) @@ -145,11 +177,31 @@ description: constructors and methods of type Ok [$MadelineProto->changeChatReportSpamState](../methods/changeChatReportSpamState.md) +[$MadelineProto->reportChat](../methods/reportChat.md) + +[$MadelineProto->setNetworkType](../methods/setNetworkType.md) + +[$MadelineProto->addNetworkStatistics](../methods/addNetworkStatistics.md) + +[$MadelineProto->resetNetworkStatistics](../methods/resetNetworkStatistics.md) + [$MadelineProto->setBotUpdatesStatus](../methods/setBotUpdatesStatus.md) +[$MadelineProto->setStickerPositionInSet](../methods/setStickerPositionInSet.md) + +[$MadelineProto->deleteStickerFromSet](../methods/deleteStickerFromSet.md) + +[$MadelineProto->answerCustomQuery](../methods/answerCustomQuery.md) + [$MadelineProto->setAlarm](../methods/setAlarm.md) -[$MadelineProto->test->forceGetDifference](../methods/test_forceGetDifference.md) +[$MadelineProto->setProxy](../methods/setProxy.md) + +[$MadelineProto->testCallEmpty](../methods/testCallEmpty.md) + +[$MadelineProto->testNetwork](../methods/testNetwork.md) + +[$MadelineProto->testGetDifference](../methods/testGetDifference.md) diff --git a/docs/TD_docs/types/OptionValue.md b/docs/TD_docs/types/OptionValue.md index 8d5a7ed5..cc4ca53c 100644 --- a/docs/TD_docs/types/OptionValue.md +++ b/docs/TD_docs/types/OptionValue.md @@ -11,13 +11,13 @@ Represents value of an option ### Possible values (constructors): -[optionBoolean](../constructors/optionBoolean.md) +[optionValueBoolean](../constructors/optionValueBoolean.md) -[optionEmpty](../constructors/optionEmpty.md) +[optionValueEmpty](../constructors/optionValueEmpty.md) -[optionInteger](../constructors/optionInteger.md) +[optionValueInteger](../constructors/optionValueInteger.md) -[optionString](../constructors/optionString.md) +[optionValueString](../constructors/optionValueString.md) diff --git a/docs/TD_docs/types/OrderInfo.md b/docs/TD_docs/types/OrderInfo.md new file mode 100644 index 00000000..86bba305 --- /dev/null +++ b/docs/TD_docs/types/OrderInfo.md @@ -0,0 +1,21 @@ +--- +title: OrderInfo +description: constructors and methods of type OrderInfo +--- +## Type: OrderInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[orderInfo](../constructors/orderInfo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->getSavedOrderInfo](../methods/getSavedOrderInfo.md) + + + diff --git a/docs/TD_docs/types/PageBlock.md b/docs/TD_docs/types/PageBlock.md new file mode 100644 index 00000000..5c45fc5d --- /dev/null +++ b/docs/TD_docs/types/PageBlock.md @@ -0,0 +1,65 @@ +--- +title: PageBlock +description: constructors and methods of type PageBlock +--- +## Type: PageBlock +[Back to types index](index.md) + + + +Describes a block of web page instant view + +### Possible values (constructors): + +[pageBlockTitle](../constructors/pageBlockTitle.md) + +[pageBlockSubtitle](../constructors/pageBlockSubtitle.md) + +[pageBlockAuthorDate](../constructors/pageBlockAuthorDate.md) + +[pageBlockHeader](../constructors/pageBlockHeader.md) + +[pageBlockSubheader](../constructors/pageBlockSubheader.md) + +[pageBlockParagraph](../constructors/pageBlockParagraph.md) + +[pageBlockPreformatted](../constructors/pageBlockPreformatted.md) + +[pageBlockFooter](../constructors/pageBlockFooter.md) + +[pageBlockDivider](../constructors/pageBlockDivider.md) + +[pageBlockAnchor](../constructors/pageBlockAnchor.md) + +[pageBlockList](../constructors/pageBlockList.md) + +[pageBlockBlockQuote](../constructors/pageBlockBlockQuote.md) + +[pageBlockPullQuote](../constructors/pageBlockPullQuote.md) + +[pageBlockAnimation](../constructors/pageBlockAnimation.md) + +[pageBlockAudio](../constructors/pageBlockAudio.md) + +[pageBlockPhoto](../constructors/pageBlockPhoto.md) + +[pageBlockVideo](../constructors/pageBlockVideo.md) + +[pageBlockCover](../constructors/pageBlockCover.md) + +[pageBlockEmbedded](../constructors/pageBlockEmbedded.md) + +[pageBlockEmbeddedPost](../constructors/pageBlockEmbeddedPost.md) + +[pageBlockCollage](../constructors/pageBlockCollage.md) + +[pageBlockSlideshow](../constructors/pageBlockSlideshow.md) + +[pageBlockChatLink](../constructors/pageBlockChatLink.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/PaymentForm.md b/docs/TD_docs/types/PaymentForm.md new file mode 100644 index 00000000..8e22aeeb --- /dev/null +++ b/docs/TD_docs/types/PaymentForm.md @@ -0,0 +1,21 @@ +--- +title: PaymentForm +description: constructors and methods of type PaymentForm +--- +## Type: PaymentForm +[Back to types index](index.md) + + + +### Possible values (constructors): + +[paymentForm](../constructors/paymentForm.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->getPaymentForm](../methods/getPaymentForm.md) + + + diff --git a/docs/TD_docs/types/PaymentReceipt.md b/docs/TD_docs/types/PaymentReceipt.md new file mode 100644 index 00000000..df227703 --- /dev/null +++ b/docs/TD_docs/types/PaymentReceipt.md @@ -0,0 +1,21 @@ +--- +title: PaymentReceipt +description: constructors and methods of type PaymentReceipt +--- +## Type: PaymentReceipt +[Back to types index](index.md) + + + +### Possible values (constructors): + +[paymentReceipt](../constructors/paymentReceipt.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->getPaymentReceipt](../methods/getPaymentReceipt.md) + + + diff --git a/docs/TD_docs/types/PaymentResult.md b/docs/TD_docs/types/PaymentResult.md new file mode 100644 index 00000000..fc10a2ea --- /dev/null +++ b/docs/TD_docs/types/PaymentResult.md @@ -0,0 +1,21 @@ +--- +title: PaymentResult +description: constructors and methods of type PaymentResult +--- +## Type: PaymentResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[paymentResult](../constructors/paymentResult.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->sendPaymentForm](../methods/sendPaymentForm.md) + + + diff --git a/docs/TD_docs/types/PaymentsProviderStripe.md b/docs/TD_docs/types/PaymentsProviderStripe.md new file mode 100644 index 00000000..0d10cb7d --- /dev/null +++ b/docs/TD_docs/types/PaymentsProviderStripe.md @@ -0,0 +1,19 @@ +--- +title: PaymentsProviderStripe +description: constructors and methods of type PaymentsProviderStripe +--- +## Type: PaymentsProviderStripe +[Back to types index](index.md) + + + +### Possible values (constructors): + +[paymentsProviderStripe](../constructors/paymentsProviderStripe.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/PrivacyKey.md b/docs/TD_docs/types/PrivacyKey.md index fa38cbea..b6c898c1 100644 --- a/docs/TD_docs/types/PrivacyKey.md +++ b/docs/TD_docs/types/PrivacyKey.md @@ -15,6 +15,8 @@ Describes available privacy settings [privacyKeyChatInvite](../constructors/privacyKeyChatInvite.md) +[privacyKeyCall](../constructors/privacyKeyCall.md) + ### Methods that return an object of this type (methods): diff --git a/docs/TD_docs/types/Proxy.md b/docs/TD_docs/types/Proxy.md new file mode 100644 index 00000000..7aaf3a22 --- /dev/null +++ b/docs/TD_docs/types/Proxy.md @@ -0,0 +1,25 @@ +--- +title: Proxy +description: constructors and methods of type Proxy +--- +## Type: Proxy +[Back to types index](index.md) + + + +Contains information about a proxy server + +### Possible values (constructors): + +[proxyEmpty](../constructors/proxyEmpty.md) + +[proxySocks5](../constructors/proxySocks5.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->getProxy](../methods/getProxy.md) + + + diff --git a/docs/TD_docs/types/PublicMessageLink.md b/docs/TD_docs/types/PublicMessageLink.md new file mode 100644 index 00000000..bf13e922 --- /dev/null +++ b/docs/TD_docs/types/PublicMessageLink.md @@ -0,0 +1,21 @@ +--- +title: PublicMessageLink +description: constructors and methods of type PublicMessageLink +--- +## Type: PublicMessageLink +[Back to types index](index.md) + + + +### Possible values (constructors): + +[publicMessageLink](../constructors/publicMessageLink.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->getPublicMessageLink](../methods/getPublicMessageLink.md) + + + diff --git a/docs/TD_docs/types/RichText.md b/docs/TD_docs/types/RichText.md new file mode 100644 index 00000000..199ca27c --- /dev/null +++ b/docs/TD_docs/types/RichText.md @@ -0,0 +1,37 @@ +--- +title: RichText +description: constructors and methods of type RichText +--- +## Type: RichText +[Back to types index](index.md) + + + +Describes a text inside web page instant view + +### Possible values (constructors): + +[richTextPlain](../constructors/richTextPlain.md) + +[richTextBold](../constructors/richTextBold.md) + +[richTextItalic](../constructors/richTextItalic.md) + +[richTextUnderline](../constructors/richTextUnderline.md) + +[richTextStrikethrough](../constructors/richTextStrikethrough.md) + +[richTextFixed](../constructors/richTextFixed.md) + +[richTextUrl](../constructors/richTextUrl.md) + +[richTextEmail](../constructors/richTextEmail.md) + +[richTextConcatenation](../constructors/richTextConcatenation.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/SavedCredentials.md b/docs/TD_docs/types/SavedCredentials.md new file mode 100644 index 00000000..9d1fe51e --- /dev/null +++ b/docs/TD_docs/types/SavedCredentials.md @@ -0,0 +1,19 @@ +--- +title: SavedCredentials +description: constructors and methods of type SavedCredentials +--- +## Type: SavedCredentials +[Back to types index](index.md) + + + +### Possible values (constructors): + +[savedCredentials](../constructors/savedCredentials.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/SearchMessagesFilter.md b/docs/TD_docs/types/SearchMessagesFilter.md index ec62bc24..3867a70a 100644 --- a/docs/TD_docs/types/SearchMessagesFilter.md +++ b/docs/TD_docs/types/SearchMessagesFilter.md @@ -31,6 +31,14 @@ Represents filter for content of searched messages [searchMessagesFilterChatPhoto](../constructors/searchMessagesFilterChatPhoto.md) +[searchMessagesFilterCall](../constructors/searchMessagesFilterCall.md) + +[searchMessagesFilterMissedCall](../constructors/searchMessagesFilterMissedCall.md) + +[searchMessagesFilterVideoNote](../constructors/searchMessagesFilterVideoNote.md) + +[searchMessagesFilterVoiceAndVideoNote](../constructors/searchMessagesFilterVoiceAndVideoNote.md) + ### Methods that return an object of this type (methods): diff --git a/docs/TD_docs/types/SendMessageAction.md b/docs/TD_docs/types/SendMessageAction.md deleted file mode 100644 index 621ef8ff..00000000 --- a/docs/TD_docs/types/SendMessageAction.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: SendMessageAction -description: constructors and methods of type SendMessageAction ---- -## Type: SendMessageAction -[Back to types index](index.md) - - - -Notifies about activity in chat - -### Possible values (constructors): - -[sendMessageTypingAction](../constructors/sendMessageTypingAction.md) - -[sendMessageCancelAction](../constructors/sendMessageCancelAction.md) - -[sendMessageRecordVideoAction](../constructors/sendMessageRecordVideoAction.md) - -[sendMessageUploadVideoAction](../constructors/sendMessageUploadVideoAction.md) - -[sendMessageRecordVoiceAction](../constructors/sendMessageRecordVoiceAction.md) - -[sendMessageUploadVoiceAction](../constructors/sendMessageUploadVoiceAction.md) - -[sendMessageUploadPhotoAction](../constructors/sendMessageUploadPhotoAction.md) - -[sendMessageUploadDocumentAction](../constructors/sendMessageUploadDocumentAction.md) - -[sendMessageGeoLocationAction](../constructors/sendMessageGeoLocationAction.md) - -[sendMessageChooseContactAction](../constructors/sendMessageChooseContactAction.md) - -[sendMessageStartPlayGameAction](../constructors/sendMessageStartPlayGameAction.md) - - - -### Methods that return an object of this type (methods): - - - diff --git a/docs/TD_docs/types/ShippingAddress.md b/docs/TD_docs/types/ShippingAddress.md new file mode 100644 index 00000000..381a5689 --- /dev/null +++ b/docs/TD_docs/types/ShippingAddress.md @@ -0,0 +1,19 @@ +--- +title: ShippingAddress +description: constructors and methods of type ShippingAddress +--- +## Type: ShippingAddress +[Back to types index](index.md) + + + +### Possible values (constructors): + +[shippingAddress](../constructors/shippingAddress.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/ShippingOption.md b/docs/TD_docs/types/ShippingOption.md new file mode 100644 index 00000000..27cfd45f --- /dev/null +++ b/docs/TD_docs/types/ShippingOption.md @@ -0,0 +1,19 @@ +--- +title: ShippingOption +description: constructors and methods of type ShippingOption +--- +## Type: ShippingOption +[Back to types index](index.md) + + + +### Possible values (constructors): + +[shippingOption](../constructors/shippingOption.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/StickerSet.md b/docs/TD_docs/types/StickerSet.md index 75823171..295f37ff 100644 --- a/docs/TD_docs/types/StickerSet.md +++ b/docs/TD_docs/types/StickerSet.md @@ -19,5 +19,9 @@ description: constructors and methods of type StickerSet [$MadelineProto->searchStickerSet](../methods/searchStickerSet.md) +[$MadelineProto->createNewStickerSet](../methods/createNewStickerSet.md) + +[$MadelineProto->addStickerToSet](../methods/addStickerToSet.md) + diff --git a/docs/TD_docs/types/StickerSets.md b/docs/TD_docs/types/StickerSets.md index a852ae66..8cc6d84f 100644 --- a/docs/TD_docs/types/StickerSets.md +++ b/docs/TD_docs/types/StickerSets.md @@ -15,7 +15,7 @@ description: constructors and methods of type StickerSets ### Methods that return an object of this type (methods): -[$MadelineProto->getStickerSets](../methods/getStickerSets.md) +[$MadelineProto->getInstalledStickerSets](../methods/getInstalledStickerSets.md) [$MadelineProto->getArchivedStickerSets](../methods/getArchivedStickerSets.md) diff --git a/docs/TD_docs/types/StorageStatistics.md b/docs/TD_docs/types/StorageStatistics.md new file mode 100644 index 00000000..a54a262e --- /dev/null +++ b/docs/TD_docs/types/StorageStatistics.md @@ -0,0 +1,23 @@ +--- +title: StorageStatistics +description: constructors and methods of type StorageStatistics +--- +## Type: StorageStatistics +[Back to types index](index.md) + + + +### Possible values (constructors): + +[storageStatistics](../constructors/storageStatistics.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->getStorageStatistics](../methods/getStorageStatistics.md) + +[$MadelineProto->optimizeStorage](../methods/optimizeStorage.md) + + + diff --git a/docs/TD_docs/types/StorageStatisticsByChat.md b/docs/TD_docs/types/StorageStatisticsByChat.md new file mode 100644 index 00000000..aa3284c0 --- /dev/null +++ b/docs/TD_docs/types/StorageStatisticsByChat.md @@ -0,0 +1,19 @@ +--- +title: StorageStatisticsByChat +description: constructors and methods of type StorageStatisticsByChat +--- +## Type: StorageStatisticsByChat +[Back to types index](index.md) + + + +### Possible values (constructors): + +[storageStatisticsByChat](../constructors/storageStatisticsByChat.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/StorageStatisticsByFileType.md b/docs/TD_docs/types/StorageStatisticsByFileType.md new file mode 100644 index 00000000..dee70e07 --- /dev/null +++ b/docs/TD_docs/types/StorageStatisticsByFileType.md @@ -0,0 +1,19 @@ +--- +title: StorageStatisticsByFileType +description: constructors and methods of type StorageStatisticsByFileType +--- +## Type: StorageStatisticsByFileType +[Back to types index](index.md) + + + +### Possible values (constructors): + +[storageStatisticsByFileType](../constructors/storageStatisticsByFileType.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/StorageStatisticsFast.md b/docs/TD_docs/types/StorageStatisticsFast.md new file mode 100644 index 00000000..5296347b --- /dev/null +++ b/docs/TD_docs/types/StorageStatisticsFast.md @@ -0,0 +1,21 @@ +--- +title: StorageStatisticsFast +description: constructors and methods of type StorageStatisticsFast +--- +## Type: StorageStatisticsFast +[Back to types index](index.md) + + + +### Possible values (constructors): + +[storageStatisticsFast](../constructors/storageStatisticsFast.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->getStorageStatisticsFast](../methods/getStorageStatisticsFast.md) + + + diff --git a/docs/TD_docs/types/TemporaryPasswordState.md b/docs/TD_docs/types/TemporaryPasswordState.md new file mode 100644 index 00000000..64187224 --- /dev/null +++ b/docs/TD_docs/types/TemporaryPasswordState.md @@ -0,0 +1,23 @@ +--- +title: TemporaryPasswordState +description: constructors and methods of type TemporaryPasswordState +--- +## Type: TemporaryPasswordState +[Back to types index](index.md) + + + +### Possible values (constructors): + +[temporaryPasswordState](../constructors/temporaryPasswordState.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->createTemporaryPassword](../methods/createTemporaryPassword.md) + +[$MadelineProto->getTemporaryPasswordState](../methods/getTemporaryPasswordState.md) + + + diff --git a/docs/TD_docs/types/TestBytes.md b/docs/TD_docs/types/TestBytes.md new file mode 100644 index 00000000..d20abf24 --- /dev/null +++ b/docs/TD_docs/types/TestBytes.md @@ -0,0 +1,21 @@ +--- +title: TestBytes +description: constructors and methods of type TestBytes +--- +## Type: TestBytes +[Back to types index](index.md) + + + +### Possible values (constructors): + +[testBytes](../constructors/testBytes.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->testCallBytes](../methods/testCallBytes.md) + + + diff --git a/docs/TD_docs/types/TestInt.md b/docs/TD_docs/types/TestInt.md new file mode 100644 index 00000000..f7ff094f --- /dev/null +++ b/docs/TD_docs/types/TestInt.md @@ -0,0 +1,21 @@ +--- +title: TestInt +description: constructors and methods of type TestInt +--- +## Type: TestInt +[Back to types index](index.md) + + + +### Possible values (constructors): + +[testInt](../constructors/testInt.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->testSquareInt](../methods/testSquareInt.md) + + + diff --git a/docs/TD_docs/types/TestString.md b/docs/TD_docs/types/TestString.md new file mode 100644 index 00000000..1a13b32a --- /dev/null +++ b/docs/TD_docs/types/TestString.md @@ -0,0 +1,21 @@ +--- +title: TestString +description: constructors and methods of type TestString +--- +## Type: TestString +[Back to types index](index.md) + + + +### Possible values (constructors): + +[testString](../constructors/testString.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->testCallString](../methods/testCallString.md) + + + diff --git a/docs/TD_docs/types/TestVectorInt.md b/docs/TD_docs/types/TestVectorInt.md new file mode 100644 index 00000000..27dc4bc8 --- /dev/null +++ b/docs/TD_docs/types/TestVectorInt.md @@ -0,0 +1,21 @@ +--- +title: TestVectorInt +description: constructors and methods of type TestVectorInt +--- +## Type: TestVectorInt +[Back to types index](index.md) + + + +### Possible values (constructors): + +[testVectorInt](../constructors/testVectorInt.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->testCallVectorInt](../methods/testCallVectorInt.md) + + + diff --git a/docs/TD_docs/types/TestVectorIntObject.md b/docs/TD_docs/types/TestVectorIntObject.md new file mode 100644 index 00000000..35e78447 --- /dev/null +++ b/docs/TD_docs/types/TestVectorIntObject.md @@ -0,0 +1,21 @@ +--- +title: TestVectorIntObject +description: constructors and methods of type TestVectorIntObject +--- +## Type: TestVectorIntObject +[Back to types index](index.md) + + + +### Possible values (constructors): + +[testVectorIntObject](../constructors/testVectorIntObject.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->testCallVectorIntObject](../methods/testCallVectorIntObject.md) + + + diff --git a/docs/TD_docs/types/TestVectorString.md b/docs/TD_docs/types/TestVectorString.md new file mode 100644 index 00000000..8e63831a --- /dev/null +++ b/docs/TD_docs/types/TestVectorString.md @@ -0,0 +1,21 @@ +--- +title: TestVectorString +description: constructors and methods of type TestVectorString +--- +## Type: TestVectorString +[Back to types index](index.md) + + + +### Possible values (constructors): + +[testVectorString](../constructors/testVectorString.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->testCallVectorString](../methods/testCallVectorString.md) + + + diff --git a/docs/TD_docs/types/TestVectorStringObject.md b/docs/TD_docs/types/TestVectorStringObject.md new file mode 100644 index 00000000..77a2fe9d --- /dev/null +++ b/docs/TD_docs/types/TestVectorStringObject.md @@ -0,0 +1,21 @@ +--- +title: TestVectorStringObject +description: constructors and methods of type TestVectorStringObject +--- +## Type: TestVectorStringObject +[Back to types index](index.md) + + + +### Possible values (constructors): + +[testVectorStringObject](../constructors/testVectorStringObject.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->testCallVectorStringObject](../methods/testCallVectorStringObject.md) + + + diff --git a/docs/TD_docs/types/Text.md b/docs/TD_docs/types/Text.md new file mode 100644 index 00000000..fd3de6e3 --- /dev/null +++ b/docs/TD_docs/types/Text.md @@ -0,0 +1,23 @@ +--- +title: Text +description: constructors and methods of type Text +--- +## Type: Text +[Back to types index](index.md) + + + +### Possible values (constructors): + +[text](../constructors/text.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->getInviteText](../methods/getInviteText.md) + +[$MadelineProto->getTermsOfService](../methods/getTermsOfService.md) + + + diff --git a/docs/TD_docs/types/TextEntity.md b/docs/TD_docs/types/TextEntity.md new file mode 100644 index 00000000..3da9c874 --- /dev/null +++ b/docs/TD_docs/types/TextEntity.md @@ -0,0 +1,19 @@ +--- +title: TextEntity +description: constructors and methods of type TextEntity +--- +## Type: TextEntity +[Back to types index](index.md) + + + +### Possible values (constructors): + +[textEntity](../constructors/textEntity.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/TextEntityType.md b/docs/TD_docs/types/TextEntityType.md new file mode 100644 index 00000000..d2eda44b --- /dev/null +++ b/docs/TD_docs/types/TextEntityType.md @@ -0,0 +1,43 @@ +--- +title: TextEntityType +description: constructors and methods of type TextEntityType +--- +## Type: TextEntityType +[Back to types index](index.md) + + + +Represent part of the text which needs to be formatted in some unusual way + +### Possible values (constructors): + +[textEntityTypeMention](../constructors/textEntityTypeMention.md) + +[textEntityTypeHashtag](../constructors/textEntityTypeHashtag.md) + +[textEntityTypeBotCommand](../constructors/textEntityTypeBotCommand.md) + +[textEntityTypeUrl](../constructors/textEntityTypeUrl.md) + +[textEntityTypeEmail](../constructors/textEntityTypeEmail.md) + +[textEntityTypeBold](../constructors/textEntityTypeBold.md) + +[textEntityTypeItalic](../constructors/textEntityTypeItalic.md) + +[textEntityTypeCode](../constructors/textEntityTypeCode.md) + +[textEntityTypePre](../constructors/textEntityTypePre.md) + +[textEntityTypePreCode](../constructors/textEntityTypePreCode.md) + +[textEntityTypeTextUrl](../constructors/textEntityTypeTextUrl.md) + +[textEntityTypeMentionName](../constructors/textEntityTypeMentionName.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/TopChatCategory.md b/docs/TD_docs/types/TopChatCategory.md new file mode 100644 index 00000000..f347680f --- /dev/null +++ b/docs/TD_docs/types/TopChatCategory.md @@ -0,0 +1,31 @@ +--- +title: TopChatCategory +description: constructors and methods of type TopChatCategory +--- +## Type: TopChatCategory +[Back to types index](index.md) + + + +Represents categories of chats for which list of frequently used chats can be retrieved + +### Possible values (constructors): + +[topChatCategoryUsers](../constructors/topChatCategoryUsers.md) + +[topChatCategoryBots](../constructors/topChatCategoryBots.md) + +[topChatCategoryGroups](../constructors/topChatCategoryGroups.md) + +[topChatCategoryChannels](../constructors/topChatCategoryChannels.md) + +[topChatCategoryInlineBots](../constructors/topChatCategoryInlineBots.md) + +[topChatCategoryCalls](../constructors/topChatCategoryCalls.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/Update.md b/docs/TD_docs/types/Update.md index 5d99b3b6..4213a430 100644 --- a/docs/TD_docs/types/Update.md +++ b/docs/TD_docs/types/Update.md @@ -15,6 +15,8 @@ Contains notifications about data changes [updateNewMessage](../constructors/updateNewMessage.md) +[updateMessageSendAcknowledged](../constructors/updateMessageSendAcknowledged.md) + [updateMessageSendSucceeded](../constructors/updateMessageSendSucceeded.md) [updateMessageSendFailed](../constructors/updateMessageSendFailed.md) @@ -25,29 +27,33 @@ Contains notifications about data changes [updateMessageViews](../constructors/updateMessageViews.md) -[updateChat](../constructors/updateChat.md) +[updateOpenMessageContent](../constructors/updateOpenMessageContent.md) -[updateChatTopMessage](../constructors/updateChatTopMessage.md) - -[updateChatOrder](../constructors/updateChatOrder.md) +[updateNewChat](../constructors/updateNewChat.md) [updateChatTitle](../constructors/updateChatTitle.md) [updateChatPhoto](../constructors/updateChatPhoto.md) +[updateChatTopMessage](../constructors/updateChatTopMessage.md) + +[updateChatOrder](../constructors/updateChatOrder.md) + +[updateChatIsPinned](../constructors/updateChatIsPinned.md) + [updateChatReadInbox](../constructors/updateChatReadInbox.md) [updateChatReadOutbox](../constructors/updateChatReadOutbox.md) +[updateNotificationSettings](../constructors/updateNotificationSettings.md) + [updateChatReplyMarkup](../constructors/updateChatReplyMarkup.md) [updateChatDraftMessage](../constructors/updateChatDraftMessage.md) -[updateNotificationSettings](../constructors/updateNotificationSettings.md) - [updateDeleteMessages](../constructors/updateDeleteMessages.md) -[updateUserAction](../constructors/updateUserAction.md) +[updateUserChatAction](../constructors/updateUserChatAction.md) [updateUserStatus](../constructors/updateUserStatus.md) @@ -59,9 +65,11 @@ Contains notifications about data changes [updateSecretChat](../constructors/updateSecretChat.md) -[updateChannelFull](../constructors/updateChannelFull.md) +[updateUserFull](../constructors/updateUserFull.md) -[updateUserBlocked](../constructors/updateUserBlocked.md) +[updateGroupFull](../constructors/updateGroupFull.md) + +[updateChannelFull](../constructors/updateChannelFull.md) [updateServiceNotification](../constructors/updateServiceNotification.md) @@ -75,11 +83,13 @@ Contains notifications about data changes [updateFileGenerationFinish](../constructors/updateFileGenerationFinish.md) +[updateCall](../constructors/updateCall.md) + [updatePrivacy](../constructors/updatePrivacy.md) [updateOption](../constructors/updateOption.md) -[updateStickerSets](../constructors/updateStickerSets.md) +[updateInstalledStickerSets](../constructors/updateInstalledStickerSets.md) [updateTrendingStickerSets](../constructors/updateTrendingStickerSets.md) @@ -87,6 +97,8 @@ Contains notifications about data changes [updateSavedAnimations](../constructors/updateSavedAnimations.md) +[updateConnectionState](../constructors/updateConnectionState.md) + [updateNewInlineQuery](../constructors/updateNewInlineQuery.md) [updateNewChosenInlineResult](../constructors/updateNewChosenInlineResult.md) @@ -95,9 +107,19 @@ Contains notifications about data changes [updateNewInlineCallbackQuery](../constructors/updateNewInlineCallbackQuery.md) +[updateNewShippingQuery](../constructors/updateNewShippingQuery.md) + +[updateNewPreCheckoutQuery](../constructors/updateNewPreCheckoutQuery.md) + +[updateNewCustomEvent](../constructors/updateNewCustomEvent.md) + +[updateNewCustomQuery](../constructors/updateNewCustomQuery.md) + ### Methods that return an object of this type (methods): +[$MadelineProto->testUseUpdate](../methods/testUseUpdate.md) + diff --git a/docs/TD_docs/types/Users.md b/docs/TD_docs/types/Users.md index ea7c1dc0..c324adb2 100644 --- a/docs/TD_docs/types/Users.md +++ b/docs/TD_docs/types/Users.md @@ -17,8 +17,6 @@ description: constructors and methods of type Users [$MadelineProto->getBlockedUsers](../methods/getBlockedUsers.md) -[$MadelineProto->importContacts](../methods/importContacts.md) - [$MadelineProto->searchContacts](../methods/searchContacts.md) [$MadelineProto->getRecentInlineBots](../methods/getRecentInlineBots.md) diff --git a/docs/TD_docs/types/ValidatedOrderInfo.md b/docs/TD_docs/types/ValidatedOrderInfo.md new file mode 100644 index 00000000..f27a831d --- /dev/null +++ b/docs/TD_docs/types/ValidatedOrderInfo.md @@ -0,0 +1,21 @@ +--- +title: ValidatedOrderInfo +description: constructors and methods of type ValidatedOrderInfo +--- +## Type: ValidatedOrderInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[validatedOrderInfo](../constructors/validatedOrderInfo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->validateOrderInfo](../methods/validateOrderInfo.md) + + + diff --git a/docs/TD_docs/types/VideoNote.md b/docs/TD_docs/types/VideoNote.md new file mode 100644 index 00000000..888e601a --- /dev/null +++ b/docs/TD_docs/types/VideoNote.md @@ -0,0 +1,19 @@ +--- +title: VideoNote +description: constructors and methods of type VideoNote +--- +## Type: VideoNote +[Back to types index](index.md) + + + +### Possible values (constructors): + +[videoNote](../constructors/videoNote.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/TD_docs/types/WebPageInstantView.md b/docs/TD_docs/types/WebPageInstantView.md new file mode 100644 index 00000000..afe862cc --- /dev/null +++ b/docs/TD_docs/types/WebPageInstantView.md @@ -0,0 +1,21 @@ +--- +title: WebPageInstantView +description: constructors and methods of type WebPageInstantView +--- +## Type: WebPageInstantView +[Back to types index](index.md) + + + +### Possible values (constructors): + +[webPageInstantView](../constructors/webPageInstantView.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->getWebPageInstantView](../methods/getWebPageInstantView.md) + + + diff --git a/docs/TD_docs/types/index.md b/docs/TD_docs/types/index.md index 1022f8ac..8bdf330d 100644 --- a/docs/TD_docs/types/index.md +++ b/docs/TD_docs/types/index.md @@ -22,6 +22,18 @@ description: List of types [BotInfo](BotInfo.md) +[Call](Call.md) + +[CallConnection](CallConnection.md) + +[CallDiscardReason](CallDiscardReason.md) + +[CallId](CallId.md) + +[CallProtocol](CallProtocol.md) + +[CallState](CallState.md) + [CallbackQueryAnswer](CallbackQueryAnswer.md) [CallbackQueryPayload](CallbackQueryPayload.md) @@ -32,11 +44,17 @@ description: List of types [ChannelMembersFilter](ChannelMembersFilter.md) -[Channels](Channels.md) - [Chat](Chat.md) -[ChatInfo](ChatInfo.md) +[ChatAction](ChatAction.md) + +[ChatEvent](ChatEvent.md) + +[ChatEventAction](ChatEventAction.md) + +[ChatEventLogFilters](ChatEventLogFilters.md) + +[ChatEvents](ChatEvents.md) [ChatInviteLink](ChatInviteLink.md) @@ -50,15 +68,21 @@ description: List of types [ChatPhoto](ChatPhoto.md) +[ChatReportReason](ChatReportReason.md) + [ChatReportSpamState](ChatReportSpamState.md) +[ChatType](ChatType.md) + [Chats](Chats.md) +[ConnectionState](ConnectionState.md) + [Contact](Contact.md) -[DeviceToken](DeviceToken.md) +[CustomRequestResult](CustomRequestResult.md) -[DeviceTokenSet](DeviceTokenSet.md) +[DeviceToken](DeviceToken.md) [Document](Document.md) @@ -68,6 +92,10 @@ description: List of types [File](File.md) +[FileType](FileType.md) + +[FoundMessages](FoundMessages.md) + [Game](Game.md) [GameHighScore](GameHighScore.md) @@ -78,6 +106,10 @@ description: List of types [GroupFull](GroupFull.md) +[Hashtags](Hashtags.md) + +[ImportedContacts](ImportedContacts.md) + [InlineKeyboardButton](InlineKeyboardButton.md) [InlineKeyboardButtonType](InlineKeyboardButtonType.md) @@ -86,18 +118,26 @@ description: List of types [InlineQueryResults](InlineQueryResults.md) +[InputCredentials](InputCredentials.md) + [InputFile](InputFile.md) [InputInlineQueryResult](InputInlineQueryResult.md) [InputMessageContent](InputMessageContent.md) +[InputSticker](InputSticker.md) + [InputThumb](InputThumb.md) +[Invoice](Invoice.md) + [KeyboardButton](KeyboardButton.md) [KeyboardButtonType](KeyboardButtonType.md) +[LabeledPrice](LabeledPrice.md) + [LinkState](LinkState.md) [Location](Location.md) @@ -108,14 +148,18 @@ description: List of types [MessageContent](MessageContent.md) -[MessageEntity](MessageEntity.md) - [MessageForwardInfo](MessageForwardInfo.md) [MessageSendState](MessageSendState.md) [Messages](Messages.md) +[NetworkStatistics](NetworkStatistics.md) + +[NetworkStatisticsEntry](NetworkStatisticsEntry.md) + +[NetworkType](NetworkType.md) + [NotificationSettings](NotificationSettings.md) [NotificationSettingsScope](NotificationSettingsScope.md) @@ -124,10 +168,22 @@ description: List of types [OptionValue](OptionValue.md) +[OrderInfo](OrderInfo.md) + +[PageBlock](PageBlock.md) + [PasswordRecoveryInfo](PasswordRecoveryInfo.md) [PasswordState](PasswordState.md) +[PaymentForm](PaymentForm.md) + +[PaymentReceipt](PaymentReceipt.md) + +[PaymentResult](PaymentResult.md) + +[PaymentsProviderStripe](PaymentsProviderStripe.md) + [Photo](Photo.md) [PhotoSize](PhotoSize.md) @@ -140,20 +196,30 @@ description: List of types [ProfilePhoto](ProfilePhoto.md) +[Proxy](Proxy.md) + +[PublicMessageLink](PublicMessageLink.md) + [RecoveryEmail](RecoveryEmail.md) [ReplyMarkup](ReplyMarkup.md) +[RichText](RichText.md) + +[SavedCredentials](SavedCredentials.md) + [SearchMessagesFilter](SearchMessagesFilter.md) [SecretChat](SecretChat.md) -[SendMessageAction](SendMessageAction.md) - [Session](Session.md) [Sessions](Sessions.md) +[ShippingAddress](ShippingAddress.md) + +[ShippingOption](ShippingOption.md) + [Sticker](Sticker.md) [StickerEmojis](StickerEmojis.md) @@ -166,8 +232,40 @@ description: List of types [Stickers](Stickers.md) +[StorageStatistics](StorageStatistics.md) + +[StorageStatisticsByChat](StorageStatisticsByChat.md) + +[StorageStatisticsByFileType](StorageStatisticsByFileType.md) + +[StorageStatisticsFast](StorageStatisticsFast.md) + +[TemporaryPasswordState](TemporaryPasswordState.md) + +[TestBytes](TestBytes.md) + +[TestInt](TestInt.md) + +[TestString](TestString.md) + +[TestVectorInt](TestVectorInt.md) + +[TestVectorIntObject](TestVectorIntObject.md) + +[TestVectorString](TestVectorString.md) + +[TestVectorStringObject](TestVectorStringObject.md) + +[Text](Text.md) + +[TextEntity](TextEntity.md) + +[TextEntityType](TextEntityType.md) + [TextParseMode](TextParseMode.md) +[TopChatCategory](TopChatCategory.md) + [Update](Update.md) [User](User.md) @@ -182,10 +280,14 @@ description: List of types [Users](Users.md) +[ValidatedOrderInfo](ValidatedOrderInfo.md) + [Venue](Venue.md) [Video](Video.md) +[VideoNote](VideoNote.md) + [Voice](Voice.md) [Wallpaper](Wallpaper.md) @@ -194,19 +296,5 @@ description: List of types [WebPage](WebPage.md) -[test\_Bytes](test_Bytes.md) - -[test\_Empty](test_Empty.md) - -[test\_Int](test_Int.md) - -[test\_String](test_String.md) - -[test\_VectorInt](test_VectorInt.md) - -[test\_VectorIntObject](test_VectorIntObject.md) - -[test\_VectorString](test_VectorString.md) - -[test\_VectorStringObject](test_VectorStringObject.md) +[WebPageInstantView](WebPageInstantView.md) diff --git a/docs/TD_docs/types/test_Bytes.md b/docs/TD_docs/types/test_Bytes.md deleted file mode 100644 index f09d48e9..00000000 --- a/docs/TD_docs/types/test_Bytes.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: test_Bytes -description: constructors and methods of type test_Bytes ---- -## Type: test\_Bytes -[Back to types index](index.md) - - - -### Possible values (constructors): - -[test\_bytes](../constructors/test_bytes.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->test->callBytes](../methods/test_callBytes.md) - - - diff --git a/docs/TD_docs/types/test_Empty.md b/docs/TD_docs/types/test_Empty.md deleted file mode 100644 index 99af491f..00000000 --- a/docs/TD_docs/types/test_Empty.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: test_Empty -description: constructors and methods of type test_Empty ---- -## Type: test\_Empty -[Back to types index](index.md) - - - -### Possible values (constructors): - -[test\_empty](../constructors/test_empty.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->test->callEmpty](../methods/test_callEmpty.md) - -[$MadelineProto->test->testNet](../methods/test_testNet.md) - - - diff --git a/docs/TD_docs/types/test_Int.md b/docs/TD_docs/types/test_Int.md deleted file mode 100644 index ad28b292..00000000 --- a/docs/TD_docs/types/test_Int.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: test_Int -description: constructors and methods of type test_Int ---- -## Type: test\_Int -[Back to types index](index.md) - - - -### Possible values (constructors): - -[test\_int](../constructors/test_int.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->test->squareInt](../methods/test_squareInt.md) - - - diff --git a/docs/TD_docs/types/test_String.md b/docs/TD_docs/types/test_String.md deleted file mode 100644 index 66a71073..00000000 --- a/docs/TD_docs/types/test_String.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: test_String -description: constructors and methods of type test_String ---- -## Type: test\_String -[Back to types index](index.md) - - - -### Possible values (constructors): - -[test\_string](../constructors/test_string.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->test->callString](../methods/test_callString.md) - - - diff --git a/docs/TD_docs/types/test_VectorInt.md b/docs/TD_docs/types/test_VectorInt.md deleted file mode 100644 index 052dacec..00000000 --- a/docs/TD_docs/types/test_VectorInt.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: test_VectorInt -description: constructors and methods of type test_VectorInt ---- -## Type: test\_VectorInt -[Back to types index](index.md) - - - -### Possible values (constructors): - -[test\_vectorInt](../constructors/test_vectorInt.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->test->callVectorInt](../methods/test_callVectorInt.md) - - - diff --git a/docs/TD_docs/types/test_VectorIntObject.md b/docs/TD_docs/types/test_VectorIntObject.md deleted file mode 100644 index d3fbe2eb..00000000 --- a/docs/TD_docs/types/test_VectorIntObject.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: test_VectorIntObject -description: constructors and methods of type test_VectorIntObject ---- -## Type: test\_VectorIntObject -[Back to types index](index.md) - - - -### Possible values (constructors): - -[test\_vectorIntObject](../constructors/test_vectorIntObject.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->test->callVectorIntObject](../methods/test_callVectorIntObject.md) - - - diff --git a/docs/TD_docs/types/test_VectorString.md b/docs/TD_docs/types/test_VectorString.md deleted file mode 100644 index 04e00359..00000000 --- a/docs/TD_docs/types/test_VectorString.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: test_VectorString -description: constructors and methods of type test_VectorString ---- -## Type: test\_VectorString -[Back to types index](index.md) - - - -### Possible values (constructors): - -[test\_vectorString](../constructors/test_vectorString.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->test->callVectorString](../methods/test_callVectorString.md) - - - diff --git a/docs/TD_docs/types/test_VectorStringObject.md b/docs/TD_docs/types/test_VectorStringObject.md deleted file mode 100644 index 84dfca70..00000000 --- a/docs/TD_docs/types/test_VectorStringObject.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: test_VectorStringObject -description: constructors and methods of type test_VectorStringObject ---- -## Type: test\_VectorStringObject -[Back to types index](index.md) - - - -### Possible values (constructors): - -[test\_vectorStringObject](../constructors/test_vectorStringObject.md) - - - -### Methods that return an object of this type (methods): - -[$MadelineProto->test->callVectorStringObject](../methods/test_callVectorStringObject.md) - - - diff --git a/src/danog/MadelineProto/TL_td.tl b/src/danog/MadelineProto/TL_td.tl index fd8162a9..73562a7f 100644 --- a/src/danog/MadelineProto/TL_td.tl +++ b/src/danog/MadelineProto/TL_td.tl @@ -1,5 +1,6 @@ //@description Object of this type may be returned on every function call in case of the error -//@code Error code, maybe changed in the future @message Error message, may be changed in the future +//@code Error code, maybe changed in the future. If code == 406, error message should not be processed in any way and shouldn't be showed to the user +//@message Error message, may be changed in the future error code:int message:string = Error; @@ -15,7 +16,7 @@ authCodeTypeMessage length:int = AuthCodeType; //@description Code is delivered by SMS to the specified phone number @length Length of the code authCodeTypeSms length:int = AuthCodeType; -//@description Code is delievered by voice call to the specified phone number @length Length of the code +//@description Code is delivered by phone call to the specified phone number @length Length of the code authCodeTypeCall length:int = AuthCodeType; //@description Code is delivered by the immediately cancelled call to the specified phone number. Number from which the call was done is the code @pattern Pattern of the phone number from which the call will be done @@ -51,11 +52,21 @@ passwordRecoveryInfo recovery_email_pattern:string = PasswordRecoveryInfo; recoveryEmail recovery_email:string = RecoveryEmail; -//@description Represents a file @id Unique file identifier, 0 for empty file @persistent_id Persistent file identifier, if exists. Can be used across application restarts or even other devices for current logged user. If begins with "http://" or "https://", it is HTTP URL of the file. Currently, TDLib is unable to download files if only they URL is known -//@size File size, 0 if unknown @path Local path to the file, if available -file id:int persistent_id:string size:int path:string = File; +//@description Returns information about availability of temporary password, which should be used for payments @has_password True, if we have temporary password @valid_for Time left before temporary password expires, seconds +temporaryPasswordState has_password:Bool valid_for:int = TemporaryPasswordState; +//@description Represents a file +//@id Unique file identifier +//@persistent_id Persistent file identifier, if exists. Can be used across application restarts or even other devices for current logged user. If begins with "http://" or "https://", it is HTTP URL of the file. Currently, TDLib is unable to download files if only they URL is known. If downloadFile is called on a such file or it is sended to a secret chat TDLib starts file generation process by sending to the client updateFileGenerationStart with HTTP URL in the original_path and "#url#" as conversion string. Client supposed to generate the file by downloading it to the specified location +//@size File size, 0 if unknown +//@is_being_downloaded True, if the file is currently being downloaded +//@local_size Size of locally available part of the file. If size != 0 && local_size == size, full file is available locally +//@is_being_uploaded True, if the file is currently being uploaded +//@remote_size Size of remotely available part of the file. If size != 0 && remote_size == size, the file is available remotely +//@path Local path to the available file part, may be empty +file id:int persistent_id:string size:int is_being_downloaded:Bool local_size:int is_being_uploaded:Bool remote_size:int path:string = File; + //@class InputFile @description Points to some file //@description File defined by its id @id Unique file identifier @@ -68,21 +79,26 @@ inputFilePersistentId persistent_id:string = InputFile; inputFileLocal path:string = InputFile; //@description File generated by the client @original_path Local path to a file from which the file is generated, may be empty if there is no such file @conversion String specifying conversion applied to the original file, should be persistent across application restart @expected_size Expected size of the generated file -//@should_cache True, if result of the conversion should be cached persistently -inputFileGenerated original_path:string conversion:string expected_size:int should_cache:Bool = InputFile; +inputFileGenerated original_path:string conversion:string expected_size:int = InputFile; -//@description Photo description @type Thumbnail type (see https://core.telegram.org/constructor/photoSize) -//@photo Information about photo file @width Photo width @height Photo height +//@description Photo description @type Thumbnail type (see https://core.telegram.org/constructor/photoSize) @photo Information about photo file @width Photo width @height Photo height photoSize type:string photo:file width:int height:int = PhotoSize; -//@description Position on a photo where a mask should be placed @point Part of a photo relative to which the mask should be placed. 0 - forehead, 1 - eyes, 2 - mouth, 3 - chin @x_shift Shift by X-axis in pixels, from left to right @y_shift Shift by Y-axis in pixels, from top to bottom @zoom Mask zoom coefficient -maskPosition point:int x_shift:double y_shift:double zoom:double = MaskPosition; +//@description Position on a photo where a mask should be placed @point Part of a face relative to which the mask should be placed. 0 - forehead, 1 - eyes, 2 - mouth, 3 - chin +//@x_shift Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position +//@y_shift Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position. +//@scale Mask scaling coefficient. For example, 2.0 means double size +maskPosition point:int x_shift:double y_shift:double scale:double = MaskPosition; -//@description Describes animation file. Animation should be encoded in gif or mp4 format @width Width of the animation @height Height of the animation +//@description Represent part of the text which needs to be formatted in some unusual way @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points @type Type of the entity +textEntity offset:int length:int type:TextEntityType = TextEntity; + + +//@description Describes animation file. Animation should be encoded in gif or mp4 format @duration Duration of the animation in seconds as defined by sender @width Width of the animation @height Height of the animation //@file_name Original name of a file as defined by sender @mime_type MIME type of a file, usually "image/gif" or "video/mp4" @thumb Animation thumb, nullable @animation File with the animation -animation width:int height:int file_name:string mime_type:string thumb:photoSize animation:file = Animation; +animation duration:int width:int height:int file_name:string mime_type:string thumb:photoSize animation:file = Animation; //@description Describes audio file. Audio is usually in mp3 format @duration Duration of the audio in seconds as defined by sender @title Title of the audio as defined by sender @performer Performer of the audio as defined by sender //@file_name Original name of a file as defined by sender @mime_type MIME type of a file as defined by sender @album_cover_thumb Thumb of the album's cover as defined by sender. Full size thumb should be extracted from the downloaded file, nullable @audio File with the audio @@ -103,26 +119,13 @@ sticker set_id:long width:int height:int emoji:string is_mask:Bool mask_position //@file_name Original name of a file as defined by sender @mime_type MIME type of a file as defined by sender @has_stickers True, if some stickers was added to the photo @thumb Video thumb as defined by sender, nullable @video File with the video video duration:int width:int height:int file_name:string mime_type:string has_stickers:Bool thumb:photoSize video:file = Video; -//@description Describes voice record. Voice must be encoded with Opus codec and must be stored inside Ogg container @duration Duration of the voice record in seconds as defined by sender +//@description Describes video note. Video must have equal width and height, cropped to circle and stored in mpeg4 format @duration Duration of the video in seconds as defined by sender @length Video width and height as defined by sender @thumb Video thumb as defined by sender, nullable @video File with the video +videoNote duration:int length:int thumb:photoSize video:file = VideoNote; + +//@description Describes voice note. Voice must be encoded with Opus codec and must be stored inside Ogg container @duration Duration of the voice record in seconds as defined by sender //@waveform Waveform representation of the voice in 5-bit format @mime_type MIME type of a file as defined by sender @voice File with the voice record voice duration:int waveform:bytes mime_type:string voice:file = Voice; -//@description Describes web page preview @url Original URL of link @display_url URL to display -//@type Type of web page: article, photo, audio, video, document, profile, app or something other -//@site_name Short name of the site (i.e. Google Docs or App Store) @title Title of the content @param_description Description of the content -//@photo Image representing the content, nullable -//@embed_url Url to show embedded preview -//@embed_type MIME type of embedded preview, i.e. text/html or video/mp4 -//@embed_width Width of embedded preview -//@embed_height Height of embedded preview @duration Duration of the content @author Author of the content -//@animation Preview as Animation if available, nullable -//@audio Preview as Audio if available, nullable -//@document Preview as Document if available (currently only for small pdf files and zip archives), nullable -//@sticker Preview as Sticker for small .webp files if available, nullable -//@video Preview as Video if available, nullable -//@voice Preview as Voice if available, nullable -webPage url:string display_url:string type:string site_name:string title:string description:string photo:photo embed_url:string embed_type:string embed_width:int embed_height:int duration:int author:string animation:animation audio:audio document:document sticker:sticker video:video voice:voice = WebPage; - //@description Describes user contact @phone_number User's phone number @first_name User first name, 1-255 characters @last_name User last name @user_id User identifier if known, 0 otherwise contact phone_number:string first_name:string last_name:string user_id:int = Contact; @@ -133,9 +136,9 @@ location latitude:double longitude:double = Location; //@id Identifier of the venue in provider database as defined by sender venue location:location title:string address:string provider:string id:string = Venue; -//@description Describes a game @id Game id @short_name Game short name, to share a game use a URL https://telegram.me/{bot_username}?game={game_short_name} @title Game title @text Game text, usually containing game scoreboards @text_entities Entities contained in the text @param_description Game description -//@photo Game photo @animation Game animation, nullable -game id:long short_name:string title:string text:string text_entities:vector description:string photo:photo animation:animation = Game; +//@description Describes a game @id Game id @short_name Game short name, to share a game use a URL https://t.me/{bot_username}?game={game_short_name} @title Game title @text Game text, usually containing game scoreboards +//@text_entities Entities contained in the text @param_description Game description @photo Game photo @animation Game animation, nullable +game id:long short_name:string title:string text:string text_entities:vector description:string photo:photo animation:animation = Game; //@description Describes user profile photo @id Photo identifier, 0 for empty photo. Can be used to find photo in list of userProfilePhotos @@ -184,39 +187,59 @@ botInfo description:string commands:vector = BotInfo; //@description Represents user @id User identifier @first_name User first name @last_name User last name @username User username //@phone_number User's phone number @status User's online status @profile_photo User profile photo, nullable -//@my_link Relationships from me to other user @foreign_link Relationships from other user to me @is_verified True, if user is verified @restriction_reason If non-empty, contains the reason, why access to this user 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 -//@have_access If false, the user is inaccessible and the only known information about it is inside this class. It can't be passed to any method except GetUser. Currently it can be false only for inaccessible authors of the channel posts @type Type of the user -user id:int first_name:string last_name:string username:string phone_number:string status:UserStatus profile_photo:profilePhoto my_link:LinkState foreign_link:LinkState is_verified:Bool restriction_reason:string have_access:Bool type:UserType = User; +//@my_link Relationships from me to other user @foreign_link Relationships from other user to me @is_verified True, if user is verified @restriction_reason If non-empty, contains the reason, why access to this user 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 +//@have_access If false, the user is inaccessible and the only known information about it is inside this class. It can't be passed to any method except GetUser. Currently it can be false only for inaccessible authors of the channel posts @type Type of the user @language_code Bots only. IETF language tag of users language +user id:int first_name:string last_name:string username:string phone_number:string status:UserStatus profile_photo:profilePhoto my_link:LinkState foreign_link:LinkState is_verified:Bool restriction_reason:string have_access:Bool type:UserType language_code:string = User; -//@description Gives full information about a user (except full list of profile photos) @user General info about the user @is_blocked Is user blacklisted by current user @about Short user description @common_chat_count Number of common chats between the user and current user, 0 for the current user @bot_info Information about bot if user is a bot, nullable -userFull user:user is_blocked:Bool about:string common_chat_count:int bot_info:botInfo = UserFull; +//@description Gives full information about a user (except full list of profile photos) @is_blocked Is user blacklisted by the current user @can_be_called True, if the user can be called @has_private_calls True, if the user can't be called only because of his privacy settings +//@about Short user bio or bot share text @common_chat_count Number of common chats between the user and current user, 0 for the current user @bot_info Information about bot if user is a bot, nullable +userFull is_blocked:Bool can_be_called:Bool has_private_calls:Bool about:string common_chat_count:int bot_info:botInfo = UserFull; //@description Contains part of the list of user photos @total_count Total number of user profile photos @photos List of photos userProfilePhotos total_count:int photos:vector = UserProfilePhotos; +//@description Represents list of users @total_count Approximate total count of found users @user_ids List of user identifiers +users total_count:int user_ids:vector = Users; + //@class ChatMemberStatus @description Provides information about status of a member in the chat -//@description Creator of the chat, can delete any message, kick any user and add editors and moderators in channels +//@description User is creator of the chat which has all administrator priviledges chatMemberStatusCreator = ChatMemberStatus; -//@description In broadcast channels, member that can post messages to the broadcast channel and have moderator rights. In groups and supergroups, member that can add new members to the chat/kick unpriviledged members -chatMemberStatusEditor = ChatMemberStatus; +//@description User is a chat member with some additional priviledges. In groups, administrators can edit and delete other messages, add new members and ban unpriviledged members +//@can_be_edited True, if current user has rights to edit administrator privileges of that user +//@can_change_info True, if the administrator can change chat title, photo and other settings +//@can_post_messages True, if the administrator can create channel posts, broadcast channels only +//@can_edit_messages True, if the administrator can edit messages of other users, broadcast channels only +//@can_delete_messages True, if the administrator can delete messages of other users +//@can_invite_users True, if the administrator can invite new users to the chat +//@can_restrict_members True, if the administrator can restrict, ban or unban chat members +//@can_pin_messages True, if the administrator can pin messages, supergroup channels only +//@can_promote_members True, if the administrator can add new administrators with a subset of his own privileges or demote administrators directly or indirectly promoted by him +chatMemberStatusAdministrator can_be_edited:Bool can_change_info:Bool can_post_messages:Bool can_edit_messages:Bool can_delete_messages:Bool can_invite_users:Bool can_restrict_members:Bool can_pin_messages:Bool can_promote_members:Bool = ChatMemberStatus; -//@description Only for channels, member that can delete messages of unprivileged members and kick them -chatMemberStatusModerator = ChatMemberStatus; - -//@description User is a member of the chat, but have no any additional privileges +//@description User is a member of the chat, but have no any additional privileges or restrictions chatMemberStatusMember = ChatMemberStatus; +//@description User has some additional restrictions in the chat. Unsupported in group chats and broadcast channels +//@is_member True, if user is chat member +//@restricted_until_date Date when the user will be unrestricted, 0 if never. Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time it considered to be restricted forever +//@can_send_messages True, if the user can send text messages, contacts, locations and venues +//@can_send_media_messages True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages +//@can_send_other_messages True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages +//@can_add_web_page_previews True, if user may add web page preview to his messages, implies can_send_messages +chatMemberStatusRestricted is_member:Bool restricted_until_date:int can_send_messages:Bool can_send_media_messages:Bool can_send_other_messages:Bool can_add_web_page_previews:Bool = ChatMemberStatus; + //@description User is not a chat member chatMemberStatusLeft = ChatMemberStatus; -//@description User was kicked from the chat (and obviously is not a chat member) -chatMemberStatusKicked = ChatMemberStatus; +//@description User was banned (and obviously is not a chat member) and can't return to the chat or view messages +//@banned_until_date Date when the user will be unbanned, 0 if never. Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time it considered to be banned forever +chatMemberStatusBanned banned_until_date:int = ChatMemberStatus; -//@description User with information about its chat joining/kicking @user_id User identifier of the chat member @inviter_user_id Identifier of a user invited this member to/kicked this member from the chat, 0 if unknown +//@description User with information about its chat joining/leaving @user_id User identifier of the chat member @inviter_user_id Identifier of a user invited/promoted/banned this member in the chat, 0 if unknown //@join_date Date the user has joined a chat, unix time @status Status of the member in the chat @bot_info Information about bot if user is a bot, nullable. Can be null even for bot if bot is not a chat member chatMember user_id:int inviter_user_id:int join_date:int status:ChatMemberStatus bot_info:botInfo = ChatMember; @@ -227,30 +250,34 @@ chatMembers total_count:int members:vector = ChatMembers; //@class ChannelMembersFilter @description Specifies kind of chat users to return in getChannelMembers //@description Return recently active users in reverse chronological order -channelMembersRecent = ChannelMembersFilter; +channelMembersFilterRecent = ChannelMembersFilter; -//@description Return privileged members, i.e. creator, editors and moderators are returned -channelMembersAdministrators = ChannelMembersFilter; +//@description Return creator and administrators +channelMembersFilterAdministrators = ChannelMembersFilter; -//@description Return kicked from the channel -channelMembersKicked = ChannelMembersFilter; +//@description Searches for channel members using specified query @query Query to search for +channelMembersFilterSearch query:string = ChannelMembersFilter; -//@description Return bots in the channel -channelMembersBots = ChannelMembersFilter; +//@description Return restricted channel members, administrators only @query Query to search for +channelMembersFilterRestricted query:string = ChannelMembersFilter; + +//@description Return banned from the channel users, administrators only @query Query to search for +channelMembersFilterBanned query:string = ChannelMembersFilter; + +//@description Return bot members of the channel +channelMembersFilterBots = ChannelMembersFilter; //@description Represents a group of zero or more other users @id Group identifier //@member_count Group member count //@status Status of the current user in the group -//@anyone_can_edit True, if all members granted editor rights in the group +//@everyone_is_administrator True, if all members granted administrator rights in the group //@is_active True, if group is active //@migrated_to_channel_id Identifier of channel (supergroup) to which this group was migrated or 0 if none -group id:int member_count:int status:ChatMemberStatus anyone_can_edit:Bool is_active:Bool migrated_to_channel_id:int = Group; +group id:int member_count:int status:ChatMemberStatus everyone_is_administrator:Bool is_active:Bool migrated_to_channel_id:int = Group; -//@description Gives full information about a group @group General info about the group -//@creator_user_id User identifier of the group creator, 0 if unknown @members Group members -//@invite_link Invite link for this group, available only for group creator and only after it is generated at least once -groupFull group:group creator_user_id:int members:vector invite_link:string = GroupFull; +//@description Gives full information about a group @creator_user_id User identifier of the group creator, 0 if unknown @members Group members @invite_link Invite link for this group, available only for group creator and only after it is generated at least once +groupFull creator_user_id:int members:vector invite_link:string = GroupFull; //@description Represents a channel with zero or more subscribers. There two different kinds of channels: supergroups and broadcast channels @@ -262,22 +289,22 @@ groupFull group:group creator_user_id:int members:vector invite_link //@sign_messages 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 True, if channel is a supergroup and is not a broadcast //@is_verified True, if the channel is verified -//@restriction_reason 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 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 channel id:int username:string date:int status:ChatMemberStatus anyone_can_invite:Bool sign_messages:Bool is_supergroup:Bool is_verified:Bool restriction_reason:string = Channel; //@description Gives full information about a channel -//@channel General info about the channel -//@about Information about the channel +//@param_description Channel description //@member_count Channel member count, 0 if unknown //@administrator_count Number of privileged users in the channel, 0 if unknown -//@kicked_count Number of users kicked from the channel, 0 if unknown +//@restricted_count Number of restricted users in the channel, 0 if unknown +//@banned_count Number of users banned from the channel, 0 if unknown //@can_get_members True, if members of the channel can be retrieved //@can_set_username True, if channel can be made public //@invite_link Invite link for this channel //@pinned_message_id Identifier of the pinned message in the channel chat, or 0 if none //@migrated_from_group_id Identifier of the group, this supergroup migrated from, or 0 if none //@migrated_from_max_message_id Identifier of last message in the group chat migrated from, or 0 if none -channelFull channel:channel about:string member_count:int administrator_count:int kicked_count:int can_get_members:Bool can_set_username:Bool invite_link:string pinned_message_id:long migrated_from_group_id:int migrated_from_max_message_id:long = ChannelFull; +channelFull description:string member_count:int administrator_count:int restricted_count:int banned_count:int can_get_members:Bool can_set_username:Bool invite_link:string pinned_message_id:int53 migrated_from_group_id:int migrated_from_max_message_id:int53 = ChannelFull; //@description Represents a secret chat @@ -286,23 +313,17 @@ channelFull channel:channel about:string member_count:int administrator_count:in //@state State of the secret chat, 0 - yet not created, 1 - active, 2 - closed //@is_outbound True if chat was created by the current logged in user, false otherwise //@ttl Current message TTL setting for the chat in seconds -//@key_hash Hash of the current used key for comparison with the hash of the interlocutor's key. String of 36 bytes, which should be used to make a 12x12 square image with a color depth of 4. First 16 bytes should be used to make a central 8 * 8 square, left 20 bytes should be used to construct a border of width 2 around that square. -Alternatively first 32 bytes of the hash can be converted to hex and printed as 32 2-digit hex numbers. -secretChat id:int user_id:int state:int is_outbound:Bool ttl:int key_hash:bytes = SecretChat; +//@key_hash Hash of the current used key for comparison with the hash of the interlocutor's key. String of 36 bytes, which should be used to make a 12x12 square image with a color depth of 4. First 16 bytes should be used to make a central 8 * 8 square, left 20 bytes should be used to construct a border of width 2 around that square. Alternatively first 32 bytes of the hash can be converted to hex and printed as 32 2-digit hex numbers +//@layer Secret chat layer, determining features supported by other client. Video notes are supported if layer >= 66 +secretChat id:int user_id:int state:int is_outbound:Bool ttl:int key_hash:bytes layer:int = SecretChat; //@description Contains chat invite link @invite_link Chat invite link chatInviteLink invite_link:string = ChatInviteLink; -//@description Contains information about chat invite link @chat_id Chat identifier of the invite link or 0 if user is not a member of this chat @title Title of the chat @photo Chat photo, nullable @member_count Total member count @members Some chat members that may be known to the current user +//@description Contains information about chat invite link @chat_id Chat identifier of the invite link or 0 if user is not a member of this chat @title Title of the chat @photo Chat photo, nullable @member_count Total member count @member_user_ids User identifiers of some chat members that may be known to the current user //@is_group True, if the chat is a group chat @is_channel True, if the chat is a channel chat @is_public_channel True, if the chat is a channel chat with set up username @is_supergroup_channel True, if the chat is a supergroup channel chat -chatInviteLinkInfo chat_id:long title:string photo:chatPhoto member_count:int members:vector is_group:Bool is_channel:Bool is_public_channel:Bool is_supergroup_channel:Bool = ChatInviteLinkInfo; - - -//@description Contains list of users @total_count Approximate total count of found users @users List of users -users total_count:int users:vector = Users; - -//@description Contains list of channel identifiers @channel_ids List of channel identifiers -channels channel_ids:vector = Channels; +chatInviteLinkInfo chat_id:int53 title:string photo:chatPhoto member_count:int member_user_ids:vector is_group:Bool is_channel:Bool is_public_channel:Bool is_supergroup_channel:Bool = ChatInviteLinkInfo; //@class MessageForwardInfo @description Contains information about initial sender of forwarded message @@ -310,9 +331,9 @@ channels channel_ids:vector = Channels; //@description Message is originally written by known user @sender_user_id Identifier of a user, who originally sent this message @date Date when message was originally sent messageForwardedFromUser sender_user_id:int date:int = MessageForwardInfo; -//@description Message is orifinally a channel post @chat_id Identifier of a chat from which message is forwarded @sender_user_id User identifier of the original message sender, 0 if unknown +//@description Message is orifinally a channel post @chat_id Identifier of a chat from which message is forwarded @author_signature Post author signature //@date Date when message was originally sent @message_id Message identifier of the message from which the message is forwarded, 0 if unknown -messageForwardedPost chat_id:long sender_user_id:int date:int message_id:long = MessageForwardInfo; +messageForwardedPost chat_id:int53 author_signature:string date:int message_id:int53 = MessageForwardInfo; //@class MessageSendState @description Contains information about sending state of the message @@ -332,82 +353,91 @@ messageIsFailedToSend = MessageSendState; //@description Describes message //@id Unique message identifier -//@sender_user_id Identifier of the user who sent the message, 0 if unknown. It can be unknown for channel posts which are not signed by the author +//@sender_user_id Identifier of the user who sent the message, 0 if unknown. It is unknown for channel posts //@chat_id Chat identifier //@send_state Information about sending state of the message //@can_be_edited True, if message can be edited -//@can_be_deleted True, if message can be deleted +//@can_be_forwarded True, if message can be forwarded +//@can_be_deleted_only_for_self True, if message can be deleted only for self, other users will continue to see it +//@can_be_deleted_for_everyone True, if message can be deleted for everyone //@is_post True, if message is channel post. All messages to broadcast channels are posts, all other messages are not posts //@date Date when message was sent, unix time //@edit_date Date when message was edited last time, unix time //@forward_info Information about initial message sender, nullable //@reply_to_message_id If non-zero, identifier of the message this message replies to, can be identifier of deleted message -//@ttl Message TTL for messages in secret chats in seconds, 0 if none. TDLib will send updateDeleteMessages when TTL expires -//@ttl_expires_in Time left for message ttl to expire in seconds +//@ttl Message TTL in seconds, 0 if none. TDLib will send updateDeleteMessages or updateMessageContent when TTL expires +//@ttl_expires_in Time left for message TTL to expire in seconds //@via_bot_user_id If non-zero, user identifier of the bot this message is sent via +//@author_signature For channel posts, optional author signature //@views Number of times this message was viewed //@content Content of the message //@reply_markup Reply markup for the message, nullable -message id:long sender_user_id:int chat_id:long send_state:MessageSendState can_be_edited:Bool can_be_deleted:Bool is_post:Bool date:int edit_date:int forward_info:MessageForwardInfo reply_to_message_id:long ttl:int ttl_expires_in:double via_bot_user_id:int views:int content:MessageContent reply_markup:ReplyMarkup = Message; +message id:int53 sender_user_id:int chat_id:int53 send_state:MessageSendState can_be_edited:Bool can_be_forwarded:Bool can_be_deleted_only_for_self:Bool can_be_deleted_for_everyone:Bool is_post:Bool date:int edit_date:int forward_info:MessageForwardInfo reply_to_message_id:int53 ttl:int ttl_expires_in:double via_bot_user_id:int author_signature:string views:int content:MessageContent reply_markup:ReplyMarkup = Message; //@description Contains list of messages @total_count Approximate total count of found messages @messages List of messages messages total_count:int messages:vector = Messages; +//@description Contains list of found by search messages @messages List of messages @next_from_search_id Value to pass as from_search_id to get more results +foundMessages messages:vector next_from_search_id:long = FoundMessages; + //@class NotificationSettingsScope @description Describes kinds of chat for which notification settings are applied //@description Notification settings applied to particular chat @chat_id Chat identifier -notificationSettingsForChat chat_id:long = NotificationSettingsScope; +notificationSettingsScopeChat chat_id:int53 = NotificationSettingsScope; //@description Notification settings applied to all private chats -notificationSettingsForPrivateChats = NotificationSettingsScope; +notificationSettingsScopePrivateChats = NotificationSettingsScope; //@description Notification settings applied to all group and broadcast channel chats (supergroup channels have no common settings) -notificationSettingsForGroupChats = NotificationSettingsScope; +notificationSettingsScopeGroupChats = NotificationSettingsScope; //@description Notification settings applied to all chats -notificationSettingsForAllChats = NotificationSettingsScope; +notificationSettingsScopeAllChats = NotificationSettingsScope; -//@description Contains information about notification settings for chat or chats @mute_for Time left before notifications will be unmuted @sound Audio file name for notifications, iPhone apps only @show_preview Display message text/media in notification +//@description Contains information about notification settings for chat or chats @mute_for Time left before notifications will be unmuted, seconds @sound Audio file name for notifications, iPhone apps only @show_preview Display message text/media in notification notificationSettings mute_for:int sound:string show_preview:Bool = NotificationSettings; //@description Contains information about draft of a message @reply_to_message_id Identifier of a message to reply to or 0 @input_message_text Content of a draft message, always should be of a type inputMessageText -draftMessage reply_to_message_id:long input_message_text:InputMessageContent = DraftMessage; +draftMessage reply_to_message_id:int53 input_message_text:InputMessageContent = DraftMessage; -//@class ChatInfo @description Describes type of a chat +//@class ChatType @description Describes type of a chat -//@description Ordinary chat with one user @user Information about interlocutor -privateChatInfo user:user = ChatInfo; +//@description Ordinary chat with a user @user_id User identifier +chatTypePrivate user_id:int = ChatType; -//@description Chat with zero or more other users @group Information about the chat -groupChatInfo group:group = ChatInfo; +//@description Chat with zero or more other users @group_id Group identifier +chatTypeGroup group_id:int = ChatType; -//@description Chat with unlimited number of members @channel Information about the chat -channelChatInfo channel:channel = ChatInfo; +//@description Chat with unlimited number of members @channel_id Channel identifier +chatTypeChannel channel_id:int = ChatType; + +//@description Secret chat with a user @secret_chat_id Secret chat identifier +chatTypeSecret secret_chat_id:int = ChatType; -//@description Secret chat with one user @secret_chat Information about the chat -secretChatInfo secret_chat:secretChat = ChatInfo; //@description Chat (private chat or group chat or channel chat) //@id Chat unique identifier +//@type Information about type of the chat //@title Chat title //@photo Chat photo, nullable //@top_message Last message in the chat, nullable -//@order 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 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 True, if the chat is pinned //@unread_count Count of unread messages in the chat //@last_read_inbox_message_id Identifier of last read incoming message //@last_read_outbox_message_id Identifier of last read outgoing message //@notification_settings Notification settings for this chat //@reply_markup_message_id 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 Draft of a message in the chat, nullable. parse_mode in input_message_text always will be null -//@type Information about type of the chat -chat id:long title:string photo:chatPhoto top_message:message order:long unread_count:int last_read_inbox_message_id:long last_read_outbox_message_id:long notification_settings:notificationSettings reply_markup_message_id:long draft_message:draftMessage type:ChatInfo = Chat; +//@client_data 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 +chat id:int53 type:ChatType title:string photo:chatPhoto top_message:message order:long is_pinned:Bool unread_count:int last_read_inbox_message_id:int53 last_read_outbox_message_id:int53 notification_settings:notificationSettings reply_markup_message_id:int53 draft_message:draftMessage client_data:string = Chat; -//@description Contains list of chats @chats List of chats -chats chats:vector = Chats; +//@description Represents list of chats @chat_ids List of chat identifiers +chats chat_ids:vector = Chats; //@class KeyboardButtonType @description Describes type of the keyboard button @@ -440,6 +470,9 @@ inlineKeyboardButtonTypeCallbackGame = InlineKeyboardButtonType; //@description A button which forces inline query to the bot to be substitued in the input field @query Inline query to be sent to the bot @in_current_chat True, if the inline query should be sent from the current chat inlineKeyboardButtonTypeSwitchInline query:string in_current_chat:Bool = InlineKeyboardButtonType; +//@description A button for buying, must be in the first column and row of the keyboard, can be attached only to a message with content of the type messageInvoice +inlineKeyboardButtonTypeBuy = InlineKeyboardButtonType; + //@description Represents one button of the inline keyboard @text Text of the button @type Type of the button inlineKeyboardButton text:string type:InlineKeyboardButtonType = InlineKeyboardButton; @@ -466,16 +499,188 @@ replyMarkupShowKeyboard rows:vector> resize_keyboard:Bool replyMarkupInlineKeyboard rows:vector> = ReplyMarkup; +//@class RichText @description Describes a text inside web page instant view + +//@description Plain text @text The text +richTextPlain text:string = RichText; + +//@description Bold rich text @text The text +richTextBold text:RichText = RichText; + +//@description Italicized rich text @text The text +richTextItalic text:RichText = RichText; + +//@description Underlined rich text @text The text +richTextUnderline text:RichText = RichText; + +//@description Striked through rich text @text The text +richTextStrikethrough text:RichText = RichText; + +//@description Fixed width rich text @text The text +richTextFixed text:RichText = RichText; + +//@description Rich text URL link @text The text @url The URL +richTextUrl text:RichText url:string = RichText; + +//@description Rich text email link @text The text @email The email +richTextEmail text:RichText email:string = RichText; + +//@description Concatenation of rich texts @texts The texts +richTextConcatenation texts:vector = RichText; + + +//@class PageBlock @description Describes a block of web page instant view + +//@description Title of a page @title The title +pageBlockTitle title:RichText = PageBlock; + +//@description Subtitle of a page @subtitle The subtitle +pageBlockSubtitle subtitle:RichText = PageBlock; + +//@description Author and publish date of a page @author The author @publish_date Date of article publish, unix time. 0 if unknown +pageBlockAuthorDate author:RichText publish_date:int = PageBlock; + +//@description A header @header The header +pageBlockHeader header:RichText = PageBlock; + +//@description A subheader @subheader The subheader +pageBlockSubheader subheader:RichText = PageBlock; + +//@description A text paragraph @text Paragraph text +pageBlockParagraph text:RichText = PageBlock; + +//@description Preformatted text paragraph @text Paragraph text @language Programming language for which the text should be formatted +pageBlockPreformatted text:RichText language:string = PageBlock; + +//@description Footer of a page @footer The footer +pageBlockFooter footer:RichText = PageBlock; + +//@description An empty block separating parts of a page +pageBlockDivider = PageBlock; + +//@description Invisible anchor on a page which can be used in a URL to open a page from the specified anchor @name Name of the anchor +pageBlockAnchor name:string = PageBlock; + +//@description List of texts @items Texts @is_ordered True, if items should be marked with numbers +pageBlockList items:vector is_ordered:Bool = PageBlock; + +//@description Block quote @text Quote text @caption Quote caption +pageBlockBlockQuote text:RichText caption:RichText = PageBlock; + +//@description Pull quote @text Quote text @caption Quote caption +pageBlockPullQuote text:RichText caption:RichText = PageBlock; + +//@description An animation @animation The animation, nullable @caption Animation caption @need_autoplay True, if the animation should be autoplayed +pageBlockAnimation animation:animation caption:RichText need_autoplay:Bool = PageBlock; + +//@description An audio @audio The audio, nullable @caption Audio caption +pageBlockAudio audio:audio caption:RichText = PageBlock; + +//@description A photo @photo The photo, nullable @caption Photo caption +pageBlockPhoto photo:photo caption:RichText = PageBlock; + +//@description A video @video The video, nullable @caption Video caption @need_autoplay True, if the video should be autoplayed @is_looped True, if the video is looped +pageBlockVideo video:video caption:RichText need_autoplay:Bool is_looped:Bool = PageBlock; + +//@description Page cover @cover The cover +pageBlockCover cover:PageBlock = PageBlock; + +//@description Embedded web page @url Web page URL, if available @html HTML-markup of the embedded page @poster_photo Poster photo if available, nullable @width Block width @height Block height @caption Block caption @is_full_width True, if the block should be full width @allow_scrolling True, if scrolling should be allowed +pageBlockEmbedded url:string html:string poster_photo:photo width:int height:int caption:RichText is_full_width:Bool allow_scrolling:Bool = PageBlock; + +//@description Embedded post @url Web page URL @author Post author @author_photo Post author photo @date Post date, unix time. 0 if unknown @page_blocks Post content @caption Post caption +pageBlockEmbeddedPost url:string author:string author_photo:photo date:int page_blocks:vector caption:RichText = PageBlock; + +//@description A collage @page_blocks Collage item contents @caption Block caption +pageBlockCollage page_blocks:vector caption:RichText = PageBlock; + +//@description A slideshow @page_blocks Slideshow item contents @caption Block caption +pageBlockSlideshow page_blocks:vector caption:RichText = PageBlock; + +//@description A link to a chat @title Chat title @photo Chat photo, nullable @username Chat username by which all other information about the chat should be resolved +pageBlockChatLink title:string photo:chatPhoto username:string = PageBlock; + + +//@description Describes instant view of a web page @page_blocks Content of the web page @is_full True, if instant view contains full page. Network request may be needed to get full web page instant view +webPageInstantView page_blocks:vector is_full:Bool = WebPageInstantView; + + +//@description Describes web page preview @url Original URL of link @display_url URL to display +//@type Type of web page: article, photo, audio, video, document, profile, app or something other +//@site_name Short name of the site (i.e. Google Docs or App Store) @title Title of the content @param_description Description of the content +//@photo Image representing the content, nullable +//@embed_url Url to show embedded preview +//@embed_type MIME type of embedded preview, i.e. text/html or video/mp4 +//@embed_width Width of embedded preview +//@embed_height Height of embedded preview +//@duration Duration of the content in seconds +//@author Author of the content +//@animation Preview as an Animation if available, nullable +//@audio Preview as an Audio if available, nullable +//@document Preview as a Document if available (currently only for small pdf files and zip archives), nullable +//@sticker Preview as a Sticker for small .webp files if available, nullable +//@video Preview as a Video if available, nullable +//@video_note Preview as a VideoNote if available, nullable +//@voice Preview as a Voice if available, nullable +//@has_instant_view True if web page has instant view +webPage url:string display_url:string type:string site_name:string title:string description:string photo:photo embed_url:string embed_type:string embed_width:int embed_height:int duration:int author:string animation:animation audio:audio document:document sticker:sticker video:video video_note:videoNote voice:voice has_instant_view:Bool = WebPage; + + +//@description Goods price portion @label Portion label @amount Currency amount in minimal quantity of the currency +labeledPrice label:string amount:int53 = LabeledPrice; + +//@description Goods invoice @currency ISO 4217 currency code @prices List of objects used to calculate total price @is_test True, if payment is test @need_name True, if user's name is needed for payment @need_phone_number True, if user's phone number is needed for payment @need_email True, if user's email is needed for payment +//@need_shipping_address True, if user's shipping address is needed for payment @is_flexible True, if total price depends on shipping method +invoice currency:string prices:vector is_test:Bool need_name:Bool need_phone_number:Bool need_email:Bool need_shipping_address:Bool is_flexible:Bool = Invoice; + +//@description Describes shipping address @country_code Two letter ISO 3166-1 alpha-2 country code @state State if applicable @city City @street_line1 First line for the address @street_line2 Second line for the address @post_code Address post code +shippingAddress country_code:string state:string city:string street_line1:string street_line2:string post_code:string = ShippingAddress; + +//@description Order information @name User name @phone_number User's phone number @email User email @shipping_address User shipping address, nullable +orderInfo name:string phone_number:string email:string shipping_address:shippingAddress = OrderInfo; + +//@description One shipping option @id Shipping option identifier @title Option title @prices List of objects used to calculate total shipping price +shippingOption id:string title:string prices:vector = ShippingOption; + +//@description Information about saved card credentials @id Unique identifier of the saved credentials @title Title of the saved credentials +savedCredentials id:string title:string = SavedCredentials; + +//@class InputCredentials @description Contains information about payment method chosen by user + +//@description User chooses previosly saved payment credentials. To use previously saved credentials user should have valid temporary password @saved_credentials_id Identifier of saved credentials +inputCredentialsSaved saved_credentials_id:string = InputCredentials; + +//@description User enters new credentials on payment provider web site @data JSON-encoded data with credentials identifier from the payment provider @allow_save True, if credentials identifier can be saved server-side +inputCredentialsNew data:string allow_save:Bool = InputCredentials; + +//@description Stripe payments provider @publishable_key Stripe API publishable key @need_country True, if user country should be entered @need_zip True, if user zip code should be entered @need_cardholder_name True, if cardholder name should be entered +paymentsProviderStripe publishable_key:string need_country:Bool need_zip:Bool need_cardholder_name:Bool = PaymentsProviderStripe; + +//@description Information about invoice payment form @invoice Full information about the invoice @url Payment form URL @payments_provider Information about payment provider if available, to support it natively without opening the URL, nullable +//@saved_order_info Saved server-side order information, nullable @saved_credentials Information about saved card credentials, nullable @can_save_credentials True, if the user can choose to save credentials @need_password True, if the user will be able to save credentials if he set up a password +paymentForm invoice:invoice url:string payments_provider:paymentsProviderStripe saved_order_info:orderInfo saved_credentials:savedCredentials can_save_credentials:Bool need_password:Bool = PaymentForm; + +//@description Contains temporary identifier of validated order information stored for an hour and available shipping options @order_info_id Temporary identifier of order information @shipping_options Available shipping options +validatedOrderInfo order_info_id:string shipping_options:vector = ValidatedOrderInfo; + +//@description Contains result of a payment query @success True, if payment request was successful. If false, verification_url will be not empty @verification_url Url for additional payments credentials verification +paymentResult success:Bool verification_url:string = PaymentResult; + +//@description Contains information about successful payment @date Payment date, unix time @payments_provider_user_id User identifier of payments provider bot @invoice Information about the invoice +//@order_info Order information, nullable @shipping_option Chosen shipping option, nullable @credentials_title Title of the saved credentials +paymentReceipt date:int payments_provider_user_id:int invoice:invoice order_info:orderInfo shipping_option:shippingOption credentials_title:string = PaymentReceipt; + + //@class MessageContent @description Content of a message //@description Text message @text Text of the message @entities Entities contained in the text @web_page Preview of a web page mentioned in the text, nullable -messageText text:string entities:vector web_page:webPage = MessageContent; +messageText text:string entities:vector web_page:webPage = MessageContent; //@description Animation message @animation Message content @caption Animation caption messageAnimation animation:animation caption:string = MessageContent; -//@description Audio message @audio Message content @caption Audio caption @is_listened True, if the audio message was listened to -messageAudio audio:audio caption:string is_listened:Bool = MessageContent; +//@description Audio message @audio Message content @caption Audio caption +messageAudio audio:audio caption:string = MessageContent; //@description Document message @document Message content @caption Document caption messageDocument document:document caption:string = MessageContent; @@ -483,12 +688,21 @@ messageDocument document:document caption:string = MessageContent; //@description Photo message @photo Message content @caption Photo caption messagePhoto photo:photo caption:string = MessageContent; +//@description Photo message expired by TTL +messageExpiredPhoto = MessageContent; + //@description Sticker message @sticker Message content messageSticker sticker:sticker = MessageContent; //@description Video message @video Message content @caption Video caption messageVideo video:video caption:string = MessageContent; +//@description Video message expired by TTL +messageExpiredVideo = MessageContent; + +//@description Video note message @video_note Message content @is_viewed True, if the video note message was viewed +messageVideoNote video_note:videoNote is_viewed:Bool = MessageContent; + //@description Voice message @voice Message content @caption Voice caption @is_listened True, if the voice message was listened to messageVoice voice:voice caption:string is_listened:Bool = MessageContent; @@ -504,8 +718,16 @@ messageContact contact:contact = MessageContent; //@description Message with a game @game The game messageGame game:game = MessageContent; -//@description New group chat created @title Title of created group chat @members Parcticipants of created group chat -messageGroupChatCreate title:string members:vector = MessageContent; +//@description Message with an invoice from a bot @title Goods title @param_description Goods description @photo Goods photo, nullable @currency Currency for goods price @total_amount Goods total price in minimal quantity of the currency +//@start_parameter Unique invoice bot start_parameter. To share an invoice use a URL https://t.me/{bot_username}?start={start_parameter} @is_test True, if invoice is test +//@need_shipping_address True, if shipping address should be specified @receipt_message_id Identifier of message with receipt after the goods are paid +messageInvoice title:string description:string photo:photo currency:string total_amount:int53 start_parameter:string is_test:Bool need_shipping_address:Bool receipt_message_id:int53 = MessageContent; + +//@description Message with an information about ended call @discard_reason Call discard reason @duration Call duration in seconds +messageCall discard_reason:CallDiscardReason duration:int = MessageContent; + +//@description New group chat created @title Title of created group chat @member_user_ids User identifiers of members of created group chat +messageGroupChatCreate title:string member_user_ids:vector = MessageContent; //@description New channel chat created @title Title of created channel chat messageChannelChatCreate title:string = MessageContent; @@ -519,14 +741,14 @@ messageChatChangePhoto photo:photo = MessageContent; //@description Chat photo deleted messageChatDeletePhoto = MessageContent; -//@description Chat members added @members New chat member -messageChatAddMembers members:vector = MessageContent; +//@description Chat members added @member_user_ids User identifiers of new chat members +messageChatAddMembers member_user_ids:vector = MessageContent; //@description Chat member joined by invite link messageChatJoinByLink = MessageContent; -//@description Chat member deleted @user Left or kicked chat member -messageChatDeleteMember user:user = MessageContent; +//@description Chat member deleted @user_id User identifier of deleted chat memeber +messageChatDeleteMember user_id:int = MessageContent; //@description Group chat is migrated to supergroup channel and deactivated @channel_id Identifier of the channel it is migrated to messageChatMigrateTo channel_id:int = MessageContent; @@ -535,58 +757,68 @@ messageChatMigrateTo channel_id:int = MessageContent; messageChatMigrateFrom title:string group_id:int = MessageContent; //@description Some message was pinned @message_id Identifier of the pinned message, can be identifier of the deleted message -messagePinMessage message_id:long = MessageContent; +messagePinMessage message_id:int53 = MessageContent; -//@description Screenshot of messages in secret chat was taken +//@description Screenshot of messages in the chat was taken messageScreenshotTaken = MessageContent; //@description Messages ttl setting in secret chat has changed @ttl New ttl messageChatSetTtl ttl:int = MessageContent; //@description New high score was achieved in a game @game_message_id Identifier of the message with the game, can be identifier of the deleted message @game_id Identifier of the game, may be different from the games presented in the message with the game @score New score -messageGameScore game_message_id:long game_id:long score:int = MessageContent; +messageGameScore game_message_id:int53 game_id:long score:int = MessageContent; + +//@description Payment completed @currency Currency for goods price @total_amount Goods total price in minimal quantity of the currency +messagePaymentSuccessful currency:string total_amount:int53 = MessageContent; + +//@description Bots only. Payment completed @currency Currency for goods price @total_amount Goods total price in minimal quantity of the currency @invoice_payload Invoice payload @shipping_option_id Identifier of a choosed by user shipping option, may be empty if not applicable @order_info Information about the order, nullable +//@telegram_payment_charge_id Telegram payment identifier @provider_payment_charge_id Provider payment identifier +messagePaymentSuccessfulBot currency:string total_amount:int53 invoice_payload:bytes shipping_option_id:string order_info:orderInfo telegram_payment_charge_id:string provider_payment_charge_id:string = MessageContent; + +//@description Contact has registered +messageContactRegistered = MessageContent; //@description Unsupported message content messageUnsupported = MessageContent; -//@class MessageEntity @description Represent part of the message text which needs to be formatted in some unusual way +//@class TextEntityType @description Represent part of the text which needs to be formatted in some unusual way -//@description Mention of the user by his username @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points -messageEntityMention offset:int length:int = MessageEntity; +//@description Mention of the user by his username +textEntityTypeMention = TextEntityType; -//@description Hashtag beginning with # @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points -messageEntityHashtag offset:int length:int = MessageEntity; +//@description Hashtag beginning with # +textEntityTypeHashtag = TextEntityType; -//@description Bot command beginning with / @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points -messageEntityBotCommand offset:int length:int = MessageEntity; +//@description Bot command beginning with /. It shouldn't be highlighted if there is no bots in the chat +textEntityTypeBotCommand = TextEntityType; -//@description Url beginning with http @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points -messageEntityUrl offset:int length:int = MessageEntity; +//@description Url beginning with http +textEntityTypeUrl = TextEntityType; -//@description Email @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points -messageEntityEmail offset:int length:int = MessageEntity; +//@description Email +textEntityTypeEmail = TextEntityType; -//@description Bold text @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points -messageEntityBold offset:int length:int = MessageEntity; +//@description Bold text +textEntityTypeBold = TextEntityType; -//@description Italic text @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points -messageEntityItalic offset:int length:int = MessageEntity; +//@description Italic text +textEntityTypeItalic = TextEntityType; -//@description Text needs to be formatted as inside of code HTML tag @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points -messageEntityCode offset:int length:int = MessageEntity; +//@description Text needs to be formatted as inside of code HTML tag +textEntityTypeCode = TextEntityType; -//@description Text needs to be formatted as inside of pre HTML tag @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points -messageEntityPre offset:int length:int = MessageEntity; +//@description Text needs to be formatted as inside of pre HTML tag +textEntityTypePre = TextEntityType; -//@description Text needs to be formatted as inside of pre and code HTML tags @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points @language Language of code as defined by sender -messageEntityPreCode offset:int length:int language:string = MessageEntity; +//@description Text needs to be formatted as inside of pre and code HTML tags @language Language of code as defined by sender +textEntityTypePreCode language:string = TextEntityType; -//@description Text description showed instead of the url @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points @url Url to be opened after link will be clicked -messageEntityTextUrl offset:int length:int url:string = MessageEntity; +//@description Text description showed instead of the url @url Url to be opened after link will be clicked +textEntityTypeTextUrl url:string = TextEntityType; -//@description Mention of the user by some text @offset Offset of the entity in UTF-16 code points @length Length of the entity in UTF-16 code points @user_id Identifier of the mentioned user -messageEntityMentionName offset:int length:int user_id:int = MessageEntity; +//@description Mention of the user by some text @user_id Identifier of the mentioned user +textEntityTypeMentionName user_id:int = TextEntityType; //@class TextParseMode @description Describes a way text should be parsed for MessageEntities, by default text is treated as is @@ -600,10 +832,11 @@ textParseModeHTML = TextParseMode; //@class InputThumb @description Thumb to send along with a file, should be in jpeg format or webp format for stickers -//@description Local file with the thumb @path Path to the file with the thumb @width Thumb width, use 0 if unknown @height Thumb height, use 0 if unknown +//@description Local file with the thumb @path Path to the file with the thumb, file should be less than 200KB @width Thumb width, usually shouldn't excceed 90. Use 0 if unknown @height Thumb height, usually shouldn't excceed 90. Use 0 if unknown inputThumbLocal path:string width:int height:int = InputThumb; -//@description Generated thumb @original_path Path to the original file @conversion String specifying conversion applied to the original file, should be persistent across application restart @width Thumb width, use 0 if unknown @height Thumb height, use 0 if unknown +//@description Generated thumb, should be less than 200KB @original_path Path to the original file @conversion String specifying conversion applied to the original file, should be persistent across application restart +//@width Thumb width, usually shouldn't excceed 90. Use 0 if unknown @height Thumb height, usually shouldn't excceed 90. Use 0 if unknown inputThumbGenerated original_path:string conversion:string width:int height:int = InputThumb; @@ -611,12 +844,12 @@ inputThumbGenerated original_path:string conversion:string width:int height:int //@description Text message @text Text to send @disable_web_page_preview Pass true to disable rich preview for link in the message text @clear_draft Pass true if chat draft message should be deleted //@entities Bold, Italic, Code, Pre, PreCode and TextUrl entities contained in the text. Non-bot users can't use TextUrl entities. Can't be used with non-null parse_mode @parse_mode Text parse mode, nullable. Can't be used along with enitities -inputMessageText text:string disable_web_page_preview:Bool clear_draft:Bool entities:vector parse_mode:TextParseMode = InputMessageContent; +inputMessageText text:string disable_web_page_preview:Bool clear_draft:Bool entities:vector parse_mode:TextParseMode = InputMessageContent; -//@description Animation message @animation Animation file to send @thumb Animation thumb, if available @width Width of the animation, may be replaced by the server @height Height of the animation, may be replaced by the server @caption Animation caption, 0-200 characters -inputMessageAnimation animation:InputFile thumb:InputThumb width:int height:int caption:string = InputMessageContent; +//@description Animation message @animation Animation file to send @thumb Animation thumb, if available @duration Duration of the animation in seconds @width Width of the animation, may be replaced by the server @height Height of the animation, may be replaced by the server @caption Animation caption, 0-200 characters +inputMessageAnimation animation:InputFile thumb:InputThumb duration:int width:int height:int caption:string = InputMessageContent; -//@description Audio message @audio Audio file to send @album_cover_thumb Thumb of the album's cover, if available @duration Duration of audio in seconds, may be replaced by the server @title Title of the audio, 0-64 characters, may be replaced by the server +//@description Audio message @audio Audio file to send @album_cover_thumb Thumb of the album's cover, if available @duration Duration of the audio in seconds, may be replaced by the server @title Title of the audio, 0-64 characters, may be replaced by the server //@performer Performer of the audio, 0-64 characters, may be replaced by the server @caption Audio caption, 0-200 characters inputMessageAudio audio:InputFile album_cover_thumb:InputThumb duration:int title:string performer:string caption:string = InputMessageContent; @@ -624,15 +857,20 @@ inputMessageAudio audio:InputFile album_cover_thumb:InputThumb duration:int titl inputMessageDocument document:InputFile thumb:InputThumb caption:string = InputMessageContent; //@description Photo message @photo Photo to send @thumb Photo thumb to send, is sent to the other party in secret chats only @added_sticker_file_ids File identifiers of stickers added onto the photo @width Photo width @height Photo height @caption Photo caption, 0-200 characters -inputMessagePhoto photo:InputFile thumb:InputThumb added_sticker_file_ids:vector width:int height:int caption:string = InputMessageContent; +//@ttl Photo TTL in seconds, 0-60. Non-zero TTL can be only specified in private chats +inputMessagePhoto photo:InputFile thumb:InputThumb added_sticker_file_ids:vector width:int height:int caption:string ttl:int = InputMessageContent; //@description Sticker message @sticker Sticker to send @thumb Sticker thumb, if available @width Sticker width @height Sticker height inputMessageSticker sticker:InputFile thumb:InputThumb width:int height:int = InputMessageContent; -//@description Video message @video Video to send @thumb Video thumb, if available @added_sticker_file_ids File identifiers of stickers added onto the video @duration Duration of video in seconds @width Video width @height Video height @caption Video caption, 0-200 characters -inputMessageVideo video:InputFile thumb:InputThumb added_sticker_file_ids:vector duration:int width:int height:int caption:string = InputMessageContent; +//@description Video message @video Video to send @thumb Video thumb, if available @added_sticker_file_ids File identifiers of stickers added onto the video @duration Duration of the video in seconds @width Video width @height Video height @caption Video caption, 0-200 characters +//@ttl Video TTL in seconds, 0-60. Non-zero TTL can be only specified in private chats +inputMessageVideo video:InputFile thumb:InputThumb added_sticker_file_ids:vector duration:int width:int height:int caption:string ttl:int = InputMessageContent; -//@description Voice message @voice Voice file to send @duration Duration of voice in seconds @waveform Waveform representation of the voice in 5-bit format @caption Voice caption, 0-200 characters +//@description Video note message @video_note Video note to send @thumb Video thumb, if available @duration Duration of the video in seconds @length Video width and height, should be positive and not greater than 640 +inputMessageVideoNote video_note:InputFile thumb:InputThumb duration:int length:int = InputMessageContent; + +//@description Voice message @voice Voice file to send @duration Duration of the voice in seconds @waveform Waveform representation of the voice in 5-bit format @caption Voice caption, 0-200 characters inputMessageVoice voice:InputFile duration:int waveform:bytes caption:string = InputMessageContent; //@description Message with location @location Location to send @@ -647,8 +885,12 @@ inputMessageContact contact:contact = InputMessageContent; //@description Message with a game, can't be used in broadcast channels and secret chats @bot_user_id User identifier of a bot owned the game @game_short_name Game short name inputMessageGame bot_user_id:int game_short_name:string = InputMessageContent; +//@description Message with an invoice, can be used only by bots and in private chats only @invoice The invoice @title Product title, 1-32 characters @param_description Product description, 0-255 characters @photo_url Goods photo URL, optional @photo_size Goods photo size @photo_width Goods photo width @photo_height Goods photo height +//@payload Invoice payload @provider_token Payments provider token @start_parameter Unique invoice bot start_parameter for generation of this invoice +inputMessageInvoice invoice:invoice title:string description:string photo_url:string photo_size:int photo_width:int photo_height:int payload:bytes provider_token:string start_parameter:string = InputMessageContent; + //@description Forwarded message @from_chat_id Chat identifier of the message to forward @message_id Identifier of the message to forward @in_game_share Pass true to share a game message within a launched game, for Game messages only -inputMessageForwarded from_chat_id:long message_id:long in_game_share:Bool = InputMessageContent; +inputMessageForwarded from_chat_id:int53 message_id:int53 in_game_share:Bool = InputMessageContent; //@class SearchMessagesFilter @description Represents filter for content of searched messages @@ -683,31 +925,47 @@ searchMessagesFilterUrl = SearchMessagesFilter; //@description Return only messages containing chat photos searchMessagesFilterChatPhoto = SearchMessagesFilter; +//@description Return only call messages +searchMessagesFilterCall = SearchMessagesFilter; -//@class SendMessageAction @description Notifies about activity in chat +//@description Return only incoming call messages with missed/declined discard reason +searchMessagesFilterMissedCall = SearchMessagesFilter; -//@description User typing message -sendMessageTypingAction = SendMessageAction; -//@description User cancels typing -sendMessageCancelAction = SendMessageAction; +//@description Return only video note messages +searchMessagesFilterVideoNote = SearchMessagesFilter; + +//@description Return only voice and video note messages +searchMessagesFilterVoiceAndVideoNote = SearchMessagesFilter; + + +//@class ChatAction @description Describes different types of activity in a chat + +//@description User typing a message +chatActionTyping = ChatAction; //@description User records a video -sendMessageRecordVideoAction = SendMessageAction; +chatActionRecordingVideo = ChatAction; //@description User uploads a video @progress Upload progress in percents -sendMessageUploadVideoAction progress:int = SendMessageAction; +chatActionUploadingVideo progress:int = ChatAction; //@description User records voice message -sendMessageRecordVoiceAction = SendMessageAction; +chatActionRecordingVoice = ChatAction; //@description User uploads voice message @progress Upload progress in percents -sendMessageUploadVoiceAction progress:int = SendMessageAction; +chatActionUploadingVoice progress:int = ChatAction; //@description User uploads a photo @progress Upload progress in percents -sendMessageUploadPhotoAction progress:int = SendMessageAction; +chatActionUploadingPhoto progress:int = ChatAction; //@description User uploads a document @progress Upload progress in percents -sendMessageUploadDocumentAction progress:int = SendMessageAction; -//@description User sends geolocation -sendMessageGeoLocationAction = SendMessageAction; +chatActionUploadingDocument progress:int = ChatAction; +//@description User chooses location or venue to send +chatActionChoosingLocation = ChatAction; //@description User chooses contact to send -sendMessageChooseContactAction = SendMessageAction; +chatActionChoosingContact = ChatAction; //@description User starts to play a game -sendMessageStartPlayGameAction = SendMessageAction; +chatActionStartPlayingGame = ChatAction; +//@description User records video note +chatActionRecordingVideoNote = ChatAction; +//@description User uploads a video note @progress Upload progress in percents +chatActionUploadingVideoNote progress:int = ChatAction; +//@description User cancels previous action +chatActionCancel = ChatAction; //@class UserStatus @description Describes last time user was online @@ -738,34 +996,95 @@ stickers stickers:vector = Stickers; stickerEmojis emojis:vector = StickerEmojis; //@description Represents sticker set @id Sticker set identifier @title Title of the sticker set @name Name of the sticker set @is_installed True if sticker set is installed by logged in user -//@is_archived True if sticker set is archived @is_official True if sticker set is official @is_masks True if stickers in the set are masks @is_viewed True for viewed trending sticker set @stickers List of stickers in this set @emojis Lists of emojis corresponding to the stickers in the same order +//@is_archived True if sticker set is archived. A sticker set can't be installed and archived simultaneously @is_official True if sticker set is official @is_masks True if stickers in the set are masks +//@is_viewed True for viewed trending sticker set @stickers List of stickers in this set @emojis Lists of emojis corresponding to the stickers in the same order stickerSet id:long title:string name:string is_installed:Bool is_archived:Bool is_official:Bool is_masks:Bool is_viewed:Bool stickers:vector emojis:vector = StickerSet; //@description Represents short information about sticker set @id Sticker set identifier @title Title of the sticker set @name Name of the sticker set @is_installed True if sticker set is installed by logged in user -//@is_archived True if sticker set is archived @is_official True if sticker set is official @is_masks True if stickers in the set are masks @is_viewed True for viewed trending sticker set @size Total number of stickers in the set @covers Up to 5 first stickers from the set depending on the context +//@is_archived True if sticker set is archived. A sticker set can't be installed and archived simultaneously @is_official True if sticker set is official @is_masks True if stickers in the set are masks +//@is_viewed True for viewed trending sticker set @size Total number of stickers in the set @covers Up to 5 first stickers from the set depending on the context. If client needs more stickers it should request full sticker set stickerSetInfo id:long title:string name:string is_installed:Bool is_archived:Bool is_official:Bool is_masks:Bool is_viewed:Bool size:int covers:vector = StickerSetInfo; //@description Represents list of sticker sets @total_count Approximate total count of found sticker sets @sets List of sticker sets stickerSets total_count:int sets:vector = StickerSets; +//@class CallDiscardReason @description Describes reason a call was discarded + +//@description Call wasn't discarded or the reason is unknown +callDiscardReasonEmpty = CallDiscardReason; + +//@description Call has ended before conversation begins. It was cancelled by the caller or was missed by the callee +callDiscardReasonMissed = CallDiscardReason; + +//@description Call has ended before conversation begins. It was declined by the callee +callDiscardReasonDeclined = CallDiscardReason; + +//@description Call has ended during conversation because users was disconnected +callDiscardReasonDisconnected = CallDiscardReason; + +//@description Call was hung up by the caller or by the callee +callDiscardReasonHungUp = CallDiscardReason; + + +//@description Specifies supported call protocols @udp_p2p True, if UDP peer to peer connections are supported @udp_reflector True, if connection through UDP reflectors are supported @min_layer Minimum supported layer, use 65 @max_layer Maximum supported layer, use 65 +callProtocol udp_p2p:Bool udp_reflector:Bool min_layer:int max_layer:int = CallProtocol; + +//@description Describes address of UDP reflectors @id Reflector identifier @ip IPv4 reflector address @ipv6 IPv6 reflector address @port Reflector port @peer_tag Connection peer tag +callConnection id:long ip:string ipv6:string port:int peer_tag:bytes = CallConnection; + + +//@description Contains call identifier @id Call identifier +callId id:int = CallId; + + +//@class CallState @description Describes current call state + +//@description Call is pending for acception by a user @is_created True, if the call is already created by the server @is_received True, if the call is already received by the other party +callStatePending is_created:Bool is_received:Bool = CallState; + +//@description Call is answered and encryption keys are exchanged +callStateExchangingKeys = CallState; + +//@description Call is ready to use @protocol Call protocols supported by the peer @connections Available UDP reflectors @config JSON-encoded call config @encryption_key Call encryption key @emojis Encryption key emojis fingerprint +callStateReady protocol:callProtocol connections:vector config:string encryption_key:bytes emojis:vector = CallState; + +//@description Call is hanging up after discardCall is called +callStateHangingUp = CallState; + +//@description Call has ended successfully @reason A reason, why call has ended @need_rating If true, call rating should be sent to the server @need_debug If true, call debug should be sent to the server +callStateDiscarded reason:CallDiscardReason need_rating:Bool need_debug:Bool = CallState; + +//@description Call has ended with an error @error The error. Error with the code 4005000 returned if an outgoing call is missed because of expired timeout +callStateError error:error = CallState; + + +//@description Describes a call @id Call identifier, not persistent @user_id Peer user identifier @is_outgoing True, if the call is outgoing @state Call state +call id:int user_id:int is_outgoing:Bool state:CallState = Call; + + //@description Represents list of animations @animations Animations animations animations:vector = Animations; +//@description Represent result for ImportContacts request @user_ids User identifiers of imported contacts in the same order as they was specified in the request. 0 if contact is not yet registered +//@importer_count Number of users which imported corresponding contact. 0 for already registered users or if unavailable +importedContacts user_ids:vector importer_count:vector = ImportedContacts; + + //@class InputInlineQueryResult @description Represents one result of the inline query received from the bot //@description Represents link to an animated gif @id Unique identifier of this result @title Title of the result @thumb_url Url of the static result thumb (jpeg or gif), if exists -//@gif_url Url of the gif-file (file size must not exceed 1MB) @gif_width Width of the gif @gif_height Height of the gif +//@gif_url Url of the gif-file (file size must not exceed 1MB) @gif_duration Duration of the gif in seconds @gif_width Width of the gif @gif_height Height of the gif //@reply_markup Message reply markup, should be of type replyMarkupInlineKeyboard or null //@input_message_content Content of the message to be sent, should be of type inputMessageText or inputMessageAnimation or InputMessageLocation or InputMessageVenue or InputMessageContact -inputInlineQueryResultAnimatedGif id:string title:string thumb_url:string gif_url:string gif_width:int gif_height:int reply_markup:ReplyMarkup input_message_content:InputMessageContent = InputInlineQueryResult; +inputInlineQueryResultAnimatedGif id:string title:string thumb_url:string gif_url:string gif_duration:int gif_width:int gif_height:int reply_markup:ReplyMarkup input_message_content:InputMessageContent = InputInlineQueryResult; //@description Represents link to an animated (i.e. without sound) H.264/MPEG-4 AVC video @id Unique identifier of this result @title Title of the result @thumb_url Url of the static result thumb (jpeg or gif), if exists -//@mpeg4_url Url of the mp4-file (file size must not exceed 1MB) @mpeg4_width Width of the video @mpeg4_height Height of the video +//@mpeg4_url Url of the mp4-file (file size must not exceed 1MB) @mpeg4_duration Duration of the video in seconds @mpeg4_width Width of the video @mpeg4_height Height of the video //@reply_markup Message reply markup, should be of type replyMarkupInlineKeyboard or null //@input_message_content Content of the message to be sent, should be of type inputMessageText or inputMessageAnimation or InputMessageLocation or InputMessageVenue or InputMessageContact -inputInlineQueryResultAnimatedMpeg4 id:string title:string thumb_url:string mpeg4_url:string mpeg4_width:int mpeg4_height:int reply_markup:ReplyMarkup input_message_content:InputMessageContent = InputInlineQueryResult; +inputInlineQueryResultAnimatedMpeg4 id:string title:string thumb_url:string mpeg4_url:string mpeg4_duration:int mpeg4_width:int mpeg4_height:int reply_markup:ReplyMarkup input_message_content:InputMessageContent = InputInlineQueryResult; //@description Represents link to an article or web page @id Unique identifier of this result @url Url of the result, if exists @hide_url True, if url must be not shown @title Title of the result //@param_description Short description of the result @thumb_url Url of the result thumb, if exists @thumb_width Thumb width, if known @thumb_height Thumb height, if known @@ -832,17 +1151,17 @@ inputInlineQueryResultVoice id:string title:string voice_url:string voice_durati //@class InlineQueryResult @description Represents one result of the inline query //@description Represents link to an article or web page @id Unique identifier of this result @url Url of the result, if exists @hide_url True, if url must be not shown @title Title of the result -//@param_description Short description of the result @thumb_url Url of the result thumb, if exists @thumb_width Thumb width, if known @thumb_height Thumb height, if known -inlineQueryResultArticle id:string url:string hide_url:Bool title:string description:string thumb_url:string thumb_width:int thumb_height:int = InlineQueryResult; +//@param_description Short description of the result @thumb Result thumb, nullable +inlineQueryResultArticle id:string url:string hide_url:Bool title:string description:string thumb:photoSize = InlineQueryResult; -//@description Represents user contact @id Unique identifier of this result @contact User contact @thumb_url Url of the result thumb, if exists @thumb_width Thumb width, if known @thumb_height Thumb height, if known -inlineQueryResultContact id:string contact:contact thumb_url:string thumb_width:int thumb_height:int = InlineQueryResult; +//@description Represents user contact @id Unique identifier of this result @contact User contact @thumb Result thumb, nullable +inlineQueryResultContact id:string contact:contact thumb:photoSize = InlineQueryResult; -//@description Represents a point on the map @id Unique identifier of this result @location The result @title Title of the result @thumb_url Url of the result thumb, if exists @thumb_width Thumb width, if known @thumb_height Thumb height, if known -inlineQueryResultLocation id:string location:location title:string thumb_url:string thumb_width:int thumb_height:int = InlineQueryResult; +//@description Represents a point on the map @id Unique identifier of this result @location The result @title Title of the result @thumb Result thumb, nullable +inlineQueryResultLocation id:string location:location title:string thumb:photoSize = InlineQueryResult; -//@description Represents information about a venue @id Unique identifier of this result @venue The result @thumb_url Url of the result thumb, if exists @thumb_width Thumb width, if known @thumb_height Thumb height, if known -inlineQueryResultVenue id:string venue:venue thumb_url:string thumb_width:int thumb_height:int = InlineQueryResult; +//@description Represents information about a venue @id Unique identifier of this result @venue The result @thumb Result thumb, nullable +inlineQueryResultVenue id:string venue:venue thumb:photoSize = InlineQueryResult; //@description Represents information about a game @id Unique identifier of this result @game The result inlineQueryResultGame id:string game:game = InlineQueryResult; @@ -876,17 +1195,21 @@ inlineQueryResults inline_query_id:long next_offset:string results:vector = GameHighScores; +//@class ChatEventAction @description Represents a chat event + +//@description A message was edited @old_message Message before edit @new_message Message after edit +chatEventMessageEdited old_message:message new_message:message = ChatEventAction; + +//@description A message was deleted @message Deleted message +chatEventMessageDeleted message:message = ChatEventAction; + +//@description A message was pinned @message Pinned message +chatEventMessagePinned message:message = ChatEventAction; + +//@description A message was unpinned +chatEventMessageUnpinned = ChatEventAction; + +//@description New chat member joined +chatEventMemberJoined = ChatEventAction; + +//@description A chat member left +chatEventMemberLeft = ChatEventAction; + +//@description New chat member invited @user_id New chat member user identifier @status New chat member status +chatEventMemberInvited user_id:int status:ChatMemberStatus = ChatEventAction; + +//@description A chat member promoted to/demoted from administrators @user_id Chat member user identifier @old_status Old chat member status @new_status New chat member status +chatEventMemberPromoted user_id:int old_status:ChatMemberStatus new_status:ChatMemberStatus = ChatEventAction; + +//@description A chat member restricted/unrestircted or banned/unbanned @user_id Chat member user identifier @old_status Old chat member status @new_status New chat member status +chatEventMemberRestricted user_id:int old_status:ChatMemberStatus new_status:ChatMemberStatus = ChatEventAction; + +//@description Chat title changed @old_title Old title value @new_title New title value +chatEventTitleChanged old_title:string new_title:string = ChatEventAction; + +//@description Chat description changed @old_description Old description value @new_description New description value +chatEventDescriptionChanged old_description:string new_description:string = ChatEventAction; + +//@description Chat username changed @old_username Old username value @new_username New username value +chatEventUsernameChanged old_username:string new_username:string = ChatEventAction; + +//@description Chat photo changed @old_photo Old photo value @new_photo New photo value +chatEventPhotoChanged old_photo:chatPhoto new_photo:chatPhoto = ChatEventAction; + +//@description Supergroup channel chat anyone_can_invite setting was toggled @anyone_can_invite New value of anyone_can_invite +chatEventInvitesToggled anyone_can_invite:Bool = ChatEventAction; + +//@description Broadcast channel chat sign_messages setting was toggled @sign_messages New value of sign_messages +chatEventSignMessagesToggled sign_messages:Bool = ChatEventAction; + +//@description Represents a chat event @id Chat event identifier @date Date of the event, unix time @user_id Identifier of a user who made the action @action Action done by the user +chatEvent id:long date:int user_id:int action:ChatEventAction = ChatEvent; + +//@description Contains list of chat events @events The events +chatEvents events:vector = ChatEvents; + +//@description Represents a set of filters used to obtain a chat event log +//@message_edits True, if message edits should be returned +//@message_deletions True, if message deletions should be returned +//@message_pins True, if message pins should be returned +//@member_joins True, if chat member joins should be returned +//@member_leaves True, if chat member leaves should be returned +//@member_invites True, if chat member invites should be returned +//@member_promotions True, if chat member promotions/demotions should be returned +//@member_restrictions True, if chat member restrictions/unrestrictions including bans/unbans should be returned +//@info_changes True, if changes of chat information should be returned +//@setting_changes True, if changes of chat settings should be returned +chatEventLogFilters message_edits:Bool message_deletions:Bool message_pins:Bool member_joins:Bool member_leaves:Bool member_invites:Bool member_promotions:Bool member_restrictions:Bool info_changes:Bool setting_changes:Bool = ChatEventLogFilters; + + //@class DeviceToken @description Represents a token for push notifications -//@description Token for APNS @token The token -apnsDeviceToken token:string = DeviceToken; +//@description Token for APNS @token The token, may be empty to unregister device +deviceTokenApns token:string = DeviceToken; -//@description Token for GCM @token The token -gcmDeviceToken token:string = DeviceToken; +//@description Token for GCM @token The token, may be empty to unregister device +deviceTokenGcm token:string = DeviceToken; -//@description Token for MPNS @token The token -mpnsDeviceToken token:string = DeviceToken; +//@description Token for MPNS @token The token, may be empty to unregister device +deviceTokenMpns token:string = DeviceToken; -//@description Token for simple push @token The token -simplePushDeviceToken token:string = DeviceToken; +//@description Token for simple push @token The token, may be empty to unregister device +deviceTokenSimplePush token:string = DeviceToken; -//@description Token for Ubuntu Push Service @token The token -ubuntuPhoneDeviceToken token:string = DeviceToken; +//@description Token for Ubuntu Push Service @token The token, may be empty to unregister device +deviceTokenUbuntuPhone token:string = DeviceToken; -//@description Token for Blackberry Push Service @token The token -blackberryDeviceToken token:string = DeviceToken; - -//@description Contains list of device tokens @tokens List of tokens -deviceTokenSet tokens:vector = DeviceTokenSet; +//@description Token for Blackberry Push Service @token The token, may be empty to unregister device +deviceTokenBlackberry token:string = DeviceToken; -//@description Contains information about one wallpaper @sizes Available variants of wallpaper of different sizes. These photos can be only downloaded and can't be sent in a message @color Main color of wallpaper in RGB24, should be treated as background color if no photos are specified -wallpaper sizes:vector color:int = Wallpaper; +//@description Contains information about one wallpaper @id Unique persistent wallpaper identifier @sizes Available variants of wallpaper of different sizes. These photos can be only downloaded and can't be sent in a message @color Main color of wallpaper in RGB24, should be treated as background color if no photos are specified +wallpaper id:int sizes:vector color:int = Wallpaper; //@description Contains list of wallpapers @wallpapers List of wallpapers wallpapers wallpapers:vector = Wallpapers; +//@description Contatins list of hashtags @hashtags List of hashtags +hashtags hashtags:vector = Hashtags; + + //@class OptionValue @description Represents value of an option //@description Boolean option @value Value of an option -optionBoolean value:Bool = OptionValue; +optionValueBoolean value:Bool = OptionValue; //@description Unknown option or option having default value -optionEmpty = OptionValue; +optionValueEmpty = OptionValue; //@description Integer option @value Value of an option -optionInteger value:int = OptionValue; +optionValueInteger value:int = OptionValue; //@description String option @value Value of an option -optionString value:string = OptionValue; +optionValueString value:string = OptionValue; //@class PrivacyRule @description Represents one rule for managing privacy settings @@ -971,16 +1362,19 @@ privacyKeyUserStatus = PrivacyKey; //@description Privacy key for managing ability of invitation of the user to chats privacyKeyChatInvite = PrivacyKey; +//@description Privacy key for managing ability to call the user +privacyKeyCall = PrivacyKey; -//@description Contains infotmation about period of inactivity, after which the account of currently logged in user will be automatically deleted @days Number of days of inactivity before account deletion, should be from 30 up to 366 + +//@description Contains information about period of inactivity, after which the account of currently logged in user will be automatically deleted @days Number of days of inactivity before account deletion, should be from 30 and up to 366 accountTtl days:int = AccountTtl; //@description Contains information about one session in some application used by the user @id Session identifier @is_current True, if it is current session @app_id Application identifier, provided by the application @app_name Name of the application, provided by the application //@app_version Version of the application, provided by the application @is_official_app True, if the application is an official application or uses the app_id of some official application @device_model Model of a device application is runned on, provided by the application @platform Operating system application is runned on, provided by the application -//@system_version Version of operating system application is runned on, provided by the application @date_created Date the user has logged in, unix time @date_active Date the session was used last time, unix time @ip An ip address from which session was created in a human-readable format +//@system_version Version of operating system application is runned on, provided by the application @log_in_date Date the user has logged in, unix time @last_active_date Date the session was used last time, unix time @ip An ip address from which session was created in a human-readable format //@country Two-letter country code from which session was created based on the ip @region Region code from which session was created based on the ip -session id:long is_current:Bool app_id:int app_name:string app_version:string is_official_app:Bool device_model:string platform:string system_version:string date_created:int date_active:int ip:string country:string region:string = Session; +session id:long is_current:Bool app_id:int app_name:string app_version:string is_official_app:Bool device_model:string platform:string system_version:string log_in_date:int last_active_date:int ip:string country:string region:string = Session; //@description Contains list of sessions @sessions List of sessions sessions sessions:vector = Sessions; @@ -989,95 +1383,276 @@ sessions sessions:vector = Sessions; //@description Contains information about chat report spam state @can_report_spam If true, prompt with "Report spam" action should be shown to the user chatReportSpamState can_report_spam:Bool = ChatReportSpamState; +//@class ChatReportReason @description Describes a reason, why a chat is reported + +//@description The chat contains spam messages +chatReportReasonSpam = ChatReportReason; + +//@description The chat contains violent messages +chatReportReasonViolence = ChatReportReason; + +//@description The chat contains pornography messages +chatReportReasonPornography = ChatReportReason; + +//@description Other reason provided by the user @text Report text +chatReportReasonOther text:string = ChatReportReason; + + +//@description Contains public HTTPS link to a message in a public channel @url The link +publicMessageLink url:string = PublicMessageLink; + + +//@class FileType @description Represents type of a file + +//@description Data is not a file +fileTypeNone = FileType; + +//@description File is an animation +fileTypeAnimation = FileType; + +//@description File is an audio +fileTypeAudio = FileType; + +//@description File is a document +fileTypeDocument = FileType; + +//@description File is a photo +fileTypePhoto = FileType; + +//@description File is a profile photo +fileTypeProfilePhoto = FileType; + +//@description File sent to a secret chat +fileTypeSecret = FileType; + +//@description File is a sticker +fileTypeSticker = FileType; + +//@description File is a thumbnail of another file +fileTypeThumb = FileType; + +//@description File type is yet unknown +fileTypeUnknown = FileType; + +//@description File is a video +fileTypeVideo = FileType; + +//@description File is a video note +fileTypeVideoNote = FileType; + +//@description File is a voice audio +fileTypeVoice = FileType; + +//@description File is a wallpaper +fileTypeWallpaper = FileType; + +//@description File is a thumbnail of a file from a secret chat +fileTypeSecretThumb = FileType; + + +//@description Contains storage usage statistics for the specific file type @file_type The file type @size Total size of files @count Total number of files +storageStatisticsByFileType file_type:FileType size:int53 count:int = StorageStatisticsByFileType; + +//@description Contains storage usage statistics for the specific chat @chat_id Chat identifier, 0 if none @size Total size of files @count Total number of files @by_file_type Statistics splitted by file types +storageStatisticsByChat chat_id:int53 size:int53 count:int by_file_type:vector = StorageStatisticsByChat; + +//@description Contains exact storage usage statistics splitted by chats and file types @size Total size of files @count Total number of files @by_chat Statistics splitted by chats +storageStatistics size:int53 count:int by_chat:vector = StorageStatistics; + +//@description Contains approximate storage usage statistics, not containing files of Unknown type @files_size Approximate total size of files @files_count Approximate number of files @database_size Size of database +storageStatisticsFast files_size:int53 files_count:int database_size:int53 = StorageStatisticsFast; + + +//@class NetworkType @description Represents type of a network + +//@description Network is not available +networkTypeNone = NetworkType; + +//@description Mobile network +networkTypeMobile = NetworkType; + +//@description Mobile roaming network +networkTypeMobileRoaming = NetworkType; + +//@description Wi-Fi network +networkTypeWiFi = NetworkType; + +//@description Other network type, for example, Ethernet network +networkTypeOther = NetworkType; + + +//@class NetworkStatisticsEntry @description Contains statistics about network usage + +//@description Contains information about total received and sent files data @file_type Type of a file the data is part of @network_type Type of a network the data was sent through. Call setNetworkType to maintain actual network type +//@sent_bytes Total number of sent bytes @received_bytes Total number of received bytes +networkStatisticsEntryFile file_type:FileType network_type:NetworkType sent_bytes:int53 received_bytes:int53 = NetworkStatisticsEntry; + +//@description Contains information about total received and sent calls data @network_type Type of a network the data was sent through. Call setNetworkType to maintain actual network type +//@sent_bytes Total number of sent bytes @received_bytes Total number of received bytes @duration Total calls duration in seconds +networkStatisticsEntryCall network_type:NetworkType sent_bytes:int53 received_bytes:int53 duration:double = NetworkStatisticsEntry; + +//@description Full list of available network statistics entries @since_date Date since which statistics are collected, unix time @entries Network statistics entries +networkStatistics since_date:int entries:vector = NetworkStatistics; + + +//@class ConnectionState @description Describes current state of the connection to Telegram servers + +//@description Waiting for network to be available. Use SetNetworkType to change available network type +connectionStateWaitingForNetwork = ConnectionState; + +//@description Establishing connection to set up proxy server +connectionStateConnectingToProxy = ConnectionState; + +//@description Establishing connection to Telegram servers +connectionStateConnecting = ConnectionState; + +//@description Downloading date received, while client was offline +connectionStateUpdating = ConnectionState; + +//@description There is a working connection to the Telegram servers +connectionStateReady = ConnectionState; + + +//@class TopChatCategory @description Represents categories of chats for which list of frequently used chats can be retrieved + +//@description The category containing private chats with non-bot users +topChatCategoryUsers = TopChatCategory; + +//@description The category containing private chats with bot users +topChatCategoryBots = TopChatCategory; + +//@description The category containing group chats and supergroup channel chats +topChatCategoryGroups = TopChatCategory; + +//@description The category containing broadcast channel chats +topChatCategoryChannels = TopChatCategory; + +//@description The category containing chats with inline bots sorted by their usage in the inline mode +topChatCategoryInlineBots = TopChatCategory; + +//@description The category containing chats frequently used for calls +topChatCategoryCalls = TopChatCategory; + + +//@description Contains some text @text The text +text text:string = Text; + + +//@class Proxy @description Contains information about a proxy server + +//@description An empty proxy +proxyEmpty = Proxy; + +//@description A SOCKS5 proxy @server Proxy server ip address @port Proxy server port @username Username to log in @password Password to log in +proxySocks5 server:string port:int username:string password:string = Proxy; + + +//@description Description of a sticker which should be added to a sticker set @png_sticker Png image with the sticker, must be up to 512 kilobytes in size and fit in 512x512 square @emojis Emojis corresponding to the sticker @mask_position Position where the mask should be placed, nullable +inputSticker png_sticker:InputFile emojis:string mask_position:maskPosition = InputSticker; + //@class Update @description Contains notifications about data changes //@description User authorization state has changed @auth_state New authorization state updateAuthState auth_state:AuthState = Update; -//@description New message received, maybe outcoming message sent from other device @message New message @disable_notification If true, notification about the message should be disabled -updateNewMessage message:message disable_notification:Bool = Update; +//@description New message received, maybe outcoming message sent from other device @message New message @disable_notification If true, notification about the message should be disabled @contains_mention True, if the message contains mention of the current user +updateNewMessage message:message disable_notification:Bool contains_mention:Bool = Update; -//@description Message is successfully sent @message Information about sent message. Usually only message identifier, date and content are changed, but some other fields may also change @old_message_id Previous temporary message identifier -updateMessageSendSucceeded message:message old_message_id:long = Update; +//@description Message send request has reached Telegram server. It doesn't mean that message send will be successful or even that message send request will be processed. Update will not come, unless option "use_quick_ack" is set to true. The update may come many times for the same message +//@chat_id Chat identifier of sent message @message_id Temporary message identifier +updateMessageSendAcknowledged chat_id:int53 message_id:int53 = Update; -//@description Message fails to send. Be aware that some being sent messages can be irrecoverably deleted and updateDeleteMessages will come instead of this update (or doesn't come at all if deletion was done by call to deleteMessages) @chat_id Chat identifier @message_id Message identifier @error_code Error code @error_message Error message -updateMessageSendFailed chat_id:long message_id:long error_code:int error_message:string = Update; +//@description Message is successfully sent @message Information about sent message. Usually only message identifier, date and content are changed, but almost any other fields can also change @old_message_id Previous temporary message identifier +updateMessageSendSucceeded message:message old_message_id:int53 = Update; -//@description Sent message gets new content @chat_id Chat identifier @message_id Message identifier @new_content New message content -updateMessageContent chat_id:long message_id:long new_content:MessageContent = Update; +//@description Message fails to send. Be aware that some being sent messages can be irrecoverably deleted and updateDeleteMessages will come instead of this update +//@message Information about failed to send message @old_message_id Previous temporary message identifier @error_code Error code @error_message Error message +updateMessageSendFailed message:message old_message_id:int53 error_code:int error_message:string = Update; + +//@description Message content has changed @chat_id Chat identifier @message_id Message identifier @new_content New message content +updateMessageContent chat_id:int53 message_id:int53 new_content:MessageContent = Update; //@description Message was edited. Changes in the message content will come in a separate updateMessageContent @chat_id Chat identifier @message_id Message identifier @edit_date Date the message was edited, unix time @reply_markup New message reply markup, nullable -updateMessageEdited chat_id:long message_id:long edit_date:int reply_markup:ReplyMarkup = Update; +updateMessageEdited chat_id:int53 message_id:int53 edit_date:int reply_markup:ReplyMarkup = Update; //@description View count of the message has changed @chat_id Chat identifier @message_id Message identifier @views New value of view count -updateMessageViews chat_id:long message_id:long views:int = Update; +updateMessageViews chat_id:int53 message_id:int53 views:int = Update; -//@description Some date about chat has been changed @chat New data about the chat -updateChat chat:chat = Update; +//@description Message content was opened. It makes voice messages listened, video note messages viewed and runs ttl timer @chat_id Chat identifier @message_id Message identifier +updateOpenMessageContent chat_id:int53 message_id:int53 = Update; -//@description Top message of the chat has changed @chat_id Chat identifier @top_message New top message of the chat, nullable -updateChatTopMessage chat_id:long top_message:message = Update; +//@description New chat has been loaded/created. This update is guaranteed to come before chat identifier is returned to the client. Chat field changes will be reported through separate updates @chat The chat +updateNewChat chat:chat = Update; -//@description Order of the chat in the chat list has changed @chat_id Chat identifier @order New value of the order -updateChatOrder chat_id:long order:long = Update; - -//@description Title of chat was changed @chat_id Chat identifier @title New chat title -updateChatTitle chat_id:long title:string = Update; +//@description Title of the chat was changed @chat_id Chat identifier @title New chat title +updateChatTitle chat_id:int53 title:string = Update; //@description Chat photo was changed @chat_id Chat identifier @photo New chat photo, nullable -updateChatPhoto chat_id:long photo:chatPhoto = Update; +updateChatPhoto chat_id:int53 photo:chatPhoto = Update; + +//@description Top message of the chat has changed. If top_message is null then top message in the chat became unknown. Some new unknown messages might be added to the chat in that case @chat_id Chat identifier @top_message New top message of the chat, nullable +updateChatTopMessage chat_id:int53 top_message:message = Update; + +//@description Order of the chat in the chat list has changed @chat_id Chat identifier @order New value of the order +updateChatOrder chat_id:int53 order:long = Update; + +//@description Chat was pinned or unpinned @chat_id Chat identifier @is_pinned New value of is_pinned +updateChatIsPinned chat_id:int53 is_pinned:Bool = Update; //@description Some incoming messages was read @chat_id Chat identifier @last_read_inbox_message_id Identifier of last read incoming message @unread_count Number of unread messages left in chat -updateChatReadInbox chat_id:long last_read_inbox_message_id:long unread_count:int = Update; +updateChatReadInbox chat_id:int53 last_read_inbox_message_id:int53 unread_count:int = Update; //@description Some outcoming messages was read @chat_id Chat identifier @last_read_outbox_message_id Identifier of last read outgoing message -updateChatReadOutbox chat_id:long last_read_outbox_message_id:long = Update; - -//@description Default chat reply markup has changed. It can happen because new message with reply markup has come or old reply markup was hidden by user -//@chat_id Chat identifier @reply_markup_message_id 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 -updateChatReplyMarkup chat_id:long reply_markup_message_id:long = Update; - -//@description Chat draft has changed. Be aware that the update may come in the currently open chat with the old content of the draft. If the user has changed the content of the draft, the update shouldn't be applied @chat_id Chat identifier @draft_message New chat draft_message, nullable -updateChatDraftMessage chat_id:long draft_message:draftMessage = Update; +updateChatReadOutbox chat_id:int53 last_read_outbox_message_id:int53 = Update; //@description Notification settings for some chats was updated @scope Kinds of chats for which notification settings was updated @notification_settings New notification settings updateNotificationSettings scope:NotificationSettingsScope notification_settings:notificationSettings = Update; -//@description Some messages was deleted @chat_id Chat identifier @message_ids Identifiers of deleted message -updateDeleteMessages chat_id:long message_ids:vector = Update; +//@description Default chat reply markup has changed. It can happen because new message with reply markup has come or old reply markup was hidden by user +//@chat_id Chat identifier @reply_markup_message_id 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 +updateChatReplyMarkup chat_id:int53 reply_markup_message_id:int53 = Update; -//@description Some chat activity @chat_id Chat identifier @user_id Identifier of user doing action @action Action description -updateUserAction chat_id:long user_id:int action:SendMessageAction = Update; +//@description Chat draft has changed. Be aware that the update may come in the currently open chat with the old content of the draft. If the user has changed the content of the draft, the update shouldn't be applied @chat_id Chat identifier @draft_message New chat draft_message, nullable +updateChatDraftMessage chat_id:int53 draft_message:draftMessage = Update; + +//@description Some messages was deleted @chat_id Chat identifier @message_ids Identifiers of deleted message +updateDeleteMessages chat_id:int53 message_ids:vector = Update; + +//@description User activity in the chat has changed @chat_id Chat identifier @user_id Identifier of user doing action @action Action description +updateUserChatAction chat_id:int53 user_id:int action:ChatAction = Update; //@description User went online/offline @user_id User identifier @status New user status updateUserStatus user_id:int status:UserStatus = Update; -//@description Some data about a user has been changed @user New data about the user +//@description Some data about a user has been changed. This update is guaranteed to come before user identifier is returned to the client, if library knows anything about the user @user New data about the user updateUser user:user = Update; -//@description Some data about a group has been changed @group New data about the group +//@description Some data about a group has been changed. This update is guaranteed to come before group identifier is returned to the client, if library knows anything about the group @group New data about the group updateGroup group:group = Update; -//@description Some data about a channel has been changed @channel New data about the channel +//@description Some data about a channel has been changed. This update is guaranteed to come before channel identifier is returned to the client, if library knows anything about the channel @channel New data about the channel updateChannel channel:channel = Update; -//@description Some data about a secret chat has been changed @secret_chat New data about the secret chat +//@description Some data about a secret chat has been changed. This update is guaranteed to come before secret chat identifier is returned to the client, if library knows anything about the secret chat @secret_chat New data about the secret chat updateSecretChat secret_chat:secretChat = Update; -//@description Some data from channelFull has been changed @channel_full New full information about the channel -updateChannelFull channel_full:channelFull = Update; +//@description Some data from userFull has been changed @user_id User identifier @user_full New full information about the user +updateUserFull user_id:int user_full:userFull = Update; -//@description User blocked/unblocked @user_id User identifier @is_blocked Is user blacklisted by current user -updateUserBlocked user_id:int is_blocked:Bool = Update; +//@description Some data from groupFull has been changed @group_id Group identifier @group_full New full information about the group +updateGroupFull group_id:int group_full:groupFull = Update; + +//@description Some data from channelFull has been changed @channel_id Channel identifier @channel_full New full information about the channel +updateChannelFull channel_id:int channel_full:channelFull = Update; //@description Service notification from the server. Upon receiving client should show popup with content of the notification @type Type of the notification @content Notification content updateServiceNotification type:string content:MessageContent = Update; -//@description File is partly downloaded/uploaded @file_id File identifier @size Total file size (0 means unknown) @ready Number of bytes already downloaded/uploaded. Negative number means that download/upload has failed and was terminated +//@description DEPRECATED. Use updateFile instead. File is partly downloaded/uploaded @file_id File identifier @size Total file size (0 means unknown) @ready Number of bytes already downloaded/uploaded. Negative number means that download/upload has failed and was terminated updateFileProgress file_id:int size:int ready:int = Update; -//@description File is downloaded/uploaded @file Synced file +//@description Information about a file was updated @file New data about a file updateFile file:file = Update; //@description File generation process need to be started by the client @generation_id Unique identifier for the generation process @original_path Path to a file from which new file is generated, may be empty @@ -1087,26 +1662,32 @@ updateFileGenerationStart generation_id:long original_path:string destination_pa //@description Informs that a file is being generated @file_id File identifier @size Expected size of the generated file @ready Number of bytes already generated. Negative number means that generation has failed and was terminated updateFileGenerationProgress file_id:int size:int ready:int = Update; -//@description File generation is finished @file Generated file +//@description DEPRECATED. Use updateFile instead. File generation is finished @file Generated file updateFileGenerationFinish file:file = Update; +//@description Information about a call was updated @call New data about a call +updateCall call:call = Update; + //@description Some privacy settings has changed @key Privacy key @rules New privacy rules updatePrivacy key:PrivacyKey rules:privacyRules = Update; //@description Some option changed its value @name Option name @value New option value updateOption name:string value:OptionValue = Update; -//@description List of installed sticker sets was updated @is_masks True, if list of installed mask sticker sets was updated @sticker_set_ids New list of installed sticker sets -updateStickerSets is_masks:Bool sticker_set_ids:vector = Update; +//@description List of installed sticker sets was updated @is_masks True, if list of installed mask sticker sets was updated @sticker_set_ids New list of installed ordinary sticker sets +updateInstalledStickerSets is_masks:Bool sticker_set_ids:vector = Update; //@description List of trending sticker sets was updated or some of them was viewed @sticker_sets New list of trending sticker sets updateTrendingStickerSets sticker_sets:stickerSets = Update; -//@description List of recently used stickers was updated @is_attached True, if the list of stickers attached to photo or video files was updated, otherwise the list of sent stickers is updated @sticker_ids New list of recently used stickers +//@description List of recently used stickers was updated @is_attached True, if the list of stickers attached to photo or video files was updated, otherwise the list of sent stickers is updated @sticker_ids New list of file identifiers of recently used stickers updateRecentStickers is_attached:Bool sticker_ids:vector = Update; -//@description List of saved animations was updated. Need to drop saved animations cache if have some -updateSavedAnimations = Update; +//@description List of saved animations was updated @animation_ids New list of file identifiers of saved animations +updateSavedAnimations animation_ids:vector = Update; + +//@description Connection state has changed @state New connection state +updateConnectionState state:ConnectionState = Update; //@description Bots only. New incoming inline query @id Unique query identifier @sender_user_id Identifier of the user who sent the query @user_location User location, provided by the client, nullable @query Text of the query @offset Offset of the first entry to return updateNewInlineQuery id:long sender_user_id:int user_location:location query:string offset:string = Update; @@ -1116,52 +1697,71 @@ updateNewChosenInlineResult sender_user_id:int user_location:location query:stri //@description Bots only. New incoming callback query @id Unique query identifier @sender_user_id Identifier of the user who sent the query @chat_id Identifier of the chat, in which the query was sent //@message_id Identifier of the message, from which the query is originated @chat_instance Identifier, uniquely corresponding to the chat a message was sent to @payload Query payload -updateNewCallbackQuery id:long sender_user_id:int chat_id:long message_id:long chat_instance:long payload:CallbackQueryPayload = Update; +updateNewCallbackQuery id:long sender_user_id:int chat_id:int53 message_id:int53 chat_instance:long payload:CallbackQueryPayload = Update; //@description Bots only. New incoming callback query from message sent via bot @id Unique query identifier @sender_user_id Identifier of the user who sent the query @inline_message_id Identifier of the inline message, from which the query is originated //@chat_instance Identifier, uniquely corresponding to the chat a message was sent to @payload Query payload updateNewInlineCallbackQuery id:long sender_user_id:int inline_message_id:string chat_instance:long payload:CallbackQueryPayload = Update; +//@description Bots only. New incoming shipping query. Only for invoices with flexible price @id Unique query identifier @sender_user_id Identifier of the user who sent the query @invoice_payload Invoice payload @shipping_address User shipping address +updateNewShippingQuery id:long sender_user_id:int invoice_payload:string shipping_address:shippingAddress = Update; -test.empty = test.Empty; -test.int value:int = test.Int; -test.string value:string = test.String; -test.bytes value:bytes = test.Bytes; -test.vectorInt value:vector = test.VectorInt; -test.vectorIntObject value:vector = test.VectorIntObject; -test.vectorString value:vector = test.VectorString; -test.vectorStringObject value:vector = test.VectorStringObject; +//@description Bots only. New incoming pre-checkout query. Contains full information about checkout @id Unique query identifier @sender_user_id Identifier of the user who sent the query @currency Currency for goods price @total_amount Goods total price in minimal quantity of the currency +//@invoice_payload Invoice payload @shipping_option_id Identifier of a choosed by user shipping option, may be empty if not applicable @order_info Information about the order, nullable +updateNewPreCheckoutQuery id:long sender_user_id:int currency:string total_amount:int53 invoice_payload:bytes shipping_option_id:string order_info:orderInfo = Update; + +//@description Bots only. New incoming event @event JSON-serialized event +updateNewCustomEvent event:string = Update; + +//@description Bots only. New incoming query @id Query identifier @data JSON-serialized query data @timeout Query timeout +updateNewCustomQuery id:long data:string timeout:int = Update; + + +//@description Tests only. A simple object containing just a number @value The number +testInt value:int = TestInt; +//@description Tests only. A simple object containing just a string @value The string +testString value:string = TestString; +//@description Tests only. A simple object containing just a bytes @value The bytes +testBytes value:bytes = TestBytes; +//@description Tests only. A simple object containing just a vector of numbers @value The vector of numbers +testVectorInt value:vector = TestVectorInt; +//@description Tests only. A simple object containing just a vector of objects containing a number @value The vector of objects +testVectorIntObject value:vector = TestVectorIntObject; +//@description Tests only. A simple object containing just a vector of strings @value The vector of strings +testVectorString value:vector = TestVectorString; +//@description Tests only. A simple object containing just a vector of objects containing a string @value The vector of objects +testVectorStringObject value:vector = TestVectorStringObject; ---functions--- //@description Returns current authorization state, offline request getAuthState = AuthState; -//@description Sets user's phone number and sends authentication code to the user. Works only when authGetState returns authStateWaitPhoneNumber. If phone number is not recognized or another error has happened, returns an error. Otherwise returns authStateWaitCode +//@description Sets user's phone number and sends authentication code to the user. Works only when getAuthState returns authStateWaitPhoneNumber. If phone number is not recognized or another error has happened, returns an error. Otherwise returns authStateWaitCode //@phone_number User's phone number in any reasonable format @allow_flash_call Pass True, if code can be sent via flash call to the specified phone number @is_current_phone_number Pass true, if the phone number is used on the current device. Ignored if allow_flash_call is False setAuthPhoneNumber phone_number:string allow_flash_call:Bool is_current_phone_number:Bool = AuthState; -//@description Resends authentication code to the user. Works only when authGetState returns authStateWaitCode and next_code_type of result is not null. Returns authStateWaitCode on success +//@description Resends authentication code to the user. Works only when getAuthState returns authStateWaitCode and next_code_type of result is not null. Returns authStateWaitCode on success resendAuthCode = AuthState; -//@description Checks authentication code. Works only when authGetState returns authStateWaitCode. Returns authStateWaitPassword or authStateOk on success @code Verification code from SMS, Telegram message, voice call or flash call +//@description Checks authentication code. Works only when getAuthState returns authStateWaitCode. Returns authStateWaitPassword or authStateOk on success @code Verification code from SMS, Telegram message, phone call or flash call //@first_name User first name, if user is yet not registered, 1-255 characters @last_name Optional user last name, if user is yet not registered, 0-255 characters checkAuthCode code:string first_name:string last_name:string = AuthState; -//@description Checks password for correctness. Works only when authGetState returns authStateWaitPassword. Returns authStateOk on success @password Password to check +//@description Checks password for correctness. Works only when getAuthState returns authStateWaitPassword. Returns authStateOk on success @password Password to check checkAuthPassword password:string = AuthState; -//@description Requests to send password recovery code to email. Works only when authGetState returns authStateWaitPassword. Returns authStateWaitPassword on success +//@description Requests to send password recovery code to email. Works only when getAuthState returns authStateWaitPassword. Returns authStateWaitPassword on success requestAuthPasswordRecovery = AuthState; -//@description Recovers password with recovery code sent to email. Works only when authGetState returns authStateWaitPassword. Returns authStateOk on success @recovery_code Recovery code to check +//@description Recovers password with recovery code sent to email. Works only when getAuthState returns authStateWaitPassword. Returns authStateOk on success @recovery_code Recovery code to check recoverAuthPassword recovery_code:string = AuthState; //@description Logs out user. If force == false, begins to perform soft log out, returns authStateLoggingOut after completion. If force == true then succeeds almost immediately without cleaning anything at the server, but returns error with code 401 and description "Unauthorized" //@force If true, just delete all local data. Session will remain in list of active sessions resetAuth force:Bool = AuthState; -//@description Check bot's authentication token to log in as a bot. Works only when authGetState returns authStateWaitPhoneNumber. Can be used instead of setAuthPhoneNumber and checkAuthCode to log in. Returns authStateOk on success @token Bot token +//@description Check bot's authentication token to log in as a bot. Works only when getAuthState returns authStateWaitPhoneNumber. Can be used instead of setAuthPhoneNumber and checkAuthCode to log in. Returns authStateOk on success @token Bot token checkAuthBotToken token:string = AuthState; @@ -1184,6 +1784,16 @@ requestPasswordRecovery = PasswordRecoveryInfo; //@description Recovers password with recovery code sent to email @recovery_code Recovery code to check recoverPassword recovery_code:string = PasswordState; +//@description Creates new temporary password for payments processing @password Persistent user password @valid_for Time before temporary password will expire, seconds. Should be between 60 and 86400 +createTemporaryPassword password:string valid_for:int = TemporaryPasswordState; + +//@description Returns information about current temporary password +getTemporaryPasswordState = TemporaryPasswordState; + + +//@description Handles DC_UPDATE push service notification. Can be called before authorization @dc Value of 'dc' paramater of the notification @addr Value of 'addr' parameter of the notification +processDcUpdate dc:string addr:string = Ok; + //@description Returns current logged in user getMe = User; @@ -1210,23 +1820,23 @@ getChannelFull channel_id:int = ChannelFull; getSecretChat secret_chat_id:int = SecretChat; //@description Returns information about a chat by its identifier, offline request if current user is not a bot @chat_id Chat identifier -getChat chat_id:long = Chat; +getChat chat_id:int53 = Chat; //@description Returns information about a message @chat_id Identifier of the chat, message belongs to @message_id Identifier of the message to get -getMessage chat_id:long message_id:long = Message; +getMessage chat_id:int53 message_id:int53 = Message; //@description Returns information about messages. If message is not found, returns null on the corresponding position of the result @chat_id Identifier of the chat, messages belongs to @message_ids Identifiers of the messages to get -getMessages chat_id:long message_ids:vector = Messages; +getMessages chat_id:int53 message_ids:vector = Messages; //@description Returns information about a file, offline request @file_id Identifier of the file to get getFile file_id:int = File; -//@description Returns information about a file by its persistent id, offline request @persistent_file_id Persistent identifier of the file to get -getFilePersistent persistent_file_id:string = File; +//@description Returns information about a file by its persistent id, offline request. May be used to register a URL as a file for further uploading or sending as message @persistent_file_id Persistent identifier of the file to get @file_type File type, if known +getFilePersistent persistent_file_id:string file_type:FileType = File; - -//@description Returns list of chats in the right order, chats are sorted by (order, chat_id) in decreasing order. For example, to get list of chats from the beginning, the offset_order should be equal 2^63 - 1 @offset_order Chat order to return chats from @offset_chat_id Chat identifier to return chats from @limit Maximum number of chats to be returned -getChats offset_order:long offset_chat_id:long limit:int = Chats; +//@description Returns list of chats in the right order, chats are sorted by (order, chat_id) in decreasing order. For example, to get list of chats from the beginning, the offset_order should be equal 2^63 - 1 @offset_order Chat order to return chats from @offset_chat_id Chat identifier to return chats from +//@limit Maximum number of chats to be returned. There may be less than limit chats returned even the end of the list is not reached +getChats offset_order:long offset_chat_id:int53 limit:int = Chats; //@description Searches public chat by its username. Currently only private and channel chats can be public. Returns chat if found, otherwise some error is returned @username Username to be resolved searchPublicChat username:string = Chat; @@ -1237,81 +1847,105 @@ searchPublicChats username_prefix:string = Chats; //@description Searches for specified query in the title and username of known chats, offline request. Returns chats in the order of them in the chat list @query Query to search for, if query is empty, returns up to 20 recently found chats @limit Maximum number of chats to be returned searchChats query:string limit:int = Chats; +//@description Returns a list of frequently used chats. Supported only if chat info database is enabled @category Category of chats to return @limit Maximum number of chats to be returned, at most 30 +getTopChats category:TopChatCategory limit:int = Chats; + +//@description Delete a chat from a list of frequently used chats. Supported only if chat info database is enabled @category Category of frequently used chats @chat_id Chat identifier +deleteTopChat category:TopChatCategory chat_id:int53 = Ok; + //@description Adds chat to the list of recently found chats. The chat is added to the beginning of the list. If the chat is already in the list, at first it is removed from the list @chat_id Identifier of the chat to add -addRecentlyFoundChat chat_id:long = Ok; +addRecentlyFoundChat chat_id:int53 = Ok; //@description Deletes chat from the list of recently found chats @chat_id Identifier of the chat to delete -deleteRecentlyFoundChat chat_id:long = Ok; +deleteRecentlyFoundChat chat_id:int53 = Ok; //@description Clears list of recently found chats deleteRecentlyFoundChats = Ok; //@description Returns list of common chats with an other given user. Chats are sorted by their type and creation date @user_id User identifier @offset_chat_id Chat identifier to return chats from, use 0 for the first request @limit Maximum number of chats to be returned, up to 100 -getCommonChats user_id:int offset_chat_id:long limit:int = Chats; +getCommonChats user_id:int offset_chat_id:int53 limit:int = Chats; + +//@description Returns list of created public chats +getCreatedPublicChats = Chats; -//@description Returns messages in a chat. Automatically calls openChat. Returns result in reverse chronological order, i.e. in order of decreasing message.message_id @chat_id Chat identifier +//@description Returns messages in a chat. Automatically calls openChat. Returns result in reverse chronological order, i.e. in order of decreasing message.message_id. Offline request if only_local is true @chat_id Chat identifier //@from_message_id Identifier of the message near which we need a history, you can use 0 to get results from the beginning, i.e. from oldest to newest //@offset Specify 0 to get results exactly from from_message_id or negative offset to get specified message and some newer messages //@limit Maximum number of messages to be returned, should be positive and can't be greater than 100. If offset is negative, limit must be greater than -offset. There may be less than limit messages returned even the end of the history is not reached -getChatHistory chat_id:long from_message_id:long offset:int limit:int = Messages; +//@only_local Return only locally available messages without sending network requests +getChatHistory chat_id:int53 from_message_id:int53 offset:int limit:int only_local:Bool = Messages; //@description Deletes all messages in the chat. Can't be used for channel chats @chat_id Chat identifier @remove_from_chat_list Pass true, if chat should be removed from the chat list -deleteChatHistory chat_id:long remove_from_chat_list:Bool = Ok; +deleteChatHistory chat_id:int53 remove_from_chat_list:Bool = Ok; -//@description Searches for messages with given words in the chat. Returns result in reverse chronological order, i. e. in order of decreasimg message_id. Doesn't work in secret chats @chat_id Chat identifier to search in -//@query Query to search for @from_message_id Identifier of the message from which we need a history, you can use 0 to get results from beginning @limit Maximum number of messages to be returned, can't be greater than 100 -//@filter Filter for content of searched messages -searchChatMessages chat_id:long query:string from_message_id:long limit:int filter:SearchMessagesFilter = Messages; +//@description Searches for messages with given words in the chat. Returns result in reverse chronological order, i. e. in order of decreasing message_id. Doesn't work in secret chats with non-empty query (searchSecretMessages should be used instead) or without enabled message database @chat_id Chat identifier to search in +//@query Query to search for @sender_user_id If not 0, only messages sent by the specified user will be returned. Doesn't supported in secret chats @from_message_id Identifier of the message from which we need a history, you can use 0 to get results from the beginning +//@limit Maximum number of messages to be returned, can't be greater than 100. There may be less than limit messages returned even the end of the history is not reached @filter Filter for content of searched messages +searchChatMessages chat_id:int53 query:string sender_user_id:int from_message_id:int53 limit:int filter:SearchMessagesFilter = Messages; -//@description Searches for messages in all chats except secret chats. Returns result in reverse chronological order, i. e. in order of decreasing (date, chat_id, message_id) @query Query to search for +//@description Searches for messages in all chats except secret chats. Returns result in reverse chronological order, i. e. in order of decreasing (date, chat_id, message_id) +//@query Query to search for //@offset_date Date of the message to search from, you can use 0 or any date in the future to get results from the beginning //@offset_chat_id Chat identifier of the last found message or 0 for the first request //@offset_message_id Message identifier of the last found message or 0 for the first request -//@limit Maximum number of messages to be returned, can't be greater than 100 -searchMessages query:string offset_date:int offset_chat_id:long offset_message_id:long limit:int = Messages; +//@limit Maximum number of messages to be returned, at most 100 +searchMessages query:string offset_date:int offset_chat_id:int53 offset_message_id:int53 limit:int = Messages; +//@description Searches for messages in secret chats. Returns result in reverse chronological order @chat_id Identifier of a chat to search in. Specify 0 to search in all secret chats @query Query to search for. If empty, searchChatMessages should be used instead +//@from_search_id Identifier from the result of previous request, use 0 to get results from the beginning @limit Maximum number of messages to be returned, can't be greater than 100 @filter Filter for content of searched messages +searchSecretMessages chat_id:int53 query:string from_search_id:long limit:int filter:SearchMessagesFilter = FoundMessages; + +//@description Searches for call messages. Returns result in reverse chronological order, i. e. in order of decreasing message_id @from_message_id Identifier of the message from which to search, you can use 0 to get results from beginning +//@limit Maximum number of messages to be returned, can't be greater than 100. There may be less than limit messages returned even the end of the history is not reached filter @only_missed If true, return only messages with missed calls +searchCallMessages from_message_id:int53 limit:int only_missed:Bool = Messages; + +//@description Returns public HTTPS link to a message. Available only for messages in public channels @chat_id Identifier of the chat, message belongs to @message_id Identifier of the message +getPublicMessageLink chat_id:int53 message_id:int53 = PublicMessageLink; //@description Sends a message. Returns sent message. UpdateChatTopMessage will not be sent, so returned message should be used to update chat top message @chat_id Chat to send message @reply_to_message_id Identifier of a message to reply to or 0 //@disable_notification Pass true, to disable notification about the message, doesn't works in secret chats @from_background Pass true, if the message is sent from background //@reply_markup Bots only. Markup for replying to message @input_message_content Content of a message to send -sendMessage chat_id:long reply_to_message_id:long disable_notification:Bool from_background:Bool reply_markup:ReplyMarkup input_message_content:InputMessageContent = Message; +sendMessage chat_id:int53 reply_to_message_id:int53 disable_notification:Bool from_background:Bool reply_markup:ReplyMarkup input_message_content:InputMessageContent = Message; //@description Invites bot to a chat (if it is not in the chat) and send /start to it. Bot can't be invited to a private chat other than chat with the bot. Bots can't be invited to broadcast channel chats and secret chats. Returns sent message. UpdateChatTopMessage will not be sent, so returned message should be used to update chat top message //@bot_user_id Identifier of the bot @chat_id Identifier of the chat @parameter Hidden parameter sent to bot for deep linking (https://api.telegram.org/bots#deep-linking) -sendBotStartMessage bot_user_id:int chat_id:long parameter:string = Message; +sendBotStartMessage bot_user_id:int chat_id:int53 parameter:string = Message; //@description Sends result of the inline query as a message. Returns sent message. UpdateChatTopMessage will not be sent, so returned message should be used to update chat top message. Always clears chat draft message @chat_id Chat to send message @reply_to_message_id Identifier of a message to reply to or 0 //@disable_notification Pass true, to disable notification about the message, doesn't works in secret chats @from_background Pass true, if the message is sent from background //@query_id Identifier of the inline query @result_id Identifier of the inline result -sendInlineQueryResultMessage chat_id:long reply_to_message_id:long disable_notification:Bool from_background:Bool query_id:long result_id:string = Message; +sendInlineQueryResultMessage chat_id:int53 reply_to_message_id:int53 disable_notification:Bool from_background:Bool query_id:long result_id:string = Message; //@description Forwards previously sent messages. Returns forwarded messages in the same order as message identifiers passed in message_ids. If message can't be forwarded, null will be returned instead of the message. UpdateChatTopMessage will not be sent, so returned messages should be used to update chat top message //@chat_id Identifier of a chat to forward messages @from_chat_id Identifier of a chat to forward from @message_ids Identifiers of messages to forward //@disable_notification Pass true, to disable notification about the message, doesn't works if messages are forwarded to secret chat @from_background Pass true, if the message is sent from background -forwardMessages chat_id:long from_chat_id:long message_ids:vector disable_notification:Bool from_background:Bool = Messages; +forwardMessages chat_id:int53 from_chat_id:int53 message_ids:vector disable_notification:Bool from_background:Bool = Messages; //@description Changes current ttl setting in a secret chat and sends corresponding message @chat_id Chat identifier @ttl New value of ttl in seconds -sendChatSetTtlMessage chat_id:long ttl:int = Message; +sendChatSetTtlMessage chat_id:int53 ttl:int = Message; -//@description Deletes messages. UpdateDeleteMessages will not be sent for messages deleted through that function @chat_id Chat identifier @message_ids Identifiers of messages to delete -deleteMessages chat_id:long message_ids:vector = Ok; +//@description Sends notification about screenshot taken in a chat. Works only in private and secret chats @chat_id Chat identifier +sendChatScreenshotTakenNotification chat_id:int53 = Ok; -//@description Deletes all messages in the chat sent by the specified user. Works only in supergroup channel chats, needs appropriate privileges @chat_id Chat identifier @user_id User identifier -deleteMessagesFromUser chat_id:long user_id:int = Ok; +//@description Deletes messages @chat_id Chat identifier @message_ids Identifiers of messages to delete @revoke Pass true to try to delete sent messages for all chat members (may fail if messages are too old). Is always true for Channels and SecretChats +deleteMessages chat_id:int53 message_ids:vector revoke:Bool = Ok; + +//@description Deletes all messages in the chat sent by the specified user. Works only in supergroup channel chats, needs can_delete_messages administrator privileges @chat_id Chat identifier @user_id User identifier +deleteMessagesFromUser chat_id:int53 user_id:int = Ok; //@description Edits text of text or game message. Non-bots can edit message in a limited period of time. Returns edited message after edit is complete server side //@chat_id Chat the message belongs to @message_id Identifier of the message @reply_markup Bots only. New message reply markup @input_message_content New text content of the message. Should be of type InputMessageText -editMessageText chat_id:long message_id:long reply_markup:ReplyMarkup input_message_content:InputMessageContent = Message; +editMessageText chat_id:int53 message_id:int53 reply_markup:ReplyMarkup input_message_content:InputMessageContent = Message; //@description Edits message content caption. Non-bots can edit message in a limited period of time. Returns edited message after edit is complete server side //@chat_id Chat the message belongs to @message_id Identifier of the message @reply_markup Bots only. New message reply markup @caption New message content caption, 0-200 characters -editMessageCaption chat_id:long message_id:long reply_markup:ReplyMarkup caption:string = Message; +editMessageCaption chat_id:int53 message_id:int53 reply_markup:ReplyMarkup caption:string = Message; //@description Bots only. Edits message reply markup. Returns edited message after edit is complete server side //@chat_id Chat the message belongs to @message_id Identifier of the message @reply_markup New message reply markup -editMessageReplyMarkup chat_id:long message_id:long reply_markup:ReplyMarkup = Message; +editMessageReplyMarkup chat_id:int53 message_id:int53 reply_markup:ReplyMarkup = Message; //@description Bots only. Edits text of an inline text or game message sent via bot @inline_message_id Inline message identifier @reply_markup New message reply markup @input_message_content New text content of the message. Should be of type InputMessageText editInlineMessageText inline_message_id:string reply_markup:ReplyMarkup input_message_content:InputMessageContent = Ok; @@ -1323,32 +1957,40 @@ editInlineMessageCaption inline_message_id:string reply_markup:ReplyMarkup capti editInlineMessageReplyMarkup inline_message_id:string reply_markup:ReplyMarkup = Ok; -//@description Sends inline query to a bot and returns its results. Unavailable for bots @bot_user_id Identifier of the bot send query to @chat_id Identifier of the chat, where the query is sent @user_location User location, only if needed @query Text of the query @offset Offset of the first entry to return -getInlineQueryResults bot_user_id:int chat_id:long user_location:location query:string offset:string = InlineQueryResults; +//@description Sends inline query to a bot and returns its results. Returns error with code 502 if bot fails to answer the query before query timeout expires. Unavailable for bots @bot_user_id Identifier of the bot send query to +//@chat_id Identifier of the chat, where the query is sent @user_location User location, only if needed @query Text of the query @offset Offset of the first entry to return +getInlineQueryResults bot_user_id:int chat_id:int53 user_location:location query:string offset:string = InlineQueryResults; -//@description Bots only. Sets result of the inline query @inline_query_id Identifier of the inline query @is_personal Does result of the query can be cached only for specified user +//@description Bots only. Sets result of an inline query @inline_query_id Identifier of the inline query @is_personal Does result of the query can be cached only for specified user //@results Results of the query @cache_time Allowed time to cache results of the query in seconds @next_offset Offset for the next inline query, pass empty string if there is no more results //@switch_pm_text If non-empty, this text should be shown on the button, which opens private chat with the bot and sends bot start message with parameter switch_pm_parameter @switch_pm_parameter Parameter for the bot start message answerInlineQuery inline_query_id:long is_personal:Bool results:vector cache_time:int next_offset:string switch_pm_text:string switch_pm_parameter:string = Ok; -//@description Sends callback query to a bot and returns answer to it. Unavailable for bots @chat_id Identifier of the chat with a message @message_id Identifier of the message, from which the query is originated @payload Query payload -getCallbackQueryAnswer chat_id:long message_id:long payload:CallbackQueryPayload = CallbackQueryAnswer; +//@description Sends callback query to a bot and returns answer to it. Returns error with code 502 if bot fails to answer the query before query timeout expires. Unavailable for bots @chat_id Identifier of the chat with a message @message_id Identifier of the message, from which the query is originated @payload Query payload +getCallbackQueryAnswer chat_id:int53 message_id:int53 payload:CallbackQueryPayload = CallbackQueryAnswer; -//@description Bots only. Sets result of the callback query @callback_query_id Identifier of the callback query @text Text of the answer @show_alert If true, an alert should be shown to the user instead of a toast @url Url to be opened @cache_time Allowed time to cache result of the query in seconds +//@description Bots only. Sets result of a callback query @callback_query_id Identifier of the callback query @text Text of the answer @show_alert If true, an alert should be shown to the user instead of a toast @url Url to be opened @cache_time Allowed time to cache result of the query in seconds answerCallbackQuery callback_query_id:long text:string show_alert:Bool url:string cache_time:int = Ok; +//@description Bots only. Sets result of a shipping query @shipping_query_id Identifier of the shipping query @shipping_options Available shipping options @error_message Error message, empty on success +answerShippingQuery shipping_query_id:long shipping_options:vector error_message:string = Ok; + +//@description Bots only. Sets result of a pre checkout query @pre_checkout_query_id Identifier of the pre-checkout query @error_message Error message, empty on success +answerPreCheckoutQuery pre_checkout_query_id:long error_message:string = Ok; + + //@description Bots only. Updates game score of the specified user in the game @chat_id Chat a message with the game belongs to @message_id Identifier of the message @edit_message True, if message should be edited @user_id User identifier @score New score //@force Pass True to update the score even if it decreases. If score is 0, user will be deleted from the high scores table -setGameScore chat_id:long message_id:long edit_message:Bool user_id:int score:int force:Bool = Message; +setGameScore chat_id:int53 message_id:int53 edit_message:Bool user_id:int score:int force:Bool = Message; //@description Bots only. Updates game score of the specified user in the game @inline_message_id Inline message identifier @edit_message True, if message should be edited @user_id User identifier @score New score //@force Pass True to update the score even if it decreases. If score is 0, user will be deleted from the high scores table setInlineGameScore inline_message_id:string edit_message:Bool user_id:int score:int force:Bool = Ok; //@description Bots only. Returns game high scores and some part of the score table around of the specified user in the game @chat_id Chat a message with the game belongs to @message_id Identifier of the message @user_id User identifie -getGameHighScores chat_id:long message_id:long user_id:int = GameHighScores; +getGameHighScores chat_id:int53 message_id:int53 user_id:int = GameHighScores; //@description Bots only. Returns game high scores and some part of the score table around of the specified user in the game @inline_message_id Inline message identifier @user_id User identifier getInlineGameHighScores inline_message_id:string user_id:int = GameHighScores; @@ -1356,27 +1998,24 @@ getInlineGameHighScores inline_message_id:string user_id:int = GameHighScores; //@description Deletes default reply markup from chat. This method needs to be called after one-time keyboard or ForceReply reply markup has been used. UpdateChatReplyMarkup will be send if reply markup will be changed @chat_id Chat identifier //@message_id Message identifier of used keyboard -deleteChatReplyMarkup chat_id:long message_id:long = Ok; +deleteChatReplyMarkup chat_id:int53 message_id:int53 = Ok; //@description Sends notification about user activity in a chat @chat_id Chat identifier @action Action description -sendChatAction chat_id:long action:SendMessageAction = Ok; - -//@description Sends notification about screenshot taken in a chat. Works only in secret chats @chat_id Chat identifier -sendChatScreenshotTakenNotification chat_id:long = Ok; +sendChatAction chat_id:int53 action:ChatAction = Ok; //@description Chat is opened by the user. Many useful activities depends on chat being opened or closed. For example, in channels all updates are received only for opened chats @chat_id Chat identifier -openChat chat_id:long = Ok; +openChat chat_id:int53 = Ok; //@description Chat is closed by the user. Many useful activities depends on chat being opened or closed. @chat_id Chat identifier -closeChat chat_id:long = Ok; +closeChat chat_id:int53 = Ok; //@description Messages are viewed by the user. Many useful activities depends on message being viewed. For example, marking messages as read, incrementing of view counter, updating of view counter, removing of deleted messages in channels @chat_id Chat identifier @message_ids Identifiers of viewed messages -viewMessages chat_id:long message_ids:vector = Ok; +viewMessages chat_id:int53 message_ids:vector = Ok; -//@description Message content is opened, for example the user has opened a photo, a video, a document, a location or a venue or have listened to an audio or a voice message @chat_id Chat identifier of the message @message_id Identifier of the message with opened content -openMessageContent chat_id:long message_id:long = Ok; +//@description Message content is opened, for example the user has opened a photo, a video, a document, a location or a venue or have listened to an audio or a voice message. You will receive updateOpenMessageContent if something has changed @chat_id Chat identifier of the message @message_id Identifier of the message with opened content +openMessageContent chat_id:int53 message_id:int53 = Ok; //@description Returns existing chat corresponding to the given user @user_id User identifier @@ -1391,69 +2030,114 @@ createChannelChat channel_id:int = Chat; //@description Returns existing chat corresponding to the known secret chat @secret_chat_id SecretChat identifier createSecretChat secret_chat_id:int = Chat; -//@description Creates new group chat and send corresponding messageGroupChatCreate, returns created chat @user_ids Identifiers of users to add to the group @title Title of new group chat, 0-255 characters +//@description Creates new group chat and send corresponding messageGroupChatCreate, returns created chat @user_ids Identifiers of users to add to the group @title Title of new group chat, 1-255 characters createNewGroupChat user_ids:vector title:string = Chat; -//@description Creates new channel chat and send corresponding messageChannelChatCreate, returns created chat @title Title of new channel chat, 0-255 characters @is_supergroup True, if supergroup chat should be created @about Information about the channel, 0-255 characters -createNewChannelChat title:string is_supergroup:Bool about:string = Chat; +//@description Creates new channel chat and send corresponding messageChannelChatCreate, returns created chat @title Title of new channel chat, 1-255 characters @is_supergroup True, if supergroup chat should be created @param_description Channel description, 0-255 characters +createNewChannelChat title:string is_supergroup:Bool description:string = Chat; //@description Creates new secret chat, returns created chat @user_id Identifier of a user to create secret chat with createNewSecretChat user_id:int = Chat; //@description Creates new channel supergroup chat from existing group chat and send corresponding messageChatMigrateTo and messageChatMigrateFrom. Deactivates group @chat_id Group chat identifier -migrateGroupChatToChannelChat chat_id:long = Chat; +migrateGroupChatToChannelChat chat_id:int53 = Chat; -//@description Changes chat title. Title can't be changed for private chats. Title will not change until change will be synchronized with the server. Title will not be changed if application is killed before it can send request to the server. - There will be update about change of the title on success. Otherwise error will be returned -//@chat_id Chat identifier @title New title of a chat, 0-255 characters -changeChatTitle chat_id:long title:string = Ok; +//@description Changes chat title. Works only for group and channel chats. Requires administrator rights in groups and appropriate administrator right in channels. Title will not change before request to the server completes +//@chat_id Chat identifier @title New title of the chat, 1-255 characters +changeChatTitle chat_id:int53 title:string = Ok; -//@description Changes chat photo. Photo can't be changed for private chats. Photo will not change until change will be synchronized with the server. Photo will not be changed if application is killed before it can send request to the server. - There will be update about change of the photo on success. Otherwise error will be returned @chat_id Chat identifier @photo New chat photo. You can use zero InputFileId to delete photo. Files accessible only by HTTP URL are not acceptable -changeChatPhoto chat_id:long photo:InputFile = Ok; +//@description Changes chat photo. Works only for group and channel chats. Requires administrator rights in groups and appropriate administrator right in channels. Photo will not change before request to the server completes +//@chat_id Chat identifier @photo New chat photo. You can use zero InputFileId to delete chat photo. Files accessible only by HTTP URL are not acceptable +changeChatPhoto chat_id:int53 photo:InputFile = Ok; //@description Changes chat draft message @chat_id Chat identifier @draft_message New draft message, nullable -changeChatDraftMessage chat_id:long draft_message:draftMessage = Ok; +changeChatDraftMessage chat_id:int53 draft_message:draftMessage = Ok; + +//@description Changes chat pinned state. You can pin up to getOption("pinned_chat_count_max") non-secret chats and the same number of secret chats @chat_id Chat identifier @is_pinned New value of is_pinned +toggleChatIsPinned chat_id:int53 is_pinned:Bool = Ok; + +//@description Changes client data associated with a chat @chat_id Chat identifier @client_data New value of client_data +setChatClientData chat_id:int53 client_data:string = Ok; //@description Adds new member to chat. Members can't be added to private or secret chats. Member will not be added until chat state will be synchronized with the server. Member will not be added if application is killed before it can send request to the server //@chat_id Chat identifier @user_id Identifier of the user to add @forward_limit Number of previous messages from chat to forward to new member, ignored for channel chats -addChatMember chat_id:long user_id:int forward_limit:int = Ok; +addChatMember chat_id:int53 user_id:int forward_limit:int = Ok; //@description Adds many new members to the chat. Currently, available only for channels. Can't be used to join the channel. Member will not be added until chat state will be synchronized with the server. Member will not be added if application is killed before it can send request to the server //@chat_id Chat identifier @user_ids Identifiers of the users to add -addChatMembers chat_id:long user_ids:vector = Ok; +addChatMembers chat_id:int53 user_ids:vector = Ok; -//@description Changes status of the chat member, need appropriate privileges. In channel chats, user will be added to chat members if he is yet not a member and there is less than 200 members in the channel. - Status will not be changed until chat state will be synchronized with the server. Status will not be changed if application is killed before it can send request to the server -//@chat_id Chat identifier @user_id Identifier of the user to edit status, bots can be editors in the channel chats @status New status of the member in the chat -changeChatMemberStatus chat_id:long user_id:int status:ChatMemberStatus = Ok; +//@description Changes status of the chat member, need appropriate privileges. This function is currently not suitable for adding new members to the chat, use addChatMember instead. Status will not be changed until chat state will be synchronized with the server. Status will not be changed if application is killed before it can send request to the server +//@chat_id Chat identifier @user_id Identifier of the user to edit status @status New status of the member in the chat +changeChatMemberStatus chat_id:int53 user_id:int status:ChatMemberStatus = Ok; //@description Returns information about one participant of the chat @chat_id Chat identifier @user_id User identifier -getChatMember chat_id:long user_id:int = ChatMember; +getChatMember chat_id:int53 user_id:int = ChatMember; + +//@description Searches for the specified query in the first name, last name and username among members of the specified chat. Requires administrator rights in broadcast channels @chat_id Chat identifier @query Query to search for @limit Maximum number of users to be returned +searchChatMembers chat_id:int53 query:string limit:int = ChatMembers; -//@description Asynchronously downloads file from cloud. Updates updateFileProgress will notify about download progress. Update updateFile will notify about successful download @file_id Identifier of file to download -downloadFile file_id:int = Ok; +//@description Changes list or order of pinned chats @chat_ids New list of pinned chats +setPinnedChats chat_ids:vector = Ok; -//@description Stops file downloading. If file already downloaded do nothing. @file_id Identifier of file to cancel download + +//@description Asynchronously downloads file from cloud. Updates updateFile will notify about download progress and successful download @file_id Identifier of file to download +//@priority Priority of download, 1-32. The higher priority, the earlier file will be downloaded. If priorities of two files are equal then the last one for which downloadFile is called will be downloaded first +downloadFile file_id:int priority:int = Ok; + +//@description Stops file downloading. If file is already downloaded, does nothing @file_id Identifier of file to cancel download cancelDownloadFile file_id:int = Ok; -//@description Next part of a file was generated @generation_id Identifier of the generation process @ready Number of bytes already generated. Negative number means that generation has failed and should be terminated -setFileGenerationProgress generation_id:long ready:int = Ok; +//@description Asynchronously uploads file to the cloud without sending it in a message. Updates updateFile will notify about upload progress and successful upload. The file will not have persistent identifier until it will be sent in a message @file File to upload @file_type File type +//@priority Priority of upload, 1-32. The higher priority, the earlier file will be uploaded. If priorities of two files are equal then the first one for which uploadFile is called will be uploaded first +uploadFile file:InputFile file_type:FileType priority:int = File; + +//@description Stops file uploading. Works only for files uploaded using uploadFile. For other files the behavior is undefined @file_id Identifier of file to cancel upload +cancelUploadFile file_id:int = Ok; + +//@description Next part of a file was generated +//@generation_id Identifier of the generation process +//@size Full size of file in bytes, 0 if unknown. +//@local_size Number of bytes already generated. Negative number means that generation has failed and should be terminated +setFileGenerationProgress generation_id:long size:int local_size:int = Ok; //@description Finishes file generation @generation_id Identifier of the generation process finishFileGeneration generation_id:long = Ok; +//@description Deletes a file from TDLib file cache @file_id Identifier of the file to delete +deleteFile file_id:int = Ok; -//@description Generates new chat invite link, previously generated link is revoked. Available for group and channel chats. Only creator of the chat can export chat invite link @chat_id Chat identifier -exportChatInviteLink chat_id:long = ChatInviteLink; -//@description Checks chat invite link for validness and returns information about the corresponding chat @invite_link Invite link to check. Should begin with "https://telegram.me/joinchat/" +//@description Generates new chat invite link, previously generated link is revoked. Available for group and channel chats. In groups can be called only by creator, in channels requires appropriate rights @chat_id Chat identifier +exportChatInviteLink chat_id:int53 = ChatInviteLink; + +//@description Checks chat invite link for validness and returns information about the corresponding chat @invite_link Invite link to check. Should begin with "https://t.me/joinchat/", "https://telegram.me/joinchat/" or "https://telegram.dog/joinchat/" checkChatInviteLink invite_link:string = ChatInviteLinkInfo; //@description Imports chat invite link, adds current user to a chat if possible. Member will not be added until chat state will be synchronized with the server. Member will not be added if application is killed before it can send request to the server -//@invite_link Invite link to import. Should begin with "https://telegram.me/joinchat/" +//@invite_link Invite link to import. Should begin with "https://t.me/joinchat/", "https://telegram.me/joinchat/" or "https://telegram.dog/joinchat/" importChatInviteLink invite_link:string = Ok; +//@description Creates new call @user_id Identifier of user to call @protocol Description of supported by the client call protocols +createCall user_id:int protocol:callProtocol = CallId; + +//@description Accepts incoming call @call_id Call identifier @protocol Description of supported by the client call protocols +acceptCall call_id:int protocol:callProtocol = Ok; + +//@description Discards a call @call_id Call identifier @is_disconnected True, if users was disconnected @duration Call duration in seconds @connection_id Identifier of a connection used during the call +discardCall call_id:int is_disconnected:Bool duration:int connection_id:long = Ok; + +//@description Sends call rating @call_id Call identifier @rating Call rating, 1-5 @comment Optional user comment if rating is less than 5 +rateCall call_id:int rating:int comment:string = Ok; + +//@description Sends call debug information @call_id Call identifier @debug Debug information in application specific format +debugCall call_id:int debug:string = Ok; + + + //@description Adds user to black list @user_id User identifier blockUser user_id:int = Ok; @@ -1464,8 +2148,8 @@ unblockUser user_id:int = Ok; getBlockedUsers offset:int limit:int = Users; -//@description Adds new contacts/edits existing contacts, contacts user identifiers are ignored. Returns list of corresponding users in the same order as input contacts. If contact doesn't registered in Telegram, user with id == 0 will be returned @contacts List of contacts to import/edit -importContacts contacts:vector = Users; +//@description Adds new contacts/edits existing contacts, contacts user identifiers are ignored @contacts List of contacts to import/edit +importContacts contacts:vector = ImportedContacts; //@description Searches for specified query in the first name, last name and username of the known user contacts @query Query to search for, can be empty to return all contacts @limit Maximum number of users to be returned searchContacts query:string limit:int = Users; @@ -1474,17 +2158,17 @@ searchContacts query:string limit:int = Users; deleteContacts user_ids:vector = Ok; -//@description Returns profile photos of the user. Result of this query can't be invalidated, so it must be used with care @user_id User identifier @offset Photos to skip, must be non-negative @limit Maximum number of photos to be returned, can't be greater than 100 +//@description Returns profile photos of the user. Result of this query may be outdated: some photos may be already deleted @user_id User identifier @offset Photos to skip, must be non-negative @limit Maximum number of photos to be returned, can't be greater than 100 getUserProfilePhotos user_id:int offset:int limit:int = UserProfilePhotos; -//@description Returns stickers corresponding to given emoji @emoji String representation of emoji. If empty, returns all known stickers -getStickers emoji:string = Stickers; +//@description Returns stickers from installed ordinary sticker sets corresponding to the given emoji @emoji String representation of emoji. If empty, returns all known stickers @limit Maximum number of stickers to return +getStickers emoji:string limit:int = Stickers; -//@description Returns list of installed sticker sets without archived sticker sets @is_masks Pass true to return masks, pass false to return stickers -getStickerSets is_masks:Bool = StickerSets; +//@description Returns list of installed sticker sets @is_masks Pass true to return mask sticker sets, pass false to return ordinary sticker sets +getInstalledStickerSets is_masks:Bool = StickerSets; -//@description Returns list of archived sticker sets @is_masks Pass true to return masks, pass false to return stickers @offset_sticker_set_id Identifier of the sticker set from which return the result @limit Maximum number of sticker sets to return +//@description Returns list of archived sticker sets @is_masks Pass true to return mask stickers sets, pass false to return ordinary sticker sets @offset_sticker_set_id Identifier of the sticker set from which return the result @limit Maximum number of sticker sets to return getArchivedStickerSets is_masks:Bool offset_sticker_set_id:long limit:int = StickerSets; //@description Returns list of trending sticker sets @@ -1499,14 +2183,14 @@ getStickerSet set_id:long = StickerSet; //@description Searches sticker set by its short name @name Name of the sticker set searchStickerSet name:string = StickerSet; -//@description Installs/uninstalls or enables/archives sticker set. Official sticker set can't be uninstalled, but it can be archived @set_id Identifier of the sticker set @is_installed New value of is_installed @is_archived New value of is_archived -updateStickerSet set_id:long is_installed:Bool is_archived:Bool = Ok; +//@description Installs/uninstalls or enables/archives sticker set @set_id Identifier of the sticker set @is_installed New value of is_installed @is_archived New value of is_archived. A sticker set can't be installed and archived simultaneously +changeStickerSet set_id:long is_installed:Bool is_archived:Bool = Ok; -//@description Trending sticker sets are viewed by the user @sticker_set_ids Identifiers of viewed trending sticker sets +//@description Informs that some trending sticker sets are viewed by the user @sticker_set_ids Identifiers of viewed trending sticker sets viewTrendingStickerSets sticker_set_ids:vector = Ok; -//@description Changes the order of installed sticker sets @is_masks Pass true to change masks order, pass false to change stickers order @sticker_set_ids Identifiers of installed sticker sets in the new right order -reorderStickerSets is_masks:Bool sticker_set_ids:vector = Ok; +//@description Changes the order of installed sticker sets @is_masks Pass true to change mask sticker sets order, pass false to change ordinary sticker sets order @sticker_set_ids Identifiers of installed sticker sets in the new right order +reorderInstalledStickerSets is_masks:Bool sticker_set_ids:vector = Ok; //@description Returns list of recently used stickers @is_attached Pass true to return stickers and masks recently attached to photo or video files, pass false to return recently sent stickers getRecentStickers is_attached:Bool = Stickers; @@ -1540,9 +2224,19 @@ deleteSavedAnimation animation:InputFile = Ok; getRecentInlineBots = Users; -//@description Get web page preview by text of the message. Do not call this function to often @message_text Message text +//@description Searches for recently used hashtags by their prefix @prefix Hashtag prefix to search for @limit Maximum number of hashtags to return +searchHashtags prefix:string limit:int = Hashtags; + +//@description Deletes a hashtag from the list of recently used hashtags @hashtag The hashtag to delete +deleteRecentHashtag hashtag:string = Ok; + + +//@description Returns web page preview by text of the message. Do not call this function to often. Returns error 404 if web page has no preview @message_text Message text getWebPagePreview message_text:string = WebPage; +//@description Returns web page instant view if available. Returns error 404 if web page has no instant view @url Web page URL @force_full If true, full web page instant view will be returned +getWebPageInstantView url:string force_full:Bool = WebPageInstantView; + //@description Returns notification settings for a given scope @scope Scope to return information about notification settings getNotificationSettings scope:NotificationSettingsScope = NotificationSettings; @@ -1555,8 +2249,8 @@ setNotificationSettings scope:NotificationSettingsScope notification_settings:no resetAllNotificationSettings = Ok; -//@description Uploads new profile photo for logged in user. Photo will not change until change will be synchronized with the server. Photo will not be changed if application is killed before it can send request to the server. If something changes, updateUser will be sent @photo_path Path to new profile photo -setProfilePhoto photo_path:string = Ok; +//@description Uploads new profile photo for logged in user. Photo will not change until change will be synchronized with the server. Photo will not be changed if application is killed before it can send request to the server. If something changes, updateUser will be sent @photo Profile photo to set. inputFileId and inputFilePersistentId may be unsupported +setProfilePhoto photo:InputFile = Ok; //@description Deletes profile photo. If something changes, updateUser will be sent @profile_photo_id Identifier of profile photo to delete deleteProfilePhoto profile_photo_id:long = Ok; @@ -1564,7 +2258,7 @@ deleteProfilePhoto profile_photo_id:long = Ok; //@description Changes first and last names of logged in user. If something changes, updateUser will be sent @first_name New value of user first name, 1-255 characters @last_name New value of optional user last name, 0-255 characters changeName first_name:string last_name:string = Ok; -//@description Changes about information of logged in user @about New value of userFull.about, 0-255 characters +//@description Changes about information of logged in user @about New value of userFull.about, 0-70 characters without line feeds changeAbout about:string = Ok; //@description Changes username of logged in user. If something changes, updateUser will be sent @username New value of username. Use empty string to remove username @@ -1577,7 +2271,7 @@ changePhoneNumber phone_number:string allow_flash_call:Bool is_current_phone_num //@description Resends authentication code sent to change user's phone number. Wotks only if in previously received authStateWaitCode next_code_type was not null. Returns authStateWaitCode on success resendChangePhoneNumberCode = AuthState; -//@description Checks authentication code sent to change user's phone number. Returns authStateOk on success @code Verification code from SMS, voice call or flash call +//@description Checks authentication code sent to change user's phone number. Returns authStateOk on success @code Verification code from SMS, phone call or flash call checkChangePhoneNumberCode code:string = AuthState; @@ -1591,46 +2285,72 @@ terminateSession session_id:long = Ok; terminateAllOtherSessions = Ok; -//@description Gives or revokes all members of the group editor rights. Needs creator privileges in the group @group_id Identifier of the group @anyone_can_edit New value of anyone_can_edit -toggleGroupEditors group_id:int anyone_can_edit:Bool = Ok; +//@description Gives or revokes all members of the group administrator rights. Needs creator privileges in the group @group_id Identifier of the group @everyone_is_administrator New value of everyone_is_administrator +toggleGroupAdministrators group_id:int everyone_is_administrator:Bool = Ok; //@description Changes username of the channel. Needs creator privileges in the channel @channel_id Identifier of the channel @username New value of username. Use empty string to remove username changeChannelUsername channel_id:int username:string = Ok; -//@description Gives or revokes right to invite new members to all current members of the channel. Needs creator privileges in the channel. Available only for supergroups @channel_id Identifier of the channel @anyone_can_invite New value of anyone_can_invite +//@description Gives or revokes right to invite new members to all current members of the channel. Needs appropriate rights in the channel. Available only for supergroups @channel_id Identifier of the channel @anyone_can_invite New value of anyone_can_invite toggleChannelInvites channel_id:int anyone_can_invite:Bool = Ok; -//@description Enables or disables sender signature on sent messages in the channel. Needs creator privileges in the channel. Not available for supergroups @channel_id Identifier of the channel @sign_messages New value of sign_messages +//@description Enables or disables sender signature on sent messages in the channel. Needs appropriate rights in the channel. Not available for supergroups @channel_id Identifier of the channel @sign_messages New value of sign_messages toggleChannelSignMessages channel_id:int sign_messages:Bool = Ok; -//@description Changes information about the channel. Needs creator privileges in the broadcast channel or editor privileges in the supergroup channel @channel_id Identifier of the channel @about New value of about, 0-255 characters -changeChannelAbout channel_id:int about:string = Ok; +//@description Changes information about the channel. Needs appropriate rights in the channel @channel_id Identifier of the channel @param_description New channel description, 0-255 characters +changeChannelDescription channel_id:int description:string = Ok; -//@description Pins a message in a supergroup channel chat. Needs editor privileges in the channel @channel_id Identifier of the channel @message_id Identifier of the new pinned message @disable_notification True, if there should be no notification about the pinned message -pinChannelMessage channel_id:int message_id:long disable_notification:Bool = Ok; +//@description Pins a message in a supergroup channel chat. Needs appropriate rights in the channel @channel_id Identifier of the channel @message_id Identifier of the new pinned message @disable_notification True, if there should be no notification about the pinned message +pinChannelMessage channel_id:int message_id:int53 disable_notification:Bool = Ok; -//@description Removes pinned message in the supergroup channel. Needs editor privileges in the channel @channel_id Identifier of the channel +//@description Removes pinned message in the supergroup channel. Needs appropriate rights in the channel @channel_id Identifier of the channel unpinChannelMessage channel_id:int = Ok; //@description Reports some supergroup channel messages from a user as spam messages @channel_id Channel identifier @user_id User identifier @message_ids Identifiers of messages sent in the supergroup by the user, the list should be non-empty -reportChannelSpam channel_id:int user_id:int message_ids:vector = Ok; +reportChannelSpam channel_id:int user_id:int message_ids:vector = Ok; -//@description Returns information about channel members or kicked from channel users. Can be used only if channel_full->can_get_members == true @channel_id Identifier of the channel +//@description Returns information about channel members or banned users. Can be used only if channel_full->can_get_members == true. Administrator privileges may be additionally needed for some filters @channel_id Identifier of the channel //@filter Kind of channel users to return, defaults to channelMembersRecent @offset Number of channel users to skip @limit Maximum number of users be returned, can't be greater than 200 getChannelMembers channel_id:int filter:ChannelMembersFilter offset:int limit:int = ChatMembers; //@description Deletes channel along with all messages in corresponding chat. Releases channel username and removes all members. Needs creator privileges in the channel. Channels with more than 1000 members can't be deleted @channel_id Identifier of the channel deleteChannel channel_id:int = Ok; -//@description Returns list of created public channels -getCreatedPublicChannels = Channels; - //@description Closes secret chat @secret_chat_id Secret chat identifier closeSecretChat secret_chat_id:int = Ok; +//@description Returns list of service actions taken by chat members and administrators in the last 48 hours, available only in channels. Requires administrator rights. Returns result in reverse chronological order, i. e. in order of decreasing event_id +//@chat_id Chat identifier @query Search query to filter events @from_event_id Identifier of an event from which to return result, you can use 0 to get results from the latest events @limit Maximum number of events to return, can't be greater than 100 +//@filters Types of events to return, defaults to all @user_ids User identifiers, which events to return, defaults to all users +getChatEventLog chat_id:int53 query:string from_event_id:long limit:int filters:chatEventLogFilters user_ids:vector = ChatEvents; + + +//@description Returns invoice payment form. The method should be called when user presses inlineKeyboardButtonBuy @chat_id Chat identifier of the Invoice message @message_id Message identifier +getPaymentForm chat_id:int53 message_id:int53 = PaymentForm; + +//@description Validates order information provided by the user and returns available shipping options for flexible invoice @chat_id Chat identifier of the Invoice message @message_id Message identifier @order_info Order information, provided by the user @allow_save True, if order information can be saved +validateOrderInfo chat_id:int53 message_id:int53 order_info:orderInfo allow_save:Bool = ValidatedOrderInfo; + +//@description Sends filled payment form to the bot for the final verification @chat_id Chat identifier of the Invoice message @message_id Message identifier @order_info_id Identifier returned by ValidateOrderInfo or empty string @shipping_option_id Identifier of a chosen shipping option, if applicable +//@credentials Credentials choosed by user for payment +sendPaymentForm chat_id:int53 message_id:int53 order_info_id:string shipping_option_id:string credentials:InputCredentials = PaymentResult; + +//@description Returns information about successful payment @chat_id Chat identifier of the PaymentSuccessful message @message_id Message identifier +getPaymentReceipt chat_id:int53 message_id:int53 = PaymentReceipt; + +//@description Returns saved order info if any +getSavedOrderInfo = OrderInfo; + +//@description Deletes saved order info +deleteSavedOrderInfo = Ok; + +//@description Deletes saved credentials for all payments provider bots +deleteSavedCredentials = Ok; + + //@description Returns user that can be contacted to get support getSupportUser = User; @@ -1641,9 +2361,6 @@ getWallpapers = Wallpapers; //@description Registers current used device for receiving push notifications @device_token Device token registerDevice device_token:DeviceToken = Ok; -//@description Returns list of used device tokens -getDeviceTokens = DeviceTokenSet; - //@description Changes privacy settings @key Privacy key @rules New privacy rules setPrivacy key:PrivacyKey rules:privacyRules = Ok; @@ -1652,11 +2369,11 @@ setPrivacy key:PrivacyKey rules:privacyRules = Ok; getPrivacy key:PrivacyKey = PrivacyRules; -//@description Returns value of an option by its name. See list of available options on https://core.telegram.org/tdlib/options +//@description Returns value of an option by its name. See list of available options on https://core.telegram.org/tdlib/options. Can be called before authorization //@name Name of the option getOption name:string = OptionValue; -//@description Sets value of an option. See list of available options on https://core.telegram.org/tdlib/options. Only writable options can be set +//@description Sets value of an option. See list of available options on https://core.telegram.org/tdlib/options. Only writable options can be set. Can be called before authorization //@name Name of the option @value New value of the option setOption name:string value:OptionValue = Ok; @@ -1672,29 +2389,113 @@ deleteAccount reason:string = Ok; //@description Returns current chat report spam state @chat_id Chat identifier -getChatReportSpamState chat_id:long = ChatReportSpamState; +getChatReportSpamState chat_id:int53 = ChatReportSpamState; //@description Reports chat as a spam chat or as not a spam chat. Can be used only if ChatReportSpamState.can_report_spam is true. After this request ChatReportSpamState.can_report_spam became false forever @chat_id Chat identifier @is_spam_chat If true, chat will be reported as a spam chat, otherwise it will be marked as not a spam chat -changeChatReportSpamState chat_id:long is_spam_chat:Bool = Ok; +changeChatReportSpamState chat_id:int53 is_spam_chat:Bool = Ok; + +//@description Reports chat to Telegram moderators. Can be used only for a channel chat or a private chat with a bot, because all other chats can't be checked by moderators @chat_id Chat identifier @reason Reason, the chat is reported +reportChat chat_id:int53 reason:ChatReportReason = Ok; + + +//@description Returns storage usage statistics @chat_limit Maximum number of chats with biggest storage usage for which separate statistics should be returned. All other chats will be grouped in entries with chat_id == 0. If chat info database is not used, chat_limit is ignored and is always set to 0 +getStorageStatistics chat_limit:int = StorageStatistics; + +//@description Quickly returns approximate storage usage statistics +getStorageStatisticsFast = StorageStatisticsFast; + +//@description Optimizes storage usage, i.e. deletes some files and return new storage usage statistics. Secret thumbnails can't be deleted +//@size Limit on total size of files after deletion. Pass -1 to use default limit +//@ttl Limit on time passed since last access time (or creation time on some filesystems) to a file. Pass -1 to use default limit +//@count Limit on total count of files after deletion. Pass -1 to use default limit +//@immunity_delay Number of seconds after creation of a file, it can't be delited. Pass -1 to use default value +//@file_types If not empty, only files with given types are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted +//@chat_ids If not empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat, for example profile photos +//@exclude_chat_ids If not empty, files from the given chats are exluded. Use 0 as chat identifier to exclude all files not belonging to any chat, for example profile photos +//@chat_limit Same as in getStorageStatistics. Affects only returned statistics +optimizeStorage size:int53 ttl:int count:int immunity_delay:int file_types:vector chat_ids:vector exclude_chat_ids:vector chat_limit:int = StorageStatistics; + + +//@description Sets current network type. Can be called before authorization. Call to this method forces reopening of all network connections mitigating delay in switching between different networks, so it should be called whenever network is changed even network type remains the same. Network type is used to check if library can use network at all and for collecting detailed network data usage statistics @type New network type, defaults to networkTypeNone +setNetworkType type:NetworkType = Ok; + +//@description Returns network data usage statistics. Can be called before authorization @only_current If true, returns only data for the current library launch +getNetworkStatistics only_current:Bool = NetworkStatistics; + +//@description Adds specified data to data usage statistics. Can be called before authorization @entry Network statistics entry with a data to add to statistics +addNetworkStatistics entry:NetworkStatisticsEntry = Ok; + +//@description Resets all network data usage statistics to zero. Can be called before authorization +resetNetworkStatistics = Ok; //@description Bots only. Informs server about number of pending bot updates if they aren't processed for a long time @pending_update_count Number of pending updates @error_message Last error's message setBotUpdatesStatus pending_update_count:int error_message:string = Ok; -//@description Returns Ok after specified amount of the time passed @seconds Number of seconds before that function returns +//@description Bots only. Uploads a png image with a sticker. Returns uploaded file @user_id Sticker file owner @png_sticker Png image with the sticker, must be up to 512 kilobytes in size and fit in 512x512 square +uploadStickerFile user_id:int png_sticker:InputFile = File; + +//@description Bots only. Creates new sticker set. Returns created sticker set @user_id Sticker set owner @title Sticker set title, 1-64 characters @name Sticker set name. Can contain only english letters, digits and underscores. Should end on *"_by_"*. ** is case insensitive, 1-64 characters +//@is_masks True, is stickers are masks @stickers List of stickers to add to the set +createNewStickerSet user_id:int title:string name:string is_masks:Bool stickers:vector = StickerSet; + +//@description Bots only. Adds new sticker to a set. Returns the sticker set @user_id Sticker set owner @name Sticker set name @sticker Sticker to add to the set +addStickerToSet user_id:int name:string sticker:inputSticker = StickerSet; + +//@description Bots only. Changes position of a sticker in the set it belongs to. Sticker set should be created by the bot @sticker The sticker @position New sticker position in the set, zero-based +setStickerPositionInSet sticker:InputFile position:int = Ok; + +//@description Bots only. Deletes a sticker from the set it belongs to. Sticker set should be created by the bot @sticker The sticker +deleteStickerFromSet sticker:InputFile = Ok; + + +//@description Bots only. Sends custom request @method Method name @parameters JSON-serialized method parameters +sendCustomRequest method:string parameters:string = CustomRequestResult; + +//@description Bots only. Answers a custom query @custom_query_id Identifier of a custom query @data JSON-serialized answer to the query +answerCustomQuery custom_query_id:long data:string = Ok; + + +//@description Returns Ok after specified amount of the time passed. Can be called before authorization @seconds Number of seconds before that function returns setAlarm seconds:double = Ok; -test.callEmpty = test.Empty; -test.squareInt x:int = test.Int; -test.callString x:string = test.String; -test.callBytes x:bytes = test.Bytes; -test.callVectorInt x:%Vector = test.VectorInt; -test.callVectorIntObject x:%Vector = test.VectorIntObject; -test.callVectorString x:%Vector = test.VectorString; -test.callVectorStringObject x:%Vector = test.VectorStringObject; +//@description Returns invite text for invitation of new users +getInviteText = Text; -test.testNet = test.Empty; -test.forceGetDifference = Ok; +//@description Returns terms of service. Can be called before authorization +getTermsOfService = Text; + +//@description Sets proxy server for network requests. Can be called before authorization @proxy The proxy to use. You can specify null to remove proxy server +setProxy proxy:Proxy = Ok; + +//@description Returns current set up proxy. Can be called before authorization +getProxy = Proxy; + + +//@description Test request. Does nothing +testCallEmpty = Ok; +//@description Test request. Returns back received string @x String to return +testCallString x:string = TestString; +//@description Test request. Returns back received bytes @x Bytes to return +testCallBytes x:bytes = TestBytes; +//@description Test request. Returns back received vector of numbers @x Vector of numbers to return +testCallVectorInt x:vector = TestVectorInt; +//@description Test request. Returns back received vector of objects containing a number @x Vector of objects to return +testCallVectorIntObject x:vector = TestVectorIntObject; +//@description Test request. Returns back received vector of strings @x Vector of strings to return +testCallVectorString x:vector = TestVectorString; +//@description Test request. Returns back received vector of objects containing a string @x Vector of objects to return +testCallVectorStringObject x:vector = TestVectorStringObject; +//@description Test request. Returns squared received number @x Number to square +testSquareInt x:int = TestInt; +//@description Test request. Sends simple network request to telegram servers +testNetwork = Ok; +//@description Test request. Forces updates.getDifference call to telegram servers +testGetDifference = Ok; +//@description Test request. Does nothing, ensures that the Update object is used +testUseUpdate = Update; +//@description Test request. Does nothing, ensures that the Error object is used +testUseError = Error;