diff --git a/docs/API_docs/constructors/contacts_topPeersDisabled.md b/docs/API_docs/constructors/contacts_topPeersDisabled.md new file mode 100644 index 00000000..51c22ad0 --- /dev/null +++ b/docs/API_docs/constructors/contacts_topPeersDisabled.md @@ -0,0 +1,38 @@ +--- +title: contacts.topPeersDisabled +description: contacts_topPeersDisabled attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contacts.topPeersDisabled +[Back to constructors index](index.md) + + + + + + +### Type: [contacts\_TopPeers](../types/contacts_TopPeers.md) + + +### Example: + +``` +$contacts_topPeersDisabled = ['_' => 'contacts.topPeersDisabled']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contacts.topPeersDisabled"} +``` + + +Or, if you're into Lua: + + +``` +contacts_topPeersDisabled={_='contacts.topPeersDisabled'} + +``` + + diff --git a/docs/API_docs/constructors/inputWebFileGeoPointLocation.md b/docs/API_docs/constructors/inputWebFileGeoPointLocation.md new file mode 100644 index 00000000..8f9fb0da --- /dev/null +++ b/docs/API_docs/constructors/inputWebFileGeoPointLocation.md @@ -0,0 +1,48 @@ +--- +title: inputWebFileGeoPointLocation +description: inputWebFileGeoPointLocation attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWebFileGeoPointLocation +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional| +|access\_hash|[long](../types/long.md) | Yes| +|w|[int](../types/int.md) | Yes| +|h|[int](../types/int.md) | Yes| +|zoom|[int](../types/int.md) | Yes| +|scale|[int](../types/int.md) | Yes| + + + +### Type: [InputWebFileLocation](../types/InputWebFileLocation.md) + + +### Example: + +``` +$inputWebFileGeoPointLocation = ['_' => 'inputWebFileGeoPointLocation', 'geo_point' => InputGeoPoint, 'access_hash' => long, 'w' => int, 'h' => int, 'zoom' => int, 'scale' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputWebFileGeoPointLocation", "geo_point": InputGeoPoint, "access_hash": long, "w": int, "h": int, "zoom": int, "scale": int} +``` + + +Or, if you're into Lua: + + +``` +inputWebFileGeoPointLocation={_='inputWebFileGeoPointLocation', geo_point=InputGeoPoint, access_hash=long, w=int, h=int, zoom=int, scale=int} + +``` + + diff --git a/docs/API_docs/constructors/messages_dialogsNotModified.md b/docs/API_docs/constructors/messages_dialogsNotModified.md new file mode 100644 index 00000000..14c76ec0 --- /dev/null +++ b/docs/API_docs/constructors/messages_dialogsNotModified.md @@ -0,0 +1,43 @@ +--- +title: messages.dialogsNotModified +description: messages_dialogsNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.dialogsNotModified +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|count|[int](../types/int.md) | Yes| + + + +### Type: [messages\_Dialogs](../types/messages_Dialogs.md) + + +### Example: + +``` +$messages_dialogsNotModified = ['_' => 'messages.dialogsNotModified', 'count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.dialogsNotModified", "count": int} +``` + + +Or, if you're into Lua: + + +``` +messages_dialogsNotModified={_='messages.dialogsNotModified', count=int} + +``` + + diff --git a/docs/API_docs/constructors/updateDialogUnreadMark.md b/docs/API_docs/constructors/updateDialogUnreadMark.md new file mode 100644 index 00000000..b9d2e8c5 --- /dev/null +++ b/docs/API_docs/constructors/updateDialogUnreadMark.md @@ -0,0 +1,44 @@ +--- +title: updateDialogUnreadMark +description: updateDialogUnreadMark attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDialogUnreadMark +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|unread|[Bool](../types/Bool.md) | Optional| +|peer|[DialogPeer](../types/DialogPeer.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateDialogUnreadMark = ['_' => 'updateDialogUnreadMark', 'unread' => Bool, 'peer' => DialogPeer]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateDialogUnreadMark", "unread": Bool, "peer": DialogPeer} +``` + + +Or, if you're into Lua: + + +``` +updateDialogUnreadMark={_='updateDialogUnreadMark', unread=Bool, peer=DialogPeer} + +``` + + diff --git a/docs/API_docs/methods/contacts_toggleTopPeers.md b/docs/API_docs/methods/contacts_toggleTopPeers.md new file mode 100644 index 00000000..32cf5691 --- /dev/null +++ b/docs/API_docs/methods/contacts_toggleTopPeers.md @@ -0,0 +1,68 @@ +--- +title: contacts.toggleTopPeers +description: Toggle top peers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.toggleTopPeers +[Back to methods index](index.md) + + +Toggle top peers + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable top peer| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->contacts->toggleTopPeers(['enabled' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - contacts.toggleTopPeers +* params - `{"enabled": Bool, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.toggleTopPeers` + +Parameters: + +enabled - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Bool = contacts.toggleTopPeers({enabled=Bool, }) +``` + diff --git a/docs/API_docs/methods/messages_getDialogUnreadMarks.md b/docs/API_docs/methods/messages_getDialogUnreadMarks.md new file mode 100644 index 00000000..3daa2710 --- /dev/null +++ b/docs/API_docs/methods/messages_getDialogUnreadMarks.md @@ -0,0 +1,61 @@ +--- +title: messages.getDialogUnreadMarks +description: Get dialogs marked as unread manually +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getDialogUnreadMarks +[Back to methods index](index.md) + + +Get dialogs marked as unread manually + + + +### Return type: [Vector\_of\_DialogPeer](../types/DialogPeer.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_DialogPeer = $MadelineProto->messages->getDialogUnreadMarks(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.getDialogUnreadMarks +* params - `{}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getDialogUnreadMarks` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Vector_of_DialogPeer = messages.getDialogUnreadMarks({}) +``` + diff --git a/docs/API_docs/methods/messages_markDialogUnread.md b/docs/API_docs/methods/messages_markDialogUnread.md new file mode 100644 index 00000000..5c22aefd --- /dev/null +++ b/docs/API_docs/methods/messages_markDialogUnread.md @@ -0,0 +1,71 @@ +--- +title: messages.markDialogUnread +description: Mark dialog as unread +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.markDialogUnread +[Back to methods index](index.md) + + +Mark dialog as unread + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|unread|[Bool](../types/Bool.md) | Optional|Should it be marked or unmarked as read| +|peer|[InputDialogPeer](../types/InputDialogPeer.md) | Yes|The dialog to mark as unread| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->markDialogUnread(['unread' => Bool, 'peer' => InputDialogPeer, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.markDialogUnread +* params - `{"unread": Bool, "peer": InputDialogPeer, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.markDialogUnread` + +Parameters: + +unread - Json encoded Bool + +peer - Json encoded InputDialogPeer + + + + +Or, if you're into Lua: + +``` +Bool = messages.markDialogUnread({unread=Bool, peer=InputDialogPeer, }) +``` + diff --git a/old_docs/API_docs_v81/README.md b/old_docs/API_docs_v81/README.md new file mode 100644 index 00000000..692642df --- /dev/null +++ b/old_docs/API_docs_v81/README.md @@ -0,0 +1,15 @@ +--- +title: MadelineProto API documentation (layer v81) +description: MadelineProto API documentation (layer v81) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# MadelineProto API documentation (layer v81) + +[Back to main documentation](..) + + +[Methods](methods/) + +[Constructors](constructors/) + +[Types](types/) \ No newline at end of file diff --git a/old_docs/API_docs_v81/constructors/README.md b/old_docs/API_docs_v81/constructors/README.md new file mode 100644 index 00000000..bf4cb114 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/README.md @@ -0,0 +1,1863 @@ +--- +title: Constructors +description: List of constructors +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructors +[Back to API documentation index](..) + +*** +

[$accessPointRule](../constructors/accessPointRule.md) = \['phone_prefix_rules' => [string](../types/string.md), 'dc_id' => [int](../types/int.md), 'ips' => \[[IpPort](../types/IpPort.md)\], \]; + +*** +

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

[$account\_authorizationForm](../constructors/account_authorizationForm.md) = \['selfie_required' => [Bool](../types/Bool.md), 'required_types' => \[[SecureValueType](../types/SecureValueType.md)\], 'values' => \[[SecureValue](../types/SecureValue.md)\], 'errors' => \[[SecureValueError](../types/SecureValueError.md)\], 'users' => \[[User](../types/User.md)\], 'privacy_policy_url' => [string](../types/string.md), \]; + +[$account\_authorizations](../constructors/account_authorizations.md) = \['authorizations' => \[[Authorization](../types/Authorization.md)\], \]; + +[$account\_noPassword](../constructors/account_noPassword.md) = \['new_salt' => [bytes](../types/bytes.md), 'new_secure_salt' => [bytes](../types/bytes.md), 'secure_random' => [bytes](../types/bytes.md), 'email_unconfirmed_pattern' => [string](../types/string.md), \]; + +[$account\_password](../constructors/account_password.md) = \['has_recovery' => [Bool](../types/Bool.md), 'has_secure_values' => [Bool](../types/Bool.md), 'current_salt' => [bytes](../types/bytes.md), 'new_salt' => [bytes](../types/bytes.md), 'new_secure_salt' => [bytes](../types/bytes.md), 'secure_random' => [bytes](../types/bytes.md), 'hint' => [string](../types/string.md), 'email_unconfirmed_pattern' => [string](../types/string.md), \]; + +[$account\_passwordInputSettings](../constructors/account_passwordInputSettings.md) = \['new_salt' => [bytes](../types/bytes.md), 'new_password_hash' => [bytes](../types/bytes.md), 'hint' => [string](../types/string.md), 'email' => [string](../types/string.md), 'new_secure_salt' => [bytes](../types/bytes.md), 'new_secure_secret' => [bytes](../types/bytes.md), 'new_secure_secret_id' => [long](../types/long.md), \]; + +[$account\_passwordSettings](../constructors/account_passwordSettings.md) = \['email' => [string](../types/string.md), 'secure_salt' => [bytes](../types/bytes.md), 'secure_secret' => [bytes](../types/bytes.md), 'secure_secret_id' => [long](../types/long.md), \]; + +[$account\_privacyRules](../constructors/account_privacyRules.md) = \['rules' => \[[PrivacyRule](../types/PrivacyRule.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$account\_sentEmailCode](../constructors/account_sentEmailCode.md) = \['email_pattern' => [string](../types/string.md), 'length' => [int](../types/int.md), \]; + +[$account\_takeout](../constructors/account_takeout.md) = \['id' => [long](../types/long.md), \]; + +[$account\_tmpPassword](../constructors/account_tmpPassword.md) = \['tmp_password' => [bytes](../types/bytes.md), 'valid_until' => [int](../types/int.md), \]; + +[$account\_webAuthorizations](../constructors/account_webAuthorizations.md) = \['authorizations' => \[[WebAuthorization](../types/WebAuthorization.md)\], 'users' => \[[User](../types/User.md)\], \]; + +*** +

[$auth\_authorization](../constructors/auth_authorization.md) = \['tmp_sessions' => [int](../types/int.md), 'user' => [User](../types/User.md), \]; + +[$auth\_checkedPhone](../constructors/auth_checkedPhone.md) = \['phone_registered' => [Bool](../types/Bool.md), \]; + +[$auth\_codeTypeCall](../constructors/auth_codeTypeCall.md) = \[\]; + +[$auth\_codeTypeFlashCall](../constructors/auth_codeTypeFlashCall.md) = \[\]; + +[$auth\_codeTypeSms](../constructors/auth_codeTypeSms.md) = \[\]; + +[$auth\_exportedAuthorization](../constructors/auth_exportedAuthorization.md) = \['id' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]; + +[$auth\_passwordRecovery](../constructors/auth_passwordRecovery.md) = \['email_pattern' => [string](../types/string.md), \]; + +[$auth\_sentCode](../constructors/auth_sentCode.md) = \['phone_registered' => [Bool](../types/Bool.md), 'type' => [auth\_SentCodeType](../types/auth_SentCodeType.md), 'phone_code_hash' => [string](../types/string.md), 'next_type' => [auth\_CodeType](../types/auth_CodeType.md), 'timeout' => [int](../types/int.md), 'terms_of_service' => [help\_TermsOfService](../types/help_TermsOfService.md), \]; + +[$auth\_sentCodeTypeApp](../constructors/auth_sentCodeTypeApp.md) = \['length' => [int](../types/int.md), \]; + +[$auth\_sentCodeTypeCall](../constructors/auth_sentCodeTypeCall.md) = \['length' => [int](../types/int.md), \]; + +[$auth\_sentCodeTypeFlashCall](../constructors/auth_sentCodeTypeFlashCall.md) = \['pattern' => [string](../types/string.md), \]; + +[$auth\_sentCodeTypeSms](../constructors/auth_sentCodeTypeSms.md) = \['length' => [int](../types/int.md), \]; + +*** +

[$authorization](../constructors/authorization.md) = \['hash' => [long](../types/long.md), 'device_model' => [string](../types/string.md), 'platform' => [string](../types/string.md), 'system_version' => [string](../types/string.md), 'api_id' => [int](../types/int.md), 'app_name' => [string](../types/string.md), 'app_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), \]; + +*** +

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

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

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

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

[$botInlineMediaResult](../constructors/botInlineMediaResult.md) = \['id' => [string](../types/string.md), 'type' => [string](../types/string.md), 'photo' => [Photo](../types/Photo.md), 'document' => [Document](../types/Document.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'send_message' => [BotInlineMessage](../types/BotInlineMessage.md), \]; + +*** +

[$botInlineMessageMediaAuto](../constructors/botInlineMessageMediaAuto.md) = \['message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +

[$botInlineMessageMediaContact](../constructors/botInlineMessageMediaContact.md) = \['phone_number' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +

[$botInlineMessageMediaGeo](../constructors/botInlineMessageMediaGeo.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), 'period' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +

[$botInlineMessageMediaVenue](../constructors/botInlineMessageMediaVenue.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), 'title' => [string](../types/string.md), 'address' => [string](../types/string.md), 'provider' => [string](../types/string.md), 'venue_id' => [string](../types/string.md), 'venue_type' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +

[$botInlineMessageText](../constructors/botInlineMessageText.md) = \['no_webpage' => [Bool](../types/Bool.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +

[$botInlineResult](../constructors/botInlineResult.md) = \['id' => [string](../types/string.md), 'type' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'url' => [string](../types/string.md), 'thumb' => [WebDocument](../types/WebDocument.md), 'content' => [WebDocument](../types/WebDocument.md), 'send_message' => [BotInlineMessage](../types/BotInlineMessage.md), \]; + +*** +

[$cdnConfig](../constructors/cdnConfig.md) = \['public_keys' => \[[CdnPublicKey](../types/CdnPublicKey.md)\], \]; + +*** +

[$cdnPublicKey](../constructors/cdnPublicKey.md) = \['dc_id' => [int](../types/int.md), 'public_key' => [string](../types/string.md), \]; + +*** +

[$channel](../constructors/channel.md) = \['creator' => [Bool](../types/Bool.md), 'left' => [Bool](../types/Bool.md), 'editor' => [Bool](../types/Bool.md), 'broadcast' => [Bool](../types/Bool.md), 'verified' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'restricted' => [Bool](../types/Bool.md), 'democracy' => [Bool](../types/Bool.md), 'signatures' => [Bool](../types/Bool.md), 'min' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), 'username' => [string](../types/string.md), 'photo' => [ChatPhoto](../types/ChatPhoto.md), 'date' => [int](../types/int.md), 'version' => [int](../types/int.md), 'restriction_reason' => [string](../types/string.md), 'admin_rights' => [ChannelAdminRights](../types/ChannelAdminRights.md), 'banned_rights' => [ChannelBannedRights](../types/ChannelBannedRights.md), 'participants_count' => [int](../types/int.md), \]; + +*** +

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

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

[$channelAdminLogEventActionChangePhoto](../constructors/channelAdminLogEventActionChangePhoto.md) = \['prev_photo' => [ChatPhoto](../types/ChatPhoto.md), 'new_photo' => [ChatPhoto](../types/ChatPhoto.md), \]; + +*** +

[$channelAdminLogEventActionChangeStickerSet](../constructors/channelAdminLogEventActionChangeStickerSet.md) = \['prev_stickerset' => [InputStickerSet](../types/InputStickerSet.md), 'new_stickerset' => [InputStickerSet](../types/InputStickerSet.md), \]; + +*** +

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

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

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

[$channelAdminLogEventActionEditMessage](../constructors/channelAdminLogEventActionEditMessage.md) = \['prev_message' => [Message](../types/Message.md), 'new_message' => [Message](../types/Message.md), \]; + +*** +

[$channelAdminLogEventActionParticipantInvite](../constructors/channelAdminLogEventActionParticipantInvite.md) = \['participant' => [ChannelParticipant](../types/ChannelParticipant.md), \]; + +*** +

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

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

[$channelAdminLogEventActionParticipantToggleAdmin](../constructors/channelAdminLogEventActionParticipantToggleAdmin.md) = \['prev_participant' => [ChannelParticipant](../types/ChannelParticipant.md), 'new_participant' => [ChannelParticipant](../types/ChannelParticipant.md), \]; + +*** +

[$channelAdminLogEventActionParticipantToggleBan](../constructors/channelAdminLogEventActionParticipantToggleBan.md) = \['prev_participant' => [ChannelParticipant](../types/ChannelParticipant.md), 'new_participant' => [ChannelParticipant](../types/ChannelParticipant.md), \]; + +*** +

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

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

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

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

[$channelAdminLogEventsFilter](../constructors/channelAdminLogEventsFilter.md) = \['join' => [Bool](../types/Bool.md), 'leave' => [Bool](../types/Bool.md), 'invite' => [Bool](../types/Bool.md), 'ban' => [Bool](../types/Bool.md), 'unban' => [Bool](../types/Bool.md), 'kick' => [Bool](../types/Bool.md), 'unkick' => [Bool](../types/Bool.md), 'promote' => [Bool](../types/Bool.md), 'demote' => [Bool](../types/Bool.md), 'info' => [Bool](../types/Bool.md), 'settings' => [Bool](../types/Bool.md), 'pinned' => [Bool](../types/Bool.md), 'edit' => [Bool](../types/Bool.md), 'delete' => [Bool](../types/Bool.md), \]; + +*** +

[$channelAdminRights](../constructors/channelAdminRights.md) = \['change_info' => [Bool](../types/Bool.md), 'post_messages' => [Bool](../types/Bool.md), 'edit_messages' => [Bool](../types/Bool.md), 'delete_messages' => [Bool](../types/Bool.md), 'ban_users' => [Bool](../types/Bool.md), 'invite_users' => [Bool](../types/Bool.md), 'invite_link' => [Bool](../types/Bool.md), 'pin_messages' => [Bool](../types/Bool.md), 'add_admins' => [Bool](../types/Bool.md), 'manage_call' => [Bool](../types/Bool.md), \]; + +*** +

[$channelBannedRights](../constructors/channelBannedRights.md) = \['view_messages' => [Bool](../types/Bool.md), 'send_messages' => [Bool](../types/Bool.md), 'send_media' => [Bool](../types/Bool.md), 'send_stickers' => [Bool](../types/Bool.md), 'send_gifs' => [Bool](../types/Bool.md), 'send_games' => [Bool](../types/Bool.md), 'send_inline' => [Bool](../types/Bool.md), 'embed_links' => [Bool](../types/Bool.md), 'until_date' => [int](../types/int.md), \]; + +*** +

[$channelForbidden](../constructors/channelForbidden.md) = \['broadcast' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), 'until_date' => [int](../types/int.md), \]; + +*** +

[$channelFull](../constructors/channelFull.md) = \['can_view_participants' => [Bool](../types/Bool.md), 'can_set_username' => [Bool](../types/Bool.md), 'can_set_stickers' => [Bool](../types/Bool.md), 'hidden_prehistory' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'about' => [string](../types/string.md), 'participants_count' => [int](../types/int.md), 'admins_count' => [int](../types/int.md), 'kicked_count' => [int](../types/int.md), 'banned_count' => [int](../types/int.md), 'read_inbox_max_id' => [int](../types/int.md), 'read_outbox_max_id' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), 'chat_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'exported_invite' => [ExportedChatInvite](../types/ExportedChatInvite.md), 'bot_info' => \[[BotInfo](../types/BotInfo.md)\], 'migrated_from_chat_id' => [int](../types/int.md), 'migrated_from_max_id' => [int](../types/int.md), 'pinned_msg_id' => [int](../types/int.md), 'stickerset' => [StickerSet](../types/StickerSet.md), 'available_min_id' => [int](../types/int.md), \]; + +*** +

[$channelMessagesFilter](../constructors/channelMessagesFilter.md) = \['exclude_new_messages' => [Bool](../types/Bool.md), 'ranges' => \[[MessageRange](../types/MessageRange.md)\], \]; + +*** +

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

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

[$channelParticipantAdmin](../constructors/channelParticipantAdmin.md) = \['can_edit' => [Bool](../types/Bool.md), 'user_id' => [int](../types/int.md), 'inviter_id' => [int](../types/int.md), 'promoted_by' => [int](../types/int.md), 'date' => [int](../types/int.md), 'admin_rights' => [ChannelAdminRights](../types/ChannelAdminRights.md), \]; + +*** +

[$channelParticipantBanned](../constructors/channelParticipantBanned.md) = \['left' => [Bool](../types/Bool.md), 'user_id' => [int](../types/int.md), 'kicked_by' => [int](../types/int.md), 'date' => [int](../types/int.md), 'banned_rights' => [ChannelBannedRights](../types/ChannelBannedRights.md), \]; + +*** +

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

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

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

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

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

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

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

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

[$channels\_adminLogResults](../constructors/channels_adminLogResults.md) = \['events' => \[[ChannelAdminLogEvent](../types/ChannelAdminLogEvent.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$channels\_channelParticipant](../constructors/channels_channelParticipant.md) = \['participant' => [ChannelParticipant](../types/ChannelParticipant.md), 'users' => \[[User](../types/User.md)\], \]; + +[$channels\_channelParticipants](../constructors/channels_channelParticipants.md) = \['count' => [int](../types/int.md), 'participants' => \[[ChannelParticipant](../types/ChannelParticipant.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$channels\_channelParticipantsNotModified](../constructors/channels_channelParticipantsNotModified.md) = \[\]; + +*** +

[$chat](../constructors/chat.md) = \['creator' => [Bool](../types/Bool.md), 'kicked' => [Bool](../types/Bool.md), 'left' => [Bool](../types/Bool.md), 'admins_enabled' => [Bool](../types/Bool.md), 'admin' => [Bool](../types/Bool.md), 'deactivated' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'title' => [string](../types/string.md), 'photo' => [ChatPhoto](../types/ChatPhoto.md), 'participants_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'version' => [int](../types/int.md), 'migrated_to' => [InputChannel](../types/InputChannel.md), \]; + +*** +

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

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

[$chatFull](../constructors/chatFull.md) = \['id' => [int](../types/int.md), 'participants' => [ChatParticipants](../types/ChatParticipants.md), 'chat_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'exported_invite' => [ExportedChatInvite](../types/ExportedChatInvite.md), 'bot_info' => \[[BotInfo](../types/BotInfo.md)\], \]; + +*** +

[$chatInvite](../constructors/chatInvite.md) = \['channel' => [Bool](../types/Bool.md), 'broadcast' => [Bool](../types/Bool.md), 'public' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'photo' => [ChatPhoto](../types/ChatPhoto.md), 'participants_count' => [int](../types/int.md), 'participants' => \[[User](../types/User.md)\], \]; + +*** +

[$chatInviteAlready](../constructors/chatInviteAlready.md) = \['chat' => [Chat](../types/Chat.md), \]; + +*** +

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

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

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

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

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

[$chatParticipants](../constructors/chatParticipants.md) = \['chat_id' => [int](../types/int.md), 'participants' => \[[ChatParticipant](../types/ChatParticipant.md)\], 'version' => [int](../types/int.md), \]; + +*** +

[$chatParticipantsForbidden](../constructors/chatParticipantsForbidden.md) = \['chat_id' => [int](../types/int.md), 'self_participant' => [ChatParticipant](../types/ChatParticipant.md), \]; + +*** +

[$chatPhoto](../constructors/chatPhoto.md) = \['photo_small' => [FileLocation](../types/FileLocation.md), 'photo_big' => [FileLocation](../types/FileLocation.md), \]; + +*** +

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

[$config](../constructors/config.md) = \['phonecalls_enabled' => [Bool](../types/Bool.md), 'default_p2p_contacts' => [Bool](../types/Bool.md), 'preload_featured_stickers' => [Bool](../types/Bool.md), 'ignore_phone_entities' => [Bool](../types/Bool.md), 'revoke_pm_inbox' => [Bool](../types/Bool.md), 'blocked_mode' => [Bool](../types/Bool.md), 'date' => [int](../types/int.md), 'expires' => [int](../types/int.md), 'test_mode' => [Bool](../types/Bool.md), 'this_dc' => [int](../types/int.md), 'dc_options' => \[[DcOption](../types/DcOption.md)\], 'chat_size_max' => [int](../types/int.md), 'megagroup_size_max' => [int](../types/int.md), 'forwarded_count_max' => [int](../types/int.md), 'online_update_period_ms' => [int](../types/int.md), 'offline_blur_timeout_ms' => [int](../types/int.md), 'offline_idle_timeout_ms' => [int](../types/int.md), 'online_cloud_timeout_ms' => [int](../types/int.md), 'notify_cloud_delay_ms' => [int](../types/int.md), 'notify_default_delay_ms' => [int](../types/int.md), 'push_chat_period_ms' => [int](../types/int.md), 'push_chat_limit' => [int](../types/int.md), 'saved_gifs_limit' => [int](../types/int.md), 'edit_time_limit' => [int](../types/int.md), 'revoke_time_limit' => [int](../types/int.md), 'revoke_pm_time_limit' => [int](../types/int.md), 'rating_e_decay' => [int](../types/int.md), 'stickers_recent_limit' => [int](../types/int.md), 'stickers_faved_limit' => [int](../types/int.md), 'channels_read_media_period' => [int](../types/int.md), 'tmp_sessions' => [int](../types/int.md), 'pinned_dialogs_count_max' => [int](../types/int.md), 'call_receive_timeout_ms' => [int](../types/int.md), 'call_ring_timeout_ms' => [int](../types/int.md), 'call_connect_timeout_ms' => [int](../types/int.md), 'call_packet_timeout_ms' => [int](../types/int.md), 'me_url_prefix' => [string](../types/string.md), 'autoupdate_url_prefix' => [string](../types/string.md), 'suggested_lang_code' => [string](../types/string.md), 'lang_pack_version' => [int](../types/int.md), \]; + +*** +

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

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

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

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

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

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

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

[$contacts\_blocked](../constructors/contacts_blocked.md) = \['blocked' => \[[ContactBlocked](../types/ContactBlocked.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$contacts\_blockedSlice](../constructors/contacts_blockedSlice.md) = \['count' => [int](../types/int.md), 'blocked' => \[[ContactBlocked](../types/ContactBlocked.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$contacts\_contacts](../constructors/contacts_contacts.md) = \['contacts' => \[[Contact](../types/Contact.md)\], 'saved_count' => [int](../types/int.md), 'users' => \[[User](../types/User.md)\], \]; + +[$contacts\_contactsNotModified](../constructors/contacts_contactsNotModified.md) = \[\]; + +[$contacts\_found](../constructors/contacts_found.md) = \['my_results' => \[[Peer](../types/Peer.md)\], 'results' => \[[Peer](../types/Peer.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$contacts\_importedContacts](../constructors/contacts_importedContacts.md) = \['imported' => \[[ImportedContact](../types/ImportedContact.md)\], 'popular_invites' => \[[PopularContact](../types/PopularContact.md)\], 'retry_contacts' => \[[long](../types/long.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$contacts\_link](../constructors/contacts_link.md) = \['my_link' => [ContactLink](../types/ContactLink.md), 'foreign_link' => [ContactLink](../types/ContactLink.md), 'user' => [User](../types/User.md), \]; + +[$contacts\_resolvedPeer](../constructors/contacts_resolvedPeer.md) = \['peer' => [Peer](../types/Peer.md), 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$contacts\_topPeers](../constructors/contacts_topPeers.md) = \['categories' => \[[TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$contacts\_topPeersNotModified](../constructors/contacts_topPeersNotModified.md) = \[\]; + +*** +

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

[$dcOption](../constructors/dcOption.md) = \['ipv6' => [Bool](../types/Bool.md), 'media_only' => [Bool](../types/Bool.md), 'tcpo_only' => [Bool](../types/Bool.md), 'cdn' => [Bool](../types/Bool.md), 'static' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'ip_address' => [string](../types/string.md), 'port' => [int](../types/int.md), 'secret' => [bytes](../types/bytes.md), \]; + +*** +

[$dialog](../constructors/dialog.md) = \['pinned' => [Bool](../types/Bool.md), 'peer' => [Peer](../types/Peer.md), 'top_message' => [int](../types/int.md), 'read_inbox_max_id' => [int](../types/int.md), 'read_outbox_max_id' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), 'unread_mentions_count' => [int](../types/int.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'pts' => [int](../types/int.md), 'draft' => [DraftMessage](../types/DraftMessage.md), \]; + +*** +

[$dialogPeer](../constructors/dialogPeer.md) = \['peer' => [Peer](../types/Peer.md), \]; + +*** +

[$document](../constructors/document.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'size' => [int](../types/int.md), 'thumb' => [PhotoSize](../types/PhotoSize.md), 'dc_id' => [int](../types/int.md), 'version' => [int](../types/int.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], \]; + +*** +

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

[$documentAttributeAudio](../constructors/documentAttributeAudio.md) = \['voice' => [Bool](../types/Bool.md), 'duration' => [int](../types/int.md), 'title' => [string](../types/string.md), 'performer' => [string](../types/string.md), 'waveform' => [bytes](../types/bytes.md), \]; + +*** +

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

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

[$documentAttributeImageSize](../constructors/documentAttributeImageSize.md) = \['w' => [int](../types/int.md), 'h' => [int](../types/int.md), \]; + +*** +

[$documentAttributeSticker](../constructors/documentAttributeSticker.md) = \['mask' => [Bool](../types/Bool.md), 'alt' => [string](../types/string.md), 'stickerset' => [InputStickerSet](../types/InputStickerSet.md), 'mask_coords' => [MaskCoords](../types/MaskCoords.md), \]; + +*** +

[$documentAttributeVideo](../constructors/documentAttributeVideo.md) = \['round_message' => [Bool](../types/Bool.md), 'supports_streaming' => [Bool](../types/Bool.md), 'duration' => [int](../types/int.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), \]; + +*** +

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

[$draftMessage](../constructors/draftMessage.md) = \['no_webpage' => [Bool](../types/Bool.md), 'reply_to_msg_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'date' => [int](../types/int.md), \]; + +*** +

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

[$encryptedChat](../constructors/encryptedChat.md) = \['id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), 'g_a_or_b' => [bytes](../types/bytes.md), 'key_fingerprint' => [long](../types/long.md), \]; + +*** +

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

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

[$encryptedChatRequested](../constructors/encryptedChatRequested.md) = \['id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), 'g_a' => [bytes](../types/bytes.md), \]; + +*** +

[$encryptedChatWaiting](../constructors/encryptedChatWaiting.md) = \['id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), \]; + +*** +

[$encryptedFile](../constructors/encryptedFile.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'size' => [int](../types/int.md), 'dc_id' => [int](../types/int.md), 'key_fingerprint' => [int](../types/int.md), \]; + +*** +

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

[$encryptedMessage](../constructors/encryptedMessage.md) = \['chat_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'decrypted_message' => [DecryptedMessage](../types/DecryptedMessage.md), 'file' => [EncryptedFile](../types/EncryptedFile.md), \]; + +*** +

[$encryptedMessageService](../constructors/encryptedMessageService.md) = \['chat_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'decrypted_message' => [DecryptedMessage](../types/DecryptedMessage.md), \]; + +*** +

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

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

[$fileHash](../constructors/fileHash.md) = \['offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'hash' => [bytes](../types/bytes.md), \]; + +*** +

[$fileLocation](../constructors/fileLocation.md) = \['dc_id' => [int](../types/int.md), 'volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), 'secret' => [long](../types/long.md), \]; + +*** +

[$fileLocationUnavailable](../constructors/fileLocationUnavailable.md) = \['volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), 'secret' => [long](../types/long.md), \]; + +*** +

[$foundGif](../constructors/foundGif.md) = \['url' => [string](../types/string.md), 'thumb_url' => [string](../types/string.md), 'content_url' => [string](../types/string.md), 'content_type' => [string](../types/string.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), \]; + +*** +

[$foundGifCached](../constructors/foundGifCached.md) = \['url' => [string](../types/string.md), 'photo' => [Photo](../types/Photo.md), 'document' => [Document](../types/Document.md), \]; + +*** +

[$game](../constructors/game.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'short_name' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [Photo](../types/Photo.md), 'document' => [Document](../types/Document.md), \]; + +*** +

[$geoPoint](../constructors/geoPoint.md) = \['long' => [double](../types/double.md), 'lat' => [double](../types/double.md), \]; + +*** +

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

[$help\_appUpdate](../constructors/help_appUpdate.md) = \['id' => [int](../types/int.md), 'critical' => [Bool](../types/Bool.md), 'url' => [string](../types/string.md), 'text' => [string](../types/string.md), \]; + +[$help\_configSimple](../constructors/help_configSimple.md) = \['date' => [int](../types/int.md), 'expires' => [int](../types/int.md), 'rules' => \[[AccessPointRule](../types/AccessPointRule.md)\], \]; + +[$help\_deepLinkInfo](../constructors/help_deepLinkInfo.md) = \['update_app' => [Bool](../types/Bool.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; + +[$help\_deepLinkInfoEmpty](../constructors/help_deepLinkInfoEmpty.md) = \[\]; + +[$help\_inviteText](../constructors/help_inviteText.md) = \['message' => [string](../types/string.md), \]; + +[$help\_noAppUpdate](../constructors/help_noAppUpdate.md) = \[\]; + +[$help\_proxyDataEmpty](../constructors/help_proxyDataEmpty.md) = \['expires' => [int](../types/int.md), \]; + +[$help\_proxyDataPromo](../constructors/help_proxyDataPromo.md) = \['expires' => [int](../types/int.md), 'peer' => [Peer](../types/Peer.md), 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$help\_recentMeUrls](../constructors/help_recentMeUrls.md) = \['urls' => \[[RecentMeUrl](../types/RecentMeUrl.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$help\_support](../constructors/help_support.md) = \['phone_number' => [string](../types/string.md), 'user' => [User](../types/User.md), \]; + +[$help\_termsOfService](../constructors/help_termsOfService.md) = \['popup' => [Bool](../types/Bool.md), 'id' => [DataJSON](../types/DataJSON.md), 'text' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'min_age_confirm' => [int](../types/int.md), \]; + +[$help\_termsOfServiceUpdate](../constructors/help_termsOfServiceUpdate.md) = \['expires' => [int](../types/int.md), 'terms_of_service' => [help\_TermsOfService](../types/help_TermsOfService.md), \]; + +[$help\_termsOfServiceUpdateEmpty](../constructors/help_termsOfServiceUpdateEmpty.md) = \['expires' => [int](../types/int.md), \]; + +*** +

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

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

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

[$inputAppEvent](../constructors/inputAppEvent.md) = \['time' => [double](../types/double.md), 'type' => [string](../types/string.md), 'peer' => [long](../types/long.md), 'data' => [string](../types/string.md), \]; + +*** +

[$inputBotInlineMessageGame](../constructors/inputBotInlineMessageGame.md) = \['reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +

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

[$inputBotInlineMessageMediaAuto](../constructors/inputBotInlineMessageMediaAuto.md) = \['message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +

[$inputBotInlineMessageMediaContact](../constructors/inputBotInlineMessageMediaContact.md) = \['phone_number' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +

[$inputBotInlineMessageMediaGeo](../constructors/inputBotInlineMessageMediaGeo.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'period' => [int](../types/int.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +

[$inputBotInlineMessageMediaVenue](../constructors/inputBotInlineMessageMediaVenue.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'title' => [string](../types/string.md), 'address' => [string](../types/string.md), 'provider' => [string](../types/string.md), 'venue_id' => [string](../types/string.md), 'venue_type' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +

[$inputBotInlineMessageText](../constructors/inputBotInlineMessageText.md) = \['no_webpage' => [Bool](../types/Bool.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), \]; + +*** +

[$inputBotInlineResult](../constructors/inputBotInlineResult.md) = \['id' => [string](../types/string.md), 'type' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'url' => [string](../types/string.md), 'thumb' => [InputWebDocument](../types/InputWebDocument.md), 'content' => [InputWebDocument](../types/InputWebDocument.md), 'send_message' => [InputBotInlineMessage](../types/InputBotInlineMessage.md), \]; + +*** +

[$inputBotInlineResultDocument](../constructors/inputBotInlineResultDocument.md) = \['id' => [string](../types/string.md), 'type' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'document' => [InputDocument](../types/InputDocument.md), 'send_message' => [InputBotInlineMessage](../types/InputBotInlineMessage.md), \]; + +*** +

[$inputBotInlineResultGame](../constructors/inputBotInlineResultGame.md) = \['id' => [string](../types/string.md), 'short_name' => [string](../types/string.md), 'send_message' => [InputBotInlineMessage](../types/InputBotInlineMessage.md), \]; + +*** +

[$inputBotInlineResultPhoto](../constructors/inputBotInlineResultPhoto.md) = \['id' => [string](../types/string.md), 'type' => [string](../types/string.md), 'photo' => [InputPhoto](../types/InputPhoto.md), 'send_message' => [InputBotInlineMessage](../types/InputBotInlineMessage.md), \]; + +*** +

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

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

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

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

[$inputChatUploadedPhoto](../constructors/inputChatUploadedPhoto.md) = \['file' => [InputFile](../types/InputFile.md), \]; + +*** +

[$inputClientProxy](../constructors/inputClientProxy.md) = \['address' => [string](../types/string.md), 'port' => [int](../types/int.md), \]; + +*** +

[$inputDialogPeer](../constructors/inputDialogPeer.md) = \['peer' => [InputPeer](../types/InputPeer.md), \]; + +*** +

[$inputDocument](../constructors/inputDocument.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +

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

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

[$inputEncryptedChat](../constructors/inputEncryptedChat.md) = \['chat_id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), \]; + +*** +

[$inputEncryptedFile](../constructors/inputEncryptedFile.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +

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

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

[$inputEncryptedFileLocation](../constructors/inputEncryptedFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +

[$inputEncryptedFileUploaded](../constructors/inputEncryptedFileUploaded.md) = \['id' => [long](../types/long.md), 'parts' => [int](../types/int.md), 'md5_checksum' => [string](../types/string.md), 'key_fingerprint' => [int](../types/int.md), \]; + +*** +

[$inputFile](../constructors/inputFile.md) = \['id' => [long](../types/long.md), 'parts' => [int](../types/int.md), 'name' => [string](../types/string.md), 'md5_checksum' => [string](../types/string.md), \]; + +*** +

[$inputFileBig](../constructors/inputFileBig.md) = \['id' => [long](../types/long.md), 'parts' => [int](../types/int.md), 'name' => [string](../types/string.md), \]; + +*** +

[$inputFileLocation](../constructors/inputFileLocation.md) = \['volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), 'secret' => [long](../types/long.md), \]; + +*** +

[$inputGameID](../constructors/inputGameID.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +

[$inputGameShortName](../constructors/inputGameShortName.md) = \['bot_id' => [InputUser](../types/InputUser.md), 'short_name' => [string](../types/string.md), \]; + +*** +

[$inputGeoPoint](../constructors/inputGeoPoint.md) = \['lat' => [double](../types/double.md), 'long' => [double](../types/double.md), \]; + +*** +

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

[$inputMediaContact](../constructors/inputMediaContact.md) = \['phone_number' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), \]; + +*** +

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

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

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

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

[$inputMediaGeoLive](../constructors/inputMediaGeoLive.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'period' => [int](../types/int.md), \]; + +*** +

[$inputMediaGeoPoint](../constructors/inputMediaGeoPoint.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), \]; + +*** +

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

[$inputMediaInvoice](../constructors/inputMediaInvoice.md) = \['title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [InputWebDocument](../types/InputWebDocument.md), 'invoice' => [Invoice](../types/Invoice.md), 'payload' => [bytes](../types/bytes.md), 'provider' => [string](../types/string.md), 'provider_data' => [DataJSON](../types/DataJSON.md), 'start_param' => [string](../types/string.md), \]; + +*** +

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

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

[$inputMediaUploadedDocument](../constructors/inputMediaUploadedDocument.md) = \['nosound_video' => [Bool](../types/Bool.md), 'file' => [InputFile](../types/InputFile.md), 'thumb' => [InputFile](../types/InputFile.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], 'stickers' => \[[InputDocument](../types/InputDocument.md)\], 'ttl_seconds' => [int](../types/int.md), \]; + +*** +

[$inputMediaUploadedPhoto](../constructors/inputMediaUploadedPhoto.md) = \['file' => [InputFile](../types/InputFile.md), 'stickers' => \[[InputDocument](../types/InputDocument.md)\], 'ttl_seconds' => [int](../types/int.md), \]; + +*** +

[$inputMediaVenue](../constructors/inputMediaVenue.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'title' => [string](../types/string.md), 'address' => [string](../types/string.md), 'provider' => [string](../types/string.md), 'venue_id' => [string](../types/string.md), 'venue_type' => [string](../types/string.md), \]; + +*** +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[$inputNotifyPeer](../constructors/inputNotifyPeer.md) = \['peer' => [InputPeer](../types/InputPeer.md), \]; + +*** +

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

[$inputPaymentCredentials](../constructors/inputPaymentCredentials.md) = \['save' => [Bool](../types/Bool.md), 'data' => [DataJSON](../types/DataJSON.md), \]; + +*** +

[$inputPaymentCredentialsAndroidPay](../constructors/inputPaymentCredentialsAndroidPay.md) = \['payment_token' => [DataJSON](../types/DataJSON.md), 'google_transaction_id' => [string](../types/string.md), \]; + +*** +

[$inputPaymentCredentialsApplePay](../constructors/inputPaymentCredentialsApplePay.md) = \['payment_data' => [DataJSON](../types/DataJSON.md), \]; + +*** +

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

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

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

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

[$inputPeerNotifySettings](../constructors/inputPeerNotifySettings.md) = \['show_previews' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'mute_until' => [int](../types/int.md), 'sound' => [string](../types/string.md), \]; + +*** +

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

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

[$inputPhoneCall](../constructors/inputPhoneCall.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +

[$inputPhoneContact](../constructors/inputPhoneContact.md) = \['client_id' => [long](../types/long.md), 'phone' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), \]; + +*** +

[$inputPhoto](../constructors/inputPhoto.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +

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

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

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

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

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

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

[$inputPrivacyValueAllowUsers](../constructors/inputPrivacyValueAllowUsers.md) = \['users' => \[[InputUser](../types/InputUser.md)\], \]; + +*** +

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

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

[$inputPrivacyValueDisallowUsers](../constructors/inputPrivacyValueDisallowUsers.md) = \['users' => \[[InputUser](../types/InputUser.md)\], \]; + +*** +

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

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

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

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

[$inputSecureFile](../constructors/inputSecureFile.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +

[$inputSecureFileLocation](../constructors/inputSecureFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +

[$inputSecureFileUploaded](../constructors/inputSecureFileUploaded.md) = \['id' => [long](../types/long.md), 'parts' => [int](../types/int.md), 'md5_checksum' => [string](../types/string.md), 'file_hash' => [bytes](../types/bytes.md), 'secret' => [bytes](../types/bytes.md), \]; + +*** +

[$inputSecureValue](../constructors/inputSecureValue.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'data' => [SecureData](../types/SecureData.md), 'front_side' => [InputSecureFile](../types/InputSecureFile.md), 'reverse_side' => [InputSecureFile](../types/InputSecureFile.md), 'selfie' => [InputSecureFile](../types/InputSecureFile.md), 'files' => \[[InputSecureFile](../types/InputSecureFile.md)\], 'plain_data' => [SecurePlainData](../types/SecurePlainData.md), \]; + +*** +

[$inputSingleMedia](../constructors/inputSingleMedia.md) = \['media' => [InputMedia](../types/InputMedia.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; + +*** +

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

[$inputStickerSetID](../constructors/inputStickerSetID.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), \]; + +*** +

[$inputStickerSetItem](../constructors/inputStickerSetItem.md) = \['document' => [InputDocument](../types/InputDocument.md), 'emoji' => [string](../types/string.md), 'mask_coords' => [MaskCoords](../types/MaskCoords.md), \]; + +*** +

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

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

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

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

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

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

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

[$inputWebDocument](../constructors/inputWebDocument.md) = \['url' => [string](../types/string.md), 'size' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], \]; + +*** +

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

[$invoice](../constructors/invoice.md) = \['test' => [Bool](../types/Bool.md), 'name_requested' => [Bool](../types/Bool.md), 'phone_requested' => [Bool](../types/Bool.md), 'email_requested' => [Bool](../types/Bool.md), 'shipping_address_requested' => [Bool](../types/Bool.md), 'flexible' => [Bool](../types/Bool.md), 'phone_to_provider' => [Bool](../types/Bool.md), 'email_to_provider' => [Bool](../types/Bool.md), 'currency' => [string](../types/string.md), 'prices' => \[[LabeledPrice](../types/LabeledPrice.md)\], \]; + +*** +

[$ipPort](../constructors/ipPort.md) = \['ipv4' => [int](../types/int.md), 'port' => [int](../types/int.md), \]; + +*** +

[$ipPortSecret](../constructors/ipPortSecret.md) = \['ipv4' => [int](../types/int.md), 'port' => [int](../types/int.md), 'secret' => [bytes](../types/bytes.md), \]; + +*** +

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

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

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

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

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

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

[$keyboardButtonRow](../constructors/keyboardButtonRow.md) = \['buttons' => \[[KeyboardButton](../types/KeyboardButton.md)\], \]; + +*** +

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

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

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

[$langPackDifference](../constructors/langPackDifference.md) = \['lang_code' => [string](../types/string.md), 'from_version' => [int](../types/int.md), 'version' => [int](../types/int.md), 'strings' => \[[LangPackString](../types/LangPackString.md)\], \]; + +*** +

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

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

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

[$langPackStringPluralized](../constructors/langPackStringPluralized.md) = \['key' => [string](../types/string.md), 'zero_value' => [string](../types/string.md), 'one_value' => [string](../types/string.md), 'two_value' => [string](../types/string.md), 'few_value' => [string](../types/string.md), 'many_value' => [string](../types/string.md), 'other_value' => [string](../types/string.md), \]; + +*** +

[$maskCoords](../constructors/maskCoords.md) = \['n' => [int](../types/int.md), 'x' => [double](../types/double.md), 'y' => [double](../types/double.md), 'zoom' => [double](../types/double.md), \]; + +*** +

[$message](../constructors/message.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'post' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'to_id' => [Peer](../types/Peer.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'message' => [string](../types/string.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'views' => [int](../types/int.md), 'edit_date' => [int](../types/int.md), 'post_author' => [string](../types/string.md), 'grouped_id' => [long](../types/long.md), \]; + +*** +

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

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

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

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

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

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

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

[$messageActionChatEditPhoto](../constructors/messageActionChatEditPhoto.md) = \['photo' => [Photo](../types/Photo.md), \]; + +*** +

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

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

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

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

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

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

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

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

[$messageActionPaymentSentMe](../constructors/messageActionPaymentSentMe.md) = \['currency' => [string](../types/string.md), 'total_amount' => [long](../types/long.md), 'payload' => [bytes](../types/bytes.md), 'info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), 'shipping_option_id' => [string](../types/string.md), 'charge' => [PaymentCharge](../types/PaymentCharge.md), \]; + +*** +

[$messageActionPhoneCall](../constructors/messageActionPhoneCall.md) = \['call_id' => [long](../types/long.md), 'reason' => [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md), 'duration' => [int](../types/int.md), \]; + +*** +

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

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

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

[$messageActionSecureValuesSentMe](../constructors/messageActionSecureValuesSentMe.md) = \['values' => \[[SecureValue](../types/SecureValue.md)\], 'credentials' => [SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md), \]; + +*** +

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

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

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

[$messageEntityCashtag](../constructors/messageEntityCashtag.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), \]; + +*** +

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

[$messageEntityPre](../constructors/messageEntityPre.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), \]; + +*** +

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

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

[$messageFwdHeader](../constructors/messageFwdHeader.md) = \['from_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'channel_id' => [int](../types/int.md), 'channel_post' => [int](../types/int.md), 'post_author' => [string](../types/string.md), 'saved_from_peer' => [Peer](../types/Peer.md), 'saved_from_msg_id' => [int](../types/int.md), \]; + +*** +

[$messageMediaContact](../constructors/messageMediaContact.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), \]; + +*** +

[$messageMediaDocument](../constructors/messageMediaDocument.md) = \['document' => [Document](../types/Document.md), 'ttl_seconds' => [int](../types/int.md), \]; + +*** +

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

[$messageMediaGame](../constructors/messageMediaGame.md) = \['game' => [Game](../types/Game.md), \]; + +*** +

[$messageMediaGeo](../constructors/messageMediaGeo.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), \]; + +*** +

[$messageMediaGeoLive](../constructors/messageMediaGeoLive.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), 'period' => [int](../types/int.md), \]; + +*** +

[$messageMediaInvoice](../constructors/messageMediaInvoice.md) = \['shipping_address_requested' => [Bool](../types/Bool.md), 'test' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [WebDocument](../types/WebDocument.md), 'receipt_msg_id' => [int](../types/int.md), 'currency' => [string](../types/string.md), 'total_amount' => [long](../types/long.md), 'start_param' => [string](../types/string.md), \]; + +*** +

[$messageMediaPhoto](../constructors/messageMediaPhoto.md) = \['photo' => [Photo](../types/Photo.md), 'ttl_seconds' => [int](../types/int.md), \]; + +*** +

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

[$messageMediaVenue](../constructors/messageMediaVenue.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), 'title' => [string](../types/string.md), 'address' => [string](../types/string.md), 'provider' => [string](../types/string.md), 'venue_id' => [string](../types/string.md), 'venue_type' => [string](../types/string.md), \]; + +*** +

[$messageMediaWebPage](../constructors/messageMediaWebPage.md) = \['webpage' => [WebPage](../types/WebPage.md), \]; + +*** +

[$messageRange](../constructors/messageRange.md) = \['min_id' => [int](../types/int.md), 'max_id' => [int](../types/int.md), \]; + +*** +

[$messageService](../constructors/messageService.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'post' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'to_id' => [Peer](../types/Peer.md), 'reply_to_msg_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'action' => [MessageAction](../types/MessageAction.md), \]; + +*** +

[$messages\_affectedHistory](../constructors/messages_affectedHistory.md) = \['pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'offset' => [int](../types/int.md), \]; + +[$messages\_affectedMessages](../constructors/messages_affectedMessages.md) = \['pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +[$messages\_allStickers](../constructors/messages_allStickers.md) = \['hash' => [int](../types/int.md), 'sets' => \[[StickerSet](../types/StickerSet.md)\], \]; + +[$messages\_allStickersNotModified](../constructors/messages_allStickersNotModified.md) = \[\]; + +[$messages\_archivedStickers](../constructors/messages_archivedStickers.md) = \['count' => [int](../types/int.md), 'sets' => \[[StickerSetCovered](../types/StickerSetCovered.md)\], \]; + +[$messages\_botCallbackAnswer](../constructors/messages_botCallbackAnswer.md) = \['alert' => [Bool](../types/Bool.md), 'has_url' => [Bool](../types/Bool.md), 'native_ui' => [Bool](../types/Bool.md), 'message' => [string](../types/string.md), 'url' => [string](../types/string.md), 'cache_time' => [int](../types/int.md), \]; + +[$messages\_botResults](../constructors/messages_botResults.md) = \['gallery' => [Bool](../types/Bool.md), 'query_id' => [long](../types/long.md), 'next_offset' => [string](../types/string.md), 'switch_pm' => [InlineBotSwitchPM](../types/InlineBotSwitchPM.md), 'results' => \[[BotInlineResult](../types/BotInlineResult.md)\], 'cache_time' => [int](../types/int.md), 'users' => \[[User](../types/User.md)\], \]; + +[$messages\_channelMessages](../constructors/messages_channelMessages.md) = \['pts' => [int](../types/int.md), 'count' => [int](../types/int.md), 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$messages\_chatFull](../constructors/messages_chatFull.md) = \['full_chat' => [ChatFull](../types/ChatFull.md), 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$messages\_chats](../constructors/messages_chats.md) = \['chats' => \[[Chat](../types/Chat.md)\], \]; + +[$messages\_chatsSlice](../constructors/messages_chatsSlice.md) = \['count' => [int](../types/int.md), 'chats' => \[[Chat](../types/Chat.md)\], \]; + +[$messages\_dhConfig](../constructors/messages_dhConfig.md) = \['g' => [int](../types/int.md), 'p' => [bytes](../types/bytes.md), 'version' => [int](../types/int.md), 'random' => [bytes](../types/bytes.md), \]; + +[$messages\_dhConfigNotModified](../constructors/messages_dhConfigNotModified.md) = \['random' => [bytes](../types/bytes.md), \]; + +[$messages\_dialogs](../constructors/messages_dialogs.md) = \['dialogs' => \[[Dialog](../types/Dialog.md)\], 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$messages\_dialogsSlice](../constructors/messages_dialogsSlice.md) = \['count' => [int](../types/int.md), 'dialogs' => \[[Dialog](../types/Dialog.md)\], 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$messages\_favedStickers](../constructors/messages_favedStickers.md) = \['hash' => [int](../types/int.md), 'packs' => \[[StickerPack](../types/StickerPack.md)\], 'stickers' => \[[Document](../types/Document.md)\], \]; + +[$messages\_favedStickersNotModified](../constructors/messages_favedStickersNotModified.md) = \[\]; + +[$messages\_featuredStickers](../constructors/messages_featuredStickers.md) = \['hash' => [int](../types/int.md), 'sets' => \[[StickerSetCovered](../types/StickerSetCovered.md)\], 'unread' => \[[long](../types/long.md)\], \]; + +[$messages\_featuredStickersNotModified](../constructors/messages_featuredStickersNotModified.md) = \[\]; + +[$messages\_foundGifs](../constructors/messages_foundGifs.md) = \['next_offset' => [int](../types/int.md), 'results' => \[[FoundGif](../types/FoundGif.md)\], \]; + +[$messages\_foundStickerSets](../constructors/messages_foundStickerSets.md) = \['hash' => [int](../types/int.md), 'sets' => \[[StickerSetCovered](../types/StickerSetCovered.md)\], \]; + +[$messages\_foundStickerSetsNotModified](../constructors/messages_foundStickerSetsNotModified.md) = \[\]; + +[$messages\_highScores](../constructors/messages_highScores.md) = \['scores' => \[[HighScore](../types/HighScore.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$messages\_messageEditData](../constructors/messages_messageEditData.md) = \['caption' => [Bool](../types/Bool.md), \]; + +[$messages\_messages](../constructors/messages_messages.md) = \['messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$messages\_messagesNotModified](../constructors/messages_messagesNotModified.md) = \['count' => [int](../types/int.md), \]; + +[$messages\_messagesSlice](../constructors/messages_messagesSlice.md) = \['count' => [int](../types/int.md), 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$messages\_peerDialogs](../constructors/messages_peerDialogs.md) = \['dialogs' => \[[Dialog](../types/Dialog.md)\], 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], 'state' => [updates\_State](../types/updates_State.md), \]; + +[$messages\_recentStickers](../constructors/messages_recentStickers.md) = \['hash' => [int](../types/int.md), 'packs' => \[[StickerPack](../types/StickerPack.md)\], 'stickers' => \[[Document](../types/Document.md)\], 'dates' => \[[int](../types/int.md)\], \]; + +[$messages\_recentStickersNotModified](../constructors/messages_recentStickersNotModified.md) = \[\]; + +[$messages\_savedGifs](../constructors/messages_savedGifs.md) = \['hash' => [int](../types/int.md), 'gifs' => \[[Document](../types/Document.md)\], \]; + +[$messages\_savedGifsNotModified](../constructors/messages_savedGifsNotModified.md) = \[\]; + +[$messages\_sentEncryptedFile](../constructors/messages_sentEncryptedFile.md) = \['date' => [int](../types/int.md), 'file' => [EncryptedFile](../types/EncryptedFile.md), \]; + +[$messages\_sentEncryptedMessage](../constructors/messages_sentEncryptedMessage.md) = \['date' => [int](../types/int.md), \]; + +[$messages\_stickerSet](../constructors/messages_stickerSet.md) = \['set' => [StickerSet](../types/StickerSet.md), 'packs' => \[[StickerPack](../types/StickerPack.md)\], 'documents' => \[[Document](../types/Document.md)\], \]; + +[$messages\_stickerSetInstallResultArchive](../constructors/messages_stickerSetInstallResultArchive.md) = \['sets' => \[[StickerSetCovered](../types/StickerSetCovered.md)\], \]; + +[$messages\_stickerSetInstallResultSuccess](../constructors/messages_stickerSetInstallResultSuccess.md) = \[\]; + +[$messages\_stickers](../constructors/messages_stickers.md) = \['hash' => [int](../types/int.md), 'stickers' => \[[Document](../types/Document.md)\], \]; + +[$messages\_stickersNotModified](../constructors/messages_stickersNotModified.md) = \[\]; + +*** +

[$nearestDc](../constructors/nearestDc.md) = \['country' => [string](../types/string.md), 'this_dc' => [int](../types/int.md), 'nearest_dc' => [int](../types/int.md), \]; + +*** +

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

[$notifyPeer](../constructors/notifyPeer.md) = \['peer' => [Peer](../types/Peer.md), \]; + +*** +

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

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

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

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

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

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

[$pageBlockChannel](../constructors/pageBlockChannel.md) = \['channel' => [Chat](../types/Chat.md), \]; + +*** +

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

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

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

[$pageBlockEmbed](../constructors/pageBlockEmbed.md) = \['full_width' => [Bool](../types/Bool.md), 'allow_scrolling' => [Bool](../types/Bool.md), 'url' => [string](../types/string.md), 'html' => [string](../types/string.md), 'poster_photo_id' => [long](../types/long.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'caption' => [RichText](../types/RichText.md), \]; + +*** +

[$pageBlockEmbedPost](../constructors/pageBlockEmbedPost.md) = \['url' => [string](../types/string.md), 'webpage_id' => [long](../types/long.md), 'author_photo_id' => [long](../types/long.md), 'author' => [string](../types/string.md), 'date' => [int](../types/int.md), 'blocks' => \[[PageBlock](../types/PageBlock.md)\], 'caption' => [RichText](../types/RichText.md), \]; + +*** +

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

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

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

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

[$pageBlockPhoto](../constructors/pageBlockPhoto.md) = \['photo_id' => [long](../types/long.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) = \['items' => \[[PageBlock](../types/PageBlock.md)\], 'caption' => [RichText](../types/RichText.md), \]; + +*** +

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

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

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

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

[$pageBlockVideo](../constructors/pageBlockVideo.md) = \['autoplay' => [Bool](../types/Bool.md), 'loop' => [Bool](../types/Bool.md), 'video_id' => [long](../types/long.md), 'caption' => [RichText](../types/RichText.md), \]; + +*** +

[$pageFull](../constructors/pageFull.md) = \['blocks' => \[[PageBlock](../types/PageBlock.md)\], 'photos' => \[[Photo](../types/Photo.md)\], 'documents' => \[[Document](../types/Document.md)\], \]; + +*** +

[$pagePart](../constructors/pagePart.md) = \['blocks' => \[[PageBlock](../types/PageBlock.md)\], 'photos' => \[[Photo](../types/Photo.md)\], 'documents' => \[[Document](../types/Document.md)\], \]; + +*** +

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

[$paymentRequestedInfo](../constructors/paymentRequestedInfo.md) = \['name' => [string](../types/string.md), 'phone' => [string](../types/string.md), 'email' => [string](../types/string.md), 'shipping_address' => [PostAddress](../types/PostAddress.md), \]; + +*** +

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

[$payments\_paymentForm](../constructors/payments_paymentForm.md) = \['can_save_credentials' => [Bool](../types/Bool.md), 'password_missing' => [Bool](../types/Bool.md), 'bot_id' => [int](../types/int.md), 'invoice' => [Invoice](../types/Invoice.md), 'provider_id' => [int](../types/int.md), 'url' => [string](../types/string.md), 'native_provider' => [string](../types/string.md), 'native_params' => [DataJSON](../types/DataJSON.md), 'saved_info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), 'saved_credentials' => [PaymentSavedCredentials](../types/PaymentSavedCredentials.md), 'users' => \[[User](../types/User.md)\], \]; + +[$payments\_paymentReceipt](../constructors/payments_paymentReceipt.md) = \['date' => [int](../types/int.md), 'bot_id' => [int](../types/int.md), 'invoice' => [Invoice](../types/Invoice.md), 'provider_id' => [int](../types/int.md), 'info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), 'shipping' => [ShippingOption](../types/ShippingOption.md), 'currency' => [string](../types/string.md), 'total_amount' => [long](../types/long.md), 'credentials_title' => [string](../types/string.md), 'users' => \[[User](../types/User.md)\], \]; + +[$payments\_paymentResult](../constructors/payments_paymentResult.md) = \['updates' => [Updates](../types/Updates.md), \]; + +[$payments\_paymentVerficationNeeded](../constructors/payments_paymentVerficationNeeded.md) = \['url' => [string](../types/string.md), \]; + +[$payments\_savedInfo](../constructors/payments_savedInfo.md) = \['has_saved_credentials' => [Bool](../types/Bool.md), 'saved_info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), \]; + +[$payments\_validatedRequestedInfo](../constructors/payments_validatedRequestedInfo.md) = \['id' => [string](../types/string.md), 'shipping_options' => \[[ShippingOption](../types/ShippingOption.md)\], \]; + +*** +

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

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

[$peerNotifySettings](../constructors/peerNotifySettings.md) = \['show_previews' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'mute_until' => [int](../types/int.md), 'sound' => [string](../types/string.md), \]; + +*** +

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

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

[$phoneCall](../constructors/phoneCall.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), 'g_a_or_b' => [bytes](../types/bytes.md), 'key_fingerprint' => [long](../types/long.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), 'connection' => [PhoneConnection](../types/PhoneConnection.md), 'alternative_connections' => \[[PhoneConnection](../types/PhoneConnection.md)\], 'start_date' => [int](../types/int.md), \]; + +*** +

[$phoneCallAccepted](../constructors/phoneCallAccepted.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), 'g_b' => [bytes](../types/bytes.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), \]; + +*** +

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

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

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

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

[$phoneCallDiscarded](../constructors/phoneCallDiscarded.md) = \['need_rating' => [Bool](../types/Bool.md), 'need_debug' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'reason' => [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md), 'duration' => [int](../types/int.md), \]; + +*** +

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

[$phoneCallProtocol](../constructors/phoneCallProtocol.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), \]; + +*** +

[$phoneCallRequested](../constructors/phoneCallRequested.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), 'g_a_hash' => [bytes](../types/bytes.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), \]; + +*** +

[$phoneCallWaiting](../constructors/phoneCallWaiting.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'admin_id' => [int](../types/int.md), 'participant_id' => [int](../types/int.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), 'receive_date' => [int](../types/int.md), \]; + +*** +

[$phoneConnection](../constructors/phoneConnection.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), \]; + +*** +

[$phone\_phoneCall](../constructors/phone_phoneCall.md) = \['phone_call' => [PhoneCall](../types/PhoneCall.md), 'users' => \[[User](../types/User.md)\], \]; + +*** +

[$photo](../constructors/photo.md) = \['has_stickers' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'date' => [int](../types/int.md), 'sizes' => \[[PhotoSize](../types/PhotoSize.md)\], \]; + +*** +

[$photoCachedSize](../constructors/photoCachedSize.md) = \['type' => [string](../types/string.md), 'location' => [FileLocation](../types/FileLocation.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]; + +*** +

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

[$photoSize](../constructors/photoSize.md) = \['type' => [string](../types/string.md), 'location' => [FileLocation](../types/FileLocation.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'size' => [int](../types/int.md), \]; + +*** +

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

[$photos\_photo](../constructors/photos_photo.md) = \['photo' => [Photo](../types/Photo.md), 'users' => \[[User](../types/User.md)\], \]; + +[$photos\_photos](../constructors/photos_photos.md) = \['photos' => \[[Photo](../types/Photo.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$photos\_photosSlice](../constructors/photos_photosSlice.md) = \['count' => [int](../types/int.md), 'photos' => \[[Photo](../types/Photo.md)\], 'users' => \[[User](../types/User.md)\], \]; + +*** +

[$popularContact](../constructors/popularContact.md) = \['client_id' => [long](../types/long.md), 'importers' => [int](../types/int.md), \]; + +*** +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[$replyInlineMarkup](../constructors/replyInlineMarkup.md) = \['rows' => \[[KeyboardButtonRow](../types/KeyboardButtonRow.md)\], \]; + +*** +

[$replyKeyboardForceReply](../constructors/replyKeyboardForceReply.md) = \['single_use' => [Bool](../types/Bool.md), 'selective' => [Bool](../types/Bool.md), \]; + +*** +

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

[$replyKeyboardMarkup](../constructors/replyKeyboardMarkup.md) = \['resize' => [Bool](../types/Bool.md), 'single_use' => [Bool](../types/Bool.md), 'selective' => [Bool](../types/Bool.md), 'rows' => \[[KeyboardButtonRow](../types/KeyboardButtonRow.md)\], \]; + +*** +

[$savedPhoneContact](../constructors/savedPhoneContact.md) = \['phone' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'date' => [int](../types/int.md), \]; + +*** +

[$secureCredentialsEncrypted](../constructors/secureCredentialsEncrypted.md) = \['data' => [bytes](../types/bytes.md), 'hash' => [bytes](../types/bytes.md), 'secret' => [bytes](../types/bytes.md), \]; + +*** +

[$secureData](../constructors/secureData.md) = \['data' => [bytes](../types/bytes.md), 'data_hash' => [bytes](../types/bytes.md), 'secret' => [bytes](../types/bytes.md), \]; + +*** +

[$secureFile](../constructors/secureFile.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'size' => [int](../types/int.md), 'dc_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'file_hash' => [bytes](../types/bytes.md), 'secret' => [bytes](../types/bytes.md), \]; + +*** +

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

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

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

[$secureValue](../constructors/secureValue.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'data' => [SecureData](../types/SecureData.md), 'front_side' => [SecureFile](../types/SecureFile.md), 'reverse_side' => [SecureFile](../types/SecureFile.md), 'selfie' => [SecureFile](../types/SecureFile.md), 'files' => \[[SecureFile](../types/SecureFile.md)\], 'plain_data' => [SecurePlainData](../types/SecurePlainData.md), 'hash' => [bytes](../types/bytes.md), \]; + +*** +

[$secureValueErrorData](../constructors/secureValueErrorData.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'data_hash' => [bytes](../types/bytes.md), 'field' => [string](../types/string.md), 'text' => [string](../types/string.md), \]; + +*** +

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

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

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

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

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

[$secureValueHash](../constructors/secureValueHash.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'hash' => [bytes](../types/bytes.md), \]; + +*** +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[$stickerPack](../constructors/stickerPack.md) = \['emoticon' => [string](../types/string.md), 'documents' => \[[long](../types/long.md)\], \]; + +*** +

[$stickerSet](../constructors/stickerSet.md) = \['archived' => [Bool](../types/Bool.md), 'official' => [Bool](../types/Bool.md), 'masks' => [Bool](../types/Bool.md), 'installed_date' => [int](../types/int.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'title' => [string](../types/string.md), 'short_name' => [string](../types/string.md), 'count' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]; + +*** +

[$stickerSetCovered](../constructors/stickerSetCovered.md) = \['set' => [StickerSet](../types/StickerSet.md), 'cover' => [Document](../types/Document.md), \]; + +*** +

[$stickerSetMultiCovered](../constructors/stickerSetMultiCovered.md) = \['set' => [StickerSet](../types/StickerSet.md), 'covers' => \[[Document](../types/Document.md)\], \]; + +*** +

[$storage\_fileGif](../constructors/storage_fileGif.md) = \[\]; + +[$storage\_fileJpeg](../constructors/storage_fileJpeg.md) = \[\]; + +[$storage\_fileMov](../constructors/storage_fileMov.md) = \[\]; + +[$storage\_fileMp3](../constructors/storage_fileMp3.md) = \[\]; + +[$storage\_fileMp4](../constructors/storage_fileMp4.md) = \[\]; + +[$storage\_filePartial](../constructors/storage_filePartial.md) = \[\]; + +[$storage\_filePdf](../constructors/storage_filePdf.md) = \[\]; + +[$storage\_filePng](../constructors/storage_filePng.md) = \[\]; + +[$storage\_fileUnknown](../constructors/storage_fileUnknown.md) = \[\]; + +[$storage\_fileWebp](../constructors/storage_fileWebp.md) = \[\]; + +*** +

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

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

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

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

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

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

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

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

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

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

[$topPeer](../constructors/topPeer.md) = \['peer' => [Peer](../types/Peer.md), 'rating' => [double](../types/double.md), \]; + +*** +

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

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

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

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

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

[$topPeerCategoryPeers](../constructors/topPeerCategoryPeers.md) = \['category' => [TopPeerCategory](../types/TopPeerCategory.md), 'count' => [int](../types/int.md), 'peers' => \[[TopPeer](../types/TopPeer.md)\], \]; + +*** +

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

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

[$updateBotCallbackQuery](../constructors/updateBotCallbackQuery.md) = \['query_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'peer' => [Peer](../types/Peer.md), 'msg_id' => [int](../types/int.md), 'chat_instance' => [long](../types/long.md), 'data' => [bytes](../types/bytes.md), 'game_short_name' => [string](../types/string.md), \]; + +*** +

[$updateBotInlineQuery](../constructors/updateBotInlineQuery.md) = \['query_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'query' => [string](../types/string.md), 'geo' => [GeoPoint](../types/GeoPoint.md), 'offset' => [string](../types/string.md), \]; + +*** +

[$updateBotInlineSend](../constructors/updateBotInlineSend.md) = \['user_id' => [int](../types/int.md), 'query' => [string](../types/string.md), 'geo' => [GeoPoint](../types/GeoPoint.md), 'id' => [string](../types/string.md), 'msg_id' => [InputBotInlineMessageID](../types/InputBotInlineMessageID.md), \]; + +*** +

[$updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) = \['query_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'payload' => [bytes](../types/bytes.md), 'info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), 'shipping_option_id' => [string](../types/string.md), 'currency' => [string](../types/string.md), 'total_amount' => [long](../types/long.md), \]; + +*** +

[$updateBotShippingQuery](../constructors/updateBotShippingQuery.md) = \['query_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'payload' => [bytes](../types/bytes.md), 'shipping_address' => [PostAddress](../types/PostAddress.md), \]; + +*** +

[$updateBotWebhookJSON](../constructors/updateBotWebhookJSON.md) = \['data' => [DataJSON](../types/DataJSON.md), \]; + +*** +

[$updateBotWebhookJSONQuery](../constructors/updateBotWebhookJSONQuery.md) = \['query_id' => [long](../types/long.md), 'data' => [DataJSON](../types/DataJSON.md), 'timeout' => [int](../types/int.md), \]; + +*** +

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

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

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

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

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

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

[$updateChannelWebPage](../constructors/updateChannelWebPage.md) = \['channel_id' => [int](../types/int.md), 'webpage' => [WebPage](../types/WebPage.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +

[$updateChatAdmins](../constructors/updateChatAdmins.md) = \['chat_id' => [int](../types/int.md), 'enabled' => [Bool](../types/Bool.md), 'version' => [int](../types/int.md), \]; + +*** +

[$updateChatParticipantAdd](../constructors/updateChatParticipantAdd.md) = \['chat_id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'inviter_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'version' => [int](../types/int.md), \]; + +*** +

[$updateChatParticipantAdmin](../constructors/updateChatParticipantAdmin.md) = \['chat_id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'is_admin' => [Bool](../types/Bool.md), 'version' => [int](../types/int.md), \]; + +*** +

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

[$updateChatParticipants](../constructors/updateChatParticipants.md) = \['participants' => [ChatParticipants](../types/ChatParticipants.md), \]; + +*** +

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

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

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

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

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

[$updateDcOptions](../constructors/updateDcOptions.md) = \['dc_options' => \[[DcOption](../types/DcOption.md)\], \]; + +*** +

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

[$updateDeleteMessages](../constructors/updateDeleteMessages.md) = \['messages' => \[[int](../types/int.md)\], 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +

[$updateDialogPinned](../constructors/updateDialogPinned.md) = \['pinned' => [Bool](../types/Bool.md), 'peer' => [DialogPeer](../types/DialogPeer.md), \]; + +*** +

[$updateDraftMessage](../constructors/updateDraftMessage.md) = \['peer' => [Peer](../types/Peer.md), 'draft' => [DraftMessage](../types/DraftMessage.md), \]; + +*** +

[$updateEditChannelMessage](../constructors/updateEditChannelMessage.md) = \['message' => [Message](../types/Message.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +

[$updateEditMessage](../constructors/updateEditMessage.md) = \['message' => [Message](../types/Message.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +

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

[$updateEncryptedMessagesRead](../constructors/updateEncryptedMessagesRead.md) = \['chat_id' => [int](../types/int.md), 'max_date' => [int](../types/int.md), 'date' => [int](../types/int.md), \]; + +*** +

[$updateEncryption](../constructors/updateEncryption.md) = \['chat' => [EncryptedChat](../types/EncryptedChat.md), 'date' => [int](../types/int.md), \]; + +*** +

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

[$updateInlineBotCallbackQuery](../constructors/updateInlineBotCallbackQuery.md) = \['query_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'msg_id' => [InputBotInlineMessageID](../types/InputBotInlineMessageID.md), 'chat_instance' => [long](../types/long.md), 'data' => [bytes](../types/bytes.md), 'game_short_name' => [string](../types/string.md), \]; + +*** +

[$updateLangPack](../constructors/updateLangPack.md) = \['difference' => [LangPackDifference](../types/LangPackDifference.md), \]; + +*** +

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

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

[$updateNewChannelMessage](../constructors/updateNewChannelMessage.md) = \['message' => [Message](../types/Message.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +

[$updateNewEncryptedMessage](../constructors/updateNewEncryptedMessage.md) = \['message' => [EncryptedMessage](../types/EncryptedMessage.md), 'qts' => [int](../types/int.md), \]; + +*** +

[$updateNewMessage](../constructors/updateNewMessage.md) = \['message' => [Message](../types/Message.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +

[$updateNewStickerSet](../constructors/updateNewStickerSet.md) = \['stickerset' => [messages\_StickerSet](../types/messages_StickerSet.md), \]; + +*** +

[$updateNotifySettings](../constructors/updateNotifySettings.md) = \['peer' => [NotifyPeer](../types/NotifyPeer.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), \]; + +*** +

[$updatePhoneCall](../constructors/updatePhoneCall.md) = \['phone_call' => [PhoneCall](../types/PhoneCall.md), \]; + +*** +

[$updatePinnedDialogs](../constructors/updatePinnedDialogs.md) = \['order' => \[[DialogPeer](../types/DialogPeer.md)\], \]; + +*** +

[$updatePrivacy](../constructors/updatePrivacy.md) = \['key' => [PrivacyKey](../types/PrivacyKey.md), 'rules' => \[[PrivacyRule](../types/PrivacyRule.md)\], \]; + +*** +

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

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

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

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

[$updateReadHistoryInbox](../constructors/updateReadHistoryInbox.md) = \['peer' => [Peer](../types/Peer.md), 'max_id' => [int](../types/int.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +

[$updateReadHistoryOutbox](../constructors/updateReadHistoryOutbox.md) = \['peer' => [Peer](../types/Peer.md), 'max_id' => [int](../types/int.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +

[$updateReadMessagesContents](../constructors/updateReadMessagesContents.md) = \['messages' => \[[int](../types/int.md)\], 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +

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

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

[$updateServiceNotification](../constructors/updateServiceNotification.md) = \['popup' => [Bool](../types/Bool.md), 'inbox_date' => [int](../types/int.md), 'type' => [string](../types/string.md), 'message' => [string](../types/string.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; + +*** +

[$updateShort](../constructors/updateShort.md) = \['update' => [Update](../types/Update.md), 'date' => [int](../types/int.md), \]; + +*** +

[$updateShortChatMessage](../constructors/updateShortChatMessage.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'from_id' => [int](../types/int.md), 'chat_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; + +*** +

[$updateShortMessage](../constructors/updateShortMessage.md) = \['out' => [Bool](../types/Bool.md), 'mentioned' => [Bool](../types/Bool.md), 'media_unread' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'user_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'fwd_from' => [MessageFwdHeader](../types/MessageFwdHeader.md), 'via_bot_id' => [int](../types/int.md), 'reply_to_msg_id' => [int](../types/int.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; + +*** +

[$updateShortSentMessage](../constructors/updateShortSentMessage.md) = \['out' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'date' => [int](../types/int.md), 'media' => [MessageMedia](../types/MessageMedia.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]; + +*** +

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

[$updateStickerSetsOrder](../constructors/updateStickerSetsOrder.md) = \['masks' => [Bool](../types/Bool.md), 'order' => \[[long](../types/long.md)\], \]; + +*** +

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

[$updateUserName](../constructors/updateUserName.md) = \['user_id' => [int](../types/int.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'username' => [string](../types/string.md), \]; + +*** +

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

[$updateUserPhoto](../constructors/updateUserPhoto.md) = \['user_id' => [int](../types/int.md), 'date' => [int](../types/int.md), 'photo' => [UserProfilePhoto](../types/UserProfilePhoto.md), 'previous' => [Bool](../types/Bool.md), \]; + +*** +

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

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

[$updateWebPage](../constructors/updateWebPage.md) = \['webpage' => [WebPage](../types/WebPage.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; + +*** +

[$updates](../constructors/updates.md) = \['updates' => \[[Update](../types/Update.md)\], 'users' => \[[User](../types/User.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'date' => [int](../types/int.md), 'seq' => [int](../types/int.md), \]; + +*** +

[$updatesCombined](../constructors/updatesCombined.md) = \['updates' => \[[Update](../types/Update.md)\], 'users' => \[[User](../types/User.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'date' => [int](../types/int.md), 'seq_start' => [int](../types/int.md), 'seq' => [int](../types/int.md), \]; + +*** +

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

[$updates\_channelDifference](../constructors/updates_channelDifference.md) = \['final' => [Bool](../types/Bool.md), 'pts' => [int](../types/int.md), 'timeout' => [int](../types/int.md), 'new_messages' => \[[Message](../types/Message.md)\], 'other_updates' => \[[Update](../types/Update.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$updates\_channelDifferenceEmpty](../constructors/updates_channelDifferenceEmpty.md) = \['final' => [Bool](../types/Bool.md), 'pts' => [int](../types/int.md), 'timeout' => [int](../types/int.md), \]; + +[$updates\_channelDifferenceTooLong](../constructors/updates_channelDifferenceTooLong.md) = \['final' => [Bool](../types/Bool.md), 'pts' => [int](../types/int.md), 'timeout' => [int](../types/int.md), 'top_message' => [int](../types/int.md), 'read_inbox_max_id' => [int](../types/int.md), 'read_outbox_max_id' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), 'unread_mentions_count' => [int](../types/int.md), 'messages' => \[[Message](../types/Message.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + +[$updates\_difference](../constructors/updates_difference.md) = \['new_messages' => \[[Message](../types/Message.md)\], 'new_encrypted_messages' => \[[EncryptedMessage](../types/EncryptedMessage.md)\], 'other_updates' => \[[Update](../types/Update.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], 'state' => [updates\_State](../types/updates_State.md), \]; + +[$updates\_differenceEmpty](../constructors/updates_differenceEmpty.md) = \['date' => [int](../types/int.md), 'seq' => [int](../types/int.md), \]; + +[$updates\_differenceSlice](../constructors/updates_differenceSlice.md) = \['new_messages' => \[[Message](../types/Message.md)\], 'new_encrypted_messages' => \[[EncryptedMessage](../types/EncryptedMessage.md)\], 'other_updates' => \[[Update](../types/Update.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], 'intermediate_state' => [updates\_State](../types/updates_State.md), \]; + +[$updates\_differenceTooLong](../constructors/updates_differenceTooLong.md) = \['pts' => [int](../types/int.md), \]; + +[$updates\_state](../constructors/updates_state.md) = \['pts' => [int](../types/int.md), 'qts' => [int](../types/int.md), 'date' => [int](../types/int.md), 'seq' => [int](../types/int.md), 'unread_count' => [int](../types/int.md), \]; + +*** +

[$upload\_cdnFile](../constructors/upload_cdnFile.md) = \['bytes' => [bytes](../types/bytes.md), \]; + +[$upload\_cdnFileReuploadNeeded](../constructors/upload_cdnFileReuploadNeeded.md) = \['request_token' => [bytes](../types/bytes.md), \]; + +[$upload\_file](../constructors/upload_file.md) = \['type' => [storage\_FileType](../types/storage_FileType.md), 'mtime' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]; + +[$upload\_fileCdnRedirect](../constructors/upload_fileCdnRedirect.md) = \['dc_id' => [int](../types/int.md), 'file_token' => [bytes](../types/bytes.md), 'encryption_key' => [bytes](../types/bytes.md), 'encryption_iv' => [bytes](../types/bytes.md), 'file_hashes' => \[[FileHash](../types/FileHash.md)\], \]; + +[$upload\_webFile](../constructors/upload_webFile.md) = \['size' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'file_type' => [storage\_FileType](../types/storage_FileType.md), 'mtime' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]; + +*** +

[$user](../constructors/user.md) = \['self' => [Bool](../types/Bool.md), 'contact' => [Bool](../types/Bool.md), 'mutual_contact' => [Bool](../types/Bool.md), 'deleted' => [Bool](../types/Bool.md), 'bot' => [Bool](../types/Bool.md), 'bot_chat_history' => [Bool](../types/Bool.md), 'bot_nochats' => [Bool](../types/Bool.md), 'verified' => [Bool](../types/Bool.md), 'restricted' => [Bool](../types/Bool.md), 'min' => [Bool](../types/Bool.md), 'bot_inline_geo' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'access_hash' => [long](../types/long.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'username' => [string](../types/string.md), 'phone' => [string](../types/string.md), 'photo' => [UserProfilePhoto](../types/UserProfilePhoto.md), 'status' => [UserStatus](../types/UserStatus.md), 'bot_info_version' => [int](../types/int.md), 'restriction_reason' => [string](../types/string.md), 'bot_inline_placeholder' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), \]; + +*** +

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

[$userFull](../constructors/userFull.md) = \['blocked' => [Bool](../types/Bool.md), 'phone_calls_available' => [Bool](../types/Bool.md), 'phone_calls_private' => [Bool](../types/Bool.md), 'user' => [User](../types/User.md), 'about' => [string](../types/string.md), 'link' => [contacts\_Link](../types/contacts_Link.md), 'profile_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'bot_info' => [BotInfo](../types/BotInfo.md), 'common_chats_count' => [int](../types/int.md), \]; + +*** +

[$userProfilePhoto](../constructors/userProfilePhoto.md) = \['photo_id' => [long](../types/long.md), 'photo_small' => [FileLocation](../types/FileLocation.md), 'photo_big' => [FileLocation](../types/FileLocation.md), \]; + +*** +

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

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

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

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

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

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

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

[$wallPaper](../constructors/wallPaper.md) = \['id' => [int](../types/int.md), 'title' => [string](../types/string.md), 'sizes' => \[[PhotoSize](../types/PhotoSize.md)\], 'color' => [int](../types/int.md), \]; + +*** +

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

[$webAuthorization](../constructors/webAuthorization.md) = \['hash' => [long](../types/long.md), 'bot_id' => [int](../types/int.md), 'domain' => [string](../types/string.md), 'browser' => [string](../types/string.md), 'platform' => [string](../types/string.md), 'date_created' => [int](../types/int.md), 'date_active' => [int](../types/int.md), 'ip' => [string](../types/string.md), 'region' => [string](../types/string.md), \]; + +*** +

[$webDocument](../constructors/webDocument.md) = \['url' => [string](../types/string.md), 'access_hash' => [long](../types/long.md), 'size' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], 'dc_id' => [int](../types/int.md), \]; + +*** +

[$webDocumentNoProxy](../constructors/webDocumentNoProxy.md) = \['url' => [string](../types/string.md), 'size' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'attributes' => \[[DocumentAttribute](../types/DocumentAttribute.md)\], \]; + +*** +

[$webPage](../constructors/webPage.md) = \['id' => [long](../types/long.md), 'url' => [string](../types/string.md), 'display_url' => [string](../types/string.md), 'hash' => [int](../types/int.md), 'type' => [string](../types/string.md), 'site_name' => [string](../types/string.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo' => [Photo](../types/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), 'document' => [Document](../types/Document.md), 'cached_page' => [Page](../types/Page.md), \]; + +*** +

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

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

[$webPagePending](../constructors/webPagePending.md) = \['id' => [long](../types/long.md), 'date' => [int](../types/int.md), \]; + diff --git a/old_docs/API_docs_v81/constructors/accessPointRule.md b/old_docs/API_docs_v81/constructors/accessPointRule.md new file mode 100644 index 00000000..22ff5179 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/accessPointRule.md @@ -0,0 +1,45 @@ +--- +title: accessPointRule +description: accessPointRule attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: accessPointRule +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone\_prefix\_rules|[string](../types/string.md) | Yes| +|dc\_id|[int](../types/int.md) | Yes| +|ips|Array of [IpPort](../types/IpPort.md) | Yes| + + + +### Type: [AccessPointRule](../types/AccessPointRule.md) + + +### Example: + +``` +$accessPointRule = ['_' => 'accessPointRule', 'phone_prefix_rules' => 'string', 'dc_id' => int, 'ips' => [IpPort, IpPort]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "accessPointRule", "phone_prefix_rules": "string", "dc_id": int, "ips": [IpPort]} +``` + + +Or, if you're into Lua: + + +``` +accessPointRule={_='accessPointRule', phone_prefix_rules='string', dc_id=int, ips={IpPort}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/accountDaysTTL.md b/old_docs/API_docs_v81/constructors/accountDaysTTL.md new file mode 100644 index 00000000..bf5f1e0a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/accountDaysTTL.md @@ -0,0 +1,43 @@ +--- +title: accountDaysTTL +description: accountDaysTTL attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: accountDaysTTL +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|days|[int](../types/int.md) | Yes| + + + +### Type: [AccountDaysTTL](../types/AccountDaysTTL.md) + + +### Example: + +``` +$accountDaysTTL = ['_' => 'accountDaysTTL', 'days' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "accountDaysTTL", "days": int} +``` + + +Or, if you're into Lua: + + +``` +accountDaysTTL={_='accountDaysTTL', days=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/account_authorizationForm.md b/old_docs/API_docs_v81/constructors/account_authorizationForm.md new file mode 100644 index 00000000..833eade6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/account_authorizationForm.md @@ -0,0 +1,48 @@ +--- +title: account.authorizationForm +description: account_authorizationForm attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: account.authorizationForm +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|selfie\_required|[Bool](../types/Bool.md) | Optional| +|required\_types|Array of [SecureValueType](../types/SecureValueType.md) | Yes| +|values|Array of [SecureValue](../types/SecureValue.md) | Yes| +|errors|Array of [SecureValueError](../types/SecureValueError.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| +|privacy\_policy\_url|[string](../types/string.md) | Optional| + + + +### Type: [account\_AuthorizationForm](../types/account_AuthorizationForm.md) + + +### Example: + +``` +$account_authorizationForm = ['_' => 'account.authorizationForm', 'selfie_required' => Bool, 'required_types' => [SecureValueType, SecureValueType], 'values' => [SecureValue, SecureValue], 'errors' => [SecureValueError, SecureValueError], 'users' => [User, User], 'privacy_policy_url' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "account.authorizationForm", "selfie_required": Bool, "required_types": [SecureValueType], "values": [SecureValue], "errors": [SecureValueError], "users": [User], "privacy_policy_url": "string"} +``` + + +Or, if you're into Lua: + + +``` +account_authorizationForm={_='account.authorizationForm', selfie_required=Bool, required_types={SecureValueType}, values={SecureValue}, errors={SecureValueError}, users={User}, privacy_policy_url='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/account_authorizations.md b/old_docs/API_docs_v81/constructors/account_authorizations.md new file mode 100644 index 00000000..faf72ed1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/account_authorizations.md @@ -0,0 +1,43 @@ +--- +title: account.authorizations +description: account_authorizations attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: account.authorizations +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|authorizations|Array of [Authorization](../types/Authorization.md) | Yes| + + + +### Type: [account\_Authorizations](../types/account_Authorizations.md) + + +### Example: + +``` +$account_authorizations = ['_' => 'account.authorizations', 'authorizations' => [Authorization, Authorization]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "account.authorizations", "authorizations": [Authorization]} +``` + + +Or, if you're into Lua: + + +``` +account_authorizations={_='account.authorizations', authorizations={Authorization}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/account_noPassword.md b/old_docs/API_docs_v81/constructors/account_noPassword.md new file mode 100644 index 00000000..5fa62aac --- /dev/null +++ b/old_docs/API_docs_v81/constructors/account_noPassword.md @@ -0,0 +1,46 @@ +--- +title: account.noPassword +description: account_noPassword attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: account.noPassword +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|new\_salt|[bytes](../types/bytes.md) | Yes| +|new\_secure\_salt|[bytes](../types/bytes.md) | Yes| +|secure\_random|[bytes](../types/bytes.md) | Yes| +|email\_unconfirmed\_pattern|[string](../types/string.md) | Yes| + + + +### Type: [account\_Password](../types/account_Password.md) + + +### Example: + +``` +$account_noPassword = ['_' => 'account.noPassword', 'new_salt' => 'bytes', 'new_secure_salt' => 'bytes', 'secure_random' => 'bytes', 'email_unconfirmed_pattern' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "account.noPassword", "new_salt": {"_": "bytes", "bytes":"base64 encoded bytes"}, "new_secure_salt": {"_": "bytes", "bytes":"base64 encoded bytes"}, "secure_random": {"_": "bytes", "bytes":"base64 encoded bytes"}, "email_unconfirmed_pattern": "string"} +``` + + +Or, if you're into Lua: + + +``` +account_noPassword={_='account.noPassword', new_salt='bytes', new_secure_salt='bytes', secure_random='bytes', email_unconfirmed_pattern='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/account_password.md b/old_docs/API_docs_v81/constructors/account_password.md new file mode 100644 index 00000000..b668cc9b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/account_password.md @@ -0,0 +1,50 @@ +--- +title: account.password +description: account_password attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: account.password +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|has\_recovery|[Bool](../types/Bool.md) | Optional| +|has\_secure\_values|[Bool](../types/Bool.md) | Optional| +|current\_salt|[bytes](../types/bytes.md) | Yes| +|new\_salt|[bytes](../types/bytes.md) | Yes| +|new\_secure\_salt|[bytes](../types/bytes.md) | Yes| +|secure\_random|[bytes](../types/bytes.md) | Yes| +|hint|[string](../types/string.md) | Yes| +|email\_unconfirmed\_pattern|[string](../types/string.md) | Yes| + + + +### Type: [account\_Password](../types/account_Password.md) + + +### Example: + +``` +$account_password = ['_' => 'account.password', 'has_recovery' => Bool, 'has_secure_values' => Bool, 'current_salt' => 'bytes', 'new_salt' => 'bytes', 'new_secure_salt' => 'bytes', 'secure_random' => 'bytes', 'hint' => 'string', 'email_unconfirmed_pattern' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "account.password", "has_recovery": Bool, "has_secure_values": Bool, "current_salt": {"_": "bytes", "bytes":"base64 encoded bytes"}, "new_salt": {"_": "bytes", "bytes":"base64 encoded bytes"}, "new_secure_salt": {"_": "bytes", "bytes":"base64 encoded bytes"}, "secure_random": {"_": "bytes", "bytes":"base64 encoded bytes"}, "hint": "string", "email_unconfirmed_pattern": "string"} +``` + + +Or, if you're into Lua: + + +``` +account_password={_='account.password', has_recovery=Bool, has_secure_values=Bool, current_salt='bytes', new_salt='bytes', new_secure_salt='bytes', secure_random='bytes', hint='string', email_unconfirmed_pattern='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/account_passwordInputSettings.md b/old_docs/API_docs_v81/constructors/account_passwordInputSettings.md new file mode 100644 index 00000000..07f77e32 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/account_passwordInputSettings.md @@ -0,0 +1,51 @@ +--- +title: account.passwordInputSettings +description: 2FA password settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: account.passwordInputSettings +[Back to constructors index](index.md) + + + +2FA password settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|new\_salt|[bytes](../types/bytes.md) | Optional|`$new_salt = $MadelineProto->account->getPassword()['new_salt'].$MadelineProto->random(8);`| +|new\_password\_hash|[bytes](../types/bytes.md) | Optional|`hash('sha256', $new_salt.$new_password.$new_salt, true)`| +|hint|[string](../types/string.md) | Optional|| +|email|[string](../types/string.md) | Optional|| +|new\_secure\_salt|[bytes](../types/bytes.md) | Optional|| +|new\_secure\_secret|[bytes](../types/bytes.md) | Optional|| +|new\_secure\_secret\_id|[long](../types/long.md) | Optional|| + + + +### Type: [account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) + + +### Example: + +``` +$account_passwordInputSettings = ['_' => 'account.passwordInputSettings', 'new_salt' => 'bytes', 'new_password_hash' => 'bytes', 'hint' => 'string', 'email' => 'string', 'new_secure_salt' => 'bytes', 'new_secure_secret' => 'bytes', 'new_secure_secret_id' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "account.passwordInputSettings", "new_salt": {"_": "bytes", "bytes":"base64 encoded bytes"}, "new_password_hash": {"_": "bytes", "bytes":"base64 encoded bytes"}, "hint": "string", "email": "string", "new_secure_salt": {"_": "bytes", "bytes":"base64 encoded bytes"}, "new_secure_secret": {"_": "bytes", "bytes":"base64 encoded bytes"}, "new_secure_secret_id": long} +``` + + +Or, if you're into Lua: + + +``` +account_passwordInputSettings={_='account.passwordInputSettings', new_salt='bytes', new_password_hash='bytes', hint='string', email='string', new_secure_salt='bytes', new_secure_secret='bytes', new_secure_secret_id=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/account_passwordSettings.md b/old_docs/API_docs_v81/constructors/account_passwordSettings.md new file mode 100644 index 00000000..79451480 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/account_passwordSettings.md @@ -0,0 +1,46 @@ +--- +title: account.passwordSettings +description: account_passwordSettings attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: account.passwordSettings +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|email|[string](../types/string.md) | Yes| +|secure\_salt|[bytes](../types/bytes.md) | Yes| +|secure\_secret|[bytes](../types/bytes.md) | Yes| +|secure\_secret\_id|[long](../types/long.md) | Yes| + + + +### Type: [account\_PasswordSettings](../types/account_PasswordSettings.md) + + +### Example: + +``` +$account_passwordSettings = ['_' => 'account.passwordSettings', 'email' => 'string', 'secure_salt' => 'bytes', 'secure_secret' => 'bytes', 'secure_secret_id' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "account.passwordSettings", "email": "string", "secure_salt": {"_": "bytes", "bytes":"base64 encoded bytes"}, "secure_secret": {"_": "bytes", "bytes":"base64 encoded bytes"}, "secure_secret_id": long} +``` + + +Or, if you're into Lua: + + +``` +account_passwordSettings={_='account.passwordSettings', email='string', secure_salt='bytes', secure_secret='bytes', secure_secret_id=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/account_privacyRules.md b/old_docs/API_docs_v81/constructors/account_privacyRules.md new file mode 100644 index 00000000..2833c71a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/account_privacyRules.md @@ -0,0 +1,44 @@ +--- +title: account.privacyRules +description: account_privacyRules attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: account.privacyRules +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [account\_PrivacyRules](../types/account_PrivacyRules.md) + + +### Example: + +``` +$account_privacyRules = ['_' => 'account.privacyRules', 'rules' => [PrivacyRule, PrivacyRule], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "account.privacyRules", "rules": [PrivacyRule], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +account_privacyRules={_='account.privacyRules', rules={PrivacyRule}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/account_sentEmailCode.md b/old_docs/API_docs_v81/constructors/account_sentEmailCode.md new file mode 100644 index 00000000..cb6dfdd6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/account_sentEmailCode.md @@ -0,0 +1,44 @@ +--- +title: account.sentEmailCode +description: account_sentEmailCode attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: account.sentEmailCode +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|email\_pattern|[string](../types/string.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [account\_SentEmailCode](../types/account_SentEmailCode.md) + + +### Example: + +``` +$account_sentEmailCode = ['_' => 'account.sentEmailCode', 'email_pattern' => 'string', 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "account.sentEmailCode", "email_pattern": "string", "length": int} +``` + + +Or, if you're into Lua: + + +``` +account_sentEmailCode={_='account.sentEmailCode', email_pattern='string', length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/account_takeout.md b/old_docs/API_docs_v81/constructors/account_takeout.md new file mode 100644 index 00000000..7c424fd1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/account_takeout.md @@ -0,0 +1,43 @@ +--- +title: account.takeout +description: account_takeout attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: account.takeout +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| + + + +### Type: [account\_Takeout](../types/account_Takeout.md) + + +### Example: + +``` +$account_takeout = ['_' => 'account.takeout', 'id' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "account.takeout", "id": long} +``` + + +Or, if you're into Lua: + + +``` +account_takeout={_='account.takeout', id=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/account_tmpPassword.md b/old_docs/API_docs_v81/constructors/account_tmpPassword.md new file mode 100644 index 00000000..e16b6f3c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/account_tmpPassword.md @@ -0,0 +1,44 @@ +--- +title: account.tmpPassword +description: account_tmpPassword attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: account.tmpPassword +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|tmp\_password|[bytes](../types/bytes.md) | Yes| +|valid\_until|[int](../types/int.md) | Yes| + + + +### Type: [account\_TmpPassword](../types/account_TmpPassword.md) + + +### Example: + +``` +$account_tmpPassword = ['_' => 'account.tmpPassword', 'tmp_password' => 'bytes', 'valid_until' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "account.tmpPassword", "tmp_password": {"_": "bytes", "bytes":"base64 encoded bytes"}, "valid_until": int} +``` + + +Or, if you're into Lua: + + +``` +account_tmpPassword={_='account.tmpPassword', tmp_password='bytes', valid_until=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/account_webAuthorizations.md b/old_docs/API_docs_v81/constructors/account_webAuthorizations.md new file mode 100644 index 00000000..5157ffdc --- /dev/null +++ b/old_docs/API_docs_v81/constructors/account_webAuthorizations.md @@ -0,0 +1,44 @@ +--- +title: account.webAuthorizations +description: account_webAuthorizations attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: account.webAuthorizations +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|authorizations|Array of [WebAuthorization](../types/WebAuthorization.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [account\_WebAuthorizations](../types/account_WebAuthorizations.md) + + +### Example: + +``` +$account_webAuthorizations = ['_' => 'account.webAuthorizations', 'authorizations' => [WebAuthorization, WebAuthorization], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "account.webAuthorizations", "authorizations": [WebAuthorization], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +account_webAuthorizations={_='account.webAuthorizations', authorizations={WebAuthorization}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_authorization.md b/old_docs/API_docs_v81/constructors/auth_authorization.md new file mode 100644 index 00000000..c8133016 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_authorization.md @@ -0,0 +1,44 @@ +--- +title: auth.authorization +description: auth_authorization attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.authorization +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|tmp\_sessions|[int](../types/int.md) | Optional| +|user|[User](../types/User.md) | Optional| + + + +### Type: [auth\_Authorization](../types/auth_Authorization.md) + + +### Example: + +``` +$auth_authorization = ['_' => 'auth.authorization', 'tmp_sessions' => int, 'user' => User]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.authorization", "tmp_sessions": int, "user": User} +``` + + +Or, if you're into Lua: + + +``` +auth_authorization={_='auth.authorization', tmp_sessions=int, user=User} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_checkedPhone.md b/old_docs/API_docs_v81/constructors/auth_checkedPhone.md new file mode 100644 index 00000000..e452a76b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_checkedPhone.md @@ -0,0 +1,43 @@ +--- +title: auth.checkedPhone +description: auth_checkedPhone attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.checkedPhone +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone\_registered|[Bool](../types/Bool.md) | Yes| + + + +### Type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) + + +### Example: + +``` +$auth_checkedPhone = ['_' => 'auth.checkedPhone', 'phone_registered' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.checkedPhone", "phone_registered": Bool} +``` + + +Or, if you're into Lua: + + +``` +auth_checkedPhone={_='auth.checkedPhone', phone_registered=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_codeTypeCall.md b/old_docs/API_docs_v81/constructors/auth_codeTypeCall.md new file mode 100644 index 00000000..6a4f28d1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_codeTypeCall.md @@ -0,0 +1,38 @@ +--- +title: auth.codeTypeCall +description: auth_codeTypeCall attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.codeTypeCall +[Back to constructors index](index.md) + + + + + + +### Type: [auth\_CodeType](../types/auth_CodeType.md) + + +### Example: + +``` +$auth_codeTypeCall = ['_' => 'auth.codeTypeCall']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.codeTypeCall"} +``` + + +Or, if you're into Lua: + + +``` +auth_codeTypeCall={_='auth.codeTypeCall'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_codeTypeFlashCall.md b/old_docs/API_docs_v81/constructors/auth_codeTypeFlashCall.md new file mode 100644 index 00000000..2851bf4e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_codeTypeFlashCall.md @@ -0,0 +1,38 @@ +--- +title: auth.codeTypeFlashCall +description: auth_codeTypeFlashCall attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.codeTypeFlashCall +[Back to constructors index](index.md) + + + + + + +### Type: [auth\_CodeType](../types/auth_CodeType.md) + + +### Example: + +``` +$auth_codeTypeFlashCall = ['_' => 'auth.codeTypeFlashCall']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.codeTypeFlashCall"} +``` + + +Or, if you're into Lua: + + +``` +auth_codeTypeFlashCall={_='auth.codeTypeFlashCall'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_codeTypeSms.md b/old_docs/API_docs_v81/constructors/auth_codeTypeSms.md new file mode 100644 index 00000000..04b78a3d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_codeTypeSms.md @@ -0,0 +1,38 @@ +--- +title: auth.codeTypeSms +description: auth_codeTypeSms attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.codeTypeSms +[Back to constructors index](index.md) + + + + + + +### Type: [auth\_CodeType](../types/auth_CodeType.md) + + +### Example: + +``` +$auth_codeTypeSms = ['_' => 'auth.codeTypeSms']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.codeTypeSms"} +``` + + +Or, if you're into Lua: + + +``` +auth_codeTypeSms={_='auth.codeTypeSms'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_exportedAuthorization.md b/old_docs/API_docs_v81/constructors/auth_exportedAuthorization.md new file mode 100644 index 00000000..9963e394 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_exportedAuthorization.md @@ -0,0 +1,44 @@ +--- +title: auth.exportedAuthorization +description: auth_exportedAuthorization attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.exportedAuthorization +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| +|bytes|[bytes](../types/bytes.md) | Yes| + + + +### Type: [auth\_ExportedAuthorization](../types/auth_ExportedAuthorization.md) + + +### Example: + +``` +$auth_exportedAuthorization = ['_' => 'auth.exportedAuthorization', 'id' => int, 'bytes' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.exportedAuthorization", "id": int, "bytes": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +auth_exportedAuthorization={_='auth.exportedAuthorization', id=int, bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_passwordRecovery.md b/old_docs/API_docs_v81/constructors/auth_passwordRecovery.md new file mode 100644 index 00000000..b38794be --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_passwordRecovery.md @@ -0,0 +1,43 @@ +--- +title: auth.passwordRecovery +description: auth_passwordRecovery attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.passwordRecovery +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|email\_pattern|[string](../types/string.md) | Yes| + + + +### Type: [auth\_PasswordRecovery](../types/auth_PasswordRecovery.md) + + +### Example: + +``` +$auth_passwordRecovery = ['_' => 'auth.passwordRecovery', 'email_pattern' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.passwordRecovery", "email_pattern": "string"} +``` + + +Or, if you're into Lua: + + +``` +auth_passwordRecovery={_='auth.passwordRecovery', email_pattern='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_sentCode.md b/old_docs/API_docs_v81/constructors/auth_sentCode.md new file mode 100644 index 00000000..11473810 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_sentCode.md @@ -0,0 +1,48 @@ +--- +title: auth.sentCode +description: auth_sentCode attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.sentCode +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone\_registered|[Bool](../types/Bool.md) | Optional| +|type|[auth\_SentCodeType](../types/auth_SentCodeType.md) | Yes| +|phone\_code\_hash|[string](../types/string.md) | Yes| +|next\_type|[auth\_CodeType](../types/auth_CodeType.md) | Optional| +|timeout|[int](../types/int.md) | Optional| +|terms\_of\_service|[help\_TermsOfService](../types/help_TermsOfService.md) | Optional| + + + +### Type: [auth\_SentCode](../types/auth_SentCode.md) + + +### Example: + +``` +$auth_sentCode = ['_' => 'auth.sentCode', 'phone_registered' => Bool, 'type' => auth_SentCodeType, 'phone_code_hash' => 'string', 'next_type' => auth_CodeType, 'timeout' => int, 'terms_of_service' => help_TermsOfService]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.sentCode", "phone_registered": Bool, "type": auth_SentCodeType, "phone_code_hash": "string", "next_type": auth_CodeType, "timeout": int, "terms_of_service": help_TermsOfService} +``` + + +Or, if you're into Lua: + + +``` +auth_sentCode={_='auth.sentCode', phone_registered=Bool, type=auth_SentCodeType, phone_code_hash='string', next_type=auth_CodeType, timeout=int, terms_of_service=help_TermsOfService} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_sentCodeTypeApp.md b/old_docs/API_docs_v81/constructors/auth_sentCodeTypeApp.md new file mode 100644 index 00000000..eb4f4530 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_sentCodeTypeApp.md @@ -0,0 +1,43 @@ +--- +title: auth.sentCodeTypeApp +description: auth_sentCodeTypeApp attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.sentCodeTypeApp +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|length|[int](../types/int.md) | Yes| + + + +### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md) + + +### Example: + +``` +$auth_sentCodeTypeApp = ['_' => 'auth.sentCodeTypeApp', 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.sentCodeTypeApp", "length": int} +``` + + +Or, if you're into Lua: + + +``` +auth_sentCodeTypeApp={_='auth.sentCodeTypeApp', length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_sentCodeTypeCall.md b/old_docs/API_docs_v81/constructors/auth_sentCodeTypeCall.md new file mode 100644 index 00000000..b72a7550 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_sentCodeTypeCall.md @@ -0,0 +1,43 @@ +--- +title: auth.sentCodeTypeCall +description: auth_sentCodeTypeCall attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.sentCodeTypeCall +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|length|[int](../types/int.md) | Yes| + + + +### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md) + + +### Example: + +``` +$auth_sentCodeTypeCall = ['_' => 'auth.sentCodeTypeCall', 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.sentCodeTypeCall", "length": int} +``` + + +Or, if you're into Lua: + + +``` +auth_sentCodeTypeCall={_='auth.sentCodeTypeCall', length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_sentCodeTypeFlashCall.md b/old_docs/API_docs_v81/constructors/auth_sentCodeTypeFlashCall.md new file mode 100644 index 00000000..2c59cad5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_sentCodeTypeFlashCall.md @@ -0,0 +1,43 @@ +--- +title: auth.sentCodeTypeFlashCall +description: auth_sentCodeTypeFlashCall attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.sentCodeTypeFlashCall +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|pattern|[string](../types/string.md) | Yes| + + + +### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md) + + +### Example: + +``` +$auth_sentCodeTypeFlashCall = ['_' => 'auth.sentCodeTypeFlashCall', 'pattern' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.sentCodeTypeFlashCall", "pattern": "string"} +``` + + +Or, if you're into Lua: + + +``` +auth_sentCodeTypeFlashCall={_='auth.sentCodeTypeFlashCall', pattern='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/auth_sentCodeTypeSms.md b/old_docs/API_docs_v81/constructors/auth_sentCodeTypeSms.md new file mode 100644 index 00000000..db6858ea --- /dev/null +++ b/old_docs/API_docs_v81/constructors/auth_sentCodeTypeSms.md @@ -0,0 +1,43 @@ +--- +title: auth.sentCodeTypeSms +description: auth_sentCodeTypeSms attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: auth.sentCodeTypeSms +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|length|[int](../types/int.md) | Yes| + + + +### Type: [auth\_SentCodeType](../types/auth_SentCodeType.md) + + +### Example: + +``` +$auth_sentCodeTypeSms = ['_' => 'auth.sentCodeTypeSms', 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "auth.sentCodeTypeSms", "length": int} +``` + + +Or, if you're into Lua: + + +``` +auth_sentCodeTypeSms={_='auth.sentCodeTypeSms', length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/authorization.md b/old_docs/API_docs_v81/constructors/authorization.md new file mode 100644 index 00000000..17458a06 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/authorization.md @@ -0,0 +1,54 @@ +--- +title: authorization +description: authorization attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: authorization +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|hash|[long](../types/long.md) | Yes| +|device\_model|[string](../types/string.md) | Yes| +|platform|[string](../types/string.md) | Yes| +|system\_version|[string](../types/string.md) | Yes| +|api\_id|[int](../types/int.md) | Yes| +|app\_name|[string](../types/string.md) | Yes| +|app\_version|[string](../types/string.md) | Yes| +|date\_created|[int](../types/int.md) | Yes| +|date\_active|[int](../types/int.md) | Yes| +|ip|[string](../types/string.md) | Yes| +|country|[string](../types/string.md) | Yes| +|region|[string](../types/string.md) | Yes| + + + +### Type: [Authorization](../types/Authorization.md) + + +### Example: + +``` +$authorization = ['_' => 'authorization', 'hash' => long, 'device_model' => 'string', 'platform' => 'string', 'system_version' => 'string', 'api_id' => int, 'app_name' => 'string', 'app_version' => 'string', 'date_created' => int, 'date_active' => int, 'ip' => 'string', 'country' => 'string', 'region' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "authorization", "hash": long, "device_model": "string", "platform": "string", "system_version": "string", "api_id": int, "app_name": "string", "app_version": "string", "date_created": int, "date_active": int, "ip": "string", "country": "string", "region": "string"} +``` + + +Or, if you're into Lua: + + +``` +authorization={_='authorization', hash=long, device_model='string', platform='string', system_version='string', api_id=int, app_name='string', app_version='string', date_created=int, date_active=int, ip='string', country='string', region='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/boolFalse.md b/old_docs/API_docs_v81/constructors/boolFalse.md new file mode 100644 index 00000000..350811df --- /dev/null +++ b/old_docs/API_docs_v81/constructors/boolFalse.md @@ -0,0 +1,9 @@ +--- +title: boolFalse +description: Represents a boolean with value equal to false +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# boolFalse +[Back to constructor index](index.md) + + Represents a boolean with value equal to `false`. diff --git a/old_docs/API_docs_v81/constructors/boolTrue.md b/old_docs/API_docs_v81/constructors/boolTrue.md new file mode 100644 index 00000000..a7de7705 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/boolTrue.md @@ -0,0 +1,9 @@ +--- +title: boolTrue +description: Represents a boolean with value equal to true +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# boolTrue +[Back to constructor index](index.md) + +Represents a boolean with value equal to `true`. diff --git a/old_docs/API_docs_v81/constructors/botCommand.md b/old_docs/API_docs_v81/constructors/botCommand.md new file mode 100644 index 00000000..8569358d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/botCommand.md @@ -0,0 +1,44 @@ +--- +title: botCommand +description: botCommand attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botCommand +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|command|[string](../types/string.md) | Yes| +|description|[string](../types/string.md) | Yes| + + + +### Type: [BotCommand](../types/BotCommand.md) + + +### Example: + +``` +$botCommand = ['_' => 'botCommand', 'command' => 'string', 'description' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "botCommand", "command": "string", "description": "string"} +``` + + +Or, if you're into Lua: + + +``` +botCommand={_='botCommand', command='string', description='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/botInfo.md b/old_docs/API_docs_v81/constructors/botInfo.md new file mode 100644 index 00000000..507f9f8c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/botInfo.md @@ -0,0 +1,45 @@ +--- +title: botInfo +description: botInfo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInfo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|description|[string](../types/string.md) | Yes| +|commands|Array of [BotCommand](../types/BotCommand.md) | Yes| + + + +### Type: [BotInfo](../types/BotInfo.md) + + +### Example: + +``` +$botInfo = ['_' => 'botInfo', 'user_id' => int, 'description' => 'string', 'commands' => [BotCommand, BotCommand]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "botInfo", "user_id": int, "description": "string", "commands": [BotCommand]} +``` + + +Or, if you're into Lua: + + +``` +botInfo={_='botInfo', user_id=int, description='string', commands={BotCommand}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/botInlineMediaResult.md b/old_docs/API_docs_v81/constructors/botInlineMediaResult.md new file mode 100644 index 00000000..43454784 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/botInlineMediaResult.md @@ -0,0 +1,49 @@ +--- +title: botInlineMediaResult +description: botInlineMediaResult attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMediaResult +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[string](../types/string.md) | Yes| +|type|[string](../types/string.md) | Yes| +|photo|[Photo](../types/Photo.md) | Optional| +|document|[Document](../types/Document.md) | Optional| +|title|[string](../types/string.md) | Optional| +|description|[string](../types/string.md) | Optional| +|send\_message|[BotInlineMessage](../types/BotInlineMessage.md) | Yes| + + + +### Type: [BotInlineResult](../types/BotInlineResult.md) + + +### Example: + +``` +$botInlineMediaResult = ['_' => 'botInlineMediaResult', 'id' => 'string', 'type' => 'string', 'photo' => Photo, 'document' => Document, 'title' => 'string', 'description' => 'string', 'send_message' => BotInlineMessage]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "botInlineMediaResult", "id": "string", "type": "string", "photo": Photo, "document": Document, "title": "string", "description": "string", "send_message": BotInlineMessage} +``` + + +Or, if you're into Lua: + + +``` +botInlineMediaResult={_='botInlineMediaResult', id='string', type='string', photo=Photo, document=Document, title='string', description='string', send_message=BotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/botInlineMessageMediaAuto.md b/old_docs/API_docs_v81/constructors/botInlineMessageMediaAuto.md new file mode 100644 index 00000000..07111aa3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/botInlineMessageMediaAuto.md @@ -0,0 +1,51 @@ +--- +title: botInlineMessageMediaAuto +description: botInlineMessageMediaAuto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaAuto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|message|[string](../types/string.md) | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +``` +$botInlineMessageMediaAuto = ['_' => 'botInlineMessageMediaAuto', 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "botInlineMessageMediaAuto", "message": "string", "entities": [MessageEntity], "reply_markup": ReplyMarkup} +``` + + +Or, if you're into Lua: + + +``` +botInlineMessageMediaAuto={_='botInlineMessageMediaAuto', message='string', entities={MessageEntity}, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/botInlineMessageMediaContact.md b/old_docs/API_docs_v81/constructors/botInlineMessageMediaContact.md new file mode 100644 index 00000000..c3f25947 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/botInlineMessageMediaContact.md @@ -0,0 +1,52 @@ +--- +title: botInlineMessageMediaContact +description: botInlineMessageMediaContact attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaContact +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone\_number|[string](../types/string.md) | Yes| +|first\_name|[string](../types/string.md) | Yes| +|last\_name|[string](../types/string.md) | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +``` +$botInlineMessageMediaContact = ['_' => 'botInlineMessageMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'reply_markup' => ReplyMarkup]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "botInlineMessageMediaContact", "phone_number": "string", "first_name": "string", "last_name": "string", "reply_markup": ReplyMarkup} +``` + + +Or, if you're into Lua: + + +``` +botInlineMessageMediaContact={_='botInlineMessageMediaContact', phone_number='string', first_name='string', last_name='string', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/botInlineMessageMediaGeo.md b/old_docs/API_docs_v81/constructors/botInlineMessageMediaGeo.md new file mode 100644 index 00000000..996ded36 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/botInlineMessageMediaGeo.md @@ -0,0 +1,51 @@ +--- +title: botInlineMessageMediaGeo +description: botInlineMessageMediaGeo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaGeo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional| +|period|[int](../types/int.md) | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +``` +$botInlineMessageMediaGeo = ['_' => 'botInlineMessageMediaGeo', 'geo' => GeoPoint, 'period' => int, 'reply_markup' => ReplyMarkup]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "botInlineMessageMediaGeo", "geo": GeoPoint, "period": int, "reply_markup": ReplyMarkup} +``` + + +Or, if you're into Lua: + + +``` +botInlineMessageMediaGeo={_='botInlineMessageMediaGeo', geo=GeoPoint, period=int, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/botInlineMessageMediaVenue.md b/old_docs/API_docs_v81/constructors/botInlineMessageMediaVenue.md new file mode 100644 index 00000000..c98ae89e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/botInlineMessageMediaVenue.md @@ -0,0 +1,55 @@ +--- +title: botInlineMessageMediaVenue +description: botInlineMessageMediaVenue attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaVenue +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional| +|title|[string](../types/string.md) | Yes| +|address|[string](../types/string.md) | Yes| +|provider|[string](../types/string.md) | Yes| +|venue\_id|[string](../types/string.md) | Yes| +|venue\_type|[string](../types/string.md) | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +``` +$botInlineMessageMediaVenue = ['_' => 'botInlineMessageMediaVenue', 'geo' => GeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string', 'venue_type' => 'string', 'reply_markup' => ReplyMarkup]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "botInlineMessageMediaVenue", "geo": GeoPoint, "title": "string", "address": "string", "provider": "string", "venue_id": "string", "venue_type": "string", "reply_markup": ReplyMarkup} +``` + + +Or, if you're into Lua: + + +``` +botInlineMessageMediaVenue={_='botInlineMessageMediaVenue', geo=GeoPoint, title='string', address='string', provider='string', venue_id='string', venue_type='string', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/botInlineMessageText.md b/old_docs/API_docs_v81/constructors/botInlineMessageText.md new file mode 100644 index 00000000..4a274d28 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/botInlineMessageText.md @@ -0,0 +1,52 @@ +--- +title: botInlineMessageText +description: botInlineMessageText attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageText +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Optional| +|message|[string](../types/string.md) | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +``` +$botInlineMessageText = ['_' => 'botInlineMessageText', 'no_webpage' => Bool, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "botInlineMessageText", "no_webpage": Bool, "message": "string", "entities": [MessageEntity], "reply_markup": ReplyMarkup} +``` + + +Or, if you're into Lua: + + +``` +botInlineMessageText={_='botInlineMessageText', no_webpage=Bool, message='string', entities={MessageEntity}, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/botInlineResult.md b/old_docs/API_docs_v81/constructors/botInlineResult.md new file mode 100644 index 00000000..9711fb3d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/botInlineResult.md @@ -0,0 +1,50 @@ +--- +title: botInlineResult +description: botInlineResult attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineResult +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[string](../types/string.md) | Yes| +|type|[string](../types/string.md) | Yes| +|title|[string](../types/string.md) | Optional| +|description|[string](../types/string.md) | Optional| +|url|[string](../types/string.md) | Optional| +|thumb|[WebDocument](../types/WebDocument.md) | Optional| +|content|[WebDocument](../types/WebDocument.md) | Optional| +|send\_message|[BotInlineMessage](../types/BotInlineMessage.md) | Yes| + + + +### Type: [BotInlineResult](../types/BotInlineResult.md) + + +### Example: + +``` +$botInlineResult = ['_' => 'botInlineResult', 'id' => 'string', 'type' => 'string', 'title' => 'string', 'description' => 'string', 'url' => 'string', 'thumb' => WebDocument, 'content' => WebDocument, 'send_message' => BotInlineMessage]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "botInlineResult", "id": "string", "type": "string", "title": "string", "description": "string", "url": "string", "thumb": WebDocument, "content": WebDocument, "send_message": BotInlineMessage} +``` + + +Or, if you're into Lua: + + +``` +botInlineResult={_='botInlineResult', id='string', type='string', title='string', description='string', url='string', thumb=WebDocument, content=WebDocument, send_message=BotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/cdnConfig.md b/old_docs/API_docs_v81/constructors/cdnConfig.md new file mode 100644 index 00000000..3df3585d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/cdnConfig.md @@ -0,0 +1,43 @@ +--- +title: cdnConfig +description: cdnConfig attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: cdnConfig +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|public\_keys|Array of [CdnPublicKey](../types/CdnPublicKey.md) | Yes| + + + +### Type: [CdnConfig](../types/CdnConfig.md) + + +### Example: + +``` +$cdnConfig = ['_' => 'cdnConfig', 'public_keys' => [CdnPublicKey, CdnPublicKey]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "cdnConfig", "public_keys": [CdnPublicKey]} +``` + + +Or, if you're into Lua: + + +``` +cdnConfig={_='cdnConfig', public_keys={CdnPublicKey}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/cdnPublicKey.md b/old_docs/API_docs_v81/constructors/cdnPublicKey.md new file mode 100644 index 00000000..78ec2a83 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/cdnPublicKey.md @@ -0,0 +1,44 @@ +--- +title: cdnPublicKey +description: cdnPublicKey attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: cdnPublicKey +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|dc\_id|[int](../types/int.md) | Yes| +|public\_key|[string](../types/string.md) | Yes| + + + +### Type: [CdnPublicKey](../types/CdnPublicKey.md) + + +### Example: + +``` +$cdnPublicKey = ['_' => 'cdnPublicKey', 'dc_id' => int, 'public_key' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "cdnPublicKey", "dc_id": int, "public_key": "string"} +``` + + +Or, if you're into Lua: + + +``` +cdnPublicKey={_='cdnPublicKey', dc_id=int, public_key='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channel.md b/old_docs/API_docs_v81/constructors/channel.md new file mode 100644 index 00000000..6508ee8d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channel.md @@ -0,0 +1,63 @@ +--- +title: channel +description: channel attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channel +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|creator|[Bool](../types/Bool.md) | Optional| +|left|[Bool](../types/Bool.md) | Optional| +|editor|[Bool](../types/Bool.md) | Optional| +|broadcast|[Bool](../types/Bool.md) | Optional| +|verified|[Bool](../types/Bool.md) | Optional| +|megagroup|[Bool](../types/Bool.md) | Optional| +|restricted|[Bool](../types/Bool.md) | Optional| +|democracy|[Bool](../types/Bool.md) | Optional| +|signatures|[Bool](../types/Bool.md) | Optional| +|min|[Bool](../types/Bool.md) | Optional| +|id|[int](../types/int.md) | Yes| +|access\_hash|[long](../types/long.md) | Optional| +|title|[string](../types/string.md) | Yes| +|username|[string](../types/string.md) | Optional| +|photo|[ChatPhoto](../types/ChatPhoto.md) | Optional| +|date|[int](../types/int.md) | Yes| +|version|[int](../types/int.md) | Yes| +|restriction\_reason|[string](../types/string.md) | Optional| +|admin\_rights|[ChannelAdminRights](../types/ChannelAdminRights.md) | Optional| +|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Optional| +|participants\_count|[int](../types/int.md) | Optional| + + + +### Type: [Chat](../types/Chat.md) + + +### Example: + +``` +$channel = ['_' => 'channel', 'creator' => Bool, 'left' => Bool, 'editor' => Bool, 'broadcast' => Bool, 'verified' => Bool, 'megagroup' => Bool, 'restricted' => Bool, 'democracy' => Bool, 'signatures' => Bool, 'min' => Bool, 'id' => int, 'access_hash' => long, 'title' => 'string', 'username' => 'string', 'photo' => ChatPhoto, 'date' => int, 'version' => int, 'restriction_reason' => 'string', 'admin_rights' => ChannelAdminRights, 'banned_rights' => ChannelBannedRights, 'participants_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channel", "creator": Bool, "left": Bool, "editor": Bool, "broadcast": Bool, "verified": Bool, "megagroup": Bool, "restricted": Bool, "democracy": Bool, "signatures": Bool, "min": Bool, "id": int, "access_hash": long, "title": "string", "username": "string", "photo": ChatPhoto, "date": int, "version": int, "restriction_reason": "string", "admin_rights": ChannelAdminRights, "banned_rights": ChannelBannedRights, "participants_count": int} +``` + + +Or, if you're into Lua: + + +``` +channel={_='channel', creator=Bool, left=Bool, editor=Bool, broadcast=Bool, verified=Bool, megagroup=Bool, restricted=Bool, democracy=Bool, signatures=Bool, min=Bool, id=int, access_hash=long, title='string', username='string', photo=ChatPhoto, date=int, version=int, restriction_reason='string', admin_rights=ChannelAdminRights, banned_rights=ChannelBannedRights, participants_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEvent.md b/old_docs/API_docs_v81/constructors/channelAdminLogEvent.md new file mode 100644 index 00000000..f48cb8db --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEvent.md @@ -0,0 +1,46 @@ +--- +title: channelAdminLogEvent +description: channelAdminLogEvent attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEvent +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|date|[int](../types/int.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|action|[ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) | Yes| + + + +### Type: [ChannelAdminLogEvent](../types/ChannelAdminLogEvent.md) + + +### Example: + +``` +$channelAdminLogEvent = ['_' => 'channelAdminLogEvent', 'id' => long, 'date' => int, 'user_id' => int, 'action' => ChannelAdminLogEventAction]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEvent", "id": long, "date": int, "user_id": int, "action": ChannelAdminLogEventAction} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEvent={_='channelAdminLogEvent', id=long, date=int, user_id=int, action=ChannelAdminLogEventAction} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeAbout.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeAbout.md new file mode 100644 index 00000000..ebec258a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeAbout.md @@ -0,0 +1,44 @@ +--- +title: channelAdminLogEventActionChangeAbout +description: channelAdminLogEventActionChangeAbout attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeAbout +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|prev\_value|[string](../types/string.md) | Yes| +|new\_value|[string](../types/string.md) | Yes| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionChangeAbout = ['_' => 'channelAdminLogEventActionChangeAbout', 'prev_value' => 'string', 'new_value' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionChangeAbout", "prev_value": "string", "new_value": "string"} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionChangeAbout={_='channelAdminLogEventActionChangeAbout', prev_value='string', new_value='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangePhoto.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangePhoto.md new file mode 100644 index 00000000..7c687202 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangePhoto.md @@ -0,0 +1,44 @@ +--- +title: channelAdminLogEventActionChangePhoto +description: channelAdminLogEventActionChangePhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangePhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|prev\_photo|[ChatPhoto](../types/ChatPhoto.md) | Optional| +|new\_photo|[ChatPhoto](../types/ChatPhoto.md) | Optional| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionChangePhoto = ['_' => 'channelAdminLogEventActionChangePhoto', 'prev_photo' => ChatPhoto, 'new_photo' => ChatPhoto]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionChangePhoto", "prev_photo": ChatPhoto, "new_photo": ChatPhoto} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionChangePhoto={_='channelAdminLogEventActionChangePhoto', prev_photo=ChatPhoto, new_photo=ChatPhoto} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeStickerSet.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeStickerSet.md new file mode 100644 index 00000000..74a2d4d4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeStickerSet.md @@ -0,0 +1,44 @@ +--- +title: channelAdminLogEventActionChangeStickerSet +description: channelAdminLogEventActionChangeStickerSet attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeStickerSet +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|prev\_stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional| +|new\_stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionChangeStickerSet = ['_' => 'channelAdminLogEventActionChangeStickerSet', 'prev_stickerset' => InputStickerSet, 'new_stickerset' => InputStickerSet]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionChangeStickerSet", "prev_stickerset": InputStickerSet, "new_stickerset": InputStickerSet} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionChangeStickerSet={_='channelAdminLogEventActionChangeStickerSet', prev_stickerset=InputStickerSet, new_stickerset=InputStickerSet} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeTitle.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeTitle.md new file mode 100644 index 00000000..dbf4ca87 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeTitle.md @@ -0,0 +1,44 @@ +--- +title: channelAdminLogEventActionChangeTitle +description: channelAdminLogEventActionChangeTitle attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeTitle +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|prev\_value|[string](../types/string.md) | Yes| +|new\_value|[string](../types/string.md) | Yes| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionChangeTitle = ['_' => 'channelAdminLogEventActionChangeTitle', 'prev_value' => 'string', 'new_value' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionChangeTitle", "prev_value": "string", "new_value": "string"} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionChangeTitle={_='channelAdminLogEventActionChangeTitle', prev_value='string', new_value='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeUsername.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeUsername.md new file mode 100644 index 00000000..8a48ba97 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionChangeUsername.md @@ -0,0 +1,44 @@ +--- +title: channelAdminLogEventActionChangeUsername +description: channelAdminLogEventActionChangeUsername attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeUsername +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|prev\_value|[string](../types/string.md) | Yes| +|new\_value|[string](../types/string.md) | Yes| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionChangeUsername = ['_' => 'channelAdminLogEventActionChangeUsername', 'prev_value' => 'string', 'new_value' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionChangeUsername", "prev_value": "string", "new_value": "string"} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionChangeUsername={_='channelAdminLogEventActionChangeUsername', prev_value='string', new_value='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionDeleteMessage.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionDeleteMessage.md new file mode 100644 index 00000000..e6ffe7f5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionDeleteMessage.md @@ -0,0 +1,43 @@ +--- +title: channelAdminLogEventActionDeleteMessage +description: channelAdminLogEventActionDeleteMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionDeleteMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|message|[Message](../types/Message.md) | Optional| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionDeleteMessage = ['_' => 'channelAdminLogEventActionDeleteMessage', 'message' => Message]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionDeleteMessage", "message": Message} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionDeleteMessage={_='channelAdminLogEventActionDeleteMessage', message=Message} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionEditMessage.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionEditMessage.md new file mode 100644 index 00000000..67b7a176 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionEditMessage.md @@ -0,0 +1,44 @@ +--- +title: channelAdminLogEventActionEditMessage +description: channelAdminLogEventActionEditMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionEditMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|prev\_message|[Message](../types/Message.md) | Optional| +|new\_message|[Message](../types/Message.md) | Optional| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionEditMessage = ['_' => 'channelAdminLogEventActionEditMessage', 'prev_message' => Message, 'new_message' => Message]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionEditMessage", "prev_message": Message, "new_message": Message} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionEditMessage={_='channelAdminLogEventActionEditMessage', prev_message=Message, new_message=Message} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantInvite.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantInvite.md new file mode 100644 index 00000000..260a3346 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantInvite.md @@ -0,0 +1,43 @@ +--- +title: channelAdminLogEventActionParticipantInvite +description: channelAdminLogEventActionParticipantInvite attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantInvite +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionParticipantInvite = ['_' => 'channelAdminLogEventActionParticipantInvite', 'participant' => ChannelParticipant]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionParticipantInvite", "participant": ChannelParticipant} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionParticipantInvite={_='channelAdminLogEventActionParticipantInvite', participant=ChannelParticipant} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantJoin.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantJoin.md new file mode 100644 index 00000000..9f59031b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantJoin.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionParticipantJoin +description: channelAdminLogEventActionParticipantJoin attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantJoin +[Back to constructors index](index.md) + + + + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionParticipantJoin = ['_' => 'channelAdminLogEventActionParticipantJoin']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionParticipantJoin"} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionParticipantJoin={_='channelAdminLogEventActionParticipantJoin'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantLeave.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantLeave.md new file mode 100644 index 00000000..03328132 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantLeave.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionParticipantLeave +description: channelAdminLogEventActionParticipantLeave attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantLeave +[Back to constructors index](index.md) + + + + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionParticipantLeave = ['_' => 'channelAdminLogEventActionParticipantLeave']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionParticipantLeave"} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionParticipantLeave={_='channelAdminLogEventActionParticipantLeave'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantToggleAdmin.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantToggleAdmin.md new file mode 100644 index 00000000..b570076b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantToggleAdmin.md @@ -0,0 +1,44 @@ +--- +title: channelAdminLogEventActionParticipantToggleAdmin +description: channelAdminLogEventActionParticipantToggleAdmin attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantToggleAdmin +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|prev\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes| +|new\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionParticipantToggleAdmin = ['_' => 'channelAdminLogEventActionParticipantToggleAdmin', 'prev_participant' => ChannelParticipant, 'new_participant' => ChannelParticipant]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionParticipantToggleAdmin", "prev_participant": ChannelParticipant, "new_participant": ChannelParticipant} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionParticipantToggleAdmin={_='channelAdminLogEventActionParticipantToggleAdmin', prev_participant=ChannelParticipant, new_participant=ChannelParticipant} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantToggleBan.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantToggleBan.md new file mode 100644 index 00000000..ef119daa --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionParticipantToggleBan.md @@ -0,0 +1,44 @@ +--- +title: channelAdminLogEventActionParticipantToggleBan +description: channelAdminLogEventActionParticipantToggleBan attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantToggleBan +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|prev\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes| +|new\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionParticipantToggleBan = ['_' => 'channelAdminLogEventActionParticipantToggleBan', 'prev_participant' => ChannelParticipant, 'new_participant' => ChannelParticipant]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionParticipantToggleBan", "prev_participant": ChannelParticipant, "new_participant": ChannelParticipant} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionParticipantToggleBan={_='channelAdminLogEventActionParticipantToggleBan', prev_participant=ChannelParticipant, new_participant=ChannelParticipant} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionToggleInvites.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionToggleInvites.md new file mode 100644 index 00000000..5a25a689 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionToggleInvites.md @@ -0,0 +1,43 @@ +--- +title: channelAdminLogEventActionToggleInvites +description: channelAdminLogEventActionToggleInvites attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionToggleInvites +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|new\_value|[Bool](../types/Bool.md) | Yes| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionToggleInvites = ['_' => 'channelAdminLogEventActionToggleInvites', 'new_value' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionToggleInvites", "new_value": Bool} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionToggleInvites={_='channelAdminLogEventActionToggleInvites', new_value=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionTogglePreHistoryHidden.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionTogglePreHistoryHidden.md new file mode 100644 index 00000000..c0b8bfce --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionTogglePreHistoryHidden.md @@ -0,0 +1,43 @@ +--- +title: channelAdminLogEventActionTogglePreHistoryHidden +description: channelAdminLogEventActionTogglePreHistoryHidden attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionTogglePreHistoryHidden +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|new\_value|[Bool](../types/Bool.md) | Yes| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionTogglePreHistoryHidden = ['_' => 'channelAdminLogEventActionTogglePreHistoryHidden', 'new_value' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionTogglePreHistoryHidden", "new_value": Bool} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionTogglePreHistoryHidden={_='channelAdminLogEventActionTogglePreHistoryHidden', new_value=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionToggleSignatures.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionToggleSignatures.md new file mode 100644 index 00000000..e7119bb6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionToggleSignatures.md @@ -0,0 +1,43 @@ +--- +title: channelAdminLogEventActionToggleSignatures +description: channelAdminLogEventActionToggleSignatures attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionToggleSignatures +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|new\_value|[Bool](../types/Bool.md) | Yes| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionToggleSignatures = ['_' => 'channelAdminLogEventActionToggleSignatures', 'new_value' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionToggleSignatures", "new_value": Bool} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionToggleSignatures={_='channelAdminLogEventActionToggleSignatures', new_value=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventActionUpdatePinned.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionUpdatePinned.md new file mode 100644 index 00000000..de066195 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventActionUpdatePinned.md @@ -0,0 +1,43 @@ +--- +title: channelAdminLogEventActionUpdatePinned +description: channelAdminLogEventActionUpdatePinned attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionUpdatePinned +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|message|[Message](../types/Message.md) | Optional| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +``` +$channelAdminLogEventActionUpdatePinned = ['_' => 'channelAdminLogEventActionUpdatePinned', 'message' => Message]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventActionUpdatePinned", "message": Message} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventActionUpdatePinned={_='channelAdminLogEventActionUpdatePinned', message=Message} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminLogEventsFilter.md b/old_docs/API_docs_v81/constructors/channelAdminLogEventsFilter.md new file mode 100644 index 00000000..04ece393 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminLogEventsFilter.md @@ -0,0 +1,56 @@ +--- +title: channelAdminLogEventsFilter +description: channelAdminLogEventsFilter attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventsFilter +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|join|[Bool](../types/Bool.md) | Optional| +|leave|[Bool](../types/Bool.md) | Optional| +|invite|[Bool](../types/Bool.md) | Optional| +|ban|[Bool](../types/Bool.md) | Optional| +|unban|[Bool](../types/Bool.md) | Optional| +|kick|[Bool](../types/Bool.md) | Optional| +|unkick|[Bool](../types/Bool.md) | Optional| +|promote|[Bool](../types/Bool.md) | Optional| +|demote|[Bool](../types/Bool.md) | Optional| +|info|[Bool](../types/Bool.md) | Optional| +|settings|[Bool](../types/Bool.md) | Optional| +|pinned|[Bool](../types/Bool.md) | Optional| +|edit|[Bool](../types/Bool.md) | Optional| +|delete|[Bool](../types/Bool.md) | Optional| + + + +### Type: [ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) + + +### Example: + +``` +$channelAdminLogEventsFilter = ['_' => 'channelAdminLogEventsFilter', 'join' => Bool, 'leave' => Bool, 'invite' => Bool, 'ban' => Bool, 'unban' => Bool, 'kick' => Bool, 'unkick' => Bool, 'promote' => Bool, 'demote' => Bool, 'info' => Bool, 'settings' => Bool, 'pinned' => Bool, 'edit' => Bool, 'delete' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminLogEventsFilter", "join": Bool, "leave": Bool, "invite": Bool, "ban": Bool, "unban": Bool, "kick": Bool, "unkick": Bool, "promote": Bool, "demote": Bool, "info": Bool, "settings": Bool, "pinned": Bool, "edit": Bool, "delete": Bool} +``` + + +Or, if you're into Lua: + + +``` +channelAdminLogEventsFilter={_='channelAdminLogEventsFilter', join=Bool, leave=Bool, invite=Bool, ban=Bool, unban=Bool, kick=Bool, unkick=Bool, promote=Bool, demote=Bool, info=Bool, settings=Bool, pinned=Bool, edit=Bool, delete=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelAdminRights.md b/old_docs/API_docs_v81/constructors/channelAdminRights.md new file mode 100644 index 00000000..923fa5f3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelAdminRights.md @@ -0,0 +1,52 @@ +--- +title: channelAdminRights +description: channelAdminRights attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminRights +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|change\_info|[Bool](../types/Bool.md) | Optional| +|post\_messages|[Bool](../types/Bool.md) | Optional| +|edit\_messages|[Bool](../types/Bool.md) | Optional| +|delete\_messages|[Bool](../types/Bool.md) | Optional| +|ban\_users|[Bool](../types/Bool.md) | Optional| +|invite\_users|[Bool](../types/Bool.md) | Optional| +|invite\_link|[Bool](../types/Bool.md) | Optional| +|pin\_messages|[Bool](../types/Bool.md) | Optional| +|add\_admins|[Bool](../types/Bool.md) | Optional| +|manage\_call|[Bool](../types/Bool.md) | Optional| + + + +### Type: [ChannelAdminRights](../types/ChannelAdminRights.md) + + +### Example: + +``` +$channelAdminRights = ['_' => 'channelAdminRights', 'change_info' => Bool, 'post_messages' => Bool, 'edit_messages' => Bool, 'delete_messages' => Bool, 'ban_users' => Bool, 'invite_users' => Bool, 'invite_link' => Bool, 'pin_messages' => Bool, 'add_admins' => Bool, 'manage_call' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelAdminRights", "change_info": Bool, "post_messages": Bool, "edit_messages": Bool, "delete_messages": Bool, "ban_users": Bool, "invite_users": Bool, "invite_link": Bool, "pin_messages": Bool, "add_admins": Bool, "manage_call": Bool} +``` + + +Or, if you're into Lua: + + +``` +channelAdminRights={_='channelAdminRights', change_info=Bool, post_messages=Bool, edit_messages=Bool, delete_messages=Bool, ban_users=Bool, invite_users=Bool, invite_link=Bool, pin_messages=Bool, add_admins=Bool, manage_call=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelBannedRights.md b/old_docs/API_docs_v81/constructors/channelBannedRights.md new file mode 100644 index 00000000..13dde648 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelBannedRights.md @@ -0,0 +1,51 @@ +--- +title: channelBannedRights +description: channelBannedRights attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelBannedRights +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|view\_messages|[Bool](../types/Bool.md) | Optional| +|send\_messages|[Bool](../types/Bool.md) | Optional| +|send\_media|[Bool](../types/Bool.md) | Optional| +|send\_stickers|[Bool](../types/Bool.md) | Optional| +|send\_gifs|[Bool](../types/Bool.md) | Optional| +|send\_games|[Bool](../types/Bool.md) | Optional| +|send\_inline|[Bool](../types/Bool.md) | Optional| +|embed\_links|[Bool](../types/Bool.md) | Optional| +|until\_date|[int](../types/int.md) | Yes| + + + +### Type: [ChannelBannedRights](../types/ChannelBannedRights.md) + + +### Example: + +``` +$channelBannedRights = ['_' => 'channelBannedRights', 'view_messages' => Bool, 'send_messages' => Bool, 'send_media' => Bool, 'send_stickers' => Bool, 'send_gifs' => Bool, 'send_games' => Bool, 'send_inline' => Bool, 'embed_links' => Bool, 'until_date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelBannedRights", "view_messages": Bool, "send_messages": Bool, "send_media": Bool, "send_stickers": Bool, "send_gifs": Bool, "send_games": Bool, "send_inline": Bool, "embed_links": Bool, "until_date": int} +``` + + +Or, if you're into Lua: + + +``` +channelBannedRights={_='channelBannedRights', view_messages=Bool, send_messages=Bool, send_media=Bool, send_stickers=Bool, send_gifs=Bool, send_games=Bool, send_inline=Bool, embed_links=Bool, until_date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelForbidden.md b/old_docs/API_docs_v81/constructors/channelForbidden.md new file mode 100644 index 00000000..00b4cbbe --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelForbidden.md @@ -0,0 +1,48 @@ +--- +title: channelForbidden +description: channelForbidden attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelForbidden +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|broadcast|[Bool](../types/Bool.md) | Optional| +|megagroup|[Bool](../types/Bool.md) | Optional| +|id|[int](../types/int.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|title|[string](../types/string.md) | Yes| +|until\_date|[int](../types/int.md) | Optional| + + + +### Type: [Chat](../types/Chat.md) + + +### Example: + +``` +$channelForbidden = ['_' => 'channelForbidden', 'broadcast' => Bool, 'megagroup' => Bool, 'id' => int, 'access_hash' => long, 'title' => 'string', 'until_date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelForbidden", "broadcast": Bool, "megagroup": Bool, "id": int, "access_hash": long, "title": "string", "until_date": int} +``` + + +Or, if you're into Lua: + + +``` +channelForbidden={_='channelForbidden', broadcast=Bool, megagroup=Bool, id=int, access_hash=long, title='string', until_date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelFull.md b/old_docs/API_docs_v81/constructors/channelFull.md new file mode 100644 index 00000000..90481c48 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelFull.md @@ -0,0 +1,64 @@ +--- +title: channelFull +description: channelFull attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelFull +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|can\_view\_participants|[Bool](../types/Bool.md) | Optional| +|can\_set\_username|[Bool](../types/Bool.md) | Optional| +|can\_set\_stickers|[Bool](../types/Bool.md) | Optional| +|hidden\_prehistory|[Bool](../types/Bool.md) | Optional| +|id|[int](../types/int.md) | Yes| +|about|[string](../types/string.md) | Yes| +|participants\_count|[int](../types/int.md) | Optional| +|admins\_count|[int](../types/int.md) | Optional| +|kicked\_count|[int](../types/int.md) | Optional| +|banned\_count|[int](../types/int.md) | Optional| +|read\_inbox\_max\_id|[int](../types/int.md) | Yes| +|read\_outbox\_max\_id|[int](../types/int.md) | Yes| +|unread\_count|[int](../types/int.md) | Yes| +|chat\_photo|[Photo](../types/Photo.md) | Optional| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes| +|exported\_invite|[ExportedChatInvite](../types/ExportedChatInvite.md) | Yes| +|bot\_info|Array of [BotInfo](../types/BotInfo.md) | Yes| +|migrated\_from\_chat\_id|[int](../types/int.md) | Optional| +|migrated\_from\_max\_id|[int](../types/int.md) | Optional| +|pinned\_msg\_id|[int](../types/int.md) | Optional| +|stickerset|[StickerSet](../types/StickerSet.md) | Optional| +|available\_min\_id|[int](../types/int.md) | Optional| + + + +### Type: [ChatFull](../types/ChatFull.md) + + +### Example: + +``` +$channelFull = ['_' => 'channelFull', 'can_view_participants' => Bool, 'can_set_username' => Bool, 'can_set_stickers' => Bool, 'hidden_prehistory' => Bool, 'id' => int, 'about' => 'string', 'participants_count' => int, 'admins_count' => int, 'kicked_count' => int, 'banned_count' => int, 'read_inbox_max_id' => int, 'read_outbox_max_id' => int, 'unread_count' => int, 'chat_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'exported_invite' => ExportedChatInvite, 'bot_info' => [BotInfo, BotInfo], 'migrated_from_chat_id' => int, 'migrated_from_max_id' => int, 'pinned_msg_id' => int, 'stickerset' => StickerSet, 'available_min_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelFull", "can_view_participants": Bool, "can_set_username": Bool, "can_set_stickers": Bool, "hidden_prehistory": Bool, "id": int, "about": "string", "participants_count": int, "admins_count": int, "kicked_count": int, "banned_count": int, "read_inbox_max_id": int, "read_outbox_max_id": int, "unread_count": int, "chat_photo": Photo, "notify_settings": PeerNotifySettings, "exported_invite": ExportedChatInvite, "bot_info": [BotInfo], "migrated_from_chat_id": int, "migrated_from_max_id": int, "pinned_msg_id": int, "stickerset": StickerSet, "available_min_id": int} +``` + + +Or, if you're into Lua: + + +``` +channelFull={_='channelFull', can_view_participants=Bool, can_set_username=Bool, can_set_stickers=Bool, hidden_prehistory=Bool, id=int, about='string', participants_count=int, admins_count=int, kicked_count=int, banned_count=int, read_inbox_max_id=int, read_outbox_max_id=int, unread_count=int, chat_photo=Photo, notify_settings=PeerNotifySettings, exported_invite=ExportedChatInvite, bot_info={BotInfo}, migrated_from_chat_id=int, migrated_from_max_id=int, pinned_msg_id=int, stickerset=StickerSet, available_min_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelMessagesFilter.md b/old_docs/API_docs_v81/constructors/channelMessagesFilter.md new file mode 100644 index 00000000..b19d3151 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelMessagesFilter.md @@ -0,0 +1,44 @@ +--- +title: channelMessagesFilter +description: channelMessagesFilter attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelMessagesFilter +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|exclude\_new\_messages|[Bool](../types/Bool.md) | Optional| +|ranges|Array of [MessageRange](../types/MessageRange.md) | Yes| + + + +### Type: [ChannelMessagesFilter](../types/ChannelMessagesFilter.md) + + +### Example: + +``` +$channelMessagesFilter = ['_' => 'channelMessagesFilter', 'exclude_new_messages' => Bool, 'ranges' => [MessageRange, MessageRange]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelMessagesFilter", "exclude_new_messages": Bool, "ranges": [MessageRange]} +``` + + +Or, if you're into Lua: + + +``` +channelMessagesFilter={_='channelMessagesFilter', exclude_new_messages=Bool, ranges={MessageRange}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelMessagesFilterEmpty.md b/old_docs/API_docs_v81/constructors/channelMessagesFilterEmpty.md new file mode 100644 index 00000000..350e50de --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelMessagesFilterEmpty.md @@ -0,0 +1,38 @@ +--- +title: channelMessagesFilterEmpty +description: channelMessagesFilterEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelMessagesFilterEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [ChannelMessagesFilter](../types/ChannelMessagesFilter.md) + + +### Example: + +``` +$channelMessagesFilterEmpty = ['_' => 'channelMessagesFilterEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelMessagesFilterEmpty"} +``` + + +Or, if you're into Lua: + + +``` +channelMessagesFilterEmpty={_='channelMessagesFilterEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelParticipant.md b/old_docs/API_docs_v81/constructors/channelParticipant.md new file mode 100644 index 00000000..c7de5400 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelParticipant.md @@ -0,0 +1,44 @@ +--- +title: channelParticipant +description: channelParticipant attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipant +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +``` +$channelParticipant = ['_' => 'channelParticipant', 'user_id' => int, 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelParticipant", "user_id": int, "date": int} +``` + + +Or, if you're into Lua: + + +``` +channelParticipant={_='channelParticipant', user_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelParticipantAdmin.md b/old_docs/API_docs_v81/constructors/channelParticipantAdmin.md new file mode 100644 index 00000000..95ef84e9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelParticipantAdmin.md @@ -0,0 +1,48 @@ +--- +title: channelParticipantAdmin +description: channelParticipantAdmin attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantAdmin +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|can\_edit|[Bool](../types/Bool.md) | Optional| +|user\_id|[int](../types/int.md) | Yes| +|inviter\_id|[int](../types/int.md) | Yes| +|promoted\_by|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|admin\_rights|[ChannelAdminRights](../types/ChannelAdminRights.md) | Yes| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +``` +$channelParticipantAdmin = ['_' => 'channelParticipantAdmin', 'can_edit' => Bool, 'user_id' => int, 'inviter_id' => int, 'promoted_by' => int, 'date' => int, 'admin_rights' => ChannelAdminRights]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelParticipantAdmin", "can_edit": Bool, "user_id": int, "inviter_id": int, "promoted_by": int, "date": int, "admin_rights": ChannelAdminRights} +``` + + +Or, if you're into Lua: + + +``` +channelParticipantAdmin={_='channelParticipantAdmin', can_edit=Bool, user_id=int, inviter_id=int, promoted_by=int, date=int, admin_rights=ChannelAdminRights} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelParticipantBanned.md b/old_docs/API_docs_v81/constructors/channelParticipantBanned.md new file mode 100644 index 00000000..be3be304 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelParticipantBanned.md @@ -0,0 +1,47 @@ +--- +title: channelParticipantBanned +description: channelParticipantBanned attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantBanned +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|left|[Bool](../types/Bool.md) | Optional| +|user\_id|[int](../types/int.md) | Yes| +|kicked\_by|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Yes| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +``` +$channelParticipantBanned = ['_' => 'channelParticipantBanned', 'left' => Bool, 'user_id' => int, 'kicked_by' => int, 'date' => int, 'banned_rights' => ChannelBannedRights]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelParticipantBanned", "left": Bool, "user_id": int, "kicked_by": int, "date": int, "banned_rights": ChannelBannedRights} +``` + + +Or, if you're into Lua: + + +``` +channelParticipantBanned={_='channelParticipantBanned', left=Bool, user_id=int, kicked_by=int, date=int, banned_rights=ChannelBannedRights} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelParticipantCreator.md b/old_docs/API_docs_v81/constructors/channelParticipantCreator.md new file mode 100644 index 00000000..86cafe0a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelParticipantCreator.md @@ -0,0 +1,43 @@ +--- +title: channelParticipantCreator +description: channelParticipantCreator attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantCreator +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +``` +$channelParticipantCreator = ['_' => 'channelParticipantCreator', 'user_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelParticipantCreator", "user_id": int} +``` + + +Or, if you're into Lua: + + +``` +channelParticipantCreator={_='channelParticipantCreator', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelParticipantSelf.md b/old_docs/API_docs_v81/constructors/channelParticipantSelf.md new file mode 100644 index 00000000..83864972 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelParticipantSelf.md @@ -0,0 +1,45 @@ +--- +title: channelParticipantSelf +description: channelParticipantSelf attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantSelf +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|inviter\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +``` +$channelParticipantSelf = ['_' => 'channelParticipantSelf', 'user_id' => int, 'inviter_id' => int, 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelParticipantSelf", "user_id": int, "inviter_id": int, "date": int} +``` + + +Or, if you're into Lua: + + +``` +channelParticipantSelf={_='channelParticipantSelf', user_id=int, inviter_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelParticipantsAdmins.md b/old_docs/API_docs_v81/constructors/channelParticipantsAdmins.md new file mode 100644 index 00000000..c86cb9a4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelParticipantsAdmins.md @@ -0,0 +1,38 @@ +--- +title: channelParticipantsAdmins +description: channelParticipantsAdmins attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsAdmins +[Back to constructors index](index.md) + + + + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +``` +$channelParticipantsAdmins = ['_' => 'channelParticipantsAdmins']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelParticipantsAdmins"} +``` + + +Or, if you're into Lua: + + +``` +channelParticipantsAdmins={_='channelParticipantsAdmins'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelParticipantsBanned.md b/old_docs/API_docs_v81/constructors/channelParticipantsBanned.md new file mode 100644 index 00000000..75a86f75 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelParticipantsBanned.md @@ -0,0 +1,43 @@ +--- +title: channelParticipantsBanned +description: channelParticipantsBanned attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsBanned +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|q|[string](../types/string.md) | Yes| + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +``` +$channelParticipantsBanned = ['_' => 'channelParticipantsBanned', 'q' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelParticipantsBanned", "q": "string"} +``` + + +Or, if you're into Lua: + + +``` +channelParticipantsBanned={_='channelParticipantsBanned', q='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelParticipantsBots.md b/old_docs/API_docs_v81/constructors/channelParticipantsBots.md new file mode 100644 index 00000000..30875f94 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelParticipantsBots.md @@ -0,0 +1,38 @@ +--- +title: channelParticipantsBots +description: channelParticipantsBots attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsBots +[Back to constructors index](index.md) + + + + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +``` +$channelParticipantsBots = ['_' => 'channelParticipantsBots']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelParticipantsBots"} +``` + + +Or, if you're into Lua: + + +``` +channelParticipantsBots={_='channelParticipantsBots'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelParticipantsKicked.md b/old_docs/API_docs_v81/constructors/channelParticipantsKicked.md new file mode 100644 index 00000000..fba5808a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelParticipantsKicked.md @@ -0,0 +1,43 @@ +--- +title: channelParticipantsKicked +description: channelParticipantsKicked attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsKicked +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|q|[string](../types/string.md) | Yes| + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +``` +$channelParticipantsKicked = ['_' => 'channelParticipantsKicked', 'q' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelParticipantsKicked", "q": "string"} +``` + + +Or, if you're into Lua: + + +``` +channelParticipantsKicked={_='channelParticipantsKicked', q='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelParticipantsRecent.md b/old_docs/API_docs_v81/constructors/channelParticipantsRecent.md new file mode 100644 index 00000000..e4cb6466 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelParticipantsRecent.md @@ -0,0 +1,38 @@ +--- +title: channelParticipantsRecent +description: channelParticipantsRecent attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsRecent +[Back to constructors index](index.md) + + + + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +``` +$channelParticipantsRecent = ['_' => 'channelParticipantsRecent']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelParticipantsRecent"} +``` + + +Or, if you're into Lua: + + +``` +channelParticipantsRecent={_='channelParticipantsRecent'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channelParticipantsSearch.md b/old_docs/API_docs_v81/constructors/channelParticipantsSearch.md new file mode 100644 index 00000000..727a7279 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channelParticipantsSearch.md @@ -0,0 +1,43 @@ +--- +title: channelParticipantsSearch +description: channelParticipantsSearch attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsSearch +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|q|[string](../types/string.md) | Yes| + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +``` +$channelParticipantsSearch = ['_' => 'channelParticipantsSearch', 'q' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channelParticipantsSearch", "q": "string"} +``` + + +Or, if you're into Lua: + + +``` +channelParticipantsSearch={_='channelParticipantsSearch', q='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channels_adminLogResults.md b/old_docs/API_docs_v81/constructors/channels_adminLogResults.md new file mode 100644 index 00000000..bd652b78 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channels_adminLogResults.md @@ -0,0 +1,45 @@ +--- +title: channels.adminLogResults +description: channels_adminLogResults attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channels.adminLogResults +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|events|Array of [ChannelAdminLogEvent](../types/ChannelAdminLogEvent.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) + + +### Example: + +``` +$channels_adminLogResults = ['_' => 'channels.adminLogResults', 'events' => [ChannelAdminLogEvent, ChannelAdminLogEvent], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channels.adminLogResults", "events": [ChannelAdminLogEvent], "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +channels_adminLogResults={_='channels.adminLogResults', events={ChannelAdminLogEvent}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channels_channelParticipant.md b/old_docs/API_docs_v81/constructors/channels_channelParticipant.md new file mode 100644 index 00000000..bdf27b08 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channels_channelParticipant.md @@ -0,0 +1,44 @@ +--- +title: channels.channelParticipant +description: channels_channelParticipant attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channels.channelParticipant +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) + + +### Example: + +``` +$channels_channelParticipant = ['_' => 'channels.channelParticipant', 'participant' => ChannelParticipant, 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channels.channelParticipant", "participant": ChannelParticipant, "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +channels_channelParticipant={_='channels.channelParticipant', participant=ChannelParticipant, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channels_channelParticipants.md b/old_docs/API_docs_v81/constructors/channels_channelParticipants.md new file mode 100644 index 00000000..1b76b1e0 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channels_channelParticipants.md @@ -0,0 +1,45 @@ +--- +title: channels.channelParticipants +description: channels_channelParticipants attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channels.channelParticipants +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|count|[int](../types/int.md) | Yes| +|participants|Array of [ChannelParticipant](../types/ChannelParticipant.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) + + +### Example: + +``` +$channels_channelParticipants = ['_' => 'channels.channelParticipants', 'count' => int, 'participants' => [ChannelParticipant, ChannelParticipant], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channels.channelParticipants", "count": int, "participants": [ChannelParticipant], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +channels_channelParticipants={_='channels.channelParticipants', count=int, participants={ChannelParticipant}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/channels_channelParticipantsNotModified.md b/old_docs/API_docs_v81/constructors/channels_channelParticipantsNotModified.md new file mode 100644 index 00000000..f3794494 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/channels_channelParticipantsNotModified.md @@ -0,0 +1,38 @@ +--- +title: channels.channelParticipantsNotModified +description: channels_channelParticipantsNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channels.channelParticipantsNotModified +[Back to constructors index](index.md) + + + + + + +### Type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) + + +### Example: + +``` +$channels_channelParticipantsNotModified = ['_' => 'channels.channelParticipantsNotModified']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "channels.channelParticipantsNotModified"} +``` + + +Or, if you're into Lua: + + +``` +channels_channelParticipantsNotModified={_='channels.channelParticipantsNotModified'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chat.md b/old_docs/API_docs_v81/constructors/chat.md new file mode 100644 index 00000000..5ae1811d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chat.md @@ -0,0 +1,55 @@ +--- +title: chat +description: chat attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chat +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|creator|[Bool](../types/Bool.md) | Optional| +|kicked|[Bool](../types/Bool.md) | Optional| +|left|[Bool](../types/Bool.md) | Optional| +|admins\_enabled|[Bool](../types/Bool.md) | Optional| +|admin|[Bool](../types/Bool.md) | Optional| +|deactivated|[Bool](../types/Bool.md) | Optional| +|id|[int](../types/int.md) | Yes| +|title|[string](../types/string.md) | Yes| +|photo|[ChatPhoto](../types/ChatPhoto.md) | Optional| +|participants\_count|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|version|[int](../types/int.md) | Yes| +|migrated\_to|[InputChannel](../types/InputChannel.md) | Optional| + + + +### Type: [Chat](../types/Chat.md) + + +### Example: + +``` +$chat = ['_' => 'chat', 'creator' => Bool, 'kicked' => Bool, 'left' => Bool, 'admins_enabled' => Bool, 'admin' => Bool, 'deactivated' => Bool, 'id' => int, 'title' => 'string', 'photo' => ChatPhoto, 'participants_count' => int, 'date' => int, 'version' => int, 'migrated_to' => InputChannel]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chat", "creator": Bool, "kicked": Bool, "left": Bool, "admins_enabled": Bool, "admin": Bool, "deactivated": Bool, "id": int, "title": "string", "photo": ChatPhoto, "participants_count": int, "date": int, "version": int, "migrated_to": InputChannel} +``` + + +Or, if you're into Lua: + + +``` +chat={_='chat', creator=Bool, kicked=Bool, left=Bool, admins_enabled=Bool, admin=Bool, deactivated=Bool, id=int, title='string', photo=ChatPhoto, participants_count=int, date=int, version=int, migrated_to=InputChannel} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatEmpty.md b/old_docs/API_docs_v81/constructors/chatEmpty.md new file mode 100644 index 00000000..c273c2bf --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatEmpty.md @@ -0,0 +1,43 @@ +--- +title: chatEmpty +description: chatEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| + + + +### Type: [Chat](../types/Chat.md) + + +### Example: + +``` +$chatEmpty = ['_' => 'chatEmpty', 'id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatEmpty", "id": int} +``` + + +Or, if you're into Lua: + + +``` +chatEmpty={_='chatEmpty', id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatForbidden.md b/old_docs/API_docs_v81/constructors/chatForbidden.md new file mode 100644 index 00000000..de5bb302 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatForbidden.md @@ -0,0 +1,44 @@ +--- +title: chatForbidden +description: chatForbidden attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatForbidden +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| +|title|[string](../types/string.md) | Yes| + + + +### Type: [Chat](../types/Chat.md) + + +### Example: + +``` +$chatForbidden = ['_' => 'chatForbidden', 'id' => int, 'title' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatForbidden", "id": int, "title": "string"} +``` + + +Or, if you're into Lua: + + +``` +chatForbidden={_='chatForbidden', id=int, title='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatFull.md b/old_docs/API_docs_v81/constructors/chatFull.md new file mode 100644 index 00000000..ebb36ec1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatFull.md @@ -0,0 +1,48 @@ +--- +title: chatFull +description: chatFull attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatFull +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| +|participants|[ChatParticipants](../types/ChatParticipants.md) | Yes| +|chat\_photo|[Photo](../types/Photo.md) | Optional| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes| +|exported\_invite|[ExportedChatInvite](../types/ExportedChatInvite.md) | Yes| +|bot\_info|Array of [BotInfo](../types/BotInfo.md) | Yes| + + + +### Type: [ChatFull](../types/ChatFull.md) + + +### Example: + +``` +$chatFull = ['_' => 'chatFull', 'id' => int, 'participants' => ChatParticipants, 'chat_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'exported_invite' => ExportedChatInvite, 'bot_info' => [BotInfo, BotInfo]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatFull", "id": int, "participants": ChatParticipants, "chat_photo": Photo, "notify_settings": PeerNotifySettings, "exported_invite": ExportedChatInvite, "bot_info": [BotInfo]} +``` + + +Or, if you're into Lua: + + +``` +chatFull={_='chatFull', id=int, participants=ChatParticipants, chat_photo=Photo, notify_settings=PeerNotifySettings, exported_invite=ExportedChatInvite, bot_info={BotInfo}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatInvite.md b/old_docs/API_docs_v81/constructors/chatInvite.md new file mode 100644 index 00000000..c0f14de6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatInvite.md @@ -0,0 +1,50 @@ +--- +title: chatInvite +description: chatInvite attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatInvite +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel|[Bool](../types/Bool.md) | Optional| +|broadcast|[Bool](../types/Bool.md) | Optional| +|public|[Bool](../types/Bool.md) | Optional| +|megagroup|[Bool](../types/Bool.md) | Optional| +|title|[string](../types/string.md) | Yes| +|photo|[ChatPhoto](../types/ChatPhoto.md) | Optional| +|participants\_count|[int](../types/int.md) | Yes| +|participants|Array of [User](../types/User.md) | Optional| + + + +### Type: [ChatInvite](../types/ChatInvite.md) + + +### Example: + +``` +$chatInvite = ['_' => 'chatInvite', 'channel' => Bool, 'broadcast' => Bool, 'public' => Bool, 'megagroup' => Bool, 'title' => 'string', 'photo' => ChatPhoto, 'participants_count' => int, 'participants' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatInvite", "channel": Bool, "broadcast": Bool, "public": Bool, "megagroup": Bool, "title": "string", "photo": ChatPhoto, "participants_count": int, "participants": [User]} +``` + + +Or, if you're into Lua: + + +``` +chatInvite={_='chatInvite', channel=Bool, broadcast=Bool, public=Bool, megagroup=Bool, title='string', photo=ChatPhoto, participants_count=int, participants={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatInviteAlready.md b/old_docs/API_docs_v81/constructors/chatInviteAlready.md new file mode 100644 index 00000000..36dc9278 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatInviteAlready.md @@ -0,0 +1,43 @@ +--- +title: chatInviteAlready +description: chatInviteAlready attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatInviteAlready +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat|[Chat](../types/Chat.md) | Optional| + + + +### Type: [ChatInvite](../types/ChatInvite.md) + + +### Example: + +``` +$chatInviteAlready = ['_' => 'chatInviteAlready', 'chat' => Chat]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatInviteAlready", "chat": Chat} +``` + + +Or, if you're into Lua: + + +``` +chatInviteAlready={_='chatInviteAlready', chat=Chat} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatInviteEmpty.md b/old_docs/API_docs_v81/constructors/chatInviteEmpty.md new file mode 100644 index 00000000..79f0c0a6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatInviteEmpty.md @@ -0,0 +1,38 @@ +--- +title: chatInviteEmpty +description: chatInviteEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatInviteEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [ExportedChatInvite](../types/ExportedChatInvite.md) + + +### Example: + +``` +$chatInviteEmpty = ['_' => 'chatInviteEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatInviteEmpty"} +``` + + +Or, if you're into Lua: + + +``` +chatInviteEmpty={_='chatInviteEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatInviteExported.md b/old_docs/API_docs_v81/constructors/chatInviteExported.md new file mode 100644 index 00000000..d167d4c6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatInviteExported.md @@ -0,0 +1,43 @@ +--- +title: chatInviteExported +description: chatInviteExported attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatInviteExported +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|link|[string](../types/string.md) | Yes| + + + +### Type: [ExportedChatInvite](../types/ExportedChatInvite.md) + + +### Example: + +``` +$chatInviteExported = ['_' => 'chatInviteExported', 'link' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatInviteExported", "link": "string"} +``` + + +Or, if you're into Lua: + + +``` +chatInviteExported={_='chatInviteExported', link='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatParticipant.md b/old_docs/API_docs_v81/constructors/chatParticipant.md new file mode 100644 index 00000000..f3acfff2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatParticipant.md @@ -0,0 +1,45 @@ +--- +title: chatParticipant +description: chatParticipant attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatParticipant +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|inviter\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [ChatParticipant](../types/ChatParticipant.md) + + +### Example: + +``` +$chatParticipant = ['_' => 'chatParticipant', 'user_id' => int, 'inviter_id' => int, 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatParticipant", "user_id": int, "inviter_id": int, "date": int} +``` + + +Or, if you're into Lua: + + +``` +chatParticipant={_='chatParticipant', user_id=int, inviter_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatParticipantAdmin.md b/old_docs/API_docs_v81/constructors/chatParticipantAdmin.md new file mode 100644 index 00000000..62aee9a4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatParticipantAdmin.md @@ -0,0 +1,45 @@ +--- +title: chatParticipantAdmin +description: chatParticipantAdmin attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatParticipantAdmin +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|inviter\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [ChatParticipant](../types/ChatParticipant.md) + + +### Example: + +``` +$chatParticipantAdmin = ['_' => 'chatParticipantAdmin', 'user_id' => int, 'inviter_id' => int, 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatParticipantAdmin", "user_id": int, "inviter_id": int, "date": int} +``` + + +Or, if you're into Lua: + + +``` +chatParticipantAdmin={_='chatParticipantAdmin', user_id=int, inviter_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatParticipantCreator.md b/old_docs/API_docs_v81/constructors/chatParticipantCreator.md new file mode 100644 index 00000000..0fb7b6ef --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatParticipantCreator.md @@ -0,0 +1,43 @@ +--- +title: chatParticipantCreator +description: chatParticipantCreator attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatParticipantCreator +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| + + + +### Type: [ChatParticipant](../types/ChatParticipant.md) + + +### Example: + +``` +$chatParticipantCreator = ['_' => 'chatParticipantCreator', 'user_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatParticipantCreator", "user_id": int} +``` + + +Or, if you're into Lua: + + +``` +chatParticipantCreator={_='chatParticipantCreator', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatParticipants.md b/old_docs/API_docs_v81/constructors/chatParticipants.md new file mode 100644 index 00000000..38af2ca5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatParticipants.md @@ -0,0 +1,45 @@ +--- +title: chatParticipants +description: chatParticipants attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatParticipants +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| +|participants|Array of [ChatParticipant](../types/ChatParticipant.md) | Yes| +|version|[int](../types/int.md) | Yes| + + + +### Type: [ChatParticipants](../types/ChatParticipants.md) + + +### Example: + +``` +$chatParticipants = ['_' => 'chatParticipants', 'chat_id' => int, 'participants' => [ChatParticipant, ChatParticipant], 'version' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatParticipants", "chat_id": int, "participants": [ChatParticipant], "version": int} +``` + + +Or, if you're into Lua: + + +``` +chatParticipants={_='chatParticipants', chat_id=int, participants={ChatParticipant}, version=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatParticipantsForbidden.md b/old_docs/API_docs_v81/constructors/chatParticipantsForbidden.md new file mode 100644 index 00000000..2ecdfe10 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatParticipantsForbidden.md @@ -0,0 +1,44 @@ +--- +title: chatParticipantsForbidden +description: chatParticipantsForbidden attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatParticipantsForbidden +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| +|self\_participant|[ChatParticipant](../types/ChatParticipant.md) | Optional| + + + +### Type: [ChatParticipants](../types/ChatParticipants.md) + + +### Example: + +``` +$chatParticipantsForbidden = ['_' => 'chatParticipantsForbidden', 'chat_id' => int, 'self_participant' => ChatParticipant]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatParticipantsForbidden", "chat_id": int, "self_participant": ChatParticipant} +``` + + +Or, if you're into Lua: + + +``` +chatParticipantsForbidden={_='chatParticipantsForbidden', chat_id=int, self_participant=ChatParticipant} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatPhoto.md b/old_docs/API_docs_v81/constructors/chatPhoto.md new file mode 100644 index 00000000..2a259a9d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatPhoto.md @@ -0,0 +1,44 @@ +--- +title: chatPhoto +description: chatPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|photo\_small|[FileLocation](../types/FileLocation.md) | Yes| +|photo\_big|[FileLocation](../types/FileLocation.md) | Yes| + + + +### Type: [ChatPhoto](../types/ChatPhoto.md) + + +### Example: + +``` +$chatPhoto = ['_' => 'chatPhoto', 'photo_small' => FileLocation, 'photo_big' => FileLocation]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatPhoto", "photo_small": FileLocation, "photo_big": FileLocation} +``` + + +Or, if you're into Lua: + + +``` +chatPhoto={_='chatPhoto', photo_small=FileLocation, photo_big=FileLocation} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/chatPhotoEmpty.md b/old_docs/API_docs_v81/constructors/chatPhotoEmpty.md new file mode 100644 index 00000000..454e4a5b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/chatPhotoEmpty.md @@ -0,0 +1,38 @@ +--- +title: chatPhotoEmpty +description: chatPhotoEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatPhotoEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [ChatPhoto](../types/ChatPhoto.md) + + +### Example: + +``` +$chatPhotoEmpty = ['_' => 'chatPhotoEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "chatPhotoEmpty"} +``` + + +Or, if you're into Lua: + + +``` +chatPhotoEmpty={_='chatPhotoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/config.md b/old_docs/API_docs_v81/constructors/config.md new file mode 100644 index 00000000..a2a888b6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/config.md @@ -0,0 +1,82 @@ +--- +title: config +description: config attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: config +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phonecalls\_enabled|[Bool](../types/Bool.md) | Optional| +|default\_p2p\_contacts|[Bool](../types/Bool.md) | Optional| +|preload\_featured\_stickers|[Bool](../types/Bool.md) | Optional| +|ignore\_phone\_entities|[Bool](../types/Bool.md) | Optional| +|revoke\_pm\_inbox|[Bool](../types/Bool.md) | Optional| +|blocked\_mode|[Bool](../types/Bool.md) | Optional| +|date|[int](../types/int.md) | Yes| +|expires|[int](../types/int.md) | Yes| +|test\_mode|[Bool](../types/Bool.md) | Yes| +|this\_dc|[int](../types/int.md) | Yes| +|dc\_options|Array of [DcOption](../types/DcOption.md) | Yes| +|chat\_size\_max|[int](../types/int.md) | Yes| +|megagroup\_size\_max|[int](../types/int.md) | Yes| +|forwarded\_count\_max|[int](../types/int.md) | Yes| +|online\_update\_period\_ms|[int](../types/int.md) | Yes| +|offline\_blur\_timeout\_ms|[int](../types/int.md) | Yes| +|offline\_idle\_timeout\_ms|[int](../types/int.md) | Yes| +|online\_cloud\_timeout\_ms|[int](../types/int.md) | Yes| +|notify\_cloud\_delay\_ms|[int](../types/int.md) | Yes| +|notify\_default\_delay\_ms|[int](../types/int.md) | Yes| +|push\_chat\_period\_ms|[int](../types/int.md) | Yes| +|push\_chat\_limit|[int](../types/int.md) | Yes| +|saved\_gifs\_limit|[int](../types/int.md) | Yes| +|edit\_time\_limit|[int](../types/int.md) | Yes| +|revoke\_time\_limit|[int](../types/int.md) | Yes| +|revoke\_pm\_time\_limit|[int](../types/int.md) | Yes| +|rating\_e\_decay|[int](../types/int.md) | Yes| +|stickers\_recent\_limit|[int](../types/int.md) | Yes| +|stickers\_faved\_limit|[int](../types/int.md) | Yes| +|channels\_read\_media\_period|[int](../types/int.md) | Yes| +|tmp\_sessions|[int](../types/int.md) | Optional| +|pinned\_dialogs\_count\_max|[int](../types/int.md) | Yes| +|call\_receive\_timeout\_ms|[int](../types/int.md) | Yes| +|call\_ring\_timeout\_ms|[int](../types/int.md) | Yes| +|call\_connect\_timeout\_ms|[int](../types/int.md) | Yes| +|call\_packet\_timeout\_ms|[int](../types/int.md) | Yes| +|me\_url\_prefix|[string](../types/string.md) | Yes| +|autoupdate\_url\_prefix|[string](../types/string.md) | Optional| +|suggested\_lang\_code|[string](../types/string.md) | Optional| +|lang\_pack\_version|[int](../types/int.md) | Optional| + + + +### Type: [Config](../types/Config.md) + + +### Example: + +``` +$config = ['_' => 'config', 'phonecalls_enabled' => Bool, 'default_p2p_contacts' => Bool, 'preload_featured_stickers' => Bool, 'ignore_phone_entities' => Bool, 'revoke_pm_inbox' => Bool, 'blocked_mode' => Bool, 'date' => int, 'expires' => int, 'test_mode' => Bool, 'this_dc' => int, 'dc_options' => [DcOption, DcOption], 'chat_size_max' => int, 'megagroup_size_max' => int, 'forwarded_count_max' => int, 'online_update_period_ms' => int, 'offline_blur_timeout_ms' => int, 'offline_idle_timeout_ms' => int, 'online_cloud_timeout_ms' => int, 'notify_cloud_delay_ms' => int, 'notify_default_delay_ms' => int, 'push_chat_period_ms' => int, 'push_chat_limit' => int, 'saved_gifs_limit' => int, 'edit_time_limit' => int, 'revoke_time_limit' => int, 'revoke_pm_time_limit' => int, 'rating_e_decay' => int, 'stickers_recent_limit' => int, 'stickers_faved_limit' => int, 'channels_read_media_period' => int, 'tmp_sessions' => int, 'pinned_dialogs_count_max' => int, 'call_receive_timeout_ms' => int, 'call_ring_timeout_ms' => int, 'call_connect_timeout_ms' => int, 'call_packet_timeout_ms' => int, 'me_url_prefix' => 'string', 'autoupdate_url_prefix' => 'string', 'suggested_lang_code' => 'string', 'lang_pack_version' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "config", "phonecalls_enabled": Bool, "default_p2p_contacts": Bool, "preload_featured_stickers": Bool, "ignore_phone_entities": Bool, "revoke_pm_inbox": Bool, "blocked_mode": Bool, "date": int, "expires": int, "test_mode": Bool, "this_dc": int, "dc_options": [DcOption], "chat_size_max": int, "megagroup_size_max": int, "forwarded_count_max": int, "online_update_period_ms": int, "offline_blur_timeout_ms": int, "offline_idle_timeout_ms": int, "online_cloud_timeout_ms": int, "notify_cloud_delay_ms": int, "notify_default_delay_ms": int, "push_chat_period_ms": int, "push_chat_limit": int, "saved_gifs_limit": int, "edit_time_limit": int, "revoke_time_limit": int, "revoke_pm_time_limit": int, "rating_e_decay": int, "stickers_recent_limit": int, "stickers_faved_limit": int, "channels_read_media_period": int, "tmp_sessions": int, "pinned_dialogs_count_max": int, "call_receive_timeout_ms": int, "call_ring_timeout_ms": int, "call_connect_timeout_ms": int, "call_packet_timeout_ms": int, "me_url_prefix": "string", "autoupdate_url_prefix": "string", "suggested_lang_code": "string", "lang_pack_version": int} +``` + + +Or, if you're into Lua: + + +``` +config={_='config', phonecalls_enabled=Bool, default_p2p_contacts=Bool, preload_featured_stickers=Bool, ignore_phone_entities=Bool, revoke_pm_inbox=Bool, blocked_mode=Bool, date=int, expires=int, test_mode=Bool, this_dc=int, dc_options={DcOption}, chat_size_max=int, megagroup_size_max=int, forwarded_count_max=int, online_update_period_ms=int, offline_blur_timeout_ms=int, offline_idle_timeout_ms=int, online_cloud_timeout_ms=int, notify_cloud_delay_ms=int, notify_default_delay_ms=int, push_chat_period_ms=int, push_chat_limit=int, saved_gifs_limit=int, edit_time_limit=int, revoke_time_limit=int, revoke_pm_time_limit=int, rating_e_decay=int, stickers_recent_limit=int, stickers_faved_limit=int, channels_read_media_period=int, tmp_sessions=int, pinned_dialogs_count_max=int, call_receive_timeout_ms=int, call_ring_timeout_ms=int, call_connect_timeout_ms=int, call_packet_timeout_ms=int, me_url_prefix='string', autoupdate_url_prefix='string', suggested_lang_code='string', lang_pack_version=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contact.md b/old_docs/API_docs_v81/constructors/contact.md new file mode 100644 index 00000000..1882354c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contact.md @@ -0,0 +1,44 @@ +--- +title: contact +description: contact attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contact +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|mutual|[Bool](../types/Bool.md) | Yes| + + + +### Type: [Contact](../types/Contact.md) + + +### Example: + +``` +$contact = ['_' => 'contact', 'user_id' => int, 'mutual' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contact", "user_id": int, "mutual": Bool} +``` + + +Or, if you're into Lua: + + +``` +contact={_='contact', user_id=int, mutual=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contactBlocked.md b/old_docs/API_docs_v81/constructors/contactBlocked.md new file mode 100644 index 00000000..455674a3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contactBlocked.md @@ -0,0 +1,44 @@ +--- +title: contactBlocked +description: contactBlocked attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contactBlocked +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [ContactBlocked](../types/ContactBlocked.md) + + +### Example: + +``` +$contactBlocked = ['_' => 'contactBlocked', 'user_id' => int, 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contactBlocked", "user_id": int, "date": int} +``` + + +Or, if you're into Lua: + + +``` +contactBlocked={_='contactBlocked', user_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contactLinkContact.md b/old_docs/API_docs_v81/constructors/contactLinkContact.md new file mode 100644 index 00000000..a0c206b5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contactLinkContact.md @@ -0,0 +1,38 @@ +--- +title: contactLinkContact +description: contactLinkContact attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contactLinkContact +[Back to constructors index](index.md) + + + + + + +### Type: [ContactLink](../types/ContactLink.md) + + +### Example: + +``` +$contactLinkContact = ['_' => 'contactLinkContact']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contactLinkContact"} +``` + + +Or, if you're into Lua: + + +``` +contactLinkContact={_='contactLinkContact'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contactLinkHasPhone.md b/old_docs/API_docs_v81/constructors/contactLinkHasPhone.md new file mode 100644 index 00000000..036e324d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contactLinkHasPhone.md @@ -0,0 +1,38 @@ +--- +title: contactLinkHasPhone +description: contactLinkHasPhone attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contactLinkHasPhone +[Back to constructors index](index.md) + + + + + + +### Type: [ContactLink](../types/ContactLink.md) + + +### Example: + +``` +$contactLinkHasPhone = ['_' => 'contactLinkHasPhone']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contactLinkHasPhone"} +``` + + +Or, if you're into Lua: + + +``` +contactLinkHasPhone={_='contactLinkHasPhone'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contactLinkNone.md b/old_docs/API_docs_v81/constructors/contactLinkNone.md new file mode 100644 index 00000000..70138bc9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contactLinkNone.md @@ -0,0 +1,38 @@ +--- +title: contactLinkNone +description: contactLinkNone attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contactLinkNone +[Back to constructors index](index.md) + + + + + + +### Type: [ContactLink](../types/ContactLink.md) + + +### Example: + +``` +$contactLinkNone = ['_' => 'contactLinkNone']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contactLinkNone"} +``` + + +Or, if you're into Lua: + + +``` +contactLinkNone={_='contactLinkNone'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contactLinkUnknown.md b/old_docs/API_docs_v81/constructors/contactLinkUnknown.md new file mode 100644 index 00000000..864da769 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contactLinkUnknown.md @@ -0,0 +1,38 @@ +--- +title: contactLinkUnknown +description: contactLinkUnknown attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contactLinkUnknown +[Back to constructors index](index.md) + + + + + + +### Type: [ContactLink](../types/ContactLink.md) + + +### Example: + +``` +$contactLinkUnknown = ['_' => 'contactLinkUnknown']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contactLinkUnknown"} +``` + + +Or, if you're into Lua: + + +``` +contactLinkUnknown={_='contactLinkUnknown'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contactStatus.md b/old_docs/API_docs_v81/constructors/contactStatus.md new file mode 100644 index 00000000..1060a8ba --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contactStatus.md @@ -0,0 +1,44 @@ +--- +title: contactStatus +description: contactStatus attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contactStatus +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|status|[UserStatus](../types/UserStatus.md) | Optional| + + + +### Type: [ContactStatus](../types/ContactStatus.md) + + +### Example: + +``` +$contactStatus = ['_' => 'contactStatus', 'user_id' => int, 'status' => UserStatus]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contactStatus", "user_id": int, "status": UserStatus} +``` + + +Or, if you're into Lua: + + +``` +contactStatus={_='contactStatus', user_id=int, status=UserStatus} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contacts_blocked.md b/old_docs/API_docs_v81/constructors/contacts_blocked.md new file mode 100644 index 00000000..10161ce4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contacts_blocked.md @@ -0,0 +1,44 @@ +--- +title: contacts.blocked +description: contacts_blocked attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contacts.blocked +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [contacts\_Blocked](../types/contacts_Blocked.md) + + +### Example: + +``` +$contacts_blocked = ['_' => 'contacts.blocked', 'blocked' => [ContactBlocked, ContactBlocked], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contacts.blocked", "blocked": [ContactBlocked], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +contacts_blocked={_='contacts.blocked', blocked={ContactBlocked}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contacts_blockedSlice.md b/old_docs/API_docs_v81/constructors/contacts_blockedSlice.md new file mode 100644 index 00000000..c7a2db93 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contacts_blockedSlice.md @@ -0,0 +1,45 @@ +--- +title: contacts.blockedSlice +description: contacts_blockedSlice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contacts.blockedSlice +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|count|[int](../types/int.md) | Yes| +|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [contacts\_Blocked](../types/contacts_Blocked.md) + + +### Example: + +``` +$contacts_blockedSlice = ['_' => 'contacts.blockedSlice', 'count' => int, 'blocked' => [ContactBlocked, ContactBlocked], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contacts.blockedSlice", "count": int, "blocked": [ContactBlocked], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +contacts_blockedSlice={_='contacts.blockedSlice', count=int, blocked={ContactBlocked}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contacts_contacts.md b/old_docs/API_docs_v81/constructors/contacts_contacts.md new file mode 100644 index 00000000..542bf62b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contacts_contacts.md @@ -0,0 +1,45 @@ +--- +title: contacts.contacts +description: contacts_contacts attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contacts.contacts +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|contacts|Array of [Contact](../types/Contact.md) | Yes| +|saved\_count|[int](../types/int.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [contacts\_Contacts](../types/contacts_Contacts.md) + + +### Example: + +``` +$contacts_contacts = ['_' => 'contacts.contacts', 'contacts' => [Contact, Contact], 'saved_count' => int, 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contacts.contacts", "contacts": [Contact], "saved_count": int, "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +contacts_contacts={_='contacts.contacts', contacts={Contact}, saved_count=int, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contacts_contactsNotModified.md b/old_docs/API_docs_v81/constructors/contacts_contactsNotModified.md new file mode 100644 index 00000000..4697e017 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contacts_contactsNotModified.md @@ -0,0 +1,38 @@ +--- +title: contacts.contactsNotModified +description: contacts_contactsNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contacts.contactsNotModified +[Back to constructors index](index.md) + + + + + + +### Type: [contacts\_Contacts](../types/contacts_Contacts.md) + + +### Example: + +``` +$contacts_contactsNotModified = ['_' => 'contacts.contactsNotModified']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contacts.contactsNotModified"} +``` + + +Or, if you're into Lua: + + +``` +contacts_contactsNotModified={_='contacts.contactsNotModified'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contacts_found.md b/old_docs/API_docs_v81/constructors/contacts_found.md new file mode 100644 index 00000000..ea92e466 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contacts_found.md @@ -0,0 +1,46 @@ +--- +title: contacts.found +description: contacts_found attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contacts.found +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|my\_results|Array of [Peer](../types/Peer.md) | Yes| +|results|Array of [Peer](../types/Peer.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [contacts\_Found](../types/contacts_Found.md) + + +### Example: + +``` +$contacts_found = ['_' => 'contacts.found', 'my_results' => [Peer, Peer], 'results' => [Peer, Peer], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contacts.found", "my_results": [Peer], "results": [Peer], "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +contacts_found={_='contacts.found', my_results={Peer}, results={Peer}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contacts_importedContacts.md b/old_docs/API_docs_v81/constructors/contacts_importedContacts.md new file mode 100644 index 00000000..fdc042d2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contacts_importedContacts.md @@ -0,0 +1,46 @@ +--- +title: contacts.importedContacts +description: contacts_importedContacts attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contacts.importedContacts +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|imported|Array of [ImportedContact](../types/ImportedContact.md) | Yes| +|popular\_invites|Array of [PopularContact](../types/PopularContact.md) | Yes| +|retry\_contacts|Array of [long](../types/long.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) + + +### Example: + +``` +$contacts_importedContacts = ['_' => 'contacts.importedContacts', 'imported' => [ImportedContact, ImportedContact], 'popular_invites' => [PopularContact, PopularContact], 'retry_contacts' => [long, long], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contacts.importedContacts", "imported": [ImportedContact], "popular_invites": [PopularContact], "retry_contacts": [long], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +contacts_importedContacts={_='contacts.importedContacts', imported={ImportedContact}, popular_invites={PopularContact}, retry_contacts={long}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contacts_link.md b/old_docs/API_docs_v81/constructors/contacts_link.md new file mode 100644 index 00000000..a317f974 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contacts_link.md @@ -0,0 +1,45 @@ +--- +title: contacts.link +description: contacts_link attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contacts.link +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|my\_link|[ContactLink](../types/ContactLink.md) | Yes| +|foreign\_link|[ContactLink](../types/ContactLink.md) | Yes| +|user|[User](../types/User.md) | Optional| + + + +### Type: [contacts\_Link](../types/contacts_Link.md) + + +### Example: + +``` +$contacts_link = ['_' => 'contacts.link', 'my_link' => ContactLink, 'foreign_link' => ContactLink, 'user' => User]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contacts.link", "my_link": ContactLink, "foreign_link": ContactLink, "user": User} +``` + + +Or, if you're into Lua: + + +``` +contacts_link={_='contacts.link', my_link=ContactLink, foreign_link=ContactLink, user=User} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contacts_resolvedPeer.md b/old_docs/API_docs_v81/constructors/contacts_resolvedPeer.md new file mode 100644 index 00000000..add29235 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contacts_resolvedPeer.md @@ -0,0 +1,45 @@ +--- +title: contacts.resolvedPeer +description: contacts_resolvedPeer attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contacts.resolvedPeer +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Peer](../types/Peer.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [contacts\_ResolvedPeer](../types/contacts_ResolvedPeer.md) + + +### Example: + +``` +$contacts_resolvedPeer = ['_' => 'contacts.resolvedPeer', 'peer' => Peer, 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contacts.resolvedPeer", "peer": Peer, "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +contacts_resolvedPeer={_='contacts.resolvedPeer', peer=Peer, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contacts_topPeers.md b/old_docs/API_docs_v81/constructors/contacts_topPeers.md new file mode 100644 index 00000000..8777bff2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contacts_topPeers.md @@ -0,0 +1,45 @@ +--- +title: contacts.topPeers +description: contacts_topPeers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contacts.topPeers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|categories|Array of [TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [contacts\_TopPeers](../types/contacts_TopPeers.md) + + +### Example: + +``` +$contacts_topPeers = ['_' => 'contacts.topPeers', 'categories' => [TopPeerCategoryPeers, TopPeerCategoryPeers], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contacts.topPeers", "categories": [TopPeerCategoryPeers], "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +contacts_topPeers={_='contacts.topPeers', categories={TopPeerCategoryPeers}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/contacts_topPeersNotModified.md b/old_docs/API_docs_v81/constructors/contacts_topPeersNotModified.md new file mode 100644 index 00000000..3aa2236a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/contacts_topPeersNotModified.md @@ -0,0 +1,38 @@ +--- +title: contacts.topPeersNotModified +description: contacts_topPeersNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contacts.topPeersNotModified +[Back to constructors index](index.md) + + + + + + +### Type: [contacts\_TopPeers](../types/contacts_TopPeers.md) + + +### Example: + +``` +$contacts_topPeersNotModified = ['_' => 'contacts.topPeersNotModified']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "contacts.topPeersNotModified"} +``` + + +Or, if you're into Lua: + + +``` +contacts_topPeersNotModified={_='contacts.topPeersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/dataJSON.md b/old_docs/API_docs_v81/constructors/dataJSON.md new file mode 100644 index 00000000..c49ec0c0 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/dataJSON.md @@ -0,0 +1,43 @@ +--- +title: dataJSON +description: dataJSON attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dataJSON +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|data|[string](../types/string.md) | Yes| + + + +### Type: [DataJSON](../types/DataJSON.md) + + +### Example: + +``` +$dataJSON = ['_' => 'dataJSON', 'data' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "dataJSON", "data": "string"} +``` + + +Or, if you're into Lua: + + +``` +dataJSON={_='dataJSON', data='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/dcOption.md b/old_docs/API_docs_v81/constructors/dcOption.md new file mode 100644 index 00000000..0211c601 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/dcOption.md @@ -0,0 +1,51 @@ +--- +title: dcOption +description: dcOption attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dcOption +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|ipv6|[Bool](../types/Bool.md) | Optional| +|media\_only|[Bool](../types/Bool.md) | Optional| +|tcpo\_only|[Bool](../types/Bool.md) | Optional| +|cdn|[Bool](../types/Bool.md) | Optional| +|static|[Bool](../types/Bool.md) | Optional| +|id|[int](../types/int.md) | Yes| +|ip\_address|[string](../types/string.md) | Yes| +|port|[int](../types/int.md) | Yes| +|secret|[bytes](../types/bytes.md) | Optional| + + + +### Type: [DcOption](../types/DcOption.md) + + +### Example: + +``` +$dcOption = ['_' => 'dcOption', 'ipv6' => Bool, 'media_only' => Bool, 'tcpo_only' => Bool, 'cdn' => Bool, 'static' => Bool, 'id' => int, 'ip_address' => 'string', 'port' => int, 'secret' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "dcOption", "ipv6": Bool, "media_only": Bool, "tcpo_only": Bool, "cdn": Bool, "static": Bool, "id": int, "ip_address": "string", "port": int, "secret": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +dcOption={_='dcOption', ipv6=Bool, media_only=Bool, tcpo_only=Bool, cdn=Bool, static=Bool, id=int, ip_address='string', port=int, secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/dialog.md b/old_docs/API_docs_v81/constructors/dialog.md new file mode 100644 index 00000000..f5f7686e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/dialog.md @@ -0,0 +1,52 @@ +--- +title: dialog +description: dialog attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dialog +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|pinned|[Bool](../types/Bool.md) | Optional| +|peer|[Peer](../types/Peer.md) | Yes| +|top\_message|[int](../types/int.md) | Yes| +|read\_inbox\_max\_id|[int](../types/int.md) | Yes| +|read\_outbox\_max\_id|[int](../types/int.md) | Yes| +|unread\_count|[int](../types/int.md) | Yes| +|unread\_mentions\_count|[int](../types/int.md) | Yes| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes| +|pts|[int](../types/int.md) | Optional| +|draft|[DraftMessage](../types/DraftMessage.md) | Optional| + + + +### Type: [Dialog](../types/Dialog.md) + + +### Example: + +``` +$dialog = ['_' => 'dialog', 'pinned' => Bool, 'peer' => Peer, 'top_message' => int, 'read_inbox_max_id' => int, 'read_outbox_max_id' => int, 'unread_count' => int, 'unread_mentions_count' => int, 'notify_settings' => PeerNotifySettings, 'pts' => int, 'draft' => DraftMessage]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "dialog", "pinned": Bool, "peer": Peer, "top_message": int, "read_inbox_max_id": int, "read_outbox_max_id": int, "unread_count": int, "unread_mentions_count": int, "notify_settings": PeerNotifySettings, "pts": int, "draft": DraftMessage} +``` + + +Or, if you're into Lua: + + +``` +dialog={_='dialog', pinned=Bool, peer=Peer, top_message=int, read_inbox_max_id=int, read_outbox_max_id=int, unread_count=int, unread_mentions_count=int, notify_settings=PeerNotifySettings, pts=int, draft=DraftMessage} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/dialogPeer.md b/old_docs/API_docs_v81/constructors/dialogPeer.md new file mode 100644 index 00000000..e137e9c8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/dialogPeer.md @@ -0,0 +1,43 @@ +--- +title: dialogPeer +description: dialogPeer attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dialogPeer +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Peer](../types/Peer.md) | Yes| + + + +### Type: [DialogPeer](../types/DialogPeer.md) + + +### Example: + +``` +$dialogPeer = ['_' => 'dialogPeer', 'peer' => Peer]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "dialogPeer", "peer": Peer} +``` + + +Or, if you're into Lua: + + +``` +dialogPeer={_='dialogPeer', peer=Peer} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/document.md b/old_docs/API_docs_v81/constructors/document.md new file mode 100644 index 00000000..1a0f1fc1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/document.md @@ -0,0 +1,51 @@ +--- +title: document +description: document attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: document +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|date|[int](../types/int.md) | Yes| +|mime\_type|[string](../types/string.md) | Yes| +|size|[int](../types/int.md) | Yes| +|thumb|[PhotoSize](../types/PhotoSize.md) | Optional| +|dc\_id|[int](../types/int.md) | Yes| +|version|[int](../types/int.md) | Yes| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes| + + + +### Type: [Document](../types/Document.md) + + +### Example: + +``` +$document = ['_' => 'document', 'id' => long, 'access_hash' => long, 'date' => int, 'mime_type' => 'string', 'size' => int, 'thumb' => PhotoSize, 'dc_id' => int, 'version' => int, 'attributes' => [DocumentAttribute, DocumentAttribute]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "document", "id": long, "access_hash": long, "date": int, "mime_type": "string", "size": int, "thumb": PhotoSize, "dc_id": int, "version": int, "attributes": [DocumentAttribute]} +``` + + +Or, if you're into Lua: + + +``` +document={_='document', id=long, access_hash=long, date=int, mime_type='string', size=int, thumb=PhotoSize, dc_id=int, version=int, attributes={DocumentAttribute}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/documentAttributeAnimated.md b/old_docs/API_docs_v81/constructors/documentAttributeAnimated.md new file mode 100644 index 00000000..226b4cf0 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/documentAttributeAnimated.md @@ -0,0 +1,38 @@ +--- +title: documentAttributeAnimated +description: documentAttributeAnimated attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeAnimated +[Back to constructors index](index.md) + + + + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +``` +$documentAttributeAnimated = ['_' => 'documentAttributeAnimated']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "documentAttributeAnimated"} +``` + + +Or, if you're into Lua: + + +``` +documentAttributeAnimated={_='documentAttributeAnimated'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/documentAttributeAudio.md b/old_docs/API_docs_v81/constructors/documentAttributeAudio.md new file mode 100644 index 00000000..0dc5decc --- /dev/null +++ b/old_docs/API_docs_v81/constructors/documentAttributeAudio.md @@ -0,0 +1,47 @@ +--- +title: documentAttributeAudio +description: documentAttributeAudio attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeAudio +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|voice|[Bool](../types/Bool.md) | Optional| +|duration|[int](../types/int.md) | Optional| +|title|[string](../types/string.md) | Optional| +|performer|[string](../types/string.md) | Optional| +|waveform|[bytes](../types/bytes.md) | Optional| + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +``` +$documentAttributeAudio = ['_' => 'documentAttributeAudio', 'voice' => Bool, 'duration' => int, 'title' => 'string', 'performer' => 'string', 'waveform' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "documentAttributeAudio", "voice": Bool, "duration": int, "title": "string", "performer": "string", "waveform": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +documentAttributeAudio={_='documentAttributeAudio', voice=Bool, duration=int, title='string', performer='string', waveform='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/documentAttributeFilename.md b/old_docs/API_docs_v81/constructors/documentAttributeFilename.md new file mode 100644 index 00000000..4beb22a6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/documentAttributeFilename.md @@ -0,0 +1,43 @@ +--- +title: documentAttributeFilename +description: documentAttributeFilename attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeFilename +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|file\_name|[string](../types/string.md) | Yes| + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +``` +$documentAttributeFilename = ['_' => 'documentAttributeFilename', 'file_name' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "documentAttributeFilename", "file_name": "string"} +``` + + +Or, if you're into Lua: + + +``` +documentAttributeFilename={_='documentAttributeFilename', file_name='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/documentAttributeHasStickers.md b/old_docs/API_docs_v81/constructors/documentAttributeHasStickers.md new file mode 100644 index 00000000..fff783df --- /dev/null +++ b/old_docs/API_docs_v81/constructors/documentAttributeHasStickers.md @@ -0,0 +1,38 @@ +--- +title: documentAttributeHasStickers +description: documentAttributeHasStickers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeHasStickers +[Back to constructors index](index.md) + + + + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +``` +$documentAttributeHasStickers = ['_' => 'documentAttributeHasStickers']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "documentAttributeHasStickers"} +``` + + +Or, if you're into Lua: + + +``` +documentAttributeHasStickers={_='documentAttributeHasStickers'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/documentAttributeImageSize.md b/old_docs/API_docs_v81/constructors/documentAttributeImageSize.md new file mode 100644 index 00000000..a8b301fd --- /dev/null +++ b/old_docs/API_docs_v81/constructors/documentAttributeImageSize.md @@ -0,0 +1,44 @@ +--- +title: documentAttributeImageSize +description: documentAttributeImageSize attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeImageSize +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|w|[int](../types/int.md) | Optional| +|h|[int](../types/int.md) | Optional| + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +``` +$documentAttributeImageSize = ['_' => 'documentAttributeImageSize', 'w' => int, 'h' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "documentAttributeImageSize", "w": int, "h": int} +``` + + +Or, if you're into Lua: + + +``` +documentAttributeImageSize={_='documentAttributeImageSize', w=int, h=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/documentAttributeSticker.md b/old_docs/API_docs_v81/constructors/documentAttributeSticker.md new file mode 100644 index 00000000..ba5243fb --- /dev/null +++ b/old_docs/API_docs_v81/constructors/documentAttributeSticker.md @@ -0,0 +1,46 @@ +--- +title: documentAttributeSticker +description: documentAttributeSticker attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeSticker +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|mask|[Bool](../types/Bool.md) | Optional| +|alt|[string](../types/string.md) | Yes| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional| +|mask\_coords|[MaskCoords](../types/MaskCoords.md) | Optional| + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +``` +$documentAttributeSticker = ['_' => 'documentAttributeSticker', 'mask' => Bool, 'alt' => 'string', 'stickerset' => InputStickerSet, 'mask_coords' => MaskCoords]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "documentAttributeSticker", "mask": Bool, "alt": "string", "stickerset": InputStickerSet, "mask_coords": MaskCoords} +``` + + +Or, if you're into Lua: + + +``` +documentAttributeSticker={_='documentAttributeSticker', mask=Bool, alt='string', stickerset=InputStickerSet, mask_coords=MaskCoords} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/documentAttributeVideo.md b/old_docs/API_docs_v81/constructors/documentAttributeVideo.md new file mode 100644 index 00000000..85de0043 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/documentAttributeVideo.md @@ -0,0 +1,47 @@ +--- +title: documentAttributeVideo +description: documentAttributeVideo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeVideo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|round\_message|[Bool](../types/Bool.md) | Optional| +|supports\_streaming|[Bool](../types/Bool.md) | Optional| +|duration|[int](../types/int.md) | Optional| +|w|[int](../types/int.md) | Optional| +|h|[int](../types/int.md) | Optional| + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +``` +$documentAttributeVideo = ['_' => 'documentAttributeVideo', 'round_message' => Bool, 'supports_streaming' => Bool, 'duration' => int, 'w' => int, 'h' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "documentAttributeVideo", "round_message": Bool, "supports_streaming": Bool, "duration": int, "w": int, "h": int} +``` + + +Or, if you're into Lua: + + +``` +documentAttributeVideo={_='documentAttributeVideo', round_message=Bool, supports_streaming=Bool, duration=int, w=int, h=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/documentEmpty.md b/old_docs/API_docs_v81/constructors/documentEmpty.md new file mode 100644 index 00000000..e309ca1e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/documentEmpty.md @@ -0,0 +1,43 @@ +--- +title: documentEmpty +description: documentEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| + + + +### Type: [Document](../types/Document.md) + + +### Example: + +``` +$documentEmpty = ['_' => 'documentEmpty', 'id' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "documentEmpty", "id": long} +``` + + +Or, if you're into Lua: + + +``` +documentEmpty={_='documentEmpty', id=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/draftMessage.md b/old_docs/API_docs_v81/constructors/draftMessage.md new file mode 100644 index 00000000..370ffaef --- /dev/null +++ b/old_docs/API_docs_v81/constructors/draftMessage.md @@ -0,0 +1,47 @@ +--- +title: draftMessage +description: draftMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: draftMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional| +|message|[string](../types/string.md) | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional| +|date|[int](../types/int.md) | Yes| + + + +### Type: [DraftMessage](../types/DraftMessage.md) + + +### Example: + +``` +$draftMessage = ['_' => 'draftMessage', 'no_webpage' => Bool, 'reply_to_msg_id' => int, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "draftMessage", "no_webpage": Bool, "reply_to_msg_id": int, "message": "string", "entities": [MessageEntity], "date": int} +``` + + +Or, if you're into Lua: + + +``` +draftMessage={_='draftMessage', no_webpage=Bool, reply_to_msg_id=int, message='string', entities={MessageEntity}, date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/draftMessageEmpty.md b/old_docs/API_docs_v81/constructors/draftMessageEmpty.md new file mode 100644 index 00000000..15b2aa67 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/draftMessageEmpty.md @@ -0,0 +1,38 @@ +--- +title: draftMessageEmpty +description: draftMessageEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: draftMessageEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [DraftMessage](../types/DraftMessage.md) + + +### Example: + +``` +$draftMessageEmpty = ['_' => 'draftMessageEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "draftMessageEmpty"} +``` + + +Or, if you're into Lua: + + +``` +draftMessageEmpty={_='draftMessageEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/encryptedChat.md b/old_docs/API_docs_v81/constructors/encryptedChat.md new file mode 100644 index 00000000..9064611f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/encryptedChat.md @@ -0,0 +1,49 @@ +--- +title: encryptedChat +description: encryptedChat attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedChat +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|date|[int](../types/int.md) | Yes| +|admin\_id|[int](../types/int.md) | Yes| +|participant\_id|[int](../types/int.md) | Yes| +|g\_a\_or\_b|[bytes](../types/bytes.md) | Yes| +|key\_fingerprint|[long](../types/long.md) | Yes| + + + +### Type: [EncryptedChat](../types/EncryptedChat.md) + + +### Example: + +``` +$encryptedChat = ['_' => 'encryptedChat', 'id' => int, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a_or_b' => 'bytes', 'key_fingerprint' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "encryptedChat", "id": int, "access_hash": long, "date": int, "admin_id": int, "participant_id": int, "g_a_or_b": {"_": "bytes", "bytes":"base64 encoded bytes"}, "key_fingerprint": long} +``` + + +Or, if you're into Lua: + + +``` +encryptedChat={_='encryptedChat', id=int, access_hash=long, date=int, admin_id=int, participant_id=int, g_a_or_b='bytes', key_fingerprint=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/encryptedChatDiscarded.md b/old_docs/API_docs_v81/constructors/encryptedChatDiscarded.md new file mode 100644 index 00000000..7c5dadb7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/encryptedChatDiscarded.md @@ -0,0 +1,43 @@ +--- +title: encryptedChatDiscarded +description: encryptedChatDiscarded attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedChatDiscarded +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| + + + +### Type: [EncryptedChat](../types/EncryptedChat.md) + + +### Example: + +``` +$encryptedChatDiscarded = ['_' => 'encryptedChatDiscarded', 'id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "encryptedChatDiscarded", "id": int} +``` + + +Or, if you're into Lua: + + +``` +encryptedChatDiscarded={_='encryptedChatDiscarded', id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/encryptedChatEmpty.md b/old_docs/API_docs_v81/constructors/encryptedChatEmpty.md new file mode 100644 index 00000000..b079a675 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/encryptedChatEmpty.md @@ -0,0 +1,43 @@ +--- +title: encryptedChatEmpty +description: encryptedChatEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedChatEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| + + + +### Type: [EncryptedChat](../types/EncryptedChat.md) + + +### Example: + +``` +$encryptedChatEmpty = ['_' => 'encryptedChatEmpty', 'id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "encryptedChatEmpty", "id": int} +``` + + +Or, if you're into Lua: + + +``` +encryptedChatEmpty={_='encryptedChatEmpty', id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/encryptedChatRequested.md b/old_docs/API_docs_v81/constructors/encryptedChatRequested.md new file mode 100644 index 00000000..2a5ce73e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/encryptedChatRequested.md @@ -0,0 +1,48 @@ +--- +title: encryptedChatRequested +description: encryptedChatRequested attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedChatRequested +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|date|[int](../types/int.md) | Yes| +|admin\_id|[int](../types/int.md) | Yes| +|participant\_id|[int](../types/int.md) | Yes| +|g\_a|[bytes](../types/bytes.md) | Yes| + + + +### Type: [EncryptedChat](../types/EncryptedChat.md) + + +### Example: + +``` +$encryptedChatRequested = ['_' => 'encryptedChatRequested', 'id' => int, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "encryptedChatRequested", "id": int, "access_hash": long, "date": int, "admin_id": int, "participant_id": int, "g_a": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +encryptedChatRequested={_='encryptedChatRequested', id=int, access_hash=long, date=int, admin_id=int, participant_id=int, g_a='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/encryptedChatWaiting.md b/old_docs/API_docs_v81/constructors/encryptedChatWaiting.md new file mode 100644 index 00000000..efe6f5db --- /dev/null +++ b/old_docs/API_docs_v81/constructors/encryptedChatWaiting.md @@ -0,0 +1,47 @@ +--- +title: encryptedChatWaiting +description: encryptedChatWaiting attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedChatWaiting +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|date|[int](../types/int.md) | Yes| +|admin\_id|[int](../types/int.md) | Yes| +|participant\_id|[int](../types/int.md) | Yes| + + + +### Type: [EncryptedChat](../types/EncryptedChat.md) + + +### Example: + +``` +$encryptedChatWaiting = ['_' => 'encryptedChatWaiting', 'id' => int, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "encryptedChatWaiting", "id": int, "access_hash": long, "date": int, "admin_id": int, "participant_id": int} +``` + + +Or, if you're into Lua: + + +``` +encryptedChatWaiting={_='encryptedChatWaiting', id=int, access_hash=long, date=int, admin_id=int, participant_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/encryptedFile.md b/old_docs/API_docs_v81/constructors/encryptedFile.md new file mode 100644 index 00000000..beef146e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/encryptedFile.md @@ -0,0 +1,47 @@ +--- +title: encryptedFile +description: encryptedFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedFile +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|size|[int](../types/int.md) | Yes| +|dc\_id|[int](../types/int.md) | Yes| +|key\_fingerprint|[int](../types/int.md) | Yes| + + + +### Type: [EncryptedFile](../types/EncryptedFile.md) + + +### Example: + +``` +$encryptedFile = ['_' => 'encryptedFile', 'id' => long, 'access_hash' => long, 'size' => int, 'dc_id' => int, 'key_fingerprint' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "encryptedFile", "id": long, "access_hash": long, "size": int, "dc_id": int, "key_fingerprint": int} +``` + + +Or, if you're into Lua: + + +``` +encryptedFile={_='encryptedFile', id=long, access_hash=long, size=int, dc_id=int, key_fingerprint=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/encryptedFileEmpty.md b/old_docs/API_docs_v81/constructors/encryptedFileEmpty.md new file mode 100644 index 00000000..578ffacd --- /dev/null +++ b/old_docs/API_docs_v81/constructors/encryptedFileEmpty.md @@ -0,0 +1,38 @@ +--- +title: encryptedFileEmpty +description: encryptedFileEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedFileEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [EncryptedFile](../types/EncryptedFile.md) + + +### Example: + +``` +$encryptedFileEmpty = ['_' => 'encryptedFileEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "encryptedFileEmpty"} +``` + + +Or, if you're into Lua: + + +``` +encryptedFileEmpty={_='encryptedFileEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/encryptedMessage.md b/old_docs/API_docs_v81/constructors/encryptedMessage.md new file mode 100644 index 00000000..bcc8244c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/encryptedMessage.md @@ -0,0 +1,46 @@ +--- +title: encryptedMessage +description: encryptedMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|decrypted\_message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes| +|file|[EncryptedFile](../types/EncryptedFile.md) | Optional| + + + +### Type: [EncryptedMessage](../types/EncryptedMessage.md) + + +### Example: + +``` +$encryptedMessage = ['_' => 'encryptedMessage', 'chat_id' => int, 'date' => int, 'decrypted_message' => DecryptedMessage, 'file' => EncryptedFile]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "encryptedMessage", "chat_id": int, "date": int, "decrypted_message": DecryptedMessage, "file": EncryptedFile} +``` + + +Or, if you're into Lua: + + +``` +encryptedMessage={_='encryptedMessage', chat_id=int, date=int, decrypted_message=DecryptedMessage, file=EncryptedFile} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/encryptedMessageService.md b/old_docs/API_docs_v81/constructors/encryptedMessageService.md new file mode 100644 index 00000000..9f861751 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/encryptedMessageService.md @@ -0,0 +1,45 @@ +--- +title: encryptedMessageService +description: encryptedMessageService attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedMessageService +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|decrypted\_message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes| + + + +### Type: [EncryptedMessage](../types/EncryptedMessage.md) + + +### Example: + +``` +$encryptedMessageService = ['_' => 'encryptedMessageService', 'chat_id' => int, 'date' => int, 'decrypted_message' => DecryptedMessage]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "encryptedMessageService", "chat_id": int, "date": int, "decrypted_message": DecryptedMessage} +``` + + +Or, if you're into Lua: + + +``` +encryptedMessageService={_='encryptedMessageService', chat_id=int, date=int, decrypted_message=DecryptedMessage} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/error.md b/old_docs/API_docs_v81/constructors/error.md new file mode 100644 index 00000000..82c5fc65 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/error.md @@ -0,0 +1,44 @@ +--- +title: error +description: error attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: error +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|code|[int](../types/int.md) | Yes| +|text|[string](../types/string.md) | Yes| + + + +### Type: [Error](../types/Error.md) + + +### Example: + +``` +$error = ['_' => 'error', 'code' => int, 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "error", "code": int, "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +error={_='error', code=int, text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/exportedMessageLink.md b/old_docs/API_docs_v81/constructors/exportedMessageLink.md new file mode 100644 index 00000000..62f9fb66 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/exportedMessageLink.md @@ -0,0 +1,44 @@ +--- +title: exportedMessageLink +description: exportedMessageLink attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: exportedMessageLink +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|link|[string](../types/string.md) | Yes| +|html|[string](../types/string.md) | Yes| + + + +### Type: [ExportedMessageLink](../types/ExportedMessageLink.md) + + +### Example: + +``` +$exportedMessageLink = ['_' => 'exportedMessageLink', 'link' => 'string', 'html' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "exportedMessageLink", "link": "string", "html": "string"} +``` + + +Or, if you're into Lua: + + +``` +exportedMessageLink={_='exportedMessageLink', link='string', html='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/fileHash.md b/old_docs/API_docs_v81/constructors/fileHash.md new file mode 100644 index 00000000..577bb6a0 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/fileHash.md @@ -0,0 +1,45 @@ +--- +title: fileHash +description: fileHash attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: fileHash +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|limit|[int](../types/int.md) | Yes| +|hash|[bytes](../types/bytes.md) | Yes| + + + +### Type: [FileHash](../types/FileHash.md) + + +### Example: + +``` +$fileHash = ['_' => 'fileHash', 'offset' => int, 'limit' => int, 'hash' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "fileHash", "offset": int, "limit": int, "hash": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +fileHash={_='fileHash', offset=int, limit=int, hash='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/fileLocation.md b/old_docs/API_docs_v81/constructors/fileLocation.md new file mode 100644 index 00000000..ad0f9639 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/fileLocation.md @@ -0,0 +1,46 @@ +--- +title: fileLocation +description: fileLocation attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: fileLocation +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|dc\_id|[int](../types/int.md) | Yes| +|volume\_id|[long](../types/long.md) | Yes| +|local\_id|[int](../types/int.md) | Yes| +|secret|[long](../types/long.md) | Yes| + + + +### Type: [FileLocation](../types/FileLocation.md) + + +### Example: + +``` +$fileLocation = ['_' => 'fileLocation', 'dc_id' => int, 'volume_id' => long, 'local_id' => int, 'secret' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "fileLocation", "dc_id": int, "volume_id": long, "local_id": int, "secret": long} +``` + + +Or, if you're into Lua: + + +``` +fileLocation={_='fileLocation', dc_id=int, volume_id=long, local_id=int, secret=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/fileLocationUnavailable.md b/old_docs/API_docs_v81/constructors/fileLocationUnavailable.md new file mode 100644 index 00000000..01f1e07f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/fileLocationUnavailable.md @@ -0,0 +1,45 @@ +--- +title: fileLocationUnavailable +description: fileLocationUnavailable attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: fileLocationUnavailable +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|volume\_id|[long](../types/long.md) | Yes| +|local\_id|[int](../types/int.md) | Yes| +|secret|[long](../types/long.md) | Yes| + + + +### Type: [FileLocation](../types/FileLocation.md) + + +### Example: + +``` +$fileLocationUnavailable = ['_' => 'fileLocationUnavailable', 'volume_id' => long, 'local_id' => int, 'secret' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "fileLocationUnavailable", "volume_id": long, "local_id": int, "secret": long} +``` + + +Or, if you're into Lua: + + +``` +fileLocationUnavailable={_='fileLocationUnavailable', volume_id=long, local_id=int, secret=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/foundGif.md b/old_docs/API_docs_v81/constructors/foundGif.md new file mode 100644 index 00000000..d8ee3695 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/foundGif.md @@ -0,0 +1,48 @@ +--- +title: foundGif +description: foundGif attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: foundGif +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|thumb\_url|[string](../types/string.md) | Yes| +|content\_url|[string](../types/string.md) | Yes| +|content\_type|[string](../types/string.md) | Yes| +|w|[int](../types/int.md) | Yes| +|h|[int](../types/int.md) | Yes| + + + +### Type: [FoundGif](../types/FoundGif.md) + + +### Example: + +``` +$foundGif = ['_' => 'foundGif', 'url' => 'string', 'thumb_url' => 'string', 'content_url' => 'string', 'content_type' => 'string', 'w' => int, 'h' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "foundGif", "url": "string", "thumb_url": "string", "content_url": "string", "content_type": "string", "w": int, "h": int} +``` + + +Or, if you're into Lua: + + +``` +foundGif={_='foundGif', url='string', thumb_url='string', content_url='string', content_type='string', w=int, h=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/foundGifCached.md b/old_docs/API_docs_v81/constructors/foundGifCached.md new file mode 100644 index 00000000..e4a1a552 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/foundGifCached.md @@ -0,0 +1,45 @@ +--- +title: foundGifCached +description: foundGifCached attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: foundGifCached +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|photo|[Photo](../types/Photo.md) | Optional| +|document|[Document](../types/Document.md) | Optional| + + + +### Type: [FoundGif](../types/FoundGif.md) + + +### Example: + +``` +$foundGifCached = ['_' => 'foundGifCached', 'url' => 'string', 'photo' => Photo, 'document' => Document]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "foundGifCached", "url": "string", "photo": Photo, "document": Document} +``` + + +Or, if you're into Lua: + + +``` +foundGifCached={_='foundGifCached', url='string', photo=Photo, document=Document} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/game.md b/old_docs/API_docs_v81/constructors/game.md new file mode 100644 index 00000000..790fbeeb --- /dev/null +++ b/old_docs/API_docs_v81/constructors/game.md @@ -0,0 +1,49 @@ +--- +title: game +description: game attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: game +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|short\_name|[string](../types/string.md) | Yes| +|title|[string](../types/string.md) | Yes| +|description|[string](../types/string.md) | Yes| +|photo|[Photo](../types/Photo.md) | Optional| +|document|[Document](../types/Document.md) | Optional| + + + +### Type: [Game](../types/Game.md) + + +### Example: + +``` +$game = ['_' => 'game', 'id' => long, 'access_hash' => long, 'short_name' => 'string', 'title' => 'string', 'description' => 'string', 'photo' => Photo, 'document' => Document]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "game", "id": long, "access_hash": long, "short_name": "string", "title": "string", "description": "string", "photo": Photo, "document": Document} +``` + + +Or, if you're into Lua: + + +``` +game={_='game', id=long, access_hash=long, short_name='string', title='string', description='string', photo=Photo, document=Document} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/geoPoint.md b/old_docs/API_docs_v81/constructors/geoPoint.md new file mode 100644 index 00000000..b932e64a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/geoPoint.md @@ -0,0 +1,44 @@ +--- +title: geoPoint +description: geoPoint attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: geoPoint +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|long|[double](../types/double.md) | Yes| +|lat|[double](../types/double.md) | Yes| + + + +### Type: [GeoPoint](../types/GeoPoint.md) + + +### Example: + +``` +$geoPoint = ['_' => 'geoPoint', 'long' => double, 'lat' => double]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "geoPoint", "long": double, "lat": double} +``` + + +Or, if you're into Lua: + + +``` +geoPoint={_='geoPoint', long=double, lat=double} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/geoPointEmpty.md b/old_docs/API_docs_v81/constructors/geoPointEmpty.md new file mode 100644 index 00000000..de430e2f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/geoPointEmpty.md @@ -0,0 +1,38 @@ +--- +title: geoPointEmpty +description: geoPointEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: geoPointEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [GeoPoint](../types/GeoPoint.md) + + +### Example: + +``` +$geoPointEmpty = ['_' => 'geoPointEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "geoPointEmpty"} +``` + + +Or, if you're into Lua: + + +``` +geoPointEmpty={_='geoPointEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_appUpdate.md b/old_docs/API_docs_v81/constructors/help_appUpdate.md new file mode 100644 index 00000000..7bef9898 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_appUpdate.md @@ -0,0 +1,46 @@ +--- +title: help.appUpdate +description: help_appUpdate attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.appUpdate +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| +|critical|[Bool](../types/Bool.md) | Yes| +|url|[string](../types/string.md) | Yes| +|text|[string](../types/string.md) | Yes| + + + +### Type: [help\_AppUpdate](../types/help_AppUpdate.md) + + +### Example: + +``` +$help_appUpdate = ['_' => 'help.appUpdate', 'id' => int, 'critical' => Bool, 'url' => 'string', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.appUpdate", "id": int, "critical": Bool, "url": "string", "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +help_appUpdate={_='help.appUpdate', id=int, critical=Bool, url='string', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_configSimple.md b/old_docs/API_docs_v81/constructors/help_configSimple.md new file mode 100644 index 00000000..95457e3b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_configSimple.md @@ -0,0 +1,45 @@ +--- +title: help.configSimple +description: help_configSimple attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.configSimple +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|date|[int](../types/int.md) | Yes| +|expires|[int](../types/int.md) | Yes| +|rules|Array of [AccessPointRule](../types/AccessPointRule.md) | Yes| + + + +### Type: [help\_ConfigSimple](../types/help_ConfigSimple.md) + + +### Example: + +``` +$help_configSimple = ['_' => 'help.configSimple', 'date' => int, 'expires' => int, 'rules' => [AccessPointRule, AccessPointRule]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.configSimple", "date": int, "expires": int, "rules": [AccessPointRule]} +``` + + +Or, if you're into Lua: + + +``` +help_configSimple={_='help.configSimple', date=int, expires=int, rules={AccessPointRule}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_deepLinkInfo.md b/old_docs/API_docs_v81/constructors/help_deepLinkInfo.md new file mode 100644 index 00000000..b7b5ecdd --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_deepLinkInfo.md @@ -0,0 +1,45 @@ +--- +title: help.deepLinkInfo +description: help_deepLinkInfo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.deepLinkInfo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|update\_app|[Bool](../types/Bool.md) | Optional| +|message|[string](../types/string.md) | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional| + + + +### Type: [help\_DeepLinkInfo](../types/help_DeepLinkInfo.md) + + +### Example: + +``` +$help_deepLinkInfo = ['_' => 'help.deepLinkInfo', 'update_app' => Bool, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.deepLinkInfo", "update_app": Bool, "message": "string", "entities": [MessageEntity]} +``` + + +Or, if you're into Lua: + + +``` +help_deepLinkInfo={_='help.deepLinkInfo', update_app=Bool, message='string', entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_deepLinkInfoEmpty.md b/old_docs/API_docs_v81/constructors/help_deepLinkInfoEmpty.md new file mode 100644 index 00000000..86d01faa --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_deepLinkInfoEmpty.md @@ -0,0 +1,38 @@ +--- +title: help.deepLinkInfoEmpty +description: help_deepLinkInfoEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.deepLinkInfoEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [help\_DeepLinkInfo](../types/help_DeepLinkInfo.md) + + +### Example: + +``` +$help_deepLinkInfoEmpty = ['_' => 'help.deepLinkInfoEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.deepLinkInfoEmpty"} +``` + + +Or, if you're into Lua: + + +``` +help_deepLinkInfoEmpty={_='help.deepLinkInfoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_inviteText.md b/old_docs/API_docs_v81/constructors/help_inviteText.md new file mode 100644 index 00000000..67d0bb03 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_inviteText.md @@ -0,0 +1,43 @@ +--- +title: help.inviteText +description: help_inviteText attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.inviteText +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|message|[string](../types/string.md) | Yes| + + + +### Type: [help\_InviteText](../types/help_InviteText.md) + + +### Example: + +``` +$help_inviteText = ['_' => 'help.inviteText', 'message' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.inviteText", "message": "string"} +``` + + +Or, if you're into Lua: + + +``` +help_inviteText={_='help.inviteText', message='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_noAppUpdate.md b/old_docs/API_docs_v81/constructors/help_noAppUpdate.md new file mode 100644 index 00000000..4bda6033 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_noAppUpdate.md @@ -0,0 +1,38 @@ +--- +title: help.noAppUpdate +description: help_noAppUpdate attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.noAppUpdate +[Back to constructors index](index.md) + + + + + + +### Type: [help\_AppUpdate](../types/help_AppUpdate.md) + + +### Example: + +``` +$help_noAppUpdate = ['_' => 'help.noAppUpdate']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.noAppUpdate"} +``` + + +Or, if you're into Lua: + + +``` +help_noAppUpdate={_='help.noAppUpdate'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_proxyDataEmpty.md b/old_docs/API_docs_v81/constructors/help_proxyDataEmpty.md new file mode 100644 index 00000000..057991ed --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_proxyDataEmpty.md @@ -0,0 +1,43 @@ +--- +title: help.proxyDataEmpty +description: help_proxyDataEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.proxyDataEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|expires|[int](../types/int.md) | Yes| + + + +### Type: [help\_ProxyData](../types/help_ProxyData.md) + + +### Example: + +``` +$help_proxyDataEmpty = ['_' => 'help.proxyDataEmpty', 'expires' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.proxyDataEmpty", "expires": int} +``` + + +Or, if you're into Lua: + + +``` +help_proxyDataEmpty={_='help.proxyDataEmpty', expires=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_proxyDataPromo.md b/old_docs/API_docs_v81/constructors/help_proxyDataPromo.md new file mode 100644 index 00000000..19938a31 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_proxyDataPromo.md @@ -0,0 +1,46 @@ +--- +title: help.proxyDataPromo +description: help_proxyDataPromo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.proxyDataPromo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|expires|[int](../types/int.md) | Yes| +|peer|[Peer](../types/Peer.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [help\_ProxyData](../types/help_ProxyData.md) + + +### Example: + +``` +$help_proxyDataPromo = ['_' => 'help.proxyDataPromo', 'expires' => int, 'peer' => Peer, 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.proxyDataPromo", "expires": int, "peer": Peer, "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +help_proxyDataPromo={_='help.proxyDataPromo', expires=int, peer=Peer, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_recentMeUrls.md b/old_docs/API_docs_v81/constructors/help_recentMeUrls.md new file mode 100644 index 00000000..4fa513b5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_recentMeUrls.md @@ -0,0 +1,45 @@ +--- +title: help.recentMeUrls +description: help_recentMeUrls attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.recentMeUrls +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|urls|Array of [RecentMeUrl](../types/RecentMeUrl.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [help\_RecentMeUrls](../types/help_RecentMeUrls.md) + + +### Example: + +``` +$help_recentMeUrls = ['_' => 'help.recentMeUrls', 'urls' => [RecentMeUrl, RecentMeUrl], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.recentMeUrls", "urls": [RecentMeUrl], "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +help_recentMeUrls={_='help.recentMeUrls', urls={RecentMeUrl}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_support.md b/old_docs/API_docs_v81/constructors/help_support.md new file mode 100644 index 00000000..9062328b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_support.md @@ -0,0 +1,44 @@ +--- +title: help.support +description: help_support attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.support +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone\_number|[string](../types/string.md) | Yes| +|user|[User](../types/User.md) | Optional| + + + +### Type: [help\_Support](../types/help_Support.md) + + +### Example: + +``` +$help_support = ['_' => 'help.support', 'phone_number' => 'string', 'user' => User]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.support", "phone_number": "string", "user": User} +``` + + +Or, if you're into Lua: + + +``` +help_support={_='help.support', phone_number='string', user=User} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_termsOfService.md b/old_docs/API_docs_v81/constructors/help_termsOfService.md new file mode 100644 index 00000000..c154976d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_termsOfService.md @@ -0,0 +1,47 @@ +--- +title: help.termsOfService +description: help_termsOfService attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.termsOfService +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|popup|[Bool](../types/Bool.md) | Optional| +|id|[DataJSON](../types/DataJSON.md) | Yes| +|text|[string](../types/string.md) | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes| +|min\_age\_confirm|[int](../types/int.md) | Optional| + + + +### Type: [help\_wTermsOfService](../types/help_wTermsOfService.md) + + +### Example: + +``` +$help_termsOfService = ['_' => 'help.termsOfService', 'popup' => Bool, 'id' => DataJSON, 'text' => 'string', 'entities' => [MessageEntity, MessageEntity], 'min_age_confirm' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.termsOfService", "popup": Bool, "id": DataJSON, "text": "string", "entities": [MessageEntity], "min_age_confirm": int} +``` + + +Or, if you're into Lua: + + +``` +help_termsOfService={_='help.termsOfService', popup=Bool, id=DataJSON, text='string', entities={MessageEntity}, min_age_confirm=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_termsOfServiceUpdate.md b/old_docs/API_docs_v81/constructors/help_termsOfServiceUpdate.md new file mode 100644 index 00000000..161946a9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_termsOfServiceUpdate.md @@ -0,0 +1,44 @@ +--- +title: help.termsOfServiceUpdate +description: help_termsOfServiceUpdate attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.termsOfServiceUpdate +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|expires|[int](../types/int.md) | Yes| +|terms\_of\_service|[help\_TermsOfService](../types/help_TermsOfService.md) | Yes| + + + +### Type: [help\_TermsOfServiceUpdate](../types/help_TermsOfServiceUpdate.md) + + +### Example: + +``` +$help_termsOfServiceUpdate = ['_' => 'help.termsOfServiceUpdate', 'expires' => int, 'terms_of_service' => help_TermsOfService]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.termsOfServiceUpdate", "expires": int, "terms_of_service": help_TermsOfService} +``` + + +Or, if you're into Lua: + + +``` +help_termsOfServiceUpdate={_='help.termsOfServiceUpdate', expires=int, terms_of_service=help_TermsOfService} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/help_termsOfServiceUpdateEmpty.md b/old_docs/API_docs_v81/constructors/help_termsOfServiceUpdateEmpty.md new file mode 100644 index 00000000..369365db --- /dev/null +++ b/old_docs/API_docs_v81/constructors/help_termsOfServiceUpdateEmpty.md @@ -0,0 +1,43 @@ +--- +title: help.termsOfServiceUpdateEmpty +description: help_termsOfServiceUpdateEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: help.termsOfServiceUpdateEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|expires|[int](../types/int.md) | Yes| + + + +### Type: [help\_TermsOfServiceUpdate](../types/help_TermsOfServiceUpdate.md) + + +### Example: + +``` +$help_termsOfServiceUpdateEmpty = ['_' => 'help.termsOfServiceUpdateEmpty', 'expires' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "help.termsOfServiceUpdateEmpty", "expires": int} +``` + + +Or, if you're into Lua: + + +``` +help_termsOfServiceUpdateEmpty={_='help.termsOfServiceUpdateEmpty', expires=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/highScore.md b/old_docs/API_docs_v81/constructors/highScore.md new file mode 100644 index 00000000..63a8ab05 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/highScore.md @@ -0,0 +1,45 @@ +--- +title: highScore +description: highScore attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: highScore +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|pos|[int](../types/int.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|score|[int](../types/int.md) | Yes| + + + +### Type: [HighScore](../types/HighScore.md) + + +### Example: + +``` +$highScore = ['_' => 'highScore', 'pos' => int, 'user_id' => int, 'score' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "highScore", "pos": int, "user_id": int, "score": int} +``` + + +Or, if you're into Lua: + + +``` +highScore={_='highScore', pos=int, user_id=int, score=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/importedContact.md b/old_docs/API_docs_v81/constructors/importedContact.md new file mode 100644 index 00000000..4615cfa8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/importedContact.md @@ -0,0 +1,44 @@ +--- +title: importedContact +description: importedContact attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: importedContact +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|client\_id|[long](../types/long.md) | Yes| + + + +### Type: [ImportedContact](../types/ImportedContact.md) + + +### Example: + +``` +$importedContact = ['_' => 'importedContact', 'user_id' => int, 'client_id' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "importedContact", "user_id": int, "client_id": long} +``` + + +Or, if you're into Lua: + + +``` +importedContact={_='importedContact', user_id=int, client_id=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inlineBotSwitchPM.md b/old_docs/API_docs_v81/constructors/inlineBotSwitchPM.md new file mode 100644 index 00000000..0dfd4714 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inlineBotSwitchPM.md @@ -0,0 +1,44 @@ +--- +title: inlineBotSwitchPM +description: inlineBotSwitchPM attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inlineBotSwitchPM +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[string](../types/string.md) | Yes| +|start\_param|[string](../types/string.md) | Yes| + + + +### Type: [InlineBotSwitchPM](../types/InlineBotSwitchPM.md) + + +### Example: + +``` +$inlineBotSwitchPM = ['_' => 'inlineBotSwitchPM', 'text' => 'string', 'start_param' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inlineBotSwitchPM", "text": "string", "start_param": "string"} +``` + + +Or, if you're into Lua: + + +``` +inlineBotSwitchPM={_='inlineBotSwitchPM', text='string', start_param='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputAppEvent.md b/old_docs/API_docs_v81/constructors/inputAppEvent.md new file mode 100644 index 00000000..a09235f2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputAppEvent.md @@ -0,0 +1,46 @@ +--- +title: inputAppEvent +description: inputAppEvent attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputAppEvent +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|time|[double](../types/double.md) | Yes| +|type|[string](../types/string.md) | Yes| +|peer|[long](../types/long.md) | Yes| +|data|[string](../types/string.md) | Yes| + + + +### Type: [InputAppEvent](../types/InputAppEvent.md) + + +### Example: + +``` +$inputAppEvent = ['_' => 'inputAppEvent', 'time' => double, 'type' => 'string', 'peer' => long, 'data' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputAppEvent", "time": double, "type": "string", "peer": long, "data": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputAppEvent={_='inputAppEvent', time=double, type='string', peer=long, data='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputBotInlineMessageGame.md b/old_docs/API_docs_v81/constructors/inputBotInlineMessageGame.md new file mode 100644 index 00000000..8e59cd54 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputBotInlineMessageGame.md @@ -0,0 +1,49 @@ +--- +title: inputBotInlineMessageGame +description: inputBotInlineMessageGame attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageGame +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +``` +$inputBotInlineMessageGame = ['_' => 'inputBotInlineMessageGame', 'reply_markup' => ReplyMarkup]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputBotInlineMessageGame", "reply_markup": ReplyMarkup} +``` + + +Or, if you're into Lua: + + +``` +inputBotInlineMessageGame={_='inputBotInlineMessageGame', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/inputBotInlineMessageID.md b/old_docs/API_docs_v81/constructors/inputBotInlineMessageID.md new file mode 100644 index 00000000..91c7586d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputBotInlineMessageID.md @@ -0,0 +1,45 @@ +--- +title: inputBotInlineMessageID +description: inputBotInlineMessageID attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageID +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|dc\_id|[int](../types/int.md) | Yes| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputBotInlineMessageID](../types/InputBotInlineMessageID.md) + + +### Example: + +``` +$inputBotInlineMessageID = ['_' => 'inputBotInlineMessageID', 'dc_id' => int, 'id' => long, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputBotInlineMessageID", "dc_id": int, "id": long, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputBotInlineMessageID={_='inputBotInlineMessageID', dc_id=int, id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaAuto.md b/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaAuto.md new file mode 100644 index 00000000..997e711e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaAuto.md @@ -0,0 +1,51 @@ +--- +title: inputBotInlineMessageMediaAuto +description: inputBotInlineMessageMediaAuto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaAuto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|message|[string](../types/string.md) | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +``` +$inputBotInlineMessageMediaAuto = ['_' => 'inputBotInlineMessageMediaAuto', 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputBotInlineMessageMediaAuto", "message": "string", "entities": [MessageEntity], "reply_markup": ReplyMarkup} +``` + + +Or, if you're into Lua: + + +``` +inputBotInlineMessageMediaAuto={_='inputBotInlineMessageMediaAuto', message='string', entities={MessageEntity}, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaContact.md b/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaContact.md new file mode 100644 index 00000000..5b78709f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaContact.md @@ -0,0 +1,52 @@ +--- +title: inputBotInlineMessageMediaContact +description: inputBotInlineMessageMediaContact attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaContact +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone\_number|[string](../types/string.md) | Yes| +|first\_name|[string](../types/string.md) | Yes| +|last\_name|[string](../types/string.md) | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +``` +$inputBotInlineMessageMediaContact = ['_' => 'inputBotInlineMessageMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'reply_markup' => ReplyMarkup]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputBotInlineMessageMediaContact", "phone_number": "string", "first_name": "string", "last_name": "string", "reply_markup": ReplyMarkup} +``` + + +Or, if you're into Lua: + + +``` +inputBotInlineMessageMediaContact={_='inputBotInlineMessageMediaContact', phone_number='string', first_name='string', last_name='string', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaGeo.md b/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaGeo.md new file mode 100644 index 00000000..2f1f75ad --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaGeo.md @@ -0,0 +1,51 @@ +--- +title: inputBotInlineMessageMediaGeo +description: inputBotInlineMessageMediaGeo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaGeo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional| +|period|[int](../types/int.md) | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +``` +$inputBotInlineMessageMediaGeo = ['_' => 'inputBotInlineMessageMediaGeo', 'geo_point' => InputGeoPoint, 'period' => int, 'reply_markup' => ReplyMarkup]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputBotInlineMessageMediaGeo", "geo_point": InputGeoPoint, "period": int, "reply_markup": ReplyMarkup} +``` + + +Or, if you're into Lua: + + +``` +inputBotInlineMessageMediaGeo={_='inputBotInlineMessageMediaGeo', geo_point=InputGeoPoint, period=int, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaVenue.md b/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaVenue.md new file mode 100644 index 00000000..2e51d848 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputBotInlineMessageMediaVenue.md @@ -0,0 +1,55 @@ +--- +title: inputBotInlineMessageMediaVenue +description: inputBotInlineMessageMediaVenue attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaVenue +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional| +|title|[string](../types/string.md) | Yes| +|address|[string](../types/string.md) | Yes| +|provider|[string](../types/string.md) | Yes| +|venue\_id|[string](../types/string.md) | Yes| +|venue\_type|[string](../types/string.md) | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +``` +$inputBotInlineMessageMediaVenue = ['_' => 'inputBotInlineMessageMediaVenue', 'geo_point' => InputGeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string', 'venue_type' => 'string', 'reply_markup' => ReplyMarkup]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputBotInlineMessageMediaVenue", "geo_point": InputGeoPoint, "title": "string", "address": "string", "provider": "string", "venue_id": "string", "venue_type": "string", "reply_markup": ReplyMarkup} +``` + + +Or, if you're into Lua: + + +``` +inputBotInlineMessageMediaVenue={_='inputBotInlineMessageMediaVenue', geo_point=InputGeoPoint, title='string', address='string', provider='string', venue_id='string', venue_type='string', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/inputBotInlineMessageText.md b/old_docs/API_docs_v81/constructors/inputBotInlineMessageText.md new file mode 100644 index 00000000..e6a0bbb7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputBotInlineMessageText.md @@ -0,0 +1,52 @@ +--- +title: inputBotInlineMessageText +description: inputBotInlineMessageText attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageText +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Optional| +|message|[string](../types/string.md) | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +``` +$inputBotInlineMessageText = ['_' => 'inputBotInlineMessageText', 'no_webpage' => Bool, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputBotInlineMessageText", "no_webpage": Bool, "message": "string", "entities": [MessageEntity], "reply_markup": ReplyMarkup} +``` + + +Or, if you're into Lua: + + +``` +inputBotInlineMessageText={_='inputBotInlineMessageText', no_webpage=Bool, message='string', entities={MessageEntity}, reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/inputBotInlineResult.md b/old_docs/API_docs_v81/constructors/inputBotInlineResult.md new file mode 100644 index 00000000..dc1a30f3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputBotInlineResult.md @@ -0,0 +1,50 @@ +--- +title: inputBotInlineResult +description: inputBotInlineResult attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResult +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[string](../types/string.md) | Yes| +|type|[string](../types/string.md) | Yes| +|title|[string](../types/string.md) | Optional| +|description|[string](../types/string.md) | Optional| +|url|[string](../types/string.md) | Optional| +|thumb|[InputWebDocument](../types/InputWebDocument.md) | Optional| +|content|[InputWebDocument](../types/InputWebDocument.md) | Optional| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +``` +$inputBotInlineResult = ['_' => 'inputBotInlineResult', 'id' => 'string', 'type' => 'string', 'title' => 'string', 'description' => 'string', 'url' => 'string', 'thumb' => InputWebDocument, 'content' => InputWebDocument, 'send_message' => InputBotInlineMessage]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputBotInlineResult", "id": "string", "type": "string", "title": "string", "description": "string", "url": "string", "thumb": InputWebDocument, "content": InputWebDocument, "send_message": InputBotInlineMessage} +``` + + +Or, if you're into Lua: + + +``` +inputBotInlineResult={_='inputBotInlineResult', id='string', type='string', title='string', description='string', url='string', thumb=InputWebDocument, content=InputWebDocument, send_message=InputBotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputBotInlineResultDocument.md b/old_docs/API_docs_v81/constructors/inputBotInlineResultDocument.md new file mode 100644 index 00000000..ad13df76 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputBotInlineResultDocument.md @@ -0,0 +1,48 @@ +--- +title: inputBotInlineResultDocument +description: inputBotInlineResultDocument attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResultDocument +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[string](../types/string.md) | Yes| +|type|[string](../types/string.md) | Yes| +|title|[string](../types/string.md) | Optional| +|description|[string](../types/string.md) | Optional| +|document|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +``` +$inputBotInlineResultDocument = ['_' => 'inputBotInlineResultDocument', 'id' => 'string', 'type' => 'string', 'title' => 'string', 'description' => 'string', 'document' => InputDocument, 'send_message' => InputBotInlineMessage]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputBotInlineResultDocument", "id": "string", "type": "string", "title": "string", "description": "string", "document": InputDocument, "send_message": InputBotInlineMessage} +``` + + +Or, if you're into Lua: + + +``` +inputBotInlineResultDocument={_='inputBotInlineResultDocument', id='string', type='string', title='string', description='string', document=InputDocument, send_message=InputBotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputBotInlineResultGame.md b/old_docs/API_docs_v81/constructors/inputBotInlineResultGame.md new file mode 100644 index 00000000..5967bea6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputBotInlineResultGame.md @@ -0,0 +1,45 @@ +--- +title: inputBotInlineResultGame +description: inputBotInlineResultGame attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResultGame +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[string](../types/string.md) | Yes| +|short\_name|[string](../types/string.md) | Yes| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +``` +$inputBotInlineResultGame = ['_' => 'inputBotInlineResultGame', 'id' => 'string', 'short_name' => 'string', 'send_message' => InputBotInlineMessage]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputBotInlineResultGame", "id": "string", "short_name": "string", "send_message": InputBotInlineMessage} +``` + + +Or, if you're into Lua: + + +``` +inputBotInlineResultGame={_='inputBotInlineResultGame', id='string', short_name='string', send_message=InputBotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputBotInlineResultPhoto.md b/old_docs/API_docs_v81/constructors/inputBotInlineResultPhoto.md new file mode 100644 index 00000000..43f00813 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputBotInlineResultPhoto.md @@ -0,0 +1,46 @@ +--- +title: inputBotInlineResultPhoto +description: inputBotInlineResultPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResultPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[string](../types/string.md) | Yes| +|type|[string](../types/string.md) | Yes| +|photo|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +``` +$inputBotInlineResultPhoto = ['_' => 'inputBotInlineResultPhoto', 'id' => 'string', 'type' => 'string', 'photo' => InputPhoto, 'send_message' => InputBotInlineMessage]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputBotInlineResultPhoto", "id": "string", "type": "string", "photo": InputPhoto, "send_message": InputBotInlineMessage} +``` + + +Or, if you're into Lua: + + +``` +inputBotInlineResultPhoto={_='inputBotInlineResultPhoto', id='string', type='string', photo=InputPhoto, send_message=InputBotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputChannel.md b/old_docs/API_docs_v81/constructors/inputChannel.md new file mode 100644 index 00000000..b5cb3566 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputChannel.md @@ -0,0 +1,44 @@ +--- +title: inputChannel +description: inputChannel attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChannel +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputChannel](../types/InputChannel.md) + + +### Example: + +``` +$inputChannel = ['_' => 'inputChannel', 'channel_id' => int, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputChannel", "channel_id": int, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputChannel={_='inputChannel', channel_id=int, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputChannelEmpty.md b/old_docs/API_docs_v81/constructors/inputChannelEmpty.md new file mode 100644 index 00000000..f7e18434 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputChannelEmpty.md @@ -0,0 +1,38 @@ +--- +title: inputChannelEmpty +description: inputChannelEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChannelEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [InputChannel](../types/InputChannel.md) + + +### Example: + +``` +$inputChannelEmpty = ['_' => 'inputChannelEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputChannelEmpty"} +``` + + +Or, if you're into Lua: + + +``` +inputChannelEmpty={_='inputChannelEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputChatPhoto.md b/old_docs/API_docs_v81/constructors/inputChatPhoto.md new file mode 100644 index 00000000..636d6f68 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputChatPhoto.md @@ -0,0 +1,43 @@ +--- +title: inputChatPhoto +description: inputChatPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChatPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional| + + + +### Type: [InputChatPhoto](../types/InputChatPhoto.md) + + +### Example: + +``` +$inputChatPhoto = ['_' => 'inputChatPhoto', 'id' => InputPhoto]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputChatPhoto", "id": InputPhoto} +``` + + +Or, if you're into Lua: + + +``` +inputChatPhoto={_='inputChatPhoto', id=InputPhoto} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputChatPhotoEmpty.md b/old_docs/API_docs_v81/constructors/inputChatPhotoEmpty.md new file mode 100644 index 00000000..1a1aea75 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputChatPhotoEmpty.md @@ -0,0 +1,38 @@ +--- +title: inputChatPhotoEmpty +description: inputChatPhotoEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChatPhotoEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [InputChatPhoto](../types/InputChatPhoto.md) + + +### Example: + +``` +$inputChatPhotoEmpty = ['_' => 'inputChatPhotoEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputChatPhotoEmpty"} +``` + + +Or, if you're into Lua: + + +``` +inputChatPhotoEmpty={_='inputChatPhotoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputChatUploadedPhoto.md b/old_docs/API_docs_v81/constructors/inputChatUploadedPhoto.md new file mode 100644 index 00000000..840ed815 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputChatUploadedPhoto.md @@ -0,0 +1,43 @@ +--- +title: inputChatUploadedPhoto +description: inputChatUploadedPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChatUploadedPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | Yes| + + + +### Type: [InputChatPhoto](../types/InputChatPhoto.md) + + +### Example: + +``` +$inputChatUploadedPhoto = ['_' => 'inputChatUploadedPhoto', 'file' => InputFile]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputChatUploadedPhoto", "file": InputFile} +``` + + +Or, if you're into Lua: + + +``` +inputChatUploadedPhoto={_='inputChatUploadedPhoto', file=InputFile} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputClientProxy.md b/old_docs/API_docs_v81/constructors/inputClientProxy.md new file mode 100644 index 00000000..a6db151e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputClientProxy.md @@ -0,0 +1,44 @@ +--- +title: inputClientProxy +description: inputClientProxy attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputClientProxy +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|address|[string](../types/string.md) | Yes| +|port|[int](../types/int.md) | Yes| + + + +### Type: [InputClientProxy](../types/InputClientProxy.md) + + +### Example: + +``` +$inputClientProxy = ['_' => 'inputClientProxy', 'address' => 'string', 'port' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputClientProxy", "address": "string", "port": int} +``` + + +Or, if you're into Lua: + + +``` +inputClientProxy={_='inputClientProxy', address='string', port=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputDialogPeer.md b/old_docs/API_docs_v81/constructors/inputDialogPeer.md new file mode 100644 index 00000000..b536e8d2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputDialogPeer.md @@ -0,0 +1,43 @@ +--- +title: inputDialogPeer +description: inputDialogPeer attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputDialogPeer +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| + + + +### Type: [InputDialogPeer](../types/InputDialogPeer.md) + + +### Example: + +``` +$inputDialogPeer = ['_' => 'inputDialogPeer', 'peer' => InputPeer]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputDialogPeer", "peer": InputPeer} +``` + + +Or, if you're into Lua: + + +``` +inputDialogPeer={_='inputDialogPeer', peer=InputPeer} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputDocument.md b/old_docs/API_docs_v81/constructors/inputDocument.md new file mode 100644 index 00000000..3adfb1b9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputDocument.md @@ -0,0 +1,44 @@ +--- +title: inputDocument +description: inputDocument attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputDocument +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputDocument](../types/InputDocument.md) + + +### Example: + +``` +$inputDocument = ['_' => 'inputDocument', 'id' => long, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputDocument", "id": long, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputDocument={_='inputDocument', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputDocumentEmpty.md b/old_docs/API_docs_v81/constructors/inputDocumentEmpty.md new file mode 100644 index 00000000..374ea32b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputDocumentEmpty.md @@ -0,0 +1,38 @@ +--- +title: inputDocumentEmpty +description: inputDocumentEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputDocumentEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [InputDocument](../types/InputDocument.md) + + +### Example: + +``` +$inputDocumentEmpty = ['_' => 'inputDocumentEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputDocumentEmpty"} +``` + + +Or, if you're into Lua: + + +``` +inputDocumentEmpty={_='inputDocumentEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputDocumentFileLocation.md b/old_docs/API_docs_v81/constructors/inputDocumentFileLocation.md new file mode 100644 index 00000000..df556f40 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputDocumentFileLocation.md @@ -0,0 +1,45 @@ +--- +title: inputDocumentFileLocation +description: inputDocumentFileLocation attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputDocumentFileLocation +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|version|[int](../types/int.md) | Yes| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +``` +$inputDocumentFileLocation = ['_' => 'inputDocumentFileLocation', 'id' => long, 'access_hash' => long, 'version' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputDocumentFileLocation", "id": long, "access_hash": long, "version": int} +``` + + +Or, if you're into Lua: + + +``` +inputDocumentFileLocation={_='inputDocumentFileLocation', id=long, access_hash=long, version=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputEncryptedChat.md b/old_docs/API_docs_v81/constructors/inputEncryptedChat.md new file mode 100644 index 00000000..346b03c3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputEncryptedChat.md @@ -0,0 +1,44 @@ +--- +title: inputEncryptedChat +description: inputEncryptedChat attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedChat +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputEncryptedChat](../types/InputEncryptedChat.md) + + +### Example: + +``` +$inputEncryptedChat = ['_' => 'inputEncryptedChat', 'chat_id' => int, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputEncryptedChat", "chat_id": int, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputEncryptedChat={_='inputEncryptedChat', chat_id=int, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputEncryptedFile.md b/old_docs/API_docs_v81/constructors/inputEncryptedFile.md new file mode 100644 index 00000000..84d27a73 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputEncryptedFile.md @@ -0,0 +1,44 @@ +--- +title: inputEncryptedFile +description: inputEncryptedFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedFile +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputEncryptedFile](../types/InputEncryptedFile.md) + + +### Example: + +``` +$inputEncryptedFile = ['_' => 'inputEncryptedFile', 'id' => long, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputEncryptedFile", "id": long, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputEncryptedFile={_='inputEncryptedFile', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputEncryptedFileBigUploaded.md b/old_docs/API_docs_v81/constructors/inputEncryptedFileBigUploaded.md new file mode 100644 index 00000000..b39b42e7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputEncryptedFileBigUploaded.md @@ -0,0 +1,45 @@ +--- +title: inputEncryptedFileBigUploaded +description: inputEncryptedFileBigUploaded attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedFileBigUploaded +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|parts|[int](../types/int.md) | Yes| +|key\_fingerprint|[int](../types/int.md) | Yes| + + + +### Type: [InputEncryptedFile](../types/InputEncryptedFile.md) + + +### Example: + +``` +$inputEncryptedFileBigUploaded = ['_' => 'inputEncryptedFileBigUploaded', 'id' => long, 'parts' => int, 'key_fingerprint' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputEncryptedFileBigUploaded", "id": long, "parts": int, "key_fingerprint": int} +``` + + +Or, if you're into Lua: + + +``` +inputEncryptedFileBigUploaded={_='inputEncryptedFileBigUploaded', id=long, parts=int, key_fingerprint=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputEncryptedFileEmpty.md b/old_docs/API_docs_v81/constructors/inputEncryptedFileEmpty.md new file mode 100644 index 00000000..c07ca14f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputEncryptedFileEmpty.md @@ -0,0 +1,38 @@ +--- +title: inputEncryptedFileEmpty +description: inputEncryptedFileEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedFileEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [InputEncryptedFile](../types/InputEncryptedFile.md) + + +### Example: + +``` +$inputEncryptedFileEmpty = ['_' => 'inputEncryptedFileEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputEncryptedFileEmpty"} +``` + + +Or, if you're into Lua: + + +``` +inputEncryptedFileEmpty={_='inputEncryptedFileEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputEncryptedFileLocation.md b/old_docs/API_docs_v81/constructors/inputEncryptedFileLocation.md new file mode 100644 index 00000000..35271b85 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputEncryptedFileLocation.md @@ -0,0 +1,44 @@ +--- +title: inputEncryptedFileLocation +description: inputEncryptedFileLocation attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedFileLocation +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +``` +$inputEncryptedFileLocation = ['_' => 'inputEncryptedFileLocation', 'id' => long, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputEncryptedFileLocation", "id": long, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputEncryptedFileLocation={_='inputEncryptedFileLocation', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputEncryptedFileUploaded.md b/old_docs/API_docs_v81/constructors/inputEncryptedFileUploaded.md new file mode 100644 index 00000000..31b2eb2b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputEncryptedFileUploaded.md @@ -0,0 +1,46 @@ +--- +title: inputEncryptedFileUploaded +description: inputEncryptedFileUploaded attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedFileUploaded +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|parts|[int](../types/int.md) | Yes| +|md5\_checksum|[string](../types/string.md) | Yes| +|key\_fingerprint|[int](../types/int.md) | Yes| + + + +### Type: [InputEncryptedFile](../types/InputEncryptedFile.md) + + +### Example: + +``` +$inputEncryptedFileUploaded = ['_' => 'inputEncryptedFileUploaded', 'id' => long, 'parts' => int, 'md5_checksum' => 'string', 'key_fingerprint' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputEncryptedFileUploaded", "id": long, "parts": int, "md5_checksum": "string", "key_fingerprint": int} +``` + + +Or, if you're into Lua: + + +``` +inputEncryptedFileUploaded={_='inputEncryptedFileUploaded', id=long, parts=int, md5_checksum='string', key_fingerprint=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputFile.md b/old_docs/API_docs_v81/constructors/inputFile.md new file mode 100644 index 00000000..64f6f343 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputFile.md @@ -0,0 +1,46 @@ +--- +title: inputFile +description: inputFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputFile +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|parts|[int](../types/int.md) | Yes| +|name|[string](../types/string.md) | Yes| +|md5\_checksum|[string](../types/string.md) | Yes| + + + +### Type: [InputFile](../types/InputFile.md) + + +### Example: + +``` +$inputFile = ['_' => 'inputFile', 'id' => long, 'parts' => int, 'name' => 'string', 'md5_checksum' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputFile", "id": long, "parts": int, "name": "string", "md5_checksum": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputFile={_='inputFile', id=long, parts=int, name='string', md5_checksum='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputFileBig.md b/old_docs/API_docs_v81/constructors/inputFileBig.md new file mode 100644 index 00000000..81c21dc0 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputFileBig.md @@ -0,0 +1,45 @@ +--- +title: inputFileBig +description: inputFileBig attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputFileBig +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|parts|[int](../types/int.md) | Yes| +|name|[string](../types/string.md) | Yes| + + + +### Type: [InputFile](../types/InputFile.md) + + +### Example: + +``` +$inputFileBig = ['_' => 'inputFileBig', 'id' => long, 'parts' => int, 'name' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputFileBig", "id": long, "parts": int, "name": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputFileBig={_='inputFileBig', id=long, parts=int, name='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputFileLocation.md b/old_docs/API_docs_v81/constructors/inputFileLocation.md new file mode 100644 index 00000000..2bbb8c97 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputFileLocation.md @@ -0,0 +1,45 @@ +--- +title: inputFileLocation +description: inputFileLocation attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputFileLocation +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|volume\_id|[long](../types/long.md) | Yes| +|local\_id|[int](../types/int.md) | Yes| +|secret|[long](../types/long.md) | Yes| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +``` +$inputFileLocation = ['_' => 'inputFileLocation', 'volume_id' => long, 'local_id' => int, 'secret' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputFileLocation", "volume_id": long, "local_id": int, "secret": long} +``` + + +Or, if you're into Lua: + + +``` +inputFileLocation={_='inputFileLocation', volume_id=long, local_id=int, secret=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputGameID.md b/old_docs/API_docs_v81/constructors/inputGameID.md new file mode 100644 index 00000000..1fff2dd1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputGameID.md @@ -0,0 +1,44 @@ +--- +title: inputGameID +description: inputGameID attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputGameID +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputGame](../types/InputGame.md) + + +### Example: + +``` +$inputGameID = ['_' => 'inputGameID', 'id' => long, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputGameID", "id": long, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputGameID={_='inputGameID', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputGameShortName.md b/old_docs/API_docs_v81/constructors/inputGameShortName.md new file mode 100644 index 00000000..742b5ae5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputGameShortName.md @@ -0,0 +1,44 @@ +--- +title: inputGameShortName +description: inputGameShortName attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputGameShortName +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|bot\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +|short\_name|[string](../types/string.md) | Yes| + + + +### Type: [InputGame](../types/InputGame.md) + + +### Example: + +``` +$inputGameShortName = ['_' => 'inputGameShortName', 'bot_id' => InputUser, 'short_name' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputGameShortName", "bot_id": InputUser, "short_name": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputGameShortName={_='inputGameShortName', bot_id=InputUser, short_name='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputGeoPoint.md b/old_docs/API_docs_v81/constructors/inputGeoPoint.md new file mode 100644 index 00000000..75d080d6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputGeoPoint.md @@ -0,0 +1,44 @@ +--- +title: inputGeoPoint +description: inputGeoPoint attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputGeoPoint +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|lat|[double](../types/double.md) | Yes| +|long|[double](../types/double.md) | Yes| + + + +### Type: [InputGeoPoint](../types/InputGeoPoint.md) + + +### Example: + +``` +$inputGeoPoint = ['_' => 'inputGeoPoint', 'lat' => double, 'long' => double]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputGeoPoint", "lat": double, "long": double} +``` + + +Or, if you're into Lua: + + +``` +inputGeoPoint={_='inputGeoPoint', lat=double, long=double} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputGeoPointEmpty.md b/old_docs/API_docs_v81/constructors/inputGeoPointEmpty.md new file mode 100644 index 00000000..7d511909 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputGeoPointEmpty.md @@ -0,0 +1,38 @@ +--- +title: inputGeoPointEmpty +description: inputGeoPointEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputGeoPointEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [InputGeoPoint](../types/InputGeoPoint.md) + + +### Example: + +``` +$inputGeoPointEmpty = ['_' => 'inputGeoPointEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputGeoPointEmpty"} +``` + + +Or, if you're into Lua: + + +``` +inputGeoPointEmpty={_='inputGeoPointEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaContact.md b/old_docs/API_docs_v81/constructors/inputMediaContact.md new file mode 100644 index 00000000..3dcee4c1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaContact.md @@ -0,0 +1,45 @@ +--- +title: inputMediaContact +description: inputMediaContact attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaContact +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone\_number|[string](../types/string.md) | Yes| +|first\_name|[string](../types/string.md) | Yes| +|last\_name|[string](../types/string.md) | Yes| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaContact = ['_' => 'inputMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaContact", "phone_number": "string", "first_name": "string", "last_name": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputMediaContact={_='inputMediaContact', phone_number='string', first_name='string', last_name='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaDocument.md b/old_docs/API_docs_v81/constructors/inputMediaDocument.md new file mode 100644 index 00000000..84065899 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaDocument.md @@ -0,0 +1,44 @@ +--- +title: inputMediaDocument +description: inputMediaDocument attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaDocument +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional| +|ttl\_seconds|[int](../types/int.md) | Optional| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaDocument = ['_' => 'inputMediaDocument', 'id' => InputDocument, 'ttl_seconds' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaDocument", "id": InputDocument, "ttl_seconds": int} +``` + + +Or, if you're into Lua: + + +``` +inputMediaDocument={_='inputMediaDocument', id=InputDocument, ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaDocumentExternal.md b/old_docs/API_docs_v81/constructors/inputMediaDocumentExternal.md new file mode 100644 index 00000000..579f7f6d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaDocumentExternal.md @@ -0,0 +1,44 @@ +--- +title: inputMediaDocumentExternal +description: inputMediaDocumentExternal attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaDocumentExternal +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|ttl\_seconds|[int](../types/int.md) | Optional| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaDocumentExternal = ['_' => 'inputMediaDocumentExternal', 'url' => 'string', 'ttl_seconds' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaDocumentExternal", "url": "string", "ttl_seconds": int} +``` + + +Or, if you're into Lua: + + +``` +inputMediaDocumentExternal={_='inputMediaDocumentExternal', url='string', ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaEmpty.md b/old_docs/API_docs_v81/constructors/inputMediaEmpty.md new file mode 100644 index 00000000..682bd6c6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaEmpty.md @@ -0,0 +1,38 @@ +--- +title: inputMediaEmpty +description: inputMediaEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaEmpty = ['_' => 'inputMediaEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaEmpty"} +``` + + +Or, if you're into Lua: + + +``` +inputMediaEmpty={_='inputMediaEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaGame.md b/old_docs/API_docs_v81/constructors/inputMediaGame.md new file mode 100644 index 00000000..883e5672 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaGame.md @@ -0,0 +1,43 @@ +--- +title: inputMediaGame +description: inputMediaGame attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaGame +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[InputGame](../types/InputGame.md) | Yes| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaGame = ['_' => 'inputMediaGame', 'id' => InputGame]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaGame", "id": InputGame} +``` + + +Or, if you're into Lua: + + +``` +inputMediaGame={_='inputMediaGame', id=InputGame} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaGeoLive.md b/old_docs/API_docs_v81/constructors/inputMediaGeoLive.md new file mode 100644 index 00000000..bf72edfb --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaGeoLive.md @@ -0,0 +1,44 @@ +--- +title: inputMediaGeoLive +description: inputMediaGeoLive attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaGeoLive +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional| +|period|[int](../types/int.md) | Yes| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaGeoLive = ['_' => 'inputMediaGeoLive', 'geo_point' => InputGeoPoint, 'period' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaGeoLive", "geo_point": InputGeoPoint, "period": int} +``` + + +Or, if you're into Lua: + + +``` +inputMediaGeoLive={_='inputMediaGeoLive', geo_point=InputGeoPoint, period=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaGeoPoint.md b/old_docs/API_docs_v81/constructors/inputMediaGeoPoint.md new file mode 100644 index 00000000..12b715c8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaGeoPoint.md @@ -0,0 +1,43 @@ +--- +title: inputMediaGeoPoint +description: inputMediaGeoPoint attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaGeoPoint +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaGeoPoint = ['_' => 'inputMediaGeoPoint', 'geo_point' => InputGeoPoint]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaGeoPoint", "geo_point": InputGeoPoint} +``` + + +Or, if you're into Lua: + + +``` +inputMediaGeoPoint={_='inputMediaGeoPoint', geo_point=InputGeoPoint} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaGifExternal.md b/old_docs/API_docs_v81/constructors/inputMediaGifExternal.md new file mode 100644 index 00000000..cf68972a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaGifExternal.md @@ -0,0 +1,44 @@ +--- +title: inputMediaGifExternal +description: inputMediaGifExternal attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaGifExternal +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|q|[string](../types/string.md) | Yes| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaGifExternal = ['_' => 'inputMediaGifExternal', 'url' => 'string', 'q' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaGifExternal", "url": "string", "q": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputMediaGifExternal={_='inputMediaGifExternal', url='string', q='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaInvoice.md b/old_docs/API_docs_v81/constructors/inputMediaInvoice.md new file mode 100644 index 00000000..7f66c4c3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaInvoice.md @@ -0,0 +1,50 @@ +--- +title: inputMediaInvoice +description: inputMediaInvoice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaInvoice +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|title|[string](../types/string.md) | Yes| +|description|[string](../types/string.md) | Yes| +|photo|[InputWebDocument](../types/InputWebDocument.md) | Optional| +|invoice|[Invoice](../types/Invoice.md) | Yes| +|payload|[bytes](../types/bytes.md) | Yes| +|provider|[string](../types/string.md) | Yes| +|provider\_data|[DataJSON](../types/DataJSON.md) | Yes| +|start\_param|[string](../types/string.md) | Yes| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaInvoice = ['_' => 'inputMediaInvoice', 'title' => 'string', 'description' => 'string', 'photo' => InputWebDocument, 'invoice' => Invoice, 'payload' => 'bytes', 'provider' => 'string', 'provider_data' => DataJSON, 'start_param' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaInvoice", "title": "string", "description": "string", "photo": InputWebDocument, "invoice": Invoice, "payload": {"_": "bytes", "bytes":"base64 encoded bytes"}, "provider": "string", "provider_data": DataJSON, "start_param": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputMediaInvoice={_='inputMediaInvoice', title='string', description='string', photo=InputWebDocument, invoice=Invoice, payload='bytes', provider='string', provider_data=DataJSON, start_param='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaPhoto.md b/old_docs/API_docs_v81/constructors/inputMediaPhoto.md new file mode 100644 index 00000000..c6ba1034 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaPhoto.md @@ -0,0 +1,44 @@ +--- +title: inputMediaPhoto +description: inputMediaPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional| +|ttl\_seconds|[int](../types/int.md) | Optional| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaPhoto = ['_' => 'inputMediaPhoto', 'id' => InputPhoto, 'ttl_seconds' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaPhoto", "id": InputPhoto, "ttl_seconds": int} +``` + + +Or, if you're into Lua: + + +``` +inputMediaPhoto={_='inputMediaPhoto', id=InputPhoto, ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaPhotoExternal.md b/old_docs/API_docs_v81/constructors/inputMediaPhotoExternal.md new file mode 100644 index 00000000..7103a02c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaPhotoExternal.md @@ -0,0 +1,44 @@ +--- +title: inputMediaPhotoExternal +description: inputMediaPhotoExternal attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaPhotoExternal +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|ttl\_seconds|[int](../types/int.md) | Optional| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaPhotoExternal = ['_' => 'inputMediaPhotoExternal', 'url' => 'string', 'ttl_seconds' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaPhotoExternal", "url": "string", "ttl_seconds": int} +``` + + +Or, if you're into Lua: + + +``` +inputMediaPhotoExternal={_='inputMediaPhotoExternal', url='string', ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaUploadedDocument.md b/old_docs/API_docs_v81/constructors/inputMediaUploadedDocument.md new file mode 100644 index 00000000..e009cbb1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaUploadedDocument.md @@ -0,0 +1,49 @@ +--- +title: inputMediaUploadedDocument +description: inputMediaUploadedDocument attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaUploadedDocument +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|nosound\_video|[Bool](../types/Bool.md) | Optional| +|file|[File path or InputFile](../types/InputFile.md) | Yes| +|thumb|[File path or InputFile](../types/InputFile.md) | Optional| +|mime\_type|[string](../types/string.md) | Optional| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes| +|stickers|Array of [MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional| +|ttl\_seconds|[int](../types/int.md) | Optional| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaUploadedDocument = ['_' => 'inputMediaUploadedDocument', 'nosound_video' => Bool, 'file' => InputFile, 'thumb' => InputFile, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute], 'stickers' => [InputDocument, InputDocument], 'ttl_seconds' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaUploadedDocument", "nosound_video": Bool, "file": InputFile, "thumb": InputFile, "mime_type": "string", "attributes": [DocumentAttribute], "stickers": [InputDocument], "ttl_seconds": int} +``` + + +Or, if you're into Lua: + + +``` +inputMediaUploadedDocument={_='inputMediaUploadedDocument', nosound_video=Bool, file=InputFile, thumb=InputFile, mime_type='string', attributes={DocumentAttribute}, stickers={InputDocument}, ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaUploadedPhoto.md b/old_docs/API_docs_v81/constructors/inputMediaUploadedPhoto.md new file mode 100644 index 00000000..fe8a811a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaUploadedPhoto.md @@ -0,0 +1,45 @@ +--- +title: inputMediaUploadedPhoto +description: inputMediaUploadedPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaUploadedPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | Yes| +|stickers|Array of [MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional| +|ttl\_seconds|[int](../types/int.md) | Optional| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaUploadedPhoto = ['_' => 'inputMediaUploadedPhoto', 'file' => InputFile, 'stickers' => [InputDocument, InputDocument], 'ttl_seconds' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaUploadedPhoto", "file": InputFile, "stickers": [InputDocument], "ttl_seconds": int} +``` + + +Or, if you're into Lua: + + +``` +inputMediaUploadedPhoto={_='inputMediaUploadedPhoto', file=InputFile, stickers={InputDocument}, ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMediaVenue.md b/old_docs/API_docs_v81/constructors/inputMediaVenue.md new file mode 100644 index 00000000..017f62ee --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMediaVenue.md @@ -0,0 +1,48 @@ +--- +title: inputMediaVenue +description: inputMediaVenue attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaVenue +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional| +|title|[string](../types/string.md) | Yes| +|address|[string](../types/string.md) | Yes| +|provider|[string](../types/string.md) | Yes| +|venue\_id|[string](../types/string.md) | Yes| +|venue\_type|[string](../types/string.md) | Yes| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +``` +$inputMediaVenue = ['_' => 'inputMediaVenue', 'geo_point' => InputGeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string', 'venue_type' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMediaVenue", "geo_point": InputGeoPoint, "title": "string", "address": "string", "provider": "string", "venue_id": "string", "venue_type": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputMediaVenue={_='inputMediaVenue', geo_point=InputGeoPoint, title='string', address='string', provider='string', venue_id='string', venue_type='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessageEntityMentionName.md b/old_docs/API_docs_v81/constructors/inputMessageEntityMentionName.md new file mode 100644 index 00000000..92d5c8d9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessageEntityMentionName.md @@ -0,0 +1,45 @@ +--- +title: inputMessageEntityMentionName +description: inputMessageEntityMentionName attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessageEntityMentionName +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| +|user\_id|[InputUser](../types/InputUser.md) | Optional| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$inputMessageEntityMentionName = ['_' => 'inputMessageEntityMentionName', 'offset' => int, 'length' => int, 'user_id' => InputUser]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessageEntityMentionName", "offset": int, "length": int, "user_id": InputUser} +``` + + +Or, if you're into Lua: + + +``` +inputMessageEntityMentionName={_='inputMessageEntityMentionName', offset=int, length=int, user_id=InputUser} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessageID.md b/old_docs/API_docs_v81/constructors/inputMessageID.md new file mode 100644 index 00000000..c6123b92 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessageID.md @@ -0,0 +1,43 @@ +--- +title: inputMessageID +description: inputMessageID attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessageID +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| + + + +### Type: [InputMessage](../types/InputMessage.md) + + +### Example: + +``` +$inputMessageID = ['_' => 'inputMessageID', 'id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessageID", "id": int} +``` + + +Or, if you're into Lua: + + +``` +inputMessageID={_='inputMessageID', id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagePinned.md b/old_docs/API_docs_v81/constructors/inputMessagePinned.md new file mode 100644 index 00000000..4dc9197e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagePinned.md @@ -0,0 +1,38 @@ +--- +title: inputMessagePinned +description: inputMessagePinned attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagePinned +[Back to constructors index](index.md) + + + + + + +### Type: [InputMessage](../types/InputMessage.md) + + +### Example: + +``` +$inputMessagePinned = ['_' => 'inputMessagePinned']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagePinned"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagePinned={_='inputMessagePinned'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessageReplyTo.md b/old_docs/API_docs_v81/constructors/inputMessageReplyTo.md new file mode 100644 index 00000000..c1737e7d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessageReplyTo.md @@ -0,0 +1,43 @@ +--- +title: inputMessageReplyTo +description: inputMessageReplyTo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessageReplyTo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| + + + +### Type: [InputMessage](../types/InputMessage.md) + + +### Example: + +``` +$inputMessageReplyTo = ['_' => 'inputMessageReplyTo', 'id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessageReplyTo", "id": int} +``` + + +Or, if you're into Lua: + + +``` +inputMessageReplyTo={_='inputMessageReplyTo', id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterChatPhotos.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterChatPhotos.md new file mode 100644 index 00000000..a02425b1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterChatPhotos.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterChatPhotos +description: inputMessagesFilterChatPhotos attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterChatPhotos +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterChatPhotos = ['_' => 'inputMessagesFilterChatPhotos']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterChatPhotos"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterChatPhotos={_='inputMessagesFilterChatPhotos'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterContacts.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterContacts.md new file mode 100644 index 00000000..98de3f5e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterContacts.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterContacts +description: inputMessagesFilterContacts attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterContacts +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterContacts = ['_' => 'inputMessagesFilterContacts']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterContacts"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterContacts={_='inputMessagesFilterContacts'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterDocument.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterDocument.md new file mode 100644 index 00000000..5ba5376d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterDocument.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterDocument +description: inputMessagesFilterDocument attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterDocument +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterDocument = ['_' => 'inputMessagesFilterDocument']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterDocument"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterDocument={_='inputMessagesFilterDocument'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterEmpty.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterEmpty.md new file mode 100644 index 00000000..d05b16ca --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterEmpty.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterEmpty +description: inputMessagesFilterEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterEmpty = ['_' => 'inputMessagesFilterEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterEmpty"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterEmpty={_='inputMessagesFilterEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterGeo.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterGeo.md new file mode 100644 index 00000000..96da554b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterGeo.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterGeo +description: inputMessagesFilterGeo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterGeo +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterGeo = ['_' => 'inputMessagesFilterGeo']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterGeo"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterGeo={_='inputMessagesFilterGeo'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterGif.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterGif.md new file mode 100644 index 00000000..94698ecd --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterGif.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterGif +description: inputMessagesFilterGif attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterGif +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterGif = ['_' => 'inputMessagesFilterGif']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterGif"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterGif={_='inputMessagesFilterGif'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterMusic.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterMusic.md new file mode 100644 index 00000000..ac6373c2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterMusic.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterMusic +description: inputMessagesFilterMusic attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterMusic +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterMusic = ['_' => 'inputMessagesFilterMusic']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterMusic"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterMusic={_='inputMessagesFilterMusic'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterMyMentions.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterMyMentions.md new file mode 100644 index 00000000..68411008 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterMyMentions.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterMyMentions +description: inputMessagesFilterMyMentions attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterMyMentions +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterMyMentions = ['_' => 'inputMessagesFilterMyMentions']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterMyMentions"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterMyMentions={_='inputMessagesFilterMyMentions'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterPhoneCalls.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterPhoneCalls.md new file mode 100644 index 00000000..8fe8537a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterPhoneCalls.md @@ -0,0 +1,43 @@ +--- +title: inputMessagesFilterPhoneCalls +description: inputMessagesFilterPhoneCalls attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterPhoneCalls +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|missed|[Bool](../types/Bool.md) | Optional| + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterPhoneCalls = ['_' => 'inputMessagesFilterPhoneCalls', 'missed' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterPhoneCalls", "missed": Bool} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterPhoneCalls={_='inputMessagesFilterPhoneCalls', missed=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterPhotoVideo.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterPhotoVideo.md new file mode 100644 index 00000000..183c8c56 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterPhotoVideo.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterPhotoVideo +description: inputMessagesFilterPhotoVideo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterPhotoVideo +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterPhotoVideo = ['_' => 'inputMessagesFilterPhotoVideo']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterPhotoVideo"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterPhotoVideo={_='inputMessagesFilterPhotoVideo'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterPhotos.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterPhotos.md new file mode 100644 index 00000000..b6bf558e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterPhotos.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterPhotos +description: inputMessagesFilterPhotos attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterPhotos +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterPhotos = ['_' => 'inputMessagesFilterPhotos']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterPhotos"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterPhotos={_='inputMessagesFilterPhotos'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterRoundVideo.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterRoundVideo.md new file mode 100644 index 00000000..5bcbbb20 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterRoundVideo.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterRoundVideo +description: inputMessagesFilterRoundVideo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterRoundVideo +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterRoundVideo = ['_' => 'inputMessagesFilterRoundVideo']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterRoundVideo"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterRoundVideo={_='inputMessagesFilterRoundVideo'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterRoundVoice.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterRoundVoice.md new file mode 100644 index 00000000..9e018fc3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterRoundVoice.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterRoundVoice +description: inputMessagesFilterRoundVoice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterRoundVoice +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterRoundVoice = ['_' => 'inputMessagesFilterRoundVoice']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterRoundVoice"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterRoundVoice={_='inputMessagesFilterRoundVoice'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterUrl.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterUrl.md new file mode 100644 index 00000000..2611616b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterUrl.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterUrl +description: inputMessagesFilterUrl attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterUrl +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterUrl = ['_' => 'inputMessagesFilterUrl']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterUrl"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterUrl={_='inputMessagesFilterUrl'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterVideo.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterVideo.md new file mode 100644 index 00000000..101ec921 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterVideo.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterVideo +description: inputMessagesFilterVideo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterVideo +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterVideo = ['_' => 'inputMessagesFilterVideo']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterVideo"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterVideo={_='inputMessagesFilterVideo'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputMessagesFilterVoice.md b/old_docs/API_docs_v81/constructors/inputMessagesFilterVoice.md new file mode 100644 index 00000000..026a91be --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputMessagesFilterVoice.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterVoice +description: inputMessagesFilterVoice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterVoice +[Back to constructors index](index.md) + + + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +``` +$inputMessagesFilterVoice = ['_' => 'inputMessagesFilterVoice']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputMessagesFilterVoice"} +``` + + +Or, if you're into Lua: + + +``` +inputMessagesFilterVoice={_='inputMessagesFilterVoice'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputNotifyChats.md b/old_docs/API_docs_v81/constructors/inputNotifyChats.md new file mode 100644 index 00000000..63a436fb --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputNotifyChats.md @@ -0,0 +1,38 @@ +--- +title: inputNotifyChats +description: inputNotifyChats attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputNotifyChats +[Back to constructors index](index.md) + + + + + + +### Type: [InputNotifyPeer](../types/InputNotifyPeer.md) + + +### Example: + +``` +$inputNotifyChats = ['_' => 'inputNotifyChats']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputNotifyChats"} +``` + + +Or, if you're into Lua: + + +``` +inputNotifyChats={_='inputNotifyChats'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputNotifyPeer.md b/old_docs/API_docs_v81/constructors/inputNotifyPeer.md new file mode 100644 index 00000000..fe7bb8db --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputNotifyPeer.md @@ -0,0 +1,43 @@ +--- +title: inputNotifyPeer +description: inputNotifyPeer attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputNotifyPeer +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| + + + +### Type: [InputNotifyPeer](../types/InputNotifyPeer.md) + + +### Example: + +``` +$inputNotifyPeer = ['_' => 'inputNotifyPeer', 'peer' => InputPeer]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputNotifyPeer", "peer": InputPeer} +``` + + +Or, if you're into Lua: + + +``` +inputNotifyPeer={_='inputNotifyPeer', peer=InputPeer} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputNotifyUsers.md b/old_docs/API_docs_v81/constructors/inputNotifyUsers.md new file mode 100644 index 00000000..9b361031 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputNotifyUsers.md @@ -0,0 +1,38 @@ +--- +title: inputNotifyUsers +description: inputNotifyUsers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputNotifyUsers +[Back to constructors index](index.md) + + + + + + +### Type: [InputNotifyPeer](../types/InputNotifyPeer.md) + + +### Example: + +``` +$inputNotifyUsers = ['_' => 'inputNotifyUsers']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputNotifyUsers"} +``` + + +Or, if you're into Lua: + + +``` +inputNotifyUsers={_='inputNotifyUsers'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPaymentCredentials.md b/old_docs/API_docs_v81/constructors/inputPaymentCredentials.md new file mode 100644 index 00000000..085db55d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPaymentCredentials.md @@ -0,0 +1,44 @@ +--- +title: inputPaymentCredentials +description: inputPaymentCredentials attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentials +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|save|[Bool](../types/Bool.md) | Optional| +|data|[DataJSON](../types/DataJSON.md) | Yes| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +``` +$inputPaymentCredentials = ['_' => 'inputPaymentCredentials', 'save' => Bool, 'data' => DataJSON]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPaymentCredentials", "save": Bool, "data": DataJSON} +``` + + +Or, if you're into Lua: + + +``` +inputPaymentCredentials={_='inputPaymentCredentials', save=Bool, data=DataJSON} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPaymentCredentialsAndroidPay.md b/old_docs/API_docs_v81/constructors/inputPaymentCredentialsAndroidPay.md new file mode 100644 index 00000000..7ee5312b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPaymentCredentialsAndroidPay.md @@ -0,0 +1,44 @@ +--- +title: inputPaymentCredentialsAndroidPay +description: inputPaymentCredentialsAndroidPay attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentialsAndroidPay +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|payment\_token|[DataJSON](../types/DataJSON.md) | Yes| +|google\_transaction\_id|[string](../types/string.md) | Yes| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +``` +$inputPaymentCredentialsAndroidPay = ['_' => 'inputPaymentCredentialsAndroidPay', 'payment_token' => DataJSON, 'google_transaction_id' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPaymentCredentialsAndroidPay", "payment_token": DataJSON, "google_transaction_id": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputPaymentCredentialsAndroidPay={_='inputPaymentCredentialsAndroidPay', payment_token=DataJSON, google_transaction_id='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPaymentCredentialsApplePay.md b/old_docs/API_docs_v81/constructors/inputPaymentCredentialsApplePay.md new file mode 100644 index 00000000..53f9901a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPaymentCredentialsApplePay.md @@ -0,0 +1,43 @@ +--- +title: inputPaymentCredentialsApplePay +description: inputPaymentCredentialsApplePay attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentialsApplePay +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|payment\_data|[DataJSON](../types/DataJSON.md) | Yes| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +``` +$inputPaymentCredentialsApplePay = ['_' => 'inputPaymentCredentialsApplePay', 'payment_data' => DataJSON]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPaymentCredentialsApplePay", "payment_data": DataJSON} +``` + + +Or, if you're into Lua: + + +``` +inputPaymentCredentialsApplePay={_='inputPaymentCredentialsApplePay', payment_data=DataJSON} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPaymentCredentialsSaved.md b/old_docs/API_docs_v81/constructors/inputPaymentCredentialsSaved.md new file mode 100644 index 00000000..63cd678e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPaymentCredentialsSaved.md @@ -0,0 +1,44 @@ +--- +title: inputPaymentCredentialsSaved +description: inputPaymentCredentialsSaved attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentialsSaved +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[string](../types/string.md) | Yes| +|tmp\_password|[bytes](../types/bytes.md) | Yes| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +``` +$inputPaymentCredentialsSaved = ['_' => 'inputPaymentCredentialsSaved', 'id' => 'string', 'tmp_password' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPaymentCredentialsSaved", "id": "string", "tmp_password": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +inputPaymentCredentialsSaved={_='inputPaymentCredentialsSaved', id='string', tmp_password='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPeerChannel.md b/old_docs/API_docs_v81/constructors/inputPeerChannel.md new file mode 100644 index 00000000..8b84fe20 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPeerChannel.md @@ -0,0 +1,44 @@ +--- +title: inputPeerChannel +description: inputPeerChannel attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerChannel +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +``` +$inputPeerChannel = ['_' => 'inputPeerChannel', 'channel_id' => int, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPeerChannel", "channel_id": int, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputPeerChannel={_='inputPeerChannel', channel_id=int, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPeerChat.md b/old_docs/API_docs_v81/constructors/inputPeerChat.md new file mode 100644 index 00000000..cbe38bcf --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPeerChat.md @@ -0,0 +1,43 @@ +--- +title: inputPeerChat +description: inputPeerChat attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerChat +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +``` +$inputPeerChat = ['_' => 'inputPeerChat', 'chat_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPeerChat", "chat_id": int} +``` + + +Or, if you're into Lua: + + +``` +inputPeerChat={_='inputPeerChat', chat_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPeerEmpty.md b/old_docs/API_docs_v81/constructors/inputPeerEmpty.md new file mode 100644 index 00000000..9116d5a9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPeerEmpty.md @@ -0,0 +1,38 @@ +--- +title: inputPeerEmpty +description: inputPeerEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +``` +$inputPeerEmpty = ['_' => 'inputPeerEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPeerEmpty"} +``` + + +Or, if you're into Lua: + + +``` +inputPeerEmpty={_='inputPeerEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPeerNotifySettings.md b/old_docs/API_docs_v81/constructors/inputPeerNotifySettings.md new file mode 100644 index 00000000..185a7492 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPeerNotifySettings.md @@ -0,0 +1,46 @@ +--- +title: inputPeerNotifySettings +description: inputPeerNotifySettings attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerNotifySettings +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|show\_previews|[Bool](../types/Bool.md) | Optional| +|silent|[Bool](../types/Bool.md) | Optional| +|mute\_until|[int](../types/int.md) | Optional| +|sound|[string](../types/string.md) | Optional| + + + +### Type: [InputPeerNotifySettings](../types/InputPeerNotifySettings.md) + + +### Example: + +``` +$inputPeerNotifySettings = ['_' => 'inputPeerNotifySettings', 'show_previews' => Bool, 'silent' => Bool, 'mute_until' => int, 'sound' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPeerNotifySettings", "show_previews": Bool, "silent": Bool, "mute_until": int, "sound": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputPeerNotifySettings={_='inputPeerNotifySettings', show_previews=Bool, silent=Bool, mute_until=int, sound='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPeerSelf.md b/old_docs/API_docs_v81/constructors/inputPeerSelf.md new file mode 100644 index 00000000..d282f9da --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPeerSelf.md @@ -0,0 +1,38 @@ +--- +title: inputPeerSelf +description: inputPeerSelf attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerSelf +[Back to constructors index](index.md) + + + + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +``` +$inputPeerSelf = ['_' => 'inputPeerSelf']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPeerSelf"} +``` + + +Or, if you're into Lua: + + +``` +inputPeerSelf={_='inputPeerSelf'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPeerUser.md b/old_docs/API_docs_v81/constructors/inputPeerUser.md new file mode 100644 index 00000000..6af9f3b0 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPeerUser.md @@ -0,0 +1,44 @@ +--- +title: inputPeerUser +description: inputPeerUser attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerUser +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +``` +$inputPeerUser = ['_' => 'inputPeerUser', 'user_id' => int, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPeerUser", "user_id": int, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputPeerUser={_='inputPeerUser', user_id=int, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPhoneCall.md b/old_docs/API_docs_v81/constructors/inputPhoneCall.md new file mode 100644 index 00000000..60cdf8ca --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPhoneCall.md @@ -0,0 +1,44 @@ +--- +title: inputPhoneCall +description: inputPhoneCall attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhoneCall +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputPhoneCall](../types/InputPhoneCall.md) + + +### Example: + +``` +$inputPhoneCall = ['_' => 'inputPhoneCall', 'id' => long, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPhoneCall", "id": long, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputPhoneCall={_='inputPhoneCall', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPhoneContact.md b/old_docs/API_docs_v81/constructors/inputPhoneContact.md new file mode 100644 index 00000000..6695d810 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPhoneContact.md @@ -0,0 +1,46 @@ +--- +title: inputPhoneContact +description: inputPhoneContact attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhoneContact +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|client\_id|[long](../types/long.md) | Yes| +|phone|[string](../types/string.md) | Yes| +|first\_name|[string](../types/string.md) | Yes| +|last\_name|[string](../types/string.md) | Yes| + + + +### Type: [InputContact](../types/InputContact.md) + + +### Example: + +``` +$inputPhoneContact = ['_' => 'inputPhoneContact', 'client_id' => long, 'phone' => 'string', 'first_name' => 'string', 'last_name' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPhoneContact", "client_id": long, "phone": "string", "first_name": "string", "last_name": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputPhoneContact={_='inputPhoneContact', client_id=long, phone='string', first_name='string', last_name='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPhoto.md b/old_docs/API_docs_v81/constructors/inputPhoto.md new file mode 100644 index 00000000..552507e3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPhoto.md @@ -0,0 +1,44 @@ +--- +title: inputPhoto +description: inputPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputPhoto](../types/InputPhoto.md) + + +### Example: + +``` +$inputPhoto = ['_' => 'inputPhoto', 'id' => long, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPhoto", "id": long, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputPhoto={_='inputPhoto', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPhotoEmpty.md b/old_docs/API_docs_v81/constructors/inputPhotoEmpty.md new file mode 100644 index 00000000..e8d9c25f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPhotoEmpty.md @@ -0,0 +1,38 @@ +--- +title: inputPhotoEmpty +description: inputPhotoEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhotoEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [InputPhoto](../types/InputPhoto.md) + + +### Example: + +``` +$inputPhotoEmpty = ['_' => 'inputPhotoEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPhotoEmpty"} +``` + + +Or, if you're into Lua: + + +``` +inputPhotoEmpty={_='inputPhotoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPrivacyKeyChatInvite.md b/old_docs/API_docs_v81/constructors/inputPrivacyKeyChatInvite.md new file mode 100644 index 00000000..9c55265f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPrivacyKeyChatInvite.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyKeyChatInvite +description: inputPrivacyKeyChatInvite attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyChatInvite +[Back to constructors index](index.md) + + + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +``` +$inputPrivacyKeyChatInvite = ['_' => 'inputPrivacyKeyChatInvite']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPrivacyKeyChatInvite"} +``` + + +Or, if you're into Lua: + + +``` +inputPrivacyKeyChatInvite={_='inputPrivacyKeyChatInvite'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPrivacyKeyPhoneCall.md b/old_docs/API_docs_v81/constructors/inputPrivacyKeyPhoneCall.md new file mode 100644 index 00000000..b16316be --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPrivacyKeyPhoneCall.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyKeyPhoneCall +description: inputPrivacyKeyPhoneCall attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyPhoneCall +[Back to constructors index](index.md) + + + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +``` +$inputPrivacyKeyPhoneCall = ['_' => 'inputPrivacyKeyPhoneCall']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPrivacyKeyPhoneCall"} +``` + + +Or, if you're into Lua: + + +``` +inputPrivacyKeyPhoneCall={_='inputPrivacyKeyPhoneCall'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPrivacyKeyStatusTimestamp.md b/old_docs/API_docs_v81/constructors/inputPrivacyKeyStatusTimestamp.md new file mode 100644 index 00000000..4730b8b3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPrivacyKeyStatusTimestamp.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyKeyStatusTimestamp +description: inputPrivacyKeyStatusTimestamp attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyStatusTimestamp +[Back to constructors index](index.md) + + + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +``` +$inputPrivacyKeyStatusTimestamp = ['_' => 'inputPrivacyKeyStatusTimestamp']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPrivacyKeyStatusTimestamp"} +``` + + +Or, if you're into Lua: + + +``` +inputPrivacyKeyStatusTimestamp={_='inputPrivacyKeyStatusTimestamp'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPrivacyValueAllowAll.md b/old_docs/API_docs_v81/constructors/inputPrivacyValueAllowAll.md new file mode 100644 index 00000000..d15740c7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPrivacyValueAllowAll.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyValueAllowAll +description: inputPrivacyValueAllowAll attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueAllowAll +[Back to constructors index](index.md) + + + + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +``` +$inputPrivacyValueAllowAll = ['_' => 'inputPrivacyValueAllowAll']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPrivacyValueAllowAll"} +``` + + +Or, if you're into Lua: + + +``` +inputPrivacyValueAllowAll={_='inputPrivacyValueAllowAll'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPrivacyValueAllowContacts.md b/old_docs/API_docs_v81/constructors/inputPrivacyValueAllowContacts.md new file mode 100644 index 00000000..fdc7eeff --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPrivacyValueAllowContacts.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyValueAllowContacts +description: inputPrivacyValueAllowContacts attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueAllowContacts +[Back to constructors index](index.md) + + + + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +``` +$inputPrivacyValueAllowContacts = ['_' => 'inputPrivacyValueAllowContacts']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPrivacyValueAllowContacts"} +``` + + +Or, if you're into Lua: + + +``` +inputPrivacyValueAllowContacts={_='inputPrivacyValueAllowContacts'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPrivacyValueAllowUsers.md b/old_docs/API_docs_v81/constructors/inputPrivacyValueAllowUsers.md new file mode 100644 index 00000000..60db0455 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPrivacyValueAllowUsers.md @@ -0,0 +1,43 @@ +--- +title: inputPrivacyValueAllowUsers +description: inputPrivacyValueAllowUsers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueAllowUsers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +``` +$inputPrivacyValueAllowUsers = ['_' => 'inputPrivacyValueAllowUsers', 'users' => [InputUser, InputUser]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPrivacyValueAllowUsers", "users": [InputUser]} +``` + + +Or, if you're into Lua: + + +``` +inputPrivacyValueAllowUsers={_='inputPrivacyValueAllowUsers', users={InputUser}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPrivacyValueDisallowAll.md b/old_docs/API_docs_v81/constructors/inputPrivacyValueDisallowAll.md new file mode 100644 index 00000000..f3dc8538 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPrivacyValueDisallowAll.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyValueDisallowAll +description: inputPrivacyValueDisallowAll attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueDisallowAll +[Back to constructors index](index.md) + + + + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +``` +$inputPrivacyValueDisallowAll = ['_' => 'inputPrivacyValueDisallowAll']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPrivacyValueDisallowAll"} +``` + + +Or, if you're into Lua: + + +``` +inputPrivacyValueDisallowAll={_='inputPrivacyValueDisallowAll'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPrivacyValueDisallowContacts.md b/old_docs/API_docs_v81/constructors/inputPrivacyValueDisallowContacts.md new file mode 100644 index 00000000..c0c61980 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPrivacyValueDisallowContacts.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyValueDisallowContacts +description: inputPrivacyValueDisallowContacts attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueDisallowContacts +[Back to constructors index](index.md) + + + + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +``` +$inputPrivacyValueDisallowContacts = ['_' => 'inputPrivacyValueDisallowContacts']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPrivacyValueDisallowContacts"} +``` + + +Or, if you're into Lua: + + +``` +inputPrivacyValueDisallowContacts={_='inputPrivacyValueDisallowContacts'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputPrivacyValueDisallowUsers.md b/old_docs/API_docs_v81/constructors/inputPrivacyValueDisallowUsers.md new file mode 100644 index 00000000..1598db64 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputPrivacyValueDisallowUsers.md @@ -0,0 +1,43 @@ +--- +title: inputPrivacyValueDisallowUsers +description: inputPrivacyValueDisallowUsers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueDisallowUsers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +``` +$inputPrivacyValueDisallowUsers = ['_' => 'inputPrivacyValueDisallowUsers', 'users' => [InputUser, InputUser]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputPrivacyValueDisallowUsers", "users": [InputUser]} +``` + + +Or, if you're into Lua: + + +``` +inputPrivacyValueDisallowUsers={_='inputPrivacyValueDisallowUsers', users={InputUser}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputReportReasonOther.md b/old_docs/API_docs_v81/constructors/inputReportReasonOther.md new file mode 100644 index 00000000..361582bd --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputReportReasonOther.md @@ -0,0 +1,43 @@ +--- +title: inputReportReasonOther +description: inputReportReasonOther attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonOther +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[string](../types/string.md) | Yes| + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +``` +$inputReportReasonOther = ['_' => 'inputReportReasonOther', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputReportReasonOther", "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputReportReasonOther={_='inputReportReasonOther', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputReportReasonPornography.md b/old_docs/API_docs_v81/constructors/inputReportReasonPornography.md new file mode 100644 index 00000000..c18c71d3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputReportReasonPornography.md @@ -0,0 +1,38 @@ +--- +title: inputReportReasonPornography +description: inputReportReasonPornography attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonPornography +[Back to constructors index](index.md) + + + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +``` +$inputReportReasonPornography = ['_' => 'inputReportReasonPornography']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputReportReasonPornography"} +``` + + +Or, if you're into Lua: + + +``` +inputReportReasonPornography={_='inputReportReasonPornography'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputReportReasonSpam.md b/old_docs/API_docs_v81/constructors/inputReportReasonSpam.md new file mode 100644 index 00000000..19ed6687 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputReportReasonSpam.md @@ -0,0 +1,38 @@ +--- +title: inputReportReasonSpam +description: inputReportReasonSpam attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonSpam +[Back to constructors index](index.md) + + + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +``` +$inputReportReasonSpam = ['_' => 'inputReportReasonSpam']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputReportReasonSpam"} +``` + + +Or, if you're into Lua: + + +``` +inputReportReasonSpam={_='inputReportReasonSpam'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputReportReasonViolence.md b/old_docs/API_docs_v81/constructors/inputReportReasonViolence.md new file mode 100644 index 00000000..10fbce47 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputReportReasonViolence.md @@ -0,0 +1,38 @@ +--- +title: inputReportReasonViolence +description: inputReportReasonViolence attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonViolence +[Back to constructors index](index.md) + + + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +``` +$inputReportReasonViolence = ['_' => 'inputReportReasonViolence']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputReportReasonViolence"} +``` + + +Or, if you're into Lua: + + +``` +inputReportReasonViolence={_='inputReportReasonViolence'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputSecureFile.md b/old_docs/API_docs_v81/constructors/inputSecureFile.md new file mode 100644 index 00000000..df67e848 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputSecureFile.md @@ -0,0 +1,44 @@ +--- +title: inputSecureFile +description: inputSecureFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureFile +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputSecureFile](../types/InputSecureFile.md) + + +### Example: + +``` +$inputSecureFile = ['_' => 'inputSecureFile', 'id' => long, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputSecureFile", "id": long, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputSecureFile={_='inputSecureFile', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputSecureFileLocation.md b/old_docs/API_docs_v81/constructors/inputSecureFileLocation.md new file mode 100644 index 00000000..223e4561 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputSecureFileLocation.md @@ -0,0 +1,44 @@ +--- +title: inputSecureFileLocation +description: inputSecureFileLocation attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureFileLocation +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +``` +$inputSecureFileLocation = ['_' => 'inputSecureFileLocation', 'id' => long, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputSecureFileLocation", "id": long, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputSecureFileLocation={_='inputSecureFileLocation', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputSecureFileUploaded.md b/old_docs/API_docs_v81/constructors/inputSecureFileUploaded.md new file mode 100644 index 00000000..89c45cb5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputSecureFileUploaded.md @@ -0,0 +1,47 @@ +--- +title: inputSecureFileUploaded +description: inputSecureFileUploaded attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureFileUploaded +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|parts|[int](../types/int.md) | Yes| +|md5\_checksum|[string](../types/string.md) | Yes| +|file\_hash|[bytes](../types/bytes.md) | Yes| +|secret|[bytes](../types/bytes.md) | Yes| + + + +### Type: [InputSecureFile](../types/InputSecureFile.md) + + +### Example: + +``` +$inputSecureFileUploaded = ['_' => 'inputSecureFileUploaded', 'id' => long, 'parts' => int, 'md5_checksum' => 'string', 'file_hash' => 'bytes', 'secret' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputSecureFileUploaded", "id": long, "parts": int, "md5_checksum": "string", "file_hash": {"_": "bytes", "bytes":"base64 encoded bytes"}, "secret": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +inputSecureFileUploaded={_='inputSecureFileUploaded', id=long, parts=int, md5_checksum='string', file_hash='bytes', secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputSecureValue.md b/old_docs/API_docs_v81/constructors/inputSecureValue.md new file mode 100644 index 00000000..e2859667 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputSecureValue.md @@ -0,0 +1,49 @@ +--- +title: inputSecureValue +description: inputSecureValue attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureValue +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes| +|data|[SecureData](../types/SecureData.md) | Optional| +|front\_side|[InputSecureFile](../types/InputSecureFile.md) | Optional| +|reverse\_side|[InputSecureFile](../types/InputSecureFile.md) | Optional| +|selfie|[InputSecureFile](../types/InputSecureFile.md) | Optional| +|files|Array of [InputSecureFile](../types/InputSecureFile.md) | Optional| +|plain\_data|[SecurePlainData](../types/SecurePlainData.md) | Optional| + + + +### Type: [InputSecureValue](../types/InputSecureValue.md) + + +### Example: + +``` +$inputSecureValue = ['_' => 'inputSecureValue', 'type' => SecureValueType, 'data' => SecureData, 'front_side' => InputSecureFile, 'reverse_side' => InputSecureFile, 'selfie' => InputSecureFile, 'files' => [InputSecureFile, InputSecureFile], 'plain_data' => SecurePlainData]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputSecureValue", "type": SecureValueType, "data": SecureData, "front_side": InputSecureFile, "reverse_side": InputSecureFile, "selfie": InputSecureFile, "files": [InputSecureFile], "plain_data": SecurePlainData} +``` + + +Or, if you're into Lua: + + +``` +inputSecureValue={_='inputSecureValue', type=SecureValueType, data=SecureData, front_side=InputSecureFile, reverse_side=InputSecureFile, selfie=InputSecureFile, files={InputSecureFile}, plain_data=SecurePlainData} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputSingleMedia.md b/old_docs/API_docs_v81/constructors/inputSingleMedia.md new file mode 100644 index 00000000..fb03aa0c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputSingleMedia.md @@ -0,0 +1,45 @@ +--- +title: inputSingleMedia +description: inputSingleMedia attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSingleMedia +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|media|[MessageMedia, Message, Update or InputMedia](../types/InputMedia.md) | Optional| +|message|[string](../types/string.md) | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional| + + + +### Type: [InputSingleMedia](../types/InputSingleMedia.md) + + +### Example: + +``` +$inputSingleMedia = ['_' => 'inputSingleMedia', 'media' => InputMedia, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputSingleMedia", "media": InputMedia, "message": "string", "entities": [MessageEntity]} +``` + + +Or, if you're into Lua: + + +``` +inputSingleMedia={_='inputSingleMedia', media=InputMedia, message='string', entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputStickerSetEmpty.md b/old_docs/API_docs_v81/constructors/inputStickerSetEmpty.md new file mode 100644 index 00000000..f213667c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputStickerSetEmpty.md @@ -0,0 +1,38 @@ +--- +title: inputStickerSetEmpty +description: inputStickerSetEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [InputStickerSet](../types/InputStickerSet.md) + + +### Example: + +``` +$inputStickerSetEmpty = ['_' => 'inputStickerSetEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputStickerSetEmpty"} +``` + + +Or, if you're into Lua: + + +``` +inputStickerSetEmpty={_='inputStickerSetEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputStickerSetID.md b/old_docs/API_docs_v81/constructors/inputStickerSetID.md new file mode 100644 index 00000000..36eebe3a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputStickerSetID.md @@ -0,0 +1,44 @@ +--- +title: inputStickerSetID +description: inputStickerSetID attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetID +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputStickerSet](../types/InputStickerSet.md) + + +### Example: + +``` +$inputStickerSetID = ['_' => 'inputStickerSetID', 'id' => long, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputStickerSetID", "id": long, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputStickerSetID={_='inputStickerSetID', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputStickerSetItem.md b/old_docs/API_docs_v81/constructors/inputStickerSetItem.md new file mode 100644 index 00000000..2efe95ff --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputStickerSetItem.md @@ -0,0 +1,45 @@ +--- +title: inputStickerSetItem +description: inputStickerSetItem attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetItem +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|document|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional| +|emoji|[string](../types/string.md) | Yes| +|mask\_coords|[MaskCoords](../types/MaskCoords.md) | Optional| + + + +### Type: [InputStickerSetItem](../types/InputStickerSetItem.md) + + +### Example: + +``` +$inputStickerSetItem = ['_' => 'inputStickerSetItem', 'document' => InputDocument, 'emoji' => 'string', 'mask_coords' => MaskCoords]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputStickerSetItem", "document": InputDocument, "emoji": "string", "mask_coords": MaskCoords} +``` + + +Or, if you're into Lua: + + +``` +inputStickerSetItem={_='inputStickerSetItem', document=InputDocument, emoji='string', mask_coords=MaskCoords} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputStickerSetShortName.md b/old_docs/API_docs_v81/constructors/inputStickerSetShortName.md new file mode 100644 index 00000000..518fdc3f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputStickerSetShortName.md @@ -0,0 +1,43 @@ +--- +title: inputStickerSetShortName +description: inputStickerSetShortName attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetShortName +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|short\_name|[string](../types/string.md) | Yes| + + + +### Type: [InputStickerSet](../types/InputStickerSet.md) + + +### Example: + +``` +$inputStickerSetShortName = ['_' => 'inputStickerSetShortName', 'short_name' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputStickerSetShortName", "short_name": "string"} +``` + + +Or, if you're into Lua: + + +``` +inputStickerSetShortName={_='inputStickerSetShortName', short_name='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputStickeredMediaDocument.md b/old_docs/API_docs_v81/constructors/inputStickeredMediaDocument.md new file mode 100644 index 00000000..c6def51c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputStickeredMediaDocument.md @@ -0,0 +1,43 @@ +--- +title: inputStickeredMediaDocument +description: inputStickeredMediaDocument attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickeredMediaDocument +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional| + + + +### Type: [InputStickeredMedia](../types/InputStickeredMedia.md) + + +### Example: + +``` +$inputStickeredMediaDocument = ['_' => 'inputStickeredMediaDocument', 'id' => InputDocument]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputStickeredMediaDocument", "id": InputDocument} +``` + + +Or, if you're into Lua: + + +``` +inputStickeredMediaDocument={_='inputStickeredMediaDocument', id=InputDocument} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputStickeredMediaPhoto.md b/old_docs/API_docs_v81/constructors/inputStickeredMediaPhoto.md new file mode 100644 index 00000000..f424c329 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputStickeredMediaPhoto.md @@ -0,0 +1,43 @@ +--- +title: inputStickeredMediaPhoto +description: inputStickeredMediaPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickeredMediaPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional| + + + +### Type: [InputStickeredMedia](../types/InputStickeredMedia.md) + + +### Example: + +``` +$inputStickeredMediaPhoto = ['_' => 'inputStickeredMediaPhoto', 'id' => InputPhoto]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputStickeredMediaPhoto", "id": InputPhoto} +``` + + +Or, if you're into Lua: + + +``` +inputStickeredMediaPhoto={_='inputStickeredMediaPhoto', id=InputPhoto} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputTakeoutFileLocation.md b/old_docs/API_docs_v81/constructors/inputTakeoutFileLocation.md new file mode 100644 index 00000000..6eee9802 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputTakeoutFileLocation.md @@ -0,0 +1,38 @@ +--- +title: inputTakeoutFileLocation +description: inputTakeoutFileLocation attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputTakeoutFileLocation +[Back to constructors index](index.md) + + + + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +``` +$inputTakeoutFileLocation = ['_' => 'inputTakeoutFileLocation']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputTakeoutFileLocation"} +``` + + +Or, if you're into Lua: + + +``` +inputTakeoutFileLocation={_='inputTakeoutFileLocation'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputUser.md b/old_docs/API_docs_v81/constructors/inputUser.md new file mode 100644 index 00000000..c3020146 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputUser.md @@ -0,0 +1,44 @@ +--- +title: inputUser +description: inputUser attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputUser +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputUser](../types/InputUser.md) + + +### Example: + +``` +$inputUser = ['_' => 'inputUser', 'user_id' => int, 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputUser", "user_id": int, "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputUser={_='inputUser', user_id=int, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputUserEmpty.md b/old_docs/API_docs_v81/constructors/inputUserEmpty.md new file mode 100644 index 00000000..a1b84389 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputUserEmpty.md @@ -0,0 +1,38 @@ +--- +title: inputUserEmpty +description: inputUserEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputUserEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [InputUser](../types/InputUser.md) + + +### Example: + +``` +$inputUserEmpty = ['_' => 'inputUserEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputUserEmpty"} +``` + + +Or, if you're into Lua: + + +``` +inputUserEmpty={_='inputUserEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputUserSelf.md b/old_docs/API_docs_v81/constructors/inputUserSelf.md new file mode 100644 index 00000000..69b91c89 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputUserSelf.md @@ -0,0 +1,38 @@ +--- +title: inputUserSelf +description: inputUserSelf attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputUserSelf +[Back to constructors index](index.md) + + + + + + +### Type: [InputUser](../types/InputUser.md) + + +### Example: + +``` +$inputUserSelf = ['_' => 'inputUserSelf']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputUserSelf"} +``` + + +Or, if you're into Lua: + + +``` +inputUserSelf={_='inputUserSelf'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputWebDocument.md b/old_docs/API_docs_v81/constructors/inputWebDocument.md new file mode 100644 index 00000000..8028cb28 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputWebDocument.md @@ -0,0 +1,46 @@ +--- +title: inputWebDocument +description: inputWebDocument attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWebDocument +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|size|[int](../types/int.md) | Yes| +|mime\_type|[string](../types/string.md) | Yes| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes| + + + +### Type: [InputWebDocument](../types/InputWebDocument.md) + + +### Example: + +``` +$inputWebDocument = ['_' => 'inputWebDocument', 'url' => 'string', 'size' => int, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputWebDocument", "url": "string", "size": int, "mime_type": "string", "attributes": [DocumentAttribute]} +``` + + +Or, if you're into Lua: + + +``` +inputWebDocument={_='inputWebDocument', url='string', size=int, mime_type='string', attributes={DocumentAttribute}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/inputWebFileLocation.md b/old_docs/API_docs_v81/constructors/inputWebFileLocation.md new file mode 100644 index 00000000..c484849b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/inputWebFileLocation.md @@ -0,0 +1,44 @@ +--- +title: inputWebFileLocation +description: inputWebFileLocation attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWebFileLocation +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| + + + +### Type: [InputWebFileLocation](../types/InputWebFileLocation.md) + + +### Example: + +``` +$inputWebFileLocation = ['_' => 'inputWebFileLocation', 'url' => 'string', 'access_hash' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "inputWebFileLocation", "url": "string", "access_hash": long} +``` + + +Or, if you're into Lua: + + +``` +inputWebFileLocation={_='inputWebFileLocation', url='string', access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/invoice.md b/old_docs/API_docs_v81/constructors/invoice.md new file mode 100644 index 00000000..5caa32f5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/invoice.md @@ -0,0 +1,52 @@ +--- +title: invoice +description: invoice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: invoice +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|test|[Bool](../types/Bool.md) | Optional| +|name\_requested|[Bool](../types/Bool.md) | Optional| +|phone\_requested|[Bool](../types/Bool.md) | Optional| +|email\_requested|[Bool](../types/Bool.md) | Optional| +|shipping\_address\_requested|[Bool](../types/Bool.md) | Optional| +|flexible|[Bool](../types/Bool.md) | Optional| +|phone\_to\_provider|[Bool](../types/Bool.md) | Optional| +|email\_to\_provider|[Bool](../types/Bool.md) | Optional| +|currency|[string](../types/string.md) | Yes| +|prices|Array of [LabeledPrice](../types/LabeledPrice.md) | Yes| + + + +### Type: [Invoice](../types/Invoice.md) + + +### Example: + +``` +$invoice = ['_' => 'invoice', 'test' => Bool, 'name_requested' => Bool, 'phone_requested' => Bool, 'email_requested' => Bool, 'shipping_address_requested' => Bool, 'flexible' => Bool, 'phone_to_provider' => Bool, 'email_to_provider' => Bool, 'currency' => 'string', 'prices' => [LabeledPrice, LabeledPrice]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "invoice", "test": Bool, "name_requested": Bool, "phone_requested": Bool, "email_requested": Bool, "shipping_address_requested": Bool, "flexible": Bool, "phone_to_provider": Bool, "email_to_provider": Bool, "currency": "string", "prices": [LabeledPrice]} +``` + + +Or, if you're into Lua: + + +``` +invoice={_='invoice', test=Bool, name_requested=Bool, phone_requested=Bool, email_requested=Bool, shipping_address_requested=Bool, flexible=Bool, phone_to_provider=Bool, email_to_provider=Bool, currency='string', prices={LabeledPrice}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/ipPort.md b/old_docs/API_docs_v81/constructors/ipPort.md new file mode 100644 index 00000000..a22e57e7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/ipPort.md @@ -0,0 +1,44 @@ +--- +title: ipPort +description: ipPort attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: ipPort +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|ipv4|[int](../types/int.md) | Yes| +|port|[int](../types/int.md) | Yes| + + + +### Type: [IpPort](../types/IpPort.md) + + +### Example: + +``` +$ipPort = ['_' => 'ipPort', 'ipv4' => int, 'port' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "ipPort", "ipv4": int, "port": int} +``` + + +Or, if you're into Lua: + + +``` +ipPort={_='ipPort', ipv4=int, port=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/ipPortSecret.md b/old_docs/API_docs_v81/constructors/ipPortSecret.md new file mode 100644 index 00000000..e18341d5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/ipPortSecret.md @@ -0,0 +1,45 @@ +--- +title: ipPortSecret +description: ipPortSecret attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: ipPortSecret +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|ipv4|[int](../types/int.md) | Yes| +|port|[int](../types/int.md) | Yes| +|secret|[bytes](../types/bytes.md) | Yes| + + + +### Type: [IpPort](../types/IpPort.md) + + +### Example: + +``` +$ipPortSecret = ['_' => 'ipPortSecret', 'ipv4' => int, 'port' => int, 'secret' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "ipPortSecret", "ipv4": int, "port": int, "secret": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +ipPortSecret={_='ipPortSecret', ipv4=int, port=int, secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/keyboardButton.md b/old_docs/API_docs_v81/constructors/keyboardButton.md new file mode 100644 index 00000000..c4e88041 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/keyboardButton.md @@ -0,0 +1,43 @@ +--- +title: keyboardButton +description: keyboardButton attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButton +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[string](../types/string.md) | Yes| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +``` +$keyboardButton = ['_' => 'keyboardButton', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "keyboardButton", "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +keyboardButton={_='keyboardButton', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/keyboardButtonBuy.md b/old_docs/API_docs_v81/constructors/keyboardButtonBuy.md new file mode 100644 index 00000000..efff4c6c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/keyboardButtonBuy.md @@ -0,0 +1,43 @@ +--- +title: keyboardButtonBuy +description: keyboardButtonBuy attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonBuy +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[string](../types/string.md) | Yes| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +``` +$keyboardButtonBuy = ['_' => 'keyboardButtonBuy', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "keyboardButtonBuy", "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +keyboardButtonBuy={_='keyboardButtonBuy', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/keyboardButtonCallback.md b/old_docs/API_docs_v81/constructors/keyboardButtonCallback.md new file mode 100644 index 00000000..63e87aac --- /dev/null +++ b/old_docs/API_docs_v81/constructors/keyboardButtonCallback.md @@ -0,0 +1,44 @@ +--- +title: keyboardButtonCallback +description: keyboardButtonCallback attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonCallback +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[string](../types/string.md) | Yes| +|data|[bytes](../types/bytes.md) | Yes| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +``` +$keyboardButtonCallback = ['_' => 'keyboardButtonCallback', 'text' => 'string', 'data' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "keyboardButtonCallback", "text": "string", "data": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +keyboardButtonCallback={_='keyboardButtonCallback', text='string', data='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/keyboardButtonGame.md b/old_docs/API_docs_v81/constructors/keyboardButtonGame.md new file mode 100644 index 00000000..08110141 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/keyboardButtonGame.md @@ -0,0 +1,43 @@ +--- +title: keyboardButtonGame +description: keyboardButtonGame attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonGame +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[string](../types/string.md) | Yes| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +``` +$keyboardButtonGame = ['_' => 'keyboardButtonGame', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "keyboardButtonGame", "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +keyboardButtonGame={_='keyboardButtonGame', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/keyboardButtonRequestGeoLocation.md b/old_docs/API_docs_v81/constructors/keyboardButtonRequestGeoLocation.md new file mode 100644 index 00000000..fc422d90 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/keyboardButtonRequestGeoLocation.md @@ -0,0 +1,43 @@ +--- +title: keyboardButtonRequestGeoLocation +description: keyboardButtonRequestGeoLocation attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonRequestGeoLocation +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[string](../types/string.md) | Yes| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +``` +$keyboardButtonRequestGeoLocation = ['_' => 'keyboardButtonRequestGeoLocation', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "keyboardButtonRequestGeoLocation", "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +keyboardButtonRequestGeoLocation={_='keyboardButtonRequestGeoLocation', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/keyboardButtonRequestPhone.md b/old_docs/API_docs_v81/constructors/keyboardButtonRequestPhone.md new file mode 100644 index 00000000..a1719e24 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/keyboardButtonRequestPhone.md @@ -0,0 +1,43 @@ +--- +title: keyboardButtonRequestPhone +description: keyboardButtonRequestPhone attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonRequestPhone +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[string](../types/string.md) | Yes| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +``` +$keyboardButtonRequestPhone = ['_' => 'keyboardButtonRequestPhone', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "keyboardButtonRequestPhone", "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +keyboardButtonRequestPhone={_='keyboardButtonRequestPhone', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/keyboardButtonRow.md b/old_docs/API_docs_v81/constructors/keyboardButtonRow.md new file mode 100644 index 00000000..d82f74c5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/keyboardButtonRow.md @@ -0,0 +1,43 @@ +--- +title: keyboardButtonRow +description: keyboardButtonRow attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonRow +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|buttons|Array of [KeyboardButton](../types/KeyboardButton.md) | Yes| + + + +### Type: [KeyboardButtonRow](../types/KeyboardButtonRow.md) + + +### Example: + +``` +$keyboardButtonRow = ['_' => 'keyboardButtonRow', 'buttons' => [KeyboardButton, KeyboardButton]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "keyboardButtonRow", "buttons": [KeyboardButton]} +``` + + +Or, if you're into Lua: + + +``` +keyboardButtonRow={_='keyboardButtonRow', buttons={KeyboardButton}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/keyboardButtonSwitchInline.md b/old_docs/API_docs_v81/constructors/keyboardButtonSwitchInline.md new file mode 100644 index 00000000..463c473c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/keyboardButtonSwitchInline.md @@ -0,0 +1,45 @@ +--- +title: keyboardButtonSwitchInline +description: keyboardButtonSwitchInline attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonSwitchInline +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|same\_peer|[Bool](../types/Bool.md) | Optional| +|text|[string](../types/string.md) | Yes| +|query|[string](../types/string.md) | Yes| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +``` +$keyboardButtonSwitchInline = ['_' => 'keyboardButtonSwitchInline', 'same_peer' => Bool, 'text' => 'string', 'query' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "keyboardButtonSwitchInline", "same_peer": Bool, "text": "string", "query": "string"} +``` + + +Or, if you're into Lua: + + +``` +keyboardButtonSwitchInline={_='keyboardButtonSwitchInline', same_peer=Bool, text='string', query='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/keyboardButtonUrl.md b/old_docs/API_docs_v81/constructors/keyboardButtonUrl.md new file mode 100644 index 00000000..709d4fa9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/keyboardButtonUrl.md @@ -0,0 +1,44 @@ +--- +title: keyboardButtonUrl +description: keyboardButtonUrl attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonUrl +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[string](../types/string.md) | Yes| +|url|[string](../types/string.md) | Yes| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +``` +$keyboardButtonUrl = ['_' => 'keyboardButtonUrl', 'text' => 'string', 'url' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "keyboardButtonUrl", "text": "string", "url": "string"} +``` + + +Or, if you're into Lua: + + +``` +keyboardButtonUrl={_='keyboardButtonUrl', text='string', url='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/labeledPrice.md b/old_docs/API_docs_v81/constructors/labeledPrice.md new file mode 100644 index 00000000..22e91c77 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/labeledPrice.md @@ -0,0 +1,44 @@ +--- +title: labeledPrice +description: labeledPrice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: labeledPrice +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|label|[string](../types/string.md) | Yes| +|amount|[long](../types/long.md) | Yes| + + + +### Type: [LabeledPrice](../types/LabeledPrice.md) + + +### Example: + +``` +$labeledPrice = ['_' => 'labeledPrice', 'label' => 'string', 'amount' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "labeledPrice", "label": "string", "amount": long} +``` + + +Or, if you're into Lua: + + +``` +labeledPrice={_='labeledPrice', label='string', amount=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/langPackDifference.md b/old_docs/API_docs_v81/constructors/langPackDifference.md new file mode 100644 index 00000000..59f57e24 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/langPackDifference.md @@ -0,0 +1,46 @@ +--- +title: langPackDifference +description: langPackDifference attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackDifference +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|lang\_code|[string](../types/string.md) | Yes| +|from\_version|[int](../types/int.md) | Yes| +|version|[int](../types/int.md) | Yes| +|strings|Array of [LangPackString](../types/LangPackString.md) | Yes| + + + +### Type: [LangPackDifference](../types/LangPackDifference.md) + + +### Example: + +``` +$langPackDifference = ['_' => 'langPackDifference', 'lang_code' => 'string', 'from_version' => int, 'version' => int, 'strings' => [LangPackString, LangPackString]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "langPackDifference", "lang_code": "string", "from_version": int, "version": int, "strings": [LangPackString]} +``` + + +Or, if you're into Lua: + + +``` +langPackDifference={_='langPackDifference', lang_code='string', from_version=int, version=int, strings={LangPackString}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/langPackLanguage.md b/old_docs/API_docs_v81/constructors/langPackLanguage.md new file mode 100644 index 00000000..a72465ca --- /dev/null +++ b/old_docs/API_docs_v81/constructors/langPackLanguage.md @@ -0,0 +1,45 @@ +--- +title: langPackLanguage +description: langPackLanguage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackLanguage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|name|[string](../types/string.md) | Yes| +|native\_name|[string](../types/string.md) | Yes| +|lang\_code|[string](../types/string.md) | Yes| + + + +### Type: [LangPackLanguage](../types/LangPackLanguage.md) + + +### Example: + +``` +$langPackLanguage = ['_' => 'langPackLanguage', 'name' => 'string', 'native_name' => 'string', 'lang_code' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "langPackLanguage", "name": "string", "native_name": "string", "lang_code": "string"} +``` + + +Or, if you're into Lua: + + +``` +langPackLanguage={_='langPackLanguage', name='string', native_name='string', lang_code='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/langPackString.md b/old_docs/API_docs_v81/constructors/langPackString.md new file mode 100644 index 00000000..4034f228 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/langPackString.md @@ -0,0 +1,44 @@ +--- +title: langPackString +description: langPackString attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackString +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|key|[string](../types/string.md) | Yes| +|value|[string](../types/string.md) | Yes| + + + +### Type: [LangPackString](../types/LangPackString.md) + + +### Example: + +``` +$langPackString = ['_' => 'langPackString', 'key' => 'string', 'value' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "langPackString", "key": "string", "value": "string"} +``` + + +Or, if you're into Lua: + + +``` +langPackString={_='langPackString', key='string', value='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/langPackStringDeleted.md b/old_docs/API_docs_v81/constructors/langPackStringDeleted.md new file mode 100644 index 00000000..3da641bb --- /dev/null +++ b/old_docs/API_docs_v81/constructors/langPackStringDeleted.md @@ -0,0 +1,43 @@ +--- +title: langPackStringDeleted +description: langPackStringDeleted attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackStringDeleted +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|key|[string](../types/string.md) | Yes| + + + +### Type: [LangPackString](../types/LangPackString.md) + + +### Example: + +``` +$langPackStringDeleted = ['_' => 'langPackStringDeleted', 'key' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "langPackStringDeleted", "key": "string"} +``` + + +Or, if you're into Lua: + + +``` +langPackStringDeleted={_='langPackStringDeleted', key='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/langPackStringPluralized.md b/old_docs/API_docs_v81/constructors/langPackStringPluralized.md new file mode 100644 index 00000000..92b0b356 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/langPackStringPluralized.md @@ -0,0 +1,49 @@ +--- +title: langPackStringPluralized +description: langPackStringPluralized attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackStringPluralized +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|key|[string](../types/string.md) | Yes| +|zero\_value|[string](../types/string.md) | Optional| +|one\_value|[string](../types/string.md) | Optional| +|two\_value|[string](../types/string.md) | Optional| +|few\_value|[string](../types/string.md) | Optional| +|many\_value|[string](../types/string.md) | Optional| +|other\_value|[string](../types/string.md) | Yes| + + + +### Type: [LangPackString](../types/LangPackString.md) + + +### Example: + +``` +$langPackStringPluralized = ['_' => 'langPackStringPluralized', 'key' => 'string', 'zero_value' => 'string', 'one_value' => 'string', 'two_value' => 'string', 'few_value' => 'string', 'many_value' => 'string', 'other_value' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "langPackStringPluralized", "key": "string", "zero_value": "string", "one_value": "string", "two_value": "string", "few_value": "string", "many_value": "string", "other_value": "string"} +``` + + +Or, if you're into Lua: + + +``` +langPackStringPluralized={_='langPackStringPluralized', key='string', zero_value='string', one_value='string', two_value='string', few_value='string', many_value='string', other_value='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/maskCoords.md b/old_docs/API_docs_v81/constructors/maskCoords.md new file mode 100644 index 00000000..21b9ad78 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/maskCoords.md @@ -0,0 +1,46 @@ +--- +title: maskCoords +description: maskCoords attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: maskCoords +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|n|[int](../types/int.md) | Yes| +|x|[double](../types/double.md) | Yes| +|y|[double](../types/double.md) | Yes| +|zoom|[double](../types/double.md) | Yes| + + + +### Type: [MaskCoords](../types/MaskCoords.md) + + +### Example: + +``` +$maskCoords = ['_' => 'maskCoords', 'n' => int, 'x' => double, 'y' => double, 'zoom' => double]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "maskCoords", "n": int, "x": double, "y": double, "zoom": double} +``` + + +Or, if you're into Lua: + + +``` +maskCoords={_='maskCoords', n=int, x=double, y=double, zoom=double} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/message.md b/old_docs/API_docs_v81/constructors/message.md new file mode 100644 index 00000000..98ea00b3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/message.md @@ -0,0 +1,68 @@ +--- +title: message +description: message attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: message +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|out|[Bool](../types/Bool.md) | Optional| +|mentioned|[Bool](../types/Bool.md) | Optional| +|media\_unread|[Bool](../types/Bool.md) | Optional| +|silent|[Bool](../types/Bool.md) | Optional| +|post|[Bool](../types/Bool.md) | Optional| +|id|[int](../types/int.md) | Yes| +|from\_id|[int](../types/int.md) | Optional| +|to\_id|[Peer](../types/Peer.md) | Yes| +|fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional| +|via\_bot\_id|[int](../types/int.md) | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional| +|date|[int](../types/int.md) | Yes| +|message|[string](../types/string.md) | Yes| +|media|[MessageMedia](../types/MessageMedia.md) | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional| +|views|[int](../types/int.md) | Optional| +|edit\_date|[int](../types/int.md) | Optional| +|post\_author|[string](../types/string.md) | Optional| +|grouped\_id|[long](../types/long.md) | Optional| + + + +### Type: [Message](../types/Message.md) + + +### Example: + +``` +$message = ['_' => 'message', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'post' => Bool, 'id' => int, 'from_id' => int, 'to_id' => Peer, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to_msg_id' => int, 'date' => int, 'message' => 'string', 'media' => MessageMedia, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'views' => int, 'edit_date' => int, 'post_author' => 'string', 'grouped_id' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "message", "out": Bool, "mentioned": Bool, "media_unread": Bool, "silent": Bool, "post": Bool, "id": int, "from_id": int, "to_id": Peer, "fwd_from": MessageFwdHeader, "via_bot_id": int, "reply_to_msg_id": int, "date": int, "message": "string", "media": MessageMedia, "reply_markup": ReplyMarkup, "entities": [MessageEntity], "views": int, "edit_date": int, "post_author": "string", "grouped_id": long} +``` + + +Or, if you're into Lua: + + +``` +message={_='message', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, post=Bool, id=int, from_id=int, to_id=Peer, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to_msg_id=int, date=int, message='string', media=MessageMedia, reply_markup=ReplyMarkup, entities={MessageEntity}, views=int, edit_date=int, post_author='string', grouped_id=long} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v81/constructors/messageActionBotAllowed.md b/old_docs/API_docs_v81/constructors/messageActionBotAllowed.md new file mode 100644 index 00000000..26cf5fe4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionBotAllowed.md @@ -0,0 +1,43 @@ +--- +title: messageActionBotAllowed +description: messageActionBotAllowed attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionBotAllowed +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|domain|[string](../types/string.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionBotAllowed = ['_' => 'messageActionBotAllowed', 'domain' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionBotAllowed", "domain": "string"} +``` + + +Or, if you're into Lua: + + +``` +messageActionBotAllowed={_='messageActionBotAllowed', domain='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionChannelCreate.md b/old_docs/API_docs_v81/constructors/messageActionChannelCreate.md new file mode 100644 index 00000000..b1750d73 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionChannelCreate.md @@ -0,0 +1,43 @@ +--- +title: messageActionChannelCreate +description: messageActionChannelCreate attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChannelCreate +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|title|[string](../types/string.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionChannelCreate = ['_' => 'messageActionChannelCreate', 'title' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionChannelCreate", "title": "string"} +``` + + +Or, if you're into Lua: + + +``` +messageActionChannelCreate={_='messageActionChannelCreate', title='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionChannelMigrateFrom.md b/old_docs/API_docs_v81/constructors/messageActionChannelMigrateFrom.md new file mode 100644 index 00000000..add136dc --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionChannelMigrateFrom.md @@ -0,0 +1,44 @@ +--- +title: messageActionChannelMigrateFrom +description: messageActionChannelMigrateFrom attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChannelMigrateFrom +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|title|[string](../types/string.md) | Yes| +|chat\_id|[int](../types/int.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionChannelMigrateFrom = ['_' => 'messageActionChannelMigrateFrom', 'title' => 'string', 'chat_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionChannelMigrateFrom", "title": "string", "chat_id": int} +``` + + +Or, if you're into Lua: + + +``` +messageActionChannelMigrateFrom={_='messageActionChannelMigrateFrom', title='string', chat_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionChatAddUser.md b/old_docs/API_docs_v81/constructors/messageActionChatAddUser.md new file mode 100644 index 00000000..9c7de7f8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionChatAddUser.md @@ -0,0 +1,43 @@ +--- +title: messageActionChatAddUser +description: messageActionChatAddUser attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatAddUser +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|users|Array of [int](../types/int.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionChatAddUser = ['_' => 'messageActionChatAddUser', 'users' => [int, int]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionChatAddUser", "users": [int]} +``` + + +Or, if you're into Lua: + + +``` +messageActionChatAddUser={_='messageActionChatAddUser', users={int}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionChatCreate.md b/old_docs/API_docs_v81/constructors/messageActionChatCreate.md new file mode 100644 index 00000000..f6a965f4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionChatCreate.md @@ -0,0 +1,44 @@ +--- +title: messageActionChatCreate +description: messageActionChatCreate attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatCreate +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|title|[string](../types/string.md) | Yes| +|users|Array of [int](../types/int.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionChatCreate = ['_' => 'messageActionChatCreate', 'title' => 'string', 'users' => [int, int]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionChatCreate", "title": "string", "users": [int]} +``` + + +Or, if you're into Lua: + + +``` +messageActionChatCreate={_='messageActionChatCreate', title='string', users={int}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionChatDeletePhoto.md b/old_docs/API_docs_v81/constructors/messageActionChatDeletePhoto.md new file mode 100644 index 00000000..a6fcf830 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionChatDeletePhoto.md @@ -0,0 +1,38 @@ +--- +title: messageActionChatDeletePhoto +description: messageActionChatDeletePhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatDeletePhoto +[Back to constructors index](index.md) + + + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionChatDeletePhoto = ['_' => 'messageActionChatDeletePhoto']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionChatDeletePhoto"} +``` + + +Or, if you're into Lua: + + +``` +messageActionChatDeletePhoto={_='messageActionChatDeletePhoto'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionChatDeleteUser.md b/old_docs/API_docs_v81/constructors/messageActionChatDeleteUser.md new file mode 100644 index 00000000..e4869c93 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionChatDeleteUser.md @@ -0,0 +1,43 @@ +--- +title: messageActionChatDeleteUser +description: messageActionChatDeleteUser attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatDeleteUser +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionChatDeleteUser = ['_' => 'messageActionChatDeleteUser', 'user_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionChatDeleteUser", "user_id": int} +``` + + +Or, if you're into Lua: + + +``` +messageActionChatDeleteUser={_='messageActionChatDeleteUser', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionChatEditPhoto.md b/old_docs/API_docs_v81/constructors/messageActionChatEditPhoto.md new file mode 100644 index 00000000..e4a2b188 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionChatEditPhoto.md @@ -0,0 +1,43 @@ +--- +title: messageActionChatEditPhoto +description: messageActionChatEditPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatEditPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|photo|[Photo](../types/Photo.md) | Optional| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionChatEditPhoto = ['_' => 'messageActionChatEditPhoto', 'photo' => Photo]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionChatEditPhoto", "photo": Photo} +``` + + +Or, if you're into Lua: + + +``` +messageActionChatEditPhoto={_='messageActionChatEditPhoto', photo=Photo} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionChatEditTitle.md b/old_docs/API_docs_v81/constructors/messageActionChatEditTitle.md new file mode 100644 index 00000000..5293b422 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionChatEditTitle.md @@ -0,0 +1,43 @@ +--- +title: messageActionChatEditTitle +description: messageActionChatEditTitle attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatEditTitle +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|title|[string](../types/string.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionChatEditTitle = ['_' => 'messageActionChatEditTitle', 'title' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionChatEditTitle", "title": "string"} +``` + + +Or, if you're into Lua: + + +``` +messageActionChatEditTitle={_='messageActionChatEditTitle', title='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionChatJoinedByLink.md b/old_docs/API_docs_v81/constructors/messageActionChatJoinedByLink.md new file mode 100644 index 00000000..70316d42 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionChatJoinedByLink.md @@ -0,0 +1,43 @@ +--- +title: messageActionChatJoinedByLink +description: messageActionChatJoinedByLink attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatJoinedByLink +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|inviter\_id|[int](../types/int.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionChatJoinedByLink = ['_' => 'messageActionChatJoinedByLink', 'inviter_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionChatJoinedByLink", "inviter_id": int} +``` + + +Or, if you're into Lua: + + +``` +messageActionChatJoinedByLink={_='messageActionChatJoinedByLink', inviter_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionChatMigrateTo.md b/old_docs/API_docs_v81/constructors/messageActionChatMigrateTo.md new file mode 100644 index 00000000..21d2cb22 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionChatMigrateTo.md @@ -0,0 +1,43 @@ +--- +title: messageActionChatMigrateTo +description: messageActionChatMigrateTo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatMigrateTo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionChatMigrateTo = ['_' => 'messageActionChatMigrateTo', 'channel_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionChatMigrateTo", "channel_id": int} +``` + + +Or, if you're into Lua: + + +``` +messageActionChatMigrateTo={_='messageActionChatMigrateTo', channel_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionCustomAction.md b/old_docs/API_docs_v81/constructors/messageActionCustomAction.md new file mode 100644 index 00000000..7dc58857 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionCustomAction.md @@ -0,0 +1,43 @@ +--- +title: messageActionCustomAction +description: messageActionCustomAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionCustomAction +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|message|[string](../types/string.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionCustomAction = ['_' => 'messageActionCustomAction', 'message' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionCustomAction", "message": "string"} +``` + + +Or, if you're into Lua: + + +``` +messageActionCustomAction={_='messageActionCustomAction', message='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionEmpty.md b/old_docs/API_docs_v81/constructors/messageActionEmpty.md new file mode 100644 index 00000000..d8c678b2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionEmpty.md @@ -0,0 +1,38 @@ +--- +title: messageActionEmpty +description: messageActionEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionEmpty = ['_' => 'messageActionEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionEmpty"} +``` + + +Or, if you're into Lua: + + +``` +messageActionEmpty={_='messageActionEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionGameScore.md b/old_docs/API_docs_v81/constructors/messageActionGameScore.md new file mode 100644 index 00000000..7a459a3d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionGameScore.md @@ -0,0 +1,44 @@ +--- +title: messageActionGameScore +description: messageActionGameScore attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionGameScore +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|game\_id|[long](../types/long.md) | Yes| +|score|[int](../types/int.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionGameScore = ['_' => 'messageActionGameScore', 'game_id' => long, 'score' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionGameScore", "game_id": long, "score": int} +``` + + +Or, if you're into Lua: + + +``` +messageActionGameScore={_='messageActionGameScore', game_id=long, score=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionHistoryClear.md b/old_docs/API_docs_v81/constructors/messageActionHistoryClear.md new file mode 100644 index 00000000..8b8dcc9d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionHistoryClear.md @@ -0,0 +1,38 @@ +--- +title: messageActionHistoryClear +description: messageActionHistoryClear attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionHistoryClear +[Back to constructors index](index.md) + + + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionHistoryClear = ['_' => 'messageActionHistoryClear']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionHistoryClear"} +``` + + +Or, if you're into Lua: + + +``` +messageActionHistoryClear={_='messageActionHistoryClear'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionPaymentSent.md b/old_docs/API_docs_v81/constructors/messageActionPaymentSent.md new file mode 100644 index 00000000..b224a125 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionPaymentSent.md @@ -0,0 +1,44 @@ +--- +title: messageActionPaymentSent +description: messageActionPaymentSent attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPaymentSent +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|currency|[string](../types/string.md) | Yes| +|total\_amount|[long](../types/long.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionPaymentSent = ['_' => 'messageActionPaymentSent', 'currency' => 'string', 'total_amount' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionPaymentSent", "currency": "string", "total_amount": long} +``` + + +Or, if you're into Lua: + + +``` +messageActionPaymentSent={_='messageActionPaymentSent', currency='string', total_amount=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionPaymentSentMe.md b/old_docs/API_docs_v81/constructors/messageActionPaymentSentMe.md new file mode 100644 index 00000000..f21ccce0 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionPaymentSentMe.md @@ -0,0 +1,48 @@ +--- +title: messageActionPaymentSentMe +description: messageActionPaymentSentMe attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPaymentSentMe +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|currency|[string](../types/string.md) | Yes| +|total\_amount|[long](../types/long.md) | Yes| +|payload|[bytes](../types/bytes.md) | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional| +|shipping\_option\_id|[string](../types/string.md) | Optional| +|charge|[PaymentCharge](../types/PaymentCharge.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionPaymentSentMe = ['_' => 'messageActionPaymentSentMe', 'currency' => 'string', 'total_amount' => long, 'payload' => 'bytes', 'info' => PaymentRequestedInfo, 'shipping_option_id' => 'string', 'charge' => PaymentCharge]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionPaymentSentMe", "currency": "string", "total_amount": long, "payload": {"_": "bytes", "bytes":"base64 encoded bytes"}, "info": PaymentRequestedInfo, "shipping_option_id": "string", "charge": PaymentCharge} +``` + + +Or, if you're into Lua: + + +``` +messageActionPaymentSentMe={_='messageActionPaymentSentMe', currency='string', total_amount=long, payload='bytes', info=PaymentRequestedInfo, shipping_option_id='string', charge=PaymentCharge} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionPhoneCall.md b/old_docs/API_docs_v81/constructors/messageActionPhoneCall.md new file mode 100644 index 00000000..f2f3eb4f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionPhoneCall.md @@ -0,0 +1,45 @@ +--- +title: messageActionPhoneCall +description: messageActionPhoneCall attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPhoneCall +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|call\_id|[long](../types/long.md) | Yes| +|reason|[PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) | Optional| +|duration|[int](../types/int.md) | Optional| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionPhoneCall = ['_' => 'messageActionPhoneCall', 'call_id' => long, 'reason' => PhoneCallDiscardReason, 'duration' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionPhoneCall", "call_id": long, "reason": PhoneCallDiscardReason, "duration": int} +``` + + +Or, if you're into Lua: + + +``` +messageActionPhoneCall={_='messageActionPhoneCall', call_id=long, reason=PhoneCallDiscardReason, duration=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionPinMessage.md b/old_docs/API_docs_v81/constructors/messageActionPinMessage.md new file mode 100644 index 00000000..ffa41746 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionPinMessage.md @@ -0,0 +1,38 @@ +--- +title: messageActionPinMessage +description: messageActionPinMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPinMessage +[Back to constructors index](index.md) + + + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionPinMessage = ['_' => 'messageActionPinMessage']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionPinMessage"} +``` + + +Or, if you're into Lua: + + +``` +messageActionPinMessage={_='messageActionPinMessage'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionScreenshotTaken.md b/old_docs/API_docs_v81/constructors/messageActionScreenshotTaken.md new file mode 100644 index 00000000..f86b1746 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionScreenshotTaken.md @@ -0,0 +1,38 @@ +--- +title: messageActionScreenshotTaken +description: messageActionScreenshotTaken attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionScreenshotTaken +[Back to constructors index](index.md) + + + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionScreenshotTaken = ['_' => 'messageActionScreenshotTaken']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionScreenshotTaken"} +``` + + +Or, if you're into Lua: + + +``` +messageActionScreenshotTaken={_='messageActionScreenshotTaken'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionSecureValuesSent.md b/old_docs/API_docs_v81/constructors/messageActionSecureValuesSent.md new file mode 100644 index 00000000..65dbd5c7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionSecureValuesSent.md @@ -0,0 +1,43 @@ +--- +title: messageActionSecureValuesSent +description: messageActionSecureValuesSent attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionSecureValuesSent +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|types|Array of [SecureValueType](../types/SecureValueType.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionSecureValuesSent = ['_' => 'messageActionSecureValuesSent', 'types' => [SecureValueType, SecureValueType]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionSecureValuesSent", "types": [SecureValueType]} +``` + + +Or, if you're into Lua: + + +``` +messageActionSecureValuesSent={_='messageActionSecureValuesSent', types={SecureValueType}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageActionSecureValuesSentMe.md b/old_docs/API_docs_v81/constructors/messageActionSecureValuesSentMe.md new file mode 100644 index 00000000..31a2ef90 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageActionSecureValuesSentMe.md @@ -0,0 +1,44 @@ +--- +title: messageActionSecureValuesSentMe +description: messageActionSecureValuesSentMe attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionSecureValuesSentMe +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|values|Array of [SecureValue](../types/SecureValue.md) | Yes| +|credentials|[SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md) | Yes| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +``` +$messageActionSecureValuesSentMe = ['_' => 'messageActionSecureValuesSentMe', 'values' => [SecureValue, SecureValue], 'credentials' => SecureCredentialsEncrypted]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageActionSecureValuesSentMe", "values": [SecureValue], "credentials": SecureCredentialsEncrypted} +``` + + +Or, if you're into Lua: + + +``` +messageActionSecureValuesSentMe={_='messageActionSecureValuesSentMe', values={SecureValue}, credentials=SecureCredentialsEncrypted} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEmpty.md b/old_docs/API_docs_v81/constructors/messageEmpty.md new file mode 100644 index 00000000..7ded1a1b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEmpty.md @@ -0,0 +1,43 @@ +--- +title: messageEmpty +description: messageEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| + + + +### Type: [Message](../types/Message.md) + + +### Example: + +``` +$messageEmpty = ['_' => 'messageEmpty', 'id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEmpty", "id": int} +``` + + +Or, if you're into Lua: + + +``` +messageEmpty={_='messageEmpty', id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityBold.md b/old_docs/API_docs_v81/constructors/messageEntityBold.md new file mode 100644 index 00000000..950699fb --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityBold.md @@ -0,0 +1,44 @@ +--- +title: messageEntityBold +description: messageEntityBold attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityBold +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityBold = ['_' => 'messageEntityBold', 'offset' => int, 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityBold", "offset": int, "length": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityBold={_='messageEntityBold', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityBotCommand.md b/old_docs/API_docs_v81/constructors/messageEntityBotCommand.md new file mode 100644 index 00000000..8be471d3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityBotCommand.md @@ -0,0 +1,44 @@ +--- +title: messageEntityBotCommand +description: messageEntityBotCommand attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityBotCommand +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityBotCommand = ['_' => 'messageEntityBotCommand', 'offset' => int, 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityBotCommand", "offset": int, "length": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityBotCommand={_='messageEntityBotCommand', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityCashtag.md b/old_docs/API_docs_v81/constructors/messageEntityCashtag.md new file mode 100644 index 00000000..527c66d1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityCashtag.md @@ -0,0 +1,44 @@ +--- +title: messageEntityCashtag +description: messageEntityCashtag attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityCashtag +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityCashtag = ['_' => 'messageEntityCashtag', 'offset' => int, 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityCashtag", "offset": int, "length": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityCashtag={_='messageEntityCashtag', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityCode.md b/old_docs/API_docs_v81/constructors/messageEntityCode.md new file mode 100644 index 00000000..7c701844 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityCode.md @@ -0,0 +1,44 @@ +--- +title: messageEntityCode +description: messageEntityCode attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityCode +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityCode = ['_' => 'messageEntityCode', 'offset' => int, 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityCode", "offset": int, "length": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityCode={_='messageEntityCode', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityEmail.md b/old_docs/API_docs_v81/constructors/messageEntityEmail.md new file mode 100644 index 00000000..35a968c7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityEmail.md @@ -0,0 +1,44 @@ +--- +title: messageEntityEmail +description: messageEntityEmail attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityEmail +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityEmail = ['_' => 'messageEntityEmail', 'offset' => int, 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityEmail", "offset": int, "length": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityEmail={_='messageEntityEmail', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityHashtag.md b/old_docs/API_docs_v81/constructors/messageEntityHashtag.md new file mode 100644 index 00000000..6b124e73 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityHashtag.md @@ -0,0 +1,44 @@ +--- +title: messageEntityHashtag +description: messageEntityHashtag attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityHashtag +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityHashtag = ['_' => 'messageEntityHashtag', 'offset' => int, 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityHashtag", "offset": int, "length": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityHashtag={_='messageEntityHashtag', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityItalic.md b/old_docs/API_docs_v81/constructors/messageEntityItalic.md new file mode 100644 index 00000000..25f73428 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityItalic.md @@ -0,0 +1,44 @@ +--- +title: messageEntityItalic +description: messageEntityItalic attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityItalic +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityItalic = ['_' => 'messageEntityItalic', 'offset' => int, 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityItalic", "offset": int, "length": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityItalic={_='messageEntityItalic', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityMention.md b/old_docs/API_docs_v81/constructors/messageEntityMention.md new file mode 100644 index 00000000..9eb4d266 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityMention.md @@ -0,0 +1,44 @@ +--- +title: messageEntityMention +description: messageEntityMention attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityMention +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityMention = ['_' => 'messageEntityMention', 'offset' => int, 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityMention", "offset": int, "length": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityMention={_='messageEntityMention', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityMentionName.md b/old_docs/API_docs_v81/constructors/messageEntityMentionName.md new file mode 100644 index 00000000..b546570b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityMentionName.md @@ -0,0 +1,45 @@ +--- +title: messageEntityMentionName +description: messageEntityMentionName attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityMentionName +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityMentionName = ['_' => 'messageEntityMentionName', 'offset' => int, 'length' => int, 'user_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityMentionName", "offset": int, "length": int, "user_id": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityMentionName={_='messageEntityMentionName', offset=int, length=int, user_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityPhone.md b/old_docs/API_docs_v81/constructors/messageEntityPhone.md new file mode 100644 index 00000000..995c04a6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityPhone.md @@ -0,0 +1,44 @@ +--- +title: messageEntityPhone +description: messageEntityPhone attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityPhone +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityPhone = ['_' => 'messageEntityPhone', 'offset' => int, 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityPhone", "offset": int, "length": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityPhone={_='messageEntityPhone', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityPre.md b/old_docs/API_docs_v81/constructors/messageEntityPre.md new file mode 100644 index 00000000..abfc9136 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityPre.md @@ -0,0 +1,45 @@ +--- +title: messageEntityPre +description: messageEntityPre attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityPre +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| +|language|[string](../types/string.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityPre = ['_' => 'messageEntityPre', 'offset' => int, 'length' => int, 'language' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityPre", "offset": int, "length": int, "language": "string"} +``` + + +Or, if you're into Lua: + + +``` +messageEntityPre={_='messageEntityPre', offset=int, length=int, language='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityTextUrl.md b/old_docs/API_docs_v81/constructors/messageEntityTextUrl.md new file mode 100644 index 00000000..91f6d36c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityTextUrl.md @@ -0,0 +1,45 @@ +--- +title: messageEntityTextUrl +description: messageEntityTextUrl attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityTextUrl +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| +|url|[string](../types/string.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityTextUrl = ['_' => 'messageEntityTextUrl', 'offset' => int, 'length' => int, 'url' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityTextUrl", "offset": int, "length": int, "url": "string"} +``` + + +Or, if you're into Lua: + + +``` +messageEntityTextUrl={_='messageEntityTextUrl', offset=int, length=int, url='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityUnknown.md b/old_docs/API_docs_v81/constructors/messageEntityUnknown.md new file mode 100644 index 00000000..69ca8a1b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityUnknown.md @@ -0,0 +1,44 @@ +--- +title: messageEntityUnknown +description: messageEntityUnknown attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityUnknown +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityUnknown = ['_' => 'messageEntityUnknown', 'offset' => int, 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityUnknown", "offset": int, "length": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityUnknown={_='messageEntityUnknown', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageEntityUrl.md b/old_docs/API_docs_v81/constructors/messageEntityUrl.md new file mode 100644 index 00000000..377c3dda --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageEntityUrl.md @@ -0,0 +1,44 @@ +--- +title: messageEntityUrl +description: messageEntityUrl attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityUrl +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|offset|[int](../types/int.md) | Yes| +|length|[int](../types/int.md) | Yes| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +``` +$messageEntityUrl = ['_' => 'messageEntityUrl', 'offset' => int, 'length' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageEntityUrl", "offset": int, "length": int} +``` + + +Or, if you're into Lua: + + +``` +messageEntityUrl={_='messageEntityUrl', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageFwdHeader.md b/old_docs/API_docs_v81/constructors/messageFwdHeader.md new file mode 100644 index 00000000..17fd301c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageFwdHeader.md @@ -0,0 +1,49 @@ +--- +title: messageFwdHeader +description: messageFwdHeader attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageFwdHeader +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|from\_id|[int](../types/int.md) | Optional| +|date|[int](../types/int.md) | Yes| +|channel\_id|[int](../types/int.md) | Optional| +|channel\_post|[int](../types/int.md) | Optional| +|post\_author|[string](../types/string.md) | Optional| +|saved\_from\_peer|[Peer](../types/Peer.md) | Optional| +|saved\_from\_msg\_id|[int](../types/int.md) | Optional| + + + +### Type: [MessageFwdHeader](../types/MessageFwdHeader.md) + + +### Example: + +``` +$messageFwdHeader = ['_' => 'messageFwdHeader', 'from_id' => int, 'date' => int, 'channel_id' => int, 'channel_post' => int, 'post_author' => 'string', 'saved_from_peer' => Peer, 'saved_from_msg_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageFwdHeader", "from_id": int, "date": int, "channel_id": int, "channel_post": int, "post_author": "string", "saved_from_peer": Peer, "saved_from_msg_id": int} +``` + + +Or, if you're into Lua: + + +``` +messageFwdHeader={_='messageFwdHeader', from_id=int, date=int, channel_id=int, channel_post=int, post_author='string', saved_from_peer=Peer, saved_from_msg_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageMediaContact.md b/old_docs/API_docs_v81/constructors/messageMediaContact.md new file mode 100644 index 00000000..a426d993 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageMediaContact.md @@ -0,0 +1,46 @@ +--- +title: messageMediaContact +description: messageMediaContact attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaContact +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone\_number|[string](../types/string.md) | Yes| +|first\_name|[string](../types/string.md) | Yes| +|last\_name|[string](../types/string.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +``` +$messageMediaContact = ['_' => 'messageMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'user_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageMediaContact", "phone_number": "string", "first_name": "string", "last_name": "string", "user_id": int} +``` + + +Or, if you're into Lua: + + +``` +messageMediaContact={_='messageMediaContact', phone_number='string', first_name='string', last_name='string', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageMediaDocument.md b/old_docs/API_docs_v81/constructors/messageMediaDocument.md new file mode 100644 index 00000000..b91e7db9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageMediaDocument.md @@ -0,0 +1,44 @@ +--- +title: messageMediaDocument +description: messageMediaDocument attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaDocument +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|document|[Document](../types/Document.md) | Optional| +|ttl\_seconds|[int](../types/int.md) | Optional| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +``` +$messageMediaDocument = ['_' => 'messageMediaDocument', 'document' => Document, 'ttl_seconds' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageMediaDocument", "document": Document, "ttl_seconds": int} +``` + + +Or, if you're into Lua: + + +``` +messageMediaDocument={_='messageMediaDocument', document=Document, ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageMediaEmpty.md b/old_docs/API_docs_v81/constructors/messageMediaEmpty.md new file mode 100644 index 00000000..b3bd4a97 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageMediaEmpty.md @@ -0,0 +1,38 @@ +--- +title: messageMediaEmpty +description: messageMediaEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +``` +$messageMediaEmpty = ['_' => 'messageMediaEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageMediaEmpty"} +``` + + +Or, if you're into Lua: + + +``` +messageMediaEmpty={_='messageMediaEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageMediaGame.md b/old_docs/API_docs_v81/constructors/messageMediaGame.md new file mode 100644 index 00000000..e97b2bd1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageMediaGame.md @@ -0,0 +1,43 @@ +--- +title: messageMediaGame +description: messageMediaGame attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaGame +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|game|[Game](../types/Game.md) | Yes| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +``` +$messageMediaGame = ['_' => 'messageMediaGame', 'game' => Game]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageMediaGame", "game": Game} +``` + + +Or, if you're into Lua: + + +``` +messageMediaGame={_='messageMediaGame', game=Game} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageMediaGeo.md b/old_docs/API_docs_v81/constructors/messageMediaGeo.md new file mode 100644 index 00000000..9de214be --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageMediaGeo.md @@ -0,0 +1,43 @@ +--- +title: messageMediaGeo +description: messageMediaGeo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaGeo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +``` +$messageMediaGeo = ['_' => 'messageMediaGeo', 'geo' => GeoPoint]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageMediaGeo", "geo": GeoPoint} +``` + + +Or, if you're into Lua: + + +``` +messageMediaGeo={_='messageMediaGeo', geo=GeoPoint} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageMediaGeoLive.md b/old_docs/API_docs_v81/constructors/messageMediaGeoLive.md new file mode 100644 index 00000000..f77c0a16 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageMediaGeoLive.md @@ -0,0 +1,44 @@ +--- +title: messageMediaGeoLive +description: messageMediaGeoLive attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaGeoLive +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional| +|period|[int](../types/int.md) | Yes| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +``` +$messageMediaGeoLive = ['_' => 'messageMediaGeoLive', 'geo' => GeoPoint, 'period' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageMediaGeoLive", "geo": GeoPoint, "period": int} +``` + + +Or, if you're into Lua: + + +``` +messageMediaGeoLive={_='messageMediaGeoLive', geo=GeoPoint, period=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageMediaInvoice.md b/old_docs/API_docs_v81/constructors/messageMediaInvoice.md new file mode 100644 index 00000000..dff83700 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageMediaInvoice.md @@ -0,0 +1,51 @@ +--- +title: messageMediaInvoice +description: messageMediaInvoice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaInvoice +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|shipping\_address\_requested|[Bool](../types/Bool.md) | Optional| +|test|[Bool](../types/Bool.md) | Optional| +|title|[string](../types/string.md) | Yes| +|description|[string](../types/string.md) | Yes| +|photo|[WebDocument](../types/WebDocument.md) | Optional| +|receipt\_msg\_id|[int](../types/int.md) | Optional| +|currency|[string](../types/string.md) | Yes| +|total\_amount|[long](../types/long.md) | Yes| +|start\_param|[string](../types/string.md) | Yes| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +``` +$messageMediaInvoice = ['_' => 'messageMediaInvoice', 'shipping_address_requested' => Bool, 'test' => Bool, 'title' => 'string', 'description' => 'string', 'photo' => WebDocument, 'receipt_msg_id' => int, 'currency' => 'string', 'total_amount' => long, 'start_param' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageMediaInvoice", "shipping_address_requested": Bool, "test": Bool, "title": "string", "description": "string", "photo": WebDocument, "receipt_msg_id": int, "currency": "string", "total_amount": long, "start_param": "string"} +``` + + +Or, if you're into Lua: + + +``` +messageMediaInvoice={_='messageMediaInvoice', shipping_address_requested=Bool, test=Bool, title='string', description='string', photo=WebDocument, receipt_msg_id=int, currency='string', total_amount=long, start_param='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageMediaPhoto.md b/old_docs/API_docs_v81/constructors/messageMediaPhoto.md new file mode 100644 index 00000000..530e1abf --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageMediaPhoto.md @@ -0,0 +1,44 @@ +--- +title: messageMediaPhoto +description: messageMediaPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|photo|[Photo](../types/Photo.md) | Optional| +|ttl\_seconds|[int](../types/int.md) | Optional| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +``` +$messageMediaPhoto = ['_' => 'messageMediaPhoto', 'photo' => Photo, 'ttl_seconds' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageMediaPhoto", "photo": Photo, "ttl_seconds": int} +``` + + +Or, if you're into Lua: + + +``` +messageMediaPhoto={_='messageMediaPhoto', photo=Photo, ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageMediaUnsupported.md b/old_docs/API_docs_v81/constructors/messageMediaUnsupported.md new file mode 100644 index 00000000..5df25a67 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageMediaUnsupported.md @@ -0,0 +1,38 @@ +--- +title: messageMediaUnsupported +description: messageMediaUnsupported attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaUnsupported +[Back to constructors index](index.md) + + + + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +``` +$messageMediaUnsupported = ['_' => 'messageMediaUnsupported']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageMediaUnsupported"} +``` + + +Or, if you're into Lua: + + +``` +messageMediaUnsupported={_='messageMediaUnsupported'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageMediaVenue.md b/old_docs/API_docs_v81/constructors/messageMediaVenue.md new file mode 100644 index 00000000..7d529bf1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageMediaVenue.md @@ -0,0 +1,48 @@ +--- +title: messageMediaVenue +description: messageMediaVenue attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaVenue +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional| +|title|[string](../types/string.md) | Yes| +|address|[string](../types/string.md) | Yes| +|provider|[string](../types/string.md) | Yes| +|venue\_id|[string](../types/string.md) | Yes| +|venue\_type|[string](../types/string.md) | Yes| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +``` +$messageMediaVenue = ['_' => 'messageMediaVenue', 'geo' => GeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string', 'venue_type' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageMediaVenue", "geo": GeoPoint, "title": "string", "address": "string", "provider": "string", "venue_id": "string", "venue_type": "string"} +``` + + +Or, if you're into Lua: + + +``` +messageMediaVenue={_='messageMediaVenue', geo=GeoPoint, title='string', address='string', provider='string', venue_id='string', venue_type='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageMediaWebPage.md b/old_docs/API_docs_v81/constructors/messageMediaWebPage.md new file mode 100644 index 00000000..6c37fb2b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageMediaWebPage.md @@ -0,0 +1,43 @@ +--- +title: messageMediaWebPage +description: messageMediaWebPage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaWebPage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|webpage|[WebPage](../types/WebPage.md) | Optional| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +``` +$messageMediaWebPage = ['_' => 'messageMediaWebPage', 'webpage' => WebPage]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageMediaWebPage", "webpage": WebPage} +``` + + +Or, if you're into Lua: + + +``` +messageMediaWebPage={_='messageMediaWebPage', webpage=WebPage} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageRange.md b/old_docs/API_docs_v81/constructors/messageRange.md new file mode 100644 index 00000000..40c3f81a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageRange.md @@ -0,0 +1,44 @@ +--- +title: messageRange +description: messageRange attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageRange +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|min\_id|[int](../types/int.md) | Yes| +|max\_id|[int](../types/int.md) | Yes| + + + +### Type: [MessageRange](../types/MessageRange.md) + + +### Example: + +``` +$messageRange = ['_' => 'messageRange', 'min_id' => int, 'max_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageRange", "min_id": int, "max_id": int} +``` + + +Or, if you're into Lua: + + +``` +messageRange={_='messageRange', min_id=int, max_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messageService.md b/old_docs/API_docs_v81/constructors/messageService.md new file mode 100644 index 00000000..8f47e32f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messageService.md @@ -0,0 +1,53 @@ +--- +title: messageService +description: messageService attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageService +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|out|[Bool](../types/Bool.md) | Optional| +|mentioned|[Bool](../types/Bool.md) | Optional| +|media\_unread|[Bool](../types/Bool.md) | Optional| +|silent|[Bool](../types/Bool.md) | Optional| +|post|[Bool](../types/Bool.md) | Optional| +|id|[int](../types/int.md) | Yes| +|from\_id|[int](../types/int.md) | Optional| +|to\_id|[Peer](../types/Peer.md) | Yes| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional| +|date|[int](../types/int.md) | Yes| +|action|[MessageAction](../types/MessageAction.md) | Optional| + + + +### Type: [Message](../types/Message.md) + + +### Example: + +``` +$messageService = ['_' => 'messageService', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'post' => Bool, 'id' => int, 'from_id' => int, 'to_id' => Peer, 'reply_to_msg_id' => int, 'date' => int, 'action' => MessageAction]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messageService", "out": Bool, "mentioned": Bool, "media_unread": Bool, "silent": Bool, "post": Bool, "id": int, "from_id": int, "to_id": Peer, "reply_to_msg_id": int, "date": int, "action": MessageAction} +``` + + +Or, if you're into Lua: + + +``` +messageService={_='messageService', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, post=Bool, id=int, from_id=int, to_id=Peer, reply_to_msg_id=int, date=int, action=MessageAction} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_affectedHistory.md b/old_docs/API_docs_v81/constructors/messages_affectedHistory.md new file mode 100644 index 00000000..24dd1b8b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_affectedHistory.md @@ -0,0 +1,45 @@ +--- +title: messages.affectedHistory +description: messages_affectedHistory attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.affectedHistory +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| +|offset|[int](../types/int.md) | Yes| + + + +### Type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) + + +### Example: + +``` +$messages_affectedHistory = ['_' => 'messages.affectedHistory', 'pts' => int, 'pts_count' => int, 'offset' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.affectedHistory", "pts": int, "pts_count": int, "offset": int} +``` + + +Or, if you're into Lua: + + +``` +messages_affectedHistory={_='messages.affectedHistory', pts=int, pts_count=int, offset=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_affectedMessages.md b/old_docs/API_docs_v81/constructors/messages_affectedMessages.md new file mode 100644 index 00000000..e5d5b9fa --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_affectedMessages.md @@ -0,0 +1,44 @@ +--- +title: messages.affectedMessages +description: messages_affectedMessages attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.affectedMessages +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) + + +### Example: + +``` +$messages_affectedMessages = ['_' => 'messages.affectedMessages', 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.affectedMessages", "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +messages_affectedMessages={_='messages.affectedMessages', pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_allStickers.md b/old_docs/API_docs_v81/constructors/messages_allStickers.md new file mode 100644 index 00000000..2a7d1313 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_allStickers.md @@ -0,0 +1,44 @@ +--- +title: messages.allStickers +description: messages_allStickers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.allStickers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|hash|[int](../types/int.md) | Yes| +|sets|Array of [StickerSet](../types/StickerSet.md) | Yes| + + + +### Type: [messages\_AllStickers](../types/messages_AllStickers.md) + + +### Example: + +``` +$messages_allStickers = ['_' => 'messages.allStickers', 'hash' => int, 'sets' => [StickerSet, StickerSet]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.allStickers", "hash": int, "sets": [StickerSet]} +``` + + +Or, if you're into Lua: + + +``` +messages_allStickers={_='messages.allStickers', hash=int, sets={StickerSet}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_allStickersNotModified.md b/old_docs/API_docs_v81/constructors/messages_allStickersNotModified.md new file mode 100644 index 00000000..84eea993 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_allStickersNotModified.md @@ -0,0 +1,38 @@ +--- +title: messages.allStickersNotModified +description: messages_allStickersNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.allStickersNotModified +[Back to constructors index](index.md) + + + + + + +### Type: [messages\_AllStickers](../types/messages_AllStickers.md) + + +### Example: + +``` +$messages_allStickersNotModified = ['_' => 'messages.allStickersNotModified']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.allStickersNotModified"} +``` + + +Or, if you're into Lua: + + +``` +messages_allStickersNotModified={_='messages.allStickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_archivedStickers.md b/old_docs/API_docs_v81/constructors/messages_archivedStickers.md new file mode 100644 index 00000000..458c74b9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_archivedStickers.md @@ -0,0 +1,44 @@ +--- +title: messages.archivedStickers +description: messages_archivedStickers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.archivedStickers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|count|[int](../types/int.md) | Yes| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes| + + + +### Type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) + + +### Example: + +``` +$messages_archivedStickers = ['_' => 'messages.archivedStickers', 'count' => int, 'sets' => [StickerSetCovered, StickerSetCovered]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.archivedStickers", "count": int, "sets": [StickerSetCovered]} +``` + + +Or, if you're into Lua: + + +``` +messages_archivedStickers={_='messages.archivedStickers', count=int, sets={StickerSetCovered}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_botCallbackAnswer.md b/old_docs/API_docs_v81/constructors/messages_botCallbackAnswer.md new file mode 100644 index 00000000..657ba0fc --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_botCallbackAnswer.md @@ -0,0 +1,48 @@ +--- +title: messages.botCallbackAnswer +description: messages_botCallbackAnswer attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.botCallbackAnswer +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|alert|[Bool](../types/Bool.md) | Optional| +|has\_url|[Bool](../types/Bool.md) | Optional| +|native\_ui|[Bool](../types/Bool.md) | Optional| +|message|[string](../types/string.md) | Optional| +|url|[string](../types/string.md) | Optional| +|cache\_time|[int](../types/int.md) | Yes| + + + +### Type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) + + +### Example: + +``` +$messages_botCallbackAnswer = ['_' => 'messages.botCallbackAnswer', 'alert' => Bool, 'has_url' => Bool, 'native_ui' => Bool, 'message' => 'string', 'url' => 'string', 'cache_time' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.botCallbackAnswer", "alert": Bool, "has_url": Bool, "native_ui": Bool, "message": "string", "url": "string", "cache_time": int} +``` + + +Or, if you're into Lua: + + +``` +messages_botCallbackAnswer={_='messages.botCallbackAnswer', alert=Bool, has_url=Bool, native_ui=Bool, message='string', url='string', cache_time=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_botResults.md b/old_docs/API_docs_v81/constructors/messages_botResults.md new file mode 100644 index 00000000..514517e4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_botResults.md @@ -0,0 +1,49 @@ +--- +title: messages.botResults +description: messages_botResults attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.botResults +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|gallery|[Bool](../types/Bool.md) | Optional| +|query\_id|[long](../types/long.md) | Yes| +|next\_offset|[string](../types/string.md) | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +|results|Array of [BotInlineResult](../types/BotInlineResult.md) | Yes| +|cache\_time|[int](../types/int.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [messages\_BotResults](../types/messages_BotResults.md) + + +### Example: + +``` +$messages_botResults = ['_' => 'messages.botResults', 'gallery' => Bool, 'query_id' => long, 'next_offset' => 'string', 'switch_pm' => InlineBotSwitchPM, 'results' => [BotInlineResult, BotInlineResult], 'cache_time' => int, 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.botResults", "gallery": Bool, "query_id": long, "next_offset": "string", "switch_pm": InlineBotSwitchPM, "results": [BotInlineResult], "cache_time": int, "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +messages_botResults={_='messages.botResults', gallery=Bool, query_id=long, next_offset='string', switch_pm=InlineBotSwitchPM, results={BotInlineResult}, cache_time=int, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_channelMessages.md b/old_docs/API_docs_v81/constructors/messages_channelMessages.md new file mode 100644 index 00000000..43f4cdc6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_channelMessages.md @@ -0,0 +1,47 @@ +--- +title: messages.channelMessages +description: messages_channelMessages attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.channelMessages +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|pts|[int](../types/int.md) | Yes| +|count|[int](../types/int.md) | Yes| +|messages|Array of [Message](../types/Message.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [messages\_Messages](../types/messages_Messages.md) + + +### Example: + +``` +$messages_channelMessages = ['_' => 'messages.channelMessages', 'pts' => int, 'count' => int, 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.channelMessages", "pts": int, "count": int, "messages": [Message], "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +messages_channelMessages={_='messages.channelMessages', pts=int, count=int, messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_chatFull.md b/old_docs/API_docs_v81/constructors/messages_chatFull.md new file mode 100644 index 00000000..faeab983 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_chatFull.md @@ -0,0 +1,45 @@ +--- +title: messages.chatFull +description: messages_chatFull attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.chatFull +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|full\_chat|[ChatFull](../types/ChatFull.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [messages\_ChatFull](../types/messages_ChatFull.md) + + +### Example: + +``` +$messages_chatFull = ['_' => 'messages.chatFull', 'full_chat' => ChatFull, 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.chatFull", "full_chat": ChatFull, "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +messages_chatFull={_='messages.chatFull', full_chat=ChatFull, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_chats.md b/old_docs/API_docs_v81/constructors/messages_chats.md new file mode 100644 index 00000000..11e867d1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_chats.md @@ -0,0 +1,43 @@ +--- +title: messages.chats +description: messages_chats attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.chats +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chats|Array of [Chat](../types/Chat.md) | Yes| + + + +### Type: [messages\_Chats](../types/messages_Chats.md) + + +### Example: + +``` +$messages_chats = ['_' => 'messages.chats', 'chats' => [Chat, Chat]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.chats", "chats": [Chat]} +``` + + +Or, if you're into Lua: + + +``` +messages_chats={_='messages.chats', chats={Chat}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_chatsSlice.md b/old_docs/API_docs_v81/constructors/messages_chatsSlice.md new file mode 100644 index 00000000..83905f64 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_chatsSlice.md @@ -0,0 +1,44 @@ +--- +title: messages.chatsSlice +description: messages_chatsSlice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.chatsSlice +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|count|[int](../types/int.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| + + + +### Type: [messages\_Chats](../types/messages_Chats.md) + + +### Example: + +``` +$messages_chatsSlice = ['_' => 'messages.chatsSlice', 'count' => int, 'chats' => [Chat, Chat]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.chatsSlice", "count": int, "chats": [Chat]} +``` + + +Or, if you're into Lua: + + +``` +messages_chatsSlice={_='messages.chatsSlice', count=int, chats={Chat}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_dhConfig.md b/old_docs/API_docs_v81/constructors/messages_dhConfig.md new file mode 100644 index 00000000..68f5f55c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_dhConfig.md @@ -0,0 +1,46 @@ +--- +title: messages.dhConfig +description: messages_dhConfig attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.dhConfig +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|g|[int](../types/int.md) | Yes| +|p|[bytes](../types/bytes.md) | Yes| +|version|[int](../types/int.md) | Yes| +|random|[bytes](../types/bytes.md) | Yes| + + + +### Type: [messages\_DhConfig](../types/messages_DhConfig.md) + + +### Example: + +``` +$messages_dhConfig = ['_' => 'messages.dhConfig', 'g' => int, 'p' => 'bytes', 'version' => int, 'random' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.dhConfig", "g": int, "p": {"_": "bytes", "bytes":"base64 encoded bytes"}, "version": int, "random": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +messages_dhConfig={_='messages.dhConfig', g=int, p='bytes', version=int, random='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_dhConfigNotModified.md b/old_docs/API_docs_v81/constructors/messages_dhConfigNotModified.md new file mode 100644 index 00000000..89246dc8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_dhConfigNotModified.md @@ -0,0 +1,43 @@ +--- +title: messages.dhConfigNotModified +description: messages_dhConfigNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.dhConfigNotModified +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|random|[bytes](../types/bytes.md) | Yes| + + + +### Type: [messages\_DhConfig](../types/messages_DhConfig.md) + + +### Example: + +``` +$messages_dhConfigNotModified = ['_' => 'messages.dhConfigNotModified', 'random' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.dhConfigNotModified", "random": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +messages_dhConfigNotModified={_='messages.dhConfigNotModified', random='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_dialogs.md b/old_docs/API_docs_v81/constructors/messages_dialogs.md new file mode 100644 index 00000000..1822595e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_dialogs.md @@ -0,0 +1,46 @@ +--- +title: messages.dialogs +description: messages_dialogs attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.dialogs +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|dialogs|Array of [Dialog](../types/Dialog.md) | Yes| +|messages|Array of [Message](../types/Message.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [messages\_Dialogs](../types/messages_Dialogs.md) + + +### Example: + +``` +$messages_dialogs = ['_' => 'messages.dialogs', 'dialogs' => [Dialog, Dialog], 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.dialogs", "dialogs": [Dialog], "messages": [Message], "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +messages_dialogs={_='messages.dialogs', dialogs={Dialog}, messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_dialogsSlice.md b/old_docs/API_docs_v81/constructors/messages_dialogsSlice.md new file mode 100644 index 00000000..9f115a2f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_dialogsSlice.md @@ -0,0 +1,47 @@ +--- +title: messages.dialogsSlice +description: messages_dialogsSlice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.dialogsSlice +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|count|[int](../types/int.md) | Yes| +|dialogs|Array of [Dialog](../types/Dialog.md) | Yes| +|messages|Array of [Message](../types/Message.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [messages\_Dialogs](../types/messages_Dialogs.md) + + +### Example: + +``` +$messages_dialogsSlice = ['_' => 'messages.dialogsSlice', 'count' => int, 'dialogs' => [Dialog, Dialog], 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.dialogsSlice", "count": int, "dialogs": [Dialog], "messages": [Message], "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +messages_dialogsSlice={_='messages.dialogsSlice', count=int, dialogs={Dialog}, messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_favedStickers.md b/old_docs/API_docs_v81/constructors/messages_favedStickers.md new file mode 100644 index 00000000..b0501427 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_favedStickers.md @@ -0,0 +1,45 @@ +--- +title: messages.favedStickers +description: messages_favedStickers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.favedStickers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|hash|[int](../types/int.md) | Yes| +|packs|Array of [StickerPack](../types/StickerPack.md) | Yes| +|stickers|Array of [Document](../types/Document.md) | Yes| + + + +### Type: [messages\_FavedStickers](../types/messages_FavedStickers.md) + + +### Example: + +``` +$messages_favedStickers = ['_' => 'messages.favedStickers', 'hash' => int, 'packs' => [StickerPack, StickerPack], 'stickers' => [Document, Document]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.favedStickers", "hash": int, "packs": [StickerPack], "stickers": [Document]} +``` + + +Or, if you're into Lua: + + +``` +messages_favedStickers={_='messages.favedStickers', hash=int, packs={StickerPack}, stickers={Document}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_favedStickersNotModified.md b/old_docs/API_docs_v81/constructors/messages_favedStickersNotModified.md new file mode 100644 index 00000000..a5215247 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_favedStickersNotModified.md @@ -0,0 +1,38 @@ +--- +title: messages.favedStickersNotModified +description: messages_favedStickersNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.favedStickersNotModified +[Back to constructors index](index.md) + + + + + + +### Type: [messages\_FavedStickers](../types/messages_FavedStickers.md) + + +### Example: + +``` +$messages_favedStickersNotModified = ['_' => 'messages.favedStickersNotModified']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.favedStickersNotModified"} +``` + + +Or, if you're into Lua: + + +``` +messages_favedStickersNotModified={_='messages.favedStickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_featuredStickers.md b/old_docs/API_docs_v81/constructors/messages_featuredStickers.md new file mode 100644 index 00000000..0ec8be8b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_featuredStickers.md @@ -0,0 +1,45 @@ +--- +title: messages.featuredStickers +description: messages_featuredStickers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.featuredStickers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|hash|[int](../types/int.md) | Yes| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes| +|unread|Array of [long](../types/long.md) | Yes| + + + +### Type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) + + +### Example: + +``` +$messages_featuredStickers = ['_' => 'messages.featuredStickers', 'hash' => int, 'sets' => [StickerSetCovered, StickerSetCovered], 'unread' => [long, long]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.featuredStickers", "hash": int, "sets": [StickerSetCovered], "unread": [long]} +``` + + +Or, if you're into Lua: + + +``` +messages_featuredStickers={_='messages.featuredStickers', hash=int, sets={StickerSetCovered}, unread={long}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_featuredStickersNotModified.md b/old_docs/API_docs_v81/constructors/messages_featuredStickersNotModified.md new file mode 100644 index 00000000..87d2e6c7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_featuredStickersNotModified.md @@ -0,0 +1,38 @@ +--- +title: messages.featuredStickersNotModified +description: messages_featuredStickersNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.featuredStickersNotModified +[Back to constructors index](index.md) + + + + + + +### Type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) + + +### Example: + +``` +$messages_featuredStickersNotModified = ['_' => 'messages.featuredStickersNotModified']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.featuredStickersNotModified"} +``` + + +Or, if you're into Lua: + + +``` +messages_featuredStickersNotModified={_='messages.featuredStickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_foundGifs.md b/old_docs/API_docs_v81/constructors/messages_foundGifs.md new file mode 100644 index 00000000..f86a9fed --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_foundGifs.md @@ -0,0 +1,44 @@ +--- +title: messages.foundGifs +description: messages_foundGifs attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.foundGifs +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|next\_offset|[int](../types/int.md) | Yes| +|results|Array of [FoundGif](../types/FoundGif.md) | Yes| + + + +### Type: [messages\_FoundGifs](../types/messages_FoundGifs.md) + + +### Example: + +``` +$messages_foundGifs = ['_' => 'messages.foundGifs', 'next_offset' => int, 'results' => [FoundGif, FoundGif]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.foundGifs", "next_offset": int, "results": [FoundGif]} +``` + + +Or, if you're into Lua: + + +``` +messages_foundGifs={_='messages.foundGifs', next_offset=int, results={FoundGif}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_foundStickerSets.md b/old_docs/API_docs_v81/constructors/messages_foundStickerSets.md new file mode 100644 index 00000000..f0cad2dd --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_foundStickerSets.md @@ -0,0 +1,44 @@ +--- +title: messages.foundStickerSets +description: messages_foundStickerSets attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.foundStickerSets +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|hash|[int](../types/int.md) | Yes| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes| + + + +### Type: [messages\_FoundStickerSets](../types/messages_FoundStickerSets.md) + + +### Example: + +``` +$messages_foundStickerSets = ['_' => 'messages.foundStickerSets', 'hash' => int, 'sets' => [StickerSetCovered, StickerSetCovered]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.foundStickerSets", "hash": int, "sets": [StickerSetCovered]} +``` + + +Or, if you're into Lua: + + +``` +messages_foundStickerSets={_='messages.foundStickerSets', hash=int, sets={StickerSetCovered}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_foundStickerSetsNotModified.md b/old_docs/API_docs_v81/constructors/messages_foundStickerSetsNotModified.md new file mode 100644 index 00000000..2263a904 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_foundStickerSetsNotModified.md @@ -0,0 +1,38 @@ +--- +title: messages.foundStickerSetsNotModified +description: messages_foundStickerSetsNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.foundStickerSetsNotModified +[Back to constructors index](index.md) + + + + + + +### Type: [messages\_FoundStickerSets](../types/messages_FoundStickerSets.md) + + +### Example: + +``` +$messages_foundStickerSetsNotModified = ['_' => 'messages.foundStickerSetsNotModified']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.foundStickerSetsNotModified"} +``` + + +Or, if you're into Lua: + + +``` +messages_foundStickerSetsNotModified={_='messages.foundStickerSetsNotModified'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_highScores.md b/old_docs/API_docs_v81/constructors/messages_highScores.md new file mode 100644 index 00000000..1af58a14 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_highScores.md @@ -0,0 +1,44 @@ +--- +title: messages.highScores +description: messages_highScores attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.highScores +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|scores|Array of [HighScore](../types/HighScore.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [messages\_HighScores](../types/messages_HighScores.md) + + +### Example: + +``` +$messages_highScores = ['_' => 'messages.highScores', 'scores' => [HighScore, HighScore], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.highScores", "scores": [HighScore], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +messages_highScores={_='messages.highScores', scores={HighScore}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_messageEditData.md b/old_docs/API_docs_v81/constructors/messages_messageEditData.md new file mode 100644 index 00000000..aee6e179 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_messageEditData.md @@ -0,0 +1,43 @@ +--- +title: messages.messageEditData +description: messages_messageEditData attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.messageEditData +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|caption|[Bool](../types/Bool.md) | Optional| + + + +### Type: [messages\_MessageEditData](../types/messages_MessageEditData.md) + + +### Example: + +``` +$messages_messageEditData = ['_' => 'messages.messageEditData', 'caption' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.messageEditData", "caption": Bool} +``` + + +Or, if you're into Lua: + + +``` +messages_messageEditData={_='messages.messageEditData', caption=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_messages.md b/old_docs/API_docs_v81/constructors/messages_messages.md new file mode 100644 index 00000000..8aa7940d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_messages.md @@ -0,0 +1,45 @@ +--- +title: messages.messages +description: messages_messages attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.messages +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|messages|Array of [Message](../types/Message.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [messages\_Messages](../types/messages_Messages.md) + + +### Example: + +``` +$messages_messages = ['_' => 'messages.messages', 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.messages", "messages": [Message], "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +messages_messages={_='messages.messages', messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_messagesNotModified.md b/old_docs/API_docs_v81/constructors/messages_messagesNotModified.md new file mode 100644 index 00000000..524d4c6f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_messagesNotModified.md @@ -0,0 +1,43 @@ +--- +title: messages.messagesNotModified +description: messages_messagesNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.messagesNotModified +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|count|[int](../types/int.md) | Yes| + + + +### Type: [messages\_Messages](../types/messages_Messages.md) + + +### Example: + +``` +$messages_messagesNotModified = ['_' => 'messages.messagesNotModified', 'count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.messagesNotModified", "count": int} +``` + + +Or, if you're into Lua: + + +``` +messages_messagesNotModified={_='messages.messagesNotModified', count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_messagesSlice.md b/old_docs/API_docs_v81/constructors/messages_messagesSlice.md new file mode 100644 index 00000000..d83e0f5c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_messagesSlice.md @@ -0,0 +1,46 @@ +--- +title: messages.messagesSlice +description: messages_messagesSlice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.messagesSlice +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|count|[int](../types/int.md) | Yes| +|messages|Array of [Message](../types/Message.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [messages\_Messages](../types/messages_Messages.md) + + +### Example: + +``` +$messages_messagesSlice = ['_' => 'messages.messagesSlice', 'count' => int, 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.messagesSlice", "count": int, "messages": [Message], "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +messages_messagesSlice={_='messages.messagesSlice', count=int, messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_peerDialogs.md b/old_docs/API_docs_v81/constructors/messages_peerDialogs.md new file mode 100644 index 00000000..93601b21 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_peerDialogs.md @@ -0,0 +1,47 @@ +--- +title: messages.peerDialogs +description: messages_peerDialogs attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.peerDialogs +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|dialogs|Array of [Dialog](../types/Dialog.md) | Yes| +|messages|Array of [Message](../types/Message.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| +|state|[updates\_State](../types/updates_State.md) | Yes| + + + +### Type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) + + +### Example: + +``` +$messages_peerDialogs = ['_' => 'messages.peerDialogs', 'dialogs' => [Dialog, Dialog], 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User], 'state' => updates_State]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.peerDialogs", "dialogs": [Dialog], "messages": [Message], "chats": [Chat], "users": [User], "state": updates_State} +``` + + +Or, if you're into Lua: + + +``` +messages_peerDialogs={_='messages.peerDialogs', dialogs={Dialog}, messages={Message}, chats={Chat}, users={User}, state=updates_State} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_recentStickers.md b/old_docs/API_docs_v81/constructors/messages_recentStickers.md new file mode 100644 index 00000000..e4b01c29 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_recentStickers.md @@ -0,0 +1,46 @@ +--- +title: messages.recentStickers +description: messages_recentStickers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.recentStickers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|hash|[int](../types/int.md) | Yes| +|packs|Array of [StickerPack](../types/StickerPack.md) | Yes| +|stickers|Array of [Document](../types/Document.md) | Yes| +|dates|Array of [int](../types/int.md) | Yes| + + + +### Type: [messages\_RecentStickers](../types/messages_RecentStickers.md) + + +### Example: + +``` +$messages_recentStickers = ['_' => 'messages.recentStickers', 'hash' => int, 'packs' => [StickerPack, StickerPack], 'stickers' => [Document, Document], 'dates' => [int, int]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.recentStickers", "hash": int, "packs": [StickerPack], "stickers": [Document], "dates": [int]} +``` + + +Or, if you're into Lua: + + +``` +messages_recentStickers={_='messages.recentStickers', hash=int, packs={StickerPack}, stickers={Document}, dates={int}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_recentStickersNotModified.md b/old_docs/API_docs_v81/constructors/messages_recentStickersNotModified.md new file mode 100644 index 00000000..9bf964da --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_recentStickersNotModified.md @@ -0,0 +1,38 @@ +--- +title: messages.recentStickersNotModified +description: messages_recentStickersNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.recentStickersNotModified +[Back to constructors index](index.md) + + + + + + +### Type: [messages\_RecentStickers](../types/messages_RecentStickers.md) + + +### Example: + +``` +$messages_recentStickersNotModified = ['_' => 'messages.recentStickersNotModified']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.recentStickersNotModified"} +``` + + +Or, if you're into Lua: + + +``` +messages_recentStickersNotModified={_='messages.recentStickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_savedGifs.md b/old_docs/API_docs_v81/constructors/messages_savedGifs.md new file mode 100644 index 00000000..4a254ab5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_savedGifs.md @@ -0,0 +1,44 @@ +--- +title: messages.savedGifs +description: messages_savedGifs attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.savedGifs +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|hash|[int](../types/int.md) | Yes| +|gifs|Array of [Document](../types/Document.md) | Yes| + + + +### Type: [messages\_SavedGifs](../types/messages_SavedGifs.md) + + +### Example: + +``` +$messages_savedGifs = ['_' => 'messages.savedGifs', 'hash' => int, 'gifs' => [Document, Document]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.savedGifs", "hash": int, "gifs": [Document]} +``` + + +Or, if you're into Lua: + + +``` +messages_savedGifs={_='messages.savedGifs', hash=int, gifs={Document}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_savedGifsNotModified.md b/old_docs/API_docs_v81/constructors/messages_savedGifsNotModified.md new file mode 100644 index 00000000..65c17d0c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_savedGifsNotModified.md @@ -0,0 +1,38 @@ +--- +title: messages.savedGifsNotModified +description: messages_savedGifsNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.savedGifsNotModified +[Back to constructors index](index.md) + + + + + + +### Type: [messages\_SavedGifs](../types/messages_SavedGifs.md) + + +### Example: + +``` +$messages_savedGifsNotModified = ['_' => 'messages.savedGifsNotModified']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.savedGifsNotModified"} +``` + + +Or, if you're into Lua: + + +``` +messages_savedGifsNotModified={_='messages.savedGifsNotModified'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_sentEncryptedFile.md b/old_docs/API_docs_v81/constructors/messages_sentEncryptedFile.md new file mode 100644 index 00000000..bd4eb12c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_sentEncryptedFile.md @@ -0,0 +1,44 @@ +--- +title: messages.sentEncryptedFile +description: messages_sentEncryptedFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.sentEncryptedFile +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|date|[int](../types/int.md) | Yes| +|file|[EncryptedFile](../types/EncryptedFile.md) | Optional| + + + +### Type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) + + +### Example: + +``` +$messages_sentEncryptedFile = ['_' => 'messages.sentEncryptedFile', 'date' => int, 'file' => EncryptedFile]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.sentEncryptedFile", "date": int, "file": EncryptedFile} +``` + + +Or, if you're into Lua: + + +``` +messages_sentEncryptedFile={_='messages.sentEncryptedFile', date=int, file=EncryptedFile} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_sentEncryptedMessage.md b/old_docs/API_docs_v81/constructors/messages_sentEncryptedMessage.md new file mode 100644 index 00000000..78e609e8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_sentEncryptedMessage.md @@ -0,0 +1,43 @@ +--- +title: messages.sentEncryptedMessage +description: messages_sentEncryptedMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.sentEncryptedMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|date|[int](../types/int.md) | Yes| + + + +### Type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) + + +### Example: + +``` +$messages_sentEncryptedMessage = ['_' => 'messages.sentEncryptedMessage', 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.sentEncryptedMessage", "date": int} +``` + + +Or, if you're into Lua: + + +``` +messages_sentEncryptedMessage={_='messages.sentEncryptedMessage', date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_stickerSet.md b/old_docs/API_docs_v81/constructors/messages_stickerSet.md new file mode 100644 index 00000000..8e181855 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_stickerSet.md @@ -0,0 +1,45 @@ +--- +title: messages.stickerSet +description: messages_stickerSet attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.stickerSet +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|set|[StickerSet](../types/StickerSet.md) | Yes| +|packs|Array of [StickerPack](../types/StickerPack.md) | Yes| +|documents|Array of [Document](../types/Document.md) | Yes| + + + +### Type: [messages\_StickerSet](../types/messages_StickerSet.md) + + +### Example: + +``` +$messages_stickerSet = ['_' => 'messages.stickerSet', 'set' => StickerSet, 'packs' => [StickerPack, StickerPack], 'documents' => [Document, Document]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.stickerSet", "set": StickerSet, "packs": [StickerPack], "documents": [Document]} +``` + + +Or, if you're into Lua: + + +``` +messages_stickerSet={_='messages.stickerSet', set=StickerSet, packs={StickerPack}, documents={Document}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_stickerSetInstallResultArchive.md b/old_docs/API_docs_v81/constructors/messages_stickerSetInstallResultArchive.md new file mode 100644 index 00000000..2f66cfa0 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_stickerSetInstallResultArchive.md @@ -0,0 +1,43 @@ +--- +title: messages.stickerSetInstallResultArchive +description: messages_stickerSetInstallResultArchive attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.stickerSetInstallResultArchive +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes| + + + +### Type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) + + +### Example: + +``` +$messages_stickerSetInstallResultArchive = ['_' => 'messages.stickerSetInstallResultArchive', 'sets' => [StickerSetCovered, StickerSetCovered]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.stickerSetInstallResultArchive", "sets": [StickerSetCovered]} +``` + + +Or, if you're into Lua: + + +``` +messages_stickerSetInstallResultArchive={_='messages.stickerSetInstallResultArchive', sets={StickerSetCovered}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_stickerSetInstallResultSuccess.md b/old_docs/API_docs_v81/constructors/messages_stickerSetInstallResultSuccess.md new file mode 100644 index 00000000..ef5752a2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_stickerSetInstallResultSuccess.md @@ -0,0 +1,38 @@ +--- +title: messages.stickerSetInstallResultSuccess +description: messages_stickerSetInstallResultSuccess attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.stickerSetInstallResultSuccess +[Back to constructors index](index.md) + + + + + + +### Type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) + + +### Example: + +``` +$messages_stickerSetInstallResultSuccess = ['_' => 'messages.stickerSetInstallResultSuccess']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.stickerSetInstallResultSuccess"} +``` + + +Or, if you're into Lua: + + +``` +messages_stickerSetInstallResultSuccess={_='messages.stickerSetInstallResultSuccess'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_stickers.md b/old_docs/API_docs_v81/constructors/messages_stickers.md new file mode 100644 index 00000000..56860537 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_stickers.md @@ -0,0 +1,44 @@ +--- +title: messages.stickers +description: messages_stickers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.stickers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|hash|[int](../types/int.md) | Yes| +|stickers|Array of [Document](../types/Document.md) | Yes| + + + +### Type: [messages\_Stickers](../types/messages_Stickers.md) + + +### Example: + +``` +$messages_stickers = ['_' => 'messages.stickers', 'hash' => int, 'stickers' => [Document, Document]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.stickers", "hash": int, "stickers": [Document]} +``` + + +Or, if you're into Lua: + + +``` +messages_stickers={_='messages.stickers', hash=int, stickers={Document}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/messages_stickersNotModified.md b/old_docs/API_docs_v81/constructors/messages_stickersNotModified.md new file mode 100644 index 00000000..2e918053 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/messages_stickersNotModified.md @@ -0,0 +1,38 @@ +--- +title: messages.stickersNotModified +description: messages_stickersNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messages.stickersNotModified +[Back to constructors index](index.md) + + + + + + +### Type: [messages\_Stickers](../types/messages_Stickers.md) + + +### Example: + +``` +$messages_stickersNotModified = ['_' => 'messages.stickersNotModified']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "messages.stickersNotModified"} +``` + + +Or, if you're into Lua: + + +``` +messages_stickersNotModified={_='messages.stickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/nearestDc.md b/old_docs/API_docs_v81/constructors/nearestDc.md new file mode 100644 index 00000000..81b04edf --- /dev/null +++ b/old_docs/API_docs_v81/constructors/nearestDc.md @@ -0,0 +1,45 @@ +--- +title: nearestDc +description: nearestDc attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: nearestDc +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|country|[string](../types/string.md) | Yes| +|this\_dc|[int](../types/int.md) | Yes| +|nearest\_dc|[int](../types/int.md) | Yes| + + + +### Type: [NearestDc](../types/NearestDc.md) + + +### Example: + +``` +$nearestDc = ['_' => 'nearestDc', 'country' => 'string', 'this_dc' => int, 'nearest_dc' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "nearestDc", "country": "string", "this_dc": int, "nearest_dc": int} +``` + + +Or, if you're into Lua: + + +``` +nearestDc={_='nearestDc', country='string', this_dc=int, nearest_dc=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/notifyChats.md b/old_docs/API_docs_v81/constructors/notifyChats.md new file mode 100644 index 00000000..9360567a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/notifyChats.md @@ -0,0 +1,38 @@ +--- +title: notifyChats +description: notifyChats attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: notifyChats +[Back to constructors index](index.md) + + + + + + +### Type: [NotifyPeer](../types/NotifyPeer.md) + + +### Example: + +``` +$notifyChats = ['_' => 'notifyChats']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "notifyChats"} +``` + + +Or, if you're into Lua: + + +``` +notifyChats={_='notifyChats'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/notifyPeer.md b/old_docs/API_docs_v81/constructors/notifyPeer.md new file mode 100644 index 00000000..f8fd47ed --- /dev/null +++ b/old_docs/API_docs_v81/constructors/notifyPeer.md @@ -0,0 +1,43 @@ +--- +title: notifyPeer +description: notifyPeer attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: notifyPeer +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Peer](../types/Peer.md) | Yes| + + + +### Type: [NotifyPeer](../types/NotifyPeer.md) + + +### Example: + +``` +$notifyPeer = ['_' => 'notifyPeer', 'peer' => Peer]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "notifyPeer", "peer": Peer} +``` + + +Or, if you're into Lua: + + +``` +notifyPeer={_='notifyPeer', peer=Peer} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/notifyUsers.md b/old_docs/API_docs_v81/constructors/notifyUsers.md new file mode 100644 index 00000000..1aca50a2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/notifyUsers.md @@ -0,0 +1,38 @@ +--- +title: notifyUsers +description: notifyUsers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: notifyUsers +[Back to constructors index](index.md) + + + + + + +### Type: [NotifyPeer](../types/NotifyPeer.md) + + +### Example: + +``` +$notifyUsers = ['_' => 'notifyUsers']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "notifyUsers"} +``` + + +Or, if you're into Lua: + + +``` +notifyUsers={_='notifyUsers'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/null.md b/old_docs/API_docs_v81/constructors/null.md new file mode 100644 index 00000000..29862cf2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/null.md @@ -0,0 +1,9 @@ +--- +title: null +description: Represents a null value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# null +[Back to constructor index](index.md) + +Represents a `null` value. diff --git a/old_docs/API_docs_v81/constructors/pageBlockAnchor.md b/old_docs/API_docs_v81/constructors/pageBlockAnchor.md new file mode 100644 index 00000000..af7f7c2b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockAnchor.md @@ -0,0 +1,43 @@ +--- +title: pageBlockAnchor +description: pageBlockAnchor attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockAnchor +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|name|[string](../types/string.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockAnchor = ['_' => 'pageBlockAnchor', 'name' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockAnchor", "name": "string"} +``` + + +Or, if you're into Lua: + + +``` +pageBlockAnchor={_='pageBlockAnchor', name='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockAudio.md b/old_docs/API_docs_v81/constructors/pageBlockAudio.md new file mode 100644 index 00000000..5a7b97c0 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockAudio.md @@ -0,0 +1,44 @@ +--- +title: pageBlockAudio +description: pageBlockAudio attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockAudio +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|audio\_id|[long](../types/long.md) | Yes| +|caption|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockAudio = ['_' => 'pageBlockAudio', 'audio_id' => long, 'caption' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockAudio", "audio_id": long, "caption": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockAudio={_='pageBlockAudio', audio_id=long, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockAuthorDate.md b/old_docs/API_docs_v81/constructors/pageBlockAuthorDate.md new file mode 100644 index 00000000..4f746156 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockAuthorDate.md @@ -0,0 +1,44 @@ +--- +title: pageBlockAuthorDate +description: pageBlockAuthorDate attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockAuthorDate +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|author|[RichText](../types/RichText.md) | Yes| +|published\_date|[int](../types/int.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockAuthorDate = ['_' => 'pageBlockAuthorDate', 'author' => RichText, 'published_date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockAuthorDate", "author": RichText, "published_date": int} +``` + + +Or, if you're into Lua: + + +``` +pageBlockAuthorDate={_='pageBlockAuthorDate', author=RichText, published_date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockBlockquote.md b/old_docs/API_docs_v81/constructors/pageBlockBlockquote.md new file mode 100644 index 00000000..f78ad5bd --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockBlockquote.md @@ -0,0 +1,44 @@ +--- +title: pageBlockBlockquote +description: pageBlockBlockquote attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockBlockquote +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| +|caption|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockBlockquote = ['_' => 'pageBlockBlockquote', 'text' => RichText, 'caption' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockBlockquote", "text": RichText, "caption": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockBlockquote={_='pageBlockBlockquote', text=RichText, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockChannel.md b/old_docs/API_docs_v81/constructors/pageBlockChannel.md new file mode 100644 index 00000000..6cd78457 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockChannel.md @@ -0,0 +1,43 @@ +--- +title: pageBlockChannel +description: pageBlockChannel attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockChannel +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel|[Chat](../types/Chat.md) | Optional| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockChannel = ['_' => 'pageBlockChannel', 'channel' => Chat]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockChannel", "channel": Chat} +``` + + +Or, if you're into Lua: + + +``` +pageBlockChannel={_='pageBlockChannel', channel=Chat} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockCollage.md b/old_docs/API_docs_v81/constructors/pageBlockCollage.md new file mode 100644 index 00000000..45bdee72 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockCollage.md @@ -0,0 +1,44 @@ +--- +title: pageBlockCollage +description: pageBlockCollage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockCollage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|items|Array of [PageBlock](../types/PageBlock.md) | Yes| +|caption|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockCollage = ['_' => 'pageBlockCollage', 'items' => [PageBlock, PageBlock], 'caption' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockCollage", "items": [PageBlock], "caption": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockCollage={_='pageBlockCollage', items={PageBlock}, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockCover.md b/old_docs/API_docs_v81/constructors/pageBlockCover.md new file mode 100644 index 00000000..8e8db49e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockCover.md @@ -0,0 +1,43 @@ +--- +title: pageBlockCover +description: pageBlockCover attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockCover +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|cover|[PageBlock](../types/PageBlock.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockCover = ['_' => 'pageBlockCover', 'cover' => PageBlock]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockCover", "cover": PageBlock} +``` + + +Or, if you're into Lua: + + +``` +pageBlockCover={_='pageBlockCover', cover=PageBlock} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockDivider.md b/old_docs/API_docs_v81/constructors/pageBlockDivider.md new file mode 100644 index 00000000..5f444cce --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockDivider.md @@ -0,0 +1,38 @@ +--- +title: pageBlockDivider +description: pageBlockDivider attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockDivider +[Back to constructors index](index.md) + + + + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockDivider = ['_' => 'pageBlockDivider']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockDivider"} +``` + + +Or, if you're into Lua: + + +``` +pageBlockDivider={_='pageBlockDivider'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockEmbed.md b/old_docs/API_docs_v81/constructors/pageBlockEmbed.md new file mode 100644 index 00000000..3e508369 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockEmbed.md @@ -0,0 +1,50 @@ +--- +title: pageBlockEmbed +description: pageBlockEmbed attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockEmbed +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|full\_width|[Bool](../types/Bool.md) | Optional| +|allow\_scrolling|[Bool](../types/Bool.md) | Optional| +|url|[string](../types/string.md) | Optional| +|html|[string](../types/string.md) | Optional| +|poster\_photo\_id|[long](../types/long.md) | Optional| +|w|[int](../types/int.md) | Yes| +|h|[int](../types/int.md) | Yes| +|caption|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockEmbed = ['_' => 'pageBlockEmbed', 'full_width' => Bool, 'allow_scrolling' => Bool, 'url' => 'string', 'html' => 'string', 'poster_photo_id' => long, 'w' => int, 'h' => int, 'caption' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockEmbed", "full_width": Bool, "allow_scrolling": Bool, "url": "string", "html": "string", "poster_photo_id": long, "w": int, "h": int, "caption": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockEmbed={_='pageBlockEmbed', full_width=Bool, allow_scrolling=Bool, url='string', html='string', poster_photo_id=long, w=int, h=int, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockEmbedPost.md b/old_docs/API_docs_v81/constructors/pageBlockEmbedPost.md new file mode 100644 index 00000000..24c622e6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockEmbedPost.md @@ -0,0 +1,49 @@ +--- +title: pageBlockEmbedPost +description: pageBlockEmbedPost attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockEmbedPost +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|webpage\_id|[long](../types/long.md) | Yes| +|author\_photo\_id|[long](../types/long.md) | Yes| +|author|[string](../types/string.md) | Yes| +|date|[int](../types/int.md) | Yes| +|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes| +|caption|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockEmbedPost = ['_' => 'pageBlockEmbedPost', 'url' => 'string', 'webpage_id' => long, 'author_photo_id' => long, 'author' => 'string', 'date' => int, 'blocks' => [PageBlock, PageBlock], 'caption' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockEmbedPost", "url": "string", "webpage_id": long, "author_photo_id": long, "author": "string", "date": int, "blocks": [PageBlock], "caption": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockEmbedPost={_='pageBlockEmbedPost', url='string', webpage_id=long, author_photo_id=long, author='string', date=int, blocks={PageBlock}, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockFooter.md b/old_docs/API_docs_v81/constructors/pageBlockFooter.md new file mode 100644 index 00000000..3caeb971 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockFooter.md @@ -0,0 +1,43 @@ +--- +title: pageBlockFooter +description: pageBlockFooter attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockFooter +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockFooter = ['_' => 'pageBlockFooter', 'text' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockFooter", "text": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockFooter={_='pageBlockFooter', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockHeader.md b/old_docs/API_docs_v81/constructors/pageBlockHeader.md new file mode 100644 index 00000000..950037d0 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockHeader.md @@ -0,0 +1,43 @@ +--- +title: pageBlockHeader +description: pageBlockHeader attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockHeader +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockHeader = ['_' => 'pageBlockHeader', 'text' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockHeader", "text": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockHeader={_='pageBlockHeader', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockList.md b/old_docs/API_docs_v81/constructors/pageBlockList.md new file mode 100644 index 00000000..37371b18 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockList.md @@ -0,0 +1,44 @@ +--- +title: pageBlockList +description: pageBlockList attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockList +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|ordered|[Bool](../types/Bool.md) | Yes| +|items|Array of [RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockList = ['_' => 'pageBlockList', 'ordered' => Bool, 'items' => [RichText, RichText]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockList", "ordered": Bool, "items": [RichText]} +``` + + +Or, if you're into Lua: + + +``` +pageBlockList={_='pageBlockList', ordered=Bool, items={RichText}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockParagraph.md b/old_docs/API_docs_v81/constructors/pageBlockParagraph.md new file mode 100644 index 00000000..6b22950e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockParagraph.md @@ -0,0 +1,43 @@ +--- +title: pageBlockParagraph +description: pageBlockParagraph attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockParagraph +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockParagraph = ['_' => 'pageBlockParagraph', 'text' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockParagraph", "text": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockParagraph={_='pageBlockParagraph', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockPhoto.md b/old_docs/API_docs_v81/constructors/pageBlockPhoto.md new file mode 100644 index 00000000..e80e16f4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockPhoto.md @@ -0,0 +1,44 @@ +--- +title: pageBlockPhoto +description: pageBlockPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|photo\_id|[long](../types/long.md) | Yes| +|caption|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockPhoto = ['_' => 'pageBlockPhoto', 'photo_id' => long, 'caption' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockPhoto", "photo_id": long, "caption": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockPhoto={_='pageBlockPhoto', photo_id=long, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockPreformatted.md b/old_docs/API_docs_v81/constructors/pageBlockPreformatted.md new file mode 100644 index 00000000..49cb8b08 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockPreformatted.md @@ -0,0 +1,44 @@ +--- +title: pageBlockPreformatted +description: pageBlockPreformatted attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockPreformatted +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| +|language|[string](../types/string.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockPreformatted = ['_' => 'pageBlockPreformatted', 'text' => RichText, 'language' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockPreformatted", "text": RichText, "language": "string"} +``` + + +Or, if you're into Lua: + + +``` +pageBlockPreformatted={_='pageBlockPreformatted', text=RichText, language='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockPullquote.md b/old_docs/API_docs_v81/constructors/pageBlockPullquote.md new file mode 100644 index 00000000..d73389da --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockPullquote.md @@ -0,0 +1,44 @@ +--- +title: pageBlockPullquote +description: pageBlockPullquote attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockPullquote +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| +|caption|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockPullquote = ['_' => 'pageBlockPullquote', 'text' => RichText, 'caption' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockPullquote", "text": RichText, "caption": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockPullquote={_='pageBlockPullquote', text=RichText, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockSlideshow.md b/old_docs/API_docs_v81/constructors/pageBlockSlideshow.md new file mode 100644 index 00000000..d855e4d8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockSlideshow.md @@ -0,0 +1,44 @@ +--- +title: pageBlockSlideshow +description: pageBlockSlideshow attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockSlideshow +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|items|Array of [PageBlock](../types/PageBlock.md) | Yes| +|caption|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockSlideshow = ['_' => 'pageBlockSlideshow', 'items' => [PageBlock, PageBlock], 'caption' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockSlideshow", "items": [PageBlock], "caption": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockSlideshow={_='pageBlockSlideshow', items={PageBlock}, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockSubheader.md b/old_docs/API_docs_v81/constructors/pageBlockSubheader.md new file mode 100644 index 00000000..6b6a332e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockSubheader.md @@ -0,0 +1,43 @@ +--- +title: pageBlockSubheader +description: pageBlockSubheader attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockSubheader +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockSubheader = ['_' => 'pageBlockSubheader', 'text' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockSubheader", "text": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockSubheader={_='pageBlockSubheader', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockSubtitle.md b/old_docs/API_docs_v81/constructors/pageBlockSubtitle.md new file mode 100644 index 00000000..017112c2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockSubtitle.md @@ -0,0 +1,43 @@ +--- +title: pageBlockSubtitle +description: pageBlockSubtitle attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockSubtitle +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockSubtitle = ['_' => 'pageBlockSubtitle', 'text' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockSubtitle", "text": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockSubtitle={_='pageBlockSubtitle', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockTitle.md b/old_docs/API_docs_v81/constructors/pageBlockTitle.md new file mode 100644 index 00000000..9dfe94d2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockTitle.md @@ -0,0 +1,43 @@ +--- +title: pageBlockTitle +description: pageBlockTitle attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockTitle +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockTitle = ['_' => 'pageBlockTitle', 'text' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockTitle", "text": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockTitle={_='pageBlockTitle', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockUnsupported.md b/old_docs/API_docs_v81/constructors/pageBlockUnsupported.md new file mode 100644 index 00000000..8d127c6d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockUnsupported.md @@ -0,0 +1,38 @@ +--- +title: pageBlockUnsupported +description: pageBlockUnsupported attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockUnsupported +[Back to constructors index](index.md) + + + + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockUnsupported = ['_' => 'pageBlockUnsupported']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockUnsupported"} +``` + + +Or, if you're into Lua: + + +``` +pageBlockUnsupported={_='pageBlockUnsupported'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageBlockVideo.md b/old_docs/API_docs_v81/constructors/pageBlockVideo.md new file mode 100644 index 00000000..03a04d1b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageBlockVideo.md @@ -0,0 +1,46 @@ +--- +title: pageBlockVideo +description: pageBlockVideo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockVideo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|autoplay|[Bool](../types/Bool.md) | Optional| +|loop|[Bool](../types/Bool.md) | Optional| +|video\_id|[long](../types/long.md) | Yes| +|caption|[RichText](../types/RichText.md) | Yes| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +``` +$pageBlockVideo = ['_' => 'pageBlockVideo', 'autoplay' => Bool, 'loop' => Bool, 'video_id' => long, 'caption' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageBlockVideo", "autoplay": Bool, "loop": Bool, "video_id": long, "caption": RichText} +``` + + +Or, if you're into Lua: + + +``` +pageBlockVideo={_='pageBlockVideo', autoplay=Bool, loop=Bool, video_id=long, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pageFull.md b/old_docs/API_docs_v81/constructors/pageFull.md new file mode 100644 index 00000000..493f1403 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pageFull.md @@ -0,0 +1,45 @@ +--- +title: pageFull +description: pageFull attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageFull +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes| +|photos|Array of [Photo](../types/Photo.md) | Yes| +|documents|Array of [Document](../types/Document.md) | Yes| + + + +### Type: [Page](../types/Page.md) + + +### Example: + +``` +$pageFull = ['_' => 'pageFull', 'blocks' => [PageBlock, PageBlock], 'photos' => [Photo, Photo], 'documents' => [Document, Document]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pageFull", "blocks": [PageBlock], "photos": [Photo], "documents": [Document]} +``` + + +Or, if you're into Lua: + + +``` +pageFull={_='pageFull', blocks={PageBlock}, photos={Photo}, documents={Document}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/pagePart.md b/old_docs/API_docs_v81/constructors/pagePart.md new file mode 100644 index 00000000..3e2261ef --- /dev/null +++ b/old_docs/API_docs_v81/constructors/pagePart.md @@ -0,0 +1,45 @@ +--- +title: pagePart +description: pagePart attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pagePart +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes| +|photos|Array of [Photo](../types/Photo.md) | Yes| +|documents|Array of [Document](../types/Document.md) | Yes| + + + +### Type: [Page](../types/Page.md) + + +### Example: + +``` +$pagePart = ['_' => 'pagePart', 'blocks' => [PageBlock, PageBlock], 'photos' => [Photo, Photo], 'documents' => [Document, Document]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "pagePart", "blocks": [PageBlock], "photos": [Photo], "documents": [Document]} +``` + + +Or, if you're into Lua: + + +``` +pagePart={_='pagePart', blocks={PageBlock}, photos={Photo}, documents={Document}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/paymentCharge.md b/old_docs/API_docs_v81/constructors/paymentCharge.md new file mode 100644 index 00000000..83a0d433 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/paymentCharge.md @@ -0,0 +1,44 @@ +--- +title: paymentCharge +description: paymentCharge attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: paymentCharge +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[string](../types/string.md) | Yes| +|provider\_charge\_id|[string](../types/string.md) | Yes| + + + +### Type: [PaymentCharge](../types/PaymentCharge.md) + + +### Example: + +``` +$paymentCharge = ['_' => 'paymentCharge', 'id' => 'string', 'provider_charge_id' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "paymentCharge", "id": "string", "provider_charge_id": "string"} +``` + + +Or, if you're into Lua: + + +``` +paymentCharge={_='paymentCharge', id='string', provider_charge_id='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/paymentRequestedInfo.md b/old_docs/API_docs_v81/constructors/paymentRequestedInfo.md new file mode 100644 index 00000000..e4b6562a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/paymentRequestedInfo.md @@ -0,0 +1,46 @@ +--- +title: paymentRequestedInfo +description: paymentRequestedInfo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: paymentRequestedInfo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|name|[string](../types/string.md) | Optional| +|phone|[string](../types/string.md) | Optional| +|email|[string](../types/string.md) | Optional| +|shipping\_address|[PostAddress](../types/PostAddress.md) | Optional| + + + +### Type: [PaymentRequestedInfo](../types/PaymentRequestedInfo.md) + + +### Example: + +``` +$paymentRequestedInfo = ['_' => 'paymentRequestedInfo', 'name' => 'string', 'phone' => 'string', 'email' => 'string', 'shipping_address' => PostAddress]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "paymentRequestedInfo", "name": "string", "phone": "string", "email": "string", "shipping_address": PostAddress} +``` + + +Or, if you're into Lua: + + +``` +paymentRequestedInfo={_='paymentRequestedInfo', name='string', phone='string', email='string', shipping_address=PostAddress} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/paymentSavedCredentialsCard.md b/old_docs/API_docs_v81/constructors/paymentSavedCredentialsCard.md new file mode 100644 index 00000000..6fc4e934 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/paymentSavedCredentialsCard.md @@ -0,0 +1,44 @@ +--- +title: paymentSavedCredentialsCard +description: paymentSavedCredentialsCard attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: paymentSavedCredentialsCard +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[string](../types/string.md) | Yes| +|title|[string](../types/string.md) | Yes| + + + +### Type: [PaymentSavedCredentials](../types/PaymentSavedCredentials.md) + + +### Example: + +``` +$paymentSavedCredentialsCard = ['_' => 'paymentSavedCredentialsCard', 'id' => 'string', 'title' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "paymentSavedCredentialsCard", "id": "string", "title": "string"} +``` + + +Or, if you're into Lua: + + +``` +paymentSavedCredentialsCard={_='paymentSavedCredentialsCard', id='string', title='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/payments_paymentForm.md b/old_docs/API_docs_v81/constructors/payments_paymentForm.md new file mode 100644 index 00000000..74cca6f4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/payments_paymentForm.md @@ -0,0 +1,53 @@ +--- +title: payments.paymentForm +description: payments_paymentForm attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: payments.paymentForm +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|can\_save\_credentials|[Bool](../types/Bool.md) | Optional| +|password\_missing|[Bool](../types/Bool.md) | Optional| +|bot\_id|[int](../types/int.md) | Yes| +|invoice|[Invoice](../types/Invoice.md) | Yes| +|provider\_id|[int](../types/int.md) | Yes| +|url|[string](../types/string.md) | Yes| +|native\_provider|[string](../types/string.md) | Optional| +|native\_params|[DataJSON](../types/DataJSON.md) | Optional| +|saved\_info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional| +|saved\_credentials|[PaymentSavedCredentials](../types/PaymentSavedCredentials.md) | Optional| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [payments\_PaymentForm](../types/payments_PaymentForm.md) + + +### Example: + +``` +$payments_paymentForm = ['_' => 'payments.paymentForm', 'can_save_credentials' => Bool, 'password_missing' => Bool, 'bot_id' => int, 'invoice' => Invoice, 'provider_id' => int, 'url' => 'string', 'native_provider' => 'string', 'native_params' => DataJSON, 'saved_info' => PaymentRequestedInfo, 'saved_credentials' => PaymentSavedCredentials, 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "payments.paymentForm", "can_save_credentials": Bool, "password_missing": Bool, "bot_id": int, "invoice": Invoice, "provider_id": int, "url": "string", "native_provider": "string", "native_params": DataJSON, "saved_info": PaymentRequestedInfo, "saved_credentials": PaymentSavedCredentials, "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +payments_paymentForm={_='payments.paymentForm', can_save_credentials=Bool, password_missing=Bool, bot_id=int, invoice=Invoice, provider_id=int, url='string', native_provider='string', native_params=DataJSON, saved_info=PaymentRequestedInfo, saved_credentials=PaymentSavedCredentials, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/payments_paymentReceipt.md b/old_docs/API_docs_v81/constructors/payments_paymentReceipt.md new file mode 100644 index 00000000..fdf741b4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/payments_paymentReceipt.md @@ -0,0 +1,52 @@ +--- +title: payments.paymentReceipt +description: payments_paymentReceipt attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: payments.paymentReceipt +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|date|[int](../types/int.md) | Yes| +|bot\_id|[int](../types/int.md) | Yes| +|invoice|[Invoice](../types/Invoice.md) | Yes| +|provider\_id|[int](../types/int.md) | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional| +|shipping|[ShippingOption](../types/ShippingOption.md) | Optional| +|currency|[string](../types/string.md) | Yes| +|total\_amount|[long](../types/long.md) | Yes| +|credentials\_title|[string](../types/string.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) + + +### Example: + +``` +$payments_paymentReceipt = ['_' => 'payments.paymentReceipt', 'date' => int, 'bot_id' => int, 'invoice' => Invoice, 'provider_id' => int, 'info' => PaymentRequestedInfo, 'shipping' => ShippingOption, 'currency' => 'string', 'total_amount' => long, 'credentials_title' => 'string', 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "payments.paymentReceipt", "date": int, "bot_id": int, "invoice": Invoice, "provider_id": int, "info": PaymentRequestedInfo, "shipping": ShippingOption, "currency": "string", "total_amount": long, "credentials_title": "string", "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +payments_paymentReceipt={_='payments.paymentReceipt', date=int, bot_id=int, invoice=Invoice, provider_id=int, info=PaymentRequestedInfo, shipping=ShippingOption, currency='string', total_amount=long, credentials_title='string', users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/payments_paymentResult.md b/old_docs/API_docs_v81/constructors/payments_paymentResult.md new file mode 100644 index 00000000..7ae00170 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/payments_paymentResult.md @@ -0,0 +1,43 @@ +--- +title: payments.paymentResult +description: payments_paymentResult attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: payments.paymentResult +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|updates|[Updates](../types/Updates.md) | Yes| + + + +### Type: [payments\_PaymentResult](../types/payments_PaymentResult.md) + + +### Example: + +``` +$payments_paymentResult = ['_' => 'payments.paymentResult', 'updates' => Updates]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "payments.paymentResult", "updates": Updates} +``` + + +Or, if you're into Lua: + + +``` +payments_paymentResult={_='payments.paymentResult', updates=Updates} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/payments_paymentVerficationNeeded.md b/old_docs/API_docs_v81/constructors/payments_paymentVerficationNeeded.md new file mode 100644 index 00000000..4a3f8cdf --- /dev/null +++ b/old_docs/API_docs_v81/constructors/payments_paymentVerficationNeeded.md @@ -0,0 +1,43 @@ +--- +title: payments.paymentVerficationNeeded +description: payments_paymentVerficationNeeded attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: payments.paymentVerficationNeeded +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| + + + +### Type: [payments\_PaymentResult](../types/payments_PaymentResult.md) + + +### Example: + +``` +$payments_paymentVerficationNeeded = ['_' => 'payments.paymentVerficationNeeded', 'url' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "payments.paymentVerficationNeeded", "url": "string"} +``` + + +Or, if you're into Lua: + + +``` +payments_paymentVerficationNeeded={_='payments.paymentVerficationNeeded', url='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/payments_savedInfo.md b/old_docs/API_docs_v81/constructors/payments_savedInfo.md new file mode 100644 index 00000000..3daf671f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/payments_savedInfo.md @@ -0,0 +1,44 @@ +--- +title: payments.savedInfo +description: payments_savedInfo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: payments.savedInfo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|has\_saved\_credentials|[Bool](../types/Bool.md) | Optional| +|saved\_info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional| + + + +### Type: [payments\_SavedInfo](../types/payments_SavedInfo.md) + + +### Example: + +``` +$payments_savedInfo = ['_' => 'payments.savedInfo', 'has_saved_credentials' => Bool, 'saved_info' => PaymentRequestedInfo]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "payments.savedInfo", "has_saved_credentials": Bool, "saved_info": PaymentRequestedInfo} +``` + + +Or, if you're into Lua: + + +``` +payments_savedInfo={_='payments.savedInfo', has_saved_credentials=Bool, saved_info=PaymentRequestedInfo} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/payments_validatedRequestedInfo.md b/old_docs/API_docs_v81/constructors/payments_validatedRequestedInfo.md new file mode 100644 index 00000000..676388b7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/payments_validatedRequestedInfo.md @@ -0,0 +1,44 @@ +--- +title: payments.validatedRequestedInfo +description: payments_validatedRequestedInfo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: payments.validatedRequestedInfo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[string](../types/string.md) | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional| + + + +### Type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) + + +### Example: + +``` +$payments_validatedRequestedInfo = ['_' => 'payments.validatedRequestedInfo', 'id' => 'string', 'shipping_options' => [ShippingOption, ShippingOption]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "payments.validatedRequestedInfo", "id": "string", "shipping_options": [ShippingOption]} +``` + + +Or, if you're into Lua: + + +``` +payments_validatedRequestedInfo={_='payments.validatedRequestedInfo', id='string', shipping_options={ShippingOption}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/peerChannel.md b/old_docs/API_docs_v81/constructors/peerChannel.md new file mode 100644 index 00000000..f30e3f41 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/peerChannel.md @@ -0,0 +1,43 @@ +--- +title: peerChannel +description: peerChannel attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerChannel +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| + + + +### Type: [Peer](../types/Peer.md) + + +### Example: + +``` +$peerChannel = ['_' => 'peerChannel', 'channel_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "peerChannel", "channel_id": int} +``` + + +Or, if you're into Lua: + + +``` +peerChannel={_='peerChannel', channel_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/peerChat.md b/old_docs/API_docs_v81/constructors/peerChat.md new file mode 100644 index 00000000..eb6682f2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/peerChat.md @@ -0,0 +1,43 @@ +--- +title: peerChat +description: peerChat attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerChat +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| + + + +### Type: [Peer](../types/Peer.md) + + +### Example: + +``` +$peerChat = ['_' => 'peerChat', 'chat_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "peerChat", "chat_id": int} +``` + + +Or, if you're into Lua: + + +``` +peerChat={_='peerChat', chat_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/peerNotifySettings.md b/old_docs/API_docs_v81/constructors/peerNotifySettings.md new file mode 100644 index 00000000..c761b48a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/peerNotifySettings.md @@ -0,0 +1,46 @@ +--- +title: peerNotifySettings +description: peerNotifySettings attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerNotifySettings +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|show\_previews|[Bool](../types/Bool.md) | Optional| +|silent|[Bool](../types/Bool.md) | Optional| +|mute\_until|[int](../types/int.md) | Optional| +|sound|[string](../types/string.md) | Optional| + + + +### Type: [PeerNotifySettings](../types/PeerNotifySettings.md) + + +### Example: + +``` +$peerNotifySettings = ['_' => 'peerNotifySettings', 'show_previews' => Bool, 'silent' => Bool, 'mute_until' => int, 'sound' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "peerNotifySettings", "show_previews": Bool, "silent": Bool, "mute_until": int, "sound": "string"} +``` + + +Or, if you're into Lua: + + +``` +peerNotifySettings={_='peerNotifySettings', show_previews=Bool, silent=Bool, mute_until=int, sound='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/peerSettings.md b/old_docs/API_docs_v81/constructors/peerSettings.md new file mode 100644 index 00000000..8f74bb50 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/peerSettings.md @@ -0,0 +1,43 @@ +--- +title: peerSettings +description: peerSettings attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerSettings +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|report\_spam|[Bool](../types/Bool.md) | Optional| + + + +### Type: [PeerSettings](../types/PeerSettings.md) + + +### Example: + +``` +$peerSettings = ['_' => 'peerSettings', 'report_spam' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "peerSettings", "report_spam": Bool} +``` + + +Or, if you're into Lua: + + +``` +peerSettings={_='peerSettings', report_spam=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/peerUser.md b/old_docs/API_docs_v81/constructors/peerUser.md new file mode 100644 index 00000000..52922c9d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/peerUser.md @@ -0,0 +1,43 @@ +--- +title: peerUser +description: peerUser attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerUser +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| + + + +### Type: [Peer](../types/Peer.md) + + +### Example: + +``` +$peerUser = ['_' => 'peerUser', 'user_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "peerUser", "user_id": int} +``` + + +Or, if you're into Lua: + + +``` +peerUser={_='peerUser', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneCall.md b/old_docs/API_docs_v81/constructors/phoneCall.md new file mode 100644 index 00000000..8104b557 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneCall.md @@ -0,0 +1,53 @@ +--- +title: phoneCall +description: phoneCall attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCall +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|date|[int](../types/int.md) | Yes| +|admin\_id|[int](../types/int.md) | Yes| +|participant\_id|[int](../types/int.md) | Yes| +|g\_a\_or\_b|[bytes](../types/bytes.md) | Yes| +|key\_fingerprint|[long](../types/long.md) | Yes| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes| +|connection|[PhoneConnection](../types/PhoneConnection.md) | Yes| +|alternative\_connections|Array of [PhoneConnection](../types/PhoneConnection.md) | Yes| +|start\_date|[int](../types/int.md) | Yes| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +``` +$phoneCall = ['_' => 'phoneCall', 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a_or_b' => 'bytes', 'key_fingerprint' => long, 'protocol' => PhoneCallProtocol, 'connection' => PhoneConnection, 'alternative_connections' => [PhoneConnection, PhoneConnection], 'start_date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneCall", "id": long, "access_hash": long, "date": int, "admin_id": int, "participant_id": int, "g_a_or_b": {"_": "bytes", "bytes":"base64 encoded bytes"}, "key_fingerprint": long, "protocol": PhoneCallProtocol, "connection": PhoneConnection, "alternative_connections": [PhoneConnection], "start_date": int} +``` + + +Or, if you're into Lua: + + +``` +phoneCall={_='phoneCall', id=long, access_hash=long, date=int, admin_id=int, participant_id=int, g_a_or_b='bytes', key_fingerprint=long, protocol=PhoneCallProtocol, connection=PhoneConnection, alternative_connections={PhoneConnection}, start_date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneCallAccepted.md b/old_docs/API_docs_v81/constructors/phoneCallAccepted.md new file mode 100644 index 00000000..cae97485 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneCallAccepted.md @@ -0,0 +1,49 @@ +--- +title: phoneCallAccepted +description: phoneCallAccepted attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallAccepted +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|date|[int](../types/int.md) | Yes| +|admin\_id|[int](../types/int.md) | Yes| +|participant\_id|[int](../types/int.md) | Yes| +|g\_b|[bytes](../types/bytes.md) | Yes| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +``` +$phoneCallAccepted = ['_' => 'phoneCallAccepted', 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_b' => 'bytes', 'protocol' => PhoneCallProtocol]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneCallAccepted", "id": long, "access_hash": long, "date": int, "admin_id": int, "participant_id": int, "g_b": {"_": "bytes", "bytes":"base64 encoded bytes"}, "protocol": PhoneCallProtocol} +``` + + +Or, if you're into Lua: + + +``` +phoneCallAccepted={_='phoneCallAccepted', id=long, access_hash=long, date=int, admin_id=int, participant_id=int, g_b='bytes', protocol=PhoneCallProtocol} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonBusy.md b/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonBusy.md new file mode 100644 index 00000000..10d47acd --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonBusy.md @@ -0,0 +1,38 @@ +--- +title: phoneCallDiscardReasonBusy +description: phoneCallDiscardReasonBusy attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonBusy +[Back to constructors index](index.md) + + + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +``` +$phoneCallDiscardReasonBusy = ['_' => 'phoneCallDiscardReasonBusy']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneCallDiscardReasonBusy"} +``` + + +Or, if you're into Lua: + + +``` +phoneCallDiscardReasonBusy={_='phoneCallDiscardReasonBusy'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonDisconnect.md b/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonDisconnect.md new file mode 100644 index 00000000..b059c909 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonDisconnect.md @@ -0,0 +1,38 @@ +--- +title: phoneCallDiscardReasonDisconnect +description: phoneCallDiscardReasonDisconnect attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonDisconnect +[Back to constructors index](index.md) + + + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +``` +$phoneCallDiscardReasonDisconnect = ['_' => 'phoneCallDiscardReasonDisconnect']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneCallDiscardReasonDisconnect"} +``` + + +Or, if you're into Lua: + + +``` +phoneCallDiscardReasonDisconnect={_='phoneCallDiscardReasonDisconnect'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonHangup.md b/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonHangup.md new file mode 100644 index 00000000..8e6e311c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonHangup.md @@ -0,0 +1,38 @@ +--- +title: phoneCallDiscardReasonHangup +description: phoneCallDiscardReasonHangup attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonHangup +[Back to constructors index](index.md) + + + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +``` +$phoneCallDiscardReasonHangup = ['_' => 'phoneCallDiscardReasonHangup']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneCallDiscardReasonHangup"} +``` + + +Or, if you're into Lua: + + +``` +phoneCallDiscardReasonHangup={_='phoneCallDiscardReasonHangup'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonMissed.md b/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonMissed.md new file mode 100644 index 00000000..b8199e88 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneCallDiscardReasonMissed.md @@ -0,0 +1,38 @@ +--- +title: phoneCallDiscardReasonMissed +description: phoneCallDiscardReasonMissed attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonMissed +[Back to constructors index](index.md) + + + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +``` +$phoneCallDiscardReasonMissed = ['_' => 'phoneCallDiscardReasonMissed']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneCallDiscardReasonMissed"} +``` + + +Or, if you're into Lua: + + +``` +phoneCallDiscardReasonMissed={_='phoneCallDiscardReasonMissed'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneCallDiscarded.md b/old_docs/API_docs_v81/constructors/phoneCallDiscarded.md new file mode 100644 index 00000000..69fd1caa --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneCallDiscarded.md @@ -0,0 +1,47 @@ +--- +title: phoneCallDiscarded +description: phoneCallDiscarded attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscarded +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|need\_rating|[Bool](../types/Bool.md) | Optional| +|need\_debug|[Bool](../types/Bool.md) | Optional| +|id|[long](../types/long.md) | Yes| +|reason|[PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) | Optional| +|duration|[int](../types/int.md) | Optional| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +``` +$phoneCallDiscarded = ['_' => 'phoneCallDiscarded', 'need_rating' => Bool, 'need_debug' => Bool, 'id' => long, 'reason' => PhoneCallDiscardReason, 'duration' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneCallDiscarded", "need_rating": Bool, "need_debug": Bool, "id": long, "reason": PhoneCallDiscardReason, "duration": int} +``` + + +Or, if you're into Lua: + + +``` +phoneCallDiscarded={_='phoneCallDiscarded', need_rating=Bool, need_debug=Bool, id=long, reason=PhoneCallDiscardReason, duration=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneCallEmpty.md b/old_docs/API_docs_v81/constructors/phoneCallEmpty.md new file mode 100644 index 00000000..cfb8125b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneCallEmpty.md @@ -0,0 +1,43 @@ +--- +title: phoneCallEmpty +description: phoneCallEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +``` +$phoneCallEmpty = ['_' => 'phoneCallEmpty', 'id' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneCallEmpty", "id": long} +``` + + +Or, if you're into Lua: + + +``` +phoneCallEmpty={_='phoneCallEmpty', id=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneCallProtocol.md b/old_docs/API_docs_v81/constructors/phoneCallProtocol.md new file mode 100644 index 00000000..9f0e2eed --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneCallProtocol.md @@ -0,0 +1,46 @@ +--- +title: phoneCallProtocol +description: phoneCallProtocol attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallProtocol +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|udp\_p2p|[Bool](../types/Bool.md) | Optional| +|udp\_reflector|[Bool](../types/Bool.md) | Optional| +|min\_layer|[int](../types/int.md) | Yes| +|max\_layer|[int](../types/int.md) | Yes| + + + +### Type: [PhoneCallProtocol](../types/PhoneCallProtocol.md) + + +### Example: + +``` +$phoneCallProtocol = ['_' => 'phoneCallProtocol', 'udp_p2p' => Bool, 'udp_reflector' => Bool, 'min_layer' => int, 'max_layer' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneCallProtocol", "udp_p2p": Bool, "udp_reflector": Bool, "min_layer": int, "max_layer": int} +``` + + +Or, if you're into Lua: + + +``` +phoneCallProtocol={_='phoneCallProtocol', udp_p2p=Bool, udp_reflector=Bool, min_layer=int, max_layer=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneCallRequested.md b/old_docs/API_docs_v81/constructors/phoneCallRequested.md new file mode 100644 index 00000000..c96f398f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneCallRequested.md @@ -0,0 +1,49 @@ +--- +title: phoneCallRequested +description: phoneCallRequested attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallRequested +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|date|[int](../types/int.md) | Yes| +|admin\_id|[int](../types/int.md) | Yes| +|participant\_id|[int](../types/int.md) | Yes| +|g\_a\_hash|[bytes](../types/bytes.md) | Yes| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +``` +$phoneCallRequested = ['_' => 'phoneCallRequested', 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a_hash' => 'bytes', 'protocol' => PhoneCallProtocol]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneCallRequested", "id": long, "access_hash": long, "date": int, "admin_id": int, "participant_id": int, "g_a_hash": {"_": "bytes", "bytes":"base64 encoded bytes"}, "protocol": PhoneCallProtocol} +``` + + +Or, if you're into Lua: + + +``` +phoneCallRequested={_='phoneCallRequested', id=long, access_hash=long, date=int, admin_id=int, participant_id=int, g_a_hash='bytes', protocol=PhoneCallProtocol} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneCallWaiting.md b/old_docs/API_docs_v81/constructors/phoneCallWaiting.md new file mode 100644 index 00000000..8dcf8e30 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneCallWaiting.md @@ -0,0 +1,49 @@ +--- +title: phoneCallWaiting +description: phoneCallWaiting attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallWaiting +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|date|[int](../types/int.md) | Yes| +|admin\_id|[int](../types/int.md) | Yes| +|participant\_id|[int](../types/int.md) | Yes| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes| +|receive\_date|[int](../types/int.md) | Optional| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +``` +$phoneCallWaiting = ['_' => 'phoneCallWaiting', 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'protocol' => PhoneCallProtocol, 'receive_date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneCallWaiting", "id": long, "access_hash": long, "date": int, "admin_id": int, "participant_id": int, "protocol": PhoneCallProtocol, "receive_date": int} +``` + + +Or, if you're into Lua: + + +``` +phoneCallWaiting={_='phoneCallWaiting', id=long, access_hash=long, date=int, admin_id=int, participant_id=int, protocol=PhoneCallProtocol, receive_date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phoneConnection.md b/old_docs/API_docs_v81/constructors/phoneConnection.md new file mode 100644 index 00000000..b117e12f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phoneConnection.md @@ -0,0 +1,47 @@ +--- +title: phoneConnection +description: phoneConnection attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneConnection +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|ip|[string](../types/string.md) | Yes| +|ipv6|[string](../types/string.md) | Yes| +|port|[int](../types/int.md) | Yes| +|peer\_tag|[bytes](../types/bytes.md) | Yes| + + + +### Type: [PhoneConnection](../types/PhoneConnection.md) + + +### Example: + +``` +$phoneConnection = ['_' => 'phoneConnection', 'id' => long, 'ip' => 'string', 'ipv6' => 'string', 'port' => int, 'peer_tag' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phoneConnection", "id": long, "ip": "string", "ipv6": "string", "port": int, "peer_tag": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +phoneConnection={_='phoneConnection', id=long, ip='string', ipv6='string', port=int, peer_tag='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/phone_phoneCall.md b/old_docs/API_docs_v81/constructors/phone_phoneCall.md new file mode 100644 index 00000000..00c21143 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/phone_phoneCall.md @@ -0,0 +1,44 @@ +--- +title: phone.phoneCall +description: phone_phoneCall attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phone.phoneCall +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone\_call|[PhoneCall](../types/PhoneCall.md) | Optional| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [phone\_PhoneCall](../types/phone_PhoneCall.md) + + +### Example: + +``` +$phone_phoneCall = ['_' => 'phone.phoneCall', 'phone_call' => PhoneCall, 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "phone.phoneCall", "phone_call": PhoneCall, "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +phone_phoneCall={_='phone.phoneCall', phone_call=PhoneCall, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/photo.md b/old_docs/API_docs_v81/constructors/photo.md new file mode 100644 index 00000000..0cad6364 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/photo.md @@ -0,0 +1,47 @@ +--- +title: photo +description: photo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|has\_stickers|[Bool](../types/Bool.md) | Optional| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|date|[int](../types/int.md) | Yes| +|sizes|Array of [PhotoSize](../types/PhotoSize.md) | Yes| + + + +### Type: [Photo](../types/Photo.md) + + +### Example: + +``` +$photo = ['_' => 'photo', 'has_stickers' => Bool, 'id' => long, 'access_hash' => long, 'date' => int, 'sizes' => [PhotoSize, PhotoSize]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "photo", "has_stickers": Bool, "id": long, "access_hash": long, "date": int, "sizes": [PhotoSize]} +``` + + +Or, if you're into Lua: + + +``` +photo={_='photo', has_stickers=Bool, id=long, access_hash=long, date=int, sizes={PhotoSize}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/photoCachedSize.md b/old_docs/API_docs_v81/constructors/photoCachedSize.md new file mode 100644 index 00000000..c5c3a63b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/photoCachedSize.md @@ -0,0 +1,47 @@ +--- +title: photoCachedSize +description: photoCachedSize attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photoCachedSize +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[string](../types/string.md) | Yes| +|location|[FileLocation](../types/FileLocation.md) | Yes| +|w|[int](../types/int.md) | Yes| +|h|[int](../types/int.md) | Yes| +|bytes|[bytes](../types/bytes.md) | Yes| + + + +### Type: [PhotoSize](../types/PhotoSize.md) + + +### Example: + +``` +$photoCachedSize = ['_' => 'photoCachedSize', 'type' => 'string', 'location' => FileLocation, 'w' => int, 'h' => int, 'bytes' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "photoCachedSize", "type": "string", "location": FileLocation, "w": int, "h": int, "bytes": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +photoCachedSize={_='photoCachedSize', type='string', location=FileLocation, w=int, h=int, bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/photoEmpty.md b/old_docs/API_docs_v81/constructors/photoEmpty.md new file mode 100644 index 00000000..f445232c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/photoEmpty.md @@ -0,0 +1,43 @@ +--- +title: photoEmpty +description: photoEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photoEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| + + + +### Type: [Photo](../types/Photo.md) + + +### Example: + +``` +$photoEmpty = ['_' => 'photoEmpty', 'id' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "photoEmpty", "id": long} +``` + + +Or, if you're into Lua: + + +``` +photoEmpty={_='photoEmpty', id=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/photoSize.md b/old_docs/API_docs_v81/constructors/photoSize.md new file mode 100644 index 00000000..0037056b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/photoSize.md @@ -0,0 +1,47 @@ +--- +title: photoSize +description: photoSize attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photoSize +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[string](../types/string.md) | Yes| +|location|[FileLocation](../types/FileLocation.md) | Yes| +|w|[int](../types/int.md) | Yes| +|h|[int](../types/int.md) | Yes| +|size|[int](../types/int.md) | Yes| + + + +### Type: [PhotoSize](../types/PhotoSize.md) + + +### Example: + +``` +$photoSize = ['_' => 'photoSize', 'type' => 'string', 'location' => FileLocation, 'w' => int, 'h' => int, 'size' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "photoSize", "type": "string", "location": FileLocation, "w": int, "h": int, "size": int} +``` + + +Or, if you're into Lua: + + +``` +photoSize={_='photoSize', type='string', location=FileLocation, w=int, h=int, size=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/photoSizeEmpty.md b/old_docs/API_docs_v81/constructors/photoSizeEmpty.md new file mode 100644 index 00000000..ecf82b75 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/photoSizeEmpty.md @@ -0,0 +1,43 @@ +--- +title: photoSizeEmpty +description: photoSizeEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photoSizeEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[string](../types/string.md) | Yes| + + + +### Type: [PhotoSize](../types/PhotoSize.md) + + +### Example: + +``` +$photoSizeEmpty = ['_' => 'photoSizeEmpty', 'type' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "photoSizeEmpty", "type": "string"} +``` + + +Or, if you're into Lua: + + +``` +photoSizeEmpty={_='photoSizeEmpty', type='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/photos_photo.md b/old_docs/API_docs_v81/constructors/photos_photo.md new file mode 100644 index 00000000..0512d476 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/photos_photo.md @@ -0,0 +1,44 @@ +--- +title: photos.photo +description: photos_photo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photos.photo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|photo|[Photo](../types/Photo.md) | Optional| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [photos\_Photo](../types/photos_Photo.md) + + +### Example: + +``` +$photos_photo = ['_' => 'photos.photo', 'photo' => Photo, 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "photos.photo", "photo": Photo, "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +photos_photo={_='photos.photo', photo=Photo, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/photos_photos.md b/old_docs/API_docs_v81/constructors/photos_photos.md new file mode 100644 index 00000000..0c33fd41 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/photos_photos.md @@ -0,0 +1,44 @@ +--- +title: photos.photos +description: photos_photos attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photos.photos +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|photos|Array of [Photo](../types/Photo.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [photos\_Photos](../types/photos_Photos.md) + + +### Example: + +``` +$photos_photos = ['_' => 'photos.photos', 'photos' => [Photo, Photo], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "photos.photos", "photos": [Photo], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +photos_photos={_='photos.photos', photos={Photo}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/photos_photosSlice.md b/old_docs/API_docs_v81/constructors/photos_photosSlice.md new file mode 100644 index 00000000..d033e65b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/photos_photosSlice.md @@ -0,0 +1,45 @@ +--- +title: photos.photosSlice +description: photos_photosSlice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photos.photosSlice +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|count|[int](../types/int.md) | Yes| +|photos|Array of [Photo](../types/Photo.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [photos\_Photos](../types/photos_Photos.md) + + +### Example: + +``` +$photos_photosSlice = ['_' => 'photos.photosSlice', 'count' => int, 'photos' => [Photo, Photo], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "photos.photosSlice", "count": int, "photos": [Photo], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +photos_photosSlice={_='photos.photosSlice', count=int, photos={Photo}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/popularContact.md b/old_docs/API_docs_v81/constructors/popularContact.md new file mode 100644 index 00000000..d7fdf7c9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/popularContact.md @@ -0,0 +1,44 @@ +--- +title: popularContact +description: popularContact attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: popularContact +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|client\_id|[long](../types/long.md) | Yes| +|importers|[int](../types/int.md) | Yes| + + + +### Type: [PopularContact](../types/PopularContact.md) + + +### Example: + +``` +$popularContact = ['_' => 'popularContact', 'client_id' => long, 'importers' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "popularContact", "client_id": long, "importers": int} +``` + + +Or, if you're into Lua: + + +``` +popularContact={_='popularContact', client_id=long, importers=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/postAddress.md b/old_docs/API_docs_v81/constructors/postAddress.md new file mode 100644 index 00000000..0bd47333 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/postAddress.md @@ -0,0 +1,48 @@ +--- +title: postAddress +description: postAddress attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: postAddress +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|street\_line1|[string](../types/string.md) | Yes| +|street\_line2|[string](../types/string.md) | Yes| +|city|[string](../types/string.md) | Yes| +|state|[string](../types/string.md) | Yes| +|country\_iso2|[string](../types/string.md) | Yes| +|post\_code|[string](../types/string.md) | Yes| + + + +### Type: [PostAddress](../types/PostAddress.md) + + +### Example: + +``` +$postAddress = ['_' => 'postAddress', 'street_line1' => 'string', 'street_line2' => 'string', 'city' => 'string', 'state' => 'string', 'country_iso2' => 'string', 'post_code' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "postAddress", "street_line1": "string", "street_line2": "string", "city": "string", "state": "string", "country_iso2": "string", "post_code": "string"} +``` + + +Or, if you're into Lua: + + +``` +postAddress={_='postAddress', street_line1='string', street_line2='string', city='string', state='string', country_iso2='string', post_code='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/privacyKeyChatInvite.md b/old_docs/API_docs_v81/constructors/privacyKeyChatInvite.md new file mode 100644 index 00000000..cc6e39b6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/privacyKeyChatInvite.md @@ -0,0 +1,38 @@ +--- +title: privacyKeyChatInvite +description: privacyKeyChatInvite attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyChatInvite +[Back to constructors index](index.md) + + + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +``` +$privacyKeyChatInvite = ['_' => 'privacyKeyChatInvite']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "privacyKeyChatInvite"} +``` + + +Or, if you're into Lua: + + +``` +privacyKeyChatInvite={_='privacyKeyChatInvite'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/privacyKeyPhoneCall.md b/old_docs/API_docs_v81/constructors/privacyKeyPhoneCall.md new file mode 100644 index 00000000..2fe6db7d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/privacyKeyPhoneCall.md @@ -0,0 +1,38 @@ +--- +title: privacyKeyPhoneCall +description: privacyKeyPhoneCall attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyPhoneCall +[Back to constructors index](index.md) + + + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +``` +$privacyKeyPhoneCall = ['_' => 'privacyKeyPhoneCall']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "privacyKeyPhoneCall"} +``` + + +Or, if you're into Lua: + + +``` +privacyKeyPhoneCall={_='privacyKeyPhoneCall'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/privacyKeyStatusTimestamp.md b/old_docs/API_docs_v81/constructors/privacyKeyStatusTimestamp.md new file mode 100644 index 00000000..d229b71e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/privacyKeyStatusTimestamp.md @@ -0,0 +1,38 @@ +--- +title: privacyKeyStatusTimestamp +description: privacyKeyStatusTimestamp attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyStatusTimestamp +[Back to constructors index](index.md) + + + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +``` +$privacyKeyStatusTimestamp = ['_' => 'privacyKeyStatusTimestamp']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "privacyKeyStatusTimestamp"} +``` + + +Or, if you're into Lua: + + +``` +privacyKeyStatusTimestamp={_='privacyKeyStatusTimestamp'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/privacyValueAllowAll.md b/old_docs/API_docs_v81/constructors/privacyValueAllowAll.md new file mode 100644 index 00000000..ed93f5e6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/privacyValueAllowAll.md @@ -0,0 +1,38 @@ +--- +title: privacyValueAllowAll +description: privacyValueAllowAll attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueAllowAll +[Back to constructors index](index.md) + + + + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +``` +$privacyValueAllowAll = ['_' => 'privacyValueAllowAll']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "privacyValueAllowAll"} +``` + + +Or, if you're into Lua: + + +``` +privacyValueAllowAll={_='privacyValueAllowAll'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/privacyValueAllowContacts.md b/old_docs/API_docs_v81/constructors/privacyValueAllowContacts.md new file mode 100644 index 00000000..4869ad62 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/privacyValueAllowContacts.md @@ -0,0 +1,38 @@ +--- +title: privacyValueAllowContacts +description: privacyValueAllowContacts attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueAllowContacts +[Back to constructors index](index.md) + + + + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +``` +$privacyValueAllowContacts = ['_' => 'privacyValueAllowContacts']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "privacyValueAllowContacts"} +``` + + +Or, if you're into Lua: + + +``` +privacyValueAllowContacts={_='privacyValueAllowContacts'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/privacyValueAllowUsers.md b/old_docs/API_docs_v81/constructors/privacyValueAllowUsers.md new file mode 100644 index 00000000..93cc0202 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/privacyValueAllowUsers.md @@ -0,0 +1,43 @@ +--- +title: privacyValueAllowUsers +description: privacyValueAllowUsers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueAllowUsers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|users|Array of [int](../types/int.md) | Yes| + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +``` +$privacyValueAllowUsers = ['_' => 'privacyValueAllowUsers', 'users' => [int, int]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "privacyValueAllowUsers", "users": [int]} +``` + + +Or, if you're into Lua: + + +``` +privacyValueAllowUsers={_='privacyValueAllowUsers', users={int}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/privacyValueDisallowAll.md b/old_docs/API_docs_v81/constructors/privacyValueDisallowAll.md new file mode 100644 index 00000000..60f3e05f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/privacyValueDisallowAll.md @@ -0,0 +1,38 @@ +--- +title: privacyValueDisallowAll +description: privacyValueDisallowAll attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueDisallowAll +[Back to constructors index](index.md) + + + + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +``` +$privacyValueDisallowAll = ['_' => 'privacyValueDisallowAll']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "privacyValueDisallowAll"} +``` + + +Or, if you're into Lua: + + +``` +privacyValueDisallowAll={_='privacyValueDisallowAll'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/privacyValueDisallowContacts.md b/old_docs/API_docs_v81/constructors/privacyValueDisallowContacts.md new file mode 100644 index 00000000..782eddb7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/privacyValueDisallowContacts.md @@ -0,0 +1,38 @@ +--- +title: privacyValueDisallowContacts +description: privacyValueDisallowContacts attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueDisallowContacts +[Back to constructors index](index.md) + + + + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +``` +$privacyValueDisallowContacts = ['_' => 'privacyValueDisallowContacts']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "privacyValueDisallowContacts"} +``` + + +Or, if you're into Lua: + + +``` +privacyValueDisallowContacts={_='privacyValueDisallowContacts'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/privacyValueDisallowUsers.md b/old_docs/API_docs_v81/constructors/privacyValueDisallowUsers.md new file mode 100644 index 00000000..bbd17f82 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/privacyValueDisallowUsers.md @@ -0,0 +1,43 @@ +--- +title: privacyValueDisallowUsers +description: privacyValueDisallowUsers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueDisallowUsers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|users|Array of [int](../types/int.md) | Yes| + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +``` +$privacyValueDisallowUsers = ['_' => 'privacyValueDisallowUsers', 'users' => [int, int]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "privacyValueDisallowUsers", "users": [int]} +``` + + +Or, if you're into Lua: + + +``` +privacyValueDisallowUsers={_='privacyValueDisallowUsers', users={int}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/receivedNotifyMessage.md b/old_docs/API_docs_v81/constructors/receivedNotifyMessage.md new file mode 100644 index 00000000..63ef4212 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/receivedNotifyMessage.md @@ -0,0 +1,43 @@ +--- +title: receivedNotifyMessage +description: receivedNotifyMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: receivedNotifyMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| + + + +### Type: [ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) + + +### Example: + +``` +$receivedNotifyMessage = ['_' => 'receivedNotifyMessage', 'id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "receivedNotifyMessage", "id": int} +``` + + +Or, if you're into Lua: + + +``` +receivedNotifyMessage={_='receivedNotifyMessage', id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/recentMeUrlChat.md b/old_docs/API_docs_v81/constructors/recentMeUrlChat.md new file mode 100644 index 00000000..8b09f818 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/recentMeUrlChat.md @@ -0,0 +1,44 @@ +--- +title: recentMeUrlChat +description: recentMeUrlChat attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlChat +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|chat\_id|[int](../types/int.md) | Yes| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +``` +$recentMeUrlChat = ['_' => 'recentMeUrlChat', 'url' => 'string', 'chat_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "recentMeUrlChat", "url": "string", "chat_id": int} +``` + + +Or, if you're into Lua: + + +``` +recentMeUrlChat={_='recentMeUrlChat', url='string', chat_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/recentMeUrlChatInvite.md b/old_docs/API_docs_v81/constructors/recentMeUrlChatInvite.md new file mode 100644 index 00000000..d9d3a1c6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/recentMeUrlChatInvite.md @@ -0,0 +1,44 @@ +--- +title: recentMeUrlChatInvite +description: recentMeUrlChatInvite attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlChatInvite +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|chat\_invite|[ChatInvite](../types/ChatInvite.md) | Optional| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +``` +$recentMeUrlChatInvite = ['_' => 'recentMeUrlChatInvite', 'url' => 'string', 'chat_invite' => ChatInvite]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "recentMeUrlChatInvite", "url": "string", "chat_invite": ChatInvite} +``` + + +Or, if you're into Lua: + + +``` +recentMeUrlChatInvite={_='recentMeUrlChatInvite', url='string', chat_invite=ChatInvite} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/recentMeUrlStickerSet.md b/old_docs/API_docs_v81/constructors/recentMeUrlStickerSet.md new file mode 100644 index 00000000..b70a27c4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/recentMeUrlStickerSet.md @@ -0,0 +1,44 @@ +--- +title: recentMeUrlStickerSet +description: recentMeUrlStickerSet attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlStickerSet +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|set|[StickerSetCovered](../types/StickerSetCovered.md) | Yes| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +``` +$recentMeUrlStickerSet = ['_' => 'recentMeUrlStickerSet', 'url' => 'string', 'set' => StickerSetCovered]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "recentMeUrlStickerSet", "url": "string", "set": StickerSetCovered} +``` + + +Or, if you're into Lua: + + +``` +recentMeUrlStickerSet={_='recentMeUrlStickerSet', url='string', set=StickerSetCovered} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/recentMeUrlUnknown.md b/old_docs/API_docs_v81/constructors/recentMeUrlUnknown.md new file mode 100644 index 00000000..0f157436 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/recentMeUrlUnknown.md @@ -0,0 +1,43 @@ +--- +title: recentMeUrlUnknown +description: recentMeUrlUnknown attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlUnknown +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +``` +$recentMeUrlUnknown = ['_' => 'recentMeUrlUnknown', 'url' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "recentMeUrlUnknown", "url": "string"} +``` + + +Or, if you're into Lua: + + +``` +recentMeUrlUnknown={_='recentMeUrlUnknown', url='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/recentMeUrlUser.md b/old_docs/API_docs_v81/constructors/recentMeUrlUser.md new file mode 100644 index 00000000..1e7ea925 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/recentMeUrlUser.md @@ -0,0 +1,44 @@ +--- +title: recentMeUrlUser +description: recentMeUrlUser attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlUser +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +``` +$recentMeUrlUser = ['_' => 'recentMeUrlUser', 'url' => 'string', 'user_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "recentMeUrlUser", "url": "string", "user_id": int} +``` + + +Or, if you're into Lua: + + +``` +recentMeUrlUser={_='recentMeUrlUser', url='string', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/replyInlineMarkup.md b/old_docs/API_docs_v81/constructors/replyInlineMarkup.md new file mode 100644 index 00000000..6d353569 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/replyInlineMarkup.md @@ -0,0 +1,43 @@ +--- +title: replyInlineMarkup +description: replyInlineMarkup attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: replyInlineMarkup +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|rows|Array of [KeyboardButtonRow](../types/KeyboardButtonRow.md) | Yes| + + + +### Type: [ReplyMarkup](../types/ReplyMarkup.md) + + +### Example: + +``` +$replyInlineMarkup = ['_' => 'replyInlineMarkup', 'rows' => [KeyboardButtonRow, KeyboardButtonRow]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "replyInlineMarkup", "rows": [KeyboardButtonRow]} +``` + + +Or, if you're into Lua: + + +``` +replyInlineMarkup={_='replyInlineMarkup', rows={KeyboardButtonRow}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/replyKeyboardForceReply.md b/old_docs/API_docs_v81/constructors/replyKeyboardForceReply.md new file mode 100644 index 00000000..56e255c1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/replyKeyboardForceReply.md @@ -0,0 +1,44 @@ +--- +title: replyKeyboardForceReply +description: replyKeyboardForceReply attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: replyKeyboardForceReply +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|single\_use|[Bool](../types/Bool.md) | Optional| +|selective|[Bool](../types/Bool.md) | Optional| + + + +### Type: [ReplyMarkup](../types/ReplyMarkup.md) + + +### Example: + +``` +$replyKeyboardForceReply = ['_' => 'replyKeyboardForceReply', 'single_use' => Bool, 'selective' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "replyKeyboardForceReply", "single_use": Bool, "selective": Bool} +``` + + +Or, if you're into Lua: + + +``` +replyKeyboardForceReply={_='replyKeyboardForceReply', single_use=Bool, selective=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/replyKeyboardHide.md b/old_docs/API_docs_v81/constructors/replyKeyboardHide.md new file mode 100644 index 00000000..7251db49 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/replyKeyboardHide.md @@ -0,0 +1,43 @@ +--- +title: replyKeyboardHide +description: replyKeyboardHide attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: replyKeyboardHide +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|selective|[Bool](../types/Bool.md) | Optional| + + + +### Type: [ReplyMarkup](../types/ReplyMarkup.md) + + +### Example: + +``` +$replyKeyboardHide = ['_' => 'replyKeyboardHide', 'selective' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "replyKeyboardHide", "selective": Bool} +``` + + +Or, if you're into Lua: + + +``` +replyKeyboardHide={_='replyKeyboardHide', selective=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/replyKeyboardMarkup.md b/old_docs/API_docs_v81/constructors/replyKeyboardMarkup.md new file mode 100644 index 00000000..87a55463 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/replyKeyboardMarkup.md @@ -0,0 +1,46 @@ +--- +title: replyKeyboardMarkup +description: replyKeyboardMarkup attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: replyKeyboardMarkup +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|resize|[Bool](../types/Bool.md) | Optional| +|single\_use|[Bool](../types/Bool.md) | Optional| +|selective|[Bool](../types/Bool.md) | Optional| +|rows|Array of [KeyboardButtonRow](../types/KeyboardButtonRow.md) | Yes| + + + +### Type: [ReplyMarkup](../types/ReplyMarkup.md) + + +### Example: + +``` +$replyKeyboardMarkup = ['_' => 'replyKeyboardMarkup', 'resize' => Bool, 'single_use' => Bool, 'selective' => Bool, 'rows' => [KeyboardButtonRow, KeyboardButtonRow]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "replyKeyboardMarkup", "resize": Bool, "single_use": Bool, "selective": Bool, "rows": [KeyboardButtonRow]} +``` + + +Or, if you're into Lua: + + +``` +replyKeyboardMarkup={_='replyKeyboardMarkup', resize=Bool, single_use=Bool, selective=Bool, rows={KeyboardButtonRow}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/savedPhoneContact.md b/old_docs/API_docs_v81/constructors/savedPhoneContact.md new file mode 100644 index 00000000..e19d1411 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/savedPhoneContact.md @@ -0,0 +1,46 @@ +--- +title: savedPhoneContact +description: savedPhoneContact attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: savedPhoneContact +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone|[string](../types/string.md) | Yes| +|first\_name|[string](../types/string.md) | Yes| +|last\_name|[string](../types/string.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [SavedContact](../types/SavedContact.md) + + +### Example: + +``` +$savedPhoneContact = ['_' => 'savedPhoneContact', 'phone' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "savedPhoneContact", "phone": "string", "first_name": "string", "last_name": "string", "date": int} +``` + + +Or, if you're into Lua: + + +``` +savedPhoneContact={_='savedPhoneContact', phone='string', first_name='string', last_name='string', date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureCredentialsEncrypted.md b/old_docs/API_docs_v81/constructors/secureCredentialsEncrypted.md new file mode 100644 index 00000000..60d34773 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureCredentialsEncrypted.md @@ -0,0 +1,45 @@ +--- +title: secureCredentialsEncrypted +description: secureCredentialsEncrypted attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureCredentialsEncrypted +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|data|[bytes](../types/bytes.md) | Yes| +|hash|[bytes](../types/bytes.md) | Yes| +|secret|[bytes](../types/bytes.md) | Yes| + + + +### Type: [SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md) + + +### Example: + +``` +$secureCredentialsEncrypted = ['_' => 'secureCredentialsEncrypted', 'data' => 'bytes', 'hash' => 'bytes', 'secret' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureCredentialsEncrypted", "data": {"_": "bytes", "bytes":"base64 encoded bytes"}, "hash": {"_": "bytes", "bytes":"base64 encoded bytes"}, "secret": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +secureCredentialsEncrypted={_='secureCredentialsEncrypted', data='bytes', hash='bytes', secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureData.md b/old_docs/API_docs_v81/constructors/secureData.md new file mode 100644 index 00000000..9f1c2a38 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureData.md @@ -0,0 +1,45 @@ +--- +title: secureData +description: secureData attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureData +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|data|[bytes](../types/bytes.md) | Yes| +|data\_hash|[bytes](../types/bytes.md) | Yes| +|secret|[bytes](../types/bytes.md) | Yes| + + + +### Type: [SecureData](../types/SecureData.md) + + +### Example: + +``` +$secureData = ['_' => 'secureData', 'data' => 'bytes', 'data_hash' => 'bytes', 'secret' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureData", "data": {"_": "bytes", "bytes":"base64 encoded bytes"}, "data_hash": {"_": "bytes", "bytes":"base64 encoded bytes"}, "secret": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +secureData={_='secureData', data='bytes', data_hash='bytes', secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureFile.md b/old_docs/API_docs_v81/constructors/secureFile.md new file mode 100644 index 00000000..1a4c0ca2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureFile.md @@ -0,0 +1,49 @@ +--- +title: secureFile +description: secureFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureFile +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|size|[int](../types/int.md) | Yes| +|dc\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|file\_hash|[bytes](../types/bytes.md) | Yes| +|secret|[bytes](../types/bytes.md) | Yes| + + + +### Type: [SecureFile](../types/SecureFile.md) + + +### Example: + +``` +$secureFile = ['_' => 'secureFile', 'id' => long, 'access_hash' => long, 'size' => int, 'dc_id' => int, 'date' => int, 'file_hash' => 'bytes', 'secret' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureFile", "id": long, "access_hash": long, "size": int, "dc_id": int, "date": int, "file_hash": {"_": "bytes", "bytes":"base64 encoded bytes"}, "secret": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +secureFile={_='secureFile', id=long, access_hash=long, size=int, dc_id=int, date=int, file_hash='bytes', secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureFileEmpty.md b/old_docs/API_docs_v81/constructors/secureFileEmpty.md new file mode 100644 index 00000000..fb8abd28 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureFileEmpty.md @@ -0,0 +1,38 @@ +--- +title: secureFileEmpty +description: secureFileEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureFileEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [SecureFile](../types/SecureFile.md) + + +### Example: + +``` +$secureFileEmpty = ['_' => 'secureFileEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureFileEmpty"} +``` + + +Or, if you're into Lua: + + +``` +secureFileEmpty={_='secureFileEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/securePlainEmail.md b/old_docs/API_docs_v81/constructors/securePlainEmail.md new file mode 100644 index 00000000..3fd9b073 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/securePlainEmail.md @@ -0,0 +1,43 @@ +--- +title: securePlainEmail +description: securePlainEmail attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePlainEmail +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|email|[string](../types/string.md) | Yes| + + + +### Type: [SecurePlainData](../types/SecurePlainData.md) + + +### Example: + +``` +$securePlainEmail = ['_' => 'securePlainEmail', 'email' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "securePlainEmail", "email": "string"} +``` + + +Or, if you're into Lua: + + +``` +securePlainEmail={_='securePlainEmail', email='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/securePlainPhone.md b/old_docs/API_docs_v81/constructors/securePlainPhone.md new file mode 100644 index 00000000..e2b451d3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/securePlainPhone.md @@ -0,0 +1,43 @@ +--- +title: securePlainPhone +description: securePlainPhone attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePlainPhone +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone|[string](../types/string.md) | Yes| + + + +### Type: [SecurePlainData](../types/SecurePlainData.md) + + +### Example: + +``` +$securePlainPhone = ['_' => 'securePlainPhone', 'phone' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "securePlainPhone", "phone": "string"} +``` + + +Or, if you're into Lua: + + +``` +securePlainPhone={_='securePlainPhone', phone='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValue.md b/old_docs/API_docs_v81/constructors/secureValue.md new file mode 100644 index 00000000..28a11b8e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValue.md @@ -0,0 +1,50 @@ +--- +title: secureValue +description: secureValue attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValue +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes| +|data|[SecureData](../types/SecureData.md) | Optional| +|front\_side|[SecureFile](../types/SecureFile.md) | Optional| +|reverse\_side|[SecureFile](../types/SecureFile.md) | Optional| +|selfie|[SecureFile](../types/SecureFile.md) | Optional| +|files|Array of [SecureFile](../types/SecureFile.md) | Optional| +|plain\_data|[SecurePlainData](../types/SecurePlainData.md) | Optional| +|hash|[bytes](../types/bytes.md) | Yes| + + + +### Type: [SecureValue](../types/SecureValue.md) + + +### Example: + +``` +$secureValue = ['_' => 'secureValue', 'type' => SecureValueType, 'data' => SecureData, 'front_side' => SecureFile, 'reverse_side' => SecureFile, 'selfie' => SecureFile, 'files' => [SecureFile, SecureFile], 'plain_data' => SecurePlainData, 'hash' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValue", "type": SecureValueType, "data": SecureData, "front_side": SecureFile, "reverse_side": SecureFile, "selfie": SecureFile, "files": [SecureFile], "plain_data": SecurePlainData, "hash": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +secureValue={_='secureValue', type=SecureValueType, data=SecureData, front_side=SecureFile, reverse_side=SecureFile, selfie=SecureFile, files={SecureFile}, plain_data=SecurePlainData, hash='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueErrorData.md b/old_docs/API_docs_v81/constructors/secureValueErrorData.md new file mode 100644 index 00000000..c635dc9f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueErrorData.md @@ -0,0 +1,46 @@ +--- +title: secureValueErrorData +description: secureValueErrorData attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorData +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes| +|data\_hash|[bytes](../types/bytes.md) | Yes| +|field|[string](../types/string.md) | Yes| +|text|[string](../types/string.md) | Yes| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +``` +$secureValueErrorData = ['_' => 'secureValueErrorData', 'type' => SecureValueType, 'data_hash' => 'bytes', 'field' => 'string', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueErrorData", "type": SecureValueType, "data_hash": {"_": "bytes", "bytes":"base64 encoded bytes"}, "field": "string", "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +secureValueErrorData={_='secureValueErrorData', type=SecureValueType, data_hash='bytes', field='string', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueErrorFile.md b/old_docs/API_docs_v81/constructors/secureValueErrorFile.md new file mode 100644 index 00000000..25225cb1 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueErrorFile.md @@ -0,0 +1,45 @@ +--- +title: secureValueErrorFile +description: secureValueErrorFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorFile +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes| +|file\_hash|[bytes](../types/bytes.md) | Yes| +|text|[string](../types/string.md) | Yes| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +``` +$secureValueErrorFile = ['_' => 'secureValueErrorFile', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueErrorFile", "type": SecureValueType, "file_hash": {"_": "bytes", "bytes":"base64 encoded bytes"}, "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +secureValueErrorFile={_='secureValueErrorFile', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueErrorFiles.md b/old_docs/API_docs_v81/constructors/secureValueErrorFiles.md new file mode 100644 index 00000000..72feb6ee --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueErrorFiles.md @@ -0,0 +1,45 @@ +--- +title: secureValueErrorFiles +description: secureValueErrorFiles attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorFiles +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes| +|file\_hash|Array of [bytes](../types/bytes.md) | Yes| +|text|[string](../types/string.md) | Yes| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +``` +$secureValueErrorFiles = ['_' => 'secureValueErrorFiles', 'type' => SecureValueType, 'file_hash' => ['bytes', 'bytes'], 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueErrorFiles", "type": SecureValueType, "file_hash": [{"_": "bytes", "bytes":"base64 encoded bytes"}], "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +secureValueErrorFiles={_='secureValueErrorFiles', type=SecureValueType, file_hash={'bytes'}, text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueErrorFrontSide.md b/old_docs/API_docs_v81/constructors/secureValueErrorFrontSide.md new file mode 100644 index 00000000..2460eb63 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueErrorFrontSide.md @@ -0,0 +1,45 @@ +--- +title: secureValueErrorFrontSide +description: secureValueErrorFrontSide attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorFrontSide +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes| +|file\_hash|[bytes](../types/bytes.md) | Yes| +|text|[string](../types/string.md) | Yes| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +``` +$secureValueErrorFrontSide = ['_' => 'secureValueErrorFrontSide', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueErrorFrontSide", "type": SecureValueType, "file_hash": {"_": "bytes", "bytes":"base64 encoded bytes"}, "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +secureValueErrorFrontSide={_='secureValueErrorFrontSide', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueErrorReverseSide.md b/old_docs/API_docs_v81/constructors/secureValueErrorReverseSide.md new file mode 100644 index 00000000..fe830333 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueErrorReverseSide.md @@ -0,0 +1,45 @@ +--- +title: secureValueErrorReverseSide +description: secureValueErrorReverseSide attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorReverseSide +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes| +|file\_hash|[bytes](../types/bytes.md) | Yes| +|text|[string](../types/string.md) | Yes| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +``` +$secureValueErrorReverseSide = ['_' => 'secureValueErrorReverseSide', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueErrorReverseSide", "type": SecureValueType, "file_hash": {"_": "bytes", "bytes":"base64 encoded bytes"}, "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +secureValueErrorReverseSide={_='secureValueErrorReverseSide', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueErrorSelfie.md b/old_docs/API_docs_v81/constructors/secureValueErrorSelfie.md new file mode 100644 index 00000000..b94f90e8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueErrorSelfie.md @@ -0,0 +1,45 @@ +--- +title: secureValueErrorSelfie +description: secureValueErrorSelfie attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorSelfie +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes| +|file\_hash|[bytes](../types/bytes.md) | Yes| +|text|[string](../types/string.md) | Yes| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +``` +$secureValueErrorSelfie = ['_' => 'secureValueErrorSelfie', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueErrorSelfie", "type": SecureValueType, "file_hash": {"_": "bytes", "bytes":"base64 encoded bytes"}, "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +secureValueErrorSelfie={_='secureValueErrorSelfie', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueHash.md b/old_docs/API_docs_v81/constructors/secureValueHash.md new file mode 100644 index 00000000..f4496737 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueHash.md @@ -0,0 +1,44 @@ +--- +title: secureValueHash +description: secureValueHash attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueHash +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes| +|hash|[bytes](../types/bytes.md) | Yes| + + + +### Type: [SecureValueHash](../types/SecureValueHash.md) + + +### Example: + +``` +$secureValueHash = ['_' => 'secureValueHash', 'type' => SecureValueType, 'hash' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueHash", "type": SecureValueType, "hash": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +secureValueHash={_='secureValueHash', type=SecureValueType, hash='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypeAddress.md b/old_docs/API_docs_v81/constructors/secureValueTypeAddress.md new file mode 100644 index 00000000..9d73f869 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypeAddress.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypeAddress +description: secureValueTypeAddress attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeAddress +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypeAddress = ['_' => 'secureValueTypeAddress']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypeAddress"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypeAddress={_='secureValueTypeAddress'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypeBankStatement.md b/old_docs/API_docs_v81/constructors/secureValueTypeBankStatement.md new file mode 100644 index 00000000..dbe5e9a5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypeBankStatement.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypeBankStatement +description: secureValueTypeBankStatement attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeBankStatement +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypeBankStatement = ['_' => 'secureValueTypeBankStatement']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypeBankStatement"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypeBankStatement={_='secureValueTypeBankStatement'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypeDriverLicense.md b/old_docs/API_docs_v81/constructors/secureValueTypeDriverLicense.md new file mode 100644 index 00000000..12845268 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypeDriverLicense.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypeDriverLicense +description: secureValueTypeDriverLicense attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeDriverLicense +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypeDriverLicense = ['_' => 'secureValueTypeDriverLicense']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypeDriverLicense"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypeDriverLicense={_='secureValueTypeDriverLicense'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypeEmail.md b/old_docs/API_docs_v81/constructors/secureValueTypeEmail.md new file mode 100644 index 00000000..1668487b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypeEmail.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypeEmail +description: secureValueTypeEmail attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeEmail +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypeEmail = ['_' => 'secureValueTypeEmail']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypeEmail"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypeEmail={_='secureValueTypeEmail'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypeIdentityCard.md b/old_docs/API_docs_v81/constructors/secureValueTypeIdentityCard.md new file mode 100644 index 00000000..5edbbf04 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypeIdentityCard.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypeIdentityCard +description: secureValueTypeIdentityCard attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeIdentityCard +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypeIdentityCard = ['_' => 'secureValueTypeIdentityCard']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypeIdentityCard"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypeIdentityCard={_='secureValueTypeIdentityCard'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypeInternalPassport.md b/old_docs/API_docs_v81/constructors/secureValueTypeInternalPassport.md new file mode 100644 index 00000000..a5ea29d3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypeInternalPassport.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypeInternalPassport +description: secureValueTypeInternalPassport attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeInternalPassport +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypeInternalPassport = ['_' => 'secureValueTypeInternalPassport']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypeInternalPassport"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypeInternalPassport={_='secureValueTypeInternalPassport'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypePassport.md b/old_docs/API_docs_v81/constructors/secureValueTypePassport.md new file mode 100644 index 00000000..aed9facc --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypePassport.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypePassport +description: secureValueTypePassport attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePassport +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypePassport = ['_' => 'secureValueTypePassport']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypePassport"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypePassport={_='secureValueTypePassport'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypePassportRegistration.md b/old_docs/API_docs_v81/constructors/secureValueTypePassportRegistration.md new file mode 100644 index 00000000..040889a2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypePassportRegistration.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypePassportRegistration +description: secureValueTypePassportRegistration attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePassportRegistration +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypePassportRegistration = ['_' => 'secureValueTypePassportRegistration']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypePassportRegistration"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypePassportRegistration={_='secureValueTypePassportRegistration'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypePersonalDetails.md b/old_docs/API_docs_v81/constructors/secureValueTypePersonalDetails.md new file mode 100644 index 00000000..d4f9659f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypePersonalDetails.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypePersonalDetails +description: secureValueTypePersonalDetails attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePersonalDetails +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypePersonalDetails = ['_' => 'secureValueTypePersonalDetails']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypePersonalDetails"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypePersonalDetails={_='secureValueTypePersonalDetails'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypePhone.md b/old_docs/API_docs_v81/constructors/secureValueTypePhone.md new file mode 100644 index 00000000..dec046f9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypePhone.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypePhone +description: secureValueTypePhone attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePhone +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypePhone = ['_' => 'secureValueTypePhone']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypePhone"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypePhone={_='secureValueTypePhone'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypeRentalAgreement.md b/old_docs/API_docs_v81/constructors/secureValueTypeRentalAgreement.md new file mode 100644 index 00000000..9dd42882 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypeRentalAgreement.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypeRentalAgreement +description: secureValueTypeRentalAgreement attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeRentalAgreement +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypeRentalAgreement = ['_' => 'secureValueTypeRentalAgreement']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypeRentalAgreement"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypeRentalAgreement={_='secureValueTypeRentalAgreement'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypeTemporaryRegistration.md b/old_docs/API_docs_v81/constructors/secureValueTypeTemporaryRegistration.md new file mode 100644 index 00000000..c5484ea8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypeTemporaryRegistration.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypeTemporaryRegistration +description: secureValueTypeTemporaryRegistration attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeTemporaryRegistration +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypeTemporaryRegistration = ['_' => 'secureValueTypeTemporaryRegistration']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypeTemporaryRegistration"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypeTemporaryRegistration={_='secureValueTypeTemporaryRegistration'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/secureValueTypeUtilityBill.md b/old_docs/API_docs_v81/constructors/secureValueTypeUtilityBill.md new file mode 100644 index 00000000..a3746506 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/secureValueTypeUtilityBill.md @@ -0,0 +1,38 @@ +--- +title: secureValueTypeUtilityBill +description: secureValueTypeUtilityBill attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeUtilityBill +[Back to constructors index](index.md) + + + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +``` +$secureValueTypeUtilityBill = ['_' => 'secureValueTypeUtilityBill']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "secureValueTypeUtilityBill"} +``` + + +Or, if you're into Lua: + + +``` +secureValueTypeUtilityBill={_='secureValueTypeUtilityBill'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageCancelAction.md b/old_docs/API_docs_v81/constructors/sendMessageCancelAction.md new file mode 100644 index 00000000..3e9c06fb --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageCancelAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageCancelAction +description: sendMessageCancelAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageCancelAction +[Back to constructors index](index.md) + + + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageCancelAction = ['_' => 'sendMessageCancelAction']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageCancelAction"} +``` + + +Or, if you're into Lua: + + +``` +sendMessageCancelAction={_='sendMessageCancelAction'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageChooseContactAction.md b/old_docs/API_docs_v81/constructors/sendMessageChooseContactAction.md new file mode 100644 index 00000000..18dd7aa3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageChooseContactAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageChooseContactAction +description: sendMessageChooseContactAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageChooseContactAction +[Back to constructors index](index.md) + + + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageChooseContactAction = ['_' => 'sendMessageChooseContactAction']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageChooseContactAction"} +``` + + +Or, if you're into Lua: + + +``` +sendMessageChooseContactAction={_='sendMessageChooseContactAction'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageGamePlayAction.md b/old_docs/API_docs_v81/constructors/sendMessageGamePlayAction.md new file mode 100644 index 00000000..8238ea55 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageGamePlayAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageGamePlayAction +description: sendMessageGamePlayAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageGamePlayAction +[Back to constructors index](index.md) + + + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageGamePlayAction = ['_' => 'sendMessageGamePlayAction']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageGamePlayAction"} +``` + + +Or, if you're into Lua: + + +``` +sendMessageGamePlayAction={_='sendMessageGamePlayAction'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageGeoLocationAction.md b/old_docs/API_docs_v81/constructors/sendMessageGeoLocationAction.md new file mode 100644 index 00000000..4082f682 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageGeoLocationAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageGeoLocationAction +description: sendMessageGeoLocationAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageGeoLocationAction +[Back to constructors index](index.md) + + + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageGeoLocationAction = ['_' => 'sendMessageGeoLocationAction']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageGeoLocationAction"} +``` + + +Or, if you're into Lua: + + +``` +sendMessageGeoLocationAction={_='sendMessageGeoLocationAction'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageRecordAudioAction.md b/old_docs/API_docs_v81/constructors/sendMessageRecordAudioAction.md new file mode 100644 index 00000000..61f91389 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageRecordAudioAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageRecordAudioAction +description: sendMessageRecordAudioAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageRecordAudioAction +[Back to constructors index](index.md) + + + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageRecordAudioAction = ['_' => 'sendMessageRecordAudioAction']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageRecordAudioAction"} +``` + + +Or, if you're into Lua: + + +``` +sendMessageRecordAudioAction={_='sendMessageRecordAudioAction'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageRecordRoundAction.md b/old_docs/API_docs_v81/constructors/sendMessageRecordRoundAction.md new file mode 100644 index 00000000..a388d0ec --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageRecordRoundAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageRecordRoundAction +description: sendMessageRecordRoundAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageRecordRoundAction +[Back to constructors index](index.md) + + + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageRecordRoundAction = ['_' => 'sendMessageRecordRoundAction']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageRecordRoundAction"} +``` + + +Or, if you're into Lua: + + +``` +sendMessageRecordRoundAction={_='sendMessageRecordRoundAction'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageRecordVideoAction.md b/old_docs/API_docs_v81/constructors/sendMessageRecordVideoAction.md new file mode 100644 index 00000000..76269466 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageRecordVideoAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageRecordVideoAction +description: sendMessageRecordVideoAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageRecordVideoAction +[Back to constructors index](index.md) + + + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageRecordVideoAction = ['_' => 'sendMessageRecordVideoAction']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageRecordVideoAction"} +``` + + +Or, if you're into Lua: + + +``` +sendMessageRecordVideoAction={_='sendMessageRecordVideoAction'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageTypingAction.md b/old_docs/API_docs_v81/constructors/sendMessageTypingAction.md new file mode 100644 index 00000000..484c71f7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageTypingAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageTypingAction +description: sendMessageTypingAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageTypingAction +[Back to constructors index](index.md) + + + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageTypingAction = ['_' => 'sendMessageTypingAction']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageTypingAction"} +``` + + +Or, if you're into Lua: + + +``` +sendMessageTypingAction={_='sendMessageTypingAction'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageUploadAudioAction.md b/old_docs/API_docs_v81/constructors/sendMessageUploadAudioAction.md new file mode 100644 index 00000000..54778ba2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageUploadAudioAction.md @@ -0,0 +1,43 @@ +--- +title: sendMessageUploadAudioAction +description: sendMessageUploadAudioAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageUploadAudioAction +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|progress|[int](../types/int.md) | Yes| + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageUploadAudioAction = ['_' => 'sendMessageUploadAudioAction', 'progress' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageUploadAudioAction", "progress": int} +``` + + +Or, if you're into Lua: + + +``` +sendMessageUploadAudioAction={_='sendMessageUploadAudioAction', progress=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageUploadDocumentAction.md b/old_docs/API_docs_v81/constructors/sendMessageUploadDocumentAction.md new file mode 100644 index 00000000..a6321d73 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageUploadDocumentAction.md @@ -0,0 +1,43 @@ +--- +title: sendMessageUploadDocumentAction +description: sendMessageUploadDocumentAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageUploadDocumentAction +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|progress|[int](../types/int.md) | Yes| + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageUploadDocumentAction = ['_' => 'sendMessageUploadDocumentAction', 'progress' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageUploadDocumentAction", "progress": int} +``` + + +Or, if you're into Lua: + + +``` +sendMessageUploadDocumentAction={_='sendMessageUploadDocumentAction', progress=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageUploadPhotoAction.md b/old_docs/API_docs_v81/constructors/sendMessageUploadPhotoAction.md new file mode 100644 index 00000000..3e4e3d3e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageUploadPhotoAction.md @@ -0,0 +1,43 @@ +--- +title: sendMessageUploadPhotoAction +description: sendMessageUploadPhotoAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageUploadPhotoAction +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|progress|[int](../types/int.md) | Yes| + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageUploadPhotoAction = ['_' => 'sendMessageUploadPhotoAction', 'progress' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageUploadPhotoAction", "progress": int} +``` + + +Or, if you're into Lua: + + +``` +sendMessageUploadPhotoAction={_='sendMessageUploadPhotoAction', progress=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageUploadRoundAction.md b/old_docs/API_docs_v81/constructors/sendMessageUploadRoundAction.md new file mode 100644 index 00000000..ffd14270 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageUploadRoundAction.md @@ -0,0 +1,43 @@ +--- +title: sendMessageUploadRoundAction +description: sendMessageUploadRoundAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageUploadRoundAction +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|progress|[int](../types/int.md) | Yes| + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageUploadRoundAction = ['_' => 'sendMessageUploadRoundAction', 'progress' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageUploadRoundAction", "progress": int} +``` + + +Or, if you're into Lua: + + +``` +sendMessageUploadRoundAction={_='sendMessageUploadRoundAction', progress=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/sendMessageUploadVideoAction.md b/old_docs/API_docs_v81/constructors/sendMessageUploadVideoAction.md new file mode 100644 index 00000000..f0203448 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/sendMessageUploadVideoAction.md @@ -0,0 +1,43 @@ +--- +title: sendMessageUploadVideoAction +description: sendMessageUploadVideoAction attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageUploadVideoAction +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|progress|[int](../types/int.md) | Yes| + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +``` +$sendMessageUploadVideoAction = ['_' => 'sendMessageUploadVideoAction', 'progress' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "sendMessageUploadVideoAction", "progress": int} +``` + + +Or, if you're into Lua: + + +``` +sendMessageUploadVideoAction={_='sendMessageUploadVideoAction', progress=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/shippingOption.md b/old_docs/API_docs_v81/constructors/shippingOption.md new file mode 100644 index 00000000..6f0cbc4c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/shippingOption.md @@ -0,0 +1,45 @@ +--- +title: shippingOption +description: shippingOption attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: shippingOption +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[string](../types/string.md) | Yes| +|title|[string](../types/string.md) | Yes| +|prices|Array of [LabeledPrice](../types/LabeledPrice.md) | Yes| + + + +### Type: [ShippingOption](../types/ShippingOption.md) + + +### Example: + +``` +$shippingOption = ['_' => 'shippingOption', 'id' => 'string', 'title' => 'string', 'prices' => [LabeledPrice, LabeledPrice]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "shippingOption", "id": "string", "title": "string", "prices": [LabeledPrice]} +``` + + +Or, if you're into Lua: + + +``` +shippingOption={_='shippingOption', id='string', title='string', prices={LabeledPrice}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/stickerPack.md b/old_docs/API_docs_v81/constructors/stickerPack.md new file mode 100644 index 00000000..7cd215cd --- /dev/null +++ b/old_docs/API_docs_v81/constructors/stickerPack.md @@ -0,0 +1,44 @@ +--- +title: stickerPack +description: stickerPack attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: stickerPack +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|emoticon|[string](../types/string.md) | Yes| +|documents|Array of [long](../types/long.md) | Yes| + + + +### Type: [StickerPack](../types/StickerPack.md) + + +### Example: + +``` +$stickerPack = ['_' => 'stickerPack', 'emoticon' => 'string', 'documents' => [long, long]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "stickerPack", "emoticon": "string", "documents": [long]} +``` + + +Or, if you're into Lua: + + +``` +stickerPack={_='stickerPack', emoticon='string', documents={long}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/stickerSet.md b/old_docs/API_docs_v81/constructors/stickerSet.md new file mode 100644 index 00000000..d6cffaba --- /dev/null +++ b/old_docs/API_docs_v81/constructors/stickerSet.md @@ -0,0 +1,52 @@ +--- +title: stickerSet +description: stickerSet attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: stickerSet +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|archived|[Bool](../types/Bool.md) | Optional| +|official|[Bool](../types/Bool.md) | Optional| +|masks|[Bool](../types/Bool.md) | Optional| +|installed\_date|[int](../types/int.md) | Optional| +|id|[long](../types/long.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|title|[string](../types/string.md) | Yes| +|short\_name|[string](../types/string.md) | Yes| +|count|[int](../types/int.md) | Yes| +|hash|[int](../types/int.md) | Yes| + + + +### Type: [StickerSet](../types/StickerSet.md) + + +### Example: + +``` +$stickerSet = ['_' => 'stickerSet', 'archived' => Bool, 'official' => Bool, 'masks' => Bool, 'installed_date' => int, 'id' => long, 'access_hash' => long, 'title' => 'string', 'short_name' => 'string', 'count' => int, 'hash' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "stickerSet", "archived": Bool, "official": Bool, "masks": Bool, "installed_date": int, "id": long, "access_hash": long, "title": "string", "short_name": "string", "count": int, "hash": int} +``` + + +Or, if you're into Lua: + + +``` +stickerSet={_='stickerSet', archived=Bool, official=Bool, masks=Bool, installed_date=int, id=long, access_hash=long, title='string', short_name='string', count=int, hash=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/stickerSetCovered.md b/old_docs/API_docs_v81/constructors/stickerSetCovered.md new file mode 100644 index 00000000..cc1c806e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/stickerSetCovered.md @@ -0,0 +1,44 @@ +--- +title: stickerSetCovered +description: stickerSetCovered attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: stickerSetCovered +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|set|[StickerSet](../types/StickerSet.md) | Yes| +|cover|[Document](../types/Document.md) | Optional| + + + +### Type: [StickerSetCovered](../types/StickerSetCovered.md) + + +### Example: + +``` +$stickerSetCovered = ['_' => 'stickerSetCovered', 'set' => StickerSet, 'cover' => Document]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "stickerSetCovered", "set": StickerSet, "cover": Document} +``` + + +Or, if you're into Lua: + + +``` +stickerSetCovered={_='stickerSetCovered', set=StickerSet, cover=Document} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/stickerSetMultiCovered.md b/old_docs/API_docs_v81/constructors/stickerSetMultiCovered.md new file mode 100644 index 00000000..74d10e38 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/stickerSetMultiCovered.md @@ -0,0 +1,44 @@ +--- +title: stickerSetMultiCovered +description: stickerSetMultiCovered attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: stickerSetMultiCovered +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|set|[StickerSet](../types/StickerSet.md) | Yes| +|covers|Array of [Document](../types/Document.md) | Yes| + + + +### Type: [StickerSetCovered](../types/StickerSetCovered.md) + + +### Example: + +``` +$stickerSetMultiCovered = ['_' => 'stickerSetMultiCovered', 'set' => StickerSet, 'covers' => [Document, Document]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "stickerSetMultiCovered", "set": StickerSet, "covers": [Document]} +``` + + +Or, if you're into Lua: + + +``` +stickerSetMultiCovered={_='stickerSetMultiCovered', set=StickerSet, covers={Document}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/storage_fileGif.md b/old_docs/API_docs_v81/constructors/storage_fileGif.md new file mode 100644 index 00000000..9620077e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/storage_fileGif.md @@ -0,0 +1,38 @@ +--- +title: storage.fileGif +description: storage_fileGif attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: storage.fileGif +[Back to constructors index](index.md) + + + + + + +### Type: [storage\_FileType](../types/storage_FileType.md) + + +### Example: + +``` +$storage_fileGif = ['_' => 'storage.fileGif']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "storage.fileGif"} +``` + + +Or, if you're into Lua: + + +``` +storage_fileGif={_='storage.fileGif'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/storage_fileJpeg.md b/old_docs/API_docs_v81/constructors/storage_fileJpeg.md new file mode 100644 index 00000000..69f637c7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/storage_fileJpeg.md @@ -0,0 +1,38 @@ +--- +title: storage.fileJpeg +description: storage_fileJpeg attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: storage.fileJpeg +[Back to constructors index](index.md) + + + + + + +### Type: [storage\_FileType](../types/storage_FileType.md) + + +### Example: + +``` +$storage_fileJpeg = ['_' => 'storage.fileJpeg']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "storage.fileJpeg"} +``` + + +Or, if you're into Lua: + + +``` +storage_fileJpeg={_='storage.fileJpeg'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/storage_fileMov.md b/old_docs/API_docs_v81/constructors/storage_fileMov.md new file mode 100644 index 00000000..ae8680aa --- /dev/null +++ b/old_docs/API_docs_v81/constructors/storage_fileMov.md @@ -0,0 +1,38 @@ +--- +title: storage.fileMov +description: storage_fileMov attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: storage.fileMov +[Back to constructors index](index.md) + + + + + + +### Type: [storage\_FileType](../types/storage_FileType.md) + + +### Example: + +``` +$storage_fileMov = ['_' => 'storage.fileMov']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "storage.fileMov"} +``` + + +Or, if you're into Lua: + + +``` +storage_fileMov={_='storage.fileMov'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/storage_fileMp3.md b/old_docs/API_docs_v81/constructors/storage_fileMp3.md new file mode 100644 index 00000000..78436c97 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/storage_fileMp3.md @@ -0,0 +1,38 @@ +--- +title: storage.fileMp3 +description: storage_fileMp3 attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: storage.fileMp3 +[Back to constructors index](index.md) + + + + + + +### Type: [storage\_FileType](../types/storage_FileType.md) + + +### Example: + +``` +$storage_fileMp3 = ['_' => 'storage.fileMp3']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "storage.fileMp3"} +``` + + +Or, if you're into Lua: + + +``` +storage_fileMp3={_='storage.fileMp3'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/storage_fileMp4.md b/old_docs/API_docs_v81/constructors/storage_fileMp4.md new file mode 100644 index 00000000..ae039916 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/storage_fileMp4.md @@ -0,0 +1,38 @@ +--- +title: storage.fileMp4 +description: storage_fileMp4 attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: storage.fileMp4 +[Back to constructors index](index.md) + + + + + + +### Type: [storage\_FileType](../types/storage_FileType.md) + + +### Example: + +``` +$storage_fileMp4 = ['_' => 'storage.fileMp4']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "storage.fileMp4"} +``` + + +Or, if you're into Lua: + + +``` +storage_fileMp4={_='storage.fileMp4'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/storage_filePartial.md b/old_docs/API_docs_v81/constructors/storage_filePartial.md new file mode 100644 index 00000000..dfa6f0fa --- /dev/null +++ b/old_docs/API_docs_v81/constructors/storage_filePartial.md @@ -0,0 +1,38 @@ +--- +title: storage.filePartial +description: storage_filePartial attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: storage.filePartial +[Back to constructors index](index.md) + + + + + + +### Type: [storage\_FileType](../types/storage_FileType.md) + + +### Example: + +``` +$storage_filePartial = ['_' => 'storage.filePartial']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "storage.filePartial"} +``` + + +Or, if you're into Lua: + + +``` +storage_filePartial={_='storage.filePartial'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/storage_filePdf.md b/old_docs/API_docs_v81/constructors/storage_filePdf.md new file mode 100644 index 00000000..92829d38 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/storage_filePdf.md @@ -0,0 +1,38 @@ +--- +title: storage.filePdf +description: storage_filePdf attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: storage.filePdf +[Back to constructors index](index.md) + + + + + + +### Type: [storage\_FileType](../types/storage_FileType.md) + + +### Example: + +``` +$storage_filePdf = ['_' => 'storage.filePdf']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "storage.filePdf"} +``` + + +Or, if you're into Lua: + + +``` +storage_filePdf={_='storage.filePdf'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/storage_filePng.md b/old_docs/API_docs_v81/constructors/storage_filePng.md new file mode 100644 index 00000000..1acf979a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/storage_filePng.md @@ -0,0 +1,38 @@ +--- +title: storage.filePng +description: storage_filePng attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: storage.filePng +[Back to constructors index](index.md) + + + + + + +### Type: [storage\_FileType](../types/storage_FileType.md) + + +### Example: + +``` +$storage_filePng = ['_' => 'storage.filePng']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "storage.filePng"} +``` + + +Or, if you're into Lua: + + +``` +storage_filePng={_='storage.filePng'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/storage_fileUnknown.md b/old_docs/API_docs_v81/constructors/storage_fileUnknown.md new file mode 100644 index 00000000..72c69e41 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/storage_fileUnknown.md @@ -0,0 +1,38 @@ +--- +title: storage.fileUnknown +description: storage_fileUnknown attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: storage.fileUnknown +[Back to constructors index](index.md) + + + + + + +### Type: [storage\_FileType](../types/storage_FileType.md) + + +### Example: + +``` +$storage_fileUnknown = ['_' => 'storage.fileUnknown']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "storage.fileUnknown"} +``` + + +Or, if you're into Lua: + + +``` +storage_fileUnknown={_='storage.fileUnknown'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/storage_fileWebp.md b/old_docs/API_docs_v81/constructors/storage_fileWebp.md new file mode 100644 index 00000000..a6c98527 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/storage_fileWebp.md @@ -0,0 +1,38 @@ +--- +title: storage.fileWebp +description: storage_fileWebp attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: storage.fileWebp +[Back to constructors index](index.md) + + + + + + +### Type: [storage\_FileType](../types/storage_FileType.md) + + +### Example: + +``` +$storage_fileWebp = ['_' => 'storage.fileWebp']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "storage.fileWebp"} +``` + + +Or, if you're into Lua: + + +``` +storage_fileWebp={_='storage.fileWebp'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/textBold.md b/old_docs/API_docs_v81/constructors/textBold.md new file mode 100644 index 00000000..52b668f6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/textBold.md @@ -0,0 +1,43 @@ +--- +title: textBold +description: textBold attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textBold +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +``` +$textBold = ['_' => 'textBold', 'text' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "textBold", "text": RichText} +``` + + +Or, if you're into Lua: + + +``` +textBold={_='textBold', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/textConcat.md b/old_docs/API_docs_v81/constructors/textConcat.md new file mode 100644 index 00000000..3f2656ed --- /dev/null +++ b/old_docs/API_docs_v81/constructors/textConcat.md @@ -0,0 +1,43 @@ +--- +title: textConcat +description: textConcat attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textConcat +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|texts|Array of [RichText](../types/RichText.md) | Yes| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +``` +$textConcat = ['_' => 'textConcat', 'texts' => [RichText, RichText]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "textConcat", "texts": [RichText]} +``` + + +Or, if you're into Lua: + + +``` +textConcat={_='textConcat', texts={RichText}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/textEmail.md b/old_docs/API_docs_v81/constructors/textEmail.md new file mode 100644 index 00000000..0b546415 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/textEmail.md @@ -0,0 +1,44 @@ +--- +title: textEmail +description: textEmail attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textEmail +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| +|email|[string](../types/string.md) | Yes| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +``` +$textEmail = ['_' => 'textEmail', 'text' => RichText, 'email' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "textEmail", "text": RichText, "email": "string"} +``` + + +Or, if you're into Lua: + + +``` +textEmail={_='textEmail', text=RichText, email='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/textEmpty.md b/old_docs/API_docs_v81/constructors/textEmpty.md new file mode 100644 index 00000000..4e96adb3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/textEmpty.md @@ -0,0 +1,38 @@ +--- +title: textEmpty +description: textEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +``` +$textEmpty = ['_' => 'textEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "textEmpty"} +``` + + +Or, if you're into Lua: + + +``` +textEmpty={_='textEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/textFixed.md b/old_docs/API_docs_v81/constructors/textFixed.md new file mode 100644 index 00000000..e40767d9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/textFixed.md @@ -0,0 +1,43 @@ +--- +title: textFixed +description: textFixed attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textFixed +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +``` +$textFixed = ['_' => 'textFixed', 'text' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "textFixed", "text": RichText} +``` + + +Or, if you're into Lua: + + +``` +textFixed={_='textFixed', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/textItalic.md b/old_docs/API_docs_v81/constructors/textItalic.md new file mode 100644 index 00000000..e32fbec2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/textItalic.md @@ -0,0 +1,43 @@ +--- +title: textItalic +description: textItalic attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textItalic +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +``` +$textItalic = ['_' => 'textItalic', 'text' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "textItalic", "text": RichText} +``` + + +Or, if you're into Lua: + + +``` +textItalic={_='textItalic', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/textPlain.md b/old_docs/API_docs_v81/constructors/textPlain.md new file mode 100644 index 00000000..2e654fde --- /dev/null +++ b/old_docs/API_docs_v81/constructors/textPlain.md @@ -0,0 +1,43 @@ +--- +title: textPlain +description: textPlain attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textPlain +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[string](../types/string.md) | Yes| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +``` +$textPlain = ['_' => 'textPlain', 'text' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "textPlain", "text": "string"} +``` + + +Or, if you're into Lua: + + +``` +textPlain={_='textPlain', text='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/textStrike.md b/old_docs/API_docs_v81/constructors/textStrike.md new file mode 100644 index 00000000..0090e980 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/textStrike.md @@ -0,0 +1,43 @@ +--- +title: textStrike +description: textStrike attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textStrike +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +``` +$textStrike = ['_' => 'textStrike', 'text' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "textStrike", "text": RichText} +``` + + +Or, if you're into Lua: + + +``` +textStrike={_='textStrike', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/textUnderline.md b/old_docs/API_docs_v81/constructors/textUnderline.md new file mode 100644 index 00000000..843d0a9a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/textUnderline.md @@ -0,0 +1,43 @@ +--- +title: textUnderline +description: textUnderline attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textUnderline +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +``` +$textUnderline = ['_' => 'textUnderline', 'text' => RichText]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "textUnderline", "text": RichText} +``` + + +Or, if you're into Lua: + + +``` +textUnderline={_='textUnderline', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/textUrl.md b/old_docs/API_docs_v81/constructors/textUrl.md new file mode 100644 index 00000000..6938f27e --- /dev/null +++ b/old_docs/API_docs_v81/constructors/textUrl.md @@ -0,0 +1,45 @@ +--- +title: textUrl +description: textUrl attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textUrl +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|text|[RichText](../types/RichText.md) | Yes| +|url|[string](../types/string.md) | Yes| +|webpage\_id|[long](../types/long.md) | Yes| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +``` +$textUrl = ['_' => 'textUrl', 'text' => RichText, 'url' => 'string', 'webpage_id' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "textUrl", "text": RichText, "url": "string", "webpage_id": long} +``` + + +Or, if you're into Lua: + + +``` +textUrl={_='textUrl', text=RichText, url='string', webpage_id=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/topPeer.md b/old_docs/API_docs_v81/constructors/topPeer.md new file mode 100644 index 00000000..aa49751b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/topPeer.md @@ -0,0 +1,44 @@ +--- +title: topPeer +description: topPeer attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeer +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Peer](../types/Peer.md) | Yes| +|rating|[double](../types/double.md) | Yes| + + + +### Type: [TopPeer](../types/TopPeer.md) + + +### Example: + +``` +$topPeer = ['_' => 'topPeer', 'peer' => Peer, 'rating' => double]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "topPeer", "peer": Peer, "rating": double} +``` + + +Or, if you're into Lua: + + +``` +topPeer={_='topPeer', peer=Peer, rating=double} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/topPeerCategoryBotsInline.md b/old_docs/API_docs_v81/constructors/topPeerCategoryBotsInline.md new file mode 100644 index 00000000..1d57e310 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/topPeerCategoryBotsInline.md @@ -0,0 +1,38 @@ +--- +title: topPeerCategoryBotsInline +description: topPeerCategoryBotsInline attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryBotsInline +[Back to constructors index](index.md) + + + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +``` +$topPeerCategoryBotsInline = ['_' => 'topPeerCategoryBotsInline']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "topPeerCategoryBotsInline"} +``` + + +Or, if you're into Lua: + + +``` +topPeerCategoryBotsInline={_='topPeerCategoryBotsInline'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/topPeerCategoryBotsPM.md b/old_docs/API_docs_v81/constructors/topPeerCategoryBotsPM.md new file mode 100644 index 00000000..f6207626 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/topPeerCategoryBotsPM.md @@ -0,0 +1,38 @@ +--- +title: topPeerCategoryBotsPM +description: topPeerCategoryBotsPM attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryBotsPM +[Back to constructors index](index.md) + + + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +``` +$topPeerCategoryBotsPM = ['_' => 'topPeerCategoryBotsPM']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "topPeerCategoryBotsPM"} +``` + + +Or, if you're into Lua: + + +``` +topPeerCategoryBotsPM={_='topPeerCategoryBotsPM'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/topPeerCategoryChannels.md b/old_docs/API_docs_v81/constructors/topPeerCategoryChannels.md new file mode 100644 index 00000000..8f0e1fcb --- /dev/null +++ b/old_docs/API_docs_v81/constructors/topPeerCategoryChannels.md @@ -0,0 +1,38 @@ +--- +title: topPeerCategoryChannels +description: topPeerCategoryChannels attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryChannels +[Back to constructors index](index.md) + + + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +``` +$topPeerCategoryChannels = ['_' => 'topPeerCategoryChannels']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "topPeerCategoryChannels"} +``` + + +Or, if you're into Lua: + + +``` +topPeerCategoryChannels={_='topPeerCategoryChannels'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/topPeerCategoryCorrespondents.md b/old_docs/API_docs_v81/constructors/topPeerCategoryCorrespondents.md new file mode 100644 index 00000000..9435610d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/topPeerCategoryCorrespondents.md @@ -0,0 +1,38 @@ +--- +title: topPeerCategoryCorrespondents +description: topPeerCategoryCorrespondents attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryCorrespondents +[Back to constructors index](index.md) + + + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +``` +$topPeerCategoryCorrespondents = ['_' => 'topPeerCategoryCorrespondents']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "topPeerCategoryCorrespondents"} +``` + + +Or, if you're into Lua: + + +``` +topPeerCategoryCorrespondents={_='topPeerCategoryCorrespondents'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/topPeerCategoryGroups.md b/old_docs/API_docs_v81/constructors/topPeerCategoryGroups.md new file mode 100644 index 00000000..3b6859df --- /dev/null +++ b/old_docs/API_docs_v81/constructors/topPeerCategoryGroups.md @@ -0,0 +1,38 @@ +--- +title: topPeerCategoryGroups +description: topPeerCategoryGroups attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryGroups +[Back to constructors index](index.md) + + + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +``` +$topPeerCategoryGroups = ['_' => 'topPeerCategoryGroups']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "topPeerCategoryGroups"} +``` + + +Or, if you're into Lua: + + +``` +topPeerCategoryGroups={_='topPeerCategoryGroups'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/topPeerCategoryPeers.md b/old_docs/API_docs_v81/constructors/topPeerCategoryPeers.md new file mode 100644 index 00000000..886ab6f9 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/topPeerCategoryPeers.md @@ -0,0 +1,45 @@ +--- +title: topPeerCategoryPeers +description: topPeerCategoryPeers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryPeers +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes| +|count|[int](../types/int.md) | Yes| +|peers|Array of [TopPeer](../types/TopPeer.md) | Yes| + + + +### Type: [TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md) + + +### Example: + +``` +$topPeerCategoryPeers = ['_' => 'topPeerCategoryPeers', 'category' => TopPeerCategory, 'count' => int, 'peers' => [TopPeer, TopPeer]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "topPeerCategoryPeers", "category": TopPeerCategory, "count": int, "peers": [TopPeer]} +``` + + +Or, if you're into Lua: + + +``` +topPeerCategoryPeers={_='topPeerCategoryPeers', category=TopPeerCategory, count=int, peers={TopPeer}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/topPeerCategoryPhoneCalls.md b/old_docs/API_docs_v81/constructors/topPeerCategoryPhoneCalls.md new file mode 100644 index 00000000..4c4a1c2d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/topPeerCategoryPhoneCalls.md @@ -0,0 +1,38 @@ +--- +title: topPeerCategoryPhoneCalls +description: topPeerCategoryPhoneCalls attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryPhoneCalls +[Back to constructors index](index.md) + + + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +``` +$topPeerCategoryPhoneCalls = ['_' => 'topPeerCategoryPhoneCalls']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "topPeerCategoryPhoneCalls"} +``` + + +Or, if you're into Lua: + + +``` +topPeerCategoryPhoneCalls={_='topPeerCategoryPhoneCalls'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/true.md b/old_docs/API_docs_v81/constructors/true.md new file mode 100644 index 00000000..2e27ecbf --- /dev/null +++ b/old_docs/API_docs_v81/constructors/true.md @@ -0,0 +1,38 @@ +--- +title: true +description: true attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: true +[Back to constructors index](index.md) + + + + + + +### Type: [True](../types/True.md) + + +### Example: + +``` +$true = ['_' => 'true']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "true"} +``` + + +Or, if you're into Lua: + + +``` +true={_='true'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateBotCallbackQuery.md b/old_docs/API_docs_v81/constructors/updateBotCallbackQuery.md new file mode 100644 index 00000000..2216e362 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateBotCallbackQuery.md @@ -0,0 +1,49 @@ +--- +title: updateBotCallbackQuery +description: updateBotCallbackQuery attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotCallbackQuery +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|query\_id|[long](../types/long.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|peer|[Peer](../types/Peer.md) | Yes| +|msg\_id|[int](../types/int.md) | Yes| +|chat\_instance|[long](../types/long.md) | Yes| +|data|[bytes](../types/bytes.md) | Optional| +|game\_short\_name|[string](../types/string.md) | Optional| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateBotCallbackQuery = ['_' => 'updateBotCallbackQuery', 'query_id' => long, 'user_id' => int, 'peer' => Peer, 'msg_id' => int, 'chat_instance' => long, 'data' => 'bytes', 'game_short_name' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateBotCallbackQuery", "query_id": long, "user_id": int, "peer": Peer, "msg_id": int, "chat_instance": long, "data": {"_": "bytes", "bytes":"base64 encoded bytes"}, "game_short_name": "string"} +``` + + +Or, if you're into Lua: + + +``` +updateBotCallbackQuery={_='updateBotCallbackQuery', query_id=long, user_id=int, peer=Peer, msg_id=int, chat_instance=long, data='bytes', game_short_name='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateBotInlineQuery.md b/old_docs/API_docs_v81/constructors/updateBotInlineQuery.md new file mode 100644 index 00000000..1cc45358 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateBotInlineQuery.md @@ -0,0 +1,47 @@ +--- +title: updateBotInlineQuery +description: updateBotInlineQuery attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotInlineQuery +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|query\_id|[long](../types/long.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|query|[string](../types/string.md) | Yes| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional| +|offset|[string](../types/string.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateBotInlineQuery = ['_' => 'updateBotInlineQuery', 'query_id' => long, 'user_id' => int, 'query' => 'string', 'geo' => GeoPoint, 'offset' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateBotInlineQuery", "query_id": long, "user_id": int, "query": "string", "geo": GeoPoint, "offset": "string"} +``` + + +Or, if you're into Lua: + + +``` +updateBotInlineQuery={_='updateBotInlineQuery', query_id=long, user_id=int, query='string', geo=GeoPoint, offset='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateBotInlineSend.md b/old_docs/API_docs_v81/constructors/updateBotInlineSend.md new file mode 100644 index 00000000..fe6c01d3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateBotInlineSend.md @@ -0,0 +1,47 @@ +--- +title: updateBotInlineSend +description: updateBotInlineSend attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotInlineSend +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|query|[string](../types/string.md) | Yes| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional| +|id|[string](../types/string.md) | Yes| +|msg\_id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Optional| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateBotInlineSend = ['_' => 'updateBotInlineSend', 'user_id' => int, 'query' => 'string', 'geo' => GeoPoint, 'id' => 'string', 'msg_id' => InputBotInlineMessageID]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateBotInlineSend", "user_id": int, "query": "string", "geo": GeoPoint, "id": "string", "msg_id": InputBotInlineMessageID} +``` + + +Or, if you're into Lua: + + +``` +updateBotInlineSend={_='updateBotInlineSend', user_id=int, query='string', geo=GeoPoint, id='string', msg_id=InputBotInlineMessageID} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateBotPrecheckoutQuery.md b/old_docs/API_docs_v81/constructors/updateBotPrecheckoutQuery.md new file mode 100644 index 00000000..f7e13668 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateBotPrecheckoutQuery.md @@ -0,0 +1,49 @@ +--- +title: updateBotPrecheckoutQuery +description: updateBotPrecheckoutQuery attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotPrecheckoutQuery +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|query\_id|[long](../types/long.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|payload|[bytes](../types/bytes.md) | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional| +|shipping\_option\_id|[string](../types/string.md) | Optional| +|currency|[string](../types/string.md) | Yes| +|total\_amount|[long](../types/long.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateBotPrecheckoutQuery = ['_' => 'updateBotPrecheckoutQuery', 'query_id' => long, 'user_id' => int, 'payload' => 'bytes', 'info' => PaymentRequestedInfo, 'shipping_option_id' => 'string', 'currency' => 'string', 'total_amount' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateBotPrecheckoutQuery", "query_id": long, "user_id": int, "payload": {"_": "bytes", "bytes":"base64 encoded bytes"}, "info": PaymentRequestedInfo, "shipping_option_id": "string", "currency": "string", "total_amount": long} +``` + + +Or, if you're into Lua: + + +``` +updateBotPrecheckoutQuery={_='updateBotPrecheckoutQuery', query_id=long, user_id=int, payload='bytes', info=PaymentRequestedInfo, shipping_option_id='string', currency='string', total_amount=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateBotShippingQuery.md b/old_docs/API_docs_v81/constructors/updateBotShippingQuery.md new file mode 100644 index 00000000..b7413761 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateBotShippingQuery.md @@ -0,0 +1,46 @@ +--- +title: updateBotShippingQuery +description: updateBotShippingQuery attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotShippingQuery +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|query\_id|[long](../types/long.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|payload|[bytes](../types/bytes.md) | Yes| +|shipping\_address|[PostAddress](../types/PostAddress.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateBotShippingQuery = ['_' => 'updateBotShippingQuery', 'query_id' => long, 'user_id' => int, 'payload' => 'bytes', 'shipping_address' => PostAddress]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateBotShippingQuery", "query_id": long, "user_id": int, "payload": {"_": "bytes", "bytes":"base64 encoded bytes"}, "shipping_address": PostAddress} +``` + + +Or, if you're into Lua: + + +``` +updateBotShippingQuery={_='updateBotShippingQuery', query_id=long, user_id=int, payload='bytes', shipping_address=PostAddress} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateBotWebhookJSON.md b/old_docs/API_docs_v81/constructors/updateBotWebhookJSON.md new file mode 100644 index 00000000..c444fe16 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateBotWebhookJSON.md @@ -0,0 +1,43 @@ +--- +title: updateBotWebhookJSON +description: updateBotWebhookJSON attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotWebhookJSON +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|data|[DataJSON](../types/DataJSON.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateBotWebhookJSON = ['_' => 'updateBotWebhookJSON', 'data' => DataJSON]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateBotWebhookJSON", "data": DataJSON} +``` + + +Or, if you're into Lua: + + +``` +updateBotWebhookJSON={_='updateBotWebhookJSON', data=DataJSON} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateBotWebhookJSONQuery.md b/old_docs/API_docs_v81/constructors/updateBotWebhookJSONQuery.md new file mode 100644 index 00000000..c8014f35 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateBotWebhookJSONQuery.md @@ -0,0 +1,45 @@ +--- +title: updateBotWebhookJSONQuery +description: updateBotWebhookJSONQuery attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotWebhookJSONQuery +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|query\_id|[long](../types/long.md) | Yes| +|data|[DataJSON](../types/DataJSON.md) | Yes| +|timeout|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateBotWebhookJSONQuery = ['_' => 'updateBotWebhookJSONQuery', 'query_id' => long, 'data' => DataJSON, 'timeout' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateBotWebhookJSONQuery", "query_id": long, "data": DataJSON, "timeout": int} +``` + + +Or, if you're into Lua: + + +``` +updateBotWebhookJSONQuery={_='updateBotWebhookJSONQuery', query_id=long, data=DataJSON, timeout=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChannel.md b/old_docs/API_docs_v81/constructors/updateChannel.md new file mode 100644 index 00000000..e615920a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChannel.md @@ -0,0 +1,43 @@ +--- +title: updateChannel +description: updateChannel attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannel +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChannel = ['_' => 'updateChannel', 'channel_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChannel", "channel_id": int} +``` + + +Or, if you're into Lua: + + +``` +updateChannel={_='updateChannel', channel_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChannelAvailableMessages.md b/old_docs/API_docs_v81/constructors/updateChannelAvailableMessages.md new file mode 100644 index 00000000..ef499037 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChannelAvailableMessages.md @@ -0,0 +1,44 @@ +--- +title: updateChannelAvailableMessages +description: updateChannelAvailableMessages attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelAvailableMessages +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|available\_min\_id|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChannelAvailableMessages = ['_' => 'updateChannelAvailableMessages', 'channel_id' => int, 'available_min_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChannelAvailableMessages", "channel_id": int, "available_min_id": int} +``` + + +Or, if you're into Lua: + + +``` +updateChannelAvailableMessages={_='updateChannelAvailableMessages', channel_id=int, available_min_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChannelMessageViews.md b/old_docs/API_docs_v81/constructors/updateChannelMessageViews.md new file mode 100644 index 00000000..19e0b648 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChannelMessageViews.md @@ -0,0 +1,45 @@ +--- +title: updateChannelMessageViews +description: updateChannelMessageViews attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelMessageViews +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|id|[int](../types/int.md) | Yes| +|views|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChannelMessageViews = ['_' => 'updateChannelMessageViews', 'channel_id' => int, 'id' => int, 'views' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChannelMessageViews", "channel_id": int, "id": int, "views": int} +``` + + +Or, if you're into Lua: + + +``` +updateChannelMessageViews={_='updateChannelMessageViews', channel_id=int, id=int, views=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChannelPinnedMessage.md b/old_docs/API_docs_v81/constructors/updateChannelPinnedMessage.md new file mode 100644 index 00000000..c6e66353 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChannelPinnedMessage.md @@ -0,0 +1,44 @@ +--- +title: updateChannelPinnedMessage +description: updateChannelPinnedMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelPinnedMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|id|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChannelPinnedMessage = ['_' => 'updateChannelPinnedMessage', 'channel_id' => int, 'id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChannelPinnedMessage", "channel_id": int, "id": int} +``` + + +Or, if you're into Lua: + + +``` +updateChannelPinnedMessage={_='updateChannelPinnedMessage', channel_id=int, id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChannelReadMessagesContents.md b/old_docs/API_docs_v81/constructors/updateChannelReadMessagesContents.md new file mode 100644 index 00000000..27c1ca60 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChannelReadMessagesContents.md @@ -0,0 +1,44 @@ +--- +title: updateChannelReadMessagesContents +description: updateChannelReadMessagesContents attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelReadMessagesContents +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|messages|Array of [int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChannelReadMessagesContents = ['_' => 'updateChannelReadMessagesContents', 'channel_id' => int, 'messages' => [int, int]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChannelReadMessagesContents", "channel_id": int, "messages": [int]} +``` + + +Or, if you're into Lua: + + +``` +updateChannelReadMessagesContents={_='updateChannelReadMessagesContents', channel_id=int, messages={int}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChannelTooLong.md b/old_docs/API_docs_v81/constructors/updateChannelTooLong.md new file mode 100644 index 00000000..e42904d0 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChannelTooLong.md @@ -0,0 +1,44 @@ +--- +title: updateChannelTooLong +description: updateChannelTooLong attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelTooLong +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|pts|[int](../types/int.md) | Optional| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChannelTooLong = ['_' => 'updateChannelTooLong', 'channel_id' => int, 'pts' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChannelTooLong", "channel_id": int, "pts": int} +``` + + +Or, if you're into Lua: + + +``` +updateChannelTooLong={_='updateChannelTooLong', channel_id=int, pts=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChannelWebPage.md b/old_docs/API_docs_v81/constructors/updateChannelWebPage.md new file mode 100644 index 00000000..f1ae421b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChannelWebPage.md @@ -0,0 +1,46 @@ +--- +title: updateChannelWebPage +description: updateChannelWebPage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelWebPage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|webpage|[WebPage](../types/WebPage.md) | Optional| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChannelWebPage = ['_' => 'updateChannelWebPage', 'channel_id' => int, 'webpage' => WebPage, 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChannelWebPage", "channel_id": int, "webpage": WebPage, "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +updateChannelWebPage={_='updateChannelWebPage', channel_id=int, webpage=WebPage, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChatAdmins.md b/old_docs/API_docs_v81/constructors/updateChatAdmins.md new file mode 100644 index 00000000..87ffd626 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChatAdmins.md @@ -0,0 +1,45 @@ +--- +title: updateChatAdmins +description: updateChatAdmins attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatAdmins +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| +|enabled|[Bool](../types/Bool.md) | Yes| +|version|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChatAdmins = ['_' => 'updateChatAdmins', 'chat_id' => int, 'enabled' => Bool, 'version' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChatAdmins", "chat_id": int, "enabled": Bool, "version": int} +``` + + +Or, if you're into Lua: + + +``` +updateChatAdmins={_='updateChatAdmins', chat_id=int, enabled=Bool, version=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChatParticipantAdd.md b/old_docs/API_docs_v81/constructors/updateChatParticipantAdd.md new file mode 100644 index 00000000..ea5157ad --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChatParticipantAdd.md @@ -0,0 +1,47 @@ +--- +title: updateChatParticipantAdd +description: updateChatParticipantAdd attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatParticipantAdd +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|inviter\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|version|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChatParticipantAdd = ['_' => 'updateChatParticipantAdd', 'chat_id' => int, 'user_id' => int, 'inviter_id' => int, 'date' => int, 'version' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChatParticipantAdd", "chat_id": int, "user_id": int, "inviter_id": int, "date": int, "version": int} +``` + + +Or, if you're into Lua: + + +``` +updateChatParticipantAdd={_='updateChatParticipantAdd', chat_id=int, user_id=int, inviter_id=int, date=int, version=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChatParticipantAdmin.md b/old_docs/API_docs_v81/constructors/updateChatParticipantAdmin.md new file mode 100644 index 00000000..b1022850 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChatParticipantAdmin.md @@ -0,0 +1,46 @@ +--- +title: updateChatParticipantAdmin +description: updateChatParticipantAdmin attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatParticipantAdmin +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|is\_admin|[Bool](../types/Bool.md) | Yes| +|version|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChatParticipantAdmin = ['_' => 'updateChatParticipantAdmin', 'chat_id' => int, 'user_id' => int, 'is_admin' => Bool, 'version' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChatParticipantAdmin", "chat_id": int, "user_id": int, "is_admin": Bool, "version": int} +``` + + +Or, if you're into Lua: + + +``` +updateChatParticipantAdmin={_='updateChatParticipantAdmin', chat_id=int, user_id=int, is_admin=Bool, version=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChatParticipantDelete.md b/old_docs/API_docs_v81/constructors/updateChatParticipantDelete.md new file mode 100644 index 00000000..c34851b4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChatParticipantDelete.md @@ -0,0 +1,45 @@ +--- +title: updateChatParticipantDelete +description: updateChatParticipantDelete attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatParticipantDelete +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|version|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChatParticipantDelete = ['_' => 'updateChatParticipantDelete', 'chat_id' => int, 'user_id' => int, 'version' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChatParticipantDelete", "chat_id": int, "user_id": int, "version": int} +``` + + +Or, if you're into Lua: + + +``` +updateChatParticipantDelete={_='updateChatParticipantDelete', chat_id=int, user_id=int, version=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChatParticipants.md b/old_docs/API_docs_v81/constructors/updateChatParticipants.md new file mode 100644 index 00000000..3b6a1ad2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChatParticipants.md @@ -0,0 +1,43 @@ +--- +title: updateChatParticipants +description: updateChatParticipants attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatParticipants +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|participants|[ChatParticipants](../types/ChatParticipants.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChatParticipants = ['_' => 'updateChatParticipants', 'participants' => ChatParticipants]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChatParticipants", "participants": ChatParticipants} +``` + + +Or, if you're into Lua: + + +``` +updateChatParticipants={_='updateChatParticipants', participants=ChatParticipants} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateChatUserTyping.md b/old_docs/API_docs_v81/constructors/updateChatUserTyping.md new file mode 100644 index 00000000..1dca6b0b --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateChatUserTyping.md @@ -0,0 +1,45 @@ +--- +title: updateChatUserTyping +description: updateChatUserTyping attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatUserTyping +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateChatUserTyping = ['_' => 'updateChatUserTyping', 'chat_id' => int, 'user_id' => int, 'action' => SendMessageAction]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateChatUserTyping", "chat_id": int, "user_id": int, "action": SendMessageAction} +``` + + +Or, if you're into Lua: + + +``` +updateChatUserTyping={_='updateChatUserTyping', chat_id=int, user_id=int, action=SendMessageAction} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateConfig.md b/old_docs/API_docs_v81/constructors/updateConfig.md new file mode 100644 index 00000000..6f25cf11 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateConfig.md @@ -0,0 +1,38 @@ +--- +title: updateConfig +description: updateConfig attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateConfig +[Back to constructors index](index.md) + + + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateConfig = ['_' => 'updateConfig']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateConfig"} +``` + + +Or, if you're into Lua: + + +``` +updateConfig={_='updateConfig'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateContactLink.md b/old_docs/API_docs_v81/constructors/updateContactLink.md new file mode 100644 index 00000000..590e1eff --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateContactLink.md @@ -0,0 +1,45 @@ +--- +title: updateContactLink +description: updateContactLink attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateContactLink +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|my\_link|[ContactLink](../types/ContactLink.md) | Yes| +|foreign\_link|[ContactLink](../types/ContactLink.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateContactLink = ['_' => 'updateContactLink', 'user_id' => int, 'my_link' => ContactLink, 'foreign_link' => ContactLink]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateContactLink", "user_id": int, "my_link": ContactLink, "foreign_link": ContactLink} +``` + + +Or, if you're into Lua: + + +``` +updateContactLink={_='updateContactLink', user_id=int, my_link=ContactLink, foreign_link=ContactLink} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateContactRegistered.md b/old_docs/API_docs_v81/constructors/updateContactRegistered.md new file mode 100644 index 00000000..28ee492d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateContactRegistered.md @@ -0,0 +1,44 @@ +--- +title: updateContactRegistered +description: updateContactRegistered attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateContactRegistered +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateContactRegistered = ['_' => 'updateContactRegistered', 'user_id' => int, 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateContactRegistered", "user_id": int, "date": int} +``` + + +Or, if you're into Lua: + + +``` +updateContactRegistered={_='updateContactRegistered', user_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateContactsReset.md b/old_docs/API_docs_v81/constructors/updateContactsReset.md new file mode 100644 index 00000000..3c9f46af --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateContactsReset.md @@ -0,0 +1,38 @@ +--- +title: updateContactsReset +description: updateContactsReset attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateContactsReset +[Back to constructors index](index.md) + + + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateContactsReset = ['_' => 'updateContactsReset']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateContactsReset"} +``` + + +Or, if you're into Lua: + + +``` +updateContactsReset={_='updateContactsReset'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateDcOptions.md b/old_docs/API_docs_v81/constructors/updateDcOptions.md new file mode 100644 index 00000000..62e306fa --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateDcOptions.md @@ -0,0 +1,43 @@ +--- +title: updateDcOptions +description: updateDcOptions attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDcOptions +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|dc\_options|Array of [DcOption](../types/DcOption.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateDcOptions = ['_' => 'updateDcOptions', 'dc_options' => [DcOption, DcOption]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateDcOptions", "dc_options": [DcOption]} +``` + + +Or, if you're into Lua: + + +``` +updateDcOptions={_='updateDcOptions', dc_options={DcOption}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateDeleteChannelMessages.md b/old_docs/API_docs_v81/constructors/updateDeleteChannelMessages.md new file mode 100644 index 00000000..0f84f3f7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateDeleteChannelMessages.md @@ -0,0 +1,46 @@ +--- +title: updateDeleteChannelMessages +description: updateDeleteChannelMessages attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDeleteChannelMessages +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|messages|Array of [int](../types/int.md) | Yes| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateDeleteChannelMessages = ['_' => 'updateDeleteChannelMessages', 'channel_id' => int, 'messages' => [int, int], 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateDeleteChannelMessages", "channel_id": int, "messages": [int], "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +updateDeleteChannelMessages={_='updateDeleteChannelMessages', channel_id=int, messages={int}, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateDeleteMessages.md b/old_docs/API_docs_v81/constructors/updateDeleteMessages.md new file mode 100644 index 00000000..d0f1b2a2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateDeleteMessages.md @@ -0,0 +1,45 @@ +--- +title: updateDeleteMessages +description: updateDeleteMessages attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDeleteMessages +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|messages|Array of [int](../types/int.md) | Yes| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateDeleteMessages = ['_' => 'updateDeleteMessages', 'messages' => [int, int], 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateDeleteMessages", "messages": [int], "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +updateDeleteMessages={_='updateDeleteMessages', messages={int}, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateDialogPinned.md b/old_docs/API_docs_v81/constructors/updateDialogPinned.md new file mode 100644 index 00000000..a79af7d5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateDialogPinned.md @@ -0,0 +1,44 @@ +--- +title: updateDialogPinned +description: updateDialogPinned attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDialogPinned +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|pinned|[Bool](../types/Bool.md) | Optional| +|peer|[DialogPeer](../types/DialogPeer.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateDialogPinned = ['_' => 'updateDialogPinned', 'pinned' => Bool, 'peer' => DialogPeer]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateDialogPinned", "pinned": Bool, "peer": DialogPeer} +``` + + +Or, if you're into Lua: + + +``` +updateDialogPinned={_='updateDialogPinned', pinned=Bool, peer=DialogPeer} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateDraftMessage.md b/old_docs/API_docs_v81/constructors/updateDraftMessage.md new file mode 100644 index 00000000..7e759a4f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateDraftMessage.md @@ -0,0 +1,44 @@ +--- +title: updateDraftMessage +description: updateDraftMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDraftMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Peer](../types/Peer.md) | Yes| +|draft|[DraftMessage](../types/DraftMessage.md) | Optional| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateDraftMessage = ['_' => 'updateDraftMessage', 'peer' => Peer, 'draft' => DraftMessage]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateDraftMessage", "peer": Peer, "draft": DraftMessage} +``` + + +Or, if you're into Lua: + + +``` +updateDraftMessage={_='updateDraftMessage', peer=Peer, draft=DraftMessage} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateEditChannelMessage.md b/old_docs/API_docs_v81/constructors/updateEditChannelMessage.md new file mode 100644 index 00000000..959c433a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateEditChannelMessage.md @@ -0,0 +1,45 @@ +--- +title: updateEditChannelMessage +description: updateEditChannelMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEditChannelMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|message|[Message](../types/Message.md) | Optional| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateEditChannelMessage = ['_' => 'updateEditChannelMessage', 'message' => Message, 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateEditChannelMessage", "message": Message, "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +updateEditChannelMessage={_='updateEditChannelMessage', message=Message, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateEditMessage.md b/old_docs/API_docs_v81/constructors/updateEditMessage.md new file mode 100644 index 00000000..f9f820e8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateEditMessage.md @@ -0,0 +1,45 @@ +--- +title: updateEditMessage +description: updateEditMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEditMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|message|[Message](../types/Message.md) | Optional| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateEditMessage = ['_' => 'updateEditMessage', 'message' => Message, 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateEditMessage", "message": Message, "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +updateEditMessage={_='updateEditMessage', message=Message, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateEncryptedChatTyping.md b/old_docs/API_docs_v81/constructors/updateEncryptedChatTyping.md new file mode 100644 index 00000000..0b327071 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateEncryptedChatTyping.md @@ -0,0 +1,43 @@ +--- +title: updateEncryptedChatTyping +description: updateEncryptedChatTyping attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEncryptedChatTyping +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateEncryptedChatTyping = ['_' => 'updateEncryptedChatTyping', 'chat_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateEncryptedChatTyping", "chat_id": int} +``` + + +Or, if you're into Lua: + + +``` +updateEncryptedChatTyping={_='updateEncryptedChatTyping', chat_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateEncryptedMessagesRead.md b/old_docs/API_docs_v81/constructors/updateEncryptedMessagesRead.md new file mode 100644 index 00000000..d2cdfb9c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateEncryptedMessagesRead.md @@ -0,0 +1,45 @@ +--- +title: updateEncryptedMessagesRead +description: updateEncryptedMessagesRead attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEncryptedMessagesRead +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat\_id|[int](../types/int.md) | Yes| +|max\_date|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateEncryptedMessagesRead = ['_' => 'updateEncryptedMessagesRead', 'chat_id' => int, 'max_date' => int, 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateEncryptedMessagesRead", "chat_id": int, "max_date": int, "date": int} +``` + + +Or, if you're into Lua: + + +``` +updateEncryptedMessagesRead={_='updateEncryptedMessagesRead', chat_id=int, max_date=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateEncryption.md b/old_docs/API_docs_v81/constructors/updateEncryption.md new file mode 100644 index 00000000..25405dd8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateEncryption.md @@ -0,0 +1,44 @@ +--- +title: updateEncryption +description: updateEncryption attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEncryption +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|chat|[EncryptedChat](../types/EncryptedChat.md) | Optional| +|date|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateEncryption = ['_' => 'updateEncryption', 'chat' => EncryptedChat, 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateEncryption", "chat": EncryptedChat, "date": int} +``` + + +Or, if you're into Lua: + + +``` +updateEncryption={_='updateEncryption', chat=EncryptedChat, date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateFavedStickers.md b/old_docs/API_docs_v81/constructors/updateFavedStickers.md new file mode 100644 index 00000000..b474cc03 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateFavedStickers.md @@ -0,0 +1,38 @@ +--- +title: updateFavedStickers +description: updateFavedStickers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateFavedStickers +[Back to constructors index](index.md) + + + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateFavedStickers = ['_' => 'updateFavedStickers']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateFavedStickers"} +``` + + +Or, if you're into Lua: + + +``` +updateFavedStickers={_='updateFavedStickers'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateInlineBotCallbackQuery.md b/old_docs/API_docs_v81/constructors/updateInlineBotCallbackQuery.md new file mode 100644 index 00000000..b1b40479 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateInlineBotCallbackQuery.md @@ -0,0 +1,48 @@ +--- +title: updateInlineBotCallbackQuery +description: updateInlineBotCallbackQuery attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateInlineBotCallbackQuery +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|query\_id|[long](../types/long.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|msg\_id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| +|chat\_instance|[long](../types/long.md) | Yes| +|data|[bytes](../types/bytes.md) | Optional| +|game\_short\_name|[string](../types/string.md) | Optional| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateInlineBotCallbackQuery = ['_' => 'updateInlineBotCallbackQuery', 'query_id' => long, 'user_id' => int, 'msg_id' => InputBotInlineMessageID, 'chat_instance' => long, 'data' => 'bytes', 'game_short_name' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateInlineBotCallbackQuery", "query_id": long, "user_id": int, "msg_id": InputBotInlineMessageID, "chat_instance": long, "data": {"_": "bytes", "bytes":"base64 encoded bytes"}, "game_short_name": "string"} +``` + + +Or, if you're into Lua: + + +``` +updateInlineBotCallbackQuery={_='updateInlineBotCallbackQuery', query_id=long, user_id=int, msg_id=InputBotInlineMessageID, chat_instance=long, data='bytes', game_short_name='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateLangPack.md b/old_docs/API_docs_v81/constructors/updateLangPack.md new file mode 100644 index 00000000..172c1a9a --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateLangPack.md @@ -0,0 +1,43 @@ +--- +title: updateLangPack +description: updateLangPack attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateLangPack +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|difference|[LangPackDifference](../types/LangPackDifference.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateLangPack = ['_' => 'updateLangPack', 'difference' => LangPackDifference]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateLangPack", "difference": LangPackDifference} +``` + + +Or, if you're into Lua: + + +``` +updateLangPack={_='updateLangPack', difference=LangPackDifference} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateLangPackTooLong.md b/old_docs/API_docs_v81/constructors/updateLangPackTooLong.md new file mode 100644 index 00000000..b55c7e33 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateLangPackTooLong.md @@ -0,0 +1,38 @@ +--- +title: updateLangPackTooLong +description: updateLangPackTooLong attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateLangPackTooLong +[Back to constructors index](index.md) + + + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateLangPackTooLong = ['_' => 'updateLangPackTooLong']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateLangPackTooLong"} +``` + + +Or, if you're into Lua: + + +``` +updateLangPackTooLong={_='updateLangPackTooLong'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateMessageID.md b/old_docs/API_docs_v81/constructors/updateMessageID.md new file mode 100644 index 00000000..7685b9af --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateMessageID.md @@ -0,0 +1,43 @@ +--- +title: updateMessageID +description: updateMessageID attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateMessageID +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateMessageID = ['_' => 'updateMessageID', 'id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateMessageID", "id": int} +``` + + +Or, if you're into Lua: + + +``` +updateMessageID={_='updateMessageID', id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateNewChannelMessage.md b/old_docs/API_docs_v81/constructors/updateNewChannelMessage.md new file mode 100644 index 00000000..59dbc820 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateNewChannelMessage.md @@ -0,0 +1,45 @@ +--- +title: updateNewChannelMessage +description: updateNewChannelMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNewChannelMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|message|[Message](../types/Message.md) | Optional| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateNewChannelMessage = ['_' => 'updateNewChannelMessage', 'message' => Message, 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateNewChannelMessage", "message": Message, "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +updateNewChannelMessage={_='updateNewChannelMessage', message=Message, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateNewEncryptedMessage.md b/old_docs/API_docs_v81/constructors/updateNewEncryptedMessage.md new file mode 100644 index 00000000..44b3a6da --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateNewEncryptedMessage.md @@ -0,0 +1,44 @@ +--- +title: updateNewEncryptedMessage +description: updateNewEncryptedMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNewEncryptedMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|message|[EncryptedMessage](../types/EncryptedMessage.md) | Yes| +|qts|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateNewEncryptedMessage = ['_' => 'updateNewEncryptedMessage', 'message' => EncryptedMessage, 'qts' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateNewEncryptedMessage", "message": EncryptedMessage, "qts": int} +``` + + +Or, if you're into Lua: + + +``` +updateNewEncryptedMessage={_='updateNewEncryptedMessage', message=EncryptedMessage, qts=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateNewMessage.md b/old_docs/API_docs_v81/constructors/updateNewMessage.md new file mode 100644 index 00000000..51ac9eed --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateNewMessage.md @@ -0,0 +1,45 @@ +--- +title: updateNewMessage +description: updateNewMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNewMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|message|[Message](../types/Message.md) | Optional| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateNewMessage = ['_' => 'updateNewMessage', 'message' => Message, 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateNewMessage", "message": Message, "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +updateNewMessage={_='updateNewMessage', message=Message, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateNewStickerSet.md b/old_docs/API_docs_v81/constructors/updateNewStickerSet.md new file mode 100644 index 00000000..c36d4617 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateNewStickerSet.md @@ -0,0 +1,43 @@ +--- +title: updateNewStickerSet +description: updateNewStickerSet attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNewStickerSet +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|stickerset|[messages\_StickerSet](../types/messages_StickerSet.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateNewStickerSet = ['_' => 'updateNewStickerSet', 'stickerset' => messages_StickerSet]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateNewStickerSet", "stickerset": messages_StickerSet} +``` + + +Or, if you're into Lua: + + +``` +updateNewStickerSet={_='updateNewStickerSet', stickerset=messages_StickerSet} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateNotifySettings.md b/old_docs/API_docs_v81/constructors/updateNotifySettings.md new file mode 100644 index 00000000..686aa10f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateNotifySettings.md @@ -0,0 +1,44 @@ +--- +title: updateNotifySettings +description: updateNotifySettings attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNotifySettings +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[NotifyPeer](../types/NotifyPeer.md) | Yes| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateNotifySettings = ['_' => 'updateNotifySettings', 'peer' => NotifyPeer, 'notify_settings' => PeerNotifySettings]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateNotifySettings", "peer": NotifyPeer, "notify_settings": PeerNotifySettings} +``` + + +Or, if you're into Lua: + + +``` +updateNotifySettings={_='updateNotifySettings', peer=NotifyPeer, notify_settings=PeerNotifySettings} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updatePhoneCall.md b/old_docs/API_docs_v81/constructors/updatePhoneCall.md new file mode 100644 index 00000000..61730eae --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updatePhoneCall.md @@ -0,0 +1,43 @@ +--- +title: updatePhoneCall +description: updatePhoneCall attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePhoneCall +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|phone\_call|[PhoneCall](../types/PhoneCall.md) | Optional| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updatePhoneCall = ['_' => 'updatePhoneCall', 'phone_call' => PhoneCall]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updatePhoneCall", "phone_call": PhoneCall} +``` + + +Or, if you're into Lua: + + +``` +updatePhoneCall={_='updatePhoneCall', phone_call=PhoneCall} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updatePinnedDialogs.md b/old_docs/API_docs_v81/constructors/updatePinnedDialogs.md new file mode 100644 index 00000000..b33518c6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updatePinnedDialogs.md @@ -0,0 +1,43 @@ +--- +title: updatePinnedDialogs +description: updatePinnedDialogs attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePinnedDialogs +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|order|Array of [DialogPeer](../types/DialogPeer.md) | Optional| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updatePinnedDialogs = ['_' => 'updatePinnedDialogs', 'order' => [DialogPeer, DialogPeer]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updatePinnedDialogs", "order": [DialogPeer]} +``` + + +Or, if you're into Lua: + + +``` +updatePinnedDialogs={_='updatePinnedDialogs', order={DialogPeer}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updatePrivacy.md b/old_docs/API_docs_v81/constructors/updatePrivacy.md new file mode 100644 index 00000000..a54977e2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updatePrivacy.md @@ -0,0 +1,44 @@ +--- +title: updatePrivacy +description: updatePrivacy attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePrivacy +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|key|[PrivacyKey](../types/PrivacyKey.md) | Yes| +|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updatePrivacy = ['_' => 'updatePrivacy', 'key' => PrivacyKey, 'rules' => [PrivacyRule, PrivacyRule]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updatePrivacy", "key": PrivacyKey, "rules": [PrivacyRule]} +``` + + +Or, if you're into Lua: + + +``` +updatePrivacy={_='updatePrivacy', key=PrivacyKey, rules={PrivacyRule}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updatePtsChanged.md b/old_docs/API_docs_v81/constructors/updatePtsChanged.md new file mode 100644 index 00000000..76b49a1f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updatePtsChanged.md @@ -0,0 +1,38 @@ +--- +title: updatePtsChanged +description: updatePtsChanged attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePtsChanged +[Back to constructors index](index.md) + + + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updatePtsChanged = ['_' => 'updatePtsChanged']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updatePtsChanged"} +``` + + +Or, if you're into Lua: + + +``` +updatePtsChanged={_='updatePtsChanged'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateReadChannelInbox.md b/old_docs/API_docs_v81/constructors/updateReadChannelInbox.md new file mode 100644 index 00000000..be964e20 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateReadChannelInbox.md @@ -0,0 +1,44 @@ +--- +title: updateReadChannelInbox +description: updateReadChannelInbox attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadChannelInbox +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|max\_id|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateReadChannelInbox = ['_' => 'updateReadChannelInbox', 'channel_id' => int, 'max_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateReadChannelInbox", "channel_id": int, "max_id": int} +``` + + +Or, if you're into Lua: + + +``` +updateReadChannelInbox={_='updateReadChannelInbox', channel_id=int, max_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateReadChannelOutbox.md b/old_docs/API_docs_v81/constructors/updateReadChannelOutbox.md new file mode 100644 index 00000000..c725d108 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateReadChannelOutbox.md @@ -0,0 +1,44 @@ +--- +title: updateReadChannelOutbox +description: updateReadChannelOutbox attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadChannelOutbox +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|channel\_id|[int](../types/int.md) | Yes| +|max\_id|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateReadChannelOutbox = ['_' => 'updateReadChannelOutbox', 'channel_id' => int, 'max_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateReadChannelOutbox", "channel_id": int, "max_id": int} +``` + + +Or, if you're into Lua: + + +``` +updateReadChannelOutbox={_='updateReadChannelOutbox', channel_id=int, max_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateReadFeaturedStickers.md b/old_docs/API_docs_v81/constructors/updateReadFeaturedStickers.md new file mode 100644 index 00000000..ea46d41f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateReadFeaturedStickers.md @@ -0,0 +1,38 @@ +--- +title: updateReadFeaturedStickers +description: updateReadFeaturedStickers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadFeaturedStickers +[Back to constructors index](index.md) + + + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateReadFeaturedStickers = ['_' => 'updateReadFeaturedStickers']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateReadFeaturedStickers"} +``` + + +Or, if you're into Lua: + + +``` +updateReadFeaturedStickers={_='updateReadFeaturedStickers'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateReadHistoryInbox.md b/old_docs/API_docs_v81/constructors/updateReadHistoryInbox.md new file mode 100644 index 00000000..3a0a3401 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateReadHistoryInbox.md @@ -0,0 +1,46 @@ +--- +title: updateReadHistoryInbox +description: updateReadHistoryInbox attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadHistoryInbox +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Peer](../types/Peer.md) | Yes| +|max\_id|[int](../types/int.md) | Yes| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateReadHistoryInbox = ['_' => 'updateReadHistoryInbox', 'peer' => Peer, 'max_id' => int, 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateReadHistoryInbox", "peer": Peer, "max_id": int, "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +updateReadHistoryInbox={_='updateReadHistoryInbox', peer=Peer, max_id=int, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateReadHistoryOutbox.md b/old_docs/API_docs_v81/constructors/updateReadHistoryOutbox.md new file mode 100644 index 00000000..6137fdf3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateReadHistoryOutbox.md @@ -0,0 +1,46 @@ +--- +title: updateReadHistoryOutbox +description: updateReadHistoryOutbox attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadHistoryOutbox +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Peer](../types/Peer.md) | Yes| +|max\_id|[int](../types/int.md) | Yes| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateReadHistoryOutbox = ['_' => 'updateReadHistoryOutbox', 'peer' => Peer, 'max_id' => int, 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateReadHistoryOutbox", "peer": Peer, "max_id": int, "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +updateReadHistoryOutbox={_='updateReadHistoryOutbox', peer=Peer, max_id=int, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateReadMessagesContents.md b/old_docs/API_docs_v81/constructors/updateReadMessagesContents.md new file mode 100644 index 00000000..54dc08d8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateReadMessagesContents.md @@ -0,0 +1,45 @@ +--- +title: updateReadMessagesContents +description: updateReadMessagesContents attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadMessagesContents +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|messages|Array of [int](../types/int.md) | Yes| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateReadMessagesContents = ['_' => 'updateReadMessagesContents', 'messages' => [int, int], 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateReadMessagesContents", "messages": [int], "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +updateReadMessagesContents={_='updateReadMessagesContents', messages={int}, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateRecentStickers.md b/old_docs/API_docs_v81/constructors/updateRecentStickers.md new file mode 100644 index 00000000..cb15d01f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateRecentStickers.md @@ -0,0 +1,38 @@ +--- +title: updateRecentStickers +description: updateRecentStickers attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateRecentStickers +[Back to constructors index](index.md) + + + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateRecentStickers = ['_' => 'updateRecentStickers']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateRecentStickers"} +``` + + +Or, if you're into Lua: + + +``` +updateRecentStickers={_='updateRecentStickers'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateSavedGifs.md b/old_docs/API_docs_v81/constructors/updateSavedGifs.md new file mode 100644 index 00000000..dd17f321 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateSavedGifs.md @@ -0,0 +1,38 @@ +--- +title: updateSavedGifs +description: updateSavedGifs attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateSavedGifs +[Back to constructors index](index.md) + + + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateSavedGifs = ['_' => 'updateSavedGifs']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateSavedGifs"} +``` + + +Or, if you're into Lua: + + +``` +updateSavedGifs={_='updateSavedGifs'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateServiceNotification.md b/old_docs/API_docs_v81/constructors/updateServiceNotification.md new file mode 100644 index 00000000..1da6885f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateServiceNotification.md @@ -0,0 +1,48 @@ +--- +title: updateServiceNotification +description: updateServiceNotification attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateServiceNotification +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|popup|[Bool](../types/Bool.md) | Optional| +|inbox\_date|[int](../types/int.md) | Optional| +|type|[string](../types/string.md) | Yes| +|message|[string](../types/string.md) | Yes| +|media|[MessageMedia](../types/MessageMedia.md) | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateServiceNotification = ['_' => 'updateServiceNotification', 'popup' => Bool, 'inbox_date' => int, 'type' => 'string', 'message' => 'string', 'media' => MessageMedia, 'entities' => [MessageEntity, MessageEntity]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateServiceNotification", "popup": Bool, "inbox_date": int, "type": "string", "message": "string", "media": MessageMedia, "entities": [MessageEntity]} +``` + + +Or, if you're into Lua: + + +``` +updateServiceNotification={_='updateServiceNotification', popup=Bool, inbox_date=int, type='string', message='string', media=MessageMedia, entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateShort.md b/old_docs/API_docs_v81/constructors/updateShort.md new file mode 100644 index 00000000..28f84c78 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateShort.md @@ -0,0 +1,44 @@ +--- +title: updateShort +description: updateShort attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateShort +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|update|[Update](../types/Update.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +``` +$updateShort = ['_' => 'updateShort', 'update' => Update, 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateShort", "update": Update, "date": int} +``` + + +Or, if you're into Lua: + + +``` +updateShort={_='updateShort', update=Update, date=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateShortChatMessage.md b/old_docs/API_docs_v81/constructors/updateShortChatMessage.md new file mode 100644 index 00000000..d62e0729 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateShortChatMessage.md @@ -0,0 +1,57 @@ +--- +title: updateShortChatMessage +description: updateShortChatMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateShortChatMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|out|[Bool](../types/Bool.md) | Optional| +|mentioned|[Bool](../types/Bool.md) | Optional| +|media\_unread|[Bool](../types/Bool.md) | Optional| +|silent|[Bool](../types/Bool.md) | Optional| +|id|[int](../types/int.md) | Yes| +|from\_id|[int](../types/int.md) | Yes| +|chat\_id|[int](../types/int.md) | Yes| +|message|[string](../types/string.md) | Yes| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional| +|via\_bot\_id|[int](../types/int.md) | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +``` +$updateShortChatMessage = ['_' => 'updateShortChatMessage', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'id' => int, 'from_id' => int, 'chat_id' => int, 'message' => 'string', 'pts' => int, 'pts_count' => int, 'date' => int, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to_msg_id' => int, 'entities' => [MessageEntity, MessageEntity]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateShortChatMessage", "out": Bool, "mentioned": Bool, "media_unread": Bool, "silent": Bool, "id": int, "from_id": int, "chat_id": int, "message": "string", "pts": int, "pts_count": int, "date": int, "fwd_from": MessageFwdHeader, "via_bot_id": int, "reply_to_msg_id": int, "entities": [MessageEntity]} +``` + + +Or, if you're into Lua: + + +``` +updateShortChatMessage={_='updateShortChatMessage', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, id=int, from_id=int, chat_id=int, message='string', pts=int, pts_count=int, date=int, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to_msg_id=int, entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateShortMessage.md b/old_docs/API_docs_v81/constructors/updateShortMessage.md new file mode 100644 index 00000000..d4effcb8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateShortMessage.md @@ -0,0 +1,56 @@ +--- +title: updateShortMessage +description: updateShortMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateShortMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|out|[Bool](../types/Bool.md) | Optional| +|mentioned|[Bool](../types/Bool.md) | Optional| +|media\_unread|[Bool](../types/Bool.md) | Optional| +|silent|[Bool](../types/Bool.md) | Optional| +|id|[int](../types/int.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|message|[string](../types/string.md) | Yes| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional| +|via\_bot\_id|[int](../types/int.md) | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +``` +$updateShortMessage = ['_' => 'updateShortMessage', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'id' => int, 'user_id' => int, 'message' => 'string', 'pts' => int, 'pts_count' => int, 'date' => int, 'fwd_from' => MessageFwdHeader, 'via_bot_id' => int, 'reply_to_msg_id' => int, 'entities' => [MessageEntity, MessageEntity]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateShortMessage", "out": Bool, "mentioned": Bool, "media_unread": Bool, "silent": Bool, "id": int, "user_id": int, "message": "string", "pts": int, "pts_count": int, "date": int, "fwd_from": MessageFwdHeader, "via_bot_id": int, "reply_to_msg_id": int, "entities": [MessageEntity]} +``` + + +Or, if you're into Lua: + + +``` +updateShortMessage={_='updateShortMessage', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, id=int, user_id=int, message='string', pts=int, pts_count=int, date=int, fwd_from=MessageFwdHeader, via_bot_id=int, reply_to_msg_id=int, entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateShortSentMessage.md b/old_docs/API_docs_v81/constructors/updateShortSentMessage.md new file mode 100644 index 00000000..fd7035c3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateShortSentMessage.md @@ -0,0 +1,49 @@ +--- +title: updateShortSentMessage +description: updateShortSentMessage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateShortSentMessage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|out|[Bool](../types/Bool.md) | Optional| +|id|[int](../types/int.md) | Yes| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|media|[MessageMedia](../types/MessageMedia.md) | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +``` +$updateShortSentMessage = ['_' => 'updateShortSentMessage', 'out' => Bool, 'id' => int, 'pts' => int, 'pts_count' => int, 'date' => int, 'media' => MessageMedia, 'entities' => [MessageEntity, MessageEntity]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateShortSentMessage", "out": Bool, "id": int, "pts": int, "pts_count": int, "date": int, "media": MessageMedia, "entities": [MessageEntity]} +``` + + +Or, if you're into Lua: + + +``` +updateShortSentMessage={_='updateShortSentMessage', out=Bool, id=int, pts=int, pts_count=int, date=int, media=MessageMedia, entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateStickerSets.md b/old_docs/API_docs_v81/constructors/updateStickerSets.md new file mode 100644 index 00000000..4f045d67 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateStickerSets.md @@ -0,0 +1,38 @@ +--- +title: updateStickerSets +description: updateStickerSets attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateStickerSets +[Back to constructors index](index.md) + + + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateStickerSets = ['_' => 'updateStickerSets']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateStickerSets"} +``` + + +Or, if you're into Lua: + + +``` +updateStickerSets={_='updateStickerSets'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateStickerSetsOrder.md b/old_docs/API_docs_v81/constructors/updateStickerSetsOrder.md new file mode 100644 index 00000000..e36470ad --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateStickerSetsOrder.md @@ -0,0 +1,44 @@ +--- +title: updateStickerSetsOrder +description: updateStickerSetsOrder attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateStickerSetsOrder +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|masks|[Bool](../types/Bool.md) | Optional| +|order|Array of [long](../types/long.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateStickerSetsOrder = ['_' => 'updateStickerSetsOrder', 'masks' => Bool, 'order' => [long, long]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateStickerSetsOrder", "masks": Bool, "order": [long]} +``` + + +Or, if you're into Lua: + + +``` +updateStickerSetsOrder={_='updateStickerSetsOrder', masks=Bool, order={long}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateUserBlocked.md b/old_docs/API_docs_v81/constructors/updateUserBlocked.md new file mode 100644 index 00000000..74e2ba8c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateUserBlocked.md @@ -0,0 +1,44 @@ +--- +title: updateUserBlocked +description: updateUserBlocked attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserBlocked +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|blocked|[Bool](../types/Bool.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateUserBlocked = ['_' => 'updateUserBlocked', 'user_id' => int, 'blocked' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateUserBlocked", "user_id": int, "blocked": Bool} +``` + + +Or, if you're into Lua: + + +``` +updateUserBlocked={_='updateUserBlocked', user_id=int, blocked=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateUserName.md b/old_docs/API_docs_v81/constructors/updateUserName.md new file mode 100644 index 00000000..a57715fa --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateUserName.md @@ -0,0 +1,46 @@ +--- +title: updateUserName +description: updateUserName attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserName +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|first\_name|[string](../types/string.md) | Yes| +|last\_name|[string](../types/string.md) | Yes| +|username|[string](../types/string.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateUserName = ['_' => 'updateUserName', 'user_id' => int, 'first_name' => 'string', 'last_name' => 'string', 'username' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateUserName", "user_id": int, "first_name": "string", "last_name": "string", "username": "string"} +``` + + +Or, if you're into Lua: + + +``` +updateUserName={_='updateUserName', user_id=int, first_name='string', last_name='string', username='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateUserPhone.md b/old_docs/API_docs_v81/constructors/updateUserPhone.md new file mode 100644 index 00000000..3af56189 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateUserPhone.md @@ -0,0 +1,44 @@ +--- +title: updateUserPhone +description: updateUserPhone attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserPhone +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|phone|[string](../types/string.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateUserPhone = ['_' => 'updateUserPhone', 'user_id' => int, 'phone' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateUserPhone", "user_id": int, "phone": "string"} +``` + + +Or, if you're into Lua: + + +``` +updateUserPhone={_='updateUserPhone', user_id=int, phone='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateUserPhoto.md b/old_docs/API_docs_v81/constructors/updateUserPhoto.md new file mode 100644 index 00000000..c5684820 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateUserPhoto.md @@ -0,0 +1,46 @@ +--- +title: updateUserPhoto +description: updateUserPhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserPhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|photo|[UserProfilePhoto](../types/UserProfilePhoto.md) | Optional| +|previous|[Bool](../types/Bool.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateUserPhoto = ['_' => 'updateUserPhoto', 'user_id' => int, 'date' => int, 'photo' => UserProfilePhoto, 'previous' => Bool]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateUserPhoto", "user_id": int, "date": int, "photo": UserProfilePhoto, "previous": Bool} +``` + + +Or, if you're into Lua: + + +``` +updateUserPhoto={_='updateUserPhoto', user_id=int, date=int, photo=UserProfilePhoto, previous=Bool} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateUserStatus.md b/old_docs/API_docs_v81/constructors/updateUserStatus.md new file mode 100644 index 00000000..e5f8757c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateUserStatus.md @@ -0,0 +1,44 @@ +--- +title: updateUserStatus +description: updateUserStatus attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserStatus +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|status|[UserStatus](../types/UserStatus.md) | Optional| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateUserStatus = ['_' => 'updateUserStatus', 'user_id' => int, 'status' => UserStatus]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateUserStatus", "user_id": int, "status": UserStatus} +``` + + +Or, if you're into Lua: + + +``` +updateUserStatus={_='updateUserStatus', user_id=int, status=UserStatus} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateUserTyping.md b/old_docs/API_docs_v81/constructors/updateUserTyping.md new file mode 100644 index 00000000..c0800614 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateUserTyping.md @@ -0,0 +1,44 @@ +--- +title: updateUserTyping +description: updateUserTyping attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserTyping +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateUserTyping = ['_' => 'updateUserTyping', 'user_id' => int, 'action' => SendMessageAction]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateUserTyping", "user_id": int, "action": SendMessageAction} +``` + + +Or, if you're into Lua: + + +``` +updateUserTyping={_='updateUserTyping', user_id=int, action=SendMessageAction} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updateWebPage.md b/old_docs/API_docs_v81/constructors/updateWebPage.md new file mode 100644 index 00000000..9f468619 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updateWebPage.md @@ -0,0 +1,45 @@ +--- +title: updateWebPage +description: updateWebPage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateWebPage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|webpage|[WebPage](../types/WebPage.md) | Optional| +|pts|[int](../types/int.md) | Yes| +|pts\_count|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +``` +$updateWebPage = ['_' => 'updateWebPage', 'webpage' => WebPage, 'pts' => int, 'pts_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updateWebPage", "webpage": WebPage, "pts": int, "pts_count": int} +``` + + +Or, if you're into Lua: + + +``` +updateWebPage={_='updateWebPage', webpage=WebPage, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updates.md b/old_docs/API_docs_v81/constructors/updates.md new file mode 100644 index 00000000..c6548ada --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updates.md @@ -0,0 +1,47 @@ +--- +title: updates +description: updates attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updates +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|updates|Array of [Update](../types/Update.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|date|[int](../types/int.md) | Yes| +|seq|[int](../types/int.md) | Yes| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +``` +$updates = ['_' => 'updates', 'updates' => [Update, Update], 'users' => [User, User], 'chats' => [Chat, Chat], 'date' => int, 'seq' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updates", "updates": [Update], "users": [User], "chats": [Chat], "date": int, "seq": int} +``` + + +Or, if you're into Lua: + + +``` +updates={_='updates', updates={Update}, users={User}, chats={Chat}, date=int, seq=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updatesCombined.md b/old_docs/API_docs_v81/constructors/updatesCombined.md new file mode 100644 index 00000000..80a21d29 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updatesCombined.md @@ -0,0 +1,48 @@ +--- +title: updatesCombined +description: updatesCombined attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatesCombined +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|updates|Array of [Update](../types/Update.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|date|[int](../types/int.md) | Yes| +|seq\_start|[int](../types/int.md) | Yes| +|seq|[int](../types/int.md) | Yes| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +``` +$updatesCombined = ['_' => 'updatesCombined', 'updates' => [Update, Update], 'users' => [User, User], 'chats' => [Chat, Chat], 'date' => int, 'seq_start' => int, 'seq' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updatesCombined", "updates": [Update], "users": [User], "chats": [Chat], "date": int, "seq_start": int, "seq": int} +``` + + +Or, if you're into Lua: + + +``` +updatesCombined={_='updatesCombined', updates={Update}, users={User}, chats={Chat}, date=int, seq_start=int, seq=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updatesTooLong.md b/old_docs/API_docs_v81/constructors/updatesTooLong.md new file mode 100644 index 00000000..49b38fc2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updatesTooLong.md @@ -0,0 +1,38 @@ +--- +title: updatesTooLong +description: updatesTooLong attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatesTooLong +[Back to constructors index](index.md) + + + + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +``` +$updatesTooLong = ['_' => 'updatesTooLong']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updatesTooLong"} +``` + + +Or, if you're into Lua: + + +``` +updatesTooLong={_='updatesTooLong'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updates_channelDifference.md b/old_docs/API_docs_v81/constructors/updates_channelDifference.md new file mode 100644 index 00000000..21b618c2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updates_channelDifference.md @@ -0,0 +1,49 @@ +--- +title: updates.channelDifference +description: updates_channelDifference attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updates.channelDifference +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|final|[Bool](../types/Bool.md) | Optional| +|pts|[int](../types/int.md) | Yes| +|timeout|[int](../types/int.md) | Optional| +|new\_messages|Array of [Message](../types/Message.md) | Yes| +|other\_updates|Array of [Update](../types/Update.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [updates\_ChannelDifference](../types/updates_ChannelDifference.md) + + +### Example: + +``` +$updates_channelDifference = ['_' => 'updates.channelDifference', 'final' => Bool, 'pts' => int, 'timeout' => int, 'new_messages' => [Message, Message], 'other_updates' => [Update, Update], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updates.channelDifference", "final": Bool, "pts": int, "timeout": int, "new_messages": [Message], "other_updates": [Update], "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +updates_channelDifference={_='updates.channelDifference', final=Bool, pts=int, timeout=int, new_messages={Message}, other_updates={Update}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updates_channelDifferenceEmpty.md b/old_docs/API_docs_v81/constructors/updates_channelDifferenceEmpty.md new file mode 100644 index 00000000..a2e49340 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updates_channelDifferenceEmpty.md @@ -0,0 +1,45 @@ +--- +title: updates.channelDifferenceEmpty +description: updates_channelDifferenceEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updates.channelDifferenceEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|final|[Bool](../types/Bool.md) | Optional| +|pts|[int](../types/int.md) | Yes| +|timeout|[int](../types/int.md) | Optional| + + + +### Type: [updates\_ChannelDifference](../types/updates_ChannelDifference.md) + + +### Example: + +``` +$updates_channelDifferenceEmpty = ['_' => 'updates.channelDifferenceEmpty', 'final' => Bool, 'pts' => int, 'timeout' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updates.channelDifferenceEmpty", "final": Bool, "pts": int, "timeout": int} +``` + + +Or, if you're into Lua: + + +``` +updates_channelDifferenceEmpty={_='updates.channelDifferenceEmpty', final=Bool, pts=int, timeout=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updates_channelDifferenceTooLong.md b/old_docs/API_docs_v81/constructors/updates_channelDifferenceTooLong.md new file mode 100644 index 00000000..84834a9f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updates_channelDifferenceTooLong.md @@ -0,0 +1,53 @@ +--- +title: updates.channelDifferenceTooLong +description: updates_channelDifferenceTooLong attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updates.channelDifferenceTooLong +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|final|[Bool](../types/Bool.md) | Optional| +|pts|[int](../types/int.md) | Yes| +|timeout|[int](../types/int.md) | Optional| +|top\_message|[int](../types/int.md) | Yes| +|read\_inbox\_max\_id|[int](../types/int.md) | Yes| +|read\_outbox\_max\_id|[int](../types/int.md) | Yes| +|unread\_count|[int](../types/int.md) | Yes| +|unread\_mentions\_count|[int](../types/int.md) | Yes| +|messages|Array of [Message](../types/Message.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [updates\_ChannelDifference](../types/updates_ChannelDifference.md) + + +### Example: + +``` +$updates_channelDifferenceTooLong = ['_' => 'updates.channelDifferenceTooLong', 'final' => Bool, 'pts' => int, 'timeout' => int, 'top_message' => int, 'read_inbox_max_id' => int, 'read_outbox_max_id' => int, 'unread_count' => int, 'unread_mentions_count' => int, 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updates.channelDifferenceTooLong", "final": Bool, "pts": int, "timeout": int, "top_message": int, "read_inbox_max_id": int, "read_outbox_max_id": int, "unread_count": int, "unread_mentions_count": int, "messages": [Message], "chats": [Chat], "users": [User]} +``` + + +Or, if you're into Lua: + + +``` +updates_channelDifferenceTooLong={_='updates.channelDifferenceTooLong', final=Bool, pts=int, timeout=int, top_message=int, read_inbox_max_id=int, read_outbox_max_id=int, unread_count=int, unread_mentions_count=int, messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updates_difference.md b/old_docs/API_docs_v81/constructors/updates_difference.md new file mode 100644 index 00000000..7b8b4be5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updates_difference.md @@ -0,0 +1,48 @@ +--- +title: updates.difference +description: updates_difference attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updates.difference +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|new\_messages|Array of [Message](../types/Message.md) | Yes| +|new\_encrypted\_messages|Array of [EncryptedMessage](../types/EncryptedMessage.md) | Yes| +|other\_updates|Array of [Update](../types/Update.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| +|state|[updates\_State](../types/updates_State.md) | Yes| + + + +### Type: [updates\_Difference](../types/updates_Difference.md) + + +### Example: + +``` +$updates_difference = ['_' => 'updates.difference', 'new_messages' => [Message, Message], 'new_encrypted_messages' => [EncryptedMessage, EncryptedMessage], 'other_updates' => [Update, Update], 'chats' => [Chat, Chat], 'users' => [User, User], 'state' => updates_State]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updates.difference", "new_messages": [Message], "new_encrypted_messages": [EncryptedMessage], "other_updates": [Update], "chats": [Chat], "users": [User], "state": updates_State} +``` + + +Or, if you're into Lua: + + +``` +updates_difference={_='updates.difference', new_messages={Message}, new_encrypted_messages={EncryptedMessage}, other_updates={Update}, chats={Chat}, users={User}, state=updates_State} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updates_differenceEmpty.md b/old_docs/API_docs_v81/constructors/updates_differenceEmpty.md new file mode 100644 index 00000000..ca7dead6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updates_differenceEmpty.md @@ -0,0 +1,44 @@ +--- +title: updates.differenceEmpty +description: updates_differenceEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updates.differenceEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|date|[int](../types/int.md) | Yes| +|seq|[int](../types/int.md) | Yes| + + + +### Type: [updates\_Difference](../types/updates_Difference.md) + + +### Example: + +``` +$updates_differenceEmpty = ['_' => 'updates.differenceEmpty', 'date' => int, 'seq' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updates.differenceEmpty", "date": int, "seq": int} +``` + + +Or, if you're into Lua: + + +``` +updates_differenceEmpty={_='updates.differenceEmpty', date=int, seq=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updates_differenceSlice.md b/old_docs/API_docs_v81/constructors/updates_differenceSlice.md new file mode 100644 index 00000000..55f7a1a7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updates_differenceSlice.md @@ -0,0 +1,48 @@ +--- +title: updates.differenceSlice +description: updates_differenceSlice attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updates.differenceSlice +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|new\_messages|Array of [Message](../types/Message.md) | Yes| +|new\_encrypted\_messages|Array of [EncryptedMessage](../types/EncryptedMessage.md) | Yes| +|other\_updates|Array of [Update](../types/Update.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| +|intermediate\_state|[updates\_State](../types/updates_State.md) | Yes| + + + +### Type: [updates\_Difference](../types/updates_Difference.md) + + +### Example: + +``` +$updates_differenceSlice = ['_' => 'updates.differenceSlice', 'new_messages' => [Message, Message], 'new_encrypted_messages' => [EncryptedMessage, EncryptedMessage], 'other_updates' => [Update, Update], 'chats' => [Chat, Chat], 'users' => [User, User], 'intermediate_state' => updates_State]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updates.differenceSlice", "new_messages": [Message], "new_encrypted_messages": [EncryptedMessage], "other_updates": [Update], "chats": [Chat], "users": [User], "intermediate_state": updates_State} +``` + + +Or, if you're into Lua: + + +``` +updates_differenceSlice={_='updates.differenceSlice', new_messages={Message}, new_encrypted_messages={EncryptedMessage}, other_updates={Update}, chats={Chat}, users={User}, intermediate_state=updates_State} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updates_differenceTooLong.md b/old_docs/API_docs_v81/constructors/updates_differenceTooLong.md new file mode 100644 index 00000000..da55eddf --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updates_differenceTooLong.md @@ -0,0 +1,43 @@ +--- +title: updates.differenceTooLong +description: updates_differenceTooLong attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updates.differenceTooLong +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|pts|[int](../types/int.md) | Yes| + + + +### Type: [updates\_Difference](../types/updates_Difference.md) + + +### Example: + +``` +$updates_differenceTooLong = ['_' => 'updates.differenceTooLong', 'pts' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updates.differenceTooLong", "pts": int} +``` + + +Or, if you're into Lua: + + +``` +updates_differenceTooLong={_='updates.differenceTooLong', pts=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/updates_state.md b/old_docs/API_docs_v81/constructors/updates_state.md new file mode 100644 index 00000000..b46c224f --- /dev/null +++ b/old_docs/API_docs_v81/constructors/updates_state.md @@ -0,0 +1,47 @@ +--- +title: updates.state +description: updates_state attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updates.state +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|pts|[int](../types/int.md) | Yes| +|qts|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| +|seq|[int](../types/int.md) | Yes| +|unread\_count|[int](../types/int.md) | Yes| + + + +### Type: [updates\_State](../types/updates_State.md) + + +### Example: + +``` +$updates_state = ['_' => 'updates.state', 'pts' => int, 'qts' => int, 'date' => int, 'seq' => int, 'unread_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "updates.state", "pts": int, "qts": int, "date": int, "seq": int, "unread_count": int} +``` + + +Or, if you're into Lua: + + +``` +updates_state={_='updates.state', pts=int, qts=int, date=int, seq=int, unread_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/upload_cdnFile.md b/old_docs/API_docs_v81/constructors/upload_cdnFile.md new file mode 100644 index 00000000..b42b285d --- /dev/null +++ b/old_docs/API_docs_v81/constructors/upload_cdnFile.md @@ -0,0 +1,43 @@ +--- +title: upload.cdnFile +description: upload_cdnFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: upload.cdnFile +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|bytes|[bytes](../types/bytes.md) | Yes| + + + +### Type: [upload\_CdnFile](../types/upload_CdnFile.md) + + +### Example: + +``` +$upload_cdnFile = ['_' => 'upload.cdnFile', 'bytes' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "upload.cdnFile", "bytes": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +upload_cdnFile={_='upload.cdnFile', bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/upload_cdnFileReuploadNeeded.md b/old_docs/API_docs_v81/constructors/upload_cdnFileReuploadNeeded.md new file mode 100644 index 00000000..b770fdf6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/upload_cdnFileReuploadNeeded.md @@ -0,0 +1,43 @@ +--- +title: upload.cdnFileReuploadNeeded +description: upload_cdnFileReuploadNeeded attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: upload.cdnFileReuploadNeeded +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|request\_token|[bytes](../types/bytes.md) | Yes| + + + +### Type: [upload\_CdnFile](../types/upload_CdnFile.md) + + +### Example: + +``` +$upload_cdnFileReuploadNeeded = ['_' => 'upload.cdnFileReuploadNeeded', 'request_token' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "upload.cdnFileReuploadNeeded", "request_token": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +upload_cdnFileReuploadNeeded={_='upload.cdnFileReuploadNeeded', request_token='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/upload_file.md b/old_docs/API_docs_v81/constructors/upload_file.md new file mode 100644 index 00000000..3d2cb7b4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/upload_file.md @@ -0,0 +1,45 @@ +--- +title: upload.file +description: upload_file attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: upload.file +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|type|[storage\_FileType](../types/storage_FileType.md) | Yes| +|mtime|[int](../types/int.md) | Yes| +|bytes|[bytes](../types/bytes.md) | Yes| + + + +### Type: [upload\_File](../types/upload_File.md) + + +### Example: + +``` +$upload_file = ['_' => 'upload.file', 'type' => storage_FileType, 'mtime' => int, 'bytes' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "upload.file", "type": storage_FileType, "mtime": int, "bytes": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +upload_file={_='upload.file', type=storage_FileType, mtime=int, bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/upload_fileCdnRedirect.md b/old_docs/API_docs_v81/constructors/upload_fileCdnRedirect.md new file mode 100644 index 00000000..f5f91660 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/upload_fileCdnRedirect.md @@ -0,0 +1,47 @@ +--- +title: upload.fileCdnRedirect +description: upload_fileCdnRedirect attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: upload.fileCdnRedirect +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|dc\_id|[int](../types/int.md) | Yes| +|file\_token|[bytes](../types/bytes.md) | Yes| +|encryption\_key|[bytes](../types/bytes.md) | Yes| +|encryption\_iv|[bytes](../types/bytes.md) | Yes| +|file\_hashes|Array of [FileHash](../types/FileHash.md) | Yes| + + + +### Type: [upload\_File](../types/upload_File.md) + + +### Example: + +``` +$upload_fileCdnRedirect = ['_' => 'upload.fileCdnRedirect', 'dc_id' => int, 'file_token' => 'bytes', 'encryption_key' => 'bytes', 'encryption_iv' => 'bytes', 'file_hashes' => [FileHash, FileHash]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "upload.fileCdnRedirect", "dc_id": int, "file_token": {"_": "bytes", "bytes":"base64 encoded bytes"}, "encryption_key": {"_": "bytes", "bytes":"base64 encoded bytes"}, "encryption_iv": {"_": "bytes", "bytes":"base64 encoded bytes"}, "file_hashes": [FileHash]} +``` + + +Or, if you're into Lua: + + +``` +upload_fileCdnRedirect={_='upload.fileCdnRedirect', dc_id=int, file_token='bytes', encryption_key='bytes', encryption_iv='bytes', file_hashes={FileHash}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/upload_webFile.md b/old_docs/API_docs_v81/constructors/upload_webFile.md new file mode 100644 index 00000000..296105ee --- /dev/null +++ b/old_docs/API_docs_v81/constructors/upload_webFile.md @@ -0,0 +1,47 @@ +--- +title: upload.webFile +description: upload_webFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: upload.webFile +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|size|[int](../types/int.md) | Yes| +|mime\_type|[string](../types/string.md) | Yes| +|file\_type|[storage\_FileType](../types/storage_FileType.md) | Yes| +|mtime|[int](../types/int.md) | Yes| +|bytes|[bytes](../types/bytes.md) | Yes| + + + +### Type: [upload\_WebFile](../types/upload_WebFile.md) + + +### Example: + +``` +$upload_webFile = ['_' => 'upload.webFile', 'size' => int, 'mime_type' => 'string', 'file_type' => storage_FileType, 'mtime' => int, 'bytes' => 'bytes']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "upload.webFile", "size": int, "mime_type": "string", "file_type": storage_FileType, "mtime": int, "bytes": {"_": "bytes", "bytes":"base64 encoded bytes"}} +``` + + +Or, if you're into Lua: + + +``` +upload_webFile={_='upload.webFile', size=int, mime_type='string', file_type=storage_FileType, mtime=int, bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/user.md b/old_docs/API_docs_v81/constructors/user.md new file mode 100644 index 00000000..e15841b7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/user.md @@ -0,0 +1,65 @@ +--- +title: user +description: user attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: user +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|self|[Bool](../types/Bool.md) | Optional| +|contact|[Bool](../types/Bool.md) | Optional| +|mutual\_contact|[Bool](../types/Bool.md) | Optional| +|deleted|[Bool](../types/Bool.md) | Optional| +|bot|[Bool](../types/Bool.md) | Optional| +|bot\_chat\_history|[Bool](../types/Bool.md) | Optional| +|bot\_nochats|[Bool](../types/Bool.md) | Optional| +|verified|[Bool](../types/Bool.md) | Optional| +|restricted|[Bool](../types/Bool.md) | Optional| +|min|[Bool](../types/Bool.md) | Optional| +|bot\_inline\_geo|[Bool](../types/Bool.md) | Optional| +|id|[int](../types/int.md) | Yes| +|access\_hash|[long](../types/long.md) | Optional| +|first\_name|[string](../types/string.md) | Optional| +|last\_name|[string](../types/string.md) | Optional| +|username|[string](../types/string.md) | Optional| +|phone|[string](../types/string.md) | Optional| +|photo|[UserProfilePhoto](../types/UserProfilePhoto.md) | Optional| +|status|[UserStatus](../types/UserStatus.md) | Optional| +|bot\_info\_version|[int](../types/int.md) | Optional| +|restriction\_reason|[string](../types/string.md) | Optional| +|bot\_inline\_placeholder|[string](../types/string.md) | Optional| +|lang\_code|[string](../types/string.md) | Optional| + + + +### Type: [User](../types/User.md) + + +### Example: + +``` +$user = ['_' => 'user', 'self' => Bool, 'contact' => Bool, 'mutual_contact' => Bool, 'deleted' => Bool, 'bot' => Bool, 'bot_chat_history' => Bool, 'bot_nochats' => Bool, 'verified' => Bool, 'restricted' => Bool, 'min' => Bool, 'bot_inline_geo' => Bool, 'id' => int, 'access_hash' => long, 'first_name' => 'string', 'last_name' => 'string', 'username' => 'string', 'phone' => 'string', 'photo' => UserProfilePhoto, 'status' => UserStatus, 'bot_info_version' => int, 'restriction_reason' => 'string', 'bot_inline_placeholder' => 'string', 'lang_code' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "user", "self": Bool, "contact": Bool, "mutual_contact": Bool, "deleted": Bool, "bot": Bool, "bot_chat_history": Bool, "bot_nochats": Bool, "verified": Bool, "restricted": Bool, "min": Bool, "bot_inline_geo": Bool, "id": int, "access_hash": long, "first_name": "string", "last_name": "string", "username": "string", "phone": "string", "photo": UserProfilePhoto, "status": UserStatus, "bot_info_version": int, "restriction_reason": "string", "bot_inline_placeholder": "string", "lang_code": "string"} +``` + + +Or, if you're into Lua: + + +``` +user={_='user', self=Bool, contact=Bool, mutual_contact=Bool, deleted=Bool, bot=Bool, bot_chat_history=Bool, bot_nochats=Bool, verified=Bool, restricted=Bool, min=Bool, bot_inline_geo=Bool, id=int, access_hash=long, first_name='string', last_name='string', username='string', phone='string', photo=UserProfilePhoto, status=UserStatus, bot_info_version=int, restriction_reason='string', bot_inline_placeholder='string', lang_code='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/userEmpty.md b/old_docs/API_docs_v81/constructors/userEmpty.md new file mode 100644 index 00000000..76584e2c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/userEmpty.md @@ -0,0 +1,43 @@ +--- +title: userEmpty +description: userEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| + + + +### Type: [User](../types/User.md) + + +### Example: + +``` +$userEmpty = ['_' => 'userEmpty', 'id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "userEmpty", "id": int} +``` + + +Or, if you're into Lua: + + +``` +userEmpty={_='userEmpty', id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/userFull.md b/old_docs/API_docs_v81/constructors/userFull.md new file mode 100644 index 00000000..8a9037d6 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/userFull.md @@ -0,0 +1,52 @@ +--- +title: userFull +description: userFull attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userFull +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|blocked|[Bool](../types/Bool.md) | Optional| +|phone\_calls\_available|[Bool](../types/Bool.md) | Optional| +|phone\_calls\_private|[Bool](../types/Bool.md) | Optional| +|user|[User](../types/User.md) | Optional| +|about|[string](../types/string.md) | Optional| +|link|[contacts\_Link](../types/contacts_Link.md) | Yes| +|profile\_photo|[Photo](../types/Photo.md) | Optional| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes| +|bot\_info|[BotInfo](../types/BotInfo.md) | Optional| +|common\_chats\_count|[int](../types/int.md) | Yes| + + + +### Type: [UserFull](../types/UserFull.md) + + +### Example: + +``` +$userFull = ['_' => 'userFull', 'blocked' => Bool, 'phone_calls_available' => Bool, 'phone_calls_private' => Bool, 'user' => User, 'about' => 'string', 'link' => contacts_Link, 'profile_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'bot_info' => BotInfo, 'common_chats_count' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "userFull", "blocked": Bool, "phone_calls_available": Bool, "phone_calls_private": Bool, "user": User, "about": "string", "link": contacts_Link, "profile_photo": Photo, "notify_settings": PeerNotifySettings, "bot_info": BotInfo, "common_chats_count": int} +``` + + +Or, if you're into Lua: + + +``` +userFull={_='userFull', blocked=Bool, phone_calls_available=Bool, phone_calls_private=Bool, user=User, about='string', link=contacts_Link, profile_photo=Photo, notify_settings=PeerNotifySettings, bot_info=BotInfo, common_chats_count=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/userProfilePhoto.md b/old_docs/API_docs_v81/constructors/userProfilePhoto.md new file mode 100644 index 00000000..e314a919 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/userProfilePhoto.md @@ -0,0 +1,45 @@ +--- +title: userProfilePhoto +description: userProfilePhoto attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userProfilePhoto +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|photo\_id|[long](../types/long.md) | Yes| +|photo\_small|[FileLocation](../types/FileLocation.md) | Yes| +|photo\_big|[FileLocation](../types/FileLocation.md) | Yes| + + + +### Type: [UserProfilePhoto](../types/UserProfilePhoto.md) + + +### Example: + +``` +$userProfilePhoto = ['_' => 'userProfilePhoto', 'photo_id' => long, 'photo_small' => FileLocation, 'photo_big' => FileLocation]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "userProfilePhoto", "photo_id": long, "photo_small": FileLocation, "photo_big": FileLocation} +``` + + +Or, if you're into Lua: + + +``` +userProfilePhoto={_='userProfilePhoto', photo_id=long, photo_small=FileLocation, photo_big=FileLocation} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/userProfilePhotoEmpty.md b/old_docs/API_docs_v81/constructors/userProfilePhotoEmpty.md new file mode 100644 index 00000000..dc0ab294 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/userProfilePhotoEmpty.md @@ -0,0 +1,38 @@ +--- +title: userProfilePhotoEmpty +description: userProfilePhotoEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userProfilePhotoEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [UserProfilePhoto](../types/UserProfilePhoto.md) + + +### Example: + +``` +$userProfilePhotoEmpty = ['_' => 'userProfilePhotoEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "userProfilePhotoEmpty"} +``` + + +Or, if you're into Lua: + + +``` +userProfilePhotoEmpty={_='userProfilePhotoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/userStatusEmpty.md b/old_docs/API_docs_v81/constructors/userStatusEmpty.md new file mode 100644 index 00000000..b5da32f4 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/userStatusEmpty.md @@ -0,0 +1,38 @@ +--- +title: userStatusEmpty +description: userStatusEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusEmpty +[Back to constructors index](index.md) + + + + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +``` +$userStatusEmpty = ['_' => 'userStatusEmpty']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "userStatusEmpty"} +``` + + +Or, if you're into Lua: + + +``` +userStatusEmpty={_='userStatusEmpty'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/userStatusLastMonth.md b/old_docs/API_docs_v81/constructors/userStatusLastMonth.md new file mode 100644 index 00000000..3ae16d3c --- /dev/null +++ b/old_docs/API_docs_v81/constructors/userStatusLastMonth.md @@ -0,0 +1,38 @@ +--- +title: userStatusLastMonth +description: userStatusLastMonth attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusLastMonth +[Back to constructors index](index.md) + + + + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +``` +$userStatusLastMonth = ['_' => 'userStatusLastMonth']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "userStatusLastMonth"} +``` + + +Or, if you're into Lua: + + +``` +userStatusLastMonth={_='userStatusLastMonth'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/userStatusLastWeek.md b/old_docs/API_docs_v81/constructors/userStatusLastWeek.md new file mode 100644 index 00000000..d3233be7 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/userStatusLastWeek.md @@ -0,0 +1,38 @@ +--- +title: userStatusLastWeek +description: userStatusLastWeek attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusLastWeek +[Back to constructors index](index.md) + + + + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +``` +$userStatusLastWeek = ['_' => 'userStatusLastWeek']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "userStatusLastWeek"} +``` + + +Or, if you're into Lua: + + +``` +userStatusLastWeek={_='userStatusLastWeek'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/userStatusOffline.md b/old_docs/API_docs_v81/constructors/userStatusOffline.md new file mode 100644 index 00000000..6c3c56ca --- /dev/null +++ b/old_docs/API_docs_v81/constructors/userStatusOffline.md @@ -0,0 +1,43 @@ +--- +title: userStatusOffline +description: userStatusOffline attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusOffline +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|was\_online|[int](../types/int.md) | Yes| + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +``` +$userStatusOffline = ['_' => 'userStatusOffline', 'was_online' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "userStatusOffline", "was_online": int} +``` + + +Or, if you're into Lua: + + +``` +userStatusOffline={_='userStatusOffline', was_online=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/userStatusOnline.md b/old_docs/API_docs_v81/constructors/userStatusOnline.md new file mode 100644 index 00000000..cda07704 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/userStatusOnline.md @@ -0,0 +1,43 @@ +--- +title: userStatusOnline +description: userStatusOnline attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusOnline +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|expires|[int](../types/int.md) | Yes| + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +``` +$userStatusOnline = ['_' => 'userStatusOnline', 'expires' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "userStatusOnline", "expires": int} +``` + + +Or, if you're into Lua: + + +``` +userStatusOnline={_='userStatusOnline', expires=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/userStatusRecently.md b/old_docs/API_docs_v81/constructors/userStatusRecently.md new file mode 100644 index 00000000..de4e75b8 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/userStatusRecently.md @@ -0,0 +1,38 @@ +--- +title: userStatusRecently +description: userStatusRecently attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusRecently +[Back to constructors index](index.md) + + + + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +``` +$userStatusRecently = ['_' => 'userStatusRecently']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "userStatusRecently"} +``` + + +Or, if you're into Lua: + + +``` +userStatusRecently={_='userStatusRecently'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/wallPaper.md b/old_docs/API_docs_v81/constructors/wallPaper.md new file mode 100644 index 00000000..4a438e75 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/wallPaper.md @@ -0,0 +1,46 @@ +--- +title: wallPaper +description: wallPaper attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: wallPaper +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| +|title|[string](../types/string.md) | Yes| +|sizes|Array of [PhotoSize](../types/PhotoSize.md) | Yes| +|color|[int](../types/int.md) | Yes| + + + +### Type: [WallPaper](../types/WallPaper.md) + + +### Example: + +``` +$wallPaper = ['_' => 'wallPaper', 'id' => int, 'title' => 'string', 'sizes' => [PhotoSize, PhotoSize], 'color' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "wallPaper", "id": int, "title": "string", "sizes": [PhotoSize], "color": int} +``` + + +Or, if you're into Lua: + + +``` +wallPaper={_='wallPaper', id=int, title='string', sizes={PhotoSize}, color=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/wallPaperSolid.md b/old_docs/API_docs_v81/constructors/wallPaperSolid.md new file mode 100644 index 00000000..c382aeaf --- /dev/null +++ b/old_docs/API_docs_v81/constructors/wallPaperSolid.md @@ -0,0 +1,46 @@ +--- +title: wallPaperSolid +description: wallPaperSolid attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: wallPaperSolid +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[int](../types/int.md) | Yes| +|title|[string](../types/string.md) | Yes| +|bg\_color|[int](../types/int.md) | Yes| +|color|[int](../types/int.md) | Yes| + + + +### Type: [WallPaper](../types/WallPaper.md) + + +### Example: + +``` +$wallPaperSolid = ['_' => 'wallPaperSolid', 'id' => int, 'title' => 'string', 'bg_color' => int, 'color' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "wallPaperSolid", "id": int, "title": "string", "bg_color": int, "color": int} +``` + + +Or, if you're into Lua: + + +``` +wallPaperSolid={_='wallPaperSolid', id=int, title='string', bg_color=int, color=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/webAuthorization.md b/old_docs/API_docs_v81/constructors/webAuthorization.md new file mode 100644 index 00000000..3c0a4170 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/webAuthorization.md @@ -0,0 +1,51 @@ +--- +title: webAuthorization +description: webAuthorization attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webAuthorization +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|hash|[long](../types/long.md) | Yes| +|bot\_id|[int](../types/int.md) | Yes| +|domain|[string](../types/string.md) | Yes| +|browser|[string](../types/string.md) | Yes| +|platform|[string](../types/string.md) | Yes| +|date\_created|[int](../types/int.md) | Yes| +|date\_active|[int](../types/int.md) | Yes| +|ip|[string](../types/string.md) | Yes| +|region|[string](../types/string.md) | Yes| + + + +### Type: [WebAuthorization](../types/WebAuthorization.md) + + +### Example: + +``` +$webAuthorization = ['_' => 'webAuthorization', 'hash' => long, 'bot_id' => int, 'domain' => 'string', 'browser' => 'string', 'platform' => 'string', 'date_created' => int, 'date_active' => int, 'ip' => 'string', 'region' => 'string']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "webAuthorization", "hash": long, "bot_id": int, "domain": "string", "browser": "string", "platform": "string", "date_created": int, "date_active": int, "ip": "string", "region": "string"} +``` + + +Or, if you're into Lua: + + +``` +webAuthorization={_='webAuthorization', hash=long, bot_id=int, domain='string', browser='string', platform='string', date_created=int, date_active=int, ip='string', region='string'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/webDocument.md b/old_docs/API_docs_v81/constructors/webDocument.md new file mode 100644 index 00000000..064367a3 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/webDocument.md @@ -0,0 +1,48 @@ +--- +title: webDocument +description: webDocument attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webDocument +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|access\_hash|[long](../types/long.md) | Yes| +|size|[int](../types/int.md) | Yes| +|mime\_type|[string](../types/string.md) | Yes| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes| +|dc\_id|[int](../types/int.md) | Yes| + + + +### Type: [WebDocument](../types/WebDocument.md) + + +### Example: + +``` +$webDocument = ['_' => 'webDocument', 'url' => 'string', 'access_hash' => long, 'size' => int, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute], 'dc_id' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "webDocument", "url": "string", "access_hash": long, "size": int, "mime_type": "string", "attributes": [DocumentAttribute], "dc_id": int} +``` + + +Or, if you're into Lua: + + +``` +webDocument={_='webDocument', url='string', access_hash=long, size=int, mime_type='string', attributes={DocumentAttribute}, dc_id=int} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/webDocumentNoProxy.md b/old_docs/API_docs_v81/constructors/webDocumentNoProxy.md new file mode 100644 index 00000000..07b6aa60 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/webDocumentNoProxy.md @@ -0,0 +1,46 @@ +--- +title: webDocumentNoProxy +description: webDocumentNoProxy attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webDocumentNoProxy +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|url|[string](../types/string.md) | Yes| +|size|[int](../types/int.md) | Yes| +|mime\_type|[string](../types/string.md) | Yes| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes| + + + +### Type: [WebDocument](../types/WebDocument.md) + + +### Example: + +``` +$webDocumentNoProxy = ['_' => 'webDocumentNoProxy', 'url' => 'string', 'size' => int, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute]]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "webDocumentNoProxy", "url": "string", "size": int, "mime_type": "string", "attributes": [DocumentAttribute]} +``` + + +Or, if you're into Lua: + + +``` +webDocumentNoProxy={_='webDocumentNoProxy', url='string', size=int, mime_type='string', attributes={DocumentAttribute}} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/webPage.md b/old_docs/API_docs_v81/constructors/webPage.md new file mode 100644 index 00000000..371b1e56 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/webPage.md @@ -0,0 +1,59 @@ +--- +title: webPage +description: webPage attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPage +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|url|[string](../types/string.md) | Yes| +|display\_url|[string](../types/string.md) | Yes| +|hash|[int](../types/int.md) | Yes| +|type|[string](../types/string.md) | Optional| +|site\_name|[string](../types/string.md) | Optional| +|title|[string](../types/string.md) | Optional| +|description|[string](../types/string.md) | Optional| +|photo|[Photo](../types/Photo.md) | Optional| +|embed\_url|[string](../types/string.md) | Optional| +|embed\_type|[string](../types/string.md) | Optional| +|embed\_width|[int](../types/int.md) | Optional| +|embed\_height|[int](../types/int.md) | Optional| +|duration|[int](../types/int.md) | Optional| +|author|[string](../types/string.md) | Optional| +|document|[Document](../types/Document.md) | Optional| +|cached\_page|[Page](../types/Page.md) | Optional| + + + +### Type: [WebPage](../types/WebPage.md) + + +### Example: + +``` +$webPage = ['_' => 'webPage', 'id' => long, 'url' => 'string', 'display_url' => 'string', 'hash' => int, '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', 'document' => Document, 'cached_page' => Page]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "webPage", "id": long, "url": "string", "display_url": "string", "hash": int, "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", "document": Document, "cached_page": Page} +``` + + +Or, if you're into Lua: + + +``` +webPage={_='webPage', id=long, url='string', display_url='string', hash=int, 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', document=Document, cached_page=Page} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/webPageEmpty.md b/old_docs/API_docs_v81/constructors/webPageEmpty.md new file mode 100644 index 00000000..7efc4ce2 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/webPageEmpty.md @@ -0,0 +1,43 @@ +--- +title: webPageEmpty +description: webPageEmpty attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPageEmpty +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| + + + +### Type: [WebPage](../types/WebPage.md) + + +### Example: + +``` +$webPageEmpty = ['_' => 'webPageEmpty', 'id' => long]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "webPageEmpty", "id": long} +``` + + +Or, if you're into Lua: + + +``` +webPageEmpty={_='webPageEmpty', id=long} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/webPageNotModified.md b/old_docs/API_docs_v81/constructors/webPageNotModified.md new file mode 100644 index 00000000..557c2947 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/webPageNotModified.md @@ -0,0 +1,38 @@ +--- +title: webPageNotModified +description: webPageNotModified attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPageNotModified +[Back to constructors index](index.md) + + + + + + +### Type: [WebPage](../types/WebPage.md) + + +### Example: + +``` +$webPageNotModified = ['_' => 'webPageNotModified']; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "webPageNotModified"} +``` + + +Or, if you're into Lua: + + +``` +webPageNotModified={_='webPageNotModified'} + +``` + + diff --git a/old_docs/API_docs_v81/constructors/webPagePending.md b/old_docs/API_docs_v81/constructors/webPagePending.md new file mode 100644 index 00000000..abe762d5 --- /dev/null +++ b/old_docs/API_docs_v81/constructors/webPagePending.md @@ -0,0 +1,44 @@ +--- +title: webPagePending +description: webPagePending attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPagePending +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|id|[long](../types/long.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [WebPage](../types/WebPage.md) + + +### Example: + +``` +$webPagePending = ['_' => 'webPagePending', 'id' => long, 'date' => int]; +``` + +[PWRTelegram](https://pwrtelegram.xyz) json-encoded version: + +``` +{"_": "webPagePending", "id": long, "date": int} +``` + + +Or, if you're into Lua: + + +``` +webPagePending={_='webPagePending', id=long, date=int} + +``` + + diff --git a/old_docs/API_docs_v81/methods/README.md b/old_docs/API_docs_v81/methods/README.md new file mode 100644 index 00000000..4b62fff8 --- /dev/null +++ b/old_docs/API_docs_v81/methods/README.md @@ -0,0 +1,498 @@ +--- +title: Methods +description: What do you want to do? +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# What do you want to do? +[Go back to API documentation index](..) + +[Go to the old code-version method index](api_README.md) + +* [Logout](https://docs.madelineproto.xyz/logout.html) + +* [Login](https://docs.madelineproto.xyz/docs/LOGIN.html) + +* [Get all chats, broadcast a message to all chats](https://docs.madelineproto.xyz/docs/DIALOGS.html) + +* [Get the full participant list of a channel/group/supergroup](https://docs.madelineproto.xyz/get_pwr_chat.html) + +* [Get full info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/get_full_info.html) + +* [Get info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/get_info.html) + +* [Get info about the currently logged-in user](https://docs.madelineproto.xyz/get_self.html) + +* [Upload or download files up to 1.5 GB](https://docs.madelineproto.xyz/docs/FILES.html) + +* [Make a phone call and play a song](https://docs.madelineproto.xyz/docs/CALLS.html) + +* [Create a secret chat bot](https://docs.madelineproto.xyz/docs/SECRET_CHATS.html) + +* Accept telegram passport authorization: account.acceptAuthorization + +* Accept telegram's TOS: help.acceptTermsOfService + +* Add a sticker set: messages.installStickerSet + +* Add a sticker to favorites: messages.faveSticker + +* Add a sticker to recent stickers: messages.saveRecentSticker + +* Add a user to a normal chat (use channels->inviteToChannel for supergroups): messages.addChatUser + +* Add phone number as contact: contacts.importContacts + +* Add sticker to stickerset: stickers.addStickerToSet + +* Add users to channel/supergroup: channels.inviteToChannel + +* Allow or disallow any user to invite users to this channel/supergroup: channels.toggleInvites + +* Block a user: contacts.block + +* Bots only: get telegram passport authorization form: account.getAuthorizationForm + +* Bots only: send payment form: payments.sendPaymentForm + +* Bots only: set precheckout results: messages.setBotPrecheckoutResults + +* Bots only: set shipping results: messages.setBotShippingResults + +* Bots only: set the callback answer (after a button was clicked): messages.setBotCallbackAnswer + +* Bots only: set the results of an inline query: messages.setInlineBotResults + +* Call inline bot: messages.getInlineBotResults + +* Change notification settings: account.updateNotifySettings + +* Change sticker position in photo: stickers.changeStickerPosition + +* Change the phone number associated to this account: account.changePhone + +* Change the phone number: account.sendChangePhoneCode + +* Change typing status: messages.setTyping + +* Check if about to edit a message or a media caption: messages.getMessageEditData + +* Check if an invitation link is valid: messages.checkChatInvite + +* Check if this username is available: account.checkUsername + +* Check if this username is free and can be assigned to a channel/supergroup: channels.checkUsername + +* Clear all recent stickers: messages.clearRecentStickers + +* Clear saved payments info: payments.clearSavedInfo + +* Confirm this phone number is associated to this account, obtain phone_code_hash from sendConfirmPhoneCode: account.confirmPhone + +* Convert chat to supergroup: messages.migrateChat + +* Create a chat (not supergroup): messages.createChat + +* Create channel/supergroup: channels.createChannel + +* Create stickerset: stickers.createStickerSet + +* Delete a certain session: account.resetAuthorization + +* Delete a certain telegram web login authorization: account.resetWebAuthorization + +* Delete a channel/supergroup: channels.deleteChannel + +* Delete a contact: contacts.deleteContact + +* Delete a user from a chat (not supergroup): messages.deleteChatUser + +* Delete all logged-in sessions.: auth.resetAuthorizations + +* Delete all messages of a user in a channel/supergroup: channels.deleteUserHistory + +* Delete all temporary authorization keys except the ones provided: auth.dropTempAuthKeys + +* Delete channel/supergroup messages: channels.deleteMessages + +* Delete chat history: messages.deleteHistory + +* Delete messages: messages.deleteMessages + +* Delete multiple contacts: contacts.deleteContacts + +* Delete profile photos: photos.deletePhotos + +* Delete secure telegram passport value: account.deleteSecureValue + +* Delete the history of a supergroup/channel: channels.deleteHistory + +* Delete this account: account.deleteAccount + +* Disable all notifications for a certain period: account.updateDeviceLocked + +* Download a file through telegram: upload.getWebFile + +* Edit a message: messages.editMessage + +* Edit a sent inline message: messages.editInlineBotMessage + +* Edit admin permissions of a user in a channel/supergroup: channels.editAdmin + +* Edit admin permissions: messages.editChatAdmin + +* Edit the about text of a channel/supergroup: channels.editAbout + +* Edit the photo of a normal chat (not supergroup): messages.editChatPhoto + +* Edit the photo of a supergroup/channel: channels.editPhoto + +* Edit the title of a normal chat (not supergroup): messages.editChatTitle + +* Edit the title of a supergroup/channel: channels.editTitle + +* Enable all users are admins in normal groups (not supergroups): messages.toggleChatAdmins + +* Enable or disable hidden history for new channel/supergroup users: channels.togglePreHistoryHidden + +* Export chat invite : messages.exportChatInvite + +* Export contact as card: contacts.exportCard + +* Export the invite link of a channel: channels.exportInvite + +* Find a sticker set: messages.searchStickerSets + +* Finish account exporting session: account.finishTakeoutSession + +* Forward messages: messages.forwardMessages + +* Get CDN configuration: help.getCdnConfig + +* Get a stickerset: messages.getStickerSet + +* Get account TTL: account.getAccountTTL + +* Get admin log of a channel/supergroup: channels.getAdminLog + +* Get all archived stickers: messages.getArchivedStickers + +* Get all channels you left: channels.getLeftChannels + +* Get all chats (not supergroups or channels): messages.getAllChats + +* Get all logged-in authorizations: account.getAuthorizations + +* Get all message drafts: messages.getAllDrafts + +* Get all secure telegram passport values: account.getAllSecureValues + +* Get all stickerpacks: messages.getAllStickers + +* Get all supergroups/channels where you're admin: channels.getAdminedPublicChannels + +* Get and increase message views: messages.getMessagesViews + +* Get available languages: langpack.getLanguages + +* Get blocked users: contacts.getBlocked + +* Get call configuration: phone.getCallConfig + +* Get channel/supergroup messages: channels.getMessages + +* Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead): channels.getParticipants + +* Get chats in common with a user: messages.getCommonChats + +* Get deep link info: help.getDeepLinkInfo + +* Get dialog info of peers: messages.getPeerDialogs + +* Get document by SHA256 hash: messages.getDocumentByHash + +* Get favorite stickers: messages.getFavedStickers + +* Get featured stickers: messages.getFeaturedStickers + +* Get high scores of a game sent in an inline message: messages.getInlineGameHighScores + +* Get high scores of a game: messages.getGameHighScores + +* Get info about a certain channel/supergroup participant: channels.getParticipant + +* Get info about a certain contact: contacts.getContacts + +* Get info about app updates: help.getAppUpdate + +* Get info about chats: messages.getChats + +* Get info about multiple channels/supergroups: channels.getChannels + +* Get info about users: users.getUsers + +* Get info of support user: help.getSupport + +* Get information about the current proxy: help.getProxyData + +* Get invitation text: help.getInviteText + +* Get language pack strings: langpack.getStrings + +* Get language pack updates: langpack.getDifference + +* Get language pack: langpack.getLangPack + +* Get masks: messages.getMaskStickers + +* Get message ranges to fetch: messages.getSplitRanges + +* Get messages: messages.getMessages + +* Get most used chats: contacts.getTopPeers + +* Get nearest datacenter: help.getNearestDc + +* Get notification settings: account.getNotifySettings + +* Get online status of all users: contacts.getStatuses + +* Get payment form: payments.getPaymentForm + +* Get payment receipt: payments.getPaymentReceipt + +* Get pinned dialogs: messages.getPinnedDialogs + +* Get previous messages of a group: messages.getHistory + +* Get privacy settings: account.getPrivacy + +* Get recent locations: messages.getRecentLocations + +* Get recent stickers: messages.getRecentStickers + +* Get recent t.me URLs: help.getRecentMeUrls + +* Get saved contacts: contacts.getSaved + +* Get saved gifs: messages.getSavedGifs + +* Get saved payments info: payments.getSavedInfo + +* Get secure value for telegram passport: account.getSecureValue + +* Get server configuration: help.getConfig + +* Get stickers attachable to images: messages.getAttachedStickers + +* Get stickers: messages.getStickers + +* Get telegram web login authorizations: account.getWebAuthorizations + +* Get temporary password for buying products through bots: account.getTmpPassword + +* Get the callback answer of a bot (after clicking a button): messages.getBotCallbackAnswer + +* Get the changelog of this app: help.getAppChangelog + +* Get the current 2FA settings: account.getPasswordSettings + +* Get the current password: account.getPassword + +* Get the link of a message in a channel: channels.exportMessageLink + +* Get the profile photos of a user: photos.getUserPhotos + +* Get the settings of apeer: messages.getPeerSettings + +* Get unread mentions: messages.getUnreadMentions + +* Get updated TOS: help.getTermsOfServiceUpdate + +* Get webpage preview: messages.getWebPage + +* Get webpage preview: messages.getWebPagePreview + +* Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html: messages.getDialogs + +* Global message search: messages.searchGlobal + +* Hide report spam popup: messages.hideReportSpam + +* Import card as contact: contacts.importCard + +* Import chat invite: messages.importChatInvite + +* Initializes connection and save information on the user's device and application.: initConnection + +* Invalidate sent phone code: auth.cancelCode + +* Invoke method from takeout session: invokeWithTakeout + +* Invoke this method with layer X: invokeWithLayer + +* Invoke with messages range: invokeWithMessagesRange + +* Invoke with method without returning updates in the socket: invokeWithoutUpdates + +* Invokes a query after successfull completion of one of the previous queries.: invokeAfterMsg + +* Join a channel/supergroup: channels.joinChannel + +* Kick or ban a user from a channel/supergroup: channels.editBanned + +* Leave a channel/supergroup: channels.leaveChannel + +* Log data for developer of this app: help.saveAppLog + +* Mark channel/supergroup history as read: channels.readHistory + +* Mark channel/supergroup messages as read: channels.readMessageContents + +* Mark mentions as read: messages.readMentions + +* Mark message as read: messages.readMessageContents + +* Mark messages as read in secret chats: messages.readEncryptedHistory + +* Mark messages as read: messages.readHistory + +* Mark messages as read: messages.receivedMessages + +* Mark new featured stickers as read: messages.readFeaturedStickers + +* Notify server that you received a call (server will refuse all incoming calls until the current call is over): phone.receivedCall + +* Pin or unpin dialog: messages.toggleDialogPin + +* Register device for push notifications: account.registerDevice + +* Remove a sticker set: messages.uninstallStickerSet + +* Remove sticker from stickerset: stickers.removeStickerFromSet + +* Reorder pinned dialogs: messages.reorderPinnedDialogs + +* Reorder sticker sets: messages.reorderStickerSets + +* Report a message in a supergroup/channel for spam: channels.reportSpam + +* Report a message: messages.report + +* Report a peer for spam: messages.reportSpam + +* Report for spam a secret chat: messages.reportEncryptedSpam + +* Report for spam: account.reportPeer + +* Resend the SMS verification code: auth.resendCode + +* Reset all notification settings: account.resetNotifySettings + +* Reset all telegram web login authorizations: account.resetWebAuthorizations + +* Reset saved contacts: contacts.resetSaved + +* Reset top peer rating for a certain category/peer: contacts.resetTopPeerRating + +* Result type returned by a current query.: invokeAfterMsgs + +* Returns a list of available wallpapers.: account.getWallPapers + +* Save a GIF: messages.saveGif + +* Save a message draft: messages.saveDraft + +* Save call debugging info: phone.saveCallDebug + +* Save telegram passport secure value: account.saveSecureValue + +* Search contacts: contacts.search + +* Search gifs: messages.searchGifs + +* Search peers or messages: messages.search + +* Send a custom request to the bot API: bots.sendCustomRequest + +* Send a file to a secret chat: messages.sendEncryptedFile + +* Send a media: messages.sendMedia + +* Send a message: messages.sendMessage + +* Send a service message to a secret chat: messages.sendEncryptedService + +* Send an album: messages.sendMultiMedia + +* Send an email to recover the 2FA password: auth.requestPasswordRecovery + +* Send confirmation phone code: account.sendConfirmPhoneCode + +* Send email verification code: account.sendVerifyEmailCode + +* Send inline bot result obtained with messages.getInlineBotResults to the chat: messages.sendInlineBotResult + +* Send message to secret chat: messages.sendEncrypted + +* Send phone verification code: account.sendVerifyPhoneCode + +* Send screenshot notification: messages.sendScreenshotNotification + +* Send typing notification to secret chat: messages.setEncryptedTyping + +* Send webhook request via bot API: bots.answerWebhookJSONQuery + +* Set account TTL: account.setAccountTTL + +* Set phone call rating: phone.setCallRating + +* Set privacy settings: account.setPrivacy + +* Set secure value error for telegram passport: users.setSecureValueErrors + +* Set the game score of an inline message: messages.setInlineGameScore + +* Set the game score: messages.setGameScore + +* Set the pinned message of a channel/supergroup: channels.updatePinnedMessage + +* Set the supergroup/channel stickerpack: channels.setStickers + +* Set the update status of webhook: help.setBotUpdatesStatus + +* Start a bot: messages.startBot + +* Start account exporting session: account.initTakeoutSession + +* Stop sending PUSH notifications to app: account.unregisterDevice + +* Toggle channel signatures: channels.toggleSignatures + +* Unblock a user: contacts.unblock + +* Update online status: account.updateStatus + +* Update profile info: account.updateProfile + +* Update the 2FA password settings: account.updatePasswordSettings + +* Update the profile photo (use photos->uploadProfilePhoto to upload the photo): photos.updateProfilePhoto + +* Update the username of a supergroup/channel: channels.updateUsername + +* Update this user's username: account.updateUsername + +* Upload a file without sending it to anyone: messages.uploadMedia + +* Upload a secret chat file without sending it to anyone: messages.uploadEncryptedFile + +* Upload profile photo: photos.uploadProfilePhoto + +* Use the code that was emailed to you after running $MadelineProto->auth->requestPasswordRecovery to login to your account: auth.recoverPassword + +* Validate requested payment info: payments.validateRequestedInfo + +* Verify email address: account.verifyEmail + +* Verify phone number: account.verifyPhone + diff --git a/old_docs/API_docs_v81/methods/account_acceptAuthorization.md b/old_docs/API_docs_v81/methods/account_acceptAuthorization.md new file mode 100644 index 00000000..b92ec185 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_acceptAuthorization.md @@ -0,0 +1,80 @@ +--- +title: account.acceptAuthorization +description: Accept telegram passport authorization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.acceptAuthorization +[Back to methods index](index.md) + + +Accept telegram passport authorization + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot\_id|[int](../types/int.md) | Yes|Bot ID| +|scope|[string](../types/string.md) | Yes|Scope| +|public\_key|[string](../types/string.md) | Yes|The bot's RSA public key| +|value\_hashes|Array of [SecureValueHash](../types/SecureValueHash.md) | Yes|Hashes of the encrypted credentials| +|credentials|[SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md) | Yes|Encrypted secure credentials| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->acceptAuthorization(['bot_id' => int, 'scope' => 'string', 'public_key' => 'string', 'value_hashes' => [SecureValueHash, SecureValueHash], 'credentials' => SecureCredentialsEncrypted, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.acceptAuthorization +* params - `{"bot_id": int, "scope": "string", "public_key": "string", "value_hashes": [SecureValueHash], "credentials": SecureCredentialsEncrypted, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.acceptAuthorization` + +Parameters: + +bot_id - Json encoded int + +scope - Json encoded string + +public_key - Json encoded string + +value_hashes - Json encoded array of SecureValueHash + +credentials - Json encoded SecureCredentialsEncrypted + + + + +Or, if you're into Lua: + +``` +Bool = account.acceptAuthorization({bot_id=int, scope='string', public_key='string', value_hashes={SecureValueHash}, credentials=SecureCredentialsEncrypted, }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_changePhone.md b/old_docs/API_docs_v81/methods/account_changePhone.md new file mode 100644 index 00000000..776e45cc --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_changePhone.md @@ -0,0 +1,72 @@ +--- +title: account.changePhone +description: Change the phone number associated to this account +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.changePhone +[Back to methods index](index.md) + + +Change the phone number associated to this account + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash returned by account.sendChangePhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code sent by account.sendChangePhoneCode| + + +### Return type: [User](../types/User.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$User = $MadelineProto->account->changePhone(['phone_number' => 'string', 'phone_code_hash' => 'string', 'phone_code' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.changePhone` + +Parameters: + +phone_number - Json encoded string + +phone_code_hash - Json encoded string + +phone_code - Json encoded string + + + + +Or, if you're into Lua: + +``` +User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_checkUsername.md b/old_docs/API_docs_v81/methods/account_checkUsername.md new file mode 100644 index 00000000..621f3a4e --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_checkUsername.md @@ -0,0 +1,66 @@ +--- +title: account.checkUsername +description: Check if this username is available +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.checkUsername +[Back to methods index](index.md) + + +Check if this username is available + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|username|[string](../types/string.md) | Yes|The username to check| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->checkUsername(['username' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.checkUsername` + +Parameters: + +username - Json encoded string + + + + +Or, if you're into Lua: + +``` +Bool = account.checkUsername({username='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v81/methods/account_confirmPhone.md b/old_docs/API_docs_v81/methods/account_confirmPhone.md new file mode 100644 index 00000000..676881f2 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_confirmPhone.md @@ -0,0 +1,70 @@ +--- +title: account.confirmPhone +description: Confirm this phone number is associated to this account, obtain phone_code_hash from sendConfirmPhoneCode +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.confirmPhone +[Back to methods index](index.md) + + +Confirm this phone number is associated to this account, obtain phone_code_hash from sendConfirmPhoneCode + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_code\_hash|[string](../types/string.md) | Yes|obtain phone_code_hash from sendConfirmPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The code sent by sendConfirmPhoneCode| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->confirmPhone(['phone_code_hash' => 'string', 'phone_code' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.confirmPhone` + +Parameters: + +phone_code_hash - Json encoded string + +phone_code - Json encoded string + + + + +Or, if you're into Lua: + +``` +Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_HASH_INVALID|Code hash invalid| +|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v81/methods/account_deleteAccount.md b/old_docs/API_docs_v81/methods/account_deleteAccount.md new file mode 100644 index 00000000..8c107f8a --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_deleteAccount.md @@ -0,0 +1,59 @@ +--- +title: account.deleteAccount +description: Delete this account +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.deleteAccount +[Back to methods index](index.md) + + +Delete this account + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|reason|[string](../types/string.md) | Yes|Why are you going away? :(| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->deleteAccount(['reason' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.deleteAccount` + +Parameters: + +reason - Json encoded string + + + + +Or, if you're into Lua: + +``` +Bool = account.deleteAccount({reason='string', }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_deleteSecureValue.md b/old_docs/API_docs_v81/methods/account_deleteSecureValue.md new file mode 100644 index 00000000..b8e1c613 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_deleteSecureValue.md @@ -0,0 +1,68 @@ +--- +title: account.deleteSecureValue +description: Delete secure telegram passport value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.deleteSecureValue +[Back to methods index](index.md) + + +Delete secure telegram passport value + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|types|Array of [SecureValueType](../types/SecureValueType.md) | Yes|The values to delete| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->deleteSecureValue(['types' => [SecureValueType, SecureValueType], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.deleteSecureValue +* params - `{"types": [SecureValueType], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.deleteSecureValue` + +Parameters: + +types - Json encoded array of SecureValueType + + + + +Or, if you're into Lua: + +``` +Bool = account.deleteSecureValue({types={SecureValueType}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_finishTakeoutSession.md b/old_docs/API_docs_v81/methods/account_finishTakeoutSession.md new file mode 100644 index 00000000..f858b3d8 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_finishTakeoutSession.md @@ -0,0 +1,68 @@ +--- +title: account.finishTakeoutSession +description: Finish account exporting session +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.finishTakeoutSession +[Back to methods index](index.md) + + +Finish account exporting session + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|success|[Bool](../types/Bool.md) | Optional|Did the data export succeed?| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->finishTakeoutSession(['success' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.finishTakeoutSession +* params - `{"success": Bool, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.finishTakeoutSession` + +Parameters: + +success - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Bool = account.finishTakeoutSession({success=Bool, }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_getAccountTTL.md b/old_docs/API_docs_v81/methods/account_getAccountTTL.md new file mode 100644 index 00000000..9f8248e7 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getAccountTTL.md @@ -0,0 +1,52 @@ +--- +title: account.getAccountTTL +description: Get account TTL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getAccountTTL +[Back to methods index](index.md) + + +Get account TTL + + + +### Return type: [AccountDaysTTL](../types/AccountDaysTTL.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$AccountDaysTTL = $MadelineProto->account->getAccountTTL(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getAccountTTL` + +Parameters: + + + + +Or, if you're into Lua: + +``` +AccountDaysTTL = account.getAccountTTL({}) +``` + diff --git a/old_docs/API_docs_v81/methods/account_getAllSecureValues.md b/old_docs/API_docs_v81/methods/account_getAllSecureValues.md new file mode 100644 index 00000000..7a3022d0 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getAllSecureValues.md @@ -0,0 +1,61 @@ +--- +title: account.getAllSecureValues +description: Get all secure telegram passport values +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getAllSecureValues +[Back to methods index](index.md) + + +Get all secure telegram passport values + + + +### Return type: [Vector\_of\_SecureValue](../types/SecureValue.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_SecureValue = $MadelineProto->account->getAllSecureValues(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.getAllSecureValues +* params - `{}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getAllSecureValues` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Vector_of_SecureValue = account.getAllSecureValues({}) +``` + diff --git a/old_docs/API_docs_v81/methods/account_getAuthorizationForm.md b/old_docs/API_docs_v81/methods/account_getAuthorizationForm.md new file mode 100644 index 00000000..e3353093 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getAuthorizationForm.md @@ -0,0 +1,74 @@ +--- +title: account.getAuthorizationForm +description: Bots only: get telegram passport authorization form +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getAuthorizationForm +[Back to methods index](index.md) + + +Bots only: get telegram passport authorization form + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot\_id|[int](../types/int.md) | Yes|Bot ID| +|scope|[string](../types/string.md) | Yes|Scope| +|public\_key|[string](../types/string.md) | Yes|Bot's public key| + + +### Return type: [account\_AuthorizationForm](../types/account_AuthorizationForm.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$account_AuthorizationForm = $MadelineProto->account->getAuthorizationForm(['bot_id' => int, 'scope' => 'string', 'public_key' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.getAuthorizationForm +* params - `{"bot_id": int, "scope": "string", "public_key": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getAuthorizationForm` + +Parameters: + +bot_id - Json encoded int + +scope - Json encoded string + +public_key - Json encoded string + + + + +Or, if you're into Lua: + +``` +account_AuthorizationForm = account.getAuthorizationForm({bot_id=int, scope='string', public_key='string', }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_getAuthorizations.md b/old_docs/API_docs_v81/methods/account_getAuthorizations.md new file mode 100644 index 00000000..148a4938 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getAuthorizations.md @@ -0,0 +1,52 @@ +--- +title: account.getAuthorizations +description: Get all logged-in authorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getAuthorizations +[Back to methods index](index.md) + + +Get all logged-in authorizations + + + +### Return type: [account\_Authorizations](../types/account_Authorizations.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$account_Authorizations = $MadelineProto->account->getAuthorizations(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getAuthorizations` + +Parameters: + + + + +Or, if you're into Lua: + +``` +account_Authorizations = account.getAuthorizations({}) +``` + diff --git a/old_docs/API_docs_v81/methods/account_getNotifySettings.md b/old_docs/API_docs_v81/methods/account_getNotifySettings.md new file mode 100644 index 00000000..3b4cc70d --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getNotifySettings.md @@ -0,0 +1,66 @@ +--- +title: account.getNotifySettings +description: Get notification settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getNotifySettings +[Back to methods index](index.md) + + +Get notification settings + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|Notification source | + + +### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$PeerNotifySettings = $MadelineProto->account->getNotifySettings(['peer' => InputNotifyPeer, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getNotifySettings` + +Parameters: + +peer - Json encoded InputNotifyPeer + + + + +Or, if you're into Lua: + +``` +PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_getPassword.md b/old_docs/API_docs_v81/methods/account_getPassword.md new file mode 100644 index 00000000..d6b82366 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getPassword.md @@ -0,0 +1,52 @@ +--- +title: account.getPassword +description: Get the current password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getPassword +[Back to methods index](index.md) + + +Get the current password + + + +### Return type: [account\_Password](../types/account_Password.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$account_Password = $MadelineProto->account->getPassword(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getPassword` + +Parameters: + + + + +Or, if you're into Lua: + +``` +account_Password = account.getPassword({}) +``` + diff --git a/old_docs/API_docs_v81/methods/account_getPasswordSettings.md b/old_docs/API_docs_v81/methods/account_getPasswordSettings.md new file mode 100644 index 00000000..cc3bc1ec --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getPasswordSettings.md @@ -0,0 +1,66 @@ +--- +title: account.getPasswordSettings +description: Get the current 2FA settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getPasswordSettings +[Back to methods index](index.md) + + +Get the current 2FA settings + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| + + +### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$account_PasswordSettings = $MadelineProto->account->getPasswordSettings(['current_password_hash' => 'bytes', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getPasswordSettings` + +Parameters: + +current_password_hash - Json encoded bytes + + + + +Or, if you're into Lua: + +``` +account_PasswordSettings = account.getPasswordSettings({current_password_hash='bytes', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_getPrivacy.md b/old_docs/API_docs_v81/methods/account_getPrivacy.md new file mode 100644 index 00000000..739a104b --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getPrivacy.md @@ -0,0 +1,66 @@ +--- +title: account.getPrivacy +description: Get privacy settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getPrivacy +[Back to methods index](index.md) + + +Get privacy settings + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting key| + + +### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$account_PrivacyRules = $MadelineProto->account->getPrivacy(['key' => InputPrivacyKey, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getPrivacy` + +Parameters: + +key - Json encoded InputPrivacyKey + + + + +Or, if you're into Lua: + +``` +account_PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_getSecureValue.md b/old_docs/API_docs_v81/methods/account_getSecureValue.md new file mode 100644 index 00000000..9aa09313 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getSecureValue.md @@ -0,0 +1,68 @@ +--- +title: account.getSecureValue +description: Get secure value for telegram passport +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getSecureValue +[Back to methods index](index.md) + + +Get secure value for telegram passport + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|types|Array of [SecureValueType](../types/SecureValueType.md) | Yes|Get telegram passport secure parameters| + + +### Return type: [Vector\_of\_SecureValue](../types/SecureValue.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_SecureValue = $MadelineProto->account->getSecureValue(['types' => [SecureValueType, SecureValueType], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.getSecureValue +* params - `{"types": [SecureValueType], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getSecureValue` + +Parameters: + +types - Json encoded array of SecureValueType + + + + +Or, if you're into Lua: + +``` +Vector_of_SecureValue = account.getSecureValue({types={SecureValueType}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_getTmpPassword.md b/old_docs/API_docs_v81/methods/account_getTmpPassword.md new file mode 100644 index 00000000..f12a6bb1 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getTmpPassword.md @@ -0,0 +1,70 @@ +--- +title: account.getTmpPassword +description: Get temporary password for buying products through bots +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getTmpPassword +[Back to methods index](index.md) + + +Get temporary password for buying products through bots + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|password\_hash|[bytes](../types/bytes.md) | Yes|The password hash| +|period|[int](../types/int.md) | Yes|The validity period| + + +### Return type: [account\_TmpPassword](../types/account_TmpPassword.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$account_TmpPassword = $MadelineProto->account->getTmpPassword(['password_hash' => 'bytes', 'period' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getTmpPassword` + +Parameters: + +password_hash - Json encoded bytes + +period - Json encoded int + + + + +Or, if you're into Lua: + +``` +account_TmpPassword = account.getTmpPassword({password_hash='bytes', period=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|TMP_PASSWORD_DISABLED|The temporary password is disabled| + + diff --git a/old_docs/API_docs_v81/methods/account_getWallPapers.md b/old_docs/API_docs_v81/methods/account_getWallPapers.md new file mode 100644 index 00000000..b72a0ac0 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getWallPapers.md @@ -0,0 +1,52 @@ +--- +title: account.getWallPapers +description: Returns a list of available wallpapers. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getWallPapers +[Back to methods index](index.md) + + +Returns a list of available wallpapers. + + + +### Return type: [Vector\_of\_WallPaper](../types/WallPaper.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_WallPaper = $MadelineProto->account->getWallPapers(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getWallPapers` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Vector_of_WallPaper = account.getWallPapers({}) +``` + diff --git a/old_docs/API_docs_v81/methods/account_getWebAuthorizations.md b/old_docs/API_docs_v81/methods/account_getWebAuthorizations.md new file mode 100644 index 00000000..eef56ced --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_getWebAuthorizations.md @@ -0,0 +1,61 @@ +--- +title: account.getWebAuthorizations +description: Get telegram web login authorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.getWebAuthorizations +[Back to methods index](index.md) + + +Get telegram web login authorizations + + + +### Return type: [account\_WebAuthorizations](../types/account_WebAuthorizations.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$account_WebAuthorizations = $MadelineProto->account->getWebAuthorizations(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.getWebAuthorizations +* params - `{}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.getWebAuthorizations` + +Parameters: + + + + +Or, if you're into Lua: + +``` +account_WebAuthorizations = account.getWebAuthorizations({}) +``` + diff --git a/old_docs/API_docs_v81/methods/account_initTakeoutSession.md b/old_docs/API_docs_v81/methods/account_initTakeoutSession.md new file mode 100644 index 00000000..d11c9075 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_initTakeoutSession.md @@ -0,0 +1,86 @@ +--- +title: account.initTakeoutSession +description: Start account exporting session +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.initTakeoutSession +[Back to methods index](index.md) + + +Start account exporting session + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|contacts|[Bool](../types/Bool.md) | Optional|Export contacts?| +|message\_users|[Bool](../types/Bool.md) | Optional|Export users?| +|message\_chats|[Bool](../types/Bool.md) | Optional|Export chats?| +|message\_megagroups|[Bool](../types/Bool.md) | Optional|Export supergroups?| +|message\_channels|[Bool](../types/Bool.md) | Optional|Export channel messages?| +|files|[Bool](../types/Bool.md) | Optional|Export files?| +|file\_max\_size|[int](../types/int.md) | Optional|Export only files smaller than this size| + + +### Return type: [account\_Takeout](../types/account_Takeout.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$account_Takeout = $MadelineProto->account->initTakeoutSession(['contacts' => Bool, 'message_users' => Bool, 'message_chats' => Bool, 'message_megagroups' => Bool, 'message_channels' => Bool, 'files' => Bool, 'file_max_size' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.initTakeoutSession +* params - `{"contacts": Bool, "message_users": Bool, "message_chats": Bool, "message_megagroups": Bool, "message_channels": Bool, "files": Bool, "file_max_size": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.initTakeoutSession` + +Parameters: + +contacts - Json encoded Bool + +message_users - Json encoded Bool + +message_chats - Json encoded Bool + +message_megagroups - Json encoded Bool + +message_channels - Json encoded Bool + +files - Json encoded Bool + +file_max_size - Json encoded int + + + + +Or, if you're into Lua: + +``` +account_Takeout = account.initTakeoutSession({contacts=Bool, message_users=Bool, message_chats=Bool, message_megagroups=Bool, message_channels=Bool, files=Bool, file_max_size=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_registerDevice.md b/old_docs/API_docs_v81/methods/account_registerDevice.md new file mode 100644 index 00000000..812f5e44 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_registerDevice.md @@ -0,0 +1,78 @@ +--- +title: account.registerDevice +description: Register device for push notifications +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.registerDevice +[Back to methods index](index.md) + + +Register device for push notifications + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| +|secret|[bytes](../types/bytes.md) | Yes|Secret| +|other\_uids|Array of [int](../types/int.md) | Yes|Other UIDs| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->registerDevice(['token_type' => int, 'token' => 'string', 'app_sandbox' => Bool, 'secret' => 'bytes', 'other_uids' => [int, int], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.registerDevice` + +Parameters: + +token_type - Json encoded int + +token - Json encoded string + +app_sandbox - Json encoded Bool + +secret - Json encoded bytes + +other_uids - Json encoded array of int + + + + +Or, if you're into Lua: + +``` +Bool = account.registerDevice({token_type=int, token='string', app_sandbox=Bool, secret='bytes', other_uids={int}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_reportPeer.md b/old_docs/API_docs_v81/methods/account_reportPeer.md new file mode 100644 index 00000000..bec1a8da --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_reportPeer.md @@ -0,0 +1,69 @@ +--- +title: account.reportPeer +description: Report for spam +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.reportPeer +[Back to methods index](index.md) + + +Report for spam + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +|reason|[ReportReason](../types/ReportReason.md) | Yes|Why are you reporting this peer| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->reportPeer(['peer' => InputPeer, 'reason' => ReportReason, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.reportPeer` + +Parameters: + +peer - Json encoded InputPeer + +reason - Json encoded ReportReason + + + + +Or, if you're into Lua: + +``` +Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_resetAuthorization.md b/old_docs/API_docs_v81/methods/account_resetAuthorization.md new file mode 100644 index 00000000..8a555666 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_resetAuthorization.md @@ -0,0 +1,66 @@ +--- +title: account.resetAuthorization +description: Delete a certain session +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.resetAuthorization +[Back to methods index](index.md) + + +Delete a certain session + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[long](../types/long.md) | Yes|The session hash, obtained from $MadelineProto->account->getAuthorizations| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->resetAuthorization(['hash' => long, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.resetAuthorization` + +Parameters: + +hash - Json encoded long + + + + +Or, if you're into Lua: + +``` +Bool = account.resetAuthorization({hash=long, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_resetNotifySettings.md b/old_docs/API_docs_v81/methods/account_resetNotifySettings.md new file mode 100644 index 00000000..e92e32b9 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_resetNotifySettings.md @@ -0,0 +1,52 @@ +--- +title: account.resetNotifySettings +description: Reset all notification settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.resetNotifySettings +[Back to methods index](index.md) + + +Reset all notification settings + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->resetNotifySettings(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.resetNotifySettings` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Bool = account.resetNotifySettings({}) +``` + diff --git a/old_docs/API_docs_v81/methods/account_resetWebAuthorization.md b/old_docs/API_docs_v81/methods/account_resetWebAuthorization.md new file mode 100644 index 00000000..9d42f177 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_resetWebAuthorization.md @@ -0,0 +1,68 @@ +--- +title: account.resetWebAuthorization +description: Delete a certain telegram web login authorization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.resetWebAuthorization +[Back to methods index](index.md) + + +Delete a certain telegram web login authorization + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[long](../types/long.md) | Yes|The authorization's hash| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->resetWebAuthorization(['hash' => long, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.resetWebAuthorization +* params - `{"hash": long, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.resetWebAuthorization` + +Parameters: + +hash - Json encoded long + + + + +Or, if you're into Lua: + +``` +Bool = account.resetWebAuthorization({hash=long, }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_resetWebAuthorizations.md b/old_docs/API_docs_v81/methods/account_resetWebAuthorizations.md new file mode 100644 index 00000000..fc39c6fd --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_resetWebAuthorizations.md @@ -0,0 +1,61 @@ +--- +title: account.resetWebAuthorizations +description: Reset all telegram web login authorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.resetWebAuthorizations +[Back to methods index](index.md) + + +Reset all telegram web login authorizations + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->resetWebAuthorizations(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.resetWebAuthorizations +* params - `{}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.resetWebAuthorizations` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Bool = account.resetWebAuthorizations({}) +``` + diff --git a/old_docs/API_docs_v81/methods/account_saveSecureValue.md b/old_docs/API_docs_v81/methods/account_saveSecureValue.md new file mode 100644 index 00000000..beb39134 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_saveSecureValue.md @@ -0,0 +1,71 @@ +--- +title: account.saveSecureValue +description: Save telegram passport secure value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.saveSecureValue +[Back to methods index](index.md) + + +Save telegram passport secure value + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|[InputSecureValue](../types/InputSecureValue.md) | Yes|Encrypted value| +|secure\_secret\_id|[long](../types/long.md) | Yes|Secret| + + +### Return type: [SecureValue](../types/SecureValue.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$SecureValue = $MadelineProto->account->saveSecureValue(['value' => InputSecureValue, 'secure_secret_id' => long, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.saveSecureValue +* params - `{"value": InputSecureValue, "secure_secret_id": long, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.saveSecureValue` + +Parameters: + +value - Json encoded InputSecureValue + +secure_secret_id - Json encoded long + + + + +Or, if you're into Lua: + +``` +SecureValue = account.saveSecureValue({value=InputSecureValue, secure_secret_id=long, }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v81/methods/account_sendChangePhoneCode.md new file mode 100644 index 00000000..ac288314 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_sendChangePhoneCode.md @@ -0,0 +1,72 @@ +--- +title: account.sendChangePhoneCode +description: Change the phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.sendChangePhoneCode +[Back to methods index](index.md) + + +Change the phone number + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can the code be sent using a flash call instead of an SMS?| +|phone\_number|[string](../types/string.md) | Yes|New phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Current phone number| + + +### Return type: [auth\_SentCode](../types/auth_SentCode.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$auth_SentCode = $MadelineProto->account->sendChangePhoneCode(['allow_flashcall' => Bool, 'phone_number' => 'string', 'current_number' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.sendChangePhoneCode` + +Parameters: + +allow_flashcall - Json encoded Bool + +phone_number - Json encoded string + +current_number - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +auth_SentCode = account.sendChangePhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v81/methods/account_sendConfirmPhoneCode.md new file mode 100644 index 00000000..14dbd095 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_sendConfirmPhoneCode.md @@ -0,0 +1,72 @@ +--- +title: account.sendConfirmPhoneCode +description: Send confirmation phone code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.sendConfirmPhoneCode +[Back to methods index](index.md) + + +Send confirmation phone code + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Can telegram call you instead of sending an SMS?| +|hash|[string](../types/string.md) | Yes|The hash| +|current\_number|[Bool](../types/Bool.md) | Optional|The current phone number| + + +### Return type: [auth\_SentCode](../types/auth_SentCode.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$auth_SentCode = $MadelineProto->account->sendConfirmPhoneCode(['allow_flashcall' => Bool, 'hash' => 'string', 'current_number' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.sendConfirmPhoneCode` + +Parameters: + +allow_flashcall - Json encoded Bool + +hash - Json encoded string + +current_number - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +auth_SentCode = account.sendConfirmPhoneCode({allow_flashcall=Bool, hash='string', current_number=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_sendVerifyEmailCode.md b/old_docs/API_docs_v81/methods/account_sendVerifyEmailCode.md new file mode 100644 index 00000000..c513c310 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_sendVerifyEmailCode.md @@ -0,0 +1,68 @@ +--- +title: account.sendVerifyEmailCode +description: Send email verification code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.sendVerifyEmailCode +[Back to methods index](index.md) + + +Send email verification code + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|email|[string](../types/string.md) | Yes|Email| + + +### Return type: [account\_SentEmailCode](../types/account_SentEmailCode.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$account_SentEmailCode = $MadelineProto->account->sendVerifyEmailCode(['email' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.sendVerifyEmailCode +* params - `{"email": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.sendVerifyEmailCode` + +Parameters: + +email - Json encoded string + + + + +Or, if you're into Lua: + +``` +account_SentEmailCode = account.sendVerifyEmailCode({email='string', }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_sendVerifyPhoneCode.md b/old_docs/API_docs_v81/methods/account_sendVerifyPhoneCode.md new file mode 100644 index 00000000..4420d730 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_sendVerifyPhoneCode.md @@ -0,0 +1,74 @@ +--- +title: account.sendVerifyPhoneCode +description: Send phone verification code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.sendVerifyPhoneCode +[Back to methods index](index.md) + + +Send phone verification code + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Allow phone calls?| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|current\_number|[Bool](../types/Bool.md) | Optional|Is this the current number?| + + +### Return type: [auth\_SentCode](../types/auth_SentCode.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$auth_SentCode = $MadelineProto->account->sendVerifyPhoneCode(['allow_flashcall' => Bool, 'phone_number' => 'string', 'current_number' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.sendVerifyPhoneCode +* params - `{"allow_flashcall": Bool, "phone_number": "string", "current_number": Bool, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.sendVerifyPhoneCode` + +Parameters: + +allow_flashcall - Json encoded Bool + +phone_number - Json encoded string + +current_number - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +auth_SentCode = account.sendVerifyPhoneCode({allow_flashcall=Bool, phone_number='string', current_number=Bool, }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_setAccountTTL.md b/old_docs/API_docs_v81/methods/account_setAccountTTL.md new file mode 100644 index 00000000..de5304fc --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_setAccountTTL.md @@ -0,0 +1,66 @@ +--- +title: account.setAccountTTL +description: Set account TTL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.setAccountTTL +[Back to methods index](index.md) + + +Set account TTL + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Yes|Time To Live of account| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->setAccountTTL(['ttl' => AccountDaysTTL, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.setAccountTTL` + +Parameters: + +ttl - Json encoded AccountDaysTTL + + + + +Or, if you're into Lua: + +``` +Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_setPrivacy.md b/old_docs/API_docs_v81/methods/account_setPrivacy.md new file mode 100644 index 00000000..7ccb4c2e --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_setPrivacy.md @@ -0,0 +1,69 @@ +--- +title: account.setPrivacy +description: Set privacy settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.setPrivacy +[Back to methods index](index.md) + + +Set privacy settings + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Yes|Privacy setting| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Yes|Privacy settings| + + +### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$account_PrivacyRules = $MadelineProto->account->setPrivacy(['key' => InputPrivacyKey, 'rules' => [InputPrivacyRule, InputPrivacyRule], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.setPrivacy` + +Parameters: + +key - Json encoded InputPrivacyKey + +rules - Json encoded array of InputPrivacyRule + + + + +Or, if you're into Lua: + +``` +account_PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_unregisterDevice.md b/old_docs/API_docs_v81/methods/account_unregisterDevice.md new file mode 100644 index 00000000..5da8c776 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_unregisterDevice.md @@ -0,0 +1,72 @@ +--- +title: account.unregisterDevice +description: Stop sending PUSH notifications to app +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.unregisterDevice +[Back to methods index](index.md) + + +Stop sending PUSH notifications to app + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|token\_type|[int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token|[string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|other\_uids|Array of [int](../types/int.md) | Yes|Other UIDs| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->unregisterDevice(['token_type' => int, 'token' => 'string', 'other_uids' => [int, int], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.unregisterDevice` + +Parameters: + +token_type - Json encoded int + +token - Json encoded string + +other_uids - Json encoded array of int + + + + +Or, if you're into Lua: + +``` +Bool = account.unregisterDevice({token_type=int, token='string', other_uids={int}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v81/methods/account_updateDeviceLocked.md new file mode 100644 index 00000000..f6a68825 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_updateDeviceLocked.md @@ -0,0 +1,59 @@ +--- +title: account.updateDeviceLocked +description: Disable all notifications for a certain period +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.updateDeviceLocked +[Back to methods index](index.md) + + +Disable all notifications for a certain period + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|period|[int](../types/int.md) | Yes|For how long should notifications be disabled| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->updateDeviceLocked(['period' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.updateDeviceLocked` + +Parameters: + +period - Json encoded int + + + + +Or, if you're into Lua: + +``` +Bool = account.updateDeviceLocked({period=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_updateNotifySettings.md b/old_docs/API_docs_v81/methods/account_updateNotifySettings.md new file mode 100644 index 00000000..bc48835f --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_updateNotifySettings.md @@ -0,0 +1,69 @@ +--- +title: account.updateNotifySettings +description: Change notification settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.updateNotifySettings +[Back to methods index](index.md) + + +Change notification settings + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[InputNotifyPeer](../types/InputNotifyPeer.md) | Yes|The peers to which the notification settings should be applied| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Yes|Notification settings| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->updateNotifySettings(['peer' => InputNotifyPeer, 'settings' => InputPeerNotifySettings, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.updateNotifySettings` + +Parameters: + +peer - Json encoded InputNotifyPeer + +settings - Json encoded InputPeerNotifySettings + + + + +Or, if you're into Lua: + +``` +Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v81/methods/account_updatePasswordSettings.md new file mode 100644 index 00000000..2ae21011 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_updatePasswordSettings.md @@ -0,0 +1,72 @@ +--- +title: account.updatePasswordSettings +description: Update the 2FA password settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.updatePasswordSettings +[Back to methods index](index.md) + + +Update the 2FA password settings + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|current\_password\_hash|[bytes](../types/bytes.md) | Yes|Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()['current_salt']; $current_password_hash = hash('sha256', $current_salt.$password.$current_salt, true);`| +|new\_settings|[account\_PasswordInputSettings](../types/account_PasswordInputSettings.md) | Yes|New 2FA settings| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->updatePasswordSettings(['current_password_hash' => 'bytes', 'new_settings' => account_PasswordInputSettings, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.updatePasswordSettings` + +Parameters: + +current_password_hash - Json encoded bytes + +new_settings - Json encoded account_PasswordInputSettings + + + + +Or, if you're into Lua: + +``` +Bool = account.updatePasswordSettings({current_password_hash='bytes', new_settings=account_PasswordInputSettings, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EMAIL_UNCONFIRMED|Email unconfirmed| +|NEW_SALT_INVALID|The new salt is invalid| +|NEW_SETTINGS_INVALID|The new settings are invalid| +|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_updateProfile.md b/old_docs/API_docs_v81/methods/account_updateProfile.md new file mode 100644 index 00000000..1ba4d059 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_updateProfile.md @@ -0,0 +1,73 @@ +--- +title: account.updateProfile +description: Update profile info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.updateProfile +[Back to methods index](index.md) + + +Update profile info + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|first\_name|[string](../types/string.md) | Optional|The first name| +|last\_name|[string](../types/string.md) | Optional|The last name| +|about|[string](../types/string.md) | Optional|The bio/about field| + + +### Return type: [User](../types/User.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$User = $MadelineProto->account->updateProfile(['first_name' => 'string', 'last_name' => 'string', 'about' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.updateProfile` + +Parameters: + +first_name - Json encoded string + +last_name - Json encoded string + +about - Json encoded string + + + + +Or, if you're into Lua: + +``` +User = account.updateProfile({first_name='string', last_name='string', about='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ABOUT_TOO_LONG|The provided bio is too long| +|FIRSTNAME_INVALID|The first name is invalid| + + diff --git a/old_docs/API_docs_v81/methods/account_updateStatus.md b/old_docs/API_docs_v81/methods/account_updateStatus.md new file mode 100644 index 00000000..b5e5b531 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_updateStatus.md @@ -0,0 +1,66 @@ +--- +title: account.updateStatus +description: Update online status +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.updateStatus +[Back to methods index](index.md) + + +Update online status + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offline|[Bool](../types/Bool.md) | Yes|offline to set the status to offline| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->updateStatus(['offline' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.updateStatus` + +Parameters: + +offline - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Bool = account.updateStatus({offline=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v81/methods/account_updateUsername.md b/old_docs/API_docs_v81/methods/account_updateUsername.md new file mode 100644 index 00000000..1215b66f --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_updateUsername.md @@ -0,0 +1,68 @@ +--- +title: account.updateUsername +description: Update this user's username +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.updateUsername +[Back to methods index](index.md) + + +Update this user's username + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|username|[string](../types/string.md) | Yes|The new username| + + +### Return type: [User](../types/User.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$User = $MadelineProto->account->updateUsername(['username' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.updateUsername` + +Parameters: + +username - Json encoded string + + + + +Or, if you're into Lua: + +``` +User = account.updateUsername({username='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_NOT_MODIFIED|The username was not modified| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v81/methods/account_verifyEmail.md b/old_docs/API_docs_v81/methods/account_verifyEmail.md new file mode 100644 index 00000000..ee14f51b --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_verifyEmail.md @@ -0,0 +1,71 @@ +--- +title: account.verifyEmail +description: Verify email address +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.verifyEmail +[Back to methods index](index.md) + + +Verify email address + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|email|[string](../types/string.md) | Yes|The email address| +|code|[string](../types/string.md) | Yes|The received code| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->verifyEmail(['email' => 'string', 'code' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.verifyEmail +* params - `{"email": "string", "code": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.verifyEmail` + +Parameters: + +email - Json encoded string + +code - Json encoded string + + + + +Or, if you're into Lua: + +``` +Bool = account.verifyEmail({email='string', code='string', }) +``` + diff --git a/old_docs/API_docs_v81/methods/account_verifyPhone.md b/old_docs/API_docs_v81/methods/account_verifyPhone.md new file mode 100644 index 00000000..667416e7 --- /dev/null +++ b/old_docs/API_docs_v81/methods/account_verifyPhone.md @@ -0,0 +1,74 @@ +--- +title: account.verifyPhone +description: Verify phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: account.verifyPhone +[Back to methods index](index.md) + + +Verify phone number + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash returned by account.sendVerifyPhoneCode| +|phone\_code|[string](../types/string.md) | Yes|The phone code type returned by account.sendVerifyPhoneCode| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->account->verifyPhone(['phone_number' => 'string', 'phone_code_hash' => 'string', 'phone_code' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - account.verifyPhone +* params - `{"phone_number": "string", "phone_code_hash": "string", "phone_code": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.verifyPhone` + +Parameters: + +phone_number - Json encoded string + +phone_code_hash - Json encoded string + +phone_code - Json encoded string + + + + +Or, if you're into Lua: + +``` +Bool = account.verifyPhone({phone_number='string', phone_code_hash='string', phone_code='string', }) +``` + diff --git a/old_docs/API_docs_v81/methods/api_README.md b/old_docs/API_docs_v81/methods/api_README.md new file mode 100644 index 00000000..7c09199a --- /dev/null +++ b/old_docs/API_docs_v81/methods/api_README.md @@ -0,0 +1,612 @@ +--- +title: Methods +description: List of methods +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Methods +[Back to API documentation index](..) + +[Go to the new description-version method index](README.md) + +$MadelineProto->[logout](https://docs.madelineproto.xyz/logout.html)(); + +$MadelineProto->[phone_login](https://docs.madelineproto.xyz/phone_login.html)($number); + +$MadelineProto->[complete_phone_login](https://docs.madelineproto.xyz/complete_phone_login.html)($code); + +$MadelineProto->[complete_2FA_login](https://docs.madelineproto.xyz/complete_2FA_login.html)($password); + +$MadelineProto->[bot_login](https://docs.madelineproto.xyz/bot_login.html)($token); + + +$MadelineProto->[get_dialogs](https://docs.madelineproto.xyz/get_dialogs.html)(); + +$MadelineProto->[get_pwr_chat](https://docs.madelineproto.xyz/get_pwr_chat.html)($id); + +$MadelineProto->[get_info](https://docs.madelineproto.xyz/get_info.html)($id); + +$MadelineProto->[get_full_info](https://docs.madelineproto.xyz/get_full_info.html)($id); + +$MadelineProto->[get_self](https://docs.madelineproto.xyz/get_self.html)(); + + +$MadelineProto->[request_call](https://docs.madelineproto.xyz/request_call.html)($id); + +$MadelineProto->[request_secret_chat](https://docs.madelineproto.xyz/request_secret_chat.html)($id); + +*** +

+$MadelineProto->[account->acceptAuthorization](account_acceptAuthorization.md)(\['bot_id' => [int](../types/int.md), 'scope' => [string](../types/string.md), 'public_key' => [string](../types/string.md), 'value_hashes' => \[[SecureValueHash](../types/SecureValueHash.md)\], 'credentials' => [SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->changePhone](account_changePhone.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), 'phone_code' => [string](../types/string.md), \]) === [$User](../types/User.md) + +$MadelineProto->[account->checkUsername](account_checkUsername.md)(\['username' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->confirmPhone](account_confirmPhone.md)(\['phone_code_hash' => [string](../types/string.md), 'phone_code' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->deleteAccount](account_deleteAccount.md)(\['reason' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->deleteSecureValue](account_deleteSecureValue.md)(\['types' => \[[SecureValueType](../types/SecureValueType.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->finishTakeoutSession](account_finishTakeoutSession.md)(\['success' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->getAccountTTL](account_getAccountTTL.md)(\[\]) === [$AccountDaysTTL](../types/AccountDaysTTL.md) + +$MadelineProto->[account->getAllSecureValues](account_getAllSecureValues.md)(\[\]) === [$Vector\_of\_SecureValue](../types/SecureValue.md) + +$MadelineProto->[account->getAuthorizationForm](account_getAuthorizationForm.md)(\['bot_id' => [int](../types/int.md), 'scope' => [string](../types/string.md), 'public_key' => [string](../types/string.md), \]) === [$account\_AuthorizationForm](../types/account_AuthorizationForm.md) + +$MadelineProto->[account->getAuthorizations](account_getAuthorizations.md)(\[\]) === [$account\_Authorizations](../types/account_Authorizations.md) + +$MadelineProto->[account->getNotifySettings](account_getNotifySettings.md)(\['peer' => [InputNotifyPeer](../types/InputNotifyPeer.md), \]) === [$PeerNotifySettings](../types/PeerNotifySettings.md) + +$MadelineProto->[account->getPassword](account_getPassword.md)(\[\]) === [$account\_Password](../types/account_Password.md) + +$MadelineProto->[account->getPasswordSettings](account_getPasswordSettings.md)(\['current_password_hash' => [bytes](../types/bytes.md), \]) === [$account\_PasswordSettings](../types/account_PasswordSettings.md) + +$MadelineProto->[account->getPrivacy](account_getPrivacy.md)(\['key' => [InputPrivacyKey](../types/InputPrivacyKey.md), \]) === [$account\_PrivacyRules](../types/account_PrivacyRules.md) + +$MadelineProto->[account->getSecureValue](account_getSecureValue.md)(\['types' => \[[SecureValueType](../types/SecureValueType.md)\], \]) === [$Vector\_of\_SecureValue](../types/SecureValue.md) + +$MadelineProto->[account->getTmpPassword](account_getTmpPassword.md)(\['password_hash' => [bytes](../types/bytes.md), 'period' => [int](../types/int.md), \]) === [$account\_TmpPassword](../types/account_TmpPassword.md) + +$MadelineProto->[account->getWallPapers](account_getWallPapers.md)(\[\]) === [$Vector\_of\_WallPaper](../types/WallPaper.md) + +$MadelineProto->[account->getWebAuthorizations](account_getWebAuthorizations.md)(\[\]) === [$account\_WebAuthorizations](../types/account_WebAuthorizations.md) + +$MadelineProto->[account->initTakeoutSession](account_initTakeoutSession.md)(\['contacts' => [Bool](../types/Bool.md), 'message_users' => [Bool](../types/Bool.md), 'message_chats' => [Bool](../types/Bool.md), 'message_megagroups' => [Bool](../types/Bool.md), 'message_channels' => [Bool](../types/Bool.md), 'files' => [Bool](../types/Bool.md), 'file_max_size' => [int](../types/int.md), \]) === [$account\_Takeout](../types/account_Takeout.md) + +$MadelineProto->[account->registerDevice](account_registerDevice.md)(\['token_type' => [int](../types/int.md), 'token' => [string](../types/string.md), 'app_sandbox' => [Bool](../types/Bool.md), 'secret' => [bytes](../types/bytes.md), 'other_uids' => \[[int](../types/int.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->reportPeer](account_reportPeer.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'reason' => [ReportReason](../types/ReportReason.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->resetAuthorization](account_resetAuthorization.md)(\['hash' => [long](../types/long.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->resetNotifySettings](account_resetNotifySettings.md)(\[\]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->resetWebAuthorization](account_resetWebAuthorization.md)(\['hash' => [long](../types/long.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->resetWebAuthorizations](account_resetWebAuthorizations.md)(\[\]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->saveSecureValue](account_saveSecureValue.md)(\['value' => [InputSecureValue](../types/InputSecureValue.md), 'secure_secret_id' => [long](../types/long.md), \]) === [$SecureValue](../types/SecureValue.md) + +$MadelineProto->[account->sendChangePhoneCode](account_sendChangePhoneCode.md)(\['allow_flashcall' => [Bool](../types/Bool.md), 'phone_number' => [string](../types/string.md), 'current_number' => [Bool](../types/Bool.md), \]) === [$auth\_SentCode](../types/auth_SentCode.md) + +$MadelineProto->[account->sendConfirmPhoneCode](account_sendConfirmPhoneCode.md)(\['allow_flashcall' => [Bool](../types/Bool.md), 'hash' => [string](../types/string.md), 'current_number' => [Bool](../types/Bool.md), \]) === [$auth\_SentCode](../types/auth_SentCode.md) + +$MadelineProto->[account->sendVerifyEmailCode](account_sendVerifyEmailCode.md)(\['email' => [string](../types/string.md), \]) === [$account\_SentEmailCode](../types/account_SentEmailCode.md) + +$MadelineProto->[account->sendVerifyPhoneCode](account_sendVerifyPhoneCode.md)(\['allow_flashcall' => [Bool](../types/Bool.md), 'phone_number' => [string](../types/string.md), 'current_number' => [Bool](../types/Bool.md), \]) === [$auth\_SentCode](../types/auth_SentCode.md) + +$MadelineProto->[account->setAccountTTL](account_setAccountTTL.md)(\['ttl' => [AccountDaysTTL](../types/AccountDaysTTL.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->setPrivacy](account_setPrivacy.md)(\['key' => [InputPrivacyKey](../types/InputPrivacyKey.md), 'rules' => \[[InputPrivacyRule](../types/InputPrivacyRule.md)\], \]) === [$account\_PrivacyRules](../types/account_PrivacyRules.md) + +$MadelineProto->[account->unregisterDevice](account_unregisterDevice.md)(\['token_type' => [int](../types/int.md), 'token' => [string](../types/string.md), 'other_uids' => \[[int](../types/int.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->updateDeviceLocked](account_updateDeviceLocked.md)(\['period' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->updateNotifySettings](account_updateNotifySettings.md)(\['peer' => [InputNotifyPeer](../types/InputNotifyPeer.md), 'settings' => [InputPeerNotifySettings](../types/InputPeerNotifySettings.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->updatePasswordSettings](account_updatePasswordSettings.md)(\['current_password_hash' => [bytes](../types/bytes.md), 'new_settings' => [account\_PasswordInputSettings](../types/account_PasswordInputSettings.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->updateProfile](account_updateProfile.md)(\['first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'about' => [string](../types/string.md), \]) === [$User](../types/User.md) + +$MadelineProto->[account->updateStatus](account_updateStatus.md)(\['offline' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->updateUsername](account_updateUsername.md)(\['username' => [string](../types/string.md), \]) === [$User](../types/User.md) + +$MadelineProto->[account->verifyEmail](account_verifyEmail.md)(\['email' => [string](../types/string.md), 'code' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[account->verifyPhone](account_verifyPhone.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), 'phone_code' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[auth->bindTempAuthKey](auth_bindTempAuthKey.md)(\['perm_auth_key_id' => [long](../types/long.md), 'nonce' => [long](../types/long.md), 'expires_at' => [int](../types/int.md), 'encrypted_message' => [bytes](../types/bytes.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[auth->cancelCode](auth_cancelCode.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[auth->checkPassword](auth_checkPassword.md)(\['password_hash' => [bytes](../types/bytes.md), \]) === [$auth\_Authorization](../types/auth_Authorization.md) + +$MadelineProto->[auth->dropTempAuthKeys](auth_dropTempAuthKeys.md)(\['except_auth_keys' => \[[long](../types/long.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[auth->exportAuthorization](auth_exportAuthorization.md)(\['dc_id' => [int](../types/int.md), \]) === [$auth\_ExportedAuthorization](../types/auth_ExportedAuthorization.md) + +$MadelineProto->[auth->importAuthorization](auth_importAuthorization.md)(\['id' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]) === [$auth\_Authorization](../types/auth_Authorization.md) + +$MadelineProto->[auth->importBotAuthorization](auth_importBotAuthorization.md)(\['api_id' => [int](../types/int.md), 'api_hash' => [string](../types/string.md), 'bot_auth_token' => [string](../types/string.md), \]) === [$auth\_Authorization](../types/auth_Authorization.md) + +$MadelineProto->[auth->logOut](auth_logOut.md)(\[\]) === [$Bool](../types/Bool.md) + +$MadelineProto->[auth->recoverPassword](auth_recoverPassword.md)(\['code' => [string](../types/string.md), \]) === [$auth\_Authorization](../types/auth_Authorization.md) + +$MadelineProto->[auth->requestPasswordRecovery](auth_requestPasswordRecovery.md)(\[\]) === [$auth\_PasswordRecovery](../types/auth_PasswordRecovery.md) + +$MadelineProto->[auth->resendCode](auth_resendCode.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), \]) === [$auth\_SentCode](../types/auth_SentCode.md) + +$MadelineProto->[auth->resetAuthorizations](auth_resetAuthorizations.md)(\[\]) === [$Bool](../types/Bool.md) + +$MadelineProto->[auth->sendCode](auth_sendCode.md)(\['allow_flashcall' => [Bool](../types/Bool.md), 'phone_number' => [string](../types/string.md), 'current_number' => [Bool](../types/Bool.md), 'api_id' => [int](../types/int.md), 'api_hash' => [string](../types/string.md), \]) === [$auth\_SentCode](../types/auth_SentCode.md) + +$MadelineProto->[auth->signIn](auth_signIn.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), 'phone_code' => [string](../types/string.md), \]) === [$auth\_Authorization](../types/auth_Authorization.md) + +$MadelineProto->[auth->signUp](auth_signUp.md)(\['phone_number' => [string](../types/string.md), 'phone_code_hash' => [string](../types/string.md), 'phone_code' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), \]) === [$auth\_Authorization](../types/auth_Authorization.md) + +*** +

+$MadelineProto->[bots->answerWebhookJSONQuery](bots_answerWebhookJSONQuery.md)(\['query_id' => [long](../types/long.md), 'data' => [DataJSON](../types/DataJSON.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[bots->sendCustomRequest](bots_sendCustomRequest.md)(\['custom_method' => [string](../types/string.md), 'params' => [DataJSON](../types/DataJSON.md), \]) === [$DataJSON](../types/DataJSON.md) + +*** +

+$MadelineProto->[channels->checkUsername](channels_checkUsername.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'username' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[channels->createChannel](channels_createChannel.md)(\['broadcast' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'title' => [string](../types/string.md), 'about' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->deleteChannel](channels_deleteChannel.md)(\['channel' => [InputChannel](../types/InputChannel.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->deleteHistory](channels_deleteHistory.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'max_id' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[channels->deleteMessages](channels_deleteMessages.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'id' => \[[int](../types/int.md)\], \]) === [$messages\_AffectedMessages](../types/messages_AffectedMessages.md) + +$MadelineProto->[channels->deleteUserHistory](channels_deleteUserHistory.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), \]) === [$messages\_AffectedHistory](../types/messages_AffectedHistory.md) + +$MadelineProto->[channels->editAbout](channels_editAbout.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'about' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[channels->editAdmin](channels_editAdmin.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'admin_rights' => [ChannelAdminRights](../types/ChannelAdminRights.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->editBanned](channels_editBanned.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'banned_rights' => [ChannelBannedRights](../types/ChannelBannedRights.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->editPhoto](channels_editPhoto.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'photo' => [InputChatPhoto](../types/InputChatPhoto.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->editTitle](channels_editTitle.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'title' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->exportInvite](channels_exportInvite.md)(\['channel' => [InputChannel](../types/InputChannel.md), \]) === [$ExportedChatInvite](../types/ExportedChatInvite.md) + +$MadelineProto->[channels->exportMessageLink](channels_exportMessageLink.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'id' => [int](../types/int.md), 'grouped' => [Bool](../types/Bool.md), \]) === [$ExportedMessageLink](../types/ExportedMessageLink.md) + +$MadelineProto->[channels->getAdminLog](channels_getAdminLog.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'q' => [string](../types/string.md), 'events_filter' => [ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md), 'admins' => \[[InputUser](../types/InputUser.md)\], 'max_id' => [long](../types/long.md), 'min_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), \]) === [$channels\_AdminLogResults](../types/channels_AdminLogResults.md) + +$MadelineProto->[channels->getAdminedPublicChannels](channels_getAdminedPublicChannels.md)(\[\]) === [$messages\_Chats](../types/messages_Chats.md) + +$MadelineProto->[channels->getChannels](channels_getChannels.md)(\['id' => \[[InputChannel](../types/InputChannel.md)\], \]) === [$messages\_Chats](../types/messages_Chats.md) + +$MadelineProto->[channels->getFullChannel](channels_getFullChannel.md)(\['channel' => [InputChannel](../types/InputChannel.md), \]) === [$messages\_ChatFull](../types/messages_ChatFull.md) + +$MadelineProto->[channels->getLeftChannels](channels_getLeftChannels.md)(\['offset' => [int](../types/int.md), \]) === [$messages\_Chats](../types/messages_Chats.md) + +$MadelineProto->[channels->getMessages](channels_getMessages.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'id' => \[[InputMessage](../types/InputMessage.md)\], \]) === [$messages\_Messages](../types/messages_Messages.md) + +$MadelineProto->[channels->getParticipant](channels_getParticipant.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), \]) === [$channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) + +$MadelineProto->[channels->getParticipants](channels_getParticipants.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'filter' => [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) + +$MadelineProto->[channels->inviteToChannel](channels_inviteToChannel.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'users' => \[[InputUser](../types/InputUser.md)\], \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->joinChannel](channels_joinChannel.md)(\['channel' => [InputChannel](../types/InputChannel.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->leaveChannel](channels_leaveChannel.md)(\['channel' => [InputChannel](../types/InputChannel.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->readHistory](channels_readHistory.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'max_id' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[channels->readMessageContents](channels_readMessageContents.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'id' => \[[int](../types/int.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[channels->reportSpam](channels_reportSpam.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'id' => \[[int](../types/int.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[channels->setStickers](channels_setStickers.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'stickerset' => [InputStickerSet](../types/InputStickerSet.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[channels->toggleInvites](channels_toggleInvites.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'enabled' => [Bool](../types/Bool.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->togglePreHistoryHidden](channels_togglePreHistoryHidden.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'enabled' => [Bool](../types/Bool.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->toggleSignatures](channels_toggleSignatures.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'enabled' => [Bool](../types/Bool.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->updatePinnedMessage](channels_updatePinnedMessage.md)(\['silent' => [Bool](../types/Bool.md), 'channel' => [InputChannel](../types/InputChannel.md), 'id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[channels->updateUsername](channels_updateUsername.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'username' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[contacts->block](contacts_block.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[contacts->deleteContact](contacts_deleteContact.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$contacts\_Link](../types/contacts_Link.md) + +$MadelineProto->[contacts->deleteContacts](contacts_deleteContacts.md)(\['id' => \[[InputUser](../types/InputUser.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[contacts->exportCard](contacts_exportCard.md)(\[\]) === [$Vector\_of\_int](../types/int.md) + +$MadelineProto->[contacts->getBlocked](contacts_getBlocked.md)(\['offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$contacts\_Blocked](../types/contacts_Blocked.md) + +$MadelineProto->[contacts->getContacts](contacts_getContacts.md)(\['hash' => [int](../types/int.md), \]) === [$contacts\_Contacts](../types/contacts_Contacts.md) + +$MadelineProto->[contacts->getSaved](contacts_getSaved.md)(\[\]) === [$Vector\_of\_SavedContact](../types/SavedContact.md) + +$MadelineProto->[contacts->getStatuses](contacts_getStatuses.md)(\[\]) === [$Vector\_of\_ContactStatus](../types/ContactStatus.md) + +$MadelineProto->[contacts->getTopPeers](contacts_getTopPeers.md)(\['correspondents' => [Bool](../types/Bool.md), 'bots_pm' => [Bool](../types/Bool.md), 'bots_inline' => [Bool](../types/Bool.md), 'phone_calls' => [Bool](../types/Bool.md), 'groups' => [Bool](../types/Bool.md), 'channels' => [Bool](../types/Bool.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$contacts\_TopPeers](../types/contacts_TopPeers.md) + +$MadelineProto->[contacts->importCard](contacts_importCard.md)(\['export_card' => \[[int](../types/int.md)\], \]) === [$User](../types/User.md) + +$MadelineProto->[contacts->importContacts](contacts_importContacts.md)(\['contacts' => \[[InputContact](../types/InputContact.md)\], \]) === [$contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) + +$MadelineProto->[contacts->resetSaved](contacts_resetSaved.md)(\[\]) === [$Bool](../types/Bool.md) + +$MadelineProto->[contacts->resetTopPeerRating](contacts_resetTopPeerRating.md)(\['category' => [TopPeerCategory](../types/TopPeerCategory.md), 'peer' => [InputPeer](../types/InputPeer.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[contacts->resolveUsername](contacts_resolveUsername.md)(\['username' => [string](../types/string.md), \]) === [$contacts\_ResolvedPeer](../types/contacts_ResolvedPeer.md) + +$MadelineProto->[contacts->search](contacts_search.md)(\['q' => [string](../types/string.md), 'limit' => [int](../types/int.md), \]) === [$contacts\_Found](../types/contacts_Found.md) + +$MadelineProto->[contacts->unblock](contacts_unblock.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[help->acceptTermsOfService](help_acceptTermsOfService.md)(\['id' => [DataJSON](../types/DataJSON.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[help->getAppChangelog](help_getAppChangelog.md)(\['prev_app_version' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[help->getAppUpdate](help_getAppUpdate.md)(\[\]) === [$help\_AppUpdate](../types/help_AppUpdate.md) + +$MadelineProto->[help->getCdnConfig](help_getCdnConfig.md)(\[\]) === [$CdnConfig](../types/CdnConfig.md) + +$MadelineProto->[help->getConfig](help_getConfig.md)(\[\]) === [$Config](../types/Config.md) + +$MadelineProto->[help->getDeepLinkInfo](help_getDeepLinkInfo.md)(\['path' => [string](../types/string.md), \]) === [$help\_DeepLinkInfo](../types/help_DeepLinkInfo.md) + +$MadelineProto->[help->getInviteText](help_getInviteText.md)(\[\]) === [$help\_InviteText](../types/help_InviteText.md) + +$MadelineProto->[help->getNearestDc](help_getNearestDc.md)(\[\]) === [$NearestDc](../types/NearestDc.md) + +$MadelineProto->[help->getProxyData](help_getProxyData.md)(\[\]) === [$help\_ProxyData](../types/help_ProxyData.md) + +$MadelineProto->[help->getRecentMeUrls](help_getRecentMeUrls.md)(\['referer' => [string](../types/string.md), \]) === [$help\_RecentMeUrls](../types/help_RecentMeUrls.md) + +$MadelineProto->[help->getSupport](help_getSupport.md)(\[\]) === [$help\_Support](../types/help_Support.md) + +$MadelineProto->[help->getTermsOfServiceUpdate](help_getTermsOfServiceUpdate.md)(\[\]) === [$help\_TermsOfServiceUpdate](../types/help_TermsOfServiceUpdate.md) + +$MadelineProto->[help->saveAppLog](help_saveAppLog.md)(\['events' => \[[InputAppEvent](../types/InputAppEvent.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[help->setBotUpdatesStatus](help_setBotUpdatesStatus.md)(\['pending_updates_count' => [int](../types/int.md), 'message' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[initConnection](initConnection.md)(\['api_id' => [int](../types/int.md), 'device_model' => [string](../types/string.md), 'system_version' => [string](../types/string.md), 'app_version' => [string](../types/string.md), 'system_lang_code' => [string](../types/string.md), 'lang_pack' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), 'proxy' => [InputClientProxy](../types/InputClientProxy.md), 'query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) + +*** +

+$MadelineProto->[invokeAfterMsg](invokeAfterMsg.md)(\['msg_id' => [long](../types/long.md), 'query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) + +*** +

+$MadelineProto->[invokeAfterMsgs](invokeAfterMsgs.md)(\['msg_ids' => \[[long](../types/long.md)\], 'query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) + +*** +

+$MadelineProto->[invokeWithLayer](invokeWithLayer.md)(\['layer' => [int](../types/int.md), 'query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) + +*** +

+$MadelineProto->[invokeWithMessagesRange](invokeWithMessagesRange.md)(\['range' => [MessageRange](../types/MessageRange.md), 'query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) + +*** +

+$MadelineProto->[invokeWithTakeout](invokeWithTakeout.md)(\['takeout_id' => [long](../types/long.md), 'query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) + +*** +

+$MadelineProto->[invokeWithoutUpdates](invokeWithoutUpdates.md)(\['query' => [!X](../types/!X.md), \]) === [$X](../types/X.md) + +*** +

+$MadelineProto->[langpack->getDifference](langpack_getDifference.md)(\['from_version' => [int](../types/int.md), \]) === [$LangPackDifference](../types/LangPackDifference.md) + +$MadelineProto->[langpack->getLangPack](langpack_getLangPack.md)(\['lang_code' => [string](../types/string.md), \]) === [$LangPackDifference](../types/LangPackDifference.md) + +$MadelineProto->[langpack->getLanguages](langpack_getLanguages.md)(\[\]) === [$Vector\_of\_LangPackLanguage](../types/LangPackLanguage.md) + +$MadelineProto->[langpack->getStrings](langpack_getStrings.md)(\['lang_code' => [string](../types/string.md), 'keys' => \[[string](../types/string.md)\], \]) === [$Vector\_of\_LangPackString](../types/LangPackString.md) + +*** +

+$MadelineProto->[messages->acceptEncryption](messages_acceptEncryption.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'g_b' => [bytes](../types/bytes.md), 'key_fingerprint' => [long](../types/long.md), \]) === [$EncryptedChat](../types/EncryptedChat.md) + +$MadelineProto->[messages->addChatUser](messages_addChatUser.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'user_id' => [InputUser](../types/InputUser.md), 'fwd_limit' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->checkChatInvite](messages_checkChatInvite.md)(\['hash' => [string](../types/string.md), \]) === [$ChatInvite](../types/ChatInvite.md) + +$MadelineProto->[messages->clearRecentStickers](messages_clearRecentStickers.md)(\['attached' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->createChat](messages_createChat.md)(\['users' => \[[InputUser](../types/InputUser.md)\], 'title' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->deleteChatUser](messages_deleteChatUser.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'user_id' => [InputUser](../types/InputUser.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->deleteHistory](messages_deleteHistory.md)(\['just_clear' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'max_id' => [int](../types/int.md), \]) === [$messages\_AffectedHistory](../types/messages_AffectedHistory.md) + +$MadelineProto->[messages->deleteMessages](messages_deleteMessages.md)(\['revoke' => [Bool](../types/Bool.md), 'id' => \[[int](../types/int.md)\], \]) === [$messages\_AffectedMessages](../types/messages_AffectedMessages.md) + +$MadelineProto->[messages->discardEncryption](messages_discardEncryption.md)(\['chat_id' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->editChatAdmin](messages_editChatAdmin.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'user_id' => [InputUser](../types/InputUser.md), 'is_admin' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->editChatPhoto](messages_editChatPhoto.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'photo' => [InputChatPhoto](../types/InputChatPhoto.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->editChatTitle](messages_editChatTitle.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'title' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->editInlineBotMessage](messages_editInlineBotMessage.md)(\['no_webpage' => [Bool](../types/Bool.md), 'stop_geo_live' => [Bool](../types/Bool.md), 'id' => [InputBotInlineMessageID](../types/InputBotInlineMessageID.md), 'message' => [string](../types/string.md), 'media' => [InputMedia](../types/InputMedia.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->editMessage](messages_editMessage.md)(\['no_webpage' => [Bool](../types/Bool.md), 'stop_geo_live' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'media' => [InputMedia](../types/InputMedia.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->exportChatInvite](messages_exportChatInvite.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$ExportedChatInvite](../types/ExportedChatInvite.md) + +$MadelineProto->[messages->faveSticker](messages_faveSticker.md)(\['id' => [InputDocument](../types/InputDocument.md), 'unfave' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->forwardMessages](messages_forwardMessages.md)(\['silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'with_my_score' => [Bool](../types/Bool.md), 'grouped' => [Bool](../types/Bool.md), 'from_peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], 'to_peer' => [InputPeer](../types/InputPeer.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->getAllChats](messages_getAllChats.md)(\['except_ids' => \[[int](../types/int.md)\], \]) === [$messages\_Chats](../types/messages_Chats.md) + +$MadelineProto->[messages->getAllDrafts](messages_getAllDrafts.md)(\[\]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->getAllStickers](messages_getAllStickers.md)(\['hash' => [int](../types/int.md), \]) === [$messages\_AllStickers](../types/messages_AllStickers.md) + +$MadelineProto->[messages->getArchivedStickers](messages_getArchivedStickers.md)(\['masks' => [Bool](../types/Bool.md), 'offset_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), \]) === [$messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) + +$MadelineProto->[messages->getAttachedStickers](messages_getAttachedStickers.md)(\['media' => [InputStickeredMedia](../types/InputStickeredMedia.md), \]) === [$Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) + +$MadelineProto->[messages->getBotCallbackAnswer](messages_getBotCallbackAnswer.md)(\['game' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'data' => [bytes](../types/bytes.md), \]) === [$messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) + +$MadelineProto->[messages->getChats](messages_getChats.md)(\['id' => \[[int](../types/int.md)\], \]) === [$messages\_Chats](../types/messages_Chats.md) + +$MadelineProto->[messages->getCommonChats](messages_getCommonChats.md)(\['user_id' => [InputUser](../types/InputUser.md), 'max_id' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$messages\_Chats](../types/messages_Chats.md) + +$MadelineProto->[messages->getDhConfig](messages_getDhConfig.md)(\['version' => [int](../types/int.md), 'random_length' => [int](../types/int.md), \]) === [$messages\_DhConfig](../types/messages_DhConfig.md) + +$MadelineProto->[messages->getDialogs](messages_getDialogs.md)(\['exclude_pinned' => [Bool](../types/Bool.md), 'offset_date' => [int](../types/int.md), 'offset_id' => [int](../types/int.md), 'offset_peer' => [InputPeer](../types/InputPeer.md), 'limit' => [int](../types/int.md), \]) === [$messages\_Dialogs](../types/messages_Dialogs.md) + +$MadelineProto->[messages->getDocumentByHash](messages_getDocumentByHash.md)(\['sha256' => [bytes](../types/bytes.md), 'size' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), \]) === [$Document](../types/Document.md) + +$MadelineProto->[messages->getFavedStickers](messages_getFavedStickers.md)(\['hash' => [int](../types/int.md), \]) === [$messages\_FavedStickers](../types/messages_FavedStickers.md) + +$MadelineProto->[messages->getFeaturedStickers](messages_getFeaturedStickers.md)(\['hash' => [int](../types/int.md), \]) === [$messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) + +$MadelineProto->[messages->getFullChat](messages_getFullChat.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$messages\_ChatFull](../types/messages_ChatFull.md) + +$MadelineProto->[messages->getGameHighScores](messages_getGameHighScores.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), 'user_id' => [InputUser](../types/InputUser.md), \]) === [$messages\_HighScores](../types/messages_HighScores.md) + +$MadelineProto->[messages->getHistory](messages_getHistory.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'offset_id' => [int](../types/int.md), 'offset_date' => [int](../types/int.md), 'add_offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'max_id' => [int](../types/int.md), 'min_id' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$messages\_Messages](../types/messages_Messages.md) + +$MadelineProto->[messages->getInlineBotResults](messages_getInlineBotResults.md)(\['bot' => [InputUser](../types/InputUser.md), 'peer' => [InputPeer](../types/InputPeer.md), 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'query' => [string](../types/string.md), 'offset' => [string](../types/string.md), \]) === [$messages\_BotResults](../types/messages_BotResults.md) + +$MadelineProto->[messages->getInlineGameHighScores](messages_getInlineGameHighScores.md)(\['id' => [InputBotInlineMessageID](../types/InputBotInlineMessageID.md), 'user_id' => [InputUser](../types/InputUser.md), \]) === [$messages\_HighScores](../types/messages_HighScores.md) + +$MadelineProto->[messages->getMaskStickers](messages_getMaskStickers.md)(\['hash' => [int](../types/int.md), \]) === [$messages\_AllStickers](../types/messages_AllStickers.md) + +$MadelineProto->[messages->getMessageEditData](messages_getMessageEditData.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), \]) === [$messages\_MessageEditData](../types/messages_MessageEditData.md) + +$MadelineProto->[messages->getMessages](messages_getMessages.md)(\['id' => \[[InputMessage](../types/InputMessage.md)\], \]) === [$messages\_Messages](../types/messages_Messages.md) + +$MadelineProto->[messages->getMessagesViews](messages_getMessagesViews.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], 'increment' => [Bool](../types/Bool.md), \]) === [$Vector\_of\_int](../types/int.md) + +$MadelineProto->[messages->getPeerDialogs](messages_getPeerDialogs.md)(\['peers' => \[[InputDialogPeer](../types/InputDialogPeer.md)\], \]) === [$messages\_PeerDialogs](../types/messages_PeerDialogs.md) + +$MadelineProto->[messages->getPeerSettings](messages_getPeerSettings.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$PeerSettings](../types/PeerSettings.md) + +$MadelineProto->[messages->getPinnedDialogs](messages_getPinnedDialogs.md)(\[\]) === [$messages\_PeerDialogs](../types/messages_PeerDialogs.md) + +$MadelineProto->[messages->getRecentLocations](messages_getRecentLocations.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'limit' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$messages\_Messages](../types/messages_Messages.md) + +$MadelineProto->[messages->getRecentStickers](messages_getRecentStickers.md)(\['attached' => [Bool](../types/Bool.md), 'hash' => [int](../types/int.md), \]) === [$messages\_RecentStickers](../types/messages_RecentStickers.md) + +$MadelineProto->[messages->getSavedGifs](messages_getSavedGifs.md)(\['hash' => [int](../types/int.md), \]) === [$messages\_SavedGifs](../types/messages_SavedGifs.md) + +$MadelineProto->[messages->getSplitRanges](messages_getSplitRanges.md)(\[\]) === [$Vector\_of\_MessageRange](../types/MessageRange.md) + +$MadelineProto->[messages->getStickerSet](messages_getStickerSet.md)(\['stickerset' => [InputStickerSet](../types/InputStickerSet.md), \]) === [$messages\_StickerSet](../types/messages_StickerSet.md) + +$MadelineProto->[messages->getStickers](messages_getStickers.md)(\['emoticon' => [string](../types/string.md), 'hash' => [int](../types/int.md), \]) === [$messages\_Stickers](../types/messages_Stickers.md) + +$MadelineProto->[messages->getUnreadMentions](messages_getUnreadMentions.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'offset_id' => [int](../types/int.md), 'add_offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'max_id' => [int](../types/int.md), 'min_id' => [int](../types/int.md), \]) === [$messages\_Messages](../types/messages_Messages.md) + +$MadelineProto->[messages->getWebPage](messages_getWebPage.md)(\['url' => [string](../types/string.md), 'hash' => [int](../types/int.md), \]) === [$WebPage](../types/WebPage.md) + +$MadelineProto->[messages->getWebPagePreview](messages_getWebPagePreview.md)(\['message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]) === [$MessageMedia](../types/MessageMedia.md) + +$MadelineProto->[messages->hideReportSpam](messages_hideReportSpam.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->importChatInvite](messages_importChatInvite.md)(\['hash' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->installStickerSet](messages_installStickerSet.md)(\['stickerset' => [InputStickerSet](../types/InputStickerSet.md), 'archived' => [Bool](../types/Bool.md), \]) === [$messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) + +$MadelineProto->[messages->migrateChat](messages_migrateChat.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->readEncryptedHistory](messages_readEncryptedHistory.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'max_date' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->readFeaturedStickers](messages_readFeaturedStickers.md)(\['id' => \[[long](../types/long.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->readHistory](messages_readHistory.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'max_id' => [int](../types/int.md), \]) === [$messages\_AffectedMessages](../types/messages_AffectedMessages.md) + +$MadelineProto->[messages->readMentions](messages_readMentions.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$messages\_AffectedHistory](../types/messages_AffectedHistory.md) + +$MadelineProto->[messages->readMessageContents](messages_readMessageContents.md)(\['id' => \[[int](../types/int.md)\], \]) === [$messages\_AffectedMessages](../types/messages_AffectedMessages.md) + +$MadelineProto->[messages->receivedMessages](messages_receivedMessages.md)(\['max_id' => [int](../types/int.md), \]) === [$Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) + +$MadelineProto->[messages->receivedQueue](messages_receivedQueue.md)(\['max_qts' => [int](../types/int.md), \]) === [$Vector\_of\_long](../types/long.md) + +$MadelineProto->[messages->reorderPinnedDialogs](messages_reorderPinnedDialogs.md)(\['force' => [Bool](../types/Bool.md), 'order' => \[[InputDialogPeer](../types/InputDialogPeer.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->reorderStickerSets](messages_reorderStickerSets.md)(\['masks' => [Bool](../types/Bool.md), 'order' => \[[long](../types/long.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->report](messages_report.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], 'reason' => [ReportReason](../types/ReportReason.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->reportEncryptedSpam](messages_reportEncryptedSpam.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->reportSpam](messages_reportSpam.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->requestEncryption](messages_requestEncryption.md)(\['user_id' => [InputUser](../types/InputUser.md), 'g_a' => [bytes](../types/bytes.md), \]) === [$EncryptedChat](../types/EncryptedChat.md) + +$MadelineProto->[messages->saveDraft](messages_saveDraft.md)(\['no_webpage' => [Bool](../types/Bool.md), 'reply_to_msg_id' => [int](../types/int.md), 'peer' => [InputPeer](../types/InputPeer.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->saveGif](messages_saveGif.md)(\['id' => [InputDocument](../types/InputDocument.md), 'unsave' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->saveRecentSticker](messages_saveRecentSticker.md)(\['attached' => [Bool](../types/Bool.md), 'id' => [InputDocument](../types/InputDocument.md), 'unsave' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->search](messages_search.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'q' => [string](../types/string.md), 'from_id' => [InputUser](../types/InputUser.md), 'filter' => [MessagesFilter](../types/MessagesFilter.md), 'min_date' => [int](../types/int.md), 'max_date' => [int](../types/int.md), 'offset_id' => [int](../types/int.md), 'add_offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), 'max_id' => [int](../types/int.md), 'min_id' => [int](../types/int.md), 'hash' => [int](../types/int.md), \]) === [$messages\_Messages](../types/messages_Messages.md) + +$MadelineProto->[messages->searchGifs](messages_searchGifs.md)(\['q' => [string](../types/string.md), 'offset' => [int](../types/int.md), \]) === [$messages\_FoundGifs](../types/messages_FoundGifs.md) + +$MadelineProto->[messages->searchGlobal](messages_searchGlobal.md)(\['q' => [string](../types/string.md), 'offset_date' => [int](../types/int.md), 'offset_peer' => [InputPeer](../types/InputPeer.md), 'offset_id' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$messages\_Messages](../types/messages_Messages.md) + +$MadelineProto->[messages->searchStickerSets](messages_searchStickerSets.md)(\['exclude_featured' => [Bool](../types/Bool.md), 'q' => [string](../types/string.md), 'hash' => [int](../types/int.md), \]) === [$messages\_FoundStickerSets](../types/messages_FoundStickerSets.md) + +$MadelineProto->[messages->sendEncrypted](messages_sendEncrypted.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'message' => [DecryptedMessage](../types/DecryptedMessage.md), \]) === [$messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) + +$MadelineProto->[messages->sendEncryptedFile](messages_sendEncryptedFile.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'message' => [DecryptedMessage](../types/DecryptedMessage.md), 'file' => [InputEncryptedFile](../types/InputEncryptedFile.md), \]) === [$messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) + +$MadelineProto->[messages->sendEncryptedService](messages_sendEncryptedService.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'message' => [DecryptedMessage](../types/DecryptedMessage.md), \]) === [$messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) + +$MadelineProto->[messages->sendInlineBotResult](messages_sendInlineBotResult.md)(\['silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'clear_draft' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), 'query_id' => [long](../types/long.md), 'id' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->sendMedia](messages_sendMedia.md)(\['silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'clear_draft' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), 'media' => [InputMedia](../types/InputMedia.md), 'message' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->sendMessage](messages_sendMessage.md)(\['no_webpage' => [Bool](../types/Bool.md), 'silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'clear_draft' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), 'message' => [string](../types/string.md), 'reply_markup' => [ReplyMarkup](../types/ReplyMarkup.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->sendMultiMedia](messages_sendMultiMedia.md)(\['silent' => [Bool](../types/Bool.md), 'background' => [Bool](../types/Bool.md), 'clear_draft' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), 'multi_media' => \[[InputSingleMedia](../types/InputSingleMedia.md)\], \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->sendScreenshotNotification](messages_sendScreenshotNotification.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'reply_to_msg_id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->setBotCallbackAnswer](messages_setBotCallbackAnswer.md)(\['alert' => [Bool](../types/Bool.md), 'query_id' => [long](../types/long.md), 'message' => [string](../types/string.md), 'url' => [string](../types/string.md), 'cache_time' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->setBotPrecheckoutResults](messages_setBotPrecheckoutResults.md)(\['success' => [Bool](../types/Bool.md), 'query_id' => [long](../types/long.md), 'error' => [string](../types/string.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->setBotShippingResults](messages_setBotShippingResults.md)(\['query_id' => [long](../types/long.md), 'error' => [string](../types/string.md), 'shipping_options' => \[[ShippingOption](../types/ShippingOption.md)\], \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->setEncryptedTyping](messages_setEncryptedTyping.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'typing' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->setGameScore](messages_setGameScore.md)(\['edit_message' => [Bool](../types/Bool.md), 'force' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), 'user_id' => [InputUser](../types/InputUser.md), 'score' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->setInlineBotResults](messages_setInlineBotResults.md)(\['gallery' => [Bool](../types/Bool.md), 'private' => [Bool](../types/Bool.md), 'query_id' => [long](../types/long.md), 'results' => \[[InputBotInlineResult](../types/InputBotInlineResult.md)\], 'cache_time' => [int](../types/int.md), 'next_offset' => [string](../types/string.md), 'switch_pm' => [InlineBotSwitchPM](../types/InlineBotSwitchPM.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->setInlineGameScore](messages_setInlineGameScore.md)(\['edit_message' => [Bool](../types/Bool.md), 'force' => [Bool](../types/Bool.md), 'id' => [InputBotInlineMessageID](../types/InputBotInlineMessageID.md), 'user_id' => [InputUser](../types/InputUser.md), 'score' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->setTyping](messages_setTyping.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'action' => [SendMessageAction](../types/SendMessageAction.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->startBot](messages_startBot.md)(\['bot' => [InputUser](../types/InputUser.md), 'peer' => [InputPeer](../types/InputPeer.md), 'start_param' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->toggleChatAdmins](messages_toggleChatAdmins.md)(\['chat_id' => [InputPeer](../types/InputPeer.md), 'enabled' => [Bool](../types/Bool.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[messages->toggleDialogPin](messages_toggleDialogPin.md)(\['pinned' => [Bool](../types/Bool.md), 'peer' => [InputDialogPeer](../types/InputDialogPeer.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->uninstallStickerSet](messages_uninstallStickerSet.md)(\['stickerset' => [InputStickerSet](../types/InputStickerSet.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[messages->uploadEncryptedFile](messages_uploadEncryptedFile.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'file' => [InputEncryptedFile](../types/InputEncryptedFile.md), \]) === [$EncryptedFile](../types/EncryptedFile.md) + +$MadelineProto->[messages->uploadMedia](messages_uploadMedia.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'media' => [InputMedia](../types/InputMedia.md), \]) === [$MessageMedia](../types/MessageMedia.md) + +*** +

+$MadelineProto->[payments->clearSavedInfo](payments_clearSavedInfo.md)(\['credentials' => [Bool](../types/Bool.md), 'info' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[payments->getPaymentForm](payments_getPaymentForm.md)(\['msg_id' => [int](../types/int.md), \]) === [$payments\_PaymentForm](../types/payments_PaymentForm.md) + +$MadelineProto->[payments->getPaymentReceipt](payments_getPaymentReceipt.md)(\['msg_id' => [int](../types/int.md), \]) === [$payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) + +$MadelineProto->[payments->getSavedInfo](payments_getSavedInfo.md)(\[\]) === [$payments\_SavedInfo](../types/payments_SavedInfo.md) + +$MadelineProto->[payments->sendPaymentForm](payments_sendPaymentForm.md)(\['msg_id' => [int](../types/int.md), 'requested_info_id' => [string](../types/string.md), 'shipping_option_id' => [string](../types/string.md), 'credentials' => [InputPaymentCredentials](../types/InputPaymentCredentials.md), \]) === [$payments\_PaymentResult](../types/payments_PaymentResult.md) + +$MadelineProto->[payments->validateRequestedInfo](payments_validateRequestedInfo.md)(\['save' => [Bool](../types/Bool.md), 'msg_id' => [int](../types/int.md), 'info' => [PaymentRequestedInfo](../types/PaymentRequestedInfo.md), \]) === [$payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) + +*** +

+$MadelineProto->[phone->acceptCall](phone_acceptCall.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'g_b' => [bytes](../types/bytes.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), \]) === [$phone\_PhoneCall](../types/phone_PhoneCall.md) + +$MadelineProto->[phone->confirmCall](phone_confirmCall.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'g_a' => [bytes](../types/bytes.md), 'key_fingerprint' => [long](../types/long.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), \]) === [$phone\_PhoneCall](../types/phone_PhoneCall.md) + +$MadelineProto->[phone->discardCall](phone_discardCall.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'duration' => [int](../types/int.md), 'reason' => [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md), 'connection_id' => [long](../types/long.md), \]) === [$Updates](../types/Updates.md) + +$MadelineProto->[phone->getCallConfig](phone_getCallConfig.md)(\[\]) === [$DataJSON](../types/DataJSON.md) + +$MadelineProto->[phone->receivedCall](phone_receivedCall.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[phone->requestCall](phone_requestCall.md)(\['user_id' => [InputUser](../types/InputUser.md), 'g_a_hash' => [bytes](../types/bytes.md), 'protocol' => [PhoneCallProtocol](../types/PhoneCallProtocol.md), \]) === [$phone\_PhoneCall](../types/phone_PhoneCall.md) + +$MadelineProto->[phone->saveCallDebug](phone_saveCallDebug.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'debug' => [DataJSON](../types/DataJSON.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[phone->setCallRating](phone_setCallRating.md)(\['peer' => [InputPhoneCall](../types/InputPhoneCall.md), 'rating' => [int](../types/int.md), 'comment' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[photos->deletePhotos](photos_deletePhotos.md)(\['id' => \[[InputPhoto](../types/InputPhoto.md)\], \]) === [$Vector\_of\_long](../types/long.md) + +$MadelineProto->[photos->getUserPhotos](photos_getUserPhotos.md)(\['user_id' => [InputUser](../types/InputUser.md), 'offset' => [int](../types/int.md), 'max_id' => [long](../types/long.md), 'limit' => [int](../types/int.md), \]) === [$photos\_Photos](../types/photos_Photos.md) + +$MadelineProto->[photos->updateProfilePhoto](photos_updateProfilePhoto.md)(\['id' => [InputPhoto](../types/InputPhoto.md), \]) === [$UserProfilePhoto](../types/UserProfilePhoto.md) + +$MadelineProto->[photos->uploadProfilePhoto](photos_uploadProfilePhoto.md)(\['file' => [InputFile](../types/InputFile.md), \]) === [$photos\_Photo](../types/photos_Photo.md) + +*** +

+$MadelineProto->[stickers->addStickerToSet](stickers_addStickerToSet.md)(\['stickerset' => [InputStickerSet](../types/InputStickerSet.md), 'sticker' => [InputStickerSetItem](../types/InputStickerSetItem.md), \]) === [$messages\_StickerSet](../types/messages_StickerSet.md) + +$MadelineProto->[stickers->changeStickerPosition](stickers_changeStickerPosition.md)(\['sticker' => [InputDocument](../types/InputDocument.md), 'position' => [int](../types/int.md), \]) === [$messages\_StickerSet](../types/messages_StickerSet.md) + +$MadelineProto->[stickers->createStickerSet](stickers_createStickerSet.md)(\['masks' => [Bool](../types/Bool.md), 'user_id' => [InputUser](../types/InputUser.md), 'title' => [string](../types/string.md), 'short_name' => [string](../types/string.md), 'stickers' => \[[InputStickerSetItem](../types/InputStickerSetItem.md)\], \]) === [$messages\_StickerSet](../types/messages_StickerSet.md) + +$MadelineProto->[stickers->removeStickerFromSet](stickers_removeStickerFromSet.md)(\['sticker' => [InputDocument](../types/InputDocument.md), \]) === [$messages\_StickerSet](../types/messages_StickerSet.md) + +*** +

+$MadelineProto->[updates->getChannelDifference](updates_getChannelDifference.md)(\['force' => [Bool](../types/Bool.md), 'channel' => [InputChannel](../types/InputChannel.md), 'filter' => [ChannelMessagesFilter](../types/ChannelMessagesFilter.md), 'pts' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$updates\_ChannelDifference](../types/updates_ChannelDifference.md) + +$MadelineProto->[updates->getDifference](updates_getDifference.md)(\['pts' => [int](../types/int.md), 'pts_total_limit' => [int](../types/int.md), 'date' => [int](../types/int.md), 'qts' => [int](../types/int.md), \]) === [$updates\_Difference](../types/updates_Difference.md) + +$MadelineProto->[updates->getState](updates_getState.md)(\[\]) === [$updates\_State](../types/updates_State.md) + +*** +

+$MadelineProto->[upload->getCdnFile](upload_getCdnFile.md)(\['file_token' => [bytes](../types/bytes.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$upload\_CdnFile](../types/upload_CdnFile.md) + +$MadelineProto->[upload->getCdnFileHashes](upload_getCdnFileHashes.md)(\['file_token' => [bytes](../types/bytes.md), 'offset' => [int](../types/int.md), \]) === [$Vector\_of\_FileHash](../types/FileHash.md) + +$MadelineProto->[upload->getFile](upload_getFile.md)(\['location' => [InputFileLocation](../types/InputFileLocation.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$upload\_File](../types/upload_File.md) + +$MadelineProto->[upload->getFileHashes](upload_getFileHashes.md)(\['location' => [InputFileLocation](../types/InputFileLocation.md), 'offset' => [int](../types/int.md), \]) === [$Vector\_of\_FileHash](../types/FileHash.md) + +$MadelineProto->[upload->getWebFile](upload_getWebFile.md)(\['location' => [InputWebFileLocation](../types/InputWebFileLocation.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$upload\_WebFile](../types/upload_WebFile.md) + +$MadelineProto->[upload->reuploadCdnFile](upload_reuploadCdnFile.md)(\['file_token' => [bytes](../types/bytes.md), 'request_token' => [bytes](../types/bytes.md), \]) === [$Vector\_of\_FileHash](../types/FileHash.md) + +$MadelineProto->[upload->saveBigFilePart](upload_saveBigFilePart.md)(\['file_id' => [long](../types/long.md), 'file_part' => [int](../types/int.md), 'file_total_parts' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]) === [$Bool](../types/Bool.md) + +$MadelineProto->[upload->saveFilePart](upload_saveFilePart.md)(\['file_id' => [long](../types/long.md), 'file_part' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[users->getFullUser](users_getFullUser.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$UserFull](../types/UserFull.md) + +$MadelineProto->[users->getUsers](users_getUsers.md)(\['id' => \[[InputUser](../types/InputUser.md)\], \]) === [$Vector\_of\_User](../types/User.md) + +$MadelineProto->[users->setSecureValueErrors](users_setSecureValueErrors.md)(\['id' => [InputUser](../types/InputUser.md), 'errors' => \[[SecureValueError](../types/SecureValueError.md)\], \]) === [$Bool](../types/Bool.md) + diff --git a/old_docs/API_docs_v81/methods/auth_bindTempAuthKey.md b/old_docs/API_docs_v81/methods/auth_bindTempAuthKey.md new file mode 100644 index 00000000..4fd80e0f --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_bindTempAuthKey.md @@ -0,0 +1,14 @@ +--- +title: auth.bindTempAuthKey +description: You cannot use this method directly, instead modify the PFS and default_temp_auth_key_expires_in settings, see https://docs.madelineproto.xyz/docs/SETTINGS.html for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.bindTempAuthKey +[Back to methods index](index.md) + + +**You cannot use this method directly, instead modify the PFS and default_temp_auth_key_expires_in settings, see https://docs.madelineproto.xyz/docs/SETTINGS.html for more info** + + + + diff --git a/old_docs/API_docs_v81/methods/auth_cancelCode.md b/old_docs/API_docs_v81/methods/auth_cancelCode.md new file mode 100644 index 00000000..4657ed9c --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_cancelCode.md @@ -0,0 +1,69 @@ +--- +title: auth.cancelCode +description: Invalidate sent phone code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.cancelCode +[Back to methods index](index.md) + + +Invalidate sent phone code + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->auth->cancelCode(['phone_number' => 'string', 'phone_code_hash' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.cancelCode` + +Parameters: + +phone_number - Json encoded string + +phone_code_hash - Json encoded string + + + + +Or, if you're into Lua: + +``` +Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v81/methods/auth_checkPassword.md b/old_docs/API_docs_v81/methods/auth_checkPassword.md new file mode 100644 index 00000000..8d76c483 --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_checkPassword.md @@ -0,0 +1,14 @@ +--- +title: auth.checkPassword +description: You cannot use this method directly, use the complete_2fa_login method instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.checkPassword +[Back to methods index](index.md) + + +**You cannot use this method directly, use the complete_2fa_login method instead (see https://docs.madelineproto.xyz for more info)** + + + + diff --git a/old_docs/API_docs_v81/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v81/methods/auth_dropTempAuthKeys.md new file mode 100644 index 00000000..27d9f71e --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_dropTempAuthKeys.md @@ -0,0 +1,68 @@ +--- +title: auth.dropTempAuthKeys +description: Delete all temporary authorization keys except the ones provided +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.dropTempAuthKeys +[Back to methods index](index.md) + + +Delete all temporary authorization keys except the ones provided + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|except\_auth\_keys|Array of [long](../types/long.md) | Yes|The temporary authorization keys to keep| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->auth->dropTempAuthKeys(['except_auth_keys' => [long, long], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - auth.dropTempAuthKeys +* params - `{"except_auth_keys": [long], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.dropTempAuthKeys` + +Parameters: + +except_auth_keys - Json encoded array of long + + + + +Or, if you're into Lua: + +``` +Bool = auth.dropTempAuthKeys({except_auth_keys={long}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/auth_exportAuthorization.md b/old_docs/API_docs_v81/methods/auth_exportAuthorization.md new file mode 100644 index 00000000..a83216ad --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_exportAuthorization.md @@ -0,0 +1,14 @@ +--- +title: auth.exportAuthorization +description: You cannot use this method directly, use $MadelineProto->export_authorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.exportAuthorization +[Back to methods index](index.md) + + +**You cannot use this method directly, use $MadelineProto->export_authorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html** + + + + diff --git a/old_docs/API_docs_v81/methods/auth_importAuthorization.md b/old_docs/API_docs_v81/methods/auth_importAuthorization.md new file mode 100644 index 00000000..ebd53001 --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_importAuthorization.md @@ -0,0 +1,14 @@ +--- +title: auth.importAuthorization +description: You cannot use this method directly, use $MadelineProto->import_authorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.importAuthorization +[Back to methods index](index.md) + + +**You cannot use this method directly, use $MadelineProto->import_authorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html** + + + + diff --git a/old_docs/API_docs_v81/methods/auth_importBotAuthorization.md b/old_docs/API_docs_v81/methods/auth_importBotAuthorization.md new file mode 100644 index 00000000..1a98c1b9 --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_importBotAuthorization.md @@ -0,0 +1,14 @@ +--- +title: auth.importBotAuthorization +description: You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.importBotAuthorization +[Back to methods index](index.md) + + +**You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info)** + + + + diff --git a/old_docs/API_docs_v81/methods/auth_logOut.md b/old_docs/API_docs_v81/methods/auth_logOut.md new file mode 100644 index 00000000..a7126ea2 --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_logOut.md @@ -0,0 +1,14 @@ +--- +title: auth.logOut +description: You cannot use this method directly, use the logout method instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.logOut +[Back to methods index](index.md) + + +**You cannot use this method directly, use the logout method instead (see https://docs.madelineproto.xyz for more info)** + + + + diff --git a/old_docs/API_docs_v81/methods/auth_recoverPassword.md b/old_docs/API_docs_v81/methods/auth_recoverPassword.md new file mode 100644 index 00000000..1b46477a --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_recoverPassword.md @@ -0,0 +1,66 @@ +--- +title: auth.recoverPassword +description: Use the code that was emailed to you after running $MadelineProto->auth->requestPasswordRecovery to login to your account +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.recoverPassword +[Back to methods index](index.md) + + +Use the code that was emailed to you after running $MadelineProto->auth->requestPasswordRecovery to login to your account + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|code|[string](../types/string.md) | Yes|The code that was emailed to you| + + +### Return type: [auth\_Authorization](../types/auth_Authorization.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$auth_Authorization = $MadelineProto->auth->recoverPassword(['code' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.recoverPassword` + +Parameters: + +code - Json encoded string + + + + +Or, if you're into Lua: + +``` +auth_Authorization = auth.recoverPassword({code='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v81/methods/auth_requestPasswordRecovery.md b/old_docs/API_docs_v81/methods/auth_requestPasswordRecovery.md new file mode 100644 index 00000000..214d5cdf --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_requestPasswordRecovery.md @@ -0,0 +1,59 @@ +--- +title: auth.requestPasswordRecovery +description: Send an email to recover the 2FA password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.requestPasswordRecovery +[Back to methods index](index.md) + + +Send an email to recover the 2FA password + + + +### Return type: [auth\_PasswordRecovery](../types/auth_PasswordRecovery.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$auth_PasswordRecovery = $MadelineProto->auth->requestPasswordRecovery(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.requestPasswordRecovery` + +Parameters: + + + + +Or, if you're into Lua: + +``` +auth_PasswordRecovery = auth.requestPasswordRecovery({}) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v81/methods/auth_resendCode.md b/old_docs/API_docs_v81/methods/auth_resendCode.md new file mode 100644 index 00000000..e433903c --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_resendCode.md @@ -0,0 +1,69 @@ +--- +title: auth.resendCode +description: Resend the SMS verification code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.resendCode +[Back to methods index](index.md) + + +Resend the SMS verification code + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_number|[string](../types/string.md) | Yes|The phone number| +|phone\_code\_hash|[string](../types/string.md) | Yes|The phone code hash| + + +### Return type: [auth\_SentCode](../types/auth_SentCode.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$auth_SentCode = $MadelineProto->auth->resendCode(['phone_number' => 'string', 'phone_code_hash' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.resendCode` + +Parameters: + +phone_number - Json encoded string + +phone_code_hash - Json encoded string + + + + +Or, if you're into Lua: + +``` +auth_SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v81/methods/auth_resetAuthorizations.md b/old_docs/API_docs_v81/methods/auth_resetAuthorizations.md new file mode 100644 index 00000000..7cdf12b7 --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_resetAuthorizations.md @@ -0,0 +1,59 @@ +--- +title: auth.resetAuthorizations +description: Delete all logged-in sessions. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.resetAuthorizations +[Back to methods index](index.md) + + +Delete all logged-in sessions. + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->auth->resetAuthorizations(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.resetAuthorizations` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Bool = auth.resetAuthorizations({}) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/auth_sendCode.md b/old_docs/API_docs_v81/methods/auth_sendCode.md new file mode 100644 index 00000000..9afebb55 --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_sendCode.md @@ -0,0 +1,14 @@ +--- +title: auth.sendCode +description: Use phone_login instead +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.sendCode +[Back to methods index](index.md) + + +**You cannot use this method directly, use the phone_login method instead (see https://docs.madelineproto.xyz for more info)** + + + + diff --git a/old_docs/API_docs_v81/methods/auth_signIn.md b/old_docs/API_docs_v81/methods/auth_signIn.md new file mode 100644 index 00000000..156b7fb5 --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_signIn.md @@ -0,0 +1,14 @@ +--- +title: auth.signIn +description: You cannot use this method directly, use the complete_phone_login method instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.signIn +[Back to methods index](index.md) + + +**You cannot use this method directly, use the complete_phone_login method instead (see https://docs.madelineproto.xyz for more info)** + + + + diff --git a/old_docs/API_docs_v81/methods/auth_signUp.md b/old_docs/API_docs_v81/methods/auth_signUp.md new file mode 100644 index 00000000..15960145 --- /dev/null +++ b/old_docs/API_docs_v81/methods/auth_signUp.md @@ -0,0 +1,14 @@ +--- +title: auth.signUp +description: You cannot use this method directly, use the complete_signup method instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: auth.signUp +[Back to methods index](index.md) + + +**You cannot use this method directly, use the complete_signup method instead (see https://docs.madelineproto.xyz for more info)** + + + + diff --git a/old_docs/API_docs_v81/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v81/methods/bots_answerWebhookJSONQuery.md new file mode 100644 index 00000000..7f68abb3 --- /dev/null +++ b/old_docs/API_docs_v81/methods/bots_answerWebhookJSONQuery.md @@ -0,0 +1,79 @@ +--- +title: bots.answerWebhookJSONQuery +description: Send webhook request via bot API +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: bots.answerWebhookJSONQuery +[Back to methods index](index.md) + + +Send webhook request via bot API + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|data|[DataJSON](../types/DataJSON.md) | Yes|The parameters| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->bots->answerWebhookJSONQuery(['query_id' => long, 'data' => DataJSON, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - bots.answerWebhookJSONQuery +* params - `{"query_id": long, "data": DataJSON, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/bots.answerWebhookJSONQuery` + +Parameters: + +query_id - Json encoded long + +data - Json encoded DataJSON + + + + +Or, if you're into Lua: + +``` +Bool = bots.answerWebhookJSONQuery({query_id=long, data=DataJSON, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v81/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v81/methods/bots_sendCustomRequest.md new file mode 100644 index 00000000..c6c5fbfd --- /dev/null +++ b/old_docs/API_docs_v81/methods/bots_sendCustomRequest.md @@ -0,0 +1,78 @@ +--- +title: bots.sendCustomRequest +description: Send a custom request to the bot API +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: bots.sendCustomRequest +[Back to methods index](index.md) + + +Send a custom request to the bot API + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|custom\_method|[string](../types/string.md) | Yes|The method to call| +|params|[DataJSON](../types/DataJSON.md) | Yes|Method parameters| + + +### Return type: [DataJSON](../types/DataJSON.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$DataJSON = $MadelineProto->bots->sendCustomRequest(['custom_method' => 'string', 'params' => DataJSON, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - bots.sendCustomRequest +* params - `{"custom_method": "string", "params": DataJSON, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/bots.sendCustomRequest` + +Parameters: + +custom_method - Json encoded string + +params - Json encoded DataJSON + + + + +Or, if you're into Lua: + +``` +DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v81/methods/channels_checkUsername.md b/old_docs/API_docs_v81/methods/channels_checkUsername.md new file mode 100644 index 00000000..aaca17ac --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_checkUsername.md @@ -0,0 +1,71 @@ +--- +title: channels.checkUsername +description: Check if this username is free and can be assigned to a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.checkUsername +[Back to methods index](index.md) + + +Check if this username is free and can be assigned to a channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username for this channel/supergroup| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->channels->checkUsername(['channel' => InputChannel, 'username' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.checkUsername` + +Parameters: + +channel - Json encoded InputChannel + +username - Json encoded string + + + + +Or, if you're into Lua: + +``` +Bool = channels.checkUsername({channel=InputChannel, username='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ID_INVALID|The provided chat id is invalid| +|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v81/methods/channels_createChannel.md b/old_docs/API_docs_v81/methods/channels_createChannel.md new file mode 100644 index 00000000..2d6912ab --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_createChannel.md @@ -0,0 +1,76 @@ +--- +title: channels.createChannel +description: Create channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.createChannel +[Back to methods index](index.md) + + +Create channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[string](../types/string.md) | Yes|Supergroup/channel title| +|about|[string](../types/string.md) | Yes|About text| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->createChannel(['broadcast' => Bool, 'megagroup' => Bool, 'title' => 'string', 'about' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.createChannel` + +Parameters: + +broadcast - Json encoded Bool + +megagroup - Json encoded Bool + +title - Json encoded string + +about - Json encoded string + + + + +Or, if you're into Lua: + +``` +Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_TITLE_EMPTY|No chat title provided| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v81/methods/channels_deleteChannel.md b/old_docs/API_docs_v81/methods/channels_deleteChannel.md new file mode 100644 index 00000000..13c5309b --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_deleteChannel.md @@ -0,0 +1,67 @@ +--- +title: channels.deleteChannel +description: Delete a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.deleteChannel +[Back to methods index](index.md) + + +Delete a channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->deleteChannel(['channel' => InputChannel, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.deleteChannel` + +Parameters: + +channel - Json encoded InputChannel + + + + +Or, if you're into Lua: + +``` +Updates = channels.deleteChannel({channel=InputChannel, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v81/methods/channels_deleteHistory.md b/old_docs/API_docs_v81/methods/channels_deleteHistory.md new file mode 100644 index 00000000..d33bdbe0 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_deleteHistory.md @@ -0,0 +1,71 @@ +--- +title: channels.deleteHistory +description: Delete the history of a supergroup/channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.deleteHistory +[Back to methods index](index.md) + + +Delete the history of a supergroup/channel + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to delete| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->channels->deleteHistory(['channel' => InputChannel, 'max_id' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.deleteHistory +* params - `{"channel": InputChannel, "max_id": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.deleteHistory` + +Parameters: + +channel - Json encoded InputChannel + +max_id - Json encoded int + + + + +Or, if you're into Lua: + +``` +Bool = channels.deleteHistory({channel=InputChannel, max_id=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/channels_deleteMessages.md b/old_docs/API_docs_v81/methods/channels_deleteMessages.md new file mode 100644 index 00000000..d21abe4f --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_deleteMessages.md @@ -0,0 +1,80 @@ +--- +title: channels.deleteMessages +description: Delete channel/supergroup messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.deleteMessages +[Back to methods index](index.md) + + +Delete channel/supergroup messages + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| + + +### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_AffectedMessages = $MadelineProto->channels->deleteMessages(['channel' => InputChannel, 'id' => [int, int], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.deleteMessages +* params - `{"channel": InputChannel, "id": [int], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.deleteMessages` + +Parameters: + +channel - Json encoded InputChannel + +id - Json encoded array of int + + + + +Or, if you're into Lua: + +``` +messages_AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v81/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v81/methods/channels_deleteUserHistory.md new file mode 100644 index 00000000..a499769c --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_deleteUserHistory.md @@ -0,0 +1,70 @@ +--- +title: channels.deleteUserHistory +description: Delete all messages of a user in a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.deleteUserHistory +[Back to methods index](index.md) + + +Delete all messages of a user in a channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| + + +### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_AffectedHistory = $MadelineProto->channels->deleteUserHistory(['channel' => InputChannel, 'user_id' => InputUser, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.deleteUserHistory` + +Parameters: + +channel - Json encoded InputChannel + +user_id - Json encoded InputUser + + + + +Or, if you're into Lua: + +``` +messages_AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v81/methods/channels_editAbout.md b/old_docs/API_docs_v81/methods/channels_editAbout.md new file mode 100644 index 00000000..d4068411 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_editAbout.md @@ -0,0 +1,81 @@ +--- +title: channels.editAbout +description: Edit the about text of a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.editAbout +[Back to methods index](index.md) + + +Edit the about text of a channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[string](../types/string.md) | Yes|The new about text| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->channels->editAbout(['channel' => InputChannel, 'about' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.editAbout +* params - `{"channel": InputChannel, "about": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.editAbout` + +Parameters: + +channel - Json encoded InputChannel + +about - Json encoded string + + + + +Or, if you're into Lua: + +``` +Bool = channels.editAbout({channel=InputChannel, about='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|CHAT_ABOUT_TOO_LONG|Chat about too long| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v81/methods/channels_editAdmin.md b/old_docs/API_docs_v81/methods/channels_editAdmin.md new file mode 100644 index 00000000..6a767f36 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_editAdmin.md @@ -0,0 +1,90 @@ +--- +title: channels.editAdmin +description: Edit admin permissions of a user in a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.editAdmin +[Back to methods index](index.md) + + +Edit admin permissions of a user in a channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|admin\_rights|[ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->editAdmin(['channel' => InputChannel, 'user_id' => InputUser, 'admin_rights' => ChannelAdminRights, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.editAdmin +* params - `{"channel": InputChannel, "user_id": InputUser, "admin_rights": ChannelAdminRights, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.editAdmin` + +Parameters: + +channel - Json encoded InputChannel + +user_id - Json encoded InputUser + +admin_rights - Json encoded ChannelAdminRights + + + + +Or, if you're into Lua: + +``` +Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, admin_rights=ChannelAdminRights, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ADMINS_TOO_MUCH|Too many admins| +|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v81/methods/channels_editBanned.md b/old_docs/API_docs_v81/methods/channels_editBanned.md new file mode 100644 index 00000000..fe7d026c --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_editBanned.md @@ -0,0 +1,85 @@ +--- +title: channels.editBanned +description: Kick or ban a user from a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.editBanned +[Back to methods index](index.md) + + +Kick or ban a user from a channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| +|banned\_rights|[ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->editBanned(['channel' => InputChannel, 'user_id' => InputUser, 'banned_rights' => ChannelBannedRights, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.editBanned +* params - `{"channel": InputChannel, "user_id": InputUser, "banned_rights": ChannelBannedRights, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.editBanned` + +Parameters: + +channel - Json encoded InputChannel + +user_id - Json encoded InputUser + +banned_rights - Json encoded ChannelBannedRights + + + + +Or, if you're into Lua: + +``` +Updates = channels.editBanned({channel=InputChannel, user_id=InputUser, banned_rights=ChannelBannedRights, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ADMIN_INVALID|You're not an admin| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/channels_editPhoto.md b/old_docs/API_docs_v81/methods/channels_editPhoto.md new file mode 100644 index 00000000..fa88f9ef --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_editPhoto.md @@ -0,0 +1,80 @@ +--- +title: channels.editPhoto +description: Edit the photo of a supergroup/channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.editPhoto +[Back to methods index](index.md) + + +Edit the photo of a supergroup/channel + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->editPhoto(['channel' => InputChannel, 'photo' => InputChatPhoto, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.editPhoto +* params - `{"channel": InputChannel, "photo": InputChatPhoto, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.editPhoto` + +Parameters: + +channel - Json encoded InputChannel + +photo - Json encoded InputChatPhoto + + + + +Or, if you're into Lua: + +``` +Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|PHOTO_INVALID|Photo invalid| + + diff --git a/old_docs/API_docs_v81/methods/channels_editTitle.md b/old_docs/API_docs_v81/methods/channels_editTitle.md new file mode 100644 index 00000000..518fc158 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_editTitle.md @@ -0,0 +1,80 @@ +--- +title: channels.editTitle +description: Edit the title of a supergroup/channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.editTitle +[Back to methods index](index.md) + + +Edit the title of a supergroup/channel + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[string](../types/string.md) | Yes|The new channel/supergroup title| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->editTitle(['channel' => InputChannel, 'title' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.editTitle +* params - `{"channel": InputChannel, "title": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.editTitle` + +Parameters: + +channel - Json encoded InputChannel + +title - Json encoded string + + + + +Or, if you're into Lua: + +``` +Updates = channels.editTitle({channel=InputChannel, title='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v81/methods/channels_exportInvite.md b/old_docs/API_docs_v81/methods/channels_exportInvite.md new file mode 100644 index 00000000..aa6e54e0 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_exportInvite.md @@ -0,0 +1,77 @@ +--- +title: channels.exportInvite +description: Export the invite link of a channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.exportInvite +[Back to methods index](index.md) + + +Export the invite link of a channel + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| + + +### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$ExportedChatInvite = $MadelineProto->channels->exportInvite(['channel' => InputChannel, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.exportInvite +* params - `{"channel": InputChannel, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.exportInvite` + +Parameters: + +channel - Json encoded InputChannel + + + + +Or, if you're into Lua: + +``` +ExportedChatInvite = channels.exportInvite({channel=InputChannel, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INVITE_HASH_EXPIRED|The invite link has expired| + + diff --git a/old_docs/API_docs_v81/methods/channels_exportMessageLink.md b/old_docs/API_docs_v81/methods/channels_exportMessageLink.md new file mode 100644 index 00000000..595e4b70 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_exportMessageLink.md @@ -0,0 +1,72 @@ +--- +title: channels.exportMessageLink +description: Get the link of a message in a channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.exportMessageLink +[Back to methods index](index.md) + + +Get the link of a message in a channel + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[int](../types/int.md) | Yes|The ID of the message| +|grouped|[Bool](../types/Bool.md) | Yes|Is this an album?| + + +### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$ExportedMessageLink = $MadelineProto->channels->exportMessageLink(['channel' => InputChannel, 'id' => int, 'grouped' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.exportMessageLink` + +Parameters: + +channel - Json encoded InputChannel + +id - Json encoded int + +grouped - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, grouped=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v81/methods/channels_getAdminLog.md b/old_docs/API_docs_v81/methods/channels_getAdminLog.md new file mode 100644 index 00000000..f78919bb --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_getAdminLog.md @@ -0,0 +1,86 @@ +--- +title: channels.getAdminLog +description: Get admin log of a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.getAdminLog +[Back to methods index](index.md) + + +Get admin log of a channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|q|[string](../types/string.md) | Yes|Search query| +|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| +|max\_id|[long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| + + +### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$channels_AdminLogResults = $MadelineProto->channels->getAdminLog(['channel' => InputChannel, 'q' => 'string', 'events_filter' => ChannelAdminLogEventsFilter, 'admins' => [InputUser, InputUser], 'max_id' => long, 'min_id' => long, 'limit' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.getAdminLog` + +Parameters: + +channel - Json encoded InputChannel + +q - Json encoded string + +events_filter - Json encoded ChannelAdminLogEventsFilter + +admins - Json encoded array of InputUser + +max_id - Json encoded long + +min_id - Json encoded long + +limit - Json encoded int + + + + +Or, if you're into Lua: + +``` +channels_AdminLogResults = channels.getAdminLog({channel=InputChannel, q='string', events_filter=ChannelAdminLogEventsFilter, admins={InputUser}, max_id=long, min_id=long, limit=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v81/methods/channels_getAdminedPublicChannels.md b/old_docs/API_docs_v81/methods/channels_getAdminedPublicChannels.md new file mode 100644 index 00000000..67ee8bd4 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_getAdminedPublicChannels.md @@ -0,0 +1,52 @@ +--- +title: channels.getAdminedPublicChannels +description: Get all supergroups/channels where you're admin +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.getAdminedPublicChannels +[Back to methods index](index.md) + + +Get all supergroups/channels where you're admin + + + +### Return type: [messages\_Chats](../types/messages_Chats.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Chats = $MadelineProto->channels->getAdminedPublicChannels(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.getAdminedPublicChannels` + +Parameters: + + + + +Or, if you're into Lua: + +``` +messages_Chats = channels.getAdminedPublicChannels({}) +``` + diff --git a/old_docs/API_docs_v81/methods/channels_getChannels.md b/old_docs/API_docs_v81/methods/channels_getChannels.md new file mode 100644 index 00000000..990e6071 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_getChannels.md @@ -0,0 +1,77 @@ +--- +title: channels.getChannels +description: Get info about multiple channels/supergroups +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.getChannels +[Back to methods index](index.md) + + +Get info about multiple channels/supergroups + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| + + +### Return type: [messages\_Chats](../types/messages_Chats.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Chats = $MadelineProto->channels->getChannels(['id' => [InputChannel, InputChannel], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.getChannels +* params - `{"id": [InputChannel], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.getChannels` + +Parameters: + +id - Json encoded array of InputChannel + + + + +Or, if you're into Lua: + +``` +messages_Chats = channels.getChannels({id={InputChannel}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v81/methods/channels_getFullChannel.md b/old_docs/API_docs_v81/methods/channels_getFullChannel.md new file mode 100644 index 00000000..45a8ec72 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_getFullChannel.md @@ -0,0 +1,14 @@ +--- +title: channels.getFullChannel +description: You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.getFullChannel +[Back to methods index](index.md) + + +**You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)** + + + + diff --git a/old_docs/API_docs_v81/methods/channels_getLeftChannels.md b/old_docs/API_docs_v81/methods/channels_getLeftChannels.md new file mode 100644 index 00000000..b51c86d9 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_getLeftChannels.md @@ -0,0 +1,68 @@ +--- +title: channels.getLeftChannels +description: Get all channels you left +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.getLeftChannels +[Back to methods index](index.md) + + +Get all channels you left + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset| + + +### Return type: [messages\_Chats](../types/messages_Chats.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Chats = $MadelineProto->channels->getLeftChannels(['offset' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.getLeftChannels +* params - `{"offset": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.getLeftChannels` + +Parameters: + +offset - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_Chats = channels.getLeftChannels({offset=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/channels_getMessages.md b/old_docs/API_docs_v81/methods/channels_getMessages.md new file mode 100644 index 00000000..2c2d822a --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_getMessages.md @@ -0,0 +1,80 @@ +--- +title: channels.getMessages +description: Get channel/supergroup messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.getMessages +[Back to methods index](index.md) + + +Get channel/supergroup messages + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes|The message IDs| + + +### Return type: [messages\_Messages](../types/messages_Messages.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Messages = $MadelineProto->channels->getMessages(['channel' => InputChannel, 'id' => [InputMessage, InputMessage], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.getMessages +* params - `{"channel": InputChannel, "id": [InputMessage], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.getMessages` + +Parameters: + +channel - Json encoded InputChannel + +id - Json encoded array of InputMessage + + + + +Or, if you're into Lua: + +``` +messages_Messages = channels.getMessages({channel=InputChannel, id={InputMessage}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|MESSAGE_IDS_EMPTY|No message ids were provided| + + diff --git a/old_docs/API_docs_v81/methods/channels_getParticipant.md b/old_docs/API_docs_v81/methods/channels_getParticipant.md new file mode 100644 index 00000000..4163e345 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_getParticipant.md @@ -0,0 +1,82 @@ +--- +title: channels.getParticipant +description: Get info about a certain channel/supergroup participant +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.getParticipant +[Back to methods index](index.md) + + +Get info about a certain channel/supergroup participant + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| + + +### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$channels_ChannelParticipant = $MadelineProto->channels->getParticipant(['channel' => InputChannel, 'user_id' => InputUser, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.getParticipant +* params - `{"channel": InputChannel, "user_id": InputUser, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.getParticipant` + +Parameters: + +channel - Json encoded InputChannel + +user_id - Json encoded InputUser + + + + +Or, if you're into Lua: + +``` +channels_ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v81/methods/channels_getParticipants.md b/old_docs/API_docs_v81/methods/channels_getParticipants.md new file mode 100644 index 00000000..00446bf1 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_getParticipants.md @@ -0,0 +1,91 @@ +--- +title: channels.getParticipants +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.getParticipants +[Back to methods index](index.md) + + +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[int](../types/int.md) | Yes|Offset| +|limit|[int](../types/int.md) | Yes|Limit| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)| + + +### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$channels_ChannelParticipants = $MadelineProto->channels->getParticipants(['channel' => InputChannel, 'filter' => ChannelParticipantsFilter, 'offset' => int, 'limit' => int, 'hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.getParticipants +* params - `{"channel": InputChannel, "filter": ChannelParticipantsFilter, "offset": int, "limit": int, "hash": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.getParticipants` + +Parameters: + +channel - Json encoded InputChannel + +filter - Json encoded ChannelParticipantsFilter + +offset - Json encoded int + +limit - Json encoded int + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +channels_ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, hash=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/channels_inviteToChannel.md b/old_docs/API_docs_v81/methods/channels_inviteToChannel.md new file mode 100644 index 00000000..e42f9554 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_inviteToChannel.md @@ -0,0 +1,84 @@ +--- +title: channels.inviteToChannel +description: Add users to channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.inviteToChannel +[Back to methods index](index.md) + + +Add users to channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->inviteToChannel(['channel' => InputChannel, 'users' => [InputUser, InputUser], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.inviteToChannel` + +Parameters: + +channel - Json encoded InputChannel + +users - Json encoded array of InputUser + + + + +Or, if you're into Lua: + +``` +Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_BLOCKED|User blocked| +|USER_BOT|Bots can only be admins in channels.| +|USER_ID_INVALID|The provided user ID is invalid| +|USER_KICKED|This user was kicked from this supergroup/channel| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v81/methods/channels_joinChannel.md b/old_docs/API_docs_v81/methods/channels_joinChannel.md new file mode 100644 index 00000000..2d6a208b --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_joinChannel.md @@ -0,0 +1,68 @@ +--- +title: channels.joinChannel +description: Join a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.joinChannel +[Back to methods index](index.md) + + +Join a channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->joinChannel(['channel' => InputChannel, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.joinChannel` + +Parameters: + +channel - Json encoded InputChannel + + + + +Or, if you're into Lua: + +``` +Updates = channels.joinChannel({channel=InputChannel, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| + + diff --git a/old_docs/API_docs_v81/methods/channels_leaveChannel.md b/old_docs/API_docs_v81/methods/channels_leaveChannel.md new file mode 100644 index 00000000..0ceb07f1 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_leaveChannel.md @@ -0,0 +1,79 @@ +--- +title: channels.leaveChannel +description: Leave a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.leaveChannel +[Back to methods index](index.md) + + +Leave a channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->leaveChannel(['channel' => InputChannel, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.leaveChannel +* params - `{"channel": InputChannel, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.leaveChannel` + +Parameters: + +channel - Json encoded InputChannel + + + + +Or, if you're into Lua: + +``` +Updates = channels.leaveChannel({channel=InputChannel, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|USER_CREATOR|You can't leave this channel, because you're its creator| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v81/methods/channels_readHistory.md b/old_docs/API_docs_v81/methods/channels_readHistory.md new file mode 100644 index 00000000..c0836633 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_readHistory.md @@ -0,0 +1,70 @@ +--- +title: channels.readHistory +description: Mark channel/supergroup history as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.readHistory +[Back to methods index](index.md) + + +Mark channel/supergroup history as read + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->channels->readHistory(['channel' => InputChannel, 'max_id' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.readHistory` + +Parameters: + +channel - Json encoded InputChannel + +max_id - Json encoded int + + + + +Or, if you're into Lua: + +``` +Bool = channels.readHistory({channel=InputChannel, max_id=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v81/methods/channels_readMessageContents.md b/old_docs/API_docs_v81/methods/channels_readMessageContents.md new file mode 100644 index 00000000..f0addc30 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_readMessageContents.md @@ -0,0 +1,70 @@ +--- +title: channels.readMessageContents +description: Mark channel/supergroup messages as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.readMessageContents +[Back to methods index](index.md) + + +Mark channel/supergroup messages as read + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|id|Array of [int](../types/int.md) | Yes|List of message IDs| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->channels->readMessageContents(['channel' => InputChannel, 'id' => [int, int], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.readMessageContents` + +Parameters: + +channel - Json encoded InputChannel + +id - Json encoded array of int + + + + +Or, if you're into Lua: + +``` +Bool = channels.readMessageContents({channel=InputChannel, id={int}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v81/methods/channels_reportSpam.md b/old_docs/API_docs_v81/methods/channels_reportSpam.md new file mode 100644 index 00000000..c9991738 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_reportSpam.md @@ -0,0 +1,73 @@ +--- +title: channels.reportSpam +description: Report a message in a supergroup/channel for spam +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.reportSpam +[Back to methods index](index.md) + + +Report a message in a supergroup/channel for spam + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that sent the messages| +|id|Array of [int](../types/int.md) | Yes|The IDs of messages to report| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->channels->reportSpam(['channel' => InputChannel, 'user_id' => InputUser, 'id' => [int, int], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.reportSpam` + +Parameters: + +channel - Json encoded InputChannel + +user_id - Json encoded InputUser + +id - Json encoded array of int + + + + +Or, if you're into Lua: + +``` +Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v81/methods/channels_setStickers.md b/old_docs/API_docs_v81/methods/channels_setStickers.md new file mode 100644 index 00000000..8557a723 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_setStickers.md @@ -0,0 +1,79 @@ +--- +title: channels.setStickers +description: Set the supergroup/channel stickerpack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.setStickers +[Back to methods index](index.md) + + +Set the supergroup/channel stickerpack + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergoup| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->channels->setStickers(['channel' => InputChannel, 'stickerset' => InputStickerSet, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.setStickers +* params - `{"channel": InputChannel, "stickerset": InputStickerSet, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.setStickers` + +Parameters: + +channel - Json encoded InputChannel + +stickerset - Json encoded InputStickerSet + + + + +Or, if you're into Lua: + +``` +Bool = channels.setStickers({channel=InputChannel, stickerset=InputStickerSet, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PARTICIPANTS_TOO_FEW|Not enough participants| + + diff --git a/old_docs/API_docs_v81/methods/channels_toggleInvites.md b/old_docs/API_docs_v81/methods/channels_toggleInvites.md new file mode 100644 index 00000000..6dd85f57 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_toggleInvites.md @@ -0,0 +1,71 @@ +--- +title: channels.toggleInvites +description: Allow or disallow any user to invite users to this channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.toggleInvites +[Back to methods index](index.md) + + +Allow or disallow any user to invite users to this channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[Bool](../types/Bool.md) | Yes|Allow or disallow| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->toggleInvites(['channel' => InputChannel, 'enabled' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.toggleInvites` + +Parameters: + +channel - Json encoded InputChannel + +enabled - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Updates = channels.toggleInvites({channel=InputChannel, enabled=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v81/methods/channels_togglePreHistoryHidden.md b/old_docs/API_docs_v81/methods/channels_togglePreHistoryHidden.md new file mode 100644 index 00000000..cc48c100 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_togglePreHistoryHidden.md @@ -0,0 +1,71 @@ +--- +title: channels.togglePreHistoryHidden +description: Enable or disable hidden history for new channel/supergroup users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.togglePreHistoryHidden +[Back to methods index](index.md) + + +Enable or disable hidden history for new channel/supergroup users + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->togglePreHistoryHidden(['channel' => InputChannel, 'enabled' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.togglePreHistoryHidden +* params - `{"channel": InputChannel, "enabled": Bool, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.togglePreHistoryHidden` + +Parameters: + +channel - Json encoded InputChannel + +enabled - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Updates = channels.togglePreHistoryHidden({channel=InputChannel, enabled=Bool, }) +``` + diff --git a/old_docs/API_docs_v81/methods/channels_toggleSignatures.md b/old_docs/API_docs_v81/methods/channels_toggleSignatures.md new file mode 100644 index 00000000..55847101 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_toggleSignatures.md @@ -0,0 +1,69 @@ +--- +title: channels.toggleSignatures +description: Toggle channel signatures +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.toggleSignatures +[Back to methods index](index.md) + + +Toggle channel signatures + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->toggleSignatures(['channel' => InputChannel, 'enabled' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.toggleSignatures` + +Parameters: + +channel - Json encoded InputChannel + +enabled - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v81/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v81/methods/channels_updatePinnedMessage.md new file mode 100644 index 00000000..7ea94b5b --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_updatePinnedMessage.md @@ -0,0 +1,84 @@ +--- +title: channels.updatePinnedMessage +description: Set the pinned message of a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.updatePinnedMessage +[Back to methods index](index.md) + + +Set the pinned message of a channel/supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[int](../types/int.md) | Yes|The ID of the message to pin| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->channels->updatePinnedMessage(['silent' => Bool, 'channel' => InputChannel, 'id' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - channels.updatePinnedMessage +* params - `{"silent": Bool, "channel": InputChannel, "id": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.updatePinnedMessage` + +Parameters: + +silent - Json encoded Bool + +channel - Json encoded InputChannel + +id - Json encoded int + + + + +Or, if you're into Lua: + +``` +Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v81/methods/channels_updateUsername.md b/old_docs/API_docs_v81/methods/channels_updateUsername.md new file mode 100644 index 00000000..8bd0b5b8 --- /dev/null +++ b/old_docs/API_docs_v81/methods/channels_updateUsername.md @@ -0,0 +1,73 @@ +--- +title: channels.updateUsername +description: Update the username of a supergroup/channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: channels.updateUsername +[Back to methods index](index.md) + + +Update the username of a supergroup/channel + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[string](../types/string.md) | Yes|The new username| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->channels->updateUsername(['channel' => InputChannel, 'username' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.updateUsername` + +Parameters: + +channel - Json encoded InputChannel + +username - Json encoded string + + + + +Or, if you're into Lua: + +``` +Bool = channels.updateUsername({channel=InputChannel, username='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|USERNAME_INVALID|The provided username is not valid| +|USERNAME_OCCUPIED|The provided username is already occupied| + + diff --git a/old_docs/API_docs_v81/methods/contacts_block.md b/old_docs/API_docs_v81/methods/contacts_block.md new file mode 100644 index 00000000..ec9366c2 --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_block.md @@ -0,0 +1,66 @@ +--- +title: contacts.block +description: Block a user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.block +[Back to methods index](index.md) + + +Block a user + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to block| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->contacts->block(['id' => InputUser, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.block` + +Parameters: + +id - Json encoded InputUser + + + + +Or, if you're into Lua: + +``` +Bool = contacts.block({id=InputUser, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/contacts_deleteContact.md b/old_docs/API_docs_v81/methods/contacts_deleteContact.md new file mode 100644 index 00000000..9269c8e2 --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_deleteContact.md @@ -0,0 +1,66 @@ +--- +title: contacts.deleteContact +description: Delete a contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.deleteContact +[Back to methods index](index.md) + + +Delete a contact + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The contact to delete| + + +### Return type: [contacts\_Link](../types/contacts_Link.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$contacts_Link = $MadelineProto->contacts->deleteContact(['id' => InputUser, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.deleteContact` + +Parameters: + +id - Json encoded InputUser + + + + +Or, if you're into Lua: + +``` +contacts_Link = contacts.deleteContact({id=InputUser, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/contacts_deleteContacts.md b/old_docs/API_docs_v81/methods/contacts_deleteContacts.md new file mode 100644 index 00000000..29883884 --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_deleteContacts.md @@ -0,0 +1,67 @@ +--- +title: contacts.deleteContacts +description: Delete multiple contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.deleteContacts +[Back to methods index](index.md) + + +Delete multiple contacts + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The contacts to delete| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->contacts->deleteContacts(['id' => [InputUser, InputUser], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.deleteContacts` + +Parameters: + +id - Json encoded array of InputUser + + + + +Or, if you're into Lua: + +``` +Bool = contacts.deleteContacts({id={InputUser}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/contacts_exportCard.md b/old_docs/API_docs_v81/methods/contacts_exportCard.md new file mode 100644 index 00000000..269a5b6a --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_exportCard.md @@ -0,0 +1,52 @@ +--- +title: contacts.exportCard +description: Export contact as card +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.exportCard +[Back to methods index](index.md) + + +Export contact as card + + + +### Return type: [Vector\_of\_int](../types/int.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_int = $MadelineProto->contacts->exportCard(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.exportCard` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Vector_of_int = contacts.exportCard({}) +``` + diff --git a/old_docs/API_docs_v81/methods/contacts_getBlocked.md b/old_docs/API_docs_v81/methods/contacts_getBlocked.md new file mode 100644 index 00000000..da656170 --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_getBlocked.md @@ -0,0 +1,62 @@ +--- +title: contacts.getBlocked +description: Get blocked users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.getBlocked +[Back to methods index](index.md) + + +Get blocked users + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|limit|[int](../types/int.md) | Yes|How many blocked contacts to fetch| + + +### Return type: [contacts\_Blocked](../types/contacts_Blocked.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$contacts_Blocked = $MadelineProto->contacts->getBlocked(['offset' => int, 'limit' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.getBlocked` + +Parameters: + +offset - Json encoded int + +limit - Json encoded int + + + + +Or, if you're into Lua: + +``` +contacts_Blocked = contacts.getBlocked({offset=int, limit=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/contacts_getContacts.md b/old_docs/API_docs_v81/methods/contacts_getContacts.md new file mode 100644 index 00000000..30a2fbca --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_getContacts.md @@ -0,0 +1,59 @@ +--- +title: contacts.getContacts +description: Get info about a certain contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.getContacts +[Back to methods index](index.md) + + +Get info about a certain contact + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`| + + +### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$contacts_Contacts = $MadelineProto->contacts->getContacts(['hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.getContacts` + +Parameters: + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +contacts_Contacts = contacts.getContacts({hash=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/contacts_getSaved.md b/old_docs/API_docs_v81/methods/contacts_getSaved.md new file mode 100644 index 00000000..85d30711 --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_getSaved.md @@ -0,0 +1,61 @@ +--- +title: contacts.getSaved +description: Get saved contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.getSaved +[Back to methods index](index.md) + + +Get saved contacts + + + +### Return type: [Vector\_of\_SavedContact](../types/SavedContact.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_SavedContact = $MadelineProto->contacts->getSaved(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - contacts.getSaved +* params - `{}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.getSaved` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Vector_of_SavedContact = contacts.getSaved({}) +``` + diff --git a/old_docs/API_docs_v81/methods/contacts_getStatuses.md b/old_docs/API_docs_v81/methods/contacts_getStatuses.md new file mode 100644 index 00000000..046e9de0 --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_getStatuses.md @@ -0,0 +1,52 @@ +--- +title: contacts.getStatuses +description: Get online status of all users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.getStatuses +[Back to methods index](index.md) + + +Get online status of all users + + + +### Return type: [Vector\_of\_ContactStatus](../types/ContactStatus.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_ContactStatus = $MadelineProto->contacts->getStatuses(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.getStatuses` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Vector_of_ContactStatus = contacts.getStatuses({}) +``` + diff --git a/old_docs/API_docs_v81/methods/contacts_getTopPeers.md b/old_docs/API_docs_v81/methods/contacts_getTopPeers.md new file mode 100644 index 00000000..ef5f40a7 --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_getTopPeers.md @@ -0,0 +1,90 @@ +--- +title: contacts.getTopPeers +description: Get most used chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.getTopPeers +[Back to methods index](index.md) + + +Get most used chats + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|correspondents|[Bool](../types/Bool.md) | Optional|Fetch users?| +|bots\_pm|[Bool](../types/Bool.md) | Optional|Fetch bots?| +|bots\_inline|[Bool](../types/Bool.md) | Optional|Fetch inline bots?| +|phone\_calls|[Bool](../types/Bool.md) | Optional|Fetch phone calls?| +|groups|[Bool](../types/Bool.md) | Optional|Fetch groups?| +|channels|[Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| +|offset|[int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|limit|[int](../types/int.md) | Yes|How many results to fetch| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| + + +### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$contacts_TopPeers = $MadelineProto->contacts->getTopPeers(['correspondents' => Bool, 'bots_pm' => Bool, 'bots_inline' => Bool, 'phone_calls' => Bool, 'groups' => Bool, 'channels' => Bool, 'offset' => int, 'limit' => int, 'hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.getTopPeers` + +Parameters: + +correspondents - Json encoded Bool + +bots_pm - Json encoded Bool + +bots_inline - Json encoded Bool + +phone_calls - Json encoded Bool + +groups - Json encoded Bool + +channels - Json encoded Bool + +offset - Json encoded int + +limit - Json encoded int + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +contacts_TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field is empty| + + diff --git a/old_docs/API_docs_v81/methods/contacts_importCard.md b/old_docs/API_docs_v81/methods/contacts_importCard.md new file mode 100644 index 00000000..080371ae --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_importCard.md @@ -0,0 +1,67 @@ +--- +title: contacts.importCard +description: Import card as contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.importCard +[Back to methods index](index.md) + + +Import card as contact + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|export\_card|Array of [int](../types/int.md) | Yes|The card| + + +### Return type: [User](../types/User.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$User = $MadelineProto->contacts->importCard(['export_card' => [int, int], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.importCard` + +Parameters: + +export_card - Json encoded array of int + + + + +Or, if you're into Lua: + +``` +User = contacts.importCard({export_card={int}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|EXPORT_CARD_INVALID|Provided card is invalid| +|NEED_MEMBER_INVALID|The provided member is invalid| + + diff --git a/old_docs/API_docs_v81/methods/contacts_importContacts.md b/old_docs/API_docs_v81/methods/contacts_importContacts.md new file mode 100644 index 00000000..6aee0ac0 --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_importContacts.md @@ -0,0 +1,59 @@ +--- +title: contacts.importContacts +description: Add phone number as contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.importContacts +[Back to methods index](index.md) + + +Add phone number as contact + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| + + +### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$contacts_ImportedContacts = $MadelineProto->contacts->importContacts(['contacts' => [InputContact, InputContact], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.importContacts` + +Parameters: + +contacts - Json encoded array of InputContact + + + + +Or, if you're into Lua: + +``` +contacts_ImportedContacts = contacts.importContacts({contacts={InputContact}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/contacts_resetSaved.md b/old_docs/API_docs_v81/methods/contacts_resetSaved.md new file mode 100644 index 00000000..6e0214c2 --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_resetSaved.md @@ -0,0 +1,61 @@ +--- +title: contacts.resetSaved +description: Reset saved contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.resetSaved +[Back to methods index](index.md) + + +Reset saved contacts + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->contacts->resetSaved(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - contacts.resetSaved +* params - `{}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.resetSaved` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Bool = contacts.resetSaved({}) +``` + diff --git a/old_docs/API_docs_v81/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v81/methods/contacts_resetTopPeerRating.md new file mode 100644 index 00000000..c232f7cc --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_resetTopPeerRating.md @@ -0,0 +1,69 @@ +--- +title: contacts.resetTopPeerRating +description: Reset top peer rating for a certain category/peer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.resetTopPeerRating +[Back to methods index](index.md) + + +Reset top peer rating for a certain category/peer + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|The category | +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->contacts->resetTopPeerRating(['category' => TopPeerCategory, 'peer' => InputPeer, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.resetTopPeerRating` + +Parameters: + +category - Json encoded TopPeerCategory + +peer - Json encoded InputPeer + + + + +Or, if you're into Lua: + +``` +Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/contacts_resolveUsername.md b/old_docs/API_docs_v81/methods/contacts_resolveUsername.md new file mode 100644 index 00000000..fab56bb1 --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_resolveUsername.md @@ -0,0 +1,14 @@ +--- +title: contacts.resolveUsername +description: You cannot use this method directly, use the resolve_username, get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.resolveUsername +[Back to methods index](index.md) + + +**You cannot use this method directly, use the resolve_username, get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)** + + + + diff --git a/old_docs/API_docs_v81/methods/contacts_search.md b/old_docs/API_docs_v81/methods/contacts_search.md new file mode 100644 index 00000000..c3e55d7d --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_search.md @@ -0,0 +1,71 @@ +--- +title: contacts.search +description: Search contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.search +[Back to methods index](index.md) + + +Search contacts + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|The search query| +|limit|[int](../types/int.md) | Yes|How many results should be returned| + + +### Return type: [contacts\_Found](../types/contacts_Found.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$contacts_Found = $MadelineProto->contacts->search(['q' => 'string', 'limit' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.search` + +Parameters: + +q - Json encoded string + +limit - Json encoded int + + + + +Or, if you're into Lua: + +``` +contacts_Found = contacts.search({q='string', limit=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short| +|SEARCH_QUERY_EMPTY|The search query is empty| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/contacts_unblock.md b/old_docs/API_docs_v81/methods/contacts_unblock.md new file mode 100644 index 00000000..7654feb0 --- /dev/null +++ b/old_docs/API_docs_v81/methods/contacts_unblock.md @@ -0,0 +1,66 @@ +--- +title: contacts.unblock +description: Unblock a user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: contacts.unblock +[Back to methods index](index.md) + + +Unblock a user + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to unblock| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->contacts->unblock(['id' => InputUser, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.unblock` + +Parameters: + +id - Json encoded InputUser + + + + +Or, if you're into Lua: + +``` +Bool = contacts.unblock({id=InputUser, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/help_acceptTermsOfService.md b/old_docs/API_docs_v81/methods/help_acceptTermsOfService.md new file mode 100644 index 00000000..54f78d58 --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_acceptTermsOfService.md @@ -0,0 +1,68 @@ +--- +title: help.acceptTermsOfService +description: Accept telegram's TOS +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.acceptTermsOfService +[Back to methods index](index.md) + + +Accept telegram's TOS + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[DataJSON](../types/DataJSON.md) | Yes|TOS| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->help->acceptTermsOfService(['id' => DataJSON, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - help.acceptTermsOfService +* params - `{"id": DataJSON, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.acceptTermsOfService` + +Parameters: + +id - Json encoded DataJSON + + + + +Or, if you're into Lua: + +``` +Bool = help.acceptTermsOfService({id=DataJSON, }) +``` + diff --git a/old_docs/API_docs_v81/methods/help_getAppChangelog.md b/old_docs/API_docs_v81/methods/help_getAppChangelog.md new file mode 100644 index 00000000..6513df19 --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_getAppChangelog.md @@ -0,0 +1,59 @@ +--- +title: help.getAppChangelog +description: Get the changelog of this app +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.getAppChangelog +[Back to methods index](index.md) + + +Get the changelog of this app + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_app\_version|[string](../types/string.md) | Yes|Previous app version| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->help->getAppChangelog(['prev_app_version' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getAppChangelog` + +Parameters: + +prev_app_version - Json encoded string + + + + +Or, if you're into Lua: + +``` +Updates = help.getAppChangelog({prev_app_version='string', }) +``` + diff --git a/old_docs/API_docs_v81/methods/help_getAppUpdate.md b/old_docs/API_docs_v81/methods/help_getAppUpdate.md new file mode 100644 index 00000000..4ddc0e4d --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_getAppUpdate.md @@ -0,0 +1,52 @@ +--- +title: help.getAppUpdate +description: Get info about app updates +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.getAppUpdate +[Back to methods index](index.md) + + +Get info about app updates + + + +### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$help_AppUpdate = $MadelineProto->help->getAppUpdate(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getAppUpdate` + +Parameters: + + + + +Or, if you're into Lua: + +``` +help_AppUpdate = help.getAppUpdate({}) +``` + diff --git a/old_docs/API_docs_v81/methods/help_getCdnConfig.md b/old_docs/API_docs_v81/methods/help_getCdnConfig.md new file mode 100644 index 00000000..be572516 --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_getCdnConfig.md @@ -0,0 +1,69 @@ +--- +title: help.getCdnConfig +description: Get CDN configuration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.getCdnConfig +[Back to methods index](index.md) + + +Get CDN configuration + + + +### Return type: [CdnConfig](../types/CdnConfig.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$CdnConfig = $MadelineProto->help->getCdnConfig(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - help.getCdnConfig +* params - `{}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getCdnConfig` + +Parameters: + + + + +Or, if you're into Lua: + +``` +CdnConfig = help.getCdnConfig({}) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/help_getConfig.md b/old_docs/API_docs_v81/methods/help_getConfig.md new file mode 100644 index 00000000..22ef7e1a --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_getConfig.md @@ -0,0 +1,69 @@ +--- +title: help.getConfig +description: Get server configuration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.getConfig +[Back to methods index](index.md) + + +Get server configuration + + + +### Return type: [Config](../types/Config.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Config = $MadelineProto->help->getConfig(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - help.getConfig +* params - `{}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getConfig` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Config = help.getConfig({}) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/help_getDeepLinkInfo.md b/old_docs/API_docs_v81/methods/help_getDeepLinkInfo.md new file mode 100644 index 00000000..3bba16de --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_getDeepLinkInfo.md @@ -0,0 +1,68 @@ +--- +title: help.getDeepLinkInfo +description: Get deep link info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.getDeepLinkInfo +[Back to methods index](index.md) + + +Get deep link info + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|path|[string](../types/string.md) | Yes|Deep link| + + +### Return type: [help\_DeepLinkInfo](../types/help_DeepLinkInfo.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$help_DeepLinkInfo = $MadelineProto->help->getDeepLinkInfo(['path' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - help.getDeepLinkInfo +* params - `{"path": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getDeepLinkInfo` + +Parameters: + +path - Json encoded string + + + + +Or, if you're into Lua: + +``` +help_DeepLinkInfo = help.getDeepLinkInfo({path='string', }) +``` + diff --git a/old_docs/API_docs_v81/methods/help_getInviteText.md b/old_docs/API_docs_v81/methods/help_getInviteText.md new file mode 100644 index 00000000..1510e64f --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_getInviteText.md @@ -0,0 +1,52 @@ +--- +title: help.getInviteText +description: Get invitation text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.getInviteText +[Back to methods index](index.md) + + +Get invitation text + + + +### Return type: [help\_InviteText](../types/help_InviteText.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$help_InviteText = $MadelineProto->help->getInviteText(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getInviteText` + +Parameters: + + + + +Or, if you're into Lua: + +``` +help_InviteText = help.getInviteText({}) +``` + diff --git a/old_docs/API_docs_v81/methods/help_getNearestDc.md b/old_docs/API_docs_v81/methods/help_getNearestDc.md new file mode 100644 index 00000000..f73ee3ae --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_getNearestDc.md @@ -0,0 +1,52 @@ +--- +title: help.getNearestDc +description: Get nearest datacenter +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.getNearestDc +[Back to methods index](index.md) + + +Get nearest datacenter + + + +### Return type: [NearestDc](../types/NearestDc.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$NearestDc = $MadelineProto->help->getNearestDc(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getNearestDc` + +Parameters: + + + + +Or, if you're into Lua: + +``` +NearestDc = help.getNearestDc({}) +``` + diff --git a/old_docs/API_docs_v81/methods/help_getProxyData.md b/old_docs/API_docs_v81/methods/help_getProxyData.md new file mode 100644 index 00000000..7c4306a8 --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_getProxyData.md @@ -0,0 +1,61 @@ +--- +title: help.getProxyData +description: Get information about the current proxy +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.getProxyData +[Back to methods index](index.md) + + +Get information about the current proxy + + + +### Return type: [help\_ProxyData](../types/help_ProxyData.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$help_ProxyData = $MadelineProto->help->getProxyData(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - help.getProxyData +* params - `{}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getProxyData` + +Parameters: + + + + +Or, if you're into Lua: + +``` +help_ProxyData = help.getProxyData({}) +``` + diff --git a/old_docs/API_docs_v81/methods/help_getRecentMeUrls.md b/old_docs/API_docs_v81/methods/help_getRecentMeUrls.md new file mode 100644 index 00000000..5043cc42 --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_getRecentMeUrls.md @@ -0,0 +1,68 @@ +--- +title: help.getRecentMeUrls +description: Get recent t.me URLs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.getRecentMeUrls +[Back to methods index](index.md) + + +Get recent t.me URLs + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|referer|[string](../types/string.md) | Yes|Referrer| + + +### Return type: [help\_RecentMeUrls](../types/help_RecentMeUrls.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$help_RecentMeUrls = $MadelineProto->help->getRecentMeUrls(['referer' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - help.getRecentMeUrls +* params - `{"referer": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getRecentMeUrls` + +Parameters: + +referer - Json encoded string + + + + +Or, if you're into Lua: + +``` +help_RecentMeUrls = help.getRecentMeUrls({referer='string', }) +``` + diff --git a/old_docs/API_docs_v81/methods/help_getSupport.md b/old_docs/API_docs_v81/methods/help_getSupport.md new file mode 100644 index 00000000..e821a1b9 --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_getSupport.md @@ -0,0 +1,52 @@ +--- +title: help.getSupport +description: Get info of support user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.getSupport +[Back to methods index](index.md) + + +Get info of support user + + + +### Return type: [help\_Support](../types/help_Support.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$help_Support = $MadelineProto->help->getSupport(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getSupport` + +Parameters: + + + + +Or, if you're into Lua: + +``` +help_Support = help.getSupport({}) +``` + diff --git a/old_docs/API_docs_v81/methods/help_getTermsOfServiceUpdate.md b/old_docs/API_docs_v81/methods/help_getTermsOfServiceUpdate.md new file mode 100644 index 00000000..4865b5c3 --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_getTermsOfServiceUpdate.md @@ -0,0 +1,61 @@ +--- +title: help.getTermsOfServiceUpdate +description: Get updated TOS +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.getTermsOfServiceUpdate +[Back to methods index](index.md) + + +Get updated TOS + + + +### Return type: [help\_TermsOfServiceUpdate](../types/help_TermsOfServiceUpdate.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$help_TermsOfServiceUpdate = $MadelineProto->help->getTermsOfServiceUpdate(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - help.getTermsOfServiceUpdate +* params - `{}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.getTermsOfServiceUpdate` + +Parameters: + + + + +Or, if you're into Lua: + +``` +help_TermsOfServiceUpdate = help.getTermsOfServiceUpdate({}) +``` + diff --git a/old_docs/API_docs_v81/methods/help_saveAppLog.md b/old_docs/API_docs_v81/methods/help_saveAppLog.md new file mode 100644 index 00000000..9acd6174 --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_saveAppLog.md @@ -0,0 +1,59 @@ +--- +title: help.saveAppLog +description: Log data for developer of this app +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.saveAppLog +[Back to methods index](index.md) + + +Log data for developer of this app + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->help->saveAppLog(['events' => [InputAppEvent, InputAppEvent], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.saveAppLog` + +Parameters: + +events - Json encoded array of InputAppEvent + + + + +Or, if you're into Lua: + +``` +Bool = help.saveAppLog({events={InputAppEvent}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v81/methods/help_setBotUpdatesStatus.md new file mode 100644 index 00000000..be3c0ead --- /dev/null +++ b/old_docs/API_docs_v81/methods/help_setBotUpdatesStatus.md @@ -0,0 +1,77 @@ +--- +title: help.setBotUpdatesStatus +description: Set the update status of webhook +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: help.setBotUpdatesStatus +[Back to methods index](index.md) + + +Set the update status of webhook + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pending\_updates\_count|[int](../types/int.md) | Yes|Pending update count| +|message|[string](../types/string.md) | Yes|Message| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->help->setBotUpdatesStatus(['pending_updates_count' => int, 'message' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - help.setBotUpdatesStatus +* params - `{"pending_updates_count": int, "message": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.setBotUpdatesStatus` + +Parameters: + +pending_updates_count - Json encoded int + +message - Json encoded string + + + + +Or, if you're into Lua: + +``` +Bool = help.setBotUpdatesStatus({pending_updates_count=int, message='string', }) +``` + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. + + diff --git a/old_docs/API_docs_v81/methods/initConnection.md b/old_docs/API_docs_v81/methods/initConnection.md new file mode 100644 index 00000000..eb1b522e --- /dev/null +++ b/old_docs/API_docs_v81/methods/initConnection.md @@ -0,0 +1,100 @@ +--- +title: initConnection +description: Initializes connection and save information on the user's device and application. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: initConnection +[Back to methods index](index.md) + + +Initializes connection and save information on the user's device and application. + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|api\_id|[int](../types/int.md) | Yes|Application identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|system\_version|[string](../types/string.md) | Yes|System version| +|app\_version|[string](../types/string.md) | Yes|App version| +|system\_lang\_code|[string](../types/string.md) | Yes|Language code| +|lang\_pack|[string](../types/string.md) | Yes|Language pack to use| +|lang\_code|[string](../types/string.md) | Yes|Language code to set| +|proxy|[InputClientProxy](../types/InputClientProxy.md) | Optional|The current proxy| +|query|[!X](../types/!X.md) | Yes|Nested query| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$X = $MadelineProto->initConnection(['api_id' => int, 'device_model' => 'string', 'system_version' => 'string', 'app_version' => 'string', 'system_lang_code' => 'string', 'lang_pack' => 'string', 'lang_code' => 'string', 'proxy' => InputClientProxy, 'query' => !X, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - initConnection +* params - `{"api_id": int, "device_model": "string", "system_version": "string", "app_version": "string", "system_lang_code": "string", "lang_pack": "string", "lang_code": "string", "proxy": InputClientProxy, "query": !X, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/initConnection` + +Parameters: + +api_id - Json encoded int + +device_model - Json encoded string + +system_version - Json encoded string + +app_version - Json encoded string + +system_lang_code - Json encoded string + +lang_pack - Json encoded string + +lang_code - Json encoded string + +proxy - Json encoded InputClientProxy + +query - Json encoded !X + + + + +Or, if you're into Lua: + +``` +X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', system_lang_code='string', lang_pack='string', lang_code='string', proxy=InputClientProxy, query=!X, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONNECTION_LAYER_INVALID|Layer invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v81/methods/invokeAfterMsg.md b/old_docs/API_docs_v81/methods/invokeAfterMsg.md new file mode 100644 index 00000000..41a381dc --- /dev/null +++ b/old_docs/API_docs_v81/methods/invokeAfterMsg.md @@ -0,0 +1,71 @@ +--- +title: invokeAfterMsg +description: Invokes a query after successfull completion of one of the previous queries. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: invokeAfterMsg +[Back to methods index](index.md) + + +Invokes a query after successfull completion of one of the previous queries. + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[long](../types/long.md) | Yes|Message identifier on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$X = $MadelineProto->invokeAfterMsg(['msg_id' => long, 'query' => !X, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - invokeAfterMsg +* params - `{"msg_id": long, "query": !X, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/invokeAfterMsg` + +Parameters: + +msg_id - Json encoded long + +query - Json encoded !X + + + + +Or, if you're into Lua: + +``` +X = invokeAfterMsg({msg_id=long, query=!X, }) +``` + diff --git a/old_docs/API_docs_v81/methods/invokeAfterMsgs.md b/old_docs/API_docs_v81/methods/invokeAfterMsgs.md new file mode 100644 index 00000000..413fc752 --- /dev/null +++ b/old_docs/API_docs_v81/methods/invokeAfterMsgs.md @@ -0,0 +1,71 @@ +--- +title: invokeAfterMsgs +description: Result type returned by a current query. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: invokeAfterMsgs +[Back to methods index](index.md) + + +Result type returned by a current query. + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_ids|Array of [long](../types/long.md) | Yes|List of messages on which a current query depends| +|query|[!X](../types/!X.md) | Yes|The query itself| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$X = $MadelineProto->invokeAfterMsgs(['msg_ids' => [long, long], 'query' => !X, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - invokeAfterMsgs +* params - `{"msg_ids": [long], "query": !X, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/invokeAfterMsgs` + +Parameters: + +msg_ids - Json encoded array of long + +query - Json encoded !X + + + + +Or, if you're into Lua: + +``` +X = invokeAfterMsgs({msg_ids={long}, query=!X, }) +``` + diff --git a/old_docs/API_docs_v81/methods/invokeWithLayer.md b/old_docs/API_docs_v81/methods/invokeWithLayer.md new file mode 100644 index 00000000..b95ce2eb --- /dev/null +++ b/old_docs/API_docs_v81/methods/invokeWithLayer.md @@ -0,0 +1,90 @@ +--- +title: invokeWithLayer +description: Invoke this method with layer X +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: invokeWithLayer +[Back to methods index](index.md) + + +Invoke this method with layer X + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|layer|[int](../types/int.md) | Yes|The layer version| +|query|[!X](../types/!X.md) | Yes|The query| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$X = $MadelineProto->invokeWithLayer(['layer' => int, 'query' => !X, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - invokeWithLayer +* params - `{"layer": int, "query": !X, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/invokeWithLayer` + +Parameters: + +layer - Json encoded int + +query - Json encoded !X + + + + +Or, if you're into Lua: + +``` +X = invokeWithLayer({layer=int, query=!X, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_BYTES_INVALID|The provided authorization is invalid| +|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|CONNECTION_NOT_INITED|Connection not initialized| +|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|INPUT_LAYER_INVALID|The provided layer is invalid| +|INVITE_HASH_EXPIRED|The invite link has expired| +|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|NEED_MEMBER_INVALID|The provided member is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/invokeWithMessagesRange.md b/old_docs/API_docs_v81/methods/invokeWithMessagesRange.md new file mode 100644 index 00000000..cdf2dae3 --- /dev/null +++ b/old_docs/API_docs_v81/methods/invokeWithMessagesRange.md @@ -0,0 +1,71 @@ +--- +title: invokeWithMessagesRange +description: Invoke with messages range +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: invokeWithMessagesRange +[Back to methods index](index.md) + + +Invoke with messages range + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|range|[MessageRange](../types/MessageRange.md) | Yes|The range| +|query|[!X](../types/!X.md) | Yes|The query| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$X = $MadelineProto->invokeWithMessagesRange(['range' => MessageRange, 'query' => !X, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - invokeWithMessagesRange +* params - `{"range": MessageRange, "query": !X, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/invokeWithMessagesRange` + +Parameters: + +range - Json encoded MessageRange + +query - Json encoded !X + + + + +Or, if you're into Lua: + +``` +X = invokeWithMessagesRange({range=MessageRange, query=!X, }) +``` + diff --git a/old_docs/API_docs_v81/methods/invokeWithTakeout.md b/old_docs/API_docs_v81/methods/invokeWithTakeout.md new file mode 100644 index 00000000..a51e1690 --- /dev/null +++ b/old_docs/API_docs_v81/methods/invokeWithTakeout.md @@ -0,0 +1,71 @@ +--- +title: invokeWithTakeout +description: Invoke method from takeout session +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: invokeWithTakeout +[Back to methods index](index.md) + + +Invoke method from takeout session + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|takeout\_id|[long](../types/long.md) | Yes|The takeout session ID| +|query|[!X](../types/!X.md) | Yes|The query| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$X = $MadelineProto->invokeWithTakeout(['takeout_id' => long, 'query' => !X, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - invokeWithTakeout +* params - `{"takeout_id": long, "query": !X, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/invokeWithTakeout` + +Parameters: + +takeout_id - Json encoded long + +query - Json encoded !X + + + + +Or, if you're into Lua: + +``` +X = invokeWithTakeout({takeout_id=long, query=!X, }) +``` + diff --git a/old_docs/API_docs_v81/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v81/methods/invokeWithoutUpdates.md new file mode 100644 index 00000000..61e02226 --- /dev/null +++ b/old_docs/API_docs_v81/methods/invokeWithoutUpdates.md @@ -0,0 +1,68 @@ +--- +title: invokeWithoutUpdates +description: Invoke with method without returning updates in the socket +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: invokeWithoutUpdates +[Back to methods index](index.md) + + +Invoke with method without returning updates in the socket + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query|[!X](../types/!X.md) | Yes|The query| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$X = $MadelineProto->invokeWithoutUpdates(['query' => !X, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - invokeWithoutUpdates +* params - `{"query": !X, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/invokeWithoutUpdates` + +Parameters: + +query - Json encoded !X + + + + +Or, if you're into Lua: + +``` +X = invokeWithoutUpdates({query=!X, }) +``` + diff --git a/old_docs/API_docs_v81/methods/langpack_getDifference.md b/old_docs/API_docs_v81/methods/langpack_getDifference.md new file mode 100644 index 00000000..26b783c8 --- /dev/null +++ b/old_docs/API_docs_v81/methods/langpack_getDifference.md @@ -0,0 +1,66 @@ +--- +title: langpack.getDifference +description: Get language pack updates +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: langpack.getDifference +[Back to methods index](index.md) + + +Get language pack updates + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|from\_version|[int](../types/int.md) | Yes|Previous version| + + +### Return type: [LangPackDifference](../types/LangPackDifference.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$LangPackDifference = $MadelineProto->langpack->getDifference(['from_version' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/langpack.getDifference` + +Parameters: + +from_version - Json encoded int + + + + +Or, if you're into Lua: + +``` +LangPackDifference = langpack.getDifference({from_version=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v81/methods/langpack_getLangPack.md b/old_docs/API_docs_v81/methods/langpack_getLangPack.md new file mode 100644 index 00000000..731998ba --- /dev/null +++ b/old_docs/API_docs_v81/methods/langpack_getLangPack.md @@ -0,0 +1,66 @@ +--- +title: langpack.getLangPack +description: Get language pack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: langpack.getLangPack +[Back to methods index](index.md) + + +Get language pack + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[string](../types/string.md) | Yes|Language code| + + +### Return type: [LangPackDifference](../types/LangPackDifference.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$LangPackDifference = $MadelineProto->langpack->getLangPack(['lang_code' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/langpack.getLangPack` + +Parameters: + +lang_code - Json encoded string + + + + +Or, if you're into Lua: + +``` +LangPackDifference = langpack.getLangPack({lang_code='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v81/methods/langpack_getLanguages.md b/old_docs/API_docs_v81/methods/langpack_getLanguages.md new file mode 100644 index 00000000..5eaf2049 --- /dev/null +++ b/old_docs/API_docs_v81/methods/langpack_getLanguages.md @@ -0,0 +1,59 @@ +--- +title: langpack.getLanguages +description: Get available languages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: langpack.getLanguages +[Back to methods index](index.md) + + +Get available languages + + + +### Return type: [Vector\_of\_LangPackLanguage](../types/LangPackLanguage.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_LangPackLanguage = $MadelineProto->langpack->getLanguages(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/langpack.getLanguages` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Vector_of_LangPackLanguage = langpack.getLanguages({}) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v81/methods/langpack_getStrings.md b/old_docs/API_docs_v81/methods/langpack_getStrings.md new file mode 100644 index 00000000..fd5ff929 --- /dev/null +++ b/old_docs/API_docs_v81/methods/langpack_getStrings.md @@ -0,0 +1,69 @@ +--- +title: langpack.getStrings +description: Get language pack strings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: langpack.getStrings +[Back to methods index](index.md) + + +Get language pack strings + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[string](../types/string.md) | Yes|Language code| +|keys|Array of [string](../types/string.md) | Yes|Keys| + + +### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_LangPackString = $MadelineProto->langpack->getStrings(['lang_code' => 'string', 'keys' => ['string', 'string'], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/langpack.getStrings` + +Parameters: + +lang_code - Json encoded string + +keys - Json encoded array of string + + + + +Or, if you're into Lua: + +``` +Vector_of_LangPackString = langpack.getStrings({lang_code='string', keys={'string'}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_acceptEncryption.md b/old_docs/API_docs_v81/methods/messages_acceptEncryption.md new file mode 100644 index 00000000..26d28676 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_acceptEncryption.md @@ -0,0 +1,14 @@ +--- +title: messages.acceptEncryption +description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.acceptEncryption +[Back to methods index](index.md) + + +**You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats** + + + + diff --git a/old_docs/API_docs_v81/methods/messages_addChatUser.md b/old_docs/API_docs_v81/methods/messages_addChatUser.md new file mode 100644 index 00000000..d79a1d45 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_addChatUser.md @@ -0,0 +1,80 @@ +--- +title: messages.addChatUser +description: Add a user to a normal chat (use channels->inviteToChannel for supergroups) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.addChatUser +[Back to methods index](index.md) + + +Add a user to a normal chat (use channels->inviteToChannel for supergroups) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite| +|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->addChatUser(['chat_id' => InputPeer, 'user_id' => InputUser, 'fwd_limit' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.addChatUser` + +Parameters: + +chat_id - Json encoded InputPeer + +user_id - Json encoded InputUser + +fwd_limit - Json encoded int + + + + +Or, if you're into Lua: + +``` +Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USER_ID_INVALID|The provided user ID is invalid| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v81/methods/messages_checkChatInvite.md b/old_docs/API_docs_v81/methods/messages_checkChatInvite.md new file mode 100644 index 00000000..f82a427e --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_checkChatInvite.md @@ -0,0 +1,68 @@ +--- +title: messages.checkChatInvite +description: Check if an invitation link is valid +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.checkChatInvite +[Back to methods index](index.md) + + +Check if an invitation link is valid + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| + + +### Return type: [ChatInvite](../types/ChatInvite.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$ChatInvite = $MadelineProto->messages->checkChatInvite(['hash' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.checkChatInvite` + +Parameters: + +hash - Json encoded string + + + + +Or, if you're into Lua: + +``` +ChatInvite = messages.checkChatInvite({hash='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v81/methods/messages_clearRecentStickers.md new file mode 100644 index 00000000..b5087461 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_clearRecentStickers.md @@ -0,0 +1,59 @@ +--- +title: messages.clearRecentStickers +description: Clear all recent stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.clearRecentStickers +[Back to methods index](index.md) + + +Clear all recent stickers + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->clearRecentStickers(['attached' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.clearRecentStickers` + +Parameters: + +attached - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Bool = messages.clearRecentStickers({attached=Bool, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_createChat.md b/old_docs/API_docs_v81/methods/messages_createChat.md new file mode 100644 index 00000000..931dce58 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_createChat.md @@ -0,0 +1,70 @@ +--- +title: messages.createChat +description: Create a chat (not supergroup) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.createChat +[Back to methods index](index.md) + + +Create a chat (not supergroup) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| +|title|[string](../types/string.md) | Yes|The new chat's title| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->createChat(['users' => [InputUser, InputUser], 'title' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.createChat` + +Parameters: + +users - Json encoded array of InputUser + +title - Json encoded string + + + + +Or, if you're into Lua: + +``` +Updates = messages.createChat({users={InputUser}, title='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v81/methods/messages_deleteChatUser.md b/old_docs/API_docs_v81/methods/messages_deleteChatUser.md new file mode 100644 index 00000000..e0ab29a9 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_deleteChatUser.md @@ -0,0 +1,80 @@ +--- +title: messages.deleteChatUser +description: Delete a user from a chat (not supergroup) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.deleteChatUser +[Back to methods index](index.md) + + +Delete a user from a chat (not supergroup) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->deleteChatUser(['chat_id' => InputPeer, 'user_id' => InputUser, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.deleteChatUser +* params - `{"chat_id": InputPeer, "user_id": InputUser, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.deleteChatUser` + +Parameters: + +chat_id - Json encoded InputPeer + +user_id - Json encoded InputUser + + + + +Or, if you're into Lua: + +``` +Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v81/methods/messages_deleteHistory.md b/old_docs/API_docs_v81/methods/messages_deleteHistory.md new file mode 100644 index 00000000..8878ffbf --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_deleteHistory.md @@ -0,0 +1,72 @@ +--- +title: messages.deleteHistory +description: Delete chat history +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.deleteHistory +[Back to methods index](index.md) + + +Delete chat history + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| + + +### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_AffectedHistory = $MadelineProto->messages->deleteHistory(['just_clear' => Bool, 'peer' => InputPeer, 'max_id' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.deleteHistory` + +Parameters: + +just_clear - Json encoded Bool + +peer - Json encoded InputPeer + +max_id - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_AffectedHistory = messages.deleteHistory({just_clear=Bool, peer=InputPeer, max_id=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_deleteMessages.md b/old_docs/API_docs_v81/methods/messages_deleteMessages.md new file mode 100644 index 00000000..67a321f9 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_deleteMessages.md @@ -0,0 +1,78 @@ +--- +title: messages.deleteMessages +description: Delete messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.deleteMessages +[Back to methods index](index.md) + + +Delete messages + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| +|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| + + +### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_AffectedMessages = $MadelineProto->messages->deleteMessages(['revoke' => Bool, 'id' => [int, int], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.deleteMessages +* params - `{"revoke": Bool, "id": [int], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.deleteMessages` + +Parameters: + +revoke - Json encoded Bool + +id - Json encoded array of int + + + + +Or, if you're into Lua: + +``` +messages_AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.| + + diff --git a/old_docs/API_docs_v81/methods/messages_discardEncryption.md b/old_docs/API_docs_v81/methods/messages_discardEncryption.md new file mode 100644 index 00000000..f3689dd0 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_discardEncryption.md @@ -0,0 +1,14 @@ +--- +title: messages.discardEncryption +description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.discardEncryption +[Back to methods index](index.md) + + +**You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats** + + + + diff --git a/old_docs/API_docs_v81/methods/messages_editChatAdmin.md b/old_docs/API_docs_v81/methods/messages_editChatAdmin.md new file mode 100644 index 00000000..bebfd4b5 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_editChatAdmin.md @@ -0,0 +1,72 @@ +--- +title: messages.editChatAdmin +description: Edit admin permissions +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.editChatAdmin +[Back to methods index](index.md) + + +Edit admin permissions + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->editChatAdmin(['chat_id' => InputPeer, 'user_id' => InputUser, 'is_admin' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.editChatAdmin` + +Parameters: + +chat_id - Json encoded InputPeer + +user_id - Json encoded InputUser + +is_admin - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_editChatPhoto.md b/old_docs/API_docs_v81/methods/messages_editChatPhoto.md new file mode 100644 index 00000000..55d3da32 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_editChatPhoto.md @@ -0,0 +1,82 @@ +--- +title: messages.editChatPhoto +description: Edit the photo of a normal chat (not supergroup) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.editChatPhoto +[Back to methods index](index.md) + + +Edit the photo of a normal chat (not supergroup) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->editChatPhoto(['chat_id' => InputPeer, 'photo' => InputChatPhoto, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.editChatPhoto +* params - `{"chat_id": InputPeer, "photo": InputChatPhoto, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.editChatPhoto` + +Parameters: + +chat_id - Json encoded InputPeer + +photo - Json encoded InputChatPhoto + + + + +Or, if you're into Lua: + +``` +Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_editChatTitle.md b/old_docs/API_docs_v81/methods/messages_editChatTitle.md new file mode 100644 index 00000000..8c412d48 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_editChatTitle.md @@ -0,0 +1,79 @@ +--- +title: messages.editChatTitle +description: Edit the title of a normal chat (not supergroup) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.editChatTitle +[Back to methods index](index.md) + + +Edit the title of a normal chat (not supergroup) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| +|title|[string](../types/string.md) | Yes|The new title| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->editChatTitle(['chat_id' => InputPeer, 'title' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.editChatTitle +* params - `{"chat_id": InputPeer, "title": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.editChatTitle` + +Parameters: + +chat_id - Json encoded InputPeer + +title - Json encoded string + + + + +Or, if you're into Lua: + +``` +Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|NEED_CHAT_INVALID|The provided chat is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v81/methods/messages_editInlineBotMessage.md new file mode 100644 index 00000000..4d097f4c --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_editInlineBotMessage.md @@ -0,0 +1,128 @@ +--- +title: messages.editInlineBotMessage +description: Edit a sent inline message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.editInlineBotMessage +[Back to methods index](index.md) + + +Edit a sent inline message + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to substitute| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->editInlineBotMessage(['no_webpage' => Bool, 'stop_geo_live' => Bool, 'id' => InputBotInlineMessageID, 'message' => 'string', 'media' => InputMedia, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', 'geo_point' => InputGeoPoint, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.editInlineBotMessage +* params - `{"no_webpage": Bool, "stop_geo_live": Bool, "id": InputBotInlineMessageID, "message": "string", "media": InputMedia, "reply_markup": ReplyMarkup, "entities": [MessageEntity], "parse_mode": "string""geo_point": InputGeoPoint, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.editInlineBotMessage` + +Parameters: + +parse_mode - string +geo_point - Json encoded InputGeoPoint + + + + +Or, if you're into Lua: + +``` +Bool = messages.editInlineBotMessage({no_webpage=Bool, stop_geo_live=Bool, id=InputBotInlineMessageID, message='string', media=InputMedia, reply_markup=ReplyMarkup, entities={MessageEntity}, parse_mode='string', geo_point=InputGeoPoint, }) +``` + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. + + + +## Usage of parse_mode: + +Set parse_mode to html to enable HTML parsing of the message. + +Set parse_mode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +``` +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +inline fixed-width code +
pre-formatted fixed-width code block
+URL +Mention by username +Mention by user id +
Pre tags can have a language attribute
+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +``` +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v81/methods/messages_editMessage.md b/old_docs/API_docs_v81/methods/messages_editMessage.md new file mode 100644 index 00000000..f5a5b5c1 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_editMessage.md @@ -0,0 +1,137 @@ +--- +title: messages.editMessage +description: Edit a message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.editMessage +[Back to methods index](index.md) + + +Edit a message + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[int](../types/int.md) | Yes|The message ID| +|message|[string](../types/string.md) | Optional|The new message| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to substitute| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +|parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->editMessage(['no_webpage' => Bool, 'stop_geo_live' => Bool, 'peer' => InputPeer, 'id' => int, 'message' => 'string', 'media' => InputMedia, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', 'geo_point' => InputGeoPoint, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.editMessage +* params - `{"no_webpage": Bool, "stop_geo_live": Bool, "peer": InputPeer, "id": int, "message": "string", "media": InputMedia, "reply_markup": ReplyMarkup, "entities": [MessageEntity], "parse_mode": "string""geo_point": InputGeoPoint, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.editMessage` + +Parameters: + +parse_mode - string +geo_point - Json encoded InputGeoPoint + + + + +Or, if you're into Lua: + +``` +Updates = messages.editMessage({no_webpage=Bool, stop_geo_live=Bool, peer=InputPeer, id=int, message='string', media=InputMedia, reply_markup=ReplyMarkup, entities={MessageEntity}, parse_mode='string', geo_point=InputGeoPoint, }) +``` + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Updates](../types/Updates.md) will be returned instead. + + + +## Usage of parse_mode: + +Set parse_mode to html to enable HTML parsing of the message. + +Set parse_mode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +``` +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +inline fixed-width code +
pre-formatted fixed-width code block
+URL +Mention by username +Mention by user id +
Pre tags can have a language attribute
+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +``` +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_NOT_MODIFIED|The message text has not changed| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v81/methods/messages_exportChatInvite.md b/old_docs/API_docs_v81/methods/messages_exportChatInvite.md new file mode 100644 index 00000000..8c0955fa --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_exportChatInvite.md @@ -0,0 +1,66 @@ +--- +title: messages.exportChatInvite +description: Export chat invite +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.exportChatInvite +[Back to methods index](index.md) + + +Export chat invite + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | + + +### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$ExportedChatInvite = $MadelineProto->messages->exportChatInvite(['chat_id' => InputPeer, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.exportChatInvite` + +Parameters: + +chat_id - Json encoded InputPeer + + + + +Or, if you're into Lua: + +``` +ExportedChatInvite = messages.exportChatInvite({chat_id=InputPeer, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_faveSticker.md b/old_docs/API_docs_v81/methods/messages_faveSticker.md new file mode 100644 index 00000000..05c04983 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_faveSticker.md @@ -0,0 +1,78 @@ +--- +title: messages.faveSticker +description: Add a sticker to favorites +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.faveSticker +[Back to methods index](index.md) + + +Add a sticker to favorites + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| +|unfave|[Bool](../types/Bool.md) | Yes|Remove it from favorites?| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->faveSticker(['id' => InputDocument, 'unfave' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.faveSticker +* params - `{"id": InputDocument, "unfave": Bool, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.faveSticker` + +Parameters: + +id - Json encoded InputDocument + +unfave - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Bool = messages.faveSticker({id=InputDocument, unfave=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_forwardMessages.md b/old_docs/API_docs_v81/methods/messages_forwardMessages.md new file mode 100644 index 00000000..e0091c2e --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_forwardMessages.md @@ -0,0 +1,114 @@ +--- +title: messages.forwardMessages +description: Forward messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.forwardMessages +[Back to methods index](index.md) + + +Forward messages + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| +|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| +|grouped|[Bool](../types/Bool.md) | Optional|Set to true if forwarding albums| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| +|id|Array of [int](../types/int.md) | Yes|The message IDs| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->forwardMessages(['silent' => Bool, 'background' => Bool, 'with_my_score' => Bool, 'grouped' => Bool, 'from_peer' => InputPeer, 'id' => [int, int], 'to_peer' => InputPeer, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.forwardMessages +* params - `{"silent": Bool, "background": Bool, "with_my_score": Bool, "grouped": Bool, "from_peer": InputPeer, "id": [int], "to_peer": InputPeer, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.forwardMessages` + +Parameters: + +silent - Json encoded Bool + +background - Json encoded Bool + +with_my_score - Json encoded Bool + +grouped - Json encoded Bool + +from_peer - Json encoded InputPeer + +id - Json encoded array of int + +to_peer - Json encoded InputPeer + + + + +Or, if you're into Lua: + +``` +Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, grouped=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|GROUPED_MEDIA_INVALID|Invalid grouped media| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_EMPTY|The provided media object is invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|MESSAGE_IDS_EMPTY|No message ids were provided| +|PEER_ID_INVALID|The provided peer id is invalid| +|RANDOM_ID_INVALID|A provided random ID is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|PTS_CHANGE_EMPTY|No PTS change| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_getAllChats.md b/old_docs/API_docs_v81/methods/messages_getAllChats.md new file mode 100644 index 00000000..862a1694 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getAllChats.md @@ -0,0 +1,59 @@ +--- +title: messages.getAllChats +description: Get all chats (not supergroups or channels) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getAllChats +[Back to methods index](index.md) + + +Get all chats (not supergroups or channels) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| + + +### Return type: [messages\_Chats](../types/messages_Chats.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Chats = $MadelineProto->messages->getAllChats(['except_ids' => [int, int], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getAllChats` + +Parameters: + +except_ids - Json encoded array of int + + + + +Or, if you're into Lua: + +``` +messages_Chats = messages.getAllChats({except_ids={int}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getAllDrafts.md b/old_docs/API_docs_v81/methods/messages_getAllDrafts.md new file mode 100644 index 00000000..31aa8176 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getAllDrafts.md @@ -0,0 +1,52 @@ +--- +title: messages.getAllDrafts +description: Get all message drafts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getAllDrafts +[Back to methods index](index.md) + + +Get all message drafts + + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->getAllDrafts(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getAllDrafts` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Updates = messages.getAllDrafts({}) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getAllStickers.md b/old_docs/API_docs_v81/methods/messages_getAllStickers.md new file mode 100644 index 00000000..e307bd31 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getAllStickers.md @@ -0,0 +1,59 @@ +--- +title: messages.getAllStickers +description: Get all stickerpacks +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getAllStickers +[Back to methods index](index.md) + + +Get all stickerpacks + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| + + +### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_AllStickers = $MadelineProto->messages->getAllStickers(['hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getAllStickers` + +Parameters: + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_AllStickers = messages.getAllStickers({hash=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v81/methods/messages_getArchivedStickers.md new file mode 100644 index 00000000..b2ab58de --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getArchivedStickers.md @@ -0,0 +1,65 @@ +--- +title: messages.getArchivedStickers +description: Get all archived stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getArchivedStickers +[Back to methods index](index.md) + + +Get all archived stickers + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| +|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| + + +### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_ArchivedStickers = $MadelineProto->messages->getArchivedStickers(['masks' => Bool, 'offset_id' => long, 'limit' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getArchivedStickers` + +Parameters: + +masks - Json encoded Bool + +offset_id - Json encoded long + +limit - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_ArchivedStickers = messages.getArchivedStickers({masks=Bool, offset_id=long, limit=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v81/methods/messages_getAttachedStickers.md new file mode 100644 index 00000000..bd20bc91 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getAttachedStickers.md @@ -0,0 +1,59 @@ +--- +title: messages.getAttachedStickers +description: Get stickers attachable to images +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getAttachedStickers +[Back to methods index](index.md) + + +Get stickers attachable to images + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| + + +### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_StickerSetCovered = $MadelineProto->messages->getAttachedStickers(['media' => InputStickeredMedia, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getAttachedStickers` + +Parameters: + +media - Json encoded InputStickeredMedia + + + + +Or, if you're into Lua: + +``` +Vector_of_StickerSetCovered = messages.getAttachedStickers({media=InputStickeredMedia, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v81/methods/messages_getBotCallbackAnswer.md new file mode 100644 index 00000000..f89f60ab --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getBotCallbackAnswer.md @@ -0,0 +1,79 @@ +--- +title: messages.getBotCallbackAnswer +description: Get the callback answer of a bot (after clicking a button) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getBotCallbackAnswer +[Back to methods index](index.md) + + +Get the callback answer of a bot (after clicking a button) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[Bool](../types/Bool.md) | Optional|Is this a game?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| + + +### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_BotCallbackAnswer = $MadelineProto->messages->getBotCallbackAnswer(['game' => Bool, 'peer' => InputPeer, 'msg_id' => int, 'data' => 'bytes', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getBotCallbackAnswer` + +Parameters: + +game - Json encoded Bool + +peer - Json encoded InputPeer + +msg_id - Json encoded int + +data - Json encoded bytes + + + + +Or, if you're into Lua: + +``` +messages_BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|DATA_INVALID|Encrypted data invalid| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_getChats.md b/old_docs/API_docs_v81/methods/messages_getChats.md new file mode 100644 index 00000000..8a875912 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getChats.md @@ -0,0 +1,76 @@ +--- +title: messages.getChats +description: Get info about chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getChats +[Back to methods index](index.md) + + +Get info about chats + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| + + +### Return type: [messages\_Chats](../types/messages_Chats.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Chats = $MadelineProto->messages->getChats(['id' => [int, int], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.getChats +* params - `{"id": [int], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getChats` + +Parameters: + +id - Json encoded array of int + + + + +Or, if you're into Lua: + +``` +messages_Chats = messages.getChats({id={int}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_getCommonChats.md b/old_docs/API_docs_v81/methods/messages_getCommonChats.md new file mode 100644 index 00000000..eb11e88a --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getCommonChats.md @@ -0,0 +1,72 @@ +--- +title: messages.getCommonChats +description: Get chats in common with a user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getCommonChats +[Back to methods index](index.md) + + +Get chats in common with a user + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[int](../types/int.md) | Yes|Number of results to fetch| + + +### Return type: [messages\_Chats](../types/messages_Chats.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Chats = $MadelineProto->messages->getCommonChats(['user_id' => InputUser, 'max_id' => int, 'limit' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getCommonChats` + +Parameters: + +user_id - Json encoded InputUser + +max_id - Json encoded int + +limit - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_getDhConfig.md b/old_docs/API_docs_v81/methods/messages_getDhConfig.md new file mode 100644 index 00000000..ea48a8f1 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getDhConfig.md @@ -0,0 +1,14 @@ +--- +title: messages.getDhConfig +description: You cannot use this method directly, instead use $MadelineProto->get_dh_config(); +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getDhConfig +[Back to methods index](index.md) + + +**You cannot use this method directly, instead use $MadelineProto->get_dh_config();** + + + + diff --git a/old_docs/API_docs_v81/methods/messages_getDialogs.md b/old_docs/API_docs_v81/methods/messages_getDialogs.md new file mode 100644 index 00000000..22dc3327 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getDialogs.md @@ -0,0 +1,81 @@ +--- +title: messages.getDialogs +description: Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getDialogs +[Back to methods index](index.md) + + +Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| +|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| +|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| +|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| + + +### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Dialogs = $MadelineProto->messages->getDialogs(['exclude_pinned' => Bool, 'offset_date' => int, 'offset_id' => int, 'offset_peer' => InputPeer, 'limit' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getDialogs` + +Parameters: + +exclude_pinned - Json encoded Bool + +offset_date - Json encoded int + +offset_id - Json encoded int + +offset_peer - Json encoded InputPeer + +limit - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v81/methods/messages_getDocumentByHash.md new file mode 100644 index 00000000..42d9bf88 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getDocumentByHash.md @@ -0,0 +1,81 @@ +--- +title: messages.getDocumentByHash +description: Get document by SHA256 hash +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getDocumentByHash +[Back to methods index](index.md) + + +Get document by SHA256 hash + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[int](../types/int.md) | Yes|The file size| +|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| + + +### Return type: [Document](../types/Document.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Document = $MadelineProto->messages->getDocumentByHash(['sha256' => 'bytes', 'size' => int, 'mime_type' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.getDocumentByHash +* params - `{"sha256": {"_": "bytes", "bytes":"base64 encoded bytes"}, "size": int, "mime_type": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getDocumentByHash` + +Parameters: + +sha256 - Json encoded bytes + +size - Json encoded int + +mime_type - Json encoded string + + + + +Or, if you're into Lua: + +``` +Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_getFavedStickers.md b/old_docs/API_docs_v81/methods/messages_getFavedStickers.md new file mode 100644 index 00000000..cae141f4 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getFavedStickers.md @@ -0,0 +1,68 @@ +--- +title: messages.getFavedStickers +description: Get favorite stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getFavedStickers +[Back to methods index](index.md) + + +Get favorite stickers + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| + + +### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_FavedStickers = $MadelineProto->messages->getFavedStickers(['hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.getFavedStickers +* params - `{"hash": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getFavedStickers` + +Parameters: + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_FavedStickers = messages.getFavedStickers({hash=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v81/methods/messages_getFeaturedStickers.md new file mode 100644 index 00000000..95b57370 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getFeaturedStickers.md @@ -0,0 +1,59 @@ +--- +title: messages.getFeaturedStickers +description: Get featured stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getFeaturedStickers +[Back to methods index](index.md) + + +Get featured stickers + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| + + +### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_FeaturedStickers = $MadelineProto->messages->getFeaturedStickers(['hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getFeaturedStickers` + +Parameters: + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_FeaturedStickers = messages.getFeaturedStickers({hash=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getFullChat.md b/old_docs/API_docs_v81/methods/messages_getFullChat.md new file mode 100644 index 00000000..5ef14f65 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getFullChat.md @@ -0,0 +1,14 @@ +--- +title: messages.getFullChat +description: You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getFullChat +[Back to methods index](index.md) + + +**You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)** + + + + diff --git a/old_docs/API_docs_v81/methods/messages_getGameHighScores.md b/old_docs/API_docs_v81/methods/messages_getGameHighScores.md new file mode 100644 index 00000000..589d91bf --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getGameHighScores.md @@ -0,0 +1,82 @@ +--- +title: messages.getGameHighScores +description: Get high scores of a game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getGameHighScores +[Back to methods index](index.md) + + +Get high scores of a game + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| + + +### Return type: [messages\_HighScores](../types/messages_HighScores.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_HighScores = $MadelineProto->messages->getGameHighScores(['peer' => InputPeer, 'id' => int, 'user_id' => InputUser, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.getGameHighScores +* params - `{"peer": InputPeer, "id": int, "user_id": InputUser, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getGameHighScores` + +Parameters: + +peer - Json encoded InputPeer + +id - Json encoded int + +user_id - Json encoded InputUser + + + + +Or, if you're into Lua: + +``` +messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_getHistory.md b/old_docs/API_docs_v81/methods/messages_getHistory.md new file mode 100644 index 00000000..0d6eee5a --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getHistory.md @@ -0,0 +1,93 @@ +--- +title: messages.getHistory +description: Get previous messages of a group +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getHistory +[Back to methods index](index.md) + + +Get previous messages of a group + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| +|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +|hash|[int](../types/int.md) | Yes|hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds)| + + +### Return type: [messages\_Messages](../types/messages_Messages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Messages = $MadelineProto->messages->getHistory(['peer' => InputPeer, 'offset_id' => int, 'offset_date' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, 'hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getHistory` + +Parameters: + +peer - Json encoded InputPeer + +offset_id - Json encoded int + +offset_date - Json encoded int + +add_offset - Json encoded int + +limit - Json encoded int + +max_id - Json encoded int + +min_id - Json encoded int + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, hash=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v81/methods/messages_getInlineBotResults.md new file mode 100644 index 00000000..7bb2d7bc --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getInlineBotResults.md @@ -0,0 +1,81 @@ +--- +title: messages.getInlineBotResults +description: Call inline bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getInlineBotResults +[Back to methods index](index.md) + + +Call inline bot + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[string](../types/string.md) | Yes|The query to send to the bot| +|offset|[string](../types/string.md) | Yes|The offset to send to the bot| + + +### Return type: [messages\_BotResults](../types/messages_BotResults.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_BotResults = $MadelineProto->messages->getInlineBotResults(['bot' => InputUser, 'peer' => InputPeer, 'geo_point' => InputGeoPoint, 'query' => 'string', 'offset' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getInlineBotResults` + +Parameters: + +bot - Json encoded InputUser + +peer - Json encoded InputPeer + +geo_point - Json encoded InputGeoPoint + +query - Json encoded string + +offset - Json encoded string + + + + +Or, if you're into Lua: + +``` +messages_BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|BOT_INVALID|This is not a valid bot| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v81/methods/messages_getInlineGameHighScores.md new file mode 100644 index 00000000..88f20c2a --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getInlineGameHighScores.md @@ -0,0 +1,79 @@ +--- +title: messages.getInlineGameHighScores +description: Get high scores of a game sent in an inline message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getInlineGameHighScores +[Back to methods index](index.md) + + +Get high scores of a game sent in an inline message + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| + + +### Return type: [messages\_HighScores](../types/messages_HighScores.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_HighScores = $MadelineProto->messages->getInlineGameHighScores(['id' => InputBotInlineMessageID, 'user_id' => InputUser, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.getInlineGameHighScores +* params - `{"id": InputBotInlineMessageID, "user_id": InputUser, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getInlineGameHighScores` + +Parameters: + +id - Json encoded InputBotInlineMessageID + +user_id - Json encoded InputUser + + + + +Or, if you're into Lua: + +``` +messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_getMaskStickers.md b/old_docs/API_docs_v81/methods/messages_getMaskStickers.md new file mode 100644 index 00000000..7aee3f08 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getMaskStickers.md @@ -0,0 +1,59 @@ +--- +title: messages.getMaskStickers +description: Get masks +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getMaskStickers +[Back to methods index](index.md) + + +Get masks + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| + + +### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_AllStickers = $MadelineProto->messages->getMaskStickers(['hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getMaskStickers` + +Parameters: + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_AllStickers = messages.getMaskStickers({hash=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getMessageEditData.md b/old_docs/API_docs_v81/methods/messages_getMessageEditData.md new file mode 100644 index 00000000..6b4f0be2 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getMessageEditData.md @@ -0,0 +1,70 @@ +--- +title: messages.getMessageEditData +description: Check if about to edit a message or a media caption +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getMessageEditData +[Back to methods index](index.md) + + +Check if about to edit a message or a media caption + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[int](../types/int.md) | Yes|The message ID| + + +### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_MessageEditData = $MadelineProto->messages->getMessageEditData(['peer' => InputPeer, 'id' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getMessageEditData` + +Parameters: + +peer - Json encoded InputPeer + +id - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v81/methods/messages_getMessages.md b/old_docs/API_docs_v81/methods/messages_getMessages.md new file mode 100644 index 00000000..c70d48c5 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getMessages.md @@ -0,0 +1,68 @@ +--- +title: messages.getMessages +description: Get messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getMessages +[Back to methods index](index.md) + + +Get messages + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| + + +### Return type: [messages\_Messages](../types/messages_Messages.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Messages = $MadelineProto->messages->getMessages(['id' => [InputMessage, InputMessage], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.getMessages +* params - `{"id": [InputMessage], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getMessages` + +Parameters: + +id - Json encoded array of InputMessage + + + + +Or, if you're into Lua: + +``` +messages_Messages = messages.getMessages({id={InputMessage}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getMessagesViews.md b/old_docs/API_docs_v81/methods/messages_getMessagesViews.md new file mode 100644 index 00000000..94310603 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getMessagesViews.md @@ -0,0 +1,74 @@ +--- +title: messages.getMessagesViews +description: Get and increase message views +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getMessagesViews +[Back to methods index](index.md) + + +Get and increase message views + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| +|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| + + +### Return type: [Vector\_of\_int](../types/int.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_int = $MadelineProto->messages->getMessagesViews(['peer' => InputPeer, 'id' => [int, int], 'increment' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getMessagesViews` + +Parameters: + +peer - Json encoded InputPeer + +id - Json encoded array of int + +increment - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v81/methods/messages_getPeerDialogs.md new file mode 100644 index 00000000..61dac347 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getPeerDialogs.md @@ -0,0 +1,67 @@ +--- +title: messages.getPeerDialogs +description: Get dialog info of peers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getPeerDialogs +[Back to methods index](index.md) + + +Get dialog info of peers + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [InputDialogPeer](../types/InputDialogPeer.md) | Yes|The peers| + + +### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_PeerDialogs = $MadelineProto->messages->getPeerDialogs(['peers' => [InputDialogPeer, InputDialogPeer], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getPeerDialogs` + +Parameters: + +peers - Json encoded array of InputDialogPeer + + + + +Or, if you're into Lua: + +``` +messages_PeerDialogs = messages.getPeerDialogs({peers={InputDialogPeer}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_getPeerSettings.md b/old_docs/API_docs_v81/methods/messages_getPeerSettings.md new file mode 100644 index 00000000..679ba8d5 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getPeerSettings.md @@ -0,0 +1,67 @@ +--- +title: messages.getPeerSettings +description: Get the settings of apeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getPeerSettings +[Back to methods index](index.md) + + +Get the settings of apeer + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| + + +### Return type: [PeerSettings](../types/PeerSettings.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$PeerSettings = $MadelineProto->messages->getPeerSettings(['peer' => InputPeer, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getPeerSettings` + +Parameters: + +peer - Json encoded InputPeer + + + + +Or, if you're into Lua: + +``` +PeerSettings = messages.getPeerSettings({peer=InputPeer, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_getPinnedDialogs.md b/old_docs/API_docs_v81/methods/messages_getPinnedDialogs.md new file mode 100644 index 00000000..634f4c41 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getPinnedDialogs.md @@ -0,0 +1,52 @@ +--- +title: messages.getPinnedDialogs +description: Get pinned dialogs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getPinnedDialogs +[Back to methods index](index.md) + + +Get pinned dialogs + + + +### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_PeerDialogs = $MadelineProto->messages->getPinnedDialogs(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getPinnedDialogs` + +Parameters: + + + + +Or, if you're into Lua: + +``` +messages_PeerDialogs = messages.getPinnedDialogs({}) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getRecentLocations.md b/old_docs/API_docs_v81/methods/messages_getRecentLocations.md new file mode 100644 index 00000000..d839c63c --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getRecentLocations.md @@ -0,0 +1,74 @@ +--- +title: messages.getRecentLocations +description: Get recent locations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getRecentLocations +[Back to methods index](index.md) + + +Get recent locations + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched locations, or []);| + + +### Return type: [messages\_Messages](../types/messages_Messages.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Messages = $MadelineProto->messages->getRecentLocations(['peer' => InputPeer, 'limit' => int, 'hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.getRecentLocations +* params - `{"peer": InputPeer, "limit": int, "hash": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getRecentLocations` + +Parameters: + +peer - Json encoded InputPeer + +limit - Json encoded int + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_Messages = messages.getRecentLocations({peer=InputPeer, limit=int, hash=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getRecentStickers.md b/old_docs/API_docs_v81/methods/messages_getRecentStickers.md new file mode 100644 index 00000000..f277eb43 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getRecentStickers.md @@ -0,0 +1,62 @@ +--- +title: messages.getRecentStickers +description: Get recent stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getRecentStickers +[Back to methods index](index.md) + + +Get recent stickers + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| + + +### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_RecentStickers = $MadelineProto->messages->getRecentStickers(['attached' => Bool, 'hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getRecentStickers` + +Parameters: + +attached - Json encoded Bool + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_RecentStickers = messages.getRecentStickers({attached=Bool, hash=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getSavedGifs.md b/old_docs/API_docs_v81/methods/messages_getSavedGifs.md new file mode 100644 index 00000000..5539c012 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getSavedGifs.md @@ -0,0 +1,59 @@ +--- +title: messages.getSavedGifs +description: Get saved gifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getSavedGifs +[Back to methods index](index.md) + + +Get saved gifs + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| + + +### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_SavedGifs = $MadelineProto->messages->getSavedGifs(['hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getSavedGifs` + +Parameters: + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_SavedGifs = messages.getSavedGifs({hash=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getSplitRanges.md b/old_docs/API_docs_v81/methods/messages_getSplitRanges.md new file mode 100644 index 00000000..1406fc06 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getSplitRanges.md @@ -0,0 +1,61 @@ +--- +title: messages.getSplitRanges +description: Get message ranges to fetch +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getSplitRanges +[Back to methods index](index.md) + + +Get message ranges to fetch + + + +### Return type: [Vector\_of\_MessageRange](../types/MessageRange.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_MessageRange = $MadelineProto->messages->getSplitRanges(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.getSplitRanges +* params - `{}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getSplitRanges` + +Parameters: + + + + +Or, if you're into Lua: + +``` +Vector_of_MessageRange = messages.getSplitRanges({}) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getStickerSet.md b/old_docs/API_docs_v81/methods/messages_getStickerSet.md new file mode 100644 index 00000000..bcad8456 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getStickerSet.md @@ -0,0 +1,75 @@ +--- +title: messages.getStickerSet +description: Get a stickerset +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getStickerSet +[Back to methods index](index.md) + + +Get a stickerset + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| + + +### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_StickerSet = $MadelineProto->messages->getStickerSet(['stickerset' => InputStickerSet, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.getStickerSet +* params - `{"stickerset": InputStickerSet, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getStickerSet` + +Parameters: + +stickerset - Json encoded InputStickerSet + + + + +Or, if you're into Lua: + +``` +messages_StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_getStickers.md b/old_docs/API_docs_v81/methods/messages_getStickers.md new file mode 100644 index 00000000..7d2822d0 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getStickers.md @@ -0,0 +1,71 @@ +--- +title: messages.getStickers +description: Get stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getStickers +[Back to methods index](index.md) + + +Get stickers + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[string](../types/string.md) | Yes|Search by emoji| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched stickers, or []);| + + +### Return type: [messages\_Stickers](../types/messages_Stickers.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Stickers = $MadelineProto->messages->getStickers(['emoticon' => 'string', 'hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.getStickers +* params - `{"emoticon": "string", "hash": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getStickers` + +Parameters: + +emoticon - Json encoded string + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_Stickers = messages.getStickers({emoticon='string', hash=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v81/methods/messages_getUnreadMentions.md new file mode 100644 index 00000000..88e895e4 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getUnreadMentions.md @@ -0,0 +1,81 @@ +--- +title: messages.getUnreadMentions +description: Get unread mentions +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getUnreadMentions +[Back to methods index](index.md) + + +Get unread mentions + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| +|offset\_id|[int](../types/int.md) | Yes|The offset| +|add\_offset|[int](../types/int.md) | Yes|The additional offset| +|limit|[int](../types/int.md) | Yes|The number of results to fetch| +|max\_id|[int](../types/int.md) | Yes|The maximum message ID to fetch| +|min\_id|[int](../types/int.md) | Yes|The minumum message ID to fetch| + + +### Return type: [messages\_Messages](../types/messages_Messages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Messages = $MadelineProto->messages->getUnreadMentions(['peer' => InputPeer, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getUnreadMentions` + +Parameters: + +peer - Json encoded InputPeer + +offset_id - Json encoded int + +add_offset - Json encoded int + +limit - Json encoded int + +max_id - Json encoded int + +min_id - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_Messages = messages.getUnreadMentions({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_getWebPage.md b/old_docs/API_docs_v81/methods/messages_getWebPage.md new file mode 100644 index 00000000..507708f7 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getWebPage.md @@ -0,0 +1,69 @@ +--- +title: messages.getWebPage +description: Get webpage preview +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getWebPage +[Back to methods index](index.md) + + +Get webpage preview + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL| +|hash|[int](../types/int.md) | Yes|0 or $result['hash']| + + +### Return type: [WebPage](../types/WebPage.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$WebPage = $MadelineProto->messages->getWebPage(['url' => 'string', 'hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getWebPage` + +Parameters: + +url - Json encoded string + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +WebPage = messages.getWebPage({url='string', hash=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v81/methods/messages_getWebPagePreview.md new file mode 100644 index 00000000..21652a7b --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_getWebPagePreview.md @@ -0,0 +1,97 @@ +--- +title: messages.getWebPagePreview +description: Get webpage preview +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.getWebPagePreview +[Back to methods index](index.md) + + +Get webpage preview + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[string](../types/string.md) | Yes|Extract preview from this message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| +|parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| + + +### Return type: [MessageMedia](../types/MessageMedia.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$MessageMedia = $MadelineProto->messages->getWebPagePreview(['message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getWebPagePreview` + +Parameters: + +parse_mode - string + + + +Or, if you're into Lua: + +``` +MessageMedia = messages.getWebPagePreview({message='string', entities={MessageEntity}, parse_mode='string', }) +``` + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [MessageMedia](../types/MessageMedia.md) will be returned instead. + + + +## Usage of parse_mode: + +Set parse_mode to html to enable HTML parsing of the message. + +Set parse_mode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +``` +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +inline fixed-width code +
pre-formatted fixed-width code block
+URL +Mention by username +Mention by user id +
Pre tags can have a language attribute
+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +``` +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). diff --git a/old_docs/API_docs_v81/methods/messages_hideReportSpam.md b/old_docs/API_docs_v81/methods/messages_hideReportSpam.md new file mode 100644 index 00000000..f5965c44 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_hideReportSpam.md @@ -0,0 +1,66 @@ +--- +title: messages.hideReportSpam +description: Hide report spam popup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.hideReportSpam +[Back to methods index](index.md) + + +Hide report spam popup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->hideReportSpam(['peer' => InputPeer, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.hideReportSpam` + +Parameters: + +peer - Json encoded InputPeer + + + + +Or, if you're into Lua: + +``` +Bool = messages.hideReportSpam({peer=InputPeer, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_importChatInvite.md b/old_docs/API_docs_v81/methods/messages_importChatInvite.md new file mode 100644 index 00000000..475d619e --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_importChatInvite.md @@ -0,0 +1,72 @@ +--- +title: messages.importChatInvite +description: Import chat invite +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.importChatInvite +[Back to methods index](index.md) + + +Import chat invite + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->importChatInvite(['hash' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.importChatInvite` + +Parameters: + +hash - Json encoded string + + + + +Or, if you're into Lua: + +``` +Updates = messages.importChatInvite({hash='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|INVITE_HASH_EMPTY|The invite hash is empty| +|INVITE_HASH_EXPIRED|The invite link has expired| +|INVITE_HASH_INVALID|The invite hash is invalid| +|USER_ALREADY_PARTICIPANT|The user is already in the group| +|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v81/methods/messages_installStickerSet.md b/old_docs/API_docs_v81/methods/messages_installStickerSet.md new file mode 100644 index 00000000..162278ba --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_installStickerSet.md @@ -0,0 +1,69 @@ +--- +title: messages.installStickerSet +description: Add a sticker set +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.installStickerSet +[Back to methods index](index.md) + + +Add a sticker set + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| + + +### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_StickerSetInstallResult = $MadelineProto->messages->installStickerSet(['stickerset' => InputStickerSet, 'archived' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.installStickerSet` + +Parameters: + +stickerset - Json encoded InputStickerSet + +archived - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +messages_StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_migrateChat.md b/old_docs/API_docs_v81/methods/messages_migrateChat.md new file mode 100644 index 00000000..243124d9 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_migrateChat.md @@ -0,0 +1,68 @@ +--- +title: messages.migrateChat +description: Convert chat to supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.migrateChat +[Back to methods index](index.md) + + +Convert chat to supergroup + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->migrateChat(['chat_id' => InputPeer, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.migrateChat` + +Parameters: + +chat_id - Json encoded InputPeer + + + + +Or, if you're into Lua: + +``` +Updates = messages.migrateChat({chat_id=InputPeer, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v81/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v81/methods/messages_readEncryptedHistory.md new file mode 100644 index 00000000..60a73d27 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_readEncryptedHistory.md @@ -0,0 +1,78 @@ +--- +title: messages.readEncryptedHistory +description: Mark messages as read in secret chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.readEncryptedHistory +[Back to methods index](index.md) + + +Mark messages as read in secret chats + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->readEncryptedHistory(['peer' => InputEncryptedChat, 'max_date' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.readEncryptedHistory +* params - `{"peer": InputEncryptedChat, "max_date": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.readEncryptedHistory` + +Parameters: + +peer - Json encoded InputEncryptedChat + +max_date - Json encoded int + + + + +Or, if you're into Lua: + +``` +Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v81/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v81/methods/messages_readFeaturedStickers.md new file mode 100644 index 00000000..5bb44041 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_readFeaturedStickers.md @@ -0,0 +1,59 @@ +--- +title: messages.readFeaturedStickers +description: Mark new featured stickers as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.readFeaturedStickers +[Back to methods index](index.md) + + +Mark new featured stickers as read + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->readFeaturedStickers(['id' => [long, long], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.readFeaturedStickers` + +Parameters: + +id - Json encoded array of long + + + + +Or, if you're into Lua: + +``` +Bool = messages.readFeaturedStickers({id={long}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_readHistory.md b/old_docs/API_docs_v81/methods/messages_readHistory.md new file mode 100644 index 00000000..8c7dfd3a --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_readHistory.md @@ -0,0 +1,70 @@ +--- +title: messages.readHistory +description: Mark messages as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.readHistory +[Back to methods index](index.md) + + +Mark messages as read + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| +|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| + + +### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_AffectedMessages = $MadelineProto->messages->readHistory(['peer' => InputPeer, 'max_id' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.readHistory` + +Parameters: + +peer - Json encoded InputPeer + +max_id - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_readMentions.md b/old_docs/API_docs_v81/methods/messages_readMentions.md new file mode 100644 index 00000000..c58cb06a --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_readMentions.md @@ -0,0 +1,68 @@ +--- +title: messages.readMentions +description: Mark mentions as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.readMentions +[Back to methods index](index.md) + + +Mark mentions as read + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| + + +### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_AffectedHistory = $MadelineProto->messages->readMentions(['peer' => InputPeer, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.readMentions +* params - `{"peer": InputPeer, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.readMentions` + +Parameters: + +peer - Json encoded InputPeer + + + + +Or, if you're into Lua: + +``` +messages_AffectedHistory = messages.readMentions({peer=InputPeer, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_readMessageContents.md b/old_docs/API_docs_v81/methods/messages_readMessageContents.md new file mode 100644 index 00000000..905fc166 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_readMessageContents.md @@ -0,0 +1,59 @@ +--- +title: messages.readMessageContents +description: Mark message as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.readMessageContents +[Back to methods index](index.md) + + +Mark message as read + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| + + +### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_AffectedMessages = $MadelineProto->messages->readMessageContents(['id' => [int, int], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.readMessageContents` + +Parameters: + +id - Json encoded array of int + + + + +Or, if you're into Lua: + +``` +messages_AffectedMessages = messages.readMessageContents({id={int}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_receivedMessages.md b/old_docs/API_docs_v81/methods/messages_receivedMessages.md new file mode 100644 index 00000000..a0c6f5e6 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_receivedMessages.md @@ -0,0 +1,59 @@ +--- +title: messages.receivedMessages +description: Mark messages as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.receivedMessages +[Back to methods index](index.md) + + +Mark messages as read + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| + + +### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_ReceivedNotifyMessage = $MadelineProto->messages->receivedMessages(['max_id' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedMessages` + +Parameters: + +max_id - Json encoded int + + + + +Or, if you're into Lua: + +``` +Vector_of_ReceivedNotifyMessage = messages.receivedMessages({max_id=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_receivedQueue.md b/old_docs/API_docs_v81/methods/messages_receivedQueue.md new file mode 100644 index 00000000..97b1aae8 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_receivedQueue.md @@ -0,0 +1,14 @@ +--- +title: messages.receivedQueue +description: You cannot use this method directly +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.receivedQueue +[Back to methods index](index.md) + + +**You cannot use this method directly** + + + + diff --git a/old_docs/API_docs_v81/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v81/methods/messages_reorderPinnedDialogs.md new file mode 100644 index 00000000..d6a517d2 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_reorderPinnedDialogs.md @@ -0,0 +1,69 @@ +--- +title: messages.reorderPinnedDialogs +description: Reorder pinned dialogs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.reorderPinnedDialogs +[Back to methods index](index.md) + + +Reorder pinned dialogs + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|force|[Bool](../types/Bool.md) | Optional|Force reordering| +|order|Array of [InputDialogPeer](../types/InputDialogPeer.md) | Yes|New order| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->reorderPinnedDialogs(['force' => Bool, 'order' => [InputDialogPeer, InputDialogPeer], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.reorderPinnedDialogs` + +Parameters: + +force - Json encoded Bool + +order - Json encoded array of InputDialogPeer + + + + +Or, if you're into Lua: + +``` +Bool = messages.reorderPinnedDialogs({force=Bool, order={InputDialogPeer}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v81/methods/messages_reorderStickerSets.md new file mode 100644 index 00000000..5ef52708 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_reorderStickerSets.md @@ -0,0 +1,62 @@ +--- +title: messages.reorderStickerSets +description: Reorder sticker sets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.reorderStickerSets +[Back to methods index](index.md) + + +Reorder sticker sets + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [long](../types/long.md) | Yes|The order| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->reorderStickerSets(['masks' => Bool, 'order' => [long, long], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.reorderStickerSets` + +Parameters: + +masks - Json encoded Bool + +order - Json encoded array of long + + + + +Or, if you're into Lua: + +``` +Bool = messages.reorderStickerSets({masks=Bool, order={long}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_report.md b/old_docs/API_docs_v81/methods/messages_report.md new file mode 100644 index 00000000..f10246ed --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_report.md @@ -0,0 +1,74 @@ +--- +title: messages.report +description: Report a message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.report +[Back to methods index](index.md) + + +Report a message + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The user that sent the messages| +|id|Array of [int](../types/int.md) | Yes|The messages to report| +|reason|[ReportReason](../types/ReportReason.md) | Yes|The reason why you're sending this report| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->report(['peer' => InputPeer, 'id' => [int, int], 'reason' => ReportReason, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.report +* params - `{"peer": InputPeer, "id": [int], "reason": ReportReason, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.report` + +Parameters: + +peer - Json encoded InputPeer + +id - Json encoded array of int + +reason - Json encoded ReportReason + + + + +Or, if you're into Lua: + +``` +Bool = messages.report({peer=InputPeer, id={int}, reason=ReportReason, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v81/methods/messages_reportEncryptedSpam.md new file mode 100644 index 00000000..e3b9f626 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_reportEncryptedSpam.md @@ -0,0 +1,66 @@ +--- +title: messages.reportEncryptedSpam +description: Report for spam a secret chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.reportEncryptedSpam +[Back to methods index](index.md) + + +Report for spam a secret chat + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->reportEncryptedSpam(['peer' => InputEncryptedChat, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.reportEncryptedSpam` + +Parameters: + +peer - Json encoded InputEncryptedChat + + + + +Or, if you're into Lua: + +``` +Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_reportSpam.md b/old_docs/API_docs_v81/methods/messages_reportSpam.md new file mode 100644 index 00000000..9ff07f9e --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_reportSpam.md @@ -0,0 +1,66 @@ +--- +title: messages.reportSpam +description: Report a peer for spam +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.reportSpam +[Back to methods index](index.md) + + +Report a peer for spam + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->reportSpam(['peer' => InputPeer, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.reportSpam` + +Parameters: + +peer - Json encoded InputPeer + + + + +Or, if you're into Lua: + +``` +Bool = messages.reportSpam({peer=InputPeer, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_requestEncryption.md b/old_docs/API_docs_v81/methods/messages_requestEncryption.md new file mode 100644 index 00000000..eccf45f3 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_requestEncryption.md @@ -0,0 +1,14 @@ +--- +title: messages.requestEncryption +description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.requestEncryption +[Back to methods index](index.md) + + +**You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats** + + + + diff --git a/old_docs/API_docs_v81/methods/messages_saveDraft.md b/old_docs/API_docs_v81/methods/messages_saveDraft.md new file mode 100644 index 00000000..56b0640c --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_saveDraft.md @@ -0,0 +1,107 @@ +--- +title: messages.saveDraft +description: Save a message draft +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.saveDraft +[Back to methods index](index.md) + + +Save a message draft + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +|parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->saveDraft(['no_webpage' => Bool, 'reply_to_msg_id' => int, 'peer' => InputPeer, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.saveDraft` + +Parameters: + +parse_mode - string + + + +Or, if you're into Lua: + +``` +Bool = messages.saveDraft({no_webpage=Bool, reply_to_msg_id=int, peer=InputPeer, message='string', entities={MessageEntity}, parse_mode='string', }) +``` + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. + + + +## Usage of parse_mode: + +Set parse_mode to html to enable HTML parsing of the message. + +Set parse_mode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +``` +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +inline fixed-width code +
pre-formatted fixed-width code block
+URL +Mention by username +Mention by user id +
Pre tags can have a language attribute
+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +``` +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_saveGif.md b/old_docs/API_docs_v81/methods/messages_saveGif.md new file mode 100644 index 00000000..427069df --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_saveGif.md @@ -0,0 +1,69 @@ +--- +title: messages.saveGif +description: Save a GIF +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.saveGif +[Back to methods index](index.md) + + +Save a GIF + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->saveGif(['id' => InputDocument, 'unsave' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.saveGif` + +Parameters: + +id - Json encoded InputDocument + +unsave - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v81/methods/messages_saveRecentSticker.md new file mode 100644 index 00000000..abfd1f22 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_saveRecentSticker.md @@ -0,0 +1,72 @@ +--- +title: messages.saveRecentSticker +description: Add a sticker to recent stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.saveRecentSticker +[Back to methods index](index.md) + + +Add a sticker to recent stickers + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->saveRecentSticker(['attached' => Bool, 'id' => InputDocument, 'unsave' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.saveRecentSticker` + +Parameters: + +attached - Json encoded Bool + +id - Json encoded InputDocument + +unsave - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_search.md b/old_docs/API_docs_v81/methods/messages_search.md new file mode 100644 index 00000000..e20ba0a3 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_search.md @@ -0,0 +1,105 @@ +--- +title: messages.search +description: Search peers or messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.search +[Back to methods index](index.md) + + +Search peers or messages + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| +|q|[string](../types/string.md) | Yes|What to search| +|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| +|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| +|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| +|offset\_id|[int](../types/int.md) | Yes|Message ID offset| +|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| +|limit|[int](../types/int.md) | Yes|Number of results to return| +|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| +|min\_id|[int](../types/int.md) | Yes|Minumum message id to return| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched messages);| + + +### Return type: [messages\_Messages](../types/messages_Messages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Messages = $MadelineProto->messages->search(['peer' => InputPeer, 'q' => 'string', 'from_id' => InputUser, 'filter' => MessagesFilter, 'min_date' => int, 'max_date' => int, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, 'hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.search` + +Parameters: + +peer - Json encoded InputPeer + +q - Json encoded string + +from_id - Json encoded InputUser + +filter - Json encoded MessagesFilter + +min_date - Json encoded int + +max_date - Json encoded int + +offset_id - Json encoded int + +add_offset - Json encoded int + +limit - Json encoded int + +max_id - Json encoded int + +min_id - Json encoded int + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, filter=MessagesFilter, min_date=int, max_date=int, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, hash=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|PEER_ID_INVALID|The provided peer id is invalid| +|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|SEARCH_QUERY_EMPTY|The search query is empty| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_searchGifs.md b/old_docs/API_docs_v81/methods/messages_searchGifs.md new file mode 100644 index 00000000..72112b7c --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_searchGifs.md @@ -0,0 +1,69 @@ +--- +title: messages.searchGifs +description: Search gifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.searchGifs +[Back to methods index](index.md) + + +Search gifs + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|The search query| +|offset|[int](../types/int.md) | Yes|The offset | + + +### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_FoundGifs = $MadelineProto->messages->searchGifs(['q' => 'string', 'offset' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.searchGifs` + +Parameters: + +q - Json encoded string + +offset - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_FoundGifs = messages.searchGifs({q='string', offset=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v81/methods/messages_searchGlobal.md b/old_docs/API_docs_v81/methods/messages_searchGlobal.md new file mode 100644 index 00000000..75059706 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_searchGlobal.md @@ -0,0 +1,78 @@ +--- +title: messages.searchGlobal +description: Global message search +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.searchGlobal +[Back to methods index](index.md) + + +Global message search + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|The query| +|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[int](../types/int.md) | Yes|The number of results to return| + + +### Return type: [messages\_Messages](../types/messages_Messages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_Messages = $MadelineProto->messages->searchGlobal(['q' => 'string', 'offset_date' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.searchGlobal` + +Parameters: + +q - Json encoded string + +offset_date - Json encoded int + +offset_peer - Json encoded InputPeer + +offset_id - Json encoded int + +limit - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_Messages = messages.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v81/methods/messages_searchStickerSets.md b/old_docs/API_docs_v81/methods/messages_searchStickerSets.md new file mode 100644 index 00000000..aeae2eea --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_searchStickerSets.md @@ -0,0 +1,74 @@ +--- +title: messages.searchStickerSets +description: Find a sticker set +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.searchStickerSets +[Back to methods index](index.md) + + +Find a sticker set + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|exclude\_featured|[Bool](../types/Bool.md) | Optional|Exclude featured sticker sets from the search?| +|q|[string](../types/string.md) | Yes|The search query| +|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously searched stickers, or []);| + + +### Return type: [messages\_FoundStickerSets](../types/messages_FoundStickerSets.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_FoundStickerSets = $MadelineProto->messages->searchStickerSets(['exclude_featured' => Bool, 'q' => 'string', 'hash' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.searchStickerSets +* params - `{"exclude_featured": Bool, "q": "string", "hash": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.searchStickerSets` + +Parameters: + +exclude_featured - Json encoded Bool + +q - Json encoded string + +hash - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_FoundStickerSets = messages.searchStickerSets({exclude_featured=Bool, q='string', hash=int, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_sendEncrypted.md b/old_docs/API_docs_v81/methods/messages_sendEncrypted.md new file mode 100644 index 00000000..60e39273 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_sendEncrypted.md @@ -0,0 +1,87 @@ +--- +title: messages.sendEncrypted +description: Send message to secret chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.sendEncrypted +[Back to methods index](index.md) + + +Send message to secret chat + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| + + +### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_SentEncryptedMessage = $MadelineProto->messages->sendEncrypted(['peer' => InputEncryptedChat, 'message' => DecryptedMessage, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.sendEncrypted +* params - `{"peer": InputEncryptedChat, "message": DecryptedMessage, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.sendEncrypted` + +Parameters: + +peer - Json encoded InputEncryptedChat + +message - Json encoded DecryptedMessage + + + + +Or, if you're into Lua: + +``` +messages_SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, message=DecryptedMessage, }) +``` + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v81/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v81/methods/messages_sendEncryptedFile.md new file mode 100644 index 00000000..b19fb862 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_sendEncryptedFile.md @@ -0,0 +1,87 @@ +--- +title: messages.sendEncryptedFile +description: Send a file to a secret chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.sendEncryptedFile +[Back to methods index](index.md) + + +Send a file to a secret chat + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| + + +### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_SentEncryptedMessage = $MadelineProto->messages->sendEncryptedFile(['peer' => InputEncryptedChat, 'message' => DecryptedMessage, 'file' => InputEncryptedFile, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.sendEncryptedFile +* params - `{"peer": InputEncryptedChat, "message": DecryptedMessage, "file": InputEncryptedFile, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.sendEncryptedFile` + +Parameters: + +peer - Json encoded InputEncryptedChat + +message - Json encoded DecryptedMessage + +file - Json encoded InputEncryptedFile + + + + +Or, if you're into Lua: + +``` +messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedChat, message=DecryptedMessage, file=InputEncryptedFile, }) +``` + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v81/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v81/methods/messages_sendEncryptedService.md new file mode 100644 index 00000000..3d0e1507 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_sendEncryptedService.md @@ -0,0 +1,87 @@ +--- +title: messages.sendEncryptedService +description: Send a service message to a secret chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.sendEncryptedService +[Back to methods index](index.md) + + +Send a service message to a secret chat + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| + + +### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_SentEncryptedMessage = $MadelineProto->messages->sendEncryptedService(['peer' => InputEncryptedChat, 'message' => DecryptedMessage, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.sendEncryptedService +* params - `{"peer": InputEncryptedChat, "message": DecryptedMessage, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.sendEncryptedService` + +Parameters: + +peer - Json encoded InputEncryptedChat + +message - Json encoded DecryptedMessage + + + + +Or, if you're into Lua: + +``` +messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncryptedChat, message=DecryptedMessage, }) +``` + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead. + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid| +|ENCRYPTION_DECLINED|The secret chat was declined| +|MSG_WAIT_FAILED|A waiting call returned an error| +|USER_IS_BLOCKED|User is blocked| + + diff --git a/old_docs/API_docs_v81/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v81/methods/messages_sendInlineBotResult.md new file mode 100644 index 00000000..354855a0 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_sendInlineBotResult.md @@ -0,0 +1,89 @@ +--- +title: messages.sendInlineBotResult +description: Send inline bot result obtained with messages.getInlineBotResults to the chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.sendInlineBotResult +[Back to methods index](index.md) + + +Send inline bot result obtained with messages.getInlineBotResults to the chat + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[long](../types/long.md) | Yes|The inline query ID| +|id|[string](../types/string.md) | Yes|The ID of one of the inline results| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->sendInlineBotResult(['silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'query_id' => long, 'id' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.sendInlineBotResult` + +Parameters: + +silent - Json encoded Bool + +background - Json encoded Bool + +clear_draft - Json encoded Bool + +peer - Json encoded InputPeer + +reply_to_msg_id - Json encoded int + +query_id - Json encoded long + +id - Json encoded string + + + + +Or, if you're into Lua: + +``` +Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired| +|PEER_ID_INVALID|The provided peer id is invalid| +|QUERY_ID_EMPTY|The query ID is empty| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v81/methods/messages_sendMedia.md b/old_docs/API_docs_v81/methods/messages_sendMedia.md new file mode 100644 index 00000000..a795c5d1 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_sendMedia.md @@ -0,0 +1,147 @@ +--- +title: messages.sendMedia +description: Send a media +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.sendMedia +[Back to methods index](index.md) + + +Send a media + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| +|message|[string](../types/string.md) | Yes|The caption| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| +|parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->sendMedia(['silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'media' => InputMedia, 'message' => 'string', 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.sendMedia +* params - `{"silent": Bool, "background": Bool, "clear_draft": Bool, "peer": InputPeer, "reply_to_msg_id": int, "media": InputMedia, "message": "string", "reply_markup": ReplyMarkup, "entities": [MessageEntity], "parse_mode": "string"}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.sendMedia` + +Parameters: + +parse_mode - string + + + +Or, if you're into Lua: + +``` +Updates = messages.sendMedia({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, media=InputMedia, message='string', reply_markup=ReplyMarkup, entities={MessageEntity}, parse_mode='string', }) +``` + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Updates](../types/Updates.md) will be returned instead. + + + +## Usage of parse_mode: + +Set parse_mode to html to enable HTML parsing of the message. + +Set parse_mode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +``` +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +inline fixed-width code +
pre-formatted fixed-width code block
+URL +Mention by username +Mention by user id +
Pre tags can have a language attribute
+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +``` +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|EXTERNAL_URL_INVALID|External URL invalid| +|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|MEDIA_EMPTY|The provided media object is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|STORAGE_CHECK_FAILED|Server storage check failed| +|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_sendMessage.md b/old_docs/API_docs_v81/methods/messages_sendMessage.md new file mode 100644 index 00000000..668d3d4b --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_sendMessage.md @@ -0,0 +1,147 @@ +--- +title: messages.sendMessage +description: Send a message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.sendMessage +[Back to methods index](index.md) + + +Send a message + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|message|[string](../types/string.md) | Yes|The message to send| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +|parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->sendMessage(['no_webpage' => Bool, 'silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'message' => 'string', 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.sendMessage +* params - `{"no_webpage": Bool, "silent": Bool, "background": Bool, "clear_draft": Bool, "peer": InputPeer, "reply_to_msg_id": int, "message": "string", "reply_markup": ReplyMarkup, "entities": [MessageEntity], "parse_mode": "string"}` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.sendMessage` + +Parameters: + +parse_mode - string + + + +Or, if you're into Lua: + +``` +Updates = messages.sendMessage({no_webpage=Bool, silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, message='string', reply_markup=ReplyMarkup, entities={MessageEntity}, parse_mode='string', }) +``` + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Updates](../types/Updates.md) will be returned instead. + + + +## Usage of parse_mode: + +Set parse_mode to html to enable HTML parsing of the message. + +Set parse_mode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +``` +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +inline fixed-width code +
pre-formatted fixed-width code block
+URL +Mention by username +Mention by user id +
Pre tags can have a language attribute
+``` + +You can also use normal markdown, note that to create mentions you must use the `mention:` syntax like in html: + +``` +[Mention by username](mention:@danogentili) +[Mention by user id](mention:186785362) +``` + +MadelineProto supports all html entities supported by [html_entity_decode](http://php.net/manual/en/function.html-entity-decode.php). +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|CHAT_ID_INVALID|The provided chat id is invalid| +|ENTITY_MENTION_USER_INVALID|You can't use this entity| +|INPUT_USER_DEACTIVATED|The specified user was deleted| +|MESSAGE_EMPTY|The provided message is empty| +|MESSAGE_TOO_LONG|The provided message is too long| +|PEER_ID_INVALID|The provided peer id is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|YOU_BLOCKED_USER|You blocked this user| +|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|RANDOM_ID_DUPLICATE|You provided a random ID that was already used| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|tanti SALUTI da peppe lg .|Ciao da un pony| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_sendMultiMedia.md b/old_docs/API_docs_v81/methods/messages_sendMultiMedia.md new file mode 100644 index 00000000..92baa8ab --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_sendMultiMedia.md @@ -0,0 +1,83 @@ +--- +title: messages.sendMultiMedia +description: Send an album +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.sendMultiMedia +[Back to methods index](index.md) + + +Send an album + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[Bool](../types/Bool.md) | Optional|Disable background notification?| +|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the album| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| +|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | Yes|The album| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->sendMultiMedia(['silent' => Bool, 'background' => Bool, 'clear_draft' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'multi_media' => [InputSingleMedia, InputSingleMedia], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.sendMultiMedia +* params - `{"silent": Bool, "background": Bool, "clear_draft": Bool, "peer": InputPeer, "reply_to_msg_id": int, "multi_media": [InputSingleMedia], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.sendMultiMedia` + +Parameters: + +silent - Json encoded Bool + +background - Json encoded Bool + +clear_draft - Json encoded Bool + +peer - Json encoded InputPeer + +reply_to_msg_id - Json encoded int + +multi_media - Json encoded array of InputSingleMedia + + + + +Or, if you're into Lua: + +``` +Updates = messages.sendMultiMedia({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, multi_media={InputSingleMedia}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v81/methods/messages_sendScreenshotNotification.md new file mode 100644 index 00000000..ac1c1c91 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_sendScreenshotNotification.md @@ -0,0 +1,69 @@ +--- +title: messages.sendScreenshotNotification +description: Send screenshot notification +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.sendScreenshotNotification +[Back to methods index](index.md) + + +Send screenshot notification + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| +|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->sendScreenshotNotification(['peer' => InputPeer, 'reply_to_msg_id' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.sendScreenshotNotification` + +Parameters: + +peer - Json encoded InputPeer + +reply_to_msg_id - Json encoded int + + + + +Or, if you're into Lua: + +``` +Updates = messages.sendScreenshotNotification({peer=InputPeer, reply_to_msg_id=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v81/methods/messages_setBotCallbackAnswer.md new file mode 100644 index 00000000..f0f04b29 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_setBotCallbackAnswer.md @@ -0,0 +1,93 @@ +--- +title: messages.setBotCallbackAnswer +description: Bots only: set the callback answer (after a button was clicked) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.setBotCallbackAnswer +[Back to methods index](index.md) + + +Bots only: set the callback answer (after a button was clicked) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[long](../types/long.md) | Yes|The query ID| +|message|[string](../types/string.md) | Optional|The message| +|url|[string](../types/string.md) | Optional|The URL| +|cache\_time|[int](../types/int.md) | Yes|Cache time| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->setBotCallbackAnswer(['alert' => Bool, 'query_id' => long, 'message' => 'string', 'url' => 'string', 'cache_time' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.setBotCallbackAnswer +* params - `{"alert": Bool, "query_id": long, "message": "string", "url": "string", "cache_time": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.setBotCallbackAnswer` + +Parameters: + +alert - Json encoded Bool + +query_id - Json encoded long + +message - Json encoded string + +url - Json encoded string + +cache_time - Json encoded int + + + + +Or, if you're into Lua: + +``` +Bool = messages.setBotCallbackAnswer({alert=Bool, query_id=long, message='string', url='string', cache_time=int, }) +``` + + +## Return value + +If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [Bool](../types/Bool.md) will be returned instead. + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v81/methods/messages_setBotPrecheckoutResults.md new file mode 100644 index 00000000..6d8e2610 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_setBotPrecheckoutResults.md @@ -0,0 +1,81 @@ +--- +title: messages.setBotPrecheckoutResults +description: Bots only: set precheckout results +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.setBotPrecheckoutResults +[Back to methods index](index.md) + + +Bots only: set precheckout results + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|success|[Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->setBotPrecheckoutResults(['success' => Bool, 'query_id' => long, 'error' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.setBotPrecheckoutResults +* params - `{"success": Bool, "query_id": long, "error": "string", }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.setBotPrecheckoutResults` + +Parameters: + +success - Json encoded Bool + +query_id - Json encoded long + +error - Json encoded string + + + + +Or, if you're into Lua: + +``` +Bool = messages.setBotPrecheckoutResults({success=Bool, query_id=long, error='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ERROR_TEXT_EMPTY|The provided error message is empty| + + diff --git a/old_docs/API_docs_v81/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v81/methods/messages_setBotShippingResults.md new file mode 100644 index 00000000..ea8fec6a --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_setBotShippingResults.md @@ -0,0 +1,81 @@ +--- +title: messages.setBotShippingResults +description: Bots only: set shipping results +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.setBotShippingResults +[Back to methods index](index.md) + + +Bots only: set shipping results + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|error|[string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->setBotShippingResults(['query_id' => long, 'error' => 'string', 'shipping_options' => [ShippingOption, ShippingOption], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.setBotShippingResults +* params - `{"query_id": long, "error": "string", "shipping_options": [ShippingOption], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.setBotShippingResults` + +Parameters: + +query_id - Json encoded long + +error - Json encoded string + +shipping_options - Json encoded array of ShippingOption + + + + +Or, if you're into Lua: + +``` +Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v81/methods/messages_setEncryptedTyping.md new file mode 100644 index 00000000..c3054ea8 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_setEncryptedTyping.md @@ -0,0 +1,69 @@ +--- +title: messages.setEncryptedTyping +description: Send typing notification to secret chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.setEncryptedTyping +[Back to methods index](index.md) + + +Send typing notification to secret chat + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->setEncryptedTyping(['peer' => InputEncryptedChat, 'typing' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.setEncryptedTyping` + +Parameters: + +peer - Json encoded InputEncryptedChat + +typing - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_setGameScore.md b/old_docs/API_docs_v81/methods/messages_setGameScore.md new file mode 100644 index 00000000..22480566 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_setGameScore.md @@ -0,0 +1,91 @@ +--- +title: messages.setGameScore +description: Set the game score +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.setGameScore +[Back to methods index](index.md) + + +Set the game score + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| +|id|[int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[int](../types/int.md) | Yes|The score| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->setGameScore(['edit_message' => Bool, 'force' => Bool, 'peer' => InputPeer, 'id' => int, 'user_id' => InputUser, 'score' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.setGameScore +* params - `{"edit_message": Bool, "force": Bool, "peer": InputPeer, "id": int, "user_id": InputUser, "score": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.setGameScore` + +Parameters: + +edit_message - Json encoded Bool + +force - Json encoded Bool + +peer - Json encoded InputPeer + +id - Json encoded int + +user_id - Json encoded InputUser + +score - Json encoded int + + + + +Or, if you're into Lua: + +``` +Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v81/methods/messages_setInlineBotResults.md new file mode 100644 index 00000000..2611c3e8 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_setInlineBotResults.md @@ -0,0 +1,103 @@ +--- +title: messages.setInlineBotResults +description: Bots only: set the results of an inline query +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.setInlineBotResults +[Back to methods index](index.md) + + +Bots only: set the results of an inline query + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Cache time| +|next\_offset|[string](../types/string.md) | Optional|The next offset| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->setInlineBotResults(['gallery' => Bool, 'private' => Bool, 'query_id' => long, 'results' => [InputBotInlineResult, InputBotInlineResult], 'cache_time' => int, 'next_offset' => 'string', 'switch_pm' => InlineBotSwitchPM, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.setInlineBotResults +* params - `{"gallery": Bool, "private": Bool, "query_id": long, "results": [InputBotInlineResult], "cache_time": int, "next_offset": "string", "switch_pm": InlineBotSwitchPM, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.setInlineBotResults` + +Parameters: + +gallery - Json encoded Bool + +private - Json encoded Bool + +query_id - Json encoded long + +results - Json encoded array of InputBotInlineResult + +cache_time - Json encoded int + +next_offset - Json encoded string + +switch_pm - Json encoded InlineBotSwitchPM + + + + +Or, if you're into Lua: + +``` +Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|BUTTON_DATA_INVALID|The provided button data is invalid| +|BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid| +|BUTTON_URL_INVALID|Button URL invalid| +|MESSAGE_EMPTY|The provided message is empty| +|QUERY_ID_INVALID|The query ID is invalid| +|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|RESULT_TYPE_INVALID|Result type invalid| +|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|START_PARAM_INVALID|Start parameter invalid| +|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v81/methods/messages_setInlineGameScore.md new file mode 100644 index 00000000..32af7c16 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_setInlineGameScore.md @@ -0,0 +1,88 @@ +--- +title: messages.setInlineGameScore +description: Set the game score of an inline message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.setInlineGameScore +[Back to methods index](index.md) + + +Set the game score of an inline message + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[int](../types/int.md) | Yes|The score| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->setInlineGameScore(['edit_message' => Bool, 'force' => Bool, 'id' => InputBotInlineMessageID, 'user_id' => InputUser, 'score' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.setInlineGameScore +* params - `{"edit_message": Bool, "force": Bool, "id": InputBotInlineMessageID, "user_id": InputUser, "score": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.setInlineGameScore` + +Parameters: + +edit_message - Json encoded Bool + +force - Json encoded Bool + +id - Json encoded InputBotInlineMessageID + +user_id - Json encoded InputUser + +score - Json encoded int + + + + +Or, if you're into Lua: + +``` +Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| +|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v81/methods/messages_setTyping.md b/old_docs/API_docs_v81/methods/messages_setTyping.md new file mode 100644 index 00000000..3abdcf5b --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_setTyping.md @@ -0,0 +1,85 @@ +--- +title: messages.setTyping +description: Change typing status +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.setTyping +[Back to methods index](index.md) + + +Change typing status + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->setTyping(['peer' => InputPeer, 'action' => SendMessageAction, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.setTyping +* params - `{"peer": InputPeer, "action": SendMessageAction, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.setTyping` + +Parameters: + +peer - Json encoded InputPeer + +action - Json encoded SendMessageAction + + + + +Or, if you're into Lua: + +``` +Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_INVALID|The provided channel is invalid| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|CHAT_ID_INVALID|The provided chat id is invalid| +|PEER_ID_INVALID|The provided peer id is invalid| +|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|USER_IS_BLOCKED|User is blocked| +|USER_IS_BOT|Bots can't send messages to other bots| +|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v81/methods/messages_startBot.md b/old_docs/API_docs_v81/methods/messages_startBot.md new file mode 100644 index 00000000..9f450c72 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_startBot.md @@ -0,0 +1,75 @@ +--- +title: messages.startBot +description: Start a bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.startBot +[Back to methods index](index.md) + + +Start a bot + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->startBot(['bot' => InputUser, 'peer' => InputPeer, 'start_param' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.startBot` + +Parameters: + +bot - Json encoded InputUser + +peer - Json encoded InputPeer + +start_param - Json encoded string + + + + +Or, if you're into Lua: + +``` +Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INVALID|This is not a valid bot| +|PEER_ID_INVALID|The provided peer id is invalid| +|START_PARAM_EMPTY|The start parameter is empty| +|START_PARAM_INVALID|Start parameter invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v81/methods/messages_toggleChatAdmins.md new file mode 100644 index 00000000..676b7f3b --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_toggleChatAdmins.md @@ -0,0 +1,70 @@ +--- +title: messages.toggleChatAdmins +description: Enable all users are admins in normal groups (not supergroups) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.toggleChatAdmins +[Back to methods index](index.md) + + +Enable all users are admins in normal groups (not supergroups) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->messages->toggleChatAdmins(['chat_id' => InputPeer, 'enabled' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.toggleChatAdmins` + +Parameters: + +chat_id - Json encoded InputPeer + +enabled - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Updates = messages.toggleChatAdmins({chat_id=InputPeer, enabled=Bool, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid| +|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v81/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v81/methods/messages_toggleDialogPin.md new file mode 100644 index 00000000..45c628d9 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_toggleDialogPin.md @@ -0,0 +1,69 @@ +--- +title: messages.toggleDialogPin +description: Pin or unpin dialog +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.toggleDialogPin +[Back to methods index](index.md) + + +Pin or unpin dialog + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|peer|[InputDialogPeer](../types/InputDialogPeer.md) | Yes|The dialog to pin| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->toggleDialogPin(['pinned' => Bool, 'peer' => InputDialogPeer, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.toggleDialogPin` + +Parameters: + +pinned - Json encoded Bool + +peer - Json encoded InputDialogPeer + + + + +Or, if you're into Lua: + +``` +Bool = messages.toggleDialogPin({pinned=Bool, peer=InputDialogPeer, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v81/methods/messages_uninstallStickerSet.md new file mode 100644 index 00000000..d888ab55 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_uninstallStickerSet.md @@ -0,0 +1,66 @@ +--- +title: messages.uninstallStickerSet +description: Remove a sticker set +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.uninstallStickerSet +[Back to methods index](index.md) + + +Remove a sticker set + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->messages->uninstallStickerSet(['stickerset' => InputStickerSet, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.uninstallStickerSet` + +Parameters: + +stickerset - Json encoded InputStickerSet + + + + +Or, if you're into Lua: + +``` +Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v81/methods/messages_uploadEncryptedFile.md b/old_docs/API_docs_v81/methods/messages_uploadEncryptedFile.md new file mode 100644 index 00000000..abb08479 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_uploadEncryptedFile.md @@ -0,0 +1,71 @@ +--- +title: messages.uploadEncryptedFile +description: Upload a secret chat file without sending it to anyone +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.uploadEncryptedFile +[Back to methods index](index.md) + + +Upload a secret chat file without sending it to anyone + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to upload the media| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file| + + +### Return type: [EncryptedFile](../types/EncryptedFile.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$EncryptedFile = $MadelineProto->messages->uploadEncryptedFile(['peer' => InputEncryptedChat, 'file' => InputEncryptedFile, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.uploadEncryptedFile +* params - `{"peer": InputEncryptedChat, "file": InputEncryptedFile, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.uploadEncryptedFile` + +Parameters: + +peer - Json encoded InputEncryptedChat + +file - Json encoded InputEncryptedFile + + + + +Or, if you're into Lua: + +``` +EncryptedFile = messages.uploadEncryptedFile({peer=InputEncryptedChat, file=InputEncryptedFile, }) +``` + diff --git a/old_docs/API_docs_v81/methods/messages_uploadMedia.md b/old_docs/API_docs_v81/methods/messages_uploadMedia.md new file mode 100644 index 00000000..8013f434 --- /dev/null +++ b/old_docs/API_docs_v81/methods/messages_uploadMedia.md @@ -0,0 +1,80 @@ +--- +title: messages.uploadMedia +description: Upload a file without sending it to anyone +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: messages.uploadMedia +[Back to methods index](index.md) + + +Upload a file without sending it to anyone + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| + + +### Return type: [MessageMedia](../types/MessageMedia.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$MessageMedia = $MadelineProto->messages->uploadMedia(['peer' => InputPeer, 'media' => InputMedia, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - messages.uploadMedia +* params - `{"peer": InputPeer, "media": InputMedia, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.uploadMedia` + +Parameters: + +peer - Json encoded InputPeer + +media - Json encoded InputMedia + + + + +Or, if you're into Lua: + +``` +MessageMedia = messages.uploadMedia({peer=InputPeer, media=InputMedia, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|MEDIA_INVALID|Media invalid| +|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v81/methods/payments_clearSavedInfo.md new file mode 100644 index 00000000..2af9639f --- /dev/null +++ b/old_docs/API_docs_v81/methods/payments_clearSavedInfo.md @@ -0,0 +1,62 @@ +--- +title: payments.clearSavedInfo +description: Clear saved payments info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: payments.clearSavedInfo +[Back to methods index](index.md) + + +Clear saved payments info + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->payments->clearSavedInfo(['credentials' => Bool, 'info' => Bool, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/payments.clearSavedInfo` + +Parameters: + +credentials - Json encoded Bool + +info - Json encoded Bool + + + + +Or, if you're into Lua: + +``` +Bool = payments.clearSavedInfo({credentials=Bool, info=Bool, }) +``` + diff --git a/old_docs/API_docs_v81/methods/payments_getPaymentForm.md b/old_docs/API_docs_v81/methods/payments_getPaymentForm.md new file mode 100644 index 00000000..52ea573e --- /dev/null +++ b/old_docs/API_docs_v81/methods/payments_getPaymentForm.md @@ -0,0 +1,66 @@ +--- +title: payments.getPaymentForm +description: Get payment form +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: payments.getPaymentForm +[Back to methods index](index.md) + + +Get payment form + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[int](../types/int.md) | Yes|Message ID| + + +### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$payments_PaymentForm = $MadelineProto->payments->getPaymentForm(['msg_id' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/payments.getPaymentForm` + +Parameters: + +msg_id - Json encoded int + + + + +Or, if you're into Lua: + +``` +payments_PaymentForm = payments.getPaymentForm({msg_id=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v81/methods/payments_getPaymentReceipt.md new file mode 100644 index 00000000..4c21b97d --- /dev/null +++ b/old_docs/API_docs_v81/methods/payments_getPaymentReceipt.md @@ -0,0 +1,66 @@ +--- +title: payments.getPaymentReceipt +description: Get payment receipt +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: payments.getPaymentReceipt +[Back to methods index](index.md) + + +Get payment receipt + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[int](../types/int.md) | Yes|The message ID| + + +### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$payments_PaymentReceipt = $MadelineProto->payments->getPaymentReceipt(['msg_id' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/payments.getPaymentReceipt` + +Parameters: + +msg_id - Json encoded int + + + + +Or, if you're into Lua: + +``` +payments_PaymentReceipt = payments.getPaymentReceipt({msg_id=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/payments_getSavedInfo.md b/old_docs/API_docs_v81/methods/payments_getSavedInfo.md new file mode 100644 index 00000000..acaa603f --- /dev/null +++ b/old_docs/API_docs_v81/methods/payments_getSavedInfo.md @@ -0,0 +1,52 @@ +--- +title: payments.getSavedInfo +description: Get saved payments info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: payments.getSavedInfo +[Back to methods index](index.md) + + +Get saved payments info + + + +### Return type: [payments\_SavedInfo](../types/payments_SavedInfo.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$payments_SavedInfo = $MadelineProto->payments->getSavedInfo(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/payments.getSavedInfo` + +Parameters: + + + + +Or, if you're into Lua: + +``` +payments_SavedInfo = payments.getSavedInfo({}) +``` + diff --git a/old_docs/API_docs_v81/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v81/methods/payments_sendPaymentForm.md new file mode 100644 index 00000000..80435dcd --- /dev/null +++ b/old_docs/API_docs_v81/methods/payments_sendPaymentForm.md @@ -0,0 +1,75 @@ +--- +title: payments.sendPaymentForm +description: Bots only: send payment form +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: payments.sendPaymentForm +[Back to methods index](index.md) + + +Bots only: send payment form + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| + + +### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$payments_PaymentResult = $MadelineProto->payments->sendPaymentForm(['msg_id' => int, 'requested_info_id' => 'string', 'shipping_option_id' => 'string', 'credentials' => InputPaymentCredentials, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/payments.sendPaymentForm` + +Parameters: + +msg_id - Json encoded int + +requested_info_id - Json encoded string + +shipping_option_id - Json encoded string + +credentials - Json encoded InputPaymentCredentials + + + + +Or, if you're into Lua: + +``` +payments_PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v81/methods/payments_validateRequestedInfo.md new file mode 100644 index 00000000..f9694b3f --- /dev/null +++ b/old_docs/API_docs_v81/methods/payments_validateRequestedInfo.md @@ -0,0 +1,72 @@ +--- +title: payments.validateRequestedInfo +description: Validate requested payment info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: payments.validateRequestedInfo +[Back to methods index](index.md) + + +Validate requested payment info + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|save|[Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| + + +### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$payments_ValidatedRequestedInfo = $MadelineProto->payments->validateRequestedInfo(['save' => Bool, 'msg_id' => int, 'info' => PaymentRequestedInfo, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/payments.validateRequestedInfo` + +Parameters: + +save - Json encoded Bool + +msg_id - Json encoded int + +info - Json encoded PaymentRequestedInfo + + + + +Or, if you're into Lua: + +``` +payments_ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v81/methods/phone_acceptCall.md b/old_docs/API_docs_v81/methods/phone_acceptCall.md new file mode 100644 index 00000000..b75ac65b --- /dev/null +++ b/old_docs/API_docs_v81/methods/phone_acceptCall.md @@ -0,0 +1,14 @@ +--- +title: phone.acceptCall +description: You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: phone.acceptCall +[Back to methods index](index.md) + + +**You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls** + + + + diff --git a/old_docs/API_docs_v81/methods/phone_confirmCall.md b/old_docs/API_docs_v81/methods/phone_confirmCall.md new file mode 100644 index 00000000..1a75563d --- /dev/null +++ b/old_docs/API_docs_v81/methods/phone_confirmCall.md @@ -0,0 +1,14 @@ +--- +title: phone.confirmCall +description: You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: phone.confirmCall +[Back to methods index](index.md) + + +**You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls** + + + + diff --git a/old_docs/API_docs_v81/methods/phone_discardCall.md b/old_docs/API_docs_v81/methods/phone_discardCall.md new file mode 100644 index 00000000..e50456eb --- /dev/null +++ b/old_docs/API_docs_v81/methods/phone_discardCall.md @@ -0,0 +1,14 @@ +--- +title: phone.discardCall +description: You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: phone.discardCall +[Back to methods index](index.md) + + +**You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls** + + + + diff --git a/old_docs/API_docs_v81/methods/phone_getCallConfig.md b/old_docs/API_docs_v81/methods/phone_getCallConfig.md new file mode 100644 index 00000000..dc8619e8 --- /dev/null +++ b/old_docs/API_docs_v81/methods/phone_getCallConfig.md @@ -0,0 +1,52 @@ +--- +title: phone.getCallConfig +description: Get call configuration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: phone.getCallConfig +[Back to methods index](index.md) + + +Get call configuration + + + +### Return type: [DataJSON](../types/DataJSON.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$DataJSON = $MadelineProto->phone->getCallConfig(); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/phone.getCallConfig` + +Parameters: + + + + +Or, if you're into Lua: + +``` +DataJSON = phone.getCallConfig({}) +``` + diff --git a/old_docs/API_docs_v81/methods/phone_receivedCall.md b/old_docs/API_docs_v81/methods/phone_receivedCall.md new file mode 100644 index 00000000..3482b99f --- /dev/null +++ b/old_docs/API_docs_v81/methods/phone_receivedCall.md @@ -0,0 +1,67 @@ +--- +title: phone.receivedCall +description: Notify server that you received a call (server will refuse all incoming calls until the current call is over) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: phone.receivedCall +[Back to methods index](index.md) + + +Notify server that you received a call (server will refuse all incoming calls until the current call is over) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->phone->receivedCall(['peer' => InputPhoneCall, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/phone.receivedCall` + +Parameters: + +peer - Json encoded InputPhoneCall + + + + +Or, if you're into Lua: + +``` +Bool = phone.receivedCall({peer=InputPhoneCall, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_ALREADY_DECLINED|The call was already declined| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v81/methods/phone_requestCall.md b/old_docs/API_docs_v81/methods/phone_requestCall.md new file mode 100644 index 00000000..9b8df564 --- /dev/null +++ b/old_docs/API_docs_v81/methods/phone_requestCall.md @@ -0,0 +1,14 @@ +--- +title: phone.requestCall +description: You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: phone.requestCall +[Back to methods index](index.md) + + +**You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls** + + + + diff --git a/old_docs/API_docs_v81/methods/phone_saveCallDebug.md b/old_docs/API_docs_v81/methods/phone_saveCallDebug.md new file mode 100644 index 00000000..b8c766c1 --- /dev/null +++ b/old_docs/API_docs_v81/methods/phone_saveCallDebug.md @@ -0,0 +1,70 @@ +--- +title: phone.saveCallDebug +description: Save call debugging info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: phone.saveCallDebug +[Back to methods index](index.md) + + +Save call debugging info + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| +|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->phone->saveCallDebug(['peer' => InputPhoneCall, 'debug' => DataJSON, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/phone.saveCallDebug` + +Parameters: + +peer - Json encoded InputPhoneCall + +debug - Json encoded DataJSON + + + + +Or, if you're into Lua: + +``` +Bool = phone.saveCallDebug({peer=InputPhoneCall, debug=DataJSON, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| +|DATA_JSON_INVALID|The provided JSON data is invalid| + + diff --git a/old_docs/API_docs_v81/methods/phone_setCallRating.md b/old_docs/API_docs_v81/methods/phone_setCallRating.md new file mode 100644 index 00000000..c0ff0c2f --- /dev/null +++ b/old_docs/API_docs_v81/methods/phone_setCallRating.md @@ -0,0 +1,72 @@ +--- +title: phone.setCallRating +description: Set phone call rating +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: phone.setCallRating +[Back to methods index](index.md) + + +Set phone call rating + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| +|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| +|comment|[string](../types/string.md) | Yes|An optional comment| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Updates = $MadelineProto->phone->setCallRating(['peer' => InputPhoneCall, 'rating' => int, 'comment' => 'string', ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/phone.setCallRating` + +Parameters: + +peer - Json encoded InputPhoneCall + +rating - Json encoded int + +comment - Json encoded string + + + + +Or, if you're into Lua: + +``` +Updates = phone.setCallRating({peer=InputPhoneCall, rating=int, comment='string', }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v81/methods/photos_deletePhotos.md b/old_docs/API_docs_v81/methods/photos_deletePhotos.md new file mode 100644 index 00000000..fd8571d2 --- /dev/null +++ b/old_docs/API_docs_v81/methods/photos_deletePhotos.md @@ -0,0 +1,59 @@ +--- +title: photos.deletePhotos +description: Delete profile photos +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: photos.deletePhotos +[Back to methods index](index.md) + + +Delete profile photos + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| + + +### Return type: [Vector\_of\_long](../types/long.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_long = $MadelineProto->photos->deletePhotos(['id' => [InputPhoto, InputPhoto], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/photos.deletePhotos` + +Parameters: + +id - Json encoded array of InputPhoto + + + + +Or, if you're into Lua: + +``` +Vector_of_long = photos.deletePhotos({id={InputPhoto}, }) +``` + diff --git a/old_docs/API_docs_v81/methods/photos_getUserPhotos.md b/old_docs/API_docs_v81/methods/photos_getUserPhotos.md new file mode 100644 index 00000000..189b72e7 --- /dev/null +++ b/old_docs/API_docs_v81/methods/photos_getUserPhotos.md @@ -0,0 +1,85 @@ +--- +title: photos.getUserPhotos +description: Get the profile photos of a user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: photos.getUserPhotos +[Back to methods index](index.md) + + +Get the profile photos of a user + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[int](../types/int.md) | Yes|Offset| +|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[int](../types/int.md) | Yes|Number of photos to return| + + +### Return type: [photos\_Photos](../types/photos_Photos.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$photos_Photos = $MadelineProto->photos->getUserPhotos(['user_id' => InputUser, 'offset' => int, 'max_id' => long, 'limit' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - photos.getUserPhotos +* params - `{"user_id": InputUser, "offset": int, "max_id": long, "limit": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/photos.getUserPhotos` + +Parameters: + +user_id - Json encoded InputUser + +offset - Json encoded int + +max_id - Json encoded long + +limit - Json encoded int + + + + +Or, if you're into Lua: + +``` +photos_Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v81/methods/photos_updateProfilePhoto.md new file mode 100644 index 00000000..24357a4b --- /dev/null +++ b/old_docs/API_docs_v81/methods/photos_updateProfilePhoto.md @@ -0,0 +1,59 @@ +--- +title: photos.updateProfilePhoto +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: photos.updateProfilePhoto +[Back to methods index](index.md) + + +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| + + +### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$UserProfilePhoto = $MadelineProto->photos->updateProfilePhoto(['id' => InputPhoto, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/photos.updateProfilePhoto` + +Parameters: + +id - Json encoded InputPhoto + + + + +Or, if you're into Lua: + +``` +UserProfilePhoto = photos.updateProfilePhoto({id=InputPhoto, }) +``` + diff --git a/old_docs/API_docs_v81/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v81/methods/photos_uploadProfilePhoto.md new file mode 100644 index 00000000..71ba3044 --- /dev/null +++ b/old_docs/API_docs_v81/methods/photos_uploadProfilePhoto.md @@ -0,0 +1,69 @@ +--- +title: photos.uploadProfilePhoto +description: Upload profile photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: photos.uploadProfilePhoto +[Back to methods index](index.md) + + +Upload profile photo + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| + + +### Return type: [photos\_Photo](../types/photos_Photo.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$photos_Photo = $MadelineProto->photos->uploadProfilePhoto(['file' => InputFile, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/photos.uploadProfilePhoto` + +Parameters: + +file - Json encoded InputFile + + + + +Or, if you're into Lua: + +``` +photos_Photo = photos.uploadProfilePhoto({file=InputFile, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| +|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v81/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v81/methods/stickers_addStickerToSet.md new file mode 100644 index 00000000..81605d27 --- /dev/null +++ b/old_docs/API_docs_v81/methods/stickers_addStickerToSet.md @@ -0,0 +1,79 @@ +--- +title: stickers.addStickerToSet +description: Add sticker to stickerset +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: stickers.addStickerToSet +[Back to methods index](index.md) + + +Add sticker to stickerset + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| + + +### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_StickerSet = $MadelineProto->stickers->addStickerToSet(['stickerset' => InputStickerSet, 'sticker' => InputStickerSetItem, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - stickers.addStickerToSet +* params - `{"stickerset": InputStickerSet, "sticker": InputStickerSetItem, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/stickers.addStickerToSet` + +Parameters: + +stickerset - Json encoded InputStickerSet + +sticker - Json encoded InputStickerSetItem + + + + +Or, if you're into Lua: + +``` +messages_StickerSet = stickers.addStickerToSet({stickerset=InputStickerSet, sticker=InputStickerSetItem, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v81/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v81/methods/stickers_changeStickerPosition.md new file mode 100644 index 00000000..df9e344d --- /dev/null +++ b/old_docs/API_docs_v81/methods/stickers_changeStickerPosition.md @@ -0,0 +1,79 @@ +--- +title: stickers.changeStickerPosition +description: Change sticker position in photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: stickers.changeStickerPosition +[Back to methods index](index.md) + + +Change sticker position in photo + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|position|[int](../types/int.md) | Yes|New position| + + +### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_StickerSet = $MadelineProto->stickers->changeStickerPosition(['sticker' => InputDocument, 'position' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - stickers.changeStickerPosition +* params - `{"sticker": InputDocument, "position": int, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/stickers.changeStickerPosition` + +Parameters: + +sticker - Json encoded InputDocument + +position - Json encoded int + + + + +Or, if you're into Lua: + +``` +messages_StickerSet = stickers.changeStickerPosition({sticker=InputDocument, position=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v81/methods/stickers_createStickerSet.md b/old_docs/API_docs_v81/methods/stickers_createStickerSet.md new file mode 100644 index 00000000..3dd60721 --- /dev/null +++ b/old_docs/API_docs_v81/methods/stickers_createStickerSet.md @@ -0,0 +1,95 @@ +--- +title: stickers.createStickerSet +description: Create stickerset +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: stickers.createStickerSet +[Back to methods index](index.md) + + +Create stickerset + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[Bool](../types/Bool.md) | Optional|Masks?| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| +|title|[string](../types/string.md) | Yes|The stickerset title| +|short\_name|[string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| + + +### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_StickerSet = $MadelineProto->stickers->createStickerSet(['masks' => Bool, 'user_id' => InputUser, 'title' => 'string', 'short_name' => 'string', 'stickers' => [InputStickerSetItem, InputStickerSetItem], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - stickers.createStickerSet +* params - `{"masks": Bool, "user_id": InputUser, "title": "string", "short_name": "string", "stickers": [InputStickerSetItem], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/stickers.createStickerSet` + +Parameters: + +masks - Json encoded Bool + +user_id - Json encoded InputUser + +title - Json encoded string + +short_name - Json encoded string + +stickers - Json encoded array of InputStickerSetItem + + + + +Or, if you're into Lua: + +``` +messages_StickerSet = stickers.createStickerSet({masks=Bool, user_id=InputUser, title='string', short_name='string', stickers={InputStickerSetItem}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|PACK_SHORT_NAME_INVALID|Short pack name invalid| +|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| +|PEER_ID_INVALID|The provided peer id is invalid| +|STICKER_EMOJI_INVALID|Sticker emoji invalid| +|STICKER_FILE_INVALID|Sticker file invalid| +|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| +|STICKERS_EMPTY|No sticker provided| +|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v81/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v81/methods/stickers_removeStickerFromSet.md new file mode 100644 index 00000000..e8444adb --- /dev/null +++ b/old_docs/API_docs_v81/methods/stickers_removeStickerFromSet.md @@ -0,0 +1,76 @@ +--- +title: stickers.removeStickerFromSet +description: Remove sticker from stickerset +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: stickers.removeStickerFromSet +[Back to methods index](index.md) + + +Remove sticker from stickerset + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| + + +### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$messages_StickerSet = $MadelineProto->stickers->removeStickerFromSet(['sticker' => InputDocument, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - stickers.removeStickerFromSet +* params - `{"sticker": InputDocument, }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/stickers.removeStickerFromSet` + +Parameters: + +sticker - Json encoded InputDocument + + + + +Or, if you're into Lua: + +``` +messages_StickerSet = stickers.removeStickerFromSet({sticker=InputDocument, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot| +|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v81/methods/updates_getChannelDifference.md b/old_docs/API_docs_v81/methods/updates_getChannelDifference.md new file mode 100644 index 00000000..6fa79529 --- /dev/null +++ b/old_docs/API_docs_v81/methods/updates_getChannelDifference.md @@ -0,0 +1,14 @@ +--- +title: updates.getChannelDifference +description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: updates.getChannelDifference +[Back to methods index](index.md) + + +**You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates** + + + + diff --git a/old_docs/API_docs_v81/methods/updates_getDifference.md b/old_docs/API_docs_v81/methods/updates_getDifference.md new file mode 100644 index 00000000..33e7d7f2 --- /dev/null +++ b/old_docs/API_docs_v81/methods/updates_getDifference.md @@ -0,0 +1,14 @@ +--- +title: updates.getDifference +description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: updates.getDifference +[Back to methods index](index.md) + + +**You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates** + + + + diff --git a/old_docs/API_docs_v81/methods/updates_getState.md b/old_docs/API_docs_v81/methods/updates_getState.md new file mode 100644 index 00000000..f43ba440 --- /dev/null +++ b/old_docs/API_docs_v81/methods/updates_getState.md @@ -0,0 +1,14 @@ +--- +title: updates.getState +description: You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: updates.getState +[Back to methods index](index.md) + + +**You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates** + + + + diff --git a/old_docs/API_docs_v81/methods/upload_getCdnFile.md b/old_docs/API_docs_v81/methods/upload_getCdnFile.md new file mode 100644 index 00000000..5e5b3f43 --- /dev/null +++ b/old_docs/API_docs_v81/methods/upload_getCdnFile.md @@ -0,0 +1,14 @@ +--- +title: upload.getCdnFile +description: You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: upload.getCdnFile +[Back to methods index](index.md) + + +**You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info** + + + + diff --git a/old_docs/API_docs_v81/methods/upload_getCdnFileHashes.md b/old_docs/API_docs_v81/methods/upload_getCdnFileHashes.md new file mode 100644 index 00000000..ea6a8e75 --- /dev/null +++ b/old_docs/API_docs_v81/methods/upload_getCdnFileHashes.md @@ -0,0 +1,14 @@ +--- +title: upload.getCdnFileHashes +description: You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: upload.getCdnFileHashes +[Back to methods index](index.md) + + +**You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info** + + + + diff --git a/old_docs/API_docs_v81/methods/upload_getFile.md b/old_docs/API_docs_v81/methods/upload_getFile.md new file mode 100644 index 00000000..c72e6090 --- /dev/null +++ b/old_docs/API_docs_v81/methods/upload_getFile.md @@ -0,0 +1,14 @@ +--- +title: upload.getFile +description: You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: upload.getFile +[Back to methods index](index.md) + + +**You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info** + + + + diff --git a/old_docs/API_docs_v81/methods/upload_getFileHashes.md b/old_docs/API_docs_v81/methods/upload_getFileHashes.md new file mode 100644 index 00000000..debeb60d --- /dev/null +++ b/old_docs/API_docs_v81/methods/upload_getFileHashes.md @@ -0,0 +1,14 @@ +--- +title: upload.getFileHashes +description: Get file hashes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: upload.getFileHashes +[Back to methods index](index.md) + + +**You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info** + + + + diff --git a/old_docs/API_docs_v81/methods/upload_getWebFile.md b/old_docs/API_docs_v81/methods/upload_getWebFile.md new file mode 100644 index 00000000..18a0955c --- /dev/null +++ b/old_docs/API_docs_v81/methods/upload_getWebFile.md @@ -0,0 +1,72 @@ +--- +title: upload.getWebFile +description: Download a file through telegram +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: upload.getWebFile +[Back to methods index](index.md) + + +Download a file through telegram + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[int](../types/int.md) | Yes|The offset in bytes| +|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| + + +### Return type: [upload\_WebFile](../types/upload_WebFile.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$upload_WebFile = $MadelineProto->upload->getWebFile(['location' => InputWebFileLocation, 'offset' => int, 'limit' => int, ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/upload.getWebFile` + +Parameters: + +location - Json encoded InputWebFileLocation + +offset - Json encoded int + +limit - Json encoded int + + + + +Or, if you're into Lua: + +``` +upload_WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v81/methods/upload_reuploadCdnFile.md b/old_docs/API_docs_v81/methods/upload_reuploadCdnFile.md new file mode 100644 index 00000000..cc20d5e3 --- /dev/null +++ b/old_docs/API_docs_v81/methods/upload_reuploadCdnFile.md @@ -0,0 +1,14 @@ +--- +title: upload.reuploadCdnFile +description: You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: upload.reuploadCdnFile +[Back to methods index](index.md) + + +**You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info** + + + + diff --git a/old_docs/API_docs_v81/methods/upload_saveBigFilePart.md b/old_docs/API_docs_v81/methods/upload_saveBigFilePart.md new file mode 100644 index 00000000..91659f4f --- /dev/null +++ b/old_docs/API_docs_v81/methods/upload_saveBigFilePart.md @@ -0,0 +1,14 @@ +--- +title: upload.saveBigFilePart +description: You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: upload.saveBigFilePart +[Back to methods index](index.md) + + +**You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info** + + + + diff --git a/old_docs/API_docs_v81/methods/upload_saveFilePart.md b/old_docs/API_docs_v81/methods/upload_saveFilePart.md new file mode 100644 index 00000000..f37bcaaf --- /dev/null +++ b/old_docs/API_docs_v81/methods/upload_saveFilePart.md @@ -0,0 +1,14 @@ +--- +title: upload.saveFilePart +description: You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: upload.saveFilePart +[Back to methods index](index.md) + + +**You cannot use this method directly, use the upload, download_to_stream, download_to_file, download_to_dir methods instead; see https://docs.madelineproto.xyz for more info** + + + + diff --git a/old_docs/API_docs_v81/methods/users_getFullUser.md b/old_docs/API_docs_v81/methods/users_getFullUser.md new file mode 100644 index 00000000..4bee704c --- /dev/null +++ b/old_docs/API_docs_v81/methods/users_getFullUser.md @@ -0,0 +1,14 @@ +--- +title: users.getFullUser +description: You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: users.getFullUser +[Back to methods index](index.md) + + +**You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)** + + + + diff --git a/old_docs/API_docs_v81/methods/users_getUsers.md b/old_docs/API_docs_v81/methods/users_getUsers.md new file mode 100644 index 00000000..cb09a74d --- /dev/null +++ b/old_docs/API_docs_v81/methods/users_getUsers.md @@ -0,0 +1,79 @@ +--- +title: users.getUsers +description: Get info about users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: users.getUsers +[Back to methods index](index.md) + + +Get info about users + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| + + +### Return type: [Vector\_of\_User](../types/User.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Vector_of_User = $MadelineProto->users->getUsers(['id' => [InputUser, InputUser], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - users.getUsers +* params - `{"id": [InputUser], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/users.getUsers` + +Parameters: + +id - Json encoded array of InputUser + + + + +Or, if you're into Lua: + +``` +Vector_of_User = users.getUsers({id={InputUser}, }) +``` + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|MEMBER_NO_LOCATION|An internal failure occurred while fetching user info (couldn't find location)| +|NEED_MEMBER_INVALID|The provided member is invalid| +|Timeout|A timeout occurred while fetching data from the bot| + + diff --git a/old_docs/API_docs_v81/methods/users_setSecureValueErrors.md b/old_docs/API_docs_v81/methods/users_setSecureValueErrors.md new file mode 100644 index 00000000..11293a49 --- /dev/null +++ b/old_docs/API_docs_v81/methods/users_setSecureValueErrors.md @@ -0,0 +1,71 @@ +--- +title: users.setSecureValueErrors +description: Set secure value error for telegram passport +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: users.setSecureValueErrors +[Back to methods index](index.md) + + +Set secure value error for telegram passport + +### Parameters: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|errors|Array of [SecureValueError](../types/SecureValueError.md) | Yes|The errors| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example: + + +``` +if (!file_exists('madeline.php')) { + copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); +} +include 'madeline.php'; + +$MadelineProto = new \danog\MadelineProto\API('session.madeline'); +$MadelineProto->start(); + +$Bool = $MadelineProto->users->setSecureValueErrors(['id' => InputUser, 'errors' => [SecureValueError, SecureValueError], ]); +``` + +### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): + +### As a bot: + +POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` + +Parameters: + +* method - users.setSecureValueErrors +* params - `{"id": InputUser, "errors": [SecureValueError], }` + + + +### As a user: + +POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/users.setSecureValueErrors` + +Parameters: + +id - Json encoded InputUser + +errors - Json encoded array of SecureValueError + + + + +Or, if you're into Lua: + +``` +Bool = users.setSecureValueErrors({id=InputUser, errors={SecureValueError}, }) +``` + diff --git a/old_docs/API_docs_v81/types/!X.md b/old_docs/API_docs_v81/types/!X.md new file mode 100644 index 00000000..dc27d5cd --- /dev/null +++ b/old_docs/API_docs_v81/types/!X.md @@ -0,0 +1,9 @@ +--- +title: !X +description: Represents a TL serialized payload +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: !X +[Back to constructor index](index.md) + +Represents a TL serialized payload. diff --git a/old_docs/API_docs_v81/types/AccessPointRule.md b/old_docs/API_docs_v81/types/AccessPointRule.md new file mode 100644 index 00000000..07450b37 --- /dev/null +++ b/old_docs/API_docs_v81/types/AccessPointRule.md @@ -0,0 +1,20 @@ +--- +title: AccessPointRule +description: constructors and methods of type AccessPointRule +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: AccessPointRule +[Back to types index](index.md) + + + +### Possible values (constructors): + +[accessPointRule](../constructors/accessPointRule.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/AccountDaysTTL.md b/old_docs/API_docs_v81/types/AccountDaysTTL.md new file mode 100644 index 00000000..12a10190 --- /dev/null +++ b/old_docs/API_docs_v81/types/AccountDaysTTL.md @@ -0,0 +1,22 @@ +--- +title: AccountDaysTTL +description: constructors and methods of type AccountDaysTTL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: AccountDaysTTL +[Back to types index](index.md) + + + +### Possible values (constructors): + +[accountDaysTTL](../constructors/accountDaysTTL.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getAccountTTL](../methods/account_getAccountTTL.md) + + + diff --git a/old_docs/API_docs_v81/types/Authorization.md b/old_docs/API_docs_v81/types/Authorization.md new file mode 100644 index 00000000..e6760335 --- /dev/null +++ b/old_docs/API_docs_v81/types/Authorization.md @@ -0,0 +1,20 @@ +--- +title: Authorization +description: constructors and methods of type Authorization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Authorization +[Back to types index](index.md) + + + +### Possible values (constructors): + +[authorization](../constructors/authorization.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Bool.md b/old_docs/API_docs_v81/types/Bool.md new file mode 100644 index 00000000..7a1d95ff --- /dev/null +++ b/old_docs/API_docs_v81/types/Bool.md @@ -0,0 +1,9 @@ +--- +title: Bool +description: Represents a boolean. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Bool +[Back to types index](index.md) + +Represents a boolean. diff --git a/old_docs/API_docs_v81/types/BotCommand.md b/old_docs/API_docs_v81/types/BotCommand.md new file mode 100644 index 00000000..759f2b8b --- /dev/null +++ b/old_docs/API_docs_v81/types/BotCommand.md @@ -0,0 +1,20 @@ +--- +title: BotCommand +description: constructors and methods of type BotCommand +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: BotCommand +[Back to types index](index.md) + + + +### Possible values (constructors): + +[botCommand](../constructors/botCommand.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/BotInfo.md b/old_docs/API_docs_v81/types/BotInfo.md new file mode 100644 index 00000000..dc876cb5 --- /dev/null +++ b/old_docs/API_docs_v81/types/BotInfo.md @@ -0,0 +1,20 @@ +--- +title: BotInfo +description: constructors and methods of type BotInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: BotInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[botInfo](../constructors/botInfo.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/BotInlineMessage.md b/old_docs/API_docs_v81/types/BotInlineMessage.md new file mode 100644 index 00000000..bd0da30e --- /dev/null +++ b/old_docs/API_docs_v81/types/BotInlineMessage.md @@ -0,0 +1,28 @@ +--- +title: BotInlineMessage +description: constructors and methods of type BotInlineMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: BotInlineMessage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[botInlineMessageMediaAuto](../constructors/botInlineMessageMediaAuto.md) + +[botInlineMessageText](../constructors/botInlineMessageText.md) + +[botInlineMessageMediaGeo](../constructors/botInlineMessageMediaGeo.md) + +[botInlineMessageMediaVenue](../constructors/botInlineMessageMediaVenue.md) + +[botInlineMessageMediaContact](../constructors/botInlineMessageMediaContact.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/BotInlineResult.md b/old_docs/API_docs_v81/types/BotInlineResult.md new file mode 100644 index 00000000..3d10e416 --- /dev/null +++ b/old_docs/API_docs_v81/types/BotInlineResult.md @@ -0,0 +1,22 @@ +--- +title: BotInlineResult +description: constructors and methods of type BotInlineResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: BotInlineResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[botInlineResult](../constructors/botInlineResult.md) + +[botInlineMediaResult](../constructors/botInlineMediaResult.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/CdnConfig.md b/old_docs/API_docs_v81/types/CdnConfig.md new file mode 100644 index 00000000..fbfe01c3 --- /dev/null +++ b/old_docs/API_docs_v81/types/CdnConfig.md @@ -0,0 +1,22 @@ +--- +title: CdnConfig +description: constructors and methods of type CdnConfig +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: CdnConfig +[Back to types index](index.md) + + + +### Possible values (constructors): + +[cdnConfig](../constructors/cdnConfig.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getCdnConfig](../methods/help_getCdnConfig.md) + + + diff --git a/old_docs/API_docs_v81/types/CdnPublicKey.md b/old_docs/API_docs_v81/types/CdnPublicKey.md new file mode 100644 index 00000000..14df6975 --- /dev/null +++ b/old_docs/API_docs_v81/types/CdnPublicKey.md @@ -0,0 +1,20 @@ +--- +title: CdnPublicKey +description: constructors and methods of type CdnPublicKey +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: CdnPublicKey +[Back to types index](index.md) + + + +### Possible values (constructors): + +[cdnPublicKey](../constructors/cdnPublicKey.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChannelAdminLogEvent.md b/old_docs/API_docs_v81/types/ChannelAdminLogEvent.md new file mode 100644 index 00000000..5cd8d2fd --- /dev/null +++ b/old_docs/API_docs_v81/types/ChannelAdminLogEvent.md @@ -0,0 +1,20 @@ +--- +title: ChannelAdminLogEvent +description: constructors and methods of type ChannelAdminLogEvent +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelAdminLogEvent +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelAdminLogEvent](../constructors/channelAdminLogEvent.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChannelAdminLogEventAction.md b/old_docs/API_docs_v81/types/ChannelAdminLogEventAction.md new file mode 100644 index 00000000..a01b5a83 --- /dev/null +++ b/old_docs/API_docs_v81/types/ChannelAdminLogEventAction.md @@ -0,0 +1,50 @@ +--- +title: ChannelAdminLogEventAction +description: constructors and methods of type ChannelAdminLogEventAction +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelAdminLogEventAction +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelAdminLogEventActionChangeTitle](../constructors/channelAdminLogEventActionChangeTitle.md) + +[channelAdminLogEventActionChangeAbout](../constructors/channelAdminLogEventActionChangeAbout.md) + +[channelAdminLogEventActionChangeUsername](../constructors/channelAdminLogEventActionChangeUsername.md) + +[channelAdminLogEventActionChangePhoto](../constructors/channelAdminLogEventActionChangePhoto.md) + +[channelAdminLogEventActionToggleInvites](../constructors/channelAdminLogEventActionToggleInvites.md) + +[channelAdminLogEventActionToggleSignatures](../constructors/channelAdminLogEventActionToggleSignatures.md) + +[channelAdminLogEventActionUpdatePinned](../constructors/channelAdminLogEventActionUpdatePinned.md) + +[channelAdminLogEventActionEditMessage](../constructors/channelAdminLogEventActionEditMessage.md) + +[channelAdminLogEventActionDeleteMessage](../constructors/channelAdminLogEventActionDeleteMessage.md) + +[channelAdminLogEventActionParticipantJoin](../constructors/channelAdminLogEventActionParticipantJoin.md) + +[channelAdminLogEventActionParticipantLeave](../constructors/channelAdminLogEventActionParticipantLeave.md) + +[channelAdminLogEventActionParticipantInvite](../constructors/channelAdminLogEventActionParticipantInvite.md) + +[channelAdminLogEventActionParticipantToggleBan](../constructors/channelAdminLogEventActionParticipantToggleBan.md) + +[channelAdminLogEventActionParticipantToggleAdmin](../constructors/channelAdminLogEventActionParticipantToggleAdmin.md) + +[channelAdminLogEventActionChangeStickerSet](../constructors/channelAdminLogEventActionChangeStickerSet.md) + +[channelAdminLogEventActionTogglePreHistoryHidden](../constructors/channelAdminLogEventActionTogglePreHistoryHidden.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChannelAdminLogEventsFilter.md b/old_docs/API_docs_v81/types/ChannelAdminLogEventsFilter.md new file mode 100644 index 00000000..1199a100 --- /dev/null +++ b/old_docs/API_docs_v81/types/ChannelAdminLogEventsFilter.md @@ -0,0 +1,20 @@ +--- +title: ChannelAdminLogEventsFilter +description: constructors and methods of type ChannelAdminLogEventsFilter +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelAdminLogEventsFilter +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelAdminLogEventsFilter](../constructors/channelAdminLogEventsFilter.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChannelAdminRights.md b/old_docs/API_docs_v81/types/ChannelAdminRights.md new file mode 100644 index 00000000..edacd956 --- /dev/null +++ b/old_docs/API_docs_v81/types/ChannelAdminRights.md @@ -0,0 +1,20 @@ +--- +title: ChannelAdminRights +description: constructors and methods of type ChannelAdminRights +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelAdminRights +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelAdminRights](../constructors/channelAdminRights.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChannelBannedRights.md b/old_docs/API_docs_v81/types/ChannelBannedRights.md new file mode 100644 index 00000000..1ffe1549 --- /dev/null +++ b/old_docs/API_docs_v81/types/ChannelBannedRights.md @@ -0,0 +1,20 @@ +--- +title: ChannelBannedRights +description: constructors and methods of type ChannelBannedRights +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelBannedRights +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelBannedRights](../constructors/channelBannedRights.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChannelMessagesFilter.md b/old_docs/API_docs_v81/types/ChannelMessagesFilter.md new file mode 100644 index 00000000..e3052b30 --- /dev/null +++ b/old_docs/API_docs_v81/types/ChannelMessagesFilter.md @@ -0,0 +1,22 @@ +--- +title: ChannelMessagesFilter +description: constructors and methods of type ChannelMessagesFilter +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelMessagesFilter +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelMessagesFilterEmpty](../constructors/channelMessagesFilterEmpty.md) + +[channelMessagesFilter](../constructors/channelMessagesFilter.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChannelParticipant.md b/old_docs/API_docs_v81/types/ChannelParticipant.md new file mode 100644 index 00000000..0658f4e9 --- /dev/null +++ b/old_docs/API_docs_v81/types/ChannelParticipant.md @@ -0,0 +1,28 @@ +--- +title: ChannelParticipant +description: constructors and methods of type ChannelParticipant +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelParticipant +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelParticipant](../constructors/channelParticipant.md) + +[channelParticipantSelf](../constructors/channelParticipantSelf.md) + +[channelParticipantCreator](../constructors/channelParticipantCreator.md) + +[channelParticipantAdmin](../constructors/channelParticipantAdmin.md) + +[channelParticipantBanned](../constructors/channelParticipantBanned.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChannelParticipantsFilter.md b/old_docs/API_docs_v81/types/ChannelParticipantsFilter.md new file mode 100644 index 00000000..fa8dee6b --- /dev/null +++ b/old_docs/API_docs_v81/types/ChannelParticipantsFilter.md @@ -0,0 +1,30 @@ +--- +title: ChannelParticipantsFilter +description: constructors and methods of type ChannelParticipantsFilter +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelParticipantsFilter +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelParticipantsRecent](../constructors/channelParticipantsRecent.md) + +[channelParticipantsAdmins](../constructors/channelParticipantsAdmins.md) + +[channelParticipantsKicked](../constructors/channelParticipantsKicked.md) + +[channelParticipantsBots](../constructors/channelParticipantsBots.md) + +[channelParticipantsBanned](../constructors/channelParticipantsBanned.md) + +[channelParticipantsSearch](../constructors/channelParticipantsSearch.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Chat.md b/old_docs/API_docs_v81/types/Chat.md new file mode 100644 index 00000000..a93e9666 --- /dev/null +++ b/old_docs/API_docs_v81/types/Chat.md @@ -0,0 +1,52 @@ +--- +title: Chat +description: constructors and methods of type Chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Chat +[Back to types index](index.md) + + + +You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. + +The following syntaxes can also be used: + +``` +$Chat = '@username'; // Username + +$Chat = 'me'; // The currently logged-in user + +$Chat = 44700; // bot API id (users) +$Chat = -492772765; // bot API id (chats) +$Chat = -10038575794; // bot API id (channels) + +$Chat = 'https://t.me/danogentili'; // t.me URLs +$Chat = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$Chat = 'user#44700'; // tg-cli style id (users) +$Chat = 'chat#492772765'; // tg-cli style id (chats) +$Chat = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), or a [Chat](Chat.md) object can also be used. + + +### Possible values (constructors): + +[chatEmpty](../constructors/chatEmpty.md) + +[chat](../constructors/chat.md) + +[chatForbidden](../constructors/chatForbidden.md) + +[channel](../constructors/channel.md) + +[channelForbidden](../constructors/channelForbidden.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChatFull.md b/old_docs/API_docs_v81/types/ChatFull.md new file mode 100644 index 00000000..615843bc --- /dev/null +++ b/old_docs/API_docs_v81/types/ChatFull.md @@ -0,0 +1,22 @@ +--- +title: ChatFull +description: constructors and methods of type ChatFull +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChatFull +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatFull](../constructors/chatFull.md) + +[channelFull](../constructors/channelFull.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChatInvite.md b/old_docs/API_docs_v81/types/ChatInvite.md new file mode 100644 index 00000000..5022a2f0 --- /dev/null +++ b/old_docs/API_docs_v81/types/ChatInvite.md @@ -0,0 +1,24 @@ +--- +title: ChatInvite +description: constructors and methods of type ChatInvite +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChatInvite +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatInviteAlready](../constructors/chatInviteAlready.md) + +[chatInvite](../constructors/chatInvite.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->checkChatInvite](../methods/messages_checkChatInvite.md) + + + diff --git a/old_docs/API_docs_v81/types/ChatParticipant.md b/old_docs/API_docs_v81/types/ChatParticipant.md new file mode 100644 index 00000000..30bad422 --- /dev/null +++ b/old_docs/API_docs_v81/types/ChatParticipant.md @@ -0,0 +1,24 @@ +--- +title: ChatParticipant +description: constructors and methods of type ChatParticipant +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChatParticipant +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatParticipant](../constructors/chatParticipant.md) + +[chatParticipantCreator](../constructors/chatParticipantCreator.md) + +[chatParticipantAdmin](../constructors/chatParticipantAdmin.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChatParticipants.md b/old_docs/API_docs_v81/types/ChatParticipants.md new file mode 100644 index 00000000..ab60023d --- /dev/null +++ b/old_docs/API_docs_v81/types/ChatParticipants.md @@ -0,0 +1,22 @@ +--- +title: ChatParticipants +description: constructors and methods of type ChatParticipants +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChatParticipants +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatParticipantsForbidden](../constructors/chatParticipantsForbidden.md) + +[chatParticipants](../constructors/chatParticipants.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ChatPhoto.md b/old_docs/API_docs_v81/types/ChatPhoto.md new file mode 100644 index 00000000..066b2a14 --- /dev/null +++ b/old_docs/API_docs_v81/types/ChatPhoto.md @@ -0,0 +1,22 @@ +--- +title: ChatPhoto +description: constructors and methods of type ChatPhoto +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChatPhoto +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatPhotoEmpty](../constructors/chatPhotoEmpty.md) + +[chatPhoto](../constructors/chatPhoto.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Config.md b/old_docs/API_docs_v81/types/Config.md new file mode 100644 index 00000000..0f7fbe70 --- /dev/null +++ b/old_docs/API_docs_v81/types/Config.md @@ -0,0 +1,22 @@ +--- +title: Config +description: constructors and methods of type Config +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Config +[Back to types index](index.md) + + + +### Possible values (constructors): + +[config](../constructors/config.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getConfig](../methods/help_getConfig.md) + + + diff --git a/old_docs/API_docs_v81/types/Contact.md b/old_docs/API_docs_v81/types/Contact.md new file mode 100644 index 00000000..b8c9db1a --- /dev/null +++ b/old_docs/API_docs_v81/types/Contact.md @@ -0,0 +1,20 @@ +--- +title: Contact +description: constructors and methods of type Contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Contact +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contact](../constructors/contact.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ContactBlocked.md b/old_docs/API_docs_v81/types/ContactBlocked.md new file mode 100644 index 00000000..a3384d9a --- /dev/null +++ b/old_docs/API_docs_v81/types/ContactBlocked.md @@ -0,0 +1,20 @@ +--- +title: ContactBlocked +description: constructors and methods of type ContactBlocked +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ContactBlocked +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contactBlocked](../constructors/contactBlocked.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ContactLink.md b/old_docs/API_docs_v81/types/ContactLink.md new file mode 100644 index 00000000..dc0bba05 --- /dev/null +++ b/old_docs/API_docs_v81/types/ContactLink.md @@ -0,0 +1,26 @@ +--- +title: ContactLink +description: constructors and methods of type ContactLink +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ContactLink +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contactLinkUnknown](../constructors/contactLinkUnknown.md) + +[contactLinkNone](../constructors/contactLinkNone.md) + +[contactLinkHasPhone](../constructors/contactLinkHasPhone.md) + +[contactLinkContact](../constructors/contactLinkContact.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ContactStatus.md b/old_docs/API_docs_v81/types/ContactStatus.md new file mode 100644 index 00000000..c5f5d658 --- /dev/null +++ b/old_docs/API_docs_v81/types/ContactStatus.md @@ -0,0 +1,22 @@ +--- +title: ContactStatus +description: constructors and methods of type ContactStatus +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ContactStatus +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contactStatus](../constructors/contactStatus.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->getStatuses](../methods/contacts_getStatuses.md) + + + diff --git a/old_docs/API_docs_v81/types/DataJSON.md b/old_docs/API_docs_v81/types/DataJSON.md new file mode 100644 index 00000000..ad772790 --- /dev/null +++ b/old_docs/API_docs_v81/types/DataJSON.md @@ -0,0 +1,9 @@ +--- +title: DataJSON +description: Any json-encodable data +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: DataJSON +[Back to constructor index](index.md) + +Any json-encodable data. diff --git a/old_docs/API_docs_v81/types/DcOption.md b/old_docs/API_docs_v81/types/DcOption.md new file mode 100644 index 00000000..c621fa1d --- /dev/null +++ b/old_docs/API_docs_v81/types/DcOption.md @@ -0,0 +1,20 @@ +--- +title: DcOption +description: constructors and methods of type DcOption +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: DcOption +[Back to types index](index.md) + + + +### Possible values (constructors): + +[dcOption](../constructors/dcOption.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Dialog.md b/old_docs/API_docs_v81/types/Dialog.md new file mode 100644 index 00000000..f69e3538 --- /dev/null +++ b/old_docs/API_docs_v81/types/Dialog.md @@ -0,0 +1,20 @@ +--- +title: Dialog +description: constructors and methods of type Dialog +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Dialog +[Back to types index](index.md) + + + +### Possible values (constructors): + +[dialog](../constructors/dialog.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/DialogPeer.md b/old_docs/API_docs_v81/types/DialogPeer.md new file mode 100644 index 00000000..1a6c4cc3 --- /dev/null +++ b/old_docs/API_docs_v81/types/DialogPeer.md @@ -0,0 +1,20 @@ +--- +title: DialogPeer +description: constructors and methods of type DialogPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: DialogPeer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[dialogPeer](../constructors/dialogPeer.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Document.md b/old_docs/API_docs_v81/types/Document.md new file mode 100644 index 00000000..f68b7aa4 --- /dev/null +++ b/old_docs/API_docs_v81/types/Document.md @@ -0,0 +1,24 @@ +--- +title: Document +description: constructors and methods of type Document +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Document +[Back to types index](index.md) + + + +### Possible values (constructors): + +[documentEmpty](../constructors/documentEmpty.md) + +[document](../constructors/document.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getDocumentByHash](../methods/messages_getDocumentByHash.md) + + + diff --git a/old_docs/API_docs_v81/types/DocumentAttribute.md b/old_docs/API_docs_v81/types/DocumentAttribute.md new file mode 100644 index 00000000..8a1060c8 --- /dev/null +++ b/old_docs/API_docs_v81/types/DocumentAttribute.md @@ -0,0 +1,32 @@ +--- +title: DocumentAttribute +description: constructors and methods of type DocumentAttribute +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: DocumentAttribute +[Back to types index](index.md) + + + +### Possible values (constructors): + +[documentAttributeImageSize](../constructors/documentAttributeImageSize.md) + +[documentAttributeAnimated](../constructors/documentAttributeAnimated.md) + +[documentAttributeSticker](../constructors/documentAttributeSticker.md) + +[documentAttributeVideo](../constructors/documentAttributeVideo.md) + +[documentAttributeAudio](../constructors/documentAttributeAudio.md) + +[documentAttributeFilename](../constructors/documentAttributeFilename.md) + +[documentAttributeHasStickers](../constructors/documentAttributeHasStickers.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/DraftMessage.md b/old_docs/API_docs_v81/types/DraftMessage.md new file mode 100644 index 00000000..63dd107a --- /dev/null +++ b/old_docs/API_docs_v81/types/DraftMessage.md @@ -0,0 +1,22 @@ +--- +title: DraftMessage +description: constructors and methods of type DraftMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: DraftMessage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[draftMessageEmpty](../constructors/draftMessageEmpty.md) + +[draftMessage](../constructors/draftMessage.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/EncryptedChat.md b/old_docs/API_docs_v81/types/EncryptedChat.md new file mode 100644 index 00000000..fd2277f6 --- /dev/null +++ b/old_docs/API_docs_v81/types/EncryptedChat.md @@ -0,0 +1,32 @@ +--- +title: EncryptedChat +description: constructors and methods of type EncryptedChat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: EncryptedChat +[Back to types index](index.md) + + + +### Possible values (constructors): + +[encryptedChatEmpty](../constructors/encryptedChatEmpty.md) + +[encryptedChatWaiting](../constructors/encryptedChatWaiting.md) + +[encryptedChatRequested](../constructors/encryptedChatRequested.md) + +[encryptedChat](../constructors/encryptedChat.md) + +[encryptedChatDiscarded](../constructors/encryptedChatDiscarded.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->requestEncryption](../methods/messages_requestEncryption.md) + +[$MadelineProto->messages->acceptEncryption](../methods/messages_acceptEncryption.md) + + + diff --git a/old_docs/API_docs_v81/types/EncryptedFile.md b/old_docs/API_docs_v81/types/EncryptedFile.md new file mode 100644 index 00000000..a26d40bb --- /dev/null +++ b/old_docs/API_docs_v81/types/EncryptedFile.md @@ -0,0 +1,24 @@ +--- +title: EncryptedFile +description: constructors and methods of type EncryptedFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: EncryptedFile +[Back to types index](index.md) + + + +### Possible values (constructors): + +[encryptedFileEmpty](../constructors/encryptedFileEmpty.md) + +[encryptedFile](../constructors/encryptedFile.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->uploadEncryptedFile](../methods/messages_uploadEncryptedFile.md) + + + diff --git a/old_docs/API_docs_v81/types/EncryptedMessage.md b/old_docs/API_docs_v81/types/EncryptedMessage.md new file mode 100644 index 00000000..f0b54b7e --- /dev/null +++ b/old_docs/API_docs_v81/types/EncryptedMessage.md @@ -0,0 +1,22 @@ +--- +title: EncryptedMessage +description: constructors and methods of type EncryptedMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: EncryptedMessage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[encryptedMessage](../constructors/encryptedMessage.md) + +[encryptedMessageService](../constructors/encryptedMessageService.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Error.md b/old_docs/API_docs_v81/types/Error.md new file mode 100644 index 00000000..245a4f03 --- /dev/null +++ b/old_docs/API_docs_v81/types/Error.md @@ -0,0 +1,20 @@ +--- +title: Error +description: constructors and methods of type Error +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Error +[Back to types index](index.md) + + + +### Possible values (constructors): + +[error](../constructors/error.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ExportedChatInvite.md b/old_docs/API_docs_v81/types/ExportedChatInvite.md new file mode 100644 index 00000000..4213a78f --- /dev/null +++ b/old_docs/API_docs_v81/types/ExportedChatInvite.md @@ -0,0 +1,26 @@ +--- +title: ExportedChatInvite +description: constructors and methods of type ExportedChatInvite +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ExportedChatInvite +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatInviteEmpty](../constructors/chatInviteEmpty.md) + +[chatInviteExported](../constructors/chatInviteExported.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->exportChatInvite](../methods/messages_exportChatInvite.md) + +[$MadelineProto->channels->exportInvite](../methods/channels_exportInvite.md) + + + diff --git a/old_docs/API_docs_v81/types/ExportedMessageLink.md b/old_docs/API_docs_v81/types/ExportedMessageLink.md new file mode 100644 index 00000000..eb2400f6 --- /dev/null +++ b/old_docs/API_docs_v81/types/ExportedMessageLink.md @@ -0,0 +1,22 @@ +--- +title: ExportedMessageLink +description: constructors and methods of type ExportedMessageLink +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ExportedMessageLink +[Back to types index](index.md) + + + +### Possible values (constructors): + +[exportedMessageLink](../constructors/exportedMessageLink.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->channels->exportMessageLink](../methods/channels_exportMessageLink.md) + + + diff --git a/old_docs/API_docs_v81/types/FileHash.md b/old_docs/API_docs_v81/types/FileHash.md new file mode 100644 index 00000000..3201d7e0 --- /dev/null +++ b/old_docs/API_docs_v81/types/FileHash.md @@ -0,0 +1,26 @@ +--- +title: FileHash +description: constructors and methods of type FileHash +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: FileHash +[Back to types index](index.md) + + + +### Possible values (constructors): + +[fileHash](../constructors/fileHash.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->upload->reuploadCdnFile](../methods/upload_reuploadCdnFile.md) + +[$MadelineProto->upload->getCdnFileHashes](../methods/upload_getCdnFileHashes.md) + +[$MadelineProto->upload->getFileHashes](../methods/upload_getFileHashes.md) + + + diff --git a/old_docs/API_docs_v81/types/FileLocation.md b/old_docs/API_docs_v81/types/FileLocation.md new file mode 100644 index 00000000..e6169428 --- /dev/null +++ b/old_docs/API_docs_v81/types/FileLocation.md @@ -0,0 +1,22 @@ +--- +title: FileLocation +description: constructors and methods of type FileLocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: FileLocation +[Back to types index](index.md) + + + +### Possible values (constructors): + +[fileLocationUnavailable](../constructors/fileLocationUnavailable.md) + +[fileLocation](../constructors/fileLocation.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/FoundGif.md b/old_docs/API_docs_v81/types/FoundGif.md new file mode 100644 index 00000000..6085f2a0 --- /dev/null +++ b/old_docs/API_docs_v81/types/FoundGif.md @@ -0,0 +1,22 @@ +--- +title: FoundGif +description: constructors and methods of type FoundGif +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: FoundGif +[Back to types index](index.md) + + + +### Possible values (constructors): + +[foundGif](../constructors/foundGif.md) + +[foundGifCached](../constructors/foundGifCached.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Game.md b/old_docs/API_docs_v81/types/Game.md new file mode 100644 index 00000000..77493a4b --- /dev/null +++ b/old_docs/API_docs_v81/types/Game.md @@ -0,0 +1,20 @@ +--- +title: Game +description: constructors and methods of type Game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Game +[Back to types index](index.md) + + + +### Possible values (constructors): + +[game](../constructors/game.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/GeoPoint.md b/old_docs/API_docs_v81/types/GeoPoint.md new file mode 100644 index 00000000..13ac6ebb --- /dev/null +++ b/old_docs/API_docs_v81/types/GeoPoint.md @@ -0,0 +1,22 @@ +--- +title: GeoPoint +description: constructors and methods of type GeoPoint +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: GeoPoint +[Back to types index](index.md) + + + +### Possible values (constructors): + +[geoPointEmpty](../constructors/geoPointEmpty.md) + +[geoPoint](../constructors/geoPoint.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/HighScore.md b/old_docs/API_docs_v81/types/HighScore.md new file mode 100644 index 00000000..41e02ee4 --- /dev/null +++ b/old_docs/API_docs_v81/types/HighScore.md @@ -0,0 +1,20 @@ +--- +title: HighScore +description: constructors and methods of type HighScore +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: HighScore +[Back to types index](index.md) + + + +### Possible values (constructors): + +[highScore](../constructors/highScore.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ImportedContact.md b/old_docs/API_docs_v81/types/ImportedContact.md new file mode 100644 index 00000000..35654f72 --- /dev/null +++ b/old_docs/API_docs_v81/types/ImportedContact.md @@ -0,0 +1,20 @@ +--- +title: ImportedContact +description: constructors and methods of type ImportedContact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ImportedContact +[Back to types index](index.md) + + + +### Possible values (constructors): + +[importedContact](../constructors/importedContact.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InlineBotSwitchPM.md b/old_docs/API_docs_v81/types/InlineBotSwitchPM.md new file mode 100644 index 00000000..68c1be35 --- /dev/null +++ b/old_docs/API_docs_v81/types/InlineBotSwitchPM.md @@ -0,0 +1,20 @@ +--- +title: InlineBotSwitchPM +description: constructors and methods of type InlineBotSwitchPM +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InlineBotSwitchPM +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inlineBotSwitchPM](../constructors/inlineBotSwitchPM.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputAppEvent.md b/old_docs/API_docs_v81/types/InputAppEvent.md new file mode 100644 index 00000000..64a2d296 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputAppEvent.md @@ -0,0 +1,20 @@ +--- +title: InputAppEvent +description: constructors and methods of type InputAppEvent +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputAppEvent +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputAppEvent](../constructors/inputAppEvent.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputBotInlineMessage.md b/old_docs/API_docs_v81/types/InputBotInlineMessage.md new file mode 100644 index 00000000..d622b55f --- /dev/null +++ b/old_docs/API_docs_v81/types/InputBotInlineMessage.md @@ -0,0 +1,30 @@ +--- +title: InputBotInlineMessage +description: constructors and methods of type InputBotInlineMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputBotInlineMessage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputBotInlineMessageMediaAuto](../constructors/inputBotInlineMessageMediaAuto.md) + +[inputBotInlineMessageText](../constructors/inputBotInlineMessageText.md) + +[inputBotInlineMessageMediaGeo](../constructors/inputBotInlineMessageMediaGeo.md) + +[inputBotInlineMessageMediaVenue](../constructors/inputBotInlineMessageMediaVenue.md) + +[inputBotInlineMessageMediaContact](../constructors/inputBotInlineMessageMediaContact.md) + +[inputBotInlineMessageGame](../constructors/inputBotInlineMessageGame.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputBotInlineMessageID.md b/old_docs/API_docs_v81/types/InputBotInlineMessageID.md new file mode 100644 index 00000000..cb1c6783 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputBotInlineMessageID.md @@ -0,0 +1,20 @@ +--- +title: InputBotInlineMessageID +description: constructors and methods of type InputBotInlineMessageID +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputBotInlineMessageID +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputBotInlineMessageID](../constructors/inputBotInlineMessageID.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputBotInlineResult.md b/old_docs/API_docs_v81/types/InputBotInlineResult.md new file mode 100644 index 00000000..0c8d79bc --- /dev/null +++ b/old_docs/API_docs_v81/types/InputBotInlineResult.md @@ -0,0 +1,26 @@ +--- +title: InputBotInlineResult +description: constructors and methods of type InputBotInlineResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputBotInlineResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputBotInlineResult](../constructors/inputBotInlineResult.md) + +[inputBotInlineResultPhoto](../constructors/inputBotInlineResultPhoto.md) + +[inputBotInlineResultDocument](../constructors/inputBotInlineResultDocument.md) + +[inputBotInlineResultGame](../constructors/inputBotInlineResultGame.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputChannel.md b/old_docs/API_docs_v81/types/InputChannel.md new file mode 100644 index 00000000..bcf52c53 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputChannel.md @@ -0,0 +1,46 @@ +--- +title: InputChannel +description: constructors and methods of type InputChannel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputChannel +[Back to types index](index.md) + + + +You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. + +The following syntaxes can also be used: + +``` +$InputChannel = '@username'; // Username + +$InputChannel = 'me'; // The currently logged-in user + +$InputChannel = 44700; // bot API id (users) +$InputChannel = -492772765; // bot API id (chats) +$InputChannel = -10038575794; // bot API id (channels) + +$InputChannel = 'https://t.me/danogentili'; // t.me URLs +$InputChannel = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$InputChannel = 'user#44700'; // tg-cli style id (users) +$InputChannel = 'chat#492772765'; // tg-cli style id (chats) +$InputChannel = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), or a [Chat](Chat.md) object can also be used. + + +### Possible values (constructors): + +[inputChannelEmpty](../constructors/inputChannelEmpty.md) + +[inputChannel](../constructors/inputChannel.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputChatPhoto.md b/old_docs/API_docs_v81/types/InputChatPhoto.md new file mode 100644 index 00000000..4be81e67 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputChatPhoto.md @@ -0,0 +1,24 @@ +--- +title: InputChatPhoto +description: constructors and methods of type InputChatPhoto +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputChatPhoto +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputChatPhotoEmpty](../constructors/inputChatPhotoEmpty.md) + +[inputChatUploadedPhoto](../constructors/inputChatUploadedPhoto.md) + +[inputChatPhoto](../constructors/inputChatPhoto.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputClientProxy.md b/old_docs/API_docs_v81/types/InputClientProxy.md new file mode 100644 index 00000000..7897a91f --- /dev/null +++ b/old_docs/API_docs_v81/types/InputClientProxy.md @@ -0,0 +1,20 @@ +--- +title: InputClientProxy +description: constructors and methods of type InputClientProxy +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputClientProxy +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputClientProxy](../constructors/inputClientProxy.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputContact.md b/old_docs/API_docs_v81/types/InputContact.md new file mode 100644 index 00000000..10026e98 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputContact.md @@ -0,0 +1,20 @@ +--- +title: InputContact +description: constructors and methods of type InputContact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputContact +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputPhoneContact](../constructors/inputPhoneContact.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputDialogPeer.md b/old_docs/API_docs_v81/types/InputDialogPeer.md new file mode 100644 index 00000000..2dec7525 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputDialogPeer.md @@ -0,0 +1,20 @@ +--- +title: InputDialogPeer +description: constructors and methods of type InputDialogPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputDialogPeer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputDialogPeer](../constructors/inputDialogPeer.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputDocument.md b/old_docs/API_docs_v81/types/InputDocument.md new file mode 100644 index 00000000..1227cd74 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputDocument.md @@ -0,0 +1,24 @@ +--- +title: InputDocument +description: constructors and methods of type InputDocument +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputDocument +[Back to types index](index.md) + + + +You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [Update](Update.md), [Document](Document.md) here, MadelineProto will automatically convert it to the right type. + +### Possible values (constructors): + +[inputDocumentEmpty](../constructors/inputDocumentEmpty.md) + +[inputDocument](../constructors/inputDocument.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputEncryptedChat.md b/old_docs/API_docs_v81/types/InputEncryptedChat.md new file mode 100644 index 00000000..17960951 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputEncryptedChat.md @@ -0,0 +1,29 @@ +--- +title: InputEncryptedChat +description: constructors and methods of type InputEncryptedChat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputEncryptedChat +[Back to types index](index.md) + + + +You can directly provide the [Update](Update.md) or [EncryptedMessage](EncryptedMessage.md) object here, MadelineProto will automatically extract the destination chat id. + +The following syntax can also be used: + +``` +$InputEncryptedChat = -147286699; // Numeric chat id returned by request_secret_chat, can be positive or negative +``` + + +### Possible values (constructors): + +[inputEncryptedChat](../constructors/inputEncryptedChat.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputEncryptedFile.md b/old_docs/API_docs_v81/types/InputEncryptedFile.md new file mode 100644 index 00000000..cd7f365f --- /dev/null +++ b/old_docs/API_docs_v81/types/InputEncryptedFile.md @@ -0,0 +1,33 @@ +--- +title: InputEncryptedFile +description: constructors and methods of type InputEncryptedFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputEncryptedFile +[Back to types index](index.md) + + + +The following syntax can also be used: + +``` +$InputEncryptedFile = 'filename.mp4'; // The file path can also be used +``` + + +### Possible values (constructors): + +[inputEncryptedFileEmpty](../constructors/inputEncryptedFileEmpty.md) + +[inputEncryptedFileUploaded](../constructors/inputEncryptedFileUploaded.md) + +[inputEncryptedFile](../constructors/inputEncryptedFile.md) + +[inputEncryptedFileBigUploaded](../constructors/inputEncryptedFileBigUploaded.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputFile.md b/old_docs/API_docs_v81/types/InputFile.md new file mode 100644 index 00000000..f76612de --- /dev/null +++ b/old_docs/API_docs_v81/types/InputFile.md @@ -0,0 +1,29 @@ +--- +title: InputFile +description: constructors and methods of type InputFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputFile +[Back to types index](index.md) + + + +The following syntax can also be used: + +``` +$InputFile = 'filename.mp4'; // The file path can also be used +``` + + +### Possible values (constructors): + +[inputFile](../constructors/inputFile.md) + +[inputFileBig](../constructors/inputFileBig.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputFileLocation.md b/old_docs/API_docs_v81/types/InputFileLocation.md new file mode 100644 index 00000000..451b1a6e --- /dev/null +++ b/old_docs/API_docs_v81/types/InputFileLocation.md @@ -0,0 +1,28 @@ +--- +title: InputFileLocation +description: constructors and methods of type InputFileLocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputFileLocation +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputFileLocation](../constructors/inputFileLocation.md) + +[inputEncryptedFileLocation](../constructors/inputEncryptedFileLocation.md) + +[inputDocumentFileLocation](../constructors/inputDocumentFileLocation.md) + +[inputSecureFileLocation](../constructors/inputSecureFileLocation.md) + +[inputTakeoutFileLocation](../constructors/inputTakeoutFileLocation.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputGame.md b/old_docs/API_docs_v81/types/InputGame.md new file mode 100644 index 00000000..604d23fc --- /dev/null +++ b/old_docs/API_docs_v81/types/InputGame.md @@ -0,0 +1,22 @@ +--- +title: InputGame +description: constructors and methods of type InputGame +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputGame +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputGameID](../constructors/inputGameID.md) + +[inputGameShortName](../constructors/inputGameShortName.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputGeoPoint.md b/old_docs/API_docs_v81/types/InputGeoPoint.md new file mode 100644 index 00000000..87ea6c09 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputGeoPoint.md @@ -0,0 +1,22 @@ +--- +title: InputGeoPoint +description: constructors and methods of type InputGeoPoint +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputGeoPoint +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputGeoPointEmpty](../constructors/inputGeoPointEmpty.md) + +[inputGeoPoint](../constructors/inputGeoPoint.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputMedia.md b/old_docs/API_docs_v81/types/InputMedia.md new file mode 100644 index 00000000..307ed990 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputMedia.md @@ -0,0 +1,48 @@ +--- +title: InputMedia +description: constructors and methods of type InputMedia +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputMedia +[Back to types index](index.md) + + + +You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [Update](Update.md), [Document](Document.md), [Photo](Photo.md), [InputDocument](InputDocument.md), [InputPhoto](InputPhoto.md) here, MadelineProto will automatically convert it to the right type. + +### Possible values (constructors): + +[inputMediaEmpty](../constructors/inputMediaEmpty.md) + +[inputMediaUploadedPhoto](../constructors/inputMediaUploadedPhoto.md) + +[inputMediaPhoto](../constructors/inputMediaPhoto.md) + +[inputMediaGeoPoint](../constructors/inputMediaGeoPoint.md) + +[inputMediaContact](../constructors/inputMediaContact.md) + +[inputMediaUploadedDocument](../constructors/inputMediaUploadedDocument.md) + +[inputMediaDocument](../constructors/inputMediaDocument.md) + +[inputMediaVenue](../constructors/inputMediaVenue.md) + +[inputMediaGifExternal](../constructors/inputMediaGifExternal.md) + +[inputMediaPhotoExternal](../constructors/inputMediaPhotoExternal.md) + +[inputMediaDocumentExternal](../constructors/inputMediaDocumentExternal.md) + +[inputMediaGame](../constructors/inputMediaGame.md) + +[inputMediaInvoice](../constructors/inputMediaInvoice.md) + +[inputMediaGeoLive](../constructors/inputMediaGeoLive.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputMessage.md b/old_docs/API_docs_v81/types/InputMessage.md new file mode 100644 index 00000000..075b4f04 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputMessage.md @@ -0,0 +1,31 @@ +--- +title: InputMessage +description: constructors and methods of type InputMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputMessage +[Back to types index](index.md) + + + +The following syntax can also be used: + +``` +$InputMessage = 142; // Numeric message ID +``` + + +### Possible values (constructors): + +[inputMessageID](../constructors/inputMessageID.md) + +[inputMessageReplyTo](../constructors/inputMessageReplyTo.md) + +[inputMessagePinned](../constructors/inputMessagePinned.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputNotifyPeer.md b/old_docs/API_docs_v81/types/InputNotifyPeer.md new file mode 100644 index 00000000..c99acd02 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputNotifyPeer.md @@ -0,0 +1,24 @@ +--- +title: InputNotifyPeer +description: constructors and methods of type InputNotifyPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputNotifyPeer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputNotifyPeer](../constructors/inputNotifyPeer.md) + +[inputNotifyUsers](../constructors/inputNotifyUsers.md) + +[inputNotifyChats](../constructors/inputNotifyChats.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputPaymentCredentials.md b/old_docs/API_docs_v81/types/InputPaymentCredentials.md new file mode 100644 index 00000000..78374c45 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputPaymentCredentials.md @@ -0,0 +1,26 @@ +--- +title: InputPaymentCredentials +description: constructors and methods of type InputPaymentCredentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputPaymentCredentials +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputPaymentCredentialsSaved](../constructors/inputPaymentCredentialsSaved.md) + +[inputPaymentCredentials](../constructors/inputPaymentCredentials.md) + +[inputPaymentCredentialsApplePay](../constructors/inputPaymentCredentialsApplePay.md) + +[inputPaymentCredentialsAndroidPay](../constructors/inputPaymentCredentialsAndroidPay.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputPeer.md b/old_docs/API_docs_v81/types/InputPeer.md new file mode 100644 index 00000000..172bc5e2 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputPeer.md @@ -0,0 +1,52 @@ +--- +title: InputPeer +description: constructors and methods of type InputPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputPeer +[Back to types index](index.md) + + + +You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. + +The following syntaxes can also be used: + +``` +$InputPeer = '@username'; // Username + +$InputPeer = 'me'; // The currently logged-in user + +$InputPeer = 44700; // bot API id (users) +$InputPeer = -492772765; // bot API id (chats) +$InputPeer = -10038575794; // bot API id (channels) + +$InputPeer = 'https://t.me/danogentili'; // t.me URLs +$InputPeer = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$InputPeer = 'user#44700'; // tg-cli style id (users) +$InputPeer = 'chat#492772765'; // tg-cli style id (chats) +$InputPeer = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), or a [Chat](Chat.md) object can also be used. + + +### Possible values (constructors): + +[inputPeerEmpty](../constructors/inputPeerEmpty.md) + +[inputPeerSelf](../constructors/inputPeerSelf.md) + +[inputPeerChat](../constructors/inputPeerChat.md) + +[inputPeerUser](../constructors/inputPeerUser.md) + +[inputPeerChannel](../constructors/inputPeerChannel.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputPeerNotifySettings.md b/old_docs/API_docs_v81/types/InputPeerNotifySettings.md new file mode 100644 index 00000000..47645252 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputPeerNotifySettings.md @@ -0,0 +1,20 @@ +--- +title: InputPeerNotifySettings +description: constructors and methods of type InputPeerNotifySettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputPeerNotifySettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputPeerNotifySettings](../constructors/inputPeerNotifySettings.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputPhoneCall.md b/old_docs/API_docs_v81/types/InputPhoneCall.md new file mode 100644 index 00000000..3203aff9 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputPhoneCall.md @@ -0,0 +1,20 @@ +--- +title: InputPhoneCall +description: constructors and methods of type InputPhoneCall +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputPhoneCall +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputPhoneCall](../constructors/inputPhoneCall.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputPhoto.md b/old_docs/API_docs_v81/types/InputPhoto.md new file mode 100644 index 00000000..fbad241d --- /dev/null +++ b/old_docs/API_docs_v81/types/InputPhoto.md @@ -0,0 +1,24 @@ +--- +title: InputPhoto +description: constructors and methods of type InputPhoto +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputPhoto +[Back to types index](index.md) + + + +You can also provide a [MessageMedia](MessageMedia.md), [Message](Message.md), [Update](Update.md), [Photo](Photo.md) here, MadelineProto will automatically convert it to the right type. + +### Possible values (constructors): + +[inputPhotoEmpty](../constructors/inputPhotoEmpty.md) + +[inputPhoto](../constructors/inputPhoto.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputPrivacyKey.md b/old_docs/API_docs_v81/types/InputPrivacyKey.md new file mode 100644 index 00000000..eaf3dbd0 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputPrivacyKey.md @@ -0,0 +1,24 @@ +--- +title: InputPrivacyKey +description: constructors and methods of type InputPrivacyKey +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputPrivacyKey +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputPrivacyKeyStatusTimestamp](../constructors/inputPrivacyKeyStatusTimestamp.md) + +[inputPrivacyKeyChatInvite](../constructors/inputPrivacyKeyChatInvite.md) + +[inputPrivacyKeyPhoneCall](../constructors/inputPrivacyKeyPhoneCall.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputPrivacyRule.md b/old_docs/API_docs_v81/types/InputPrivacyRule.md new file mode 100644 index 00000000..92abf96f --- /dev/null +++ b/old_docs/API_docs_v81/types/InputPrivacyRule.md @@ -0,0 +1,30 @@ +--- +title: InputPrivacyRule +description: constructors and methods of type InputPrivacyRule +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputPrivacyRule +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputPrivacyValueAllowContacts](../constructors/inputPrivacyValueAllowContacts.md) + +[inputPrivacyValueAllowAll](../constructors/inputPrivacyValueAllowAll.md) + +[inputPrivacyValueAllowUsers](../constructors/inputPrivacyValueAllowUsers.md) + +[inputPrivacyValueDisallowContacts](../constructors/inputPrivacyValueDisallowContacts.md) + +[inputPrivacyValueDisallowAll](../constructors/inputPrivacyValueDisallowAll.md) + +[inputPrivacyValueDisallowUsers](../constructors/inputPrivacyValueDisallowUsers.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputSecureFile.md b/old_docs/API_docs_v81/types/InputSecureFile.md new file mode 100644 index 00000000..1ee36428 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputSecureFile.md @@ -0,0 +1,22 @@ +--- +title: InputSecureFile +description: constructors and methods of type InputSecureFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputSecureFile +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputSecureFileUploaded](../constructors/inputSecureFileUploaded.md) + +[inputSecureFile](../constructors/inputSecureFile.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputSecureValue.md b/old_docs/API_docs_v81/types/InputSecureValue.md new file mode 100644 index 00000000..c99a7ab4 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputSecureValue.md @@ -0,0 +1,20 @@ +--- +title: InputSecureValue +description: constructors and methods of type InputSecureValue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputSecureValue +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputSecureValue](../constructors/inputSecureValue.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputSingleMedia.md b/old_docs/API_docs_v81/types/InputSingleMedia.md new file mode 100644 index 00000000..db24c669 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputSingleMedia.md @@ -0,0 +1,20 @@ +--- +title: InputSingleMedia +description: constructors and methods of type InputSingleMedia +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputSingleMedia +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputSingleMedia](../constructors/inputSingleMedia.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputStickerSet.md b/old_docs/API_docs_v81/types/InputStickerSet.md new file mode 100644 index 00000000..4ab0897c --- /dev/null +++ b/old_docs/API_docs_v81/types/InputStickerSet.md @@ -0,0 +1,24 @@ +--- +title: InputStickerSet +description: constructors and methods of type InputStickerSet +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputStickerSet +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputStickerSetEmpty](../constructors/inputStickerSetEmpty.md) + +[inputStickerSetID](../constructors/inputStickerSetID.md) + +[inputStickerSetShortName](../constructors/inputStickerSetShortName.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputStickerSetItem.md b/old_docs/API_docs_v81/types/InputStickerSetItem.md new file mode 100644 index 00000000..da3e5a74 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputStickerSetItem.md @@ -0,0 +1,20 @@ +--- +title: InputStickerSetItem +description: constructors and methods of type InputStickerSetItem +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputStickerSetItem +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputStickerSetItem](../constructors/inputStickerSetItem.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputStickeredMedia.md b/old_docs/API_docs_v81/types/InputStickeredMedia.md new file mode 100644 index 00000000..a93a406a --- /dev/null +++ b/old_docs/API_docs_v81/types/InputStickeredMedia.md @@ -0,0 +1,22 @@ +--- +title: InputStickeredMedia +description: constructors and methods of type InputStickeredMedia +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputStickeredMedia +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputStickeredMediaPhoto](../constructors/inputStickeredMediaPhoto.md) + +[inputStickeredMediaDocument](../constructors/inputStickeredMediaDocument.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputUser.md b/old_docs/API_docs_v81/types/InputUser.md new file mode 100644 index 00000000..0c08a76a --- /dev/null +++ b/old_docs/API_docs_v81/types/InputUser.md @@ -0,0 +1,48 @@ +--- +title: InputUser +description: constructors and methods of type InputUser +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputUser +[Back to types index](index.md) + + + +You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. + +The following syntaxes can also be used: + +``` +$InputUser = '@username'; // Username + +$InputUser = 'me'; // The currently logged-in user + +$InputUser = 44700; // bot API id (users) +$InputUser = -492772765; // bot API id (chats) +$InputUser = -10038575794; // bot API id (channels) + +$InputUser = 'https://t.me/danogentili'; // t.me URLs +$InputUser = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$InputUser = 'user#44700'; // tg-cli style id (users) +$InputUser = 'chat#492772765'; // tg-cli style id (chats) +$InputUser = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), or a [Chat](Chat.md) object can also be used. + + +### Possible values (constructors): + +[inputUserEmpty](../constructors/inputUserEmpty.md) + +[inputUserSelf](../constructors/inputUserSelf.md) + +[inputUser](../constructors/inputUser.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputWebDocument.md b/old_docs/API_docs_v81/types/InputWebDocument.md new file mode 100644 index 00000000..f6a5f1b2 --- /dev/null +++ b/old_docs/API_docs_v81/types/InputWebDocument.md @@ -0,0 +1,20 @@ +--- +title: InputWebDocument +description: constructors and methods of type InputWebDocument +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputWebDocument +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputWebDocument](../constructors/inputWebDocument.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/InputWebFileLocation.md b/old_docs/API_docs_v81/types/InputWebFileLocation.md new file mode 100644 index 00000000..988eb8fb --- /dev/null +++ b/old_docs/API_docs_v81/types/InputWebFileLocation.md @@ -0,0 +1,20 @@ +--- +title: InputWebFileLocation +description: constructors and methods of type InputWebFileLocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputWebFileLocation +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputWebFileLocation](../constructors/inputWebFileLocation.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Invoice.md b/old_docs/API_docs_v81/types/Invoice.md new file mode 100644 index 00000000..34f688e5 --- /dev/null +++ b/old_docs/API_docs_v81/types/Invoice.md @@ -0,0 +1,20 @@ +--- +title: Invoice +description: constructors and methods of type Invoice +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# 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/old_docs/API_docs_v81/types/IpPort.md b/old_docs/API_docs_v81/types/IpPort.md new file mode 100644 index 00000000..91e0cb84 --- /dev/null +++ b/old_docs/API_docs_v81/types/IpPort.md @@ -0,0 +1,22 @@ +--- +title: IpPort +description: constructors and methods of type IpPort +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: IpPort +[Back to types index](index.md) + + + +### Possible values (constructors): + +[ipPort](../constructors/ipPort.md) + +[ipPortSecret](../constructors/ipPortSecret.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/KeyboardButton.md b/old_docs/API_docs_v81/types/KeyboardButton.md new file mode 100644 index 00000000..ac4b9e1e --- /dev/null +++ b/old_docs/API_docs_v81/types/KeyboardButton.md @@ -0,0 +1,55 @@ +--- +title: KeyboardButton +description: constructors and methods of type KeyboardButton +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: KeyboardButton +[Back to types index](index.md) + + + +Clicking these buttons: + +To click these buttons simply run the `click` method: + +``` +$result = $KeyboardButton->click(); +``` + +`$result` can be one of the following: + + +* A string - If the button is a keyboardButtonUrl + +* [Updates](Updates.md) - If the button is a keyboardButton, the message will be sent to the chat, in reply to the message with the keyboard + +* [messages_BotCallbackAnswer](messages_BotCallbackAnswer.md) - If the button is a keyboardButtonCallback or a keyboardButtonGame the button will be pressed and the result will be returned + +* `false` - If the button is an unsupported button, like keyboardButtonRequestPhone, keyboardButtonRequestGeoLocation, keyboardButtonSwitchInlinekeyboardButtonBuy; you will have to parse data from these buttons manually + + +You can also access the properties of the constructor as a normal array, for example $button['name'] +### Possible values (constructors): + +[keyboardButton](../constructors/keyboardButton.md) + +[keyboardButtonUrl](../constructors/keyboardButtonUrl.md) + +[keyboardButtonCallback](../constructors/keyboardButtonCallback.md) + +[keyboardButtonRequestPhone](../constructors/keyboardButtonRequestPhone.md) + +[keyboardButtonRequestGeoLocation](../constructors/keyboardButtonRequestGeoLocation.md) + +[keyboardButtonSwitchInline](../constructors/keyboardButtonSwitchInline.md) + +[keyboardButtonGame](../constructors/keyboardButtonGame.md) + +[keyboardButtonBuy](../constructors/keyboardButtonBuy.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/KeyboardButtonRow.md b/old_docs/API_docs_v81/types/KeyboardButtonRow.md new file mode 100644 index 00000000..03bf724e --- /dev/null +++ b/old_docs/API_docs_v81/types/KeyboardButtonRow.md @@ -0,0 +1,20 @@ +--- +title: KeyboardButtonRow +description: constructors and methods of type KeyboardButtonRow +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: KeyboardButtonRow +[Back to types index](index.md) + + + +### Possible values (constructors): + +[keyboardButtonRow](../constructors/keyboardButtonRow.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/LabeledPrice.md b/old_docs/API_docs_v81/types/LabeledPrice.md new file mode 100644 index 00000000..c2c91c3a --- /dev/null +++ b/old_docs/API_docs_v81/types/LabeledPrice.md @@ -0,0 +1,20 @@ +--- +title: LabeledPrice +description: constructors and methods of type LabeledPrice +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# 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/old_docs/API_docs_v81/types/LangPackDifference.md b/old_docs/API_docs_v81/types/LangPackDifference.md new file mode 100644 index 00000000..fd9f41f2 --- /dev/null +++ b/old_docs/API_docs_v81/types/LangPackDifference.md @@ -0,0 +1,24 @@ +--- +title: LangPackDifference +description: constructors and methods of type LangPackDifference +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: LangPackDifference +[Back to types index](index.md) + + + +### Possible values (constructors): + +[langPackDifference](../constructors/langPackDifference.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->langpack->getLangPack](../methods/langpack_getLangPack.md) + +[$MadelineProto->langpack->getDifference](../methods/langpack_getDifference.md) + + + diff --git a/old_docs/API_docs_v81/types/LangPackLanguage.md b/old_docs/API_docs_v81/types/LangPackLanguage.md new file mode 100644 index 00000000..f7459fc2 --- /dev/null +++ b/old_docs/API_docs_v81/types/LangPackLanguage.md @@ -0,0 +1,22 @@ +--- +title: LangPackLanguage +description: constructors and methods of type LangPackLanguage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: LangPackLanguage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[langPackLanguage](../constructors/langPackLanguage.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->langpack->getLanguages](../methods/langpack_getLanguages.md) + + + diff --git a/old_docs/API_docs_v81/types/LangPackString.md b/old_docs/API_docs_v81/types/LangPackString.md new file mode 100644 index 00000000..f1a43dd9 --- /dev/null +++ b/old_docs/API_docs_v81/types/LangPackString.md @@ -0,0 +1,26 @@ +--- +title: LangPackString +description: constructors and methods of type LangPackString +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: LangPackString +[Back to types index](index.md) + + + +### Possible values (constructors): + +[langPackString](../constructors/langPackString.md) + +[langPackStringPluralized](../constructors/langPackStringPluralized.md) + +[langPackStringDeleted](../constructors/langPackStringDeleted.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->langpack->getStrings](../methods/langpack_getStrings.md) + + + diff --git a/old_docs/API_docs_v81/types/MaskCoords.md b/old_docs/API_docs_v81/types/MaskCoords.md new file mode 100644 index 00000000..23d9fa75 --- /dev/null +++ b/old_docs/API_docs_v81/types/MaskCoords.md @@ -0,0 +1,20 @@ +--- +title: MaskCoords +description: constructors and methods of type MaskCoords +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MaskCoords +[Back to types index](index.md) + + + +### Possible values (constructors): + +[maskCoords](../constructors/maskCoords.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Message.md b/old_docs/API_docs_v81/types/Message.md new file mode 100644 index 00000000..b306c73c --- /dev/null +++ b/old_docs/API_docs_v81/types/Message.md @@ -0,0 +1,24 @@ +--- +title: Message +description: constructors and methods of type Message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Message +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageEmpty](../constructors/messageEmpty.md) + +[message](../constructors/message.md) + +[messageService](../constructors/messageService.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/MessageAction.md b/old_docs/API_docs_v81/types/MessageAction.md new file mode 100644 index 00000000..5faa3398 --- /dev/null +++ b/old_docs/API_docs_v81/types/MessageAction.md @@ -0,0 +1,62 @@ +--- +title: MessageAction +description: constructors and methods of type MessageAction +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessageAction +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageActionEmpty](../constructors/messageActionEmpty.md) + +[messageActionChatCreate](../constructors/messageActionChatCreate.md) + +[messageActionChatEditTitle](../constructors/messageActionChatEditTitle.md) + +[messageActionChatEditPhoto](../constructors/messageActionChatEditPhoto.md) + +[messageActionChatDeletePhoto](../constructors/messageActionChatDeletePhoto.md) + +[messageActionChatAddUser](../constructors/messageActionChatAddUser.md) + +[messageActionChatDeleteUser](../constructors/messageActionChatDeleteUser.md) + +[messageActionChatJoinedByLink](../constructors/messageActionChatJoinedByLink.md) + +[messageActionChannelCreate](../constructors/messageActionChannelCreate.md) + +[messageActionChatMigrateTo](../constructors/messageActionChatMigrateTo.md) + +[messageActionChannelMigrateFrom](../constructors/messageActionChannelMigrateFrom.md) + +[messageActionPinMessage](../constructors/messageActionPinMessage.md) + +[messageActionHistoryClear](../constructors/messageActionHistoryClear.md) + +[messageActionGameScore](../constructors/messageActionGameScore.md) + +[messageActionPaymentSentMe](../constructors/messageActionPaymentSentMe.md) + +[messageActionPaymentSent](../constructors/messageActionPaymentSent.md) + +[messageActionPhoneCall](../constructors/messageActionPhoneCall.md) + +[messageActionScreenshotTaken](../constructors/messageActionScreenshotTaken.md) + +[messageActionCustomAction](../constructors/messageActionCustomAction.md) + +[messageActionBotAllowed](../constructors/messageActionBotAllowed.md) + +[messageActionSecureValuesSentMe](../constructors/messageActionSecureValuesSentMe.md) + +[messageActionSecureValuesSent](../constructors/messageActionSecureValuesSent.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/MessageEntity.md b/old_docs/API_docs_v81/types/MessageEntity.md new file mode 100644 index 00000000..ae789cb5 --- /dev/null +++ b/old_docs/API_docs_v81/types/MessageEntity.md @@ -0,0 +1,48 @@ +--- +title: MessageEntity +description: constructors and methods of type MessageEntity +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessageEntity +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageEntityUnknown](../constructors/messageEntityUnknown.md) + +[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) + +[messageEntityTextUrl](../constructors/messageEntityTextUrl.md) + +[messageEntityMentionName](../constructors/messageEntityMentionName.md) + +[inputMessageEntityMentionName](../constructors/inputMessageEntityMentionName.md) + +[messageEntityPhone](../constructors/messageEntityPhone.md) + +[messageEntityCashtag](../constructors/messageEntityCashtag.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/MessageFwdHeader.md b/old_docs/API_docs_v81/types/MessageFwdHeader.md new file mode 100644 index 00000000..aa92c6a5 --- /dev/null +++ b/old_docs/API_docs_v81/types/MessageFwdHeader.md @@ -0,0 +1,20 @@ +--- +title: MessageFwdHeader +description: constructors and methods of type MessageFwdHeader +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessageFwdHeader +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageFwdHeader](../constructors/messageFwdHeader.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/MessageMedia.md b/old_docs/API_docs_v81/types/MessageMedia.md new file mode 100644 index 00000000..fa00818d --- /dev/null +++ b/old_docs/API_docs_v81/types/MessageMedia.md @@ -0,0 +1,44 @@ +--- +title: MessageMedia +description: constructors and methods of type MessageMedia +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessageMedia +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageMediaEmpty](../constructors/messageMediaEmpty.md) + +[messageMediaPhoto](../constructors/messageMediaPhoto.md) + +[messageMediaGeo](../constructors/messageMediaGeo.md) + +[messageMediaContact](../constructors/messageMediaContact.md) + +[messageMediaUnsupported](../constructors/messageMediaUnsupported.md) + +[messageMediaDocument](../constructors/messageMediaDocument.md) + +[messageMediaWebPage](../constructors/messageMediaWebPage.md) + +[messageMediaVenue](../constructors/messageMediaVenue.md) + +[messageMediaGame](../constructors/messageMediaGame.md) + +[messageMediaInvoice](../constructors/messageMediaInvoice.md) + +[messageMediaGeoLive](../constructors/messageMediaGeoLive.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getWebPagePreview](../methods/messages_getWebPagePreview.md) + +[$MadelineProto->messages->uploadMedia](../methods/messages_uploadMedia.md) + + + diff --git a/old_docs/API_docs_v81/types/MessageRange.md b/old_docs/API_docs_v81/types/MessageRange.md new file mode 100644 index 00000000..c93011aa --- /dev/null +++ b/old_docs/API_docs_v81/types/MessageRange.md @@ -0,0 +1,22 @@ +--- +title: MessageRange +description: constructors and methods of type MessageRange +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessageRange +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageRange](../constructors/messageRange.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getSplitRanges](../methods/messages_getSplitRanges.md) + + + diff --git a/old_docs/API_docs_v81/types/MessagesFilter.md b/old_docs/API_docs_v81/types/MessagesFilter.md new file mode 100644 index 00000000..117fbfe3 --- /dev/null +++ b/old_docs/API_docs_v81/types/MessagesFilter.md @@ -0,0 +1,50 @@ +--- +title: MessagesFilter +description: constructors and methods of type MessagesFilter +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessagesFilter +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputMessagesFilterEmpty](../constructors/inputMessagesFilterEmpty.md) + +[inputMessagesFilterPhotos](../constructors/inputMessagesFilterPhotos.md) + +[inputMessagesFilterVideo](../constructors/inputMessagesFilterVideo.md) + +[inputMessagesFilterPhotoVideo](../constructors/inputMessagesFilterPhotoVideo.md) + +[inputMessagesFilterDocument](../constructors/inputMessagesFilterDocument.md) + +[inputMessagesFilterUrl](../constructors/inputMessagesFilterUrl.md) + +[inputMessagesFilterGif](../constructors/inputMessagesFilterGif.md) + +[inputMessagesFilterVoice](../constructors/inputMessagesFilterVoice.md) + +[inputMessagesFilterMusic](../constructors/inputMessagesFilterMusic.md) + +[inputMessagesFilterChatPhotos](../constructors/inputMessagesFilterChatPhotos.md) + +[inputMessagesFilterPhoneCalls](../constructors/inputMessagesFilterPhoneCalls.md) + +[inputMessagesFilterRoundVoice](../constructors/inputMessagesFilterRoundVoice.md) + +[inputMessagesFilterRoundVideo](../constructors/inputMessagesFilterRoundVideo.md) + +[inputMessagesFilterMyMentions](../constructors/inputMessagesFilterMyMentions.md) + +[inputMessagesFilterGeo](../constructors/inputMessagesFilterGeo.md) + +[inputMessagesFilterContacts](../constructors/inputMessagesFilterContacts.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/NearestDc.md b/old_docs/API_docs_v81/types/NearestDc.md new file mode 100644 index 00000000..31f24377 --- /dev/null +++ b/old_docs/API_docs_v81/types/NearestDc.md @@ -0,0 +1,22 @@ +--- +title: NearestDc +description: constructors and methods of type NearestDc +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: NearestDc +[Back to types index](index.md) + + + +### Possible values (constructors): + +[nearestDc](../constructors/nearestDc.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getNearestDc](../methods/help_getNearestDc.md) + + + diff --git a/old_docs/API_docs_v81/types/NotifyPeer.md b/old_docs/API_docs_v81/types/NotifyPeer.md new file mode 100644 index 00000000..45b3d1ac --- /dev/null +++ b/old_docs/API_docs_v81/types/NotifyPeer.md @@ -0,0 +1,24 @@ +--- +title: NotifyPeer +description: constructors and methods of type NotifyPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: NotifyPeer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[notifyPeer](../constructors/notifyPeer.md) + +[notifyUsers](../constructors/notifyUsers.md) + +[notifyChats](../constructors/notifyChats.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Null.md b/old_docs/API_docs_v81/types/Null.md new file mode 100644 index 00000000..58d38809 --- /dev/null +++ b/old_docs/API_docs_v81/types/Null.md @@ -0,0 +1,20 @@ +--- +title: Null +description: constructors and methods of type Null +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Null +[Back to types index](index.md) + + + +### Possible values (constructors): + +[null](../constructors/null.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Page.md b/old_docs/API_docs_v81/types/Page.md new file mode 100644 index 00000000..9f3c7b3a --- /dev/null +++ b/old_docs/API_docs_v81/types/Page.md @@ -0,0 +1,22 @@ +--- +title: Page +description: constructors and methods of type Page +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Page +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pagePart](../constructors/pagePart.md) + +[pageFull](../constructors/pageFull.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PageBlock.md b/old_docs/API_docs_v81/types/PageBlock.md new file mode 100644 index 00000000..729760c1 --- /dev/null +++ b/old_docs/API_docs_v81/types/PageBlock.md @@ -0,0 +1,64 @@ +--- +title: PageBlock +description: constructors and methods of type PageBlock +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageBlock +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageBlockUnsupported](../constructors/pageBlockUnsupported.md) + +[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) + +[pageBlockPhoto](../constructors/pageBlockPhoto.md) + +[pageBlockVideo](../constructors/pageBlockVideo.md) + +[pageBlockCover](../constructors/pageBlockCover.md) + +[pageBlockEmbed](../constructors/pageBlockEmbed.md) + +[pageBlockEmbedPost](../constructors/pageBlockEmbedPost.md) + +[pageBlockCollage](../constructors/pageBlockCollage.md) + +[pageBlockSlideshow](../constructors/pageBlockSlideshow.md) + +[pageBlockChannel](../constructors/pageBlockChannel.md) + +[pageBlockAudio](../constructors/pageBlockAudio.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PaymentCharge.md b/old_docs/API_docs_v81/types/PaymentCharge.md new file mode 100644 index 00000000..9cb17085 --- /dev/null +++ b/old_docs/API_docs_v81/types/PaymentCharge.md @@ -0,0 +1,20 @@ +--- +title: PaymentCharge +description: constructors and methods of type PaymentCharge +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PaymentCharge +[Back to types index](index.md) + + + +### Possible values (constructors): + +[paymentCharge](../constructors/paymentCharge.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PaymentRequestedInfo.md b/old_docs/API_docs_v81/types/PaymentRequestedInfo.md new file mode 100644 index 00000000..2f119ef3 --- /dev/null +++ b/old_docs/API_docs_v81/types/PaymentRequestedInfo.md @@ -0,0 +1,20 @@ +--- +title: PaymentRequestedInfo +description: constructors and methods of type PaymentRequestedInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PaymentRequestedInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[paymentRequestedInfo](../constructors/paymentRequestedInfo.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PaymentSavedCredentials.md b/old_docs/API_docs_v81/types/PaymentSavedCredentials.md new file mode 100644 index 00000000..8a2ae849 --- /dev/null +++ b/old_docs/API_docs_v81/types/PaymentSavedCredentials.md @@ -0,0 +1,20 @@ +--- +title: PaymentSavedCredentials +description: constructors and methods of type PaymentSavedCredentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PaymentSavedCredentials +[Back to types index](index.md) + + + +### Possible values (constructors): + +[paymentSavedCredentialsCard](../constructors/paymentSavedCredentialsCard.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Peer.md b/old_docs/API_docs_v81/types/Peer.md new file mode 100644 index 00000000..ca693596 --- /dev/null +++ b/old_docs/API_docs_v81/types/Peer.md @@ -0,0 +1,48 @@ +--- +title: Peer +description: constructors and methods of type Peer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Peer +[Back to types index](index.md) + + + +You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. + +The following syntaxes can also be used: + +``` +$Peer = '@username'; // Username + +$Peer = 'me'; // The currently logged-in user + +$Peer = 44700; // bot API id (users) +$Peer = -492772765; // bot API id (chats) +$Peer = -10038575794; // bot API id (channels) + +$Peer = 'https://t.me/danogentili'; // t.me URLs +$Peer = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$Peer = 'user#44700'; // tg-cli style id (users) +$Peer = 'chat#492772765'; // tg-cli style id (chats) +$Peer = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), or a [Chat](Chat.md) object can also be used. + + +### Possible values (constructors): + +[peerUser](../constructors/peerUser.md) + +[peerChat](../constructors/peerChat.md) + +[peerChannel](../constructors/peerChannel.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PeerNotifySettings.md b/old_docs/API_docs_v81/types/PeerNotifySettings.md new file mode 100644 index 00000000..ecb483c5 --- /dev/null +++ b/old_docs/API_docs_v81/types/PeerNotifySettings.md @@ -0,0 +1,22 @@ +--- +title: PeerNotifySettings +description: constructors and methods of type PeerNotifySettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PeerNotifySettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[peerNotifySettings](../constructors/peerNotifySettings.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getNotifySettings](../methods/account_getNotifySettings.md) + + + diff --git a/old_docs/API_docs_v81/types/PeerSettings.md b/old_docs/API_docs_v81/types/PeerSettings.md new file mode 100644 index 00000000..60ac3765 --- /dev/null +++ b/old_docs/API_docs_v81/types/PeerSettings.md @@ -0,0 +1,22 @@ +--- +title: PeerSettings +description: constructors and methods of type PeerSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PeerSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[peerSettings](../constructors/peerSettings.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getPeerSettings](../methods/messages_getPeerSettings.md) + + + diff --git a/old_docs/API_docs_v81/types/PhoneCall.md b/old_docs/API_docs_v81/types/PhoneCall.md new file mode 100644 index 00000000..64d95972 --- /dev/null +++ b/old_docs/API_docs_v81/types/PhoneCall.md @@ -0,0 +1,187 @@ +--- +title: PhoneCall +description: constructors and methods of type PhoneCall +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PhoneCall +[Back to types index](index.md) + + + +This is an object of type `\danog\MadelineProto\VoIP`. + +It will only be available if the [php-libtgvoip](https://github.com/danog/php-libtgvoip) extension is installed, see [the main docs](https://docs.madelineproto.xyz#calls) for an easy installation script. + +You MUST know [OOP](http://php.net/manual/en/language.oop5.php) to use this class. + +## Constants: + +VoIPController states (these constants are incrementing integers, thus can be compared like numbers): + +* `STATE_CREATED` - controller created +* `STATE_WAIT_INIT` - controller inited +* `STATE_WAIT_INIT_ACK` - controller inited +* `STATE_ESTABLISHED` - connection established +* `STATE_FAILED` - connection failed +* `STATE_RECONNECTING` - reconnecting + +VoIPController errors: + +* `TGVOIP_ERROR_UNKNOWN` - An unknown error occurred +* `TGVOIP_ERROR_INCOMPATIBLE` - The other side is using an unsupported client/protocol +* `TGVOIP_ERROR_TIMEOUT` - A timeout occurred +* `TGVOIP_ERROR_AUDIO_IO` - An I/O error occurred + +Network types (these constants are incrementing integers, thus can be compared like numbers): + +* `NET_TYPE_UNKNOWN` - Unknown network type +* `NET_TYPE_GPRS` - GPRS connection +* `NET_TYPE_EDGE` - EDGE connection +* `NET_TYPE_3G` - 3G connection +* `NET_TYPE_HSPA` - HSPA connection +* `NET_TYPE_LTE` - LTE connection +* `NET_TYPE_WIFI` - WIFI connection +* `NET_TYPE_ETHERNET` - Ethernet connection (this guarantees high audio quality) +* `NET_TYPE_OTHER_HIGH_SPEED` - Other high speed connection +* `NET_TYPE_OTHER_LOW_SPEED` - Other low speed connection +* `NET_TYPE_DIALUP` - Dialup connection +* `NET_TYPE_OTHER_MOBILE` - Other mobile network connection + +Data saving modes (these constants are incrementing integers, thus can be compared like numbers): + +* `DATA_SAVING_NEVER` - Never save data (this guarantees high audio quality) +* `DATA_SAVING_MOBILE` - Use mobile data saving profiles +* `DATA_SAVING_ALWAYS` - Always use data saving profiles + +Proxy settings (these constants are incrementing integers, thus can be compared like numbers): + +* `PROXY_NONE` - No proxy +* `PROXY_SOCKS5` - Use the socks5 protocol + +Audio states (these constants are incrementing integers, thus can be compared like numbers): + +* `AUDIO_STATE_NONE` - The audio module was not created yet +* `AUDIO_STATE_CREATED` - The audio module was created +* `AUDIO_STATE_CONFIGURED` - The audio module was configured +* `AUDIO_STATE_RUNNING` - The audio module is running + +Call states (these constants are incrementing integers, thus can be compared like numbers): + +* `CALL_STATE_NONE` - The call was not created yet +* `CALL_STATE_REQUESTED` - This is an outgoing call +* `CALL_STATE_INCOMING` - This is an incoming call +* `CALL_STATE_ACCEPTED` - The incoming call was accepted, but not yet ready +* `CALL_STATE_CONFIRMED` - The outgoing call was accepted, but not yet ready +* `CALL_STATE_READY` - The call is ready. Audio data is being sent and received +* `CALL_STATE_ENDED` - The call is over. + + + +## Methods: + +* `getState()` - Gets the controller state, as a VoIPController state constant +* `getCallState()` - Gets the call state, as a call state constant +* `getVisualization()` - Gets the visualization of the encryption key, as an array of emojis, can be called only when the call state is bigger than or equal to `CALL_STATE_READY`. If called sooner, returns false. +* `getStats()` Gets connection stats +* `getOtherID()` - Gets the id of the other call participant, as a bot API ID +* `getProtocol()` - Gets the protocol used by the current call, as a [PhoneCallProtocol](https://docs.madelineproto.xyz/API_docs/types/PhoneCallProtocol.html) object +* `getCallID()` - Gets the call ID, as an [InputPhoneCall](https://docs.madelineproto.xyz/API_docs/types/InputPhoneCall.html) object +* `isCreator()` - Returns a boolean that indicates whether you are the creator of the call +* `whenCreated()` - Returns the unix timestamp of when the call was started (when was the call state set to `CALL_STATE_READY`) +* `getOutputState()` - Returns the state of the audio output module, as an audio state constant +* `getInputState()` - Returns the state of the audio input module, as an audio state constant +* `getDebugLog()` - Gets VoIPController debug log +* `getDebugString()` - Gets VoIPController debug string +* `getLastError()` - Gets the last error as a VoIPController error constant +* `getVersion()` - Gets VoIPController version +* `getSignalBarsCount()` - Gets number of signal bars (0-4) + +* `parseConfig()` - Parses the configuration + +* `accept()` - Accepts the phone call, returns `$this` +* `discard($reason = ["_" => "phoneCallDiscardReasonDisconnect"], $rating = [])` - Ends the phone call. + +Accepts two optional parameters: + +`$reason` - can be a [PhoneCallDiscardReason](https://docs.madelineproto.xyz/API_docs/types/PhoneCallDiscardReason.html) object (defaults to a [phoneCallDiscardReasonDisconnect](https://docs.madelineproto.xyz/API_docs/constructors/phoneCallDiscardReasonDisconnect.html) object). + +`$rating` - Can be an array that must contain a rating, and a comment (`["rating" => 5, "comment" => "MadelineProto is very easy to use!"]). Defaults to an empty array.` + + + +* `getOutputParams()` - Returns the output audio configuration + +MadelineProto works using raw signed PCM audio, internally split in packets with `sampleNumber` samples. + +The audio configuration is an array structured in the following way: +``` +[ + "bitsPerSample" => int. // Bits in each PCM sample + "sampleRate" => int, // PCM sample rate + "channels" => int, // Number of PCM audio channels + "sampleNumber" => int, // The audio data is internally split in packets, each having this number of samples + "samplePeriod" => double, // PCM sample period in seconds, useful if you want to generate audio data manually + "writePeriod" => double, // PCM write period in seconds (samplePeriod*sampleNumber), useful if you want to generate audio data manually + "samplesSize" => int, // The audio data is internally split in packets, each having this number of bytes (sampleNumber*bitsPerSample/8) + "level" => int // idk +]; +``` + +* `getInputParams()` - Returns the input audio configuration + +MadelineProto works using raw signed PCM audio, internally split in packets with `sampleNumber` samples. + +The audio configuration is an array structured in the following way: +``` +[ + "bitsPerSample" => int. // Bits in each PCM sample + "sampleRate" => int, // PCM sample rate + "channels" => int, // Number of PCM audio channels + "sampleNumber" => int, // The audio data is internally split in packets, each having this number of samples + "samplePeriod" => double, // PCM sample period in seconds, useful if you want to generate audio data manually + "writePeriod" => double, // PCM write period in seconds (samplePeriod*sampleNumber), useful if you want to generate audio data manually + "samplesSize" => int, // The audio data is internally split in packets, each having this number of bytes (sampleNumber*bitsPerSample/8) +]; +``` + +* `play(string $file)` and `then(string $file)` - Play a certain audio file encoded in PCM, with the audio input configuration, returns `$this` +* `playOnHold(array $files)` - Array of audio files encoded in PCM, with the audio input configuration to loop on hold (when the files given with play/then have finished playing). If not called, no data will be played, returns `$this` +* `isPlaying()` - Returns true if MadelineProto is still playing the files given with play/then, false if the hold files (or nothing) is being played +* `setMicMute(bool $mute)` - Stops/resumes playing files/hold files, returns `$this` + +* `setOutputFile(string $outputfile)` - Writes incoming audio data to file encoded in PCM, with the audio output configuration, returns `$this` +* `unsetOutputFile()` - Stops writing audio data to previously set file, returns `$this` + + +## Properties: + +* `storage`: An array that can be used to store data related to this call. + +Easy as pie: + +``` +$call->storage["pony"] = "fluttershy"; +\danog\MadelineProto\Logger::log($call->storage["pony"]); // fluttershy +``` + +Note: when modifying this property, *never* overwrite the previous values. Always either modify the values of the array separately like showed above, or use array_merge. + + +* `configuration`: An array containing the libtgvoip configuration. + +You can only modify the data saving mode, the network type, the logging file path and the stats dump file path: + +Example: + +``` +$call->configuration["log_file_path"] = "logs".$call->getOtherID().".log"; // Default is /dev/null +$call->configuration["stats_dump_file_path"] = "stats".$call->getOtherID().".log"; // Default is /dev/null +$call->configuration["network_type"] = \danog\MadelineProto\VoIP::NET_TYPE_WIFI; // Default is NET_TYPE_ETHERNET +$call->configuration["data_saving"] = \danog\MadelineProto\VoIP::DATA_SAVING_MOBILE; // Default is DATA_SAVING_NEVER +$call->parseConfig(); // Always call this after changing settings +``` + +Note: when modifying this property, *never* overwrite the previous values. Always either modify the values of the array separately like showed above, or use array_merge. + +After modifying it, you must always parse the new configuration with a call to `parseConfig`. + diff --git a/old_docs/API_docs_v81/types/PhoneCallDiscardReason.md b/old_docs/API_docs_v81/types/PhoneCallDiscardReason.md new file mode 100644 index 00000000..cbf9ff9c --- /dev/null +++ b/old_docs/API_docs_v81/types/PhoneCallDiscardReason.md @@ -0,0 +1,26 @@ +--- +title: PhoneCallDiscardReason +description: constructors and methods of type PhoneCallDiscardReason +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PhoneCallDiscardReason +[Back to types index](index.md) + + + +### Possible values (constructors): + +[phoneCallDiscardReasonMissed](../constructors/phoneCallDiscardReasonMissed.md) + +[phoneCallDiscardReasonDisconnect](../constructors/phoneCallDiscardReasonDisconnect.md) + +[phoneCallDiscardReasonHangup](../constructors/phoneCallDiscardReasonHangup.md) + +[phoneCallDiscardReasonBusy](../constructors/phoneCallDiscardReasonBusy.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PhoneCallProtocol.md b/old_docs/API_docs_v81/types/PhoneCallProtocol.md new file mode 100644 index 00000000..eb9cbd49 --- /dev/null +++ b/old_docs/API_docs_v81/types/PhoneCallProtocol.md @@ -0,0 +1,20 @@ +--- +title: PhoneCallProtocol +description: constructors and methods of type PhoneCallProtocol +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PhoneCallProtocol +[Back to types index](index.md) + + + +### Possible values (constructors): + +[phoneCallProtocol](../constructors/phoneCallProtocol.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PhoneConnection.md b/old_docs/API_docs_v81/types/PhoneConnection.md new file mode 100644 index 00000000..a62f147f --- /dev/null +++ b/old_docs/API_docs_v81/types/PhoneConnection.md @@ -0,0 +1,20 @@ +--- +title: PhoneConnection +description: constructors and methods of type PhoneConnection +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PhoneConnection +[Back to types index](index.md) + + + +### Possible values (constructors): + +[phoneConnection](../constructors/phoneConnection.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Photo.md b/old_docs/API_docs_v81/types/Photo.md new file mode 100644 index 00000000..7cd6e713 --- /dev/null +++ b/old_docs/API_docs_v81/types/Photo.md @@ -0,0 +1,22 @@ +--- +title: Photo +description: constructors and methods of type Photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Photo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[photoEmpty](../constructors/photoEmpty.md) + +[photo](../constructors/photo.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PhotoSize.md b/old_docs/API_docs_v81/types/PhotoSize.md new file mode 100644 index 00000000..caf1684c --- /dev/null +++ b/old_docs/API_docs_v81/types/PhotoSize.md @@ -0,0 +1,24 @@ +--- +title: PhotoSize +description: constructors and methods of type PhotoSize +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PhotoSize +[Back to types index](index.md) + + + +### Possible values (constructors): + +[photoSizeEmpty](../constructors/photoSizeEmpty.md) + +[photoSize](../constructors/photoSize.md) + +[photoCachedSize](../constructors/photoCachedSize.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PopularContact.md b/old_docs/API_docs_v81/types/PopularContact.md new file mode 100644 index 00000000..5d61b85d --- /dev/null +++ b/old_docs/API_docs_v81/types/PopularContact.md @@ -0,0 +1,20 @@ +--- +title: PopularContact +description: constructors and methods of type PopularContact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PopularContact +[Back to types index](index.md) + + + +### Possible values (constructors): + +[popularContact](../constructors/popularContact.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PostAddress.md b/old_docs/API_docs_v81/types/PostAddress.md new file mode 100644 index 00000000..1715112d --- /dev/null +++ b/old_docs/API_docs_v81/types/PostAddress.md @@ -0,0 +1,20 @@ +--- +title: PostAddress +description: constructors and methods of type PostAddress +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PostAddress +[Back to types index](index.md) + + + +### Possible values (constructors): + +[postAddress](../constructors/postAddress.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PrivacyKey.md b/old_docs/API_docs_v81/types/PrivacyKey.md new file mode 100644 index 00000000..f86cf78a --- /dev/null +++ b/old_docs/API_docs_v81/types/PrivacyKey.md @@ -0,0 +1,24 @@ +--- +title: PrivacyKey +description: constructors and methods of type PrivacyKey +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PrivacyKey +[Back to types index](index.md) + + + +### Possible values (constructors): + +[privacyKeyStatusTimestamp](../constructors/privacyKeyStatusTimestamp.md) + +[privacyKeyChatInvite](../constructors/privacyKeyChatInvite.md) + +[privacyKeyPhoneCall](../constructors/privacyKeyPhoneCall.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/PrivacyRule.md b/old_docs/API_docs_v81/types/PrivacyRule.md new file mode 100644 index 00000000..5f0425b9 --- /dev/null +++ b/old_docs/API_docs_v81/types/PrivacyRule.md @@ -0,0 +1,30 @@ +--- +title: PrivacyRule +description: constructors and methods of type PrivacyRule +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PrivacyRule +[Back to types index](index.md) + + + +### Possible values (constructors): + +[privacyValueAllowContacts](../constructors/privacyValueAllowContacts.md) + +[privacyValueAllowAll](../constructors/privacyValueAllowAll.md) + +[privacyValueAllowUsers](../constructors/privacyValueAllowUsers.md) + +[privacyValueDisallowContacts](../constructors/privacyValueDisallowContacts.md) + +[privacyValueDisallowAll](../constructors/privacyValueDisallowAll.md) + +[privacyValueDisallowUsers](../constructors/privacyValueDisallowUsers.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/README.md b/old_docs/API_docs_v81/types/README.md new file mode 100644 index 00000000..0ec3b91f --- /dev/null +++ b/old_docs/API_docs_v81/types/README.md @@ -0,0 +1,475 @@ +--- +title: Types +description: List of types +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Types +[Back to API documentation index](..) + + +[AccessPointRule](AccessPointRule.md) + +[AccountDaysTTL](AccountDaysTTL.md) + +[Authorization](Authorization.md) + +[Bool](Bool.md) + +[BotCommand](BotCommand.md) + +[BotInfo](BotInfo.md) + +[BotInlineMessage](BotInlineMessage.md) + +[BotInlineResult](BotInlineResult.md) + +[CdnConfig](CdnConfig.md) + +[CdnPublicKey](CdnPublicKey.md) + +[ChannelAdminLogEvent](ChannelAdminLogEvent.md) + +[ChannelAdminLogEventAction](ChannelAdminLogEventAction.md) + +[ChannelAdminLogEventsFilter](ChannelAdminLogEventsFilter.md) + +[ChannelAdminRights](ChannelAdminRights.md) + +[ChannelBannedRights](ChannelBannedRights.md) + +[ChannelMessagesFilter](ChannelMessagesFilter.md) + +[ChannelParticipant](ChannelParticipant.md) + +[ChannelParticipantsFilter](ChannelParticipantsFilter.md) + +[Chat](Chat.md) + +[ChatFull](ChatFull.md) + +[ChatInvite](ChatInvite.md) + +[ChatParticipant](ChatParticipant.md) + +[ChatParticipants](ChatParticipants.md) + +[ChatPhoto](ChatPhoto.md) + +[Config](Config.md) + +[Contact](Contact.md) + +[ContactBlocked](ContactBlocked.md) + +[ContactLink](ContactLink.md) + +[ContactStatus](ContactStatus.md) + +[DataJSON](DataJSON.md) + +[DcOption](DcOption.md) + +[Dialog](Dialog.md) + +[DialogPeer](DialogPeer.md) + +[Document](Document.md) + +[DocumentAttribute](DocumentAttribute.md) + +[DraftMessage](DraftMessage.md) + +[EncryptedChat](EncryptedChat.md) + +[EncryptedFile](EncryptedFile.md) + +[EncryptedMessage](EncryptedMessage.md) + +[Error](Error.md) + +[ExportedChatInvite](ExportedChatInvite.md) + +[ExportedMessageLink](ExportedMessageLink.md) + +[FileHash](FileHash.md) + +[FileLocation](FileLocation.md) + +[FoundGif](FoundGif.md) + +[Game](Game.md) + +[GeoPoint](GeoPoint.md) + +[HighScore](HighScore.md) + +[ImportedContact](ImportedContact.md) + +[InlineBotSwitchPM](InlineBotSwitchPM.md) + +[InputAppEvent](InputAppEvent.md) + +[InputBotInlineMessage](InputBotInlineMessage.md) + +[InputBotInlineMessageID](InputBotInlineMessageID.md) + +[InputBotInlineResult](InputBotInlineResult.md) + +[InputChannel](InputChannel.md) + +[InputChatPhoto](InputChatPhoto.md) + +[InputClientProxy](InputClientProxy.md) + +[InputContact](InputContact.md) + +[InputDialogPeer](InputDialogPeer.md) + +[InputDocument](InputDocument.md) + +[InputEncryptedChat](InputEncryptedChat.md) + +[InputEncryptedFile](InputEncryptedFile.md) + +[InputFile](InputFile.md) + +[InputFileLocation](InputFileLocation.md) + +[InputGame](InputGame.md) + +[InputGeoPoint](InputGeoPoint.md) + +[InputMedia](InputMedia.md) + +[InputMessage](InputMessage.md) + +[InputNotifyPeer](InputNotifyPeer.md) + +[InputPaymentCredentials](InputPaymentCredentials.md) + +[InputPeer](InputPeer.md) + +[InputPeerNotifySettings](InputPeerNotifySettings.md) + +[InputPhoneCall](InputPhoneCall.md) + +[InputPhoto](InputPhoto.md) + +[InputPrivacyKey](InputPrivacyKey.md) + +[InputPrivacyRule](InputPrivacyRule.md) + +[InputSecureFile](InputSecureFile.md) + +[InputSecureValue](InputSecureValue.md) + +[InputSingleMedia](InputSingleMedia.md) + +[InputStickerSet](InputStickerSet.md) + +[InputStickerSetItem](InputStickerSetItem.md) + +[InputStickeredMedia](InputStickeredMedia.md) + +[InputUser](InputUser.md) + +[InputWebDocument](InputWebDocument.md) + +[InputWebFileLocation](InputWebFileLocation.md) + +[Invoice](Invoice.md) + +[IpPort](IpPort.md) + +[KeyboardButton](KeyboardButton.md) + +[KeyboardButtonRow](KeyboardButtonRow.md) + +[LabeledPrice](LabeledPrice.md) + +[LangPackDifference](LangPackDifference.md) + +[LangPackLanguage](LangPackLanguage.md) + +[LangPackString](LangPackString.md) + +[MaskCoords](MaskCoords.md) + +[Message](Message.md) + +[MessageAction](MessageAction.md) + +[MessageEntity](MessageEntity.md) + +[MessageFwdHeader](MessageFwdHeader.md) + +[MessageMedia](MessageMedia.md) + +[MessageRange](MessageRange.md) + +[MessagesFilter](MessagesFilter.md) + +[NearestDc](NearestDc.md) + +[NotifyPeer](NotifyPeer.md) + +[Null](Null.md) + +[Page](Page.md) + +[PageBlock](PageBlock.md) + +[PaymentCharge](PaymentCharge.md) + +[PaymentRequestedInfo](PaymentRequestedInfo.md) + +[PaymentSavedCredentials](PaymentSavedCredentials.md) + +[Peer](Peer.md) + +[PeerNotifySettings](PeerNotifySettings.md) + +[PeerSettings](PeerSettings.md) + +[PhoneCall](PhoneCall.md) + +[PhoneCallDiscardReason](PhoneCallDiscardReason.md) + +[PhoneCallProtocol](PhoneCallProtocol.md) + +[PhoneConnection](PhoneConnection.md) + +[Photo](Photo.md) + +[PhotoSize](PhotoSize.md) + +[PopularContact](PopularContact.md) + +[PostAddress](PostAddress.md) + +[PrivacyKey](PrivacyKey.md) + +[PrivacyRule](PrivacyRule.md) + +[ReceivedNotifyMessage](ReceivedNotifyMessage.md) + +[RecentMeUrl](RecentMeUrl.md) + +[ReplyMarkup](ReplyMarkup.md) + +[ReportReason](ReportReason.md) + +[RichText](RichText.md) + +[SavedContact](SavedContact.md) + +[SecureCredentialsEncrypted](SecureCredentialsEncrypted.md) + +[SecureData](SecureData.md) + +[SecureFile](SecureFile.md) + +[SecurePlainData](SecurePlainData.md) + +[SecureValue](SecureValue.md) + +[SecureValueError](SecureValueError.md) + +[SecureValueHash](SecureValueHash.md) + +[SecureValueType](SecureValueType.md) + +[SendMessageAction](SendMessageAction.md) + +[ShippingOption](ShippingOption.md) + +[StickerPack](StickerPack.md) + +[StickerSet](StickerSet.md) + +[StickerSetCovered](StickerSetCovered.md) + +[TopPeer](TopPeer.md) + +[TopPeerCategory](TopPeerCategory.md) + +[TopPeerCategoryPeers](TopPeerCategoryPeers.md) + +[True](True.md) + +[Update](Update.md) + +[Updates](Updates.md) + +[User](User.md) + +[UserFull](UserFull.md) + +[UserProfilePhoto](UserProfilePhoto.md) + +[UserStatus](UserStatus.md) + +[WallPaper](WallPaper.md) + +[WebAuthorization](WebAuthorization.md) + +[WebDocument](WebDocument.md) + +[WebPage](WebPage.md) + +[X](X.md) + +[account\_AuthorizationForm](account_AuthorizationForm.md) + +[account\_Authorizations](account_Authorizations.md) + +[account\_Password](account_Password.md) + +[account\_PasswordInputSettings](account_PasswordInputSettings.md) + +[account\_PasswordSettings](account_PasswordSettings.md) + +[account\_PrivacyRules](account_PrivacyRules.md) + +[account\_SentEmailCode](account_SentEmailCode.md) + +[account\_Takeout](account_Takeout.md) + +[account\_TmpPassword](account_TmpPassword.md) + +[account\_WebAuthorizations](account_WebAuthorizations.md) + +[auth\_Authorization](auth_Authorization.md) + +[auth\_CheckedPhone](auth_CheckedPhone.md) + +[auth\_CodeType](auth_CodeType.md) + +[auth\_ExportedAuthorization](auth_ExportedAuthorization.md) + +[auth\_PasswordRecovery](auth_PasswordRecovery.md) + +[auth\_SentCode](auth_SentCode.md) + +[auth\_SentCodeType](auth_SentCodeType.md) + +[channels\_AdminLogResults](channels_AdminLogResults.md) + +[channels\_ChannelParticipant](channels_ChannelParticipant.md) + +[channels\_ChannelParticipants](channels_ChannelParticipants.md) + +[contacts\_Blocked](contacts_Blocked.md) + +[contacts\_Contacts](contacts_Contacts.md) + +[contacts\_Found](contacts_Found.md) + +[contacts\_ImportedContacts](contacts_ImportedContacts.md) + +[contacts\_Link](contacts_Link.md) + +[contacts\_ResolvedPeer](contacts_ResolvedPeer.md) + +[contacts\_TopPeers](contacts_TopPeers.md) + +[help\_AppUpdate](help_AppUpdate.md) + +[help\_ConfigSimple](help_ConfigSimple.md) + +[help\_DeepLinkInfo](help_DeepLinkInfo.md) + +[help\_InviteText](help_InviteText.md) + +[help\_ProxyData](help_ProxyData.md) + +[help\_RecentMeUrls](help_RecentMeUrls.md) + +[help\_Support](help_Support.md) + +[help\_TermsOfServiceUpdate](help_TermsOfServiceUpdate.md) + +[help\_wTermsOfService](help_wTermsOfService.md) + +[int](int.md) + +[long](long.md) + +[messages\_AffectedHistory](messages_AffectedHistory.md) + +[messages\_AffectedMessages](messages_AffectedMessages.md) + +[messages\_AllStickers](messages_AllStickers.md) + +[messages\_ArchivedStickers](messages_ArchivedStickers.md) + +[messages\_BotCallbackAnswer](messages_BotCallbackAnswer.md) + +[messages\_BotResults](messages_BotResults.md) + +[messages\_ChatFull](messages_ChatFull.md) + +[messages\_Chats](messages_Chats.md) + +[messages\_DhConfig](messages_DhConfig.md) + +[messages\_Dialogs](messages_Dialogs.md) + +[messages\_FavedStickers](messages_FavedStickers.md) + +[messages\_FeaturedStickers](messages_FeaturedStickers.md) + +[messages\_FoundGifs](messages_FoundGifs.md) + +[messages\_FoundStickerSets](messages_FoundStickerSets.md) + +[messages\_HighScores](messages_HighScores.md) + +[messages\_MessageEditData](messages_MessageEditData.md) + +[messages\_Messages](messages_Messages.md) + +[messages\_PeerDialogs](messages_PeerDialogs.md) + +[messages\_RecentStickers](messages_RecentStickers.md) + +[messages\_SavedGifs](messages_SavedGifs.md) + +[messages\_SentEncryptedMessage](messages_SentEncryptedMessage.md) + +[messages\_StickerSet](messages_StickerSet.md) + +[messages\_StickerSetInstallResult](messages_StickerSetInstallResult.md) + +[messages\_Stickers](messages_Stickers.md) + +[payments\_PaymentForm](payments_PaymentForm.md) + +[payments\_PaymentReceipt](payments_PaymentReceipt.md) + +[payments\_PaymentResult](payments_PaymentResult.md) + +[payments\_SavedInfo](payments_SavedInfo.md) + +[payments\_ValidatedRequestedInfo](payments_ValidatedRequestedInfo.md) + +[phone\_PhoneCall](phone_PhoneCall.md) + +[photos\_Photo](photos_Photo.md) + +[photos\_Photos](photos_Photos.md) + +[storage\_FileType](storage_FileType.md) + +[updates\_ChannelDifference](updates_ChannelDifference.md) + +[updates\_Difference](updates_Difference.md) + +[updates\_State](updates_State.md) + +[upload\_CdnFile](upload_CdnFile.md) + +[upload\_File](upload_File.md) + +[upload\_WebFile](upload_WebFile.md) + diff --git a/old_docs/API_docs_v81/types/ReceivedNotifyMessage.md b/old_docs/API_docs_v81/types/ReceivedNotifyMessage.md new file mode 100644 index 00000000..c7fc3b8c --- /dev/null +++ b/old_docs/API_docs_v81/types/ReceivedNotifyMessage.md @@ -0,0 +1,22 @@ +--- +title: ReceivedNotifyMessage +description: constructors and methods of type ReceivedNotifyMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ReceivedNotifyMessage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[receivedNotifyMessage](../constructors/receivedNotifyMessage.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->receivedMessages](../methods/messages_receivedMessages.md) + + + diff --git a/old_docs/API_docs_v81/types/RecentMeUrl.md b/old_docs/API_docs_v81/types/RecentMeUrl.md new file mode 100644 index 00000000..4fd43199 --- /dev/null +++ b/old_docs/API_docs_v81/types/RecentMeUrl.md @@ -0,0 +1,28 @@ +--- +title: RecentMeUrl +description: constructors and methods of type RecentMeUrl +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: RecentMeUrl +[Back to types index](index.md) + + + +### Possible values (constructors): + +[recentMeUrlUnknown](../constructors/recentMeUrlUnknown.md) + +[recentMeUrlUser](../constructors/recentMeUrlUser.md) + +[recentMeUrlChat](../constructors/recentMeUrlChat.md) + +[recentMeUrlChatInvite](../constructors/recentMeUrlChatInvite.md) + +[recentMeUrlStickerSet](../constructors/recentMeUrlStickerSet.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ReplyMarkup.md b/old_docs/API_docs_v81/types/ReplyMarkup.md new file mode 100644 index 00000000..a1f5f21d --- /dev/null +++ b/old_docs/API_docs_v81/types/ReplyMarkup.md @@ -0,0 +1,26 @@ +--- +title: ReplyMarkup +description: constructors and methods of type ReplyMarkup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ReplyMarkup +[Back to types index](index.md) + + + +### Possible values (constructors): + +[replyKeyboardHide](../constructors/replyKeyboardHide.md) + +[replyKeyboardForceReply](../constructors/replyKeyboardForceReply.md) + +[replyKeyboardMarkup](../constructors/replyKeyboardMarkup.md) + +[replyInlineMarkup](../constructors/replyInlineMarkup.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ReportReason.md b/old_docs/API_docs_v81/types/ReportReason.md new file mode 100644 index 00000000..b7d87ec8 --- /dev/null +++ b/old_docs/API_docs_v81/types/ReportReason.md @@ -0,0 +1,26 @@ +--- +title: ReportReason +description: constructors and methods of type ReportReason +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ReportReason +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputReportReasonSpam](../constructors/inputReportReasonSpam.md) + +[inputReportReasonViolence](../constructors/inputReportReasonViolence.md) + +[inputReportReasonPornography](../constructors/inputReportReasonPornography.md) + +[inputReportReasonOther](../constructors/inputReportReasonOther.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/RichText.md b/old_docs/API_docs_v81/types/RichText.md new file mode 100644 index 00000000..f36d50fd --- /dev/null +++ b/old_docs/API_docs_v81/types/RichText.md @@ -0,0 +1,38 @@ +--- +title: RichText +description: constructors and methods of type RichText +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: RichText +[Back to types index](index.md) + + + +### Possible values (constructors): + +[textEmpty](../constructors/textEmpty.md) + +[textPlain](../constructors/textPlain.md) + +[textBold](../constructors/textBold.md) + +[textItalic](../constructors/textItalic.md) + +[textUnderline](../constructors/textUnderline.md) + +[textStrike](../constructors/textStrike.md) + +[textFixed](../constructors/textFixed.md) + +[textUrl](../constructors/textUrl.md) + +[textEmail](../constructors/textEmail.md) + +[textConcat](../constructors/textConcat.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/SavedContact.md b/old_docs/API_docs_v81/types/SavedContact.md new file mode 100644 index 00000000..c337f3eb --- /dev/null +++ b/old_docs/API_docs_v81/types/SavedContact.md @@ -0,0 +1,22 @@ +--- +title: SavedContact +description: constructors and methods of type SavedContact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SavedContact +[Back to types index](index.md) + + + +### Possible values (constructors): + +[savedPhoneContact](../constructors/savedPhoneContact.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->getSaved](../methods/contacts_getSaved.md) + + + diff --git a/old_docs/API_docs_v81/types/SecureCredentialsEncrypted.md b/old_docs/API_docs_v81/types/SecureCredentialsEncrypted.md new file mode 100644 index 00000000..b3f45428 --- /dev/null +++ b/old_docs/API_docs_v81/types/SecureCredentialsEncrypted.md @@ -0,0 +1,20 @@ +--- +title: SecureCredentialsEncrypted +description: constructors and methods of type SecureCredentialsEncrypted +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureCredentialsEncrypted +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureCredentialsEncrypted](../constructors/secureCredentialsEncrypted.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/SecureData.md b/old_docs/API_docs_v81/types/SecureData.md new file mode 100644 index 00000000..54ebc5fd --- /dev/null +++ b/old_docs/API_docs_v81/types/SecureData.md @@ -0,0 +1,20 @@ +--- +title: SecureData +description: constructors and methods of type SecureData +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureData +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureData](../constructors/secureData.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/SecureFile.md b/old_docs/API_docs_v81/types/SecureFile.md new file mode 100644 index 00000000..989d8522 --- /dev/null +++ b/old_docs/API_docs_v81/types/SecureFile.md @@ -0,0 +1,22 @@ +--- +title: SecureFile +description: constructors and methods of type SecureFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureFile +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureFileEmpty](../constructors/secureFileEmpty.md) + +[secureFile](../constructors/secureFile.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/SecurePlainData.md b/old_docs/API_docs_v81/types/SecurePlainData.md new file mode 100644 index 00000000..7fe1c49c --- /dev/null +++ b/old_docs/API_docs_v81/types/SecurePlainData.md @@ -0,0 +1,22 @@ +--- +title: SecurePlainData +description: constructors and methods of type SecurePlainData +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecurePlainData +[Back to types index](index.md) + + + +### Possible values (constructors): + +[securePlainPhone](../constructors/securePlainPhone.md) + +[securePlainEmail](../constructors/securePlainEmail.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/SecureValue.md b/old_docs/API_docs_v81/types/SecureValue.md new file mode 100644 index 00000000..8490f399 --- /dev/null +++ b/old_docs/API_docs_v81/types/SecureValue.md @@ -0,0 +1,26 @@ +--- +title: SecureValue +description: constructors and methods of type SecureValue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureValue +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureValue](../constructors/secureValue.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getAllSecureValues](../methods/account_getAllSecureValues.md) + +[$MadelineProto->account->getSecureValue](../methods/account_getSecureValue.md) + +[$MadelineProto->account->saveSecureValue](../methods/account_saveSecureValue.md) + + + diff --git a/old_docs/API_docs_v81/types/SecureValueError.md b/old_docs/API_docs_v81/types/SecureValueError.md new file mode 100644 index 00000000..ab51f8f1 --- /dev/null +++ b/old_docs/API_docs_v81/types/SecureValueError.md @@ -0,0 +1,30 @@ +--- +title: SecureValueError +description: constructors and methods of type SecureValueError +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureValueError +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureValueErrorData](../constructors/secureValueErrorData.md) + +[secureValueErrorFrontSide](../constructors/secureValueErrorFrontSide.md) + +[secureValueErrorReverseSide](../constructors/secureValueErrorReverseSide.md) + +[secureValueErrorSelfie](../constructors/secureValueErrorSelfie.md) + +[secureValueErrorFile](../constructors/secureValueErrorFile.md) + +[secureValueErrorFiles](../constructors/secureValueErrorFiles.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/SecureValueHash.md b/old_docs/API_docs_v81/types/SecureValueHash.md new file mode 100644 index 00000000..4857148c --- /dev/null +++ b/old_docs/API_docs_v81/types/SecureValueHash.md @@ -0,0 +1,20 @@ +--- +title: SecureValueHash +description: constructors and methods of type SecureValueHash +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureValueHash +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureValueHash](../constructors/secureValueHash.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/SecureValueType.md b/old_docs/API_docs_v81/types/SecureValueType.md new file mode 100644 index 00000000..740cbf51 --- /dev/null +++ b/old_docs/API_docs_v81/types/SecureValueType.md @@ -0,0 +1,44 @@ +--- +title: SecureValueType +description: constructors and methods of type SecureValueType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureValueType +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureValueTypePersonalDetails](../constructors/secureValueTypePersonalDetails.md) + +[secureValueTypePassport](../constructors/secureValueTypePassport.md) + +[secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md) + +[secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md) + +[secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md) + +[secureValueTypeAddress](../constructors/secureValueTypeAddress.md) + +[secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md) + +[secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md) + +[secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md) + +[secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md) + +[secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md) + +[secureValueTypePhone](../constructors/secureValueTypePhone.md) + +[secureValueTypeEmail](../constructors/secureValueTypeEmail.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/SendMessageAction.md b/old_docs/API_docs_v81/types/SendMessageAction.md new file mode 100644 index 00000000..8826af78 --- /dev/null +++ b/old_docs/API_docs_v81/types/SendMessageAction.md @@ -0,0 +1,44 @@ +--- +title: SendMessageAction +description: constructors and methods of type SendMessageAction +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SendMessageAction +[Back to types index](index.md) + + + +### Possible values (constructors): + +[sendMessageTypingAction](../constructors/sendMessageTypingAction.md) + +[sendMessageCancelAction](../constructors/sendMessageCancelAction.md) + +[sendMessageRecordVideoAction](../constructors/sendMessageRecordVideoAction.md) + +[sendMessageUploadVideoAction](../constructors/sendMessageUploadVideoAction.md) + +[sendMessageRecordAudioAction](../constructors/sendMessageRecordAudioAction.md) + +[sendMessageUploadAudioAction](../constructors/sendMessageUploadAudioAction.md) + +[sendMessageUploadPhotoAction](../constructors/sendMessageUploadPhotoAction.md) + +[sendMessageUploadDocumentAction](../constructors/sendMessageUploadDocumentAction.md) + +[sendMessageGeoLocationAction](../constructors/sendMessageGeoLocationAction.md) + +[sendMessageChooseContactAction](../constructors/sendMessageChooseContactAction.md) + +[sendMessageGamePlayAction](../constructors/sendMessageGamePlayAction.md) + +[sendMessageRecordRoundAction](../constructors/sendMessageRecordRoundAction.md) + +[sendMessageUploadRoundAction](../constructors/sendMessageUploadRoundAction.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/ShippingOption.md b/old_docs/API_docs_v81/types/ShippingOption.md new file mode 100644 index 00000000..57847fe1 --- /dev/null +++ b/old_docs/API_docs_v81/types/ShippingOption.md @@ -0,0 +1,20 @@ +--- +title: ShippingOption +description: constructors and methods of type ShippingOption +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# 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/old_docs/API_docs_v81/types/StickerPack.md b/old_docs/API_docs_v81/types/StickerPack.md new file mode 100644 index 00000000..ffb83b15 --- /dev/null +++ b/old_docs/API_docs_v81/types/StickerPack.md @@ -0,0 +1,20 @@ +--- +title: StickerPack +description: constructors and methods of type StickerPack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: StickerPack +[Back to types index](index.md) + + + +### Possible values (constructors): + +[stickerPack](../constructors/stickerPack.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/StickerSet.md b/old_docs/API_docs_v81/types/StickerSet.md new file mode 100644 index 00000000..70aa63dc --- /dev/null +++ b/old_docs/API_docs_v81/types/StickerSet.md @@ -0,0 +1,20 @@ +--- +title: StickerSet +description: constructors and methods of type StickerSet +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: StickerSet +[Back to types index](index.md) + + + +### Possible values (constructors): + +[stickerSet](../constructors/stickerSet.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/StickerSetCovered.md b/old_docs/API_docs_v81/types/StickerSetCovered.md new file mode 100644 index 00000000..ffd1da1f --- /dev/null +++ b/old_docs/API_docs_v81/types/StickerSetCovered.md @@ -0,0 +1,24 @@ +--- +title: StickerSetCovered +description: constructors and methods of type StickerSetCovered +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: StickerSetCovered +[Back to types index](index.md) + + + +### Possible values (constructors): + +[stickerSetCovered](../constructors/stickerSetCovered.md) + +[stickerSetMultiCovered](../constructors/stickerSetMultiCovered.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getAttachedStickers](../methods/messages_getAttachedStickers.md) + + + diff --git a/old_docs/API_docs_v81/types/TopPeer.md b/old_docs/API_docs_v81/types/TopPeer.md new file mode 100644 index 00000000..ff51630a --- /dev/null +++ b/old_docs/API_docs_v81/types/TopPeer.md @@ -0,0 +1,20 @@ +--- +title: TopPeer +description: constructors and methods of type TopPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: TopPeer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[topPeer](../constructors/topPeer.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/TopPeerCategory.md b/old_docs/API_docs_v81/types/TopPeerCategory.md new file mode 100644 index 00000000..6aae0da3 --- /dev/null +++ b/old_docs/API_docs_v81/types/TopPeerCategory.md @@ -0,0 +1,30 @@ +--- +title: TopPeerCategory +description: constructors and methods of type TopPeerCategory +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: TopPeerCategory +[Back to types index](index.md) + + + +### Possible values (constructors): + +[topPeerCategoryBotsPM](../constructors/topPeerCategoryBotsPM.md) + +[topPeerCategoryBotsInline](../constructors/topPeerCategoryBotsInline.md) + +[topPeerCategoryCorrespondents](../constructors/topPeerCategoryCorrespondents.md) + +[topPeerCategoryGroups](../constructors/topPeerCategoryGroups.md) + +[topPeerCategoryChannels](../constructors/topPeerCategoryChannels.md) + +[topPeerCategoryPhoneCalls](../constructors/topPeerCategoryPhoneCalls.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/TopPeerCategoryPeers.md b/old_docs/API_docs_v81/types/TopPeerCategoryPeers.md new file mode 100644 index 00000000..9fe37e57 --- /dev/null +++ b/old_docs/API_docs_v81/types/TopPeerCategoryPeers.md @@ -0,0 +1,20 @@ +--- +title: TopPeerCategoryPeers +description: constructors and methods of type TopPeerCategoryPeers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: TopPeerCategoryPeers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[topPeerCategoryPeers](../constructors/topPeerCategoryPeers.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/True.md b/old_docs/API_docs_v81/types/True.md new file mode 100644 index 00000000..ea96d248 --- /dev/null +++ b/old_docs/API_docs_v81/types/True.md @@ -0,0 +1,20 @@ +--- +title: True +description: constructors and methods of type True +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: True +[Back to types index](index.md) + + + +### Possible values (constructors): + +[true](../constructors/true.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Update.md b/old_docs/API_docs_v81/types/Update.md new file mode 100644 index 00000000..2b112450 --- /dev/null +++ b/old_docs/API_docs_v81/types/Update.md @@ -0,0 +1,150 @@ +--- +title: Update +description: constructors and methods of type Update +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Update +[Back to types index](index.md) + + + +### Possible values (constructors): + +[updateNewMessage](../constructors/updateNewMessage.md) + +[updateMessageID](../constructors/updateMessageID.md) + +[updateDeleteMessages](../constructors/updateDeleteMessages.md) + +[updateUserTyping](../constructors/updateUserTyping.md) + +[updateChatUserTyping](../constructors/updateChatUserTyping.md) + +[updateChatParticipants](../constructors/updateChatParticipants.md) + +[updateUserStatus](../constructors/updateUserStatus.md) + +[updateUserName](../constructors/updateUserName.md) + +[updateUserPhoto](../constructors/updateUserPhoto.md) + +[updateContactRegistered](../constructors/updateContactRegistered.md) + +[updateContactLink](../constructors/updateContactLink.md) + +[updateNewEncryptedMessage](../constructors/updateNewEncryptedMessage.md) + +[updateEncryptedChatTyping](../constructors/updateEncryptedChatTyping.md) + +[updateEncryption](../constructors/updateEncryption.md) + +[updateEncryptedMessagesRead](../constructors/updateEncryptedMessagesRead.md) + +[updateChatParticipantAdd](../constructors/updateChatParticipantAdd.md) + +[updateChatParticipantDelete](../constructors/updateChatParticipantDelete.md) + +[updateDcOptions](../constructors/updateDcOptions.md) + +[updateUserBlocked](../constructors/updateUserBlocked.md) + +[updateNotifySettings](../constructors/updateNotifySettings.md) + +[updateServiceNotification](../constructors/updateServiceNotification.md) + +[updatePrivacy](../constructors/updatePrivacy.md) + +[updateUserPhone](../constructors/updateUserPhone.md) + +[updateReadHistoryInbox](../constructors/updateReadHistoryInbox.md) + +[updateReadHistoryOutbox](../constructors/updateReadHistoryOutbox.md) + +[updateWebPage](../constructors/updateWebPage.md) + +[updateReadMessagesContents](../constructors/updateReadMessagesContents.md) + +[updateChannelTooLong](../constructors/updateChannelTooLong.md) + +[updateChannel](../constructors/updateChannel.md) + +[updateNewChannelMessage](../constructors/updateNewChannelMessage.md) + +[updateReadChannelInbox](../constructors/updateReadChannelInbox.md) + +[updateDeleteChannelMessages](../constructors/updateDeleteChannelMessages.md) + +[updateChannelMessageViews](../constructors/updateChannelMessageViews.md) + +[updateChatAdmins](../constructors/updateChatAdmins.md) + +[updateChatParticipantAdmin](../constructors/updateChatParticipantAdmin.md) + +[updateNewStickerSet](../constructors/updateNewStickerSet.md) + +[updateStickerSetsOrder](../constructors/updateStickerSetsOrder.md) + +[updateStickerSets](../constructors/updateStickerSets.md) + +[updateSavedGifs](../constructors/updateSavedGifs.md) + +[updateBotInlineQuery](../constructors/updateBotInlineQuery.md) + +[updateBotInlineSend](../constructors/updateBotInlineSend.md) + +[updateEditChannelMessage](../constructors/updateEditChannelMessage.md) + +[updateChannelPinnedMessage](../constructors/updateChannelPinnedMessage.md) + +[updateBotCallbackQuery](../constructors/updateBotCallbackQuery.md) + +[updateEditMessage](../constructors/updateEditMessage.md) + +[updateInlineBotCallbackQuery](../constructors/updateInlineBotCallbackQuery.md) + +[updateReadChannelOutbox](../constructors/updateReadChannelOutbox.md) + +[updateDraftMessage](../constructors/updateDraftMessage.md) + +[updateReadFeaturedStickers](../constructors/updateReadFeaturedStickers.md) + +[updateRecentStickers](../constructors/updateRecentStickers.md) + +[updateConfig](../constructors/updateConfig.md) + +[updatePtsChanged](../constructors/updatePtsChanged.md) + +[updateChannelWebPage](../constructors/updateChannelWebPage.md) + +[updateDialogPinned](../constructors/updateDialogPinned.md) + +[updatePinnedDialogs](../constructors/updatePinnedDialogs.md) + +[updateBotWebhookJSON](../constructors/updateBotWebhookJSON.md) + +[updateBotWebhookJSONQuery](../constructors/updateBotWebhookJSONQuery.md) + +[updateBotShippingQuery](../constructors/updateBotShippingQuery.md) + +[updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) + +[updatePhoneCall](../constructors/updatePhoneCall.md) + +[updateLangPackTooLong](../constructors/updateLangPackTooLong.md) + +[updateLangPack](../constructors/updateLangPack.md) + +[updateFavedStickers](../constructors/updateFavedStickers.md) + +[updateChannelReadMessagesContents](../constructors/updateChannelReadMessagesContents.md) + +[updateContactsReset](../constructors/updateContactsReset.md) + +[updateChannelAvailableMessages](../constructors/updateChannelAvailableMessages.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/Updates.md b/old_docs/API_docs_v81/types/Updates.md new file mode 100644 index 00000000..a62f270d --- /dev/null +++ b/old_docs/API_docs_v81/types/Updates.md @@ -0,0 +1,100 @@ +--- +title: Updates +description: constructors and methods of type Updates +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Updates +[Back to types index](index.md) + + + +### Possible values (constructors): + +[updatesTooLong](../constructors/updatesTooLong.md) + +[updateShortMessage](../constructors/updateShortMessage.md) + +[updateShortChatMessage](../constructors/updateShortChatMessage.md) + +[updateShort](../constructors/updateShort.md) + +[updatesCombined](../constructors/updatesCombined.md) + +[updates](../constructors/updates.md) + +[updateShortSentMessage](../constructors/updateShortSentMessage.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->sendMessage](../methods/messages_sendMessage.md) + +[$MadelineProto->messages->sendMedia](../methods/messages_sendMedia.md) + +[$MadelineProto->messages->forwardMessages](../methods/messages_forwardMessages.md) + +[$MadelineProto->messages->editChatTitle](../methods/messages_editChatTitle.md) + +[$MadelineProto->messages->editChatPhoto](../methods/messages_editChatPhoto.md) + +[$MadelineProto->messages->addChatUser](../methods/messages_addChatUser.md) + +[$MadelineProto->messages->deleteChatUser](../methods/messages_deleteChatUser.md) + +[$MadelineProto->messages->createChat](../methods/messages_createChat.md) + +[$MadelineProto->messages->importChatInvite](../methods/messages_importChatInvite.md) + +[$MadelineProto->messages->startBot](../methods/messages_startBot.md) + +[$MadelineProto->messages->toggleChatAdmins](../methods/messages_toggleChatAdmins.md) + +[$MadelineProto->messages->migrateChat](../methods/messages_migrateChat.md) + +[$MadelineProto->messages->sendInlineBotResult](../methods/messages_sendInlineBotResult.md) + +[$MadelineProto->messages->editMessage](../methods/messages_editMessage.md) + +[$MadelineProto->messages->getAllDrafts](../methods/messages_getAllDrafts.md) + +[$MadelineProto->messages->setGameScore](../methods/messages_setGameScore.md) + +[$MadelineProto->messages->sendScreenshotNotification](../methods/messages_sendScreenshotNotification.md) + +[$MadelineProto->messages->sendMultiMedia](../methods/messages_sendMultiMedia.md) + +[$MadelineProto->help->getAppChangelog](../methods/help_getAppChangelog.md) + +[$MadelineProto->channels->createChannel](../methods/channels_createChannel.md) + +[$MadelineProto->channels->editAdmin](../methods/channels_editAdmin.md) + +[$MadelineProto->channels->editTitle](../methods/channels_editTitle.md) + +[$MadelineProto->channels->editPhoto](../methods/channels_editPhoto.md) + +[$MadelineProto->channels->joinChannel](../methods/channels_joinChannel.md) + +[$MadelineProto->channels->leaveChannel](../methods/channels_leaveChannel.md) + +[$MadelineProto->channels->inviteToChannel](../methods/channels_inviteToChannel.md) + +[$MadelineProto->channels->deleteChannel](../methods/channels_deleteChannel.md) + +[$MadelineProto->channels->toggleInvites](../methods/channels_toggleInvites.md) + +[$MadelineProto->channels->toggleSignatures](../methods/channels_toggleSignatures.md) + +[$MadelineProto->channels->updatePinnedMessage](../methods/channels_updatePinnedMessage.md) + +[$MadelineProto->channels->editBanned](../methods/channels_editBanned.md) + +[$MadelineProto->channels->togglePreHistoryHidden](../methods/channels_togglePreHistoryHidden.md) + +[$MadelineProto->phone->discardCall](../methods/phone_discardCall.md) + +[$MadelineProto->phone->setCallRating](../methods/phone_setCallRating.md) + + + diff --git a/old_docs/API_docs_v81/types/User.md b/old_docs/API_docs_v81/types/User.md new file mode 100644 index 00000000..3f0af641 --- /dev/null +++ b/old_docs/API_docs_v81/types/User.md @@ -0,0 +1,56 @@ +--- +title: User +description: constructors and methods of type User +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: User +[Back to types index](index.md) + + + +You can directly provide the [Update](Update.md) or [Message](Message.md) object here, MadelineProto will automatically extract the destination chat id. + +The following syntaxes can also be used: + +``` +$User = '@username'; // Username + +$User = 'me'; // The currently logged-in user + +$User = 44700; // bot API id (users) +$User = -492772765; // bot API id (chats) +$User = -10038575794; // bot API id (channels) + +$User = 'https://t.me/danogentili'; // t.me URLs +$User = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$User = 'user#44700'; // tg-cli style id (users) +$User = 'chat#492772765'; // tg-cli style id (chats) +$User = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), or a [Chat](Chat.md) object can also be used. + + +### Possible values (constructors): + +[userEmpty](../constructors/userEmpty.md) + +[user](../constructors/user.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->updateProfile](../methods/account_updateProfile.md) + +[$MadelineProto->account->updateUsername](../methods/account_updateUsername.md) + +[$MadelineProto->account->changePhone](../methods/account_changePhone.md) + +[$MadelineProto->users->getUsers](../methods/users_getUsers.md) + +[$MadelineProto->contacts->importCard](../methods/contacts_importCard.md) + + + diff --git a/old_docs/API_docs_v81/types/UserFull.md b/old_docs/API_docs_v81/types/UserFull.md new file mode 100644 index 00000000..79ad30bb --- /dev/null +++ b/old_docs/API_docs_v81/types/UserFull.md @@ -0,0 +1,22 @@ +--- +title: UserFull +description: constructors and methods of type UserFull +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: UserFull +[Back to types index](index.md) + + + +### Possible values (constructors): + +[userFull](../constructors/userFull.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->users->getFullUser](../methods/users_getFullUser.md) + + + diff --git a/old_docs/API_docs_v81/types/UserProfilePhoto.md b/old_docs/API_docs_v81/types/UserProfilePhoto.md new file mode 100644 index 00000000..e5243a2e --- /dev/null +++ b/old_docs/API_docs_v81/types/UserProfilePhoto.md @@ -0,0 +1,24 @@ +--- +title: UserProfilePhoto +description: constructors and methods of type UserProfilePhoto +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: UserProfilePhoto +[Back to types index](index.md) + + + +### Possible values (constructors): + +[userProfilePhotoEmpty](../constructors/userProfilePhotoEmpty.md) + +[userProfilePhoto](../constructors/userProfilePhoto.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->photos->updateProfilePhoto](../methods/photos_updateProfilePhoto.md) + + + diff --git a/old_docs/API_docs_v81/types/UserStatus.md b/old_docs/API_docs_v81/types/UserStatus.md new file mode 100644 index 00000000..a5f9ec16 --- /dev/null +++ b/old_docs/API_docs_v81/types/UserStatus.md @@ -0,0 +1,30 @@ +--- +title: UserStatus +description: constructors and methods of type UserStatus +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: UserStatus +[Back to types index](index.md) + + + +### Possible values (constructors): + +[userStatusEmpty](../constructors/userStatusEmpty.md) + +[userStatusOnline](../constructors/userStatusOnline.md) + +[userStatusOffline](../constructors/userStatusOffline.md) + +[userStatusRecently](../constructors/userStatusRecently.md) + +[userStatusLastWeek](../constructors/userStatusLastWeek.md) + +[userStatusLastMonth](../constructors/userStatusLastMonth.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/WallPaper.md b/old_docs/API_docs_v81/types/WallPaper.md new file mode 100644 index 00000000..8c5ac7cf --- /dev/null +++ b/old_docs/API_docs_v81/types/WallPaper.md @@ -0,0 +1,24 @@ +--- +title: WallPaper +description: constructors and methods of type WallPaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: WallPaper +[Back to types index](index.md) + + + +### Possible values (constructors): + +[wallPaper](../constructors/wallPaper.md) + +[wallPaperSolid](../constructors/wallPaperSolid.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getWallPapers](../methods/account_getWallPapers.md) + + + diff --git a/old_docs/API_docs_v81/types/WebAuthorization.md b/old_docs/API_docs_v81/types/WebAuthorization.md new file mode 100644 index 00000000..54c02f7d --- /dev/null +++ b/old_docs/API_docs_v81/types/WebAuthorization.md @@ -0,0 +1,20 @@ +--- +title: WebAuthorization +description: constructors and methods of type WebAuthorization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: WebAuthorization +[Back to types index](index.md) + + + +### Possible values (constructors): + +[webAuthorization](../constructors/webAuthorization.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/WebDocument.md b/old_docs/API_docs_v81/types/WebDocument.md new file mode 100644 index 00000000..8727b6b4 --- /dev/null +++ b/old_docs/API_docs_v81/types/WebDocument.md @@ -0,0 +1,22 @@ +--- +title: WebDocument +description: constructors and methods of type WebDocument +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: WebDocument +[Back to types index](index.md) + + + +### Possible values (constructors): + +[webDocument](../constructors/webDocument.md) + +[webDocumentNoProxy](../constructors/webDocumentNoProxy.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/WebPage.md b/old_docs/API_docs_v81/types/WebPage.md new file mode 100644 index 00000000..a3df791f --- /dev/null +++ b/old_docs/API_docs_v81/types/WebPage.md @@ -0,0 +1,28 @@ +--- +title: WebPage +description: constructors and methods of type WebPage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: WebPage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[webPageEmpty](../constructors/webPageEmpty.md) + +[webPagePending](../constructors/webPagePending.md) + +[webPage](../constructors/webPage.md) + +[webPageNotModified](../constructors/webPageNotModified.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getWebPage](../methods/messages_getWebPage.md) + + + diff --git a/old_docs/API_docs_v81/types/X.md b/old_docs/API_docs_v81/types/X.md new file mode 100644 index 00000000..3b234633 --- /dev/null +++ b/old_docs/API_docs_v81/types/X.md @@ -0,0 +1,9 @@ +--- +title: X +description: Represents a TL serialized payload +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: X +[Back to constructor index](index.md) + +Represents a TL serialized payload. diff --git a/old_docs/API_docs_v81/types/account_AuthorizationForm.md b/old_docs/API_docs_v81/types/account_AuthorizationForm.md new file mode 100644 index 00000000..5eec2b92 --- /dev/null +++ b/old_docs/API_docs_v81/types/account_AuthorizationForm.md @@ -0,0 +1,22 @@ +--- +title: account_AuthorizationForm +description: constructors and methods of type account_AuthorizationForm +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: account\_AuthorizationForm +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account\_authorizationForm](../constructors/account_authorizationForm.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getAuthorizationForm](../methods/account_getAuthorizationForm.md) + + + diff --git a/old_docs/API_docs_v81/types/account_Authorizations.md b/old_docs/API_docs_v81/types/account_Authorizations.md new file mode 100644 index 00000000..4709ddb5 --- /dev/null +++ b/old_docs/API_docs_v81/types/account_Authorizations.md @@ -0,0 +1,22 @@ +--- +title: account_Authorizations +description: constructors and methods of type account_Authorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: account\_Authorizations +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account\_authorizations](../constructors/account_authorizations.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getAuthorizations](../methods/account_getAuthorizations.md) + + + diff --git a/old_docs/API_docs_v81/types/account_Password.md b/old_docs/API_docs_v81/types/account_Password.md new file mode 100644 index 00000000..23e05987 --- /dev/null +++ b/old_docs/API_docs_v81/types/account_Password.md @@ -0,0 +1,24 @@ +--- +title: account_Password +description: constructors and methods of type account_Password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: account\_Password +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account\_noPassword](../constructors/account_noPassword.md) + +[account\_password](../constructors/account_password.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getPassword](../methods/account_getPassword.md) + + + diff --git a/old_docs/API_docs_v81/types/account_PasswordInputSettings.md b/old_docs/API_docs_v81/types/account_PasswordInputSettings.md new file mode 100644 index 00000000..a6455eb8 --- /dev/null +++ b/old_docs/API_docs_v81/types/account_PasswordInputSettings.md @@ -0,0 +1,20 @@ +--- +title: account_PasswordInputSettings +description: constructors and methods of type account_PasswordInputSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: account\_PasswordInputSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account\_passwordInputSettings](../constructors/account_passwordInputSettings.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/account_PasswordSettings.md b/old_docs/API_docs_v81/types/account_PasswordSettings.md new file mode 100644 index 00000000..687eb217 --- /dev/null +++ b/old_docs/API_docs_v81/types/account_PasswordSettings.md @@ -0,0 +1,22 @@ +--- +title: account_PasswordSettings +description: constructors and methods of type account_PasswordSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: account\_PasswordSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account\_passwordSettings](../constructors/account_passwordSettings.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getPasswordSettings](../methods/account_getPasswordSettings.md) + + + diff --git a/old_docs/API_docs_v81/types/account_PrivacyRules.md b/old_docs/API_docs_v81/types/account_PrivacyRules.md new file mode 100644 index 00000000..40b00077 --- /dev/null +++ b/old_docs/API_docs_v81/types/account_PrivacyRules.md @@ -0,0 +1,24 @@ +--- +title: account_PrivacyRules +description: constructors and methods of type account_PrivacyRules +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: account\_PrivacyRules +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account\_privacyRules](../constructors/account_privacyRules.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getPrivacy](../methods/account_getPrivacy.md) + +[$MadelineProto->account->setPrivacy](../methods/account_setPrivacy.md) + + + diff --git a/old_docs/API_docs_v81/types/account_SentEmailCode.md b/old_docs/API_docs_v81/types/account_SentEmailCode.md new file mode 100644 index 00000000..4aa38335 --- /dev/null +++ b/old_docs/API_docs_v81/types/account_SentEmailCode.md @@ -0,0 +1,22 @@ +--- +title: account_SentEmailCode +description: constructors and methods of type account_SentEmailCode +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: account\_SentEmailCode +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account\_sentEmailCode](../constructors/account_sentEmailCode.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->sendVerifyEmailCode](../methods/account_sendVerifyEmailCode.md) + + + diff --git a/old_docs/API_docs_v81/types/account_Takeout.md b/old_docs/API_docs_v81/types/account_Takeout.md new file mode 100644 index 00000000..26960f88 --- /dev/null +++ b/old_docs/API_docs_v81/types/account_Takeout.md @@ -0,0 +1,22 @@ +--- +title: account_Takeout +description: constructors and methods of type account_Takeout +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: account\_Takeout +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account\_takeout](../constructors/account_takeout.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->initTakeoutSession](../methods/account_initTakeoutSession.md) + + + diff --git a/old_docs/API_docs_v81/types/account_TmpPassword.md b/old_docs/API_docs_v81/types/account_TmpPassword.md new file mode 100644 index 00000000..d7557921 --- /dev/null +++ b/old_docs/API_docs_v81/types/account_TmpPassword.md @@ -0,0 +1,22 @@ +--- +title: account_TmpPassword +description: constructors and methods of type account_TmpPassword +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: account\_TmpPassword +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account\_tmpPassword](../constructors/account_tmpPassword.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getTmpPassword](../methods/account_getTmpPassword.md) + + + diff --git a/old_docs/API_docs_v81/types/account_WebAuthorizations.md b/old_docs/API_docs_v81/types/account_WebAuthorizations.md new file mode 100644 index 00000000..1202632b --- /dev/null +++ b/old_docs/API_docs_v81/types/account_WebAuthorizations.md @@ -0,0 +1,22 @@ +--- +title: account_WebAuthorizations +description: constructors and methods of type account_WebAuthorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: account\_WebAuthorizations +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account\_webAuthorizations](../constructors/account_webAuthorizations.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getWebAuthorizations](../methods/account_getWebAuthorizations.md) + + + diff --git a/old_docs/API_docs_v81/types/auth_Authorization.md b/old_docs/API_docs_v81/types/auth_Authorization.md new file mode 100644 index 00000000..5a34fc2d --- /dev/null +++ b/old_docs/API_docs_v81/types/auth_Authorization.md @@ -0,0 +1,32 @@ +--- +title: auth_Authorization +description: constructors and methods of type auth_Authorization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: auth\_Authorization +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth\_authorization](../constructors/auth_authorization.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->auth->signUp](../methods/auth_signUp.md) + +[$MadelineProto->auth->signIn](../methods/auth_signIn.md) + +[$MadelineProto->auth->importAuthorization](../methods/auth_importAuthorization.md) + +[$MadelineProto->auth->importBotAuthorization](../methods/auth_importBotAuthorization.md) + +[$MadelineProto->auth->checkPassword](../methods/auth_checkPassword.md) + +[$MadelineProto->auth->recoverPassword](../methods/auth_recoverPassword.md) + + + diff --git a/old_docs/API_docs_v81/types/auth_CheckedPhone.md b/old_docs/API_docs_v81/types/auth_CheckedPhone.md new file mode 100644 index 00000000..e2b823f7 --- /dev/null +++ b/old_docs/API_docs_v81/types/auth_CheckedPhone.md @@ -0,0 +1,20 @@ +--- +title: auth_CheckedPhone +description: constructors and methods of type auth_CheckedPhone +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: auth\_CheckedPhone +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth\_checkedPhone](../constructors/auth_checkedPhone.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/auth_CodeType.md b/old_docs/API_docs_v81/types/auth_CodeType.md new file mode 100644 index 00000000..3cd9a7b7 --- /dev/null +++ b/old_docs/API_docs_v81/types/auth_CodeType.md @@ -0,0 +1,24 @@ +--- +title: auth_CodeType +description: constructors and methods of type auth_CodeType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: auth\_CodeType +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth\_codeTypeSms](../constructors/auth_codeTypeSms.md) + +[auth\_codeTypeCall](../constructors/auth_codeTypeCall.md) + +[auth\_codeTypeFlashCall](../constructors/auth_codeTypeFlashCall.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/auth_ExportedAuthorization.md b/old_docs/API_docs_v81/types/auth_ExportedAuthorization.md new file mode 100644 index 00000000..69e5c42e --- /dev/null +++ b/old_docs/API_docs_v81/types/auth_ExportedAuthorization.md @@ -0,0 +1,22 @@ +--- +title: auth_ExportedAuthorization +description: constructors and methods of type auth_ExportedAuthorization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: auth\_ExportedAuthorization +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth\_exportedAuthorization](../constructors/auth_exportedAuthorization.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->auth->exportAuthorization](../methods/auth_exportAuthorization.md) + + + diff --git a/old_docs/API_docs_v81/types/auth_PasswordRecovery.md b/old_docs/API_docs_v81/types/auth_PasswordRecovery.md new file mode 100644 index 00000000..4962bf42 --- /dev/null +++ b/old_docs/API_docs_v81/types/auth_PasswordRecovery.md @@ -0,0 +1,22 @@ +--- +title: auth_PasswordRecovery +description: constructors and methods of type auth_PasswordRecovery +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: auth\_PasswordRecovery +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth\_passwordRecovery](../constructors/auth_passwordRecovery.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->auth->requestPasswordRecovery](../methods/auth_requestPasswordRecovery.md) + + + diff --git a/old_docs/API_docs_v81/types/auth_SentCode.md b/old_docs/API_docs_v81/types/auth_SentCode.md new file mode 100644 index 00000000..140d956c --- /dev/null +++ b/old_docs/API_docs_v81/types/auth_SentCode.md @@ -0,0 +1,30 @@ +--- +title: auth_SentCode +description: constructors and methods of type auth_SentCode +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: auth\_SentCode +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth\_sentCode](../constructors/auth_sentCode.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->auth->sendCode](../methods/auth_sendCode.md) + +[$MadelineProto->auth->resendCode](../methods/auth_resendCode.md) + +[$MadelineProto->account->sendChangePhoneCode](../methods/account_sendChangePhoneCode.md) + +[$MadelineProto->account->sendConfirmPhoneCode](../methods/account_sendConfirmPhoneCode.md) + +[$MadelineProto->account->sendVerifyPhoneCode](../methods/account_sendVerifyPhoneCode.md) + + + diff --git a/old_docs/API_docs_v81/types/auth_SentCodeType.md b/old_docs/API_docs_v81/types/auth_SentCodeType.md new file mode 100644 index 00000000..8dfcb93b --- /dev/null +++ b/old_docs/API_docs_v81/types/auth_SentCodeType.md @@ -0,0 +1,26 @@ +--- +title: auth_SentCodeType +description: constructors and methods of type auth_SentCodeType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: auth\_SentCodeType +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth\_sentCodeTypeApp](../constructors/auth_sentCodeTypeApp.md) + +[auth\_sentCodeTypeSms](../constructors/auth_sentCodeTypeSms.md) + +[auth\_sentCodeTypeCall](../constructors/auth_sentCodeTypeCall.md) + +[auth\_sentCodeTypeFlashCall](../constructors/auth_sentCodeTypeFlashCall.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/bytes.md b/old_docs/API_docs_v81/types/bytes.md new file mode 100644 index 00000000..a4d8c2f7 --- /dev/null +++ b/old_docs/API_docs_v81/types/bytes.md @@ -0,0 +1,17 @@ +--- +title: bytes +description: A string of variable length +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: bytes +[Back to constructor index](index.md) + +An object of type `\danog\MadelineProto\TL\Types\Bytes`. +When casted to string, turns into a string of bytes of variable length, with length smaller than or equal to 16777215. +When JSON-serialized, turns into an array of the following format: +``` +[ + '_' => 'bytes', + 'bytes' => base64_encode($contents) +]; +``` diff --git a/old_docs/API_docs_v81/types/channels_AdminLogResults.md b/old_docs/API_docs_v81/types/channels_AdminLogResults.md new file mode 100644 index 00000000..4e9b5544 --- /dev/null +++ b/old_docs/API_docs_v81/types/channels_AdminLogResults.md @@ -0,0 +1,22 @@ +--- +title: channels_AdminLogResults +description: constructors and methods of type channels_AdminLogResults +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: channels\_AdminLogResults +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channels\_adminLogResults](../constructors/channels_adminLogResults.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->channels->getAdminLog](../methods/channels_getAdminLog.md) + + + diff --git a/old_docs/API_docs_v81/types/channels_ChannelParticipant.md b/old_docs/API_docs_v81/types/channels_ChannelParticipant.md new file mode 100644 index 00000000..3d4667c3 --- /dev/null +++ b/old_docs/API_docs_v81/types/channels_ChannelParticipant.md @@ -0,0 +1,22 @@ +--- +title: channels_ChannelParticipant +description: constructors and methods of type channels_ChannelParticipant +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: channels\_ChannelParticipant +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channels\_channelParticipant](../constructors/channels_channelParticipant.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->channels->getParticipant](../methods/channels_getParticipant.md) + + + diff --git a/old_docs/API_docs_v81/types/channels_ChannelParticipants.md b/old_docs/API_docs_v81/types/channels_ChannelParticipants.md new file mode 100644 index 00000000..80a41dd9 --- /dev/null +++ b/old_docs/API_docs_v81/types/channels_ChannelParticipants.md @@ -0,0 +1,24 @@ +--- +title: channels_ChannelParticipants +description: constructors and methods of type channels_ChannelParticipants +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: channels\_ChannelParticipants +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channels\_channelParticipants](../constructors/channels_channelParticipants.md) + +[channels\_channelParticipantsNotModified](../constructors/channels_channelParticipantsNotModified.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->channels->getParticipants](../methods/channels_getParticipants.md) + + + diff --git a/old_docs/API_docs_v81/types/contacts_Blocked.md b/old_docs/API_docs_v81/types/contacts_Blocked.md new file mode 100644 index 00000000..3e1f02eb --- /dev/null +++ b/old_docs/API_docs_v81/types/contacts_Blocked.md @@ -0,0 +1,24 @@ +--- +title: contacts_Blocked +description: constructors and methods of type contacts_Blocked +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: contacts\_Blocked +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contacts\_blocked](../constructors/contacts_blocked.md) + +[contacts\_blockedSlice](../constructors/contacts_blockedSlice.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->getBlocked](../methods/contacts_getBlocked.md) + + + diff --git a/old_docs/API_docs_v81/types/contacts_Contacts.md b/old_docs/API_docs_v81/types/contacts_Contacts.md new file mode 100644 index 00000000..5d6c9506 --- /dev/null +++ b/old_docs/API_docs_v81/types/contacts_Contacts.md @@ -0,0 +1,24 @@ +--- +title: contacts_Contacts +description: constructors and methods of type contacts_Contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: contacts\_Contacts +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contacts\_contactsNotModified](../constructors/contacts_contactsNotModified.md) + +[contacts\_contacts](../constructors/contacts_contacts.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->getContacts](../methods/contacts_getContacts.md) + + + diff --git a/old_docs/API_docs_v81/types/contacts_Found.md b/old_docs/API_docs_v81/types/contacts_Found.md new file mode 100644 index 00000000..806101cf --- /dev/null +++ b/old_docs/API_docs_v81/types/contacts_Found.md @@ -0,0 +1,22 @@ +--- +title: contacts_Found +description: constructors and methods of type contacts_Found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: contacts\_Found +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contacts\_found](../constructors/contacts_found.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->search](../methods/contacts_search.md) + + + diff --git a/old_docs/API_docs_v81/types/contacts_ImportedContacts.md b/old_docs/API_docs_v81/types/contacts_ImportedContacts.md new file mode 100644 index 00000000..faf7e615 --- /dev/null +++ b/old_docs/API_docs_v81/types/contacts_ImportedContacts.md @@ -0,0 +1,22 @@ +--- +title: contacts_ImportedContacts +description: constructors and methods of type contacts_ImportedContacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: contacts\_ImportedContacts +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contacts\_importedContacts](../constructors/contacts_importedContacts.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->importContacts](../methods/contacts_importContacts.md) + + + diff --git a/old_docs/API_docs_v81/types/contacts_Link.md b/old_docs/API_docs_v81/types/contacts_Link.md new file mode 100644 index 00000000..01556606 --- /dev/null +++ b/old_docs/API_docs_v81/types/contacts_Link.md @@ -0,0 +1,22 @@ +--- +title: contacts_Link +description: constructors and methods of type contacts_Link +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: contacts\_Link +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contacts\_link](../constructors/contacts_link.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->deleteContact](../methods/contacts_deleteContact.md) + + + diff --git a/old_docs/API_docs_v81/types/contacts_ResolvedPeer.md b/old_docs/API_docs_v81/types/contacts_ResolvedPeer.md new file mode 100644 index 00000000..cf107f7c --- /dev/null +++ b/old_docs/API_docs_v81/types/contacts_ResolvedPeer.md @@ -0,0 +1,22 @@ +--- +title: contacts_ResolvedPeer +description: constructors and methods of type contacts_ResolvedPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: contacts\_ResolvedPeer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contacts\_resolvedPeer](../constructors/contacts_resolvedPeer.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->resolveUsername](../methods/contacts_resolveUsername.md) + + + diff --git a/old_docs/API_docs_v81/types/contacts_TopPeers.md b/old_docs/API_docs_v81/types/contacts_TopPeers.md new file mode 100644 index 00000000..fe4255c7 --- /dev/null +++ b/old_docs/API_docs_v81/types/contacts_TopPeers.md @@ -0,0 +1,24 @@ +--- +title: contacts_TopPeers +description: constructors and methods of type contacts_TopPeers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: contacts\_TopPeers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contacts\_topPeersNotModified](../constructors/contacts_topPeersNotModified.md) + +[contacts\_topPeers](../constructors/contacts_topPeers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->getTopPeers](../methods/contacts_getTopPeers.md) + + + diff --git a/old_docs/API_docs_v81/types/double.md b/old_docs/API_docs_v81/types/double.md new file mode 100644 index 00000000..a6d2ee55 --- /dev/null +++ b/old_docs/API_docs_v81/types/double.md @@ -0,0 +1,9 @@ +--- +title: double +description: A double precision floating point number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: double +[Back to constructor index](index.md) + +A double precision floating point number, single precision can also be used (float). diff --git a/old_docs/API_docs_v81/types/help_AppUpdate.md b/old_docs/API_docs_v81/types/help_AppUpdate.md new file mode 100644 index 00000000..1f296a70 --- /dev/null +++ b/old_docs/API_docs_v81/types/help_AppUpdate.md @@ -0,0 +1,24 @@ +--- +title: help_AppUpdate +description: constructors and methods of type help_AppUpdate +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: help\_AppUpdate +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help\_appUpdate](../constructors/help_appUpdate.md) + +[help\_noAppUpdate](../constructors/help_noAppUpdate.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getAppUpdate](../methods/help_getAppUpdate.md) + + + diff --git a/old_docs/API_docs_v81/types/help_ConfigSimple.md b/old_docs/API_docs_v81/types/help_ConfigSimple.md new file mode 100644 index 00000000..81678d74 --- /dev/null +++ b/old_docs/API_docs_v81/types/help_ConfigSimple.md @@ -0,0 +1,20 @@ +--- +title: help_ConfigSimple +description: constructors and methods of type help_ConfigSimple +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: help\_ConfigSimple +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help\_configSimple](../constructors/help_configSimple.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/help_DeepLinkInfo.md b/old_docs/API_docs_v81/types/help_DeepLinkInfo.md new file mode 100644 index 00000000..776e8e09 --- /dev/null +++ b/old_docs/API_docs_v81/types/help_DeepLinkInfo.md @@ -0,0 +1,24 @@ +--- +title: help_DeepLinkInfo +description: constructors and methods of type help_DeepLinkInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: help\_DeepLinkInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help\_deepLinkInfoEmpty](../constructors/help_deepLinkInfoEmpty.md) + +[help\_deepLinkInfo](../constructors/help_deepLinkInfo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getDeepLinkInfo](../methods/help_getDeepLinkInfo.md) + + + diff --git a/old_docs/API_docs_v81/types/help_InviteText.md b/old_docs/API_docs_v81/types/help_InviteText.md new file mode 100644 index 00000000..018d35bf --- /dev/null +++ b/old_docs/API_docs_v81/types/help_InviteText.md @@ -0,0 +1,22 @@ +--- +title: help_InviteText +description: constructors and methods of type help_InviteText +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: help\_InviteText +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help\_inviteText](../constructors/help_inviteText.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getInviteText](../methods/help_getInviteText.md) + + + diff --git a/old_docs/API_docs_v81/types/help_ProxyData.md b/old_docs/API_docs_v81/types/help_ProxyData.md new file mode 100644 index 00000000..1bc6839e --- /dev/null +++ b/old_docs/API_docs_v81/types/help_ProxyData.md @@ -0,0 +1,24 @@ +--- +title: help_ProxyData +description: constructors and methods of type help_ProxyData +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: help\_ProxyData +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help\_proxyDataEmpty](../constructors/help_proxyDataEmpty.md) + +[help\_proxyDataPromo](../constructors/help_proxyDataPromo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getProxyData](../methods/help_getProxyData.md) + + + diff --git a/old_docs/API_docs_v81/types/help_RecentMeUrls.md b/old_docs/API_docs_v81/types/help_RecentMeUrls.md new file mode 100644 index 00000000..691af1c3 --- /dev/null +++ b/old_docs/API_docs_v81/types/help_RecentMeUrls.md @@ -0,0 +1,22 @@ +--- +title: help_RecentMeUrls +description: constructors and methods of type help_RecentMeUrls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: help\_RecentMeUrls +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help\_recentMeUrls](../constructors/help_recentMeUrls.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getRecentMeUrls](../methods/help_getRecentMeUrls.md) + + + diff --git a/old_docs/API_docs_v81/types/help_Support.md b/old_docs/API_docs_v81/types/help_Support.md new file mode 100644 index 00000000..26de447b --- /dev/null +++ b/old_docs/API_docs_v81/types/help_Support.md @@ -0,0 +1,22 @@ +--- +title: help_Support +description: constructors and methods of type help_Support +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: help\_Support +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help\_support](../constructors/help_support.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getSupport](../methods/help_getSupport.md) + + + diff --git a/old_docs/API_docs_v81/types/help_TermsOfServiceUpdate.md b/old_docs/API_docs_v81/types/help_TermsOfServiceUpdate.md new file mode 100644 index 00000000..0e4f1ef2 --- /dev/null +++ b/old_docs/API_docs_v81/types/help_TermsOfServiceUpdate.md @@ -0,0 +1,24 @@ +--- +title: help_TermsOfServiceUpdate +description: constructors and methods of type help_TermsOfServiceUpdate +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: help\_TermsOfServiceUpdate +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help\_termsOfServiceUpdateEmpty](../constructors/help_termsOfServiceUpdateEmpty.md) + +[help\_termsOfServiceUpdate](../constructors/help_termsOfServiceUpdate.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getTermsOfServiceUpdate](../methods/help_getTermsOfServiceUpdate.md) + + + diff --git a/old_docs/API_docs_v81/types/help_wTermsOfService.md b/old_docs/API_docs_v81/types/help_wTermsOfService.md new file mode 100644 index 00000000..797be4dc --- /dev/null +++ b/old_docs/API_docs_v81/types/help_wTermsOfService.md @@ -0,0 +1,20 @@ +--- +title: help_wTermsOfService +description: constructors and methods of type help_wTermsOfService +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: help\_wTermsOfService +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help\_termsOfService](../constructors/help_termsOfService.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/int.md b/old_docs/API_docs_v81/types/int.md new file mode 100644 index 00000000..73dd1c64 --- /dev/null +++ b/old_docs/API_docs_v81/types/int.md @@ -0,0 +1,9 @@ +--- +title: integer +description: A 32 bit signed integer ranging from -2147483648 to 2147483647 +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: int +[Back to constructor index](index.md) + +A 32 bit signed integer ranging from `-2147483648` to `2147483647`. diff --git a/old_docs/API_docs_v81/types/int128.md b/old_docs/API_docs_v81/types/int128.md new file mode 100644 index 00000000..042ef75b --- /dev/null +++ b/old_docs/API_docs_v81/types/int128.md @@ -0,0 +1,9 @@ +--- +title: int128 +description: A 128 bit signed integer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: int128 +[Back to constructor index](index.md) + +A 128 bit signed integer represented in little-endian base256 (`string`) format. diff --git a/old_docs/API_docs_v81/types/int256.md b/old_docs/API_docs_v81/types/int256.md new file mode 100644 index 00000000..6b19844d --- /dev/null +++ b/old_docs/API_docs_v81/types/int256.md @@ -0,0 +1,9 @@ +--- +title: int256 +description: A 256 bit signed integer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: int256 +[Back to constructor index](index.md) + +A 256 bit signed integer represented in little-endian base256 (`string`) format. diff --git a/old_docs/API_docs_v81/types/int512.md b/old_docs/API_docs_v81/types/int512.md new file mode 100644 index 00000000..eec6ec00 --- /dev/null +++ b/old_docs/API_docs_v81/types/int512.md @@ -0,0 +1,9 @@ +--- +title: int512 +description: A 512 bit signed integer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: int512 +[Back to constructor index](index.md) + +A 512 bit signed integer represented in little-endian base256 (`string`) format. diff --git a/old_docs/API_docs_v81/types/int53.md b/old_docs/API_docs_v81/types/int53.md new file mode 100644 index 00000000..820b48f8 --- /dev/null +++ b/old_docs/API_docs_v81/types/int53.md @@ -0,0 +1,9 @@ +--- +title: integer +description: A 53 bit signed integer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: int53 +[Back to constructor index](index.md) + +A 53 bit signed integer. diff --git a/old_docs/API_docs_v81/types/long.md b/old_docs/API_docs_v81/types/long.md new file mode 100644 index 00000000..e60a8f75 --- /dev/null +++ b/old_docs/API_docs_v81/types/long.md @@ -0,0 +1,9 @@ +--- +title: long +description: A 32 bit signed integer ranging from -9223372036854775808 to 9223372036854775807 +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: long +[Back to constructor index](index.md) + +A 64 bit signed integer ranging from `-9223372036854775808` to `9223372036854775807`. diff --git a/old_docs/API_docs_v81/types/messages_AffectedHistory.md b/old_docs/API_docs_v81/types/messages_AffectedHistory.md new file mode 100644 index 00000000..9eef04c0 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_AffectedHistory.md @@ -0,0 +1,26 @@ +--- +title: messages_AffectedHistory +description: constructors and methods of type messages_AffectedHistory +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_AffectedHistory +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_affectedHistory](../constructors/messages_affectedHistory.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->deleteHistory](../methods/messages_deleteHistory.md) + +[$MadelineProto->messages->readMentions](../methods/messages_readMentions.md) + +[$MadelineProto->channels->deleteUserHistory](../methods/channels_deleteUserHistory.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_AffectedMessages.md b/old_docs/API_docs_v81/types/messages_AffectedMessages.md new file mode 100644 index 00000000..dcbea721 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_AffectedMessages.md @@ -0,0 +1,28 @@ +--- +title: messages_AffectedMessages +description: constructors and methods of type messages_AffectedMessages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_AffectedMessages +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_affectedMessages](../constructors/messages_affectedMessages.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->readHistory](../methods/messages_readHistory.md) + +[$MadelineProto->messages->deleteMessages](../methods/messages_deleteMessages.md) + +[$MadelineProto->messages->readMessageContents](../methods/messages_readMessageContents.md) + +[$MadelineProto->channels->deleteMessages](../methods/channels_deleteMessages.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_AllStickers.md b/old_docs/API_docs_v81/types/messages_AllStickers.md new file mode 100644 index 00000000..b6a322e0 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_AllStickers.md @@ -0,0 +1,26 @@ +--- +title: messages_AllStickers +description: constructors and methods of type messages_AllStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_AllStickers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_allStickersNotModified](../constructors/messages_allStickersNotModified.md) + +[messages\_allStickers](../constructors/messages_allStickers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getAllStickers](../methods/messages_getAllStickers.md) + +[$MadelineProto->messages->getMaskStickers](../methods/messages_getMaskStickers.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_ArchivedStickers.md b/old_docs/API_docs_v81/types/messages_ArchivedStickers.md new file mode 100644 index 00000000..c569675e --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_ArchivedStickers.md @@ -0,0 +1,22 @@ +--- +title: messages_ArchivedStickers +description: constructors and methods of type messages_ArchivedStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_ArchivedStickers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_archivedStickers](../constructors/messages_archivedStickers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getArchivedStickers](../methods/messages_getArchivedStickers.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_BotCallbackAnswer.md b/old_docs/API_docs_v81/types/messages_BotCallbackAnswer.md new file mode 100644 index 00000000..f8d424d0 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_BotCallbackAnswer.md @@ -0,0 +1,22 @@ +--- +title: messages_BotCallbackAnswer +description: constructors and methods of type messages_BotCallbackAnswer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_BotCallbackAnswer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_botCallbackAnswer](../constructors/messages_botCallbackAnswer.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getBotCallbackAnswer](../methods/messages_getBotCallbackAnswer.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_BotResults.md b/old_docs/API_docs_v81/types/messages_BotResults.md new file mode 100644 index 00000000..c346c5bd --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_BotResults.md @@ -0,0 +1,22 @@ +--- +title: messages_BotResults +description: constructors and methods of type messages_BotResults +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_BotResults +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_botResults](../constructors/messages_botResults.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getInlineBotResults](../methods/messages_getInlineBotResults.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_ChatFull.md b/old_docs/API_docs_v81/types/messages_ChatFull.md new file mode 100644 index 00000000..e4add41e --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_ChatFull.md @@ -0,0 +1,24 @@ +--- +title: messages_ChatFull +description: constructors and methods of type messages_ChatFull +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_ChatFull +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_chatFull](../constructors/messages_chatFull.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getFullChat](../methods/messages_getFullChat.md) + +[$MadelineProto->channels->getFullChannel](../methods/channels_getFullChannel.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_Chats.md b/old_docs/API_docs_v81/types/messages_Chats.md new file mode 100644 index 00000000..57349b11 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_Chats.md @@ -0,0 +1,34 @@ +--- +title: messages_Chats +description: constructors and methods of type messages_Chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_Chats +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_chats](../constructors/messages_chats.md) + +[messages\_chatsSlice](../constructors/messages_chatsSlice.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getChats](../methods/messages_getChats.md) + +[$MadelineProto->messages->getCommonChats](../methods/messages_getCommonChats.md) + +[$MadelineProto->messages->getAllChats](../methods/messages_getAllChats.md) + +[$MadelineProto->channels->getChannels](../methods/channels_getChannels.md) + +[$MadelineProto->channels->getAdminedPublicChannels](../methods/channels_getAdminedPublicChannels.md) + +[$MadelineProto->channels->getLeftChannels](../methods/channels_getLeftChannels.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_DhConfig.md b/old_docs/API_docs_v81/types/messages_DhConfig.md new file mode 100644 index 00000000..ce237411 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_DhConfig.md @@ -0,0 +1,24 @@ +--- +title: messages_DhConfig +description: constructors and methods of type messages_DhConfig +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_DhConfig +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_dhConfigNotModified](../constructors/messages_dhConfigNotModified.md) + +[messages\_dhConfig](../constructors/messages_dhConfig.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getDhConfig](../methods/messages_getDhConfig.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_Dialogs.md b/old_docs/API_docs_v81/types/messages_Dialogs.md new file mode 100644 index 00000000..733a42c5 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_Dialogs.md @@ -0,0 +1,24 @@ +--- +title: messages_Dialogs +description: constructors and methods of type messages_Dialogs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_Dialogs +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_dialogs](../constructors/messages_dialogs.md) + +[messages\_dialogsSlice](../constructors/messages_dialogsSlice.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getDialogs](../methods/messages_getDialogs.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_FavedStickers.md b/old_docs/API_docs_v81/types/messages_FavedStickers.md new file mode 100644 index 00000000..6fa1f221 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_FavedStickers.md @@ -0,0 +1,24 @@ +--- +title: messages_FavedStickers +description: constructors and methods of type messages_FavedStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_FavedStickers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_favedStickersNotModified](../constructors/messages_favedStickersNotModified.md) + +[messages\_favedStickers](../constructors/messages_favedStickers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getFavedStickers](../methods/messages_getFavedStickers.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_FeaturedStickers.md b/old_docs/API_docs_v81/types/messages_FeaturedStickers.md new file mode 100644 index 00000000..9b4c5002 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_FeaturedStickers.md @@ -0,0 +1,24 @@ +--- +title: messages_FeaturedStickers +description: constructors and methods of type messages_FeaturedStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_FeaturedStickers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_featuredStickersNotModified](../constructors/messages_featuredStickersNotModified.md) + +[messages\_featuredStickers](../constructors/messages_featuredStickers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getFeaturedStickers](../methods/messages_getFeaturedStickers.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_FoundGifs.md b/old_docs/API_docs_v81/types/messages_FoundGifs.md new file mode 100644 index 00000000..9dd088ba --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_FoundGifs.md @@ -0,0 +1,22 @@ +--- +title: messages_FoundGifs +description: constructors and methods of type messages_FoundGifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_FoundGifs +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_foundGifs](../constructors/messages_foundGifs.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->searchGifs](../methods/messages_searchGifs.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_FoundStickerSets.md b/old_docs/API_docs_v81/types/messages_FoundStickerSets.md new file mode 100644 index 00000000..9045b0d7 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_FoundStickerSets.md @@ -0,0 +1,24 @@ +--- +title: messages_FoundStickerSets +description: constructors and methods of type messages_FoundStickerSets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_FoundStickerSets +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_foundStickerSetsNotModified](../constructors/messages_foundStickerSetsNotModified.md) + +[messages\_foundStickerSets](../constructors/messages_foundStickerSets.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->searchStickerSets](../methods/messages_searchStickerSets.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_HighScores.md b/old_docs/API_docs_v81/types/messages_HighScores.md new file mode 100644 index 00000000..9660e255 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_HighScores.md @@ -0,0 +1,24 @@ +--- +title: messages_HighScores +description: constructors and methods of type messages_HighScores +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_HighScores +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_highScores](../constructors/messages_highScores.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getGameHighScores](../methods/messages_getGameHighScores.md) + +[$MadelineProto->messages->getInlineGameHighScores](../methods/messages_getInlineGameHighScores.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_MessageEditData.md b/old_docs/API_docs_v81/types/messages_MessageEditData.md new file mode 100644 index 00000000..ed3c507a --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_MessageEditData.md @@ -0,0 +1,22 @@ +--- +title: messages_MessageEditData +description: constructors and methods of type messages_MessageEditData +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_MessageEditData +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_messageEditData](../constructors/messages_messageEditData.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getMessageEditData](../methods/messages_getMessageEditData.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_Messages.md b/old_docs/API_docs_v81/types/messages_Messages.md new file mode 100644 index 00000000..35514e90 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_Messages.md @@ -0,0 +1,40 @@ +--- +title: messages_Messages +description: constructors and methods of type messages_Messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_Messages +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_messages](../constructors/messages_messages.md) + +[messages\_messagesSlice](../constructors/messages_messagesSlice.md) + +[messages\_channelMessages](../constructors/messages_channelMessages.md) + +[messages\_messagesNotModified](../constructors/messages_messagesNotModified.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getMessages](../methods/messages_getMessages.md) + +[$MadelineProto->messages->getHistory](../methods/messages_getHistory.md) + +[$MadelineProto->messages->search](../methods/messages_search.md) + +[$MadelineProto->messages->searchGlobal](../methods/messages_searchGlobal.md) + +[$MadelineProto->messages->getUnreadMentions](../methods/messages_getUnreadMentions.md) + +[$MadelineProto->messages->getRecentLocations](../methods/messages_getRecentLocations.md) + +[$MadelineProto->channels->getMessages](../methods/channels_getMessages.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_PeerDialogs.md b/old_docs/API_docs_v81/types/messages_PeerDialogs.md new file mode 100644 index 00000000..2477931f --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_PeerDialogs.md @@ -0,0 +1,24 @@ +--- +title: messages_PeerDialogs +description: constructors and methods of type messages_PeerDialogs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_PeerDialogs +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_peerDialogs](../constructors/messages_peerDialogs.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getPeerDialogs](../methods/messages_getPeerDialogs.md) + +[$MadelineProto->messages->getPinnedDialogs](../methods/messages_getPinnedDialogs.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_RecentStickers.md b/old_docs/API_docs_v81/types/messages_RecentStickers.md new file mode 100644 index 00000000..2c9db779 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_RecentStickers.md @@ -0,0 +1,24 @@ +--- +title: messages_RecentStickers +description: constructors and methods of type messages_RecentStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_RecentStickers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_recentStickersNotModified](../constructors/messages_recentStickersNotModified.md) + +[messages\_recentStickers](../constructors/messages_recentStickers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getRecentStickers](../methods/messages_getRecentStickers.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_SavedGifs.md b/old_docs/API_docs_v81/types/messages_SavedGifs.md new file mode 100644 index 00000000..ffb000aa --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_SavedGifs.md @@ -0,0 +1,24 @@ +--- +title: messages_SavedGifs +description: constructors and methods of type messages_SavedGifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_SavedGifs +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_savedGifsNotModified](../constructors/messages_savedGifsNotModified.md) + +[messages\_savedGifs](../constructors/messages_savedGifs.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getSavedGifs](../methods/messages_getSavedGifs.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_SentEncryptedMessage.md b/old_docs/API_docs_v81/types/messages_SentEncryptedMessage.md new file mode 100644 index 00000000..9f7ab935 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_SentEncryptedMessage.md @@ -0,0 +1,28 @@ +--- +title: messages_SentEncryptedMessage +description: constructors and methods of type messages_SentEncryptedMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_SentEncryptedMessage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_sentEncryptedMessage](../constructors/messages_sentEncryptedMessage.md) + +[messages\_sentEncryptedFile](../constructors/messages_sentEncryptedFile.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->sendEncrypted](../methods/messages_sendEncrypted.md) + +[$MadelineProto->messages->sendEncryptedFile](../methods/messages_sendEncryptedFile.md) + +[$MadelineProto->messages->sendEncryptedService](../methods/messages_sendEncryptedService.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_StickerSet.md b/old_docs/API_docs_v81/types/messages_StickerSet.md new file mode 100644 index 00000000..98e34dd2 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_StickerSet.md @@ -0,0 +1,30 @@ +--- +title: messages_StickerSet +description: constructors and methods of type messages_StickerSet +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_StickerSet +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_stickerSet](../constructors/messages_stickerSet.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getStickerSet](../methods/messages_getStickerSet.md) + +[$MadelineProto->stickers->createStickerSet](../methods/stickers_createStickerSet.md) + +[$MadelineProto->stickers->removeStickerFromSet](../methods/stickers_removeStickerFromSet.md) + +[$MadelineProto->stickers->changeStickerPosition](../methods/stickers_changeStickerPosition.md) + +[$MadelineProto->stickers->addStickerToSet](../methods/stickers_addStickerToSet.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_StickerSetInstallResult.md b/old_docs/API_docs_v81/types/messages_StickerSetInstallResult.md new file mode 100644 index 00000000..bb62ec11 --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_StickerSetInstallResult.md @@ -0,0 +1,24 @@ +--- +title: messages_StickerSetInstallResult +description: constructors and methods of type messages_StickerSetInstallResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_StickerSetInstallResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_stickerSetInstallResultSuccess](../constructors/messages_stickerSetInstallResultSuccess.md) + +[messages\_stickerSetInstallResultArchive](../constructors/messages_stickerSetInstallResultArchive.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->installStickerSet](../methods/messages_installStickerSet.md) + + + diff --git a/old_docs/API_docs_v81/types/messages_Stickers.md b/old_docs/API_docs_v81/types/messages_Stickers.md new file mode 100644 index 00000000..cf53f57b --- /dev/null +++ b/old_docs/API_docs_v81/types/messages_Stickers.md @@ -0,0 +1,24 @@ +--- +title: messages_Stickers +description: constructors and methods of type messages_Stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: messages\_Stickers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages\_stickersNotModified](../constructors/messages_stickersNotModified.md) + +[messages\_stickers](../constructors/messages_stickers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getStickers](../methods/messages_getStickers.md) + + + diff --git a/old_docs/API_docs_v81/types/payments_PaymentForm.md b/old_docs/API_docs_v81/types/payments_PaymentForm.md new file mode 100644 index 00000000..4662586d --- /dev/null +++ b/old_docs/API_docs_v81/types/payments_PaymentForm.md @@ -0,0 +1,22 @@ +--- +title: payments_PaymentForm +description: constructors and methods of type payments_PaymentForm +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: payments\_PaymentForm +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments\_paymentForm](../constructors/payments_paymentForm.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->getPaymentForm](../methods/payments_getPaymentForm.md) + + + diff --git a/old_docs/API_docs_v81/types/payments_PaymentReceipt.md b/old_docs/API_docs_v81/types/payments_PaymentReceipt.md new file mode 100644 index 00000000..b4770d2a --- /dev/null +++ b/old_docs/API_docs_v81/types/payments_PaymentReceipt.md @@ -0,0 +1,22 @@ +--- +title: payments_PaymentReceipt +description: constructors and methods of type payments_PaymentReceipt +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: payments\_PaymentReceipt +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments\_paymentReceipt](../constructors/payments_paymentReceipt.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->getPaymentReceipt](../methods/payments_getPaymentReceipt.md) + + + diff --git a/old_docs/API_docs_v81/types/payments_PaymentResult.md b/old_docs/API_docs_v81/types/payments_PaymentResult.md new file mode 100644 index 00000000..3c0ad411 --- /dev/null +++ b/old_docs/API_docs_v81/types/payments_PaymentResult.md @@ -0,0 +1,24 @@ +--- +title: payments_PaymentResult +description: constructors and methods of type payments_PaymentResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: payments\_PaymentResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments\_paymentResult](../constructors/payments_paymentResult.md) + +[payments\_paymentVerficationNeeded](../constructors/payments_paymentVerficationNeeded.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->sendPaymentForm](../methods/payments_sendPaymentForm.md) + + + diff --git a/old_docs/API_docs_v81/types/payments_SavedInfo.md b/old_docs/API_docs_v81/types/payments_SavedInfo.md new file mode 100644 index 00000000..c8f7b9e3 --- /dev/null +++ b/old_docs/API_docs_v81/types/payments_SavedInfo.md @@ -0,0 +1,22 @@ +--- +title: payments_SavedInfo +description: constructors and methods of type payments_SavedInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: payments\_SavedInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments\_savedInfo](../constructors/payments_savedInfo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->getSavedInfo](../methods/payments_getSavedInfo.md) + + + diff --git a/old_docs/API_docs_v81/types/payments_ValidatedRequestedInfo.md b/old_docs/API_docs_v81/types/payments_ValidatedRequestedInfo.md new file mode 100644 index 00000000..ff6c4e39 --- /dev/null +++ b/old_docs/API_docs_v81/types/payments_ValidatedRequestedInfo.md @@ -0,0 +1,22 @@ +--- +title: payments_ValidatedRequestedInfo +description: constructors and methods of type payments_ValidatedRequestedInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: payments\_ValidatedRequestedInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments\_validatedRequestedInfo](../constructors/payments_validatedRequestedInfo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->validateRequestedInfo](../methods/payments_validateRequestedInfo.md) + + + diff --git a/old_docs/API_docs_v81/types/phone_PhoneCall.md b/old_docs/API_docs_v81/types/phone_PhoneCall.md new file mode 100644 index 00000000..0a49d482 --- /dev/null +++ b/old_docs/API_docs_v81/types/phone_PhoneCall.md @@ -0,0 +1,26 @@ +--- +title: phone_PhoneCall +description: constructors and methods of type phone_PhoneCall +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: phone\_PhoneCall +[Back to types index](index.md) + + + +### Possible values (constructors): + +[phone\_phoneCall](../constructors/phone_phoneCall.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->phone->requestCall](../methods/phone_requestCall.md) + +[$MadelineProto->phone->acceptCall](../methods/phone_acceptCall.md) + +[$MadelineProto->phone->confirmCall](../methods/phone_confirmCall.md) + + + diff --git a/old_docs/API_docs_v81/types/photos_Photo.md b/old_docs/API_docs_v81/types/photos_Photo.md new file mode 100644 index 00000000..d11bbdef --- /dev/null +++ b/old_docs/API_docs_v81/types/photos_Photo.md @@ -0,0 +1,22 @@ +--- +title: photos_Photo +description: constructors and methods of type photos_Photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: photos\_Photo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[photos\_photo](../constructors/photos_photo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->photos->uploadProfilePhoto](../methods/photos_uploadProfilePhoto.md) + + + diff --git a/old_docs/API_docs_v81/types/photos_Photos.md b/old_docs/API_docs_v81/types/photos_Photos.md new file mode 100644 index 00000000..9875ad70 --- /dev/null +++ b/old_docs/API_docs_v81/types/photos_Photos.md @@ -0,0 +1,24 @@ +--- +title: photos_Photos +description: constructors and methods of type photos_Photos +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: photos\_Photos +[Back to types index](index.md) + + + +### Possible values (constructors): + +[photos\_photos](../constructors/photos_photos.md) + +[photos\_photosSlice](../constructors/photos_photosSlice.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->photos->getUserPhotos](../methods/photos_getUserPhotos.md) + + + diff --git a/old_docs/API_docs_v81/types/storage_FileType.md b/old_docs/API_docs_v81/types/storage_FileType.md new file mode 100644 index 00000000..22118805 --- /dev/null +++ b/old_docs/API_docs_v81/types/storage_FileType.md @@ -0,0 +1,38 @@ +--- +title: storage_FileType +description: constructors and methods of type storage_FileType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: storage\_FileType +[Back to types index](index.md) + + + +### Possible values (constructors): + +[storage\_fileUnknown](../constructors/storage_fileUnknown.md) + +[storage\_filePartial](../constructors/storage_filePartial.md) + +[storage\_fileJpeg](../constructors/storage_fileJpeg.md) + +[storage\_fileGif](../constructors/storage_fileGif.md) + +[storage\_filePng](../constructors/storage_filePng.md) + +[storage\_filePdf](../constructors/storage_filePdf.md) + +[storage\_fileMp3](../constructors/storage_fileMp3.md) + +[storage\_fileMov](../constructors/storage_fileMov.md) + +[storage\_fileMp4](../constructors/storage_fileMp4.md) + +[storage\_fileWebp](../constructors/storage_fileWebp.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v81/types/string.md b/old_docs/API_docs_v81/types/string.md new file mode 100644 index 00000000..b4658c95 --- /dev/null +++ b/old_docs/API_docs_v81/types/string.md @@ -0,0 +1,9 @@ +--- +title: string +description: A UTF8 string of variable length +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +## Type: string +[Back to constructor index](index.md) + +A UTF8 string of variable length. The total length in bytes of the string must not be bigger than 16777215. diff --git a/old_docs/API_docs_v81/types/updates_ChannelDifference.md b/old_docs/API_docs_v81/types/updates_ChannelDifference.md new file mode 100644 index 00000000..dc988692 --- /dev/null +++ b/old_docs/API_docs_v81/types/updates_ChannelDifference.md @@ -0,0 +1,26 @@ +--- +title: updates_ChannelDifference +description: constructors and methods of type updates_ChannelDifference +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: updates\_ChannelDifference +[Back to types index](index.md) + + + +### Possible values (constructors): + +[updates\_channelDifferenceEmpty](../constructors/updates_channelDifferenceEmpty.md) + +[updates\_channelDifferenceTooLong](../constructors/updates_channelDifferenceTooLong.md) + +[updates\_channelDifference](../constructors/updates_channelDifference.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->updates->getChannelDifference](../methods/updates_getChannelDifference.md) + + + diff --git a/old_docs/API_docs_v81/types/updates_Difference.md b/old_docs/API_docs_v81/types/updates_Difference.md new file mode 100644 index 00000000..50bb098e --- /dev/null +++ b/old_docs/API_docs_v81/types/updates_Difference.md @@ -0,0 +1,28 @@ +--- +title: updates_Difference +description: constructors and methods of type updates_Difference +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: updates\_Difference +[Back to types index](index.md) + + + +### Possible values (constructors): + +[updates\_differenceEmpty](../constructors/updates_differenceEmpty.md) + +[updates\_difference](../constructors/updates_difference.md) + +[updates\_differenceSlice](../constructors/updates_differenceSlice.md) + +[updates\_differenceTooLong](../constructors/updates_differenceTooLong.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->updates->getDifference](../methods/updates_getDifference.md) + + + diff --git a/old_docs/API_docs_v81/types/updates_State.md b/old_docs/API_docs_v81/types/updates_State.md new file mode 100644 index 00000000..7a441145 --- /dev/null +++ b/old_docs/API_docs_v81/types/updates_State.md @@ -0,0 +1,22 @@ +--- +title: updates_State +description: constructors and methods of type updates_State +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: updates\_State +[Back to types index](index.md) + + + +### Possible values (constructors): + +[updates\_state](../constructors/updates_state.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->updates->getState](../methods/updates_getState.md) + + + diff --git a/old_docs/API_docs_v81/types/upload_CdnFile.md b/old_docs/API_docs_v81/types/upload_CdnFile.md new file mode 100644 index 00000000..51ae2e68 --- /dev/null +++ b/old_docs/API_docs_v81/types/upload_CdnFile.md @@ -0,0 +1,24 @@ +--- +title: upload_CdnFile +description: constructors and methods of type upload_CdnFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: upload\_CdnFile +[Back to types index](index.md) + + + +### Possible values (constructors): + +[upload\_cdnFileReuploadNeeded](../constructors/upload_cdnFileReuploadNeeded.md) + +[upload\_cdnFile](../constructors/upload_cdnFile.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->upload->getCdnFile](../methods/upload_getCdnFile.md) + + + diff --git a/old_docs/API_docs_v81/types/upload_File.md b/old_docs/API_docs_v81/types/upload_File.md new file mode 100644 index 00000000..00e0f9cb --- /dev/null +++ b/old_docs/API_docs_v81/types/upload_File.md @@ -0,0 +1,24 @@ +--- +title: upload_File +description: constructors and methods of type upload_File +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: upload\_File +[Back to types index](index.md) + + + +### Possible values (constructors): + +[upload\_file](../constructors/upload_file.md) + +[upload\_fileCdnRedirect](../constructors/upload_fileCdnRedirect.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->upload->getFile](../methods/upload_getFile.md) + + + diff --git a/old_docs/API_docs_v81/types/upload_WebFile.md b/old_docs/API_docs_v81/types/upload_WebFile.md new file mode 100644 index 00000000..9a86264f --- /dev/null +++ b/old_docs/API_docs_v81/types/upload_WebFile.md @@ -0,0 +1,22 @@ +--- +title: upload_WebFile +description: constructors and methods of type upload_WebFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: upload\_WebFile +[Back to types index](index.md) + + + +### Possible values (constructors): + +[upload\_webFile](../constructors/upload_webFile.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->upload->getWebFile](../methods/upload_getWebFile.md) + + +