From 75d067613653811c762496703d3eb7ae3425396f Mon Sep 17 00:00:00 2001 From: Daniil Gentili Date: Fri, 6 Mar 2020 12:24:14 +0100 Subject: [PATCH] Update docs --- docs/API_docs/constructors/accessPointRule.md | 40 - .../constructors/account.contentSettings.md | 38 + docs/API_docs/constructors/auth.loginToken.md | 38 + .../constructors/auth.loginTokenMigrateTo.md | 38 + .../constructors/auth.loginTokenSuccess.md | 37 + .../constructors/autoDownloadSettings.md | 5 +- docs/API_docs/constructors/baseThemeArctic.md | 31 + .../API_docs/constructors/baseThemeClassic.md | 31 + docs/API_docs/constructors/baseThemeDay.md | 31 + docs/API_docs/constructors/baseThemeNight.md | 31 + docs/API_docs/constructors/baseThemeTinted.md | 31 + .../constructors/help.configSimple.md | 41 - docs/API_docs/constructors/index.md | 99 +- docs/API_docs/constructors/inputMediaPoll.md | 5 +- .../inputPhotoLegacyFileLocation.md | 43 + .../constructors/inputThemeSettings.md | 41 + .../constructors/inputWallPaperNoFile.md | 31 + docs/API_docs/constructors/ipPortSecret.md | 40 - .../constructors/keyboardButtonRequestPoll.md | 37 + docs/API_docs/constructors/messageUserVote.md | 38 + .../messageUserVoteInputOption.md | 37 + .../constructors/messageUserVoteMultiple.md | 38 + .../constructors/messages.inactiveChats.md | 39 + .../constructors/messages.votesList.md | 40 + docs/API_docs/constructors/poll.md | 7 +- .../API_docs/constructors/pollAnswerVoters.md | 5 +- docs/API_docs/constructors/pollResults.md | 5 +- docs/API_docs/constructors/theme.md | 5 +- .../constructors/themeDocumentNotModified.md | 33 - docs/API_docs/constructors/themeSettings.md | 40 + .../constructors/updateGeoLiveViewed.md | 37 + .../API_docs/constructors/updateLoginToken.md | 31 + .../constructors/updateMessagePollVote.md | 38 + docs/API_docs/constructors/wallPaperNoFile.md | 38 + .../constructors/wallPaperSettings.md | 6 +- docs/API_docs/constructors/webPage.md | 6 +- .../constructors/webPageAttributeTheme.md | 37 + docs/API_docs/index.md | 6 +- docs/API_docs/methods/account.createTheme.md | 5 +- .../methods/account.getContentSettings.md | 38 + .../methods/account.getMultiWallPapers.md | 43 + .../methods/account.setContentSettings.md | 43 + docs/API_docs/methods/account.updateTheme.md | 5 +- docs/API_docs/methods/api_index.md | 38 +- .../API_docs/methods/auth.acceptLoginToken.md | 43 + .../API_docs/methods/auth.exportLoginToken.md | 45 + .../API_docs/methods/auth.importLoginToken.md | 43 + .../methods/channels.getInactiveChannels.md | 38 + .../API_docs/methods/messages.getPollVotes.md | 47 + docs/API_docs/methods/upload.getFile.md | 5 +- docs/API_docs/types/Authorization.md | 2 + docs/API_docs/types/BaseTheme.md | 28 + docs/API_docs/types/InputFileLocation.md | 2 + docs/API_docs/types/InputThemeSettings.md | 20 + docs/API_docs/types/InputWallPaper.md | 2 + docs/API_docs/types/KeyboardButton.md | 2 + docs/API_docs/types/MessageUserVote.md | 24 + docs/API_docs/types/Theme.md | 2 - .../{AccessPointRule.md => ThemeSettings.md} | 8 +- docs/API_docs/types/Update.md | 6 + docs/API_docs/types/WallPaper.md | 4 + docs/API_docs/types/WebPageAttribute.md | 20 + .../API_docs/types/account.ContentSettings.md | 23 + docs/API_docs/types/auth.LoginToken.md | 29 + docs/API_docs/types/help.ConfigSimple.md | 21 - docs/API_docs/types/index.md | 24 +- docs/API_docs/types/messages.InactiveChats.md | 23 + docs/API_docs/types/messages.VotesList.md | 23 + docs/docs/FILES.md | 2 +- docs/docs/INSTALLATION.md | 2 +- docs/docs/UPDATES.md | 2 +- docs/docs/USING_METHODS.md | 2 +- old_docs/API_docs_v109/README.md | 15 + old_docs/API_docs_v109/constructors/README.md | 2420 +++++++++++++++++ .../constructors/account.authorizationForm.md | 43 + .../constructors/account.authorizations.md | 39 + .../account.autoDownloadSettings.md | 41 + .../constructors/account.contentSettings.md | 38 + .../constructors/account.password.md | 49 + .../account.passwordInputSettings.md | 43 + .../constructors/account.passwordSettings.md | 40 + .../constructors/account.privacyRules.md | 41 + .../constructors/account.sentEmailCode.md | 40 + .../constructors/account.takeout.md | 39 + .../constructors/account.themes.md | 40 + .../constructors/account.themesNotModified.md | 34 + .../constructors/account.tmpPassword.md | 40 + .../constructors/account.wallPapers.md | 40 + .../account.wallPapersNotModified.md | 34 + .../constructors/account.webAuthorizations.md | 40 + .../constructors/accountDaysTTL.md | 38 + .../constructors/auth.authorization.md | 40 + .../auth.authorizationSignUpRequired.md | 39 + .../constructors/auth.codeTypeCall.md | 34 + .../constructors/auth.codeTypeFlashCall.md | 34 + .../constructors/auth.codeTypeSms.md | 34 + .../auth.exportedAuthorization.md | 40 + .../constructors/auth.loginToken.md | 38 + .../constructors/auth.loginTokenMigrateTo.md | 38 + .../constructors/auth.loginTokenSuccess.md | 37 + .../constructors/auth.passwordRecovery.md | 39 + .../constructors/auth.sentCode.md | 42 + .../constructors/auth.sentCodeTypeApp.md | 39 + .../constructors/auth.sentCodeTypeCall.md | 39 + .../auth.sentCodeTypeFlashCall.md | 39 + .../constructors/auth.sentCodeTypeSms.md | 39 + .../constructors/authorization.md | 52 + .../constructors/autoDownloadSettings.md | 45 + .../constructors/baseThemeArctic.md | 31 + .../constructors/baseThemeClassic.md | 31 + .../constructors/baseThemeDay.md | 31 + .../constructors/baseThemeNight.md | 31 + .../constructors/baseThemeTinted.md | 31 + .../API_docs_v109/constructors/boolFalse.md | 9 + .../API_docs_v109/constructors/boolTrue.md | 9 + .../API_docs_v109/constructors/botCommand.md | 39 + .../API_docs_v109/constructors/botInfo.md | 40 + .../constructors/botInlineMediaResult.md | 44 + .../constructors/botInlineMessageMediaAuto.md | 46 + .../botInlineMessageMediaContact.md | 48 + .../constructors/botInlineMessageMediaGeo.md | 46 + .../botInlineMessageMediaVenue.md | 50 + .../constructors/botInlineMessageText.md | 47 + .../constructors/botInlineResult.md | 45 + .../API_docs_v109/constructors/cdnConfig.md | 38 + .../constructors/cdnPublicKey.md | 39 + .../API_docs_v109/constructors/channel.md | 61 + .../constructors/channelAdminLogEvent.md | 41 + .../channelAdminLogEventActionChangeAbout.md | 39 + ...nnelAdminLogEventActionChangeLinkedChat.md | 39 + ...hannelAdminLogEventActionChangeLocation.md | 39 + .../channelAdminLogEventActionChangePhoto.md | 39 + ...nnelAdminLogEventActionChangeStickerSet.md | 39 + .../channelAdminLogEventActionChangeTitle.md | 39 + ...hannelAdminLogEventActionChangeUsername.md | 39 + ...lAdminLogEventActionDefaultBannedRights.md | 39 + ...channelAdminLogEventActionDeleteMessage.md | 38 + .../channelAdminLogEventActionEditMessage.md | 39 + ...nelAdminLogEventActionParticipantInvite.md | 38 + ...annelAdminLogEventActionParticipantJoin.md | 33 + ...nnelAdminLogEventActionParticipantLeave.md | 33 + ...minLogEventActionParticipantToggleAdmin.md | 39 + ...AdminLogEventActionParticipantToggleBan.md | 39 + .../channelAdminLogEventActionStopPoll.md | 38 + ...channelAdminLogEventActionToggleInvites.md | 38 + ...minLogEventActionTogglePreHistoryHidden.md | 38 + ...nnelAdminLogEventActionToggleSignatures.md | 38 + ...hannelAdminLogEventActionToggleSlowMode.md | 39 + .../channelAdminLogEventActionUpdatePinned.md | 38 + .../channelAdminLogEventsFilter.md | 51 + .../constructors/channelForbidden.md | 43 + .../API_docs_v109/constructors/channelFull.md | 69 + .../constructors/channelLocation.md | 39 + .../constructors/channelLocationEmpty.md | 33 + .../constructors/channelMessagesFilter.md | 39 + .../channelMessagesFilterEmpty.md | 33 + .../constructors/channelParticipant.md | 39 + .../constructors/channelParticipantAdmin.md | 45 + .../constructors/channelParticipantBanned.md | 42 + .../constructors/channelParticipantCreator.md | 39 + .../constructors/channelParticipantSelf.md | 40 + .../constructors/channelParticipantsAdmins.md | 33 + .../constructors/channelParticipantsBanned.md | 38 + .../constructors/channelParticipantsBots.md | 33 + .../channelParticipantsContacts.md | 38 + .../constructors/channelParticipantsKicked.md | 38 + .../constructors/channelParticipantsRecent.md | 33 + .../constructors/channelParticipantsSearch.md | 38 + .../constructors/channels.adminLogResults.md | 41 + .../channels.channelParticipant.md | 40 + .../channels.channelParticipants.md | 41 + ...channels.channelParticipantsNotModified.md | 34 + old_docs/API_docs_v109/constructors/chat.md | 50 + .../constructors/chatAdminRights.md | 45 + .../constructors/chatBannedRights.md | 50 + .../API_docs_v109/constructors/chatEmpty.md | 38 + .../constructors/chatForbidden.md | 39 + .../API_docs_v109/constructors/chatFull.md | 48 + .../API_docs_v109/constructors/chatInvite.md | 45 + .../constructors/chatInviteAlready.md | 38 + .../constructors/chatInviteEmpty.md | 33 + .../constructors/chatInviteExported.md | 38 + .../API_docs_v109/constructors/chatOnlines.md | 38 + .../constructors/chatParticipant.md | 40 + .../constructors/chatParticipantAdmin.md | 40 + .../constructors/chatParticipantCreator.md | 38 + .../constructors/chatParticipants.md | 40 + .../constructors/chatParticipantsForbidden.md | 39 + .../API_docs_v109/constructors/chatPhoto.md | 40 + .../constructors/chatPhotoEmpty.md | 33 + .../constructors/codeSettings.md | 44 + old_docs/API_docs_v109/constructors/config.md | 88 + .../API_docs_v109/constructors/contact.md | 39 + .../constructors/contactBlocked.md | 39 + .../constructors/contactStatus.md | 39 + .../constructors/contacts.blocked.md | 40 + .../constructors/contacts.blockedSlice.md | 41 + .../constructors/contacts.contacts.md | 41 + .../contacts.contactsNotModified.md | 34 + .../constructors/contacts.found.md | 42 + .../constructors/contacts.importedContacts.md | 42 + .../constructors/contacts.resolvedPeer.md | 41 + .../constructors/contacts.topPeers.md | 41 + .../constructors/contacts.topPeersDisabled.md | 34 + .../contacts.topPeersNotModified.md | 34 + .../API_docs_v109/constructors/dataJSON.md | 38 + .../API_docs_v109/constructors/dcOption.md | 46 + old_docs/API_docs_v109/constructors/dialog.md | 49 + .../constructors/dialogFolder.md | 45 + .../API_docs_v109/constructors/dialogPeer.md | 17 +- .../constructors/dialogPeerFolder.md | 38 + .../API_docs_v109/constructors/document.md | 46 + .../constructors/documentAttributeAnimated.md | 33 + .../constructors/documentAttributeAudio.md | 42 + .../constructors/documentAttributeFilename.md | 38 + .../documentAttributeHasStickers.md | 33 + .../documentAttributeImageSize.md | 39 + .../constructors/documentAttributeSticker.md | 41 + .../constructors/documentAttributeVideo.md | 42 + .../constructors/documentEmpty.md | 38 + .../constructors/draftMessage.md | 42 + .../constructors/draftMessageEmpty.md | 38 + .../constructors/emojiKeyword.md | 39 + .../constructors/emojiKeywordDeleted.md | 39 + .../constructors/emojiKeywordsDifference.md | 41 + .../constructors/emojiLanguage.md | 38 + .../API_docs_v109/constructors/emojiURL.md | 38 + .../constructors/encryptedChat.md | 44 + .../constructors/encryptedChatDiscarded.md | 38 + .../constructors/encryptedChatEmpty.md | 38 + .../constructors/encryptedChatRequested.md | 43 + .../constructors/encryptedChatWaiting.md | 42 + .../constructors/encryptedFile.md | 42 + .../constructors/encryptedFileEmpty.md | 33 + .../constructors/encryptedMessage.md | 41 + .../constructors/encryptedMessageService.md | 40 + old_docs/API_docs_v109/constructors/error.md | 39 + .../constructors/exportedMessageLink.md | 39 + .../API_docs_v109/constructors/fileHash.md | 40 + .../fileLocationToBeDeprecated.md | 39 + old_docs/API_docs_v109/constructors/folder.md | 43 + .../API_docs_v109/constructors/folderPeer.md | 39 + .../API_docs_v109/constructors/foundGif.md | 43 + .../constructors/foundGifCached.md | 40 + old_docs/API_docs_v109/constructors/game.md | 44 + .../API_docs_v109/constructors/geoPoint.md | 40 + .../constructors/geoPointEmpty.md | 33 + .../constructors/help.appUpdate.md | 45 + .../constructors/help.deepLinkInfo.md | 41 + .../constructors/help.deepLinkInfoEmpty.md | 34 + .../constructors/help.inviteText.md | 39 + .../constructors/help.noAppUpdate.md | 34 + .../constructors/help.passportConfig.md | 40 + .../help.passportConfigNotModified.md | 34 + .../constructors/help.proxyDataEmpty.md | 39 + .../constructors/help.proxyDataPromo.md | 42 + .../constructors/help.recentMeUrls.md | 41 + .../constructors/help.support.md | 40 + .../constructors/help.supportName.md | 39 + .../constructors/help.termsOfService.md | 43 + .../constructors/help.termsOfServiceUpdate.md | 40 + .../help.termsOfServiceUpdateEmpty.md | 39 + .../constructors/help.userInfo.md | 42 + .../constructors/help.userInfoEmpty.md | 34 + .../API_docs_v109/constructors/highScore.md | 40 + .../constructors/importedContact.md | 39 + .../constructors/inlineBotSwitchPM.md | 39 + .../constructors/inputAppEvent.md | 41 + .../constructors/inputBotInlineMessageGame.md | 44 + .../constructors/inputBotInlineMessageID.md | 40 + .../inputBotInlineMessageMediaAuto.md | 46 + .../inputBotInlineMessageMediaContact.md | 48 + .../inputBotInlineMessageMediaGeo.md | 46 + .../inputBotInlineMessageMediaVenue.md | 50 + .../constructors/inputBotInlineMessageText.md | 47 + .../constructors/inputBotInlineResult.md | 45 + .../inputBotInlineResultDocument.md | 43 + .../constructors/inputBotInlineResultGame.md | 40 + .../constructors/inputBotInlineResultPhoto.md | 41 + .../constructors/inputChannel.md | 39 + .../constructors/inputChannelEmpty.md | 33 + .../constructors/inputChannelFromMessage.md | 40 + .../constructors/inputChatPhoto.md | 38 + .../constructors/inputChatPhotoEmpty.md | 33 + .../constructors/inputChatUploadedPhoto.md | 38 + .../constructors/inputCheckPasswordEmpty.md | 33 + .../constructors/inputCheckPasswordSRP.md | 40 + .../constructors/inputClientProxy.md | 39 + .../constructors/inputDialogPeer.md | 38 + .../constructors/inputDialogPeerFolder.md | 38 + .../constructors/inputDocument.md | 40 + .../constructors/inputDocumentEmpty.md | 33 + .../constructors/inputDocumentFileLocation.md | 41 + .../constructors/inputEncryptedChat.md | 39 + .../constructors/inputEncryptedFile.md | 39 + .../inputEncryptedFileBigUploaded.md | 40 + .../constructors/inputEncryptedFileEmpty.md | 33 + .../inputEncryptedFileLocation.md | 39 + .../inputEncryptedFileUploaded.md | 41 + .../API_docs_v109/constructors/inputFile.md | 41 + .../constructors/inputFileBig.md | 40 + .../constructors/inputFileLocation.md | 41 + .../constructors/inputFolderPeer.md | 39 + .../API_docs_v109/constructors/inputGameID.md | 39 + .../constructors/inputGameShortName.md | 39 + .../constructors/inputGeoPoint.md | 39 + .../constructors/inputGeoPointEmpty.md | 33 + .../inputKeyboardButtonUrlAuth.md | 42 + .../constructors/inputMediaContact.md | 41 + .../constructors/inputMediaDocument.md | 39 + .../inputMediaDocumentExternal.md | 39 + .../constructors/inputMediaEmpty.md | 33 + .../constructors/inputMediaGame.md | 38 + .../constructors/inputMediaGeoLive.md | 40 + .../constructors/inputMediaGeoPoint.md | 38 + .../constructors/inputMediaGifExternal.md | 39 + .../constructors/inputMediaInvoice.md | 45 + .../constructors/inputMediaPhoto.md | 39 + .../constructors/inputMediaPhotoExternal.md | 39 + .../constructors/inputMediaPoll.md | 39 + .../inputMediaUploadedDocument.md | 44 + .../constructors/inputMediaUploadedPhoto.md | 40 + .../constructors/inputMediaVenue.md | 43 + .../inputMessageEntityMentionName.md | 40 + .../constructors/inputMessageID.md | 38 + .../constructors/inputMessagePinned.md | 33 + .../constructors/inputMessageReplyTo.md | 38 + .../inputMessagesFilterChatPhotos.md | 33 + .../inputMessagesFilterContacts.md | 33 + .../inputMessagesFilterDocument.md | 33 + .../constructors/inputMessagesFilterEmpty.md | 33 + .../constructors/inputMessagesFilterGeo.md | 33 + .../constructors/inputMessagesFilterGif.md | 33 + .../constructors/inputMessagesFilterMusic.md | 33 + .../inputMessagesFilterMyMentions.md | 33 + .../inputMessagesFilterPhoneCalls.md | 38 + .../inputMessagesFilterPhotoVideo.md | 33 + .../constructors/inputMessagesFilterPhotos.md | 33 + .../inputMessagesFilterRoundVideo.md | 33 + .../inputMessagesFilterRoundVoice.md | 33 + .../constructors/inputMessagesFilterUrl.md | 33 + .../constructors/inputMessagesFilterVideo.md | 33 + .../constructors/inputMessagesFilterVoice.md | 33 + .../constructors/inputNotifyBroadcasts.md | 33 + .../constructors/inputNotifyChats.md | 33 + .../constructors/inputNotifyPeer.md | 38 + .../constructors/inputNotifyUsers.md | 33 + .../constructors/inputPaymentCredentials.md | 39 + .../inputPaymentCredentialsAndroidPay.md | 39 + .../inputPaymentCredentialsApplePay.md | 38 + .../inputPaymentCredentialsSaved.md | 39 + .../constructors/inputPeerChannel.md | 39 + .../inputPeerChannelFromMessage.md | 40 + .../constructors/inputPeerChat.md | 38 + .../constructors/inputPeerEmpty.md | 33 + .../constructors/inputPeerNotifySettings.md | 41 + .../inputPeerPhotoFileLocation.md | 41 + .../constructors/inputPeerSelf.md | 33 + .../constructors/inputPeerUser.md | 39 + .../constructors/inputPeerUserFromMessage.md | 40 + .../constructors/inputPhoneCall.md | 39 + .../constructors/inputPhoneContact.md | 41 + .../API_docs_v109/constructors/inputPhoto.md | 40 + .../constructors/inputPhotoEmpty.md | 33 + .../constructors/inputPhotoFileLocation.md | 41 + .../inputPhotoLegacyFileLocation.md | 43 + .../inputPrivacyKeyAddedByPhone.md | 33 + .../constructors/inputPrivacyKeyChatInvite.md | 33 + .../constructors/inputPrivacyKeyForwards.md | 33 + .../constructors/inputPrivacyKeyPhoneCall.md | 33 + .../inputPrivacyKeyPhoneNumber.md | 33 + .../constructors/inputPrivacyKeyPhoneP2P.md | 33 + .../inputPrivacyKeyProfilePhoto.md | 33 + .../inputPrivacyKeyStatusTimestamp.md | 33 + .../constructors/inputPrivacyValueAllowAll.md | 33 + .../inputPrivacyValueAllowChatParticipants.md | 38 + .../inputPrivacyValueAllowContacts.md | 33 + .../inputPrivacyValueAllowUsers.md | 38 + .../inputPrivacyValueDisallowAll.md | 33 + ...putPrivacyValueDisallowChatParticipants.md | 38 + .../inputPrivacyValueDisallowContacts.md | 33 + .../inputPrivacyValueDisallowUsers.md | 38 + .../inputReportReasonChildAbuse.md | 33 + .../inputReportReasonCopyright.md | 33 + .../inputReportReasonGeoIrrelevant.md | 33 + .../constructors/inputReportReasonOther.md | 38 + .../inputReportReasonPornography.md | 33 + .../constructors/inputReportReasonSpam.md | 33 + .../constructors/inputReportReasonViolence.md | 33 + .../constructors/inputSecureFile.md | 39 + .../constructors/inputSecureFileLocation.md | 39 + .../constructors/inputSecureFileUploaded.md | 42 + .../constructors/inputSecureValue.md | 45 + .../constructors/inputSingleMedia.md | 40 + .../inputStickerSetAnimatedEmoji.md | 33 + .../constructors/inputStickerSetEmpty.md | 33 + .../constructors/inputStickerSetID.md | 39 + .../constructors/inputStickerSetItem.md | 40 + .../constructors/inputStickerSetShortName.md | 38 + .../constructors/inputStickerSetThumb.md | 40 + .../inputStickeredMediaDocument.md | 38 + .../constructors/inputStickeredMediaPhoto.md | 38 + .../constructors/inputTakeoutFileLocation.md | 33 + .../API_docs_v109/constructors/inputTheme.md | 39 + .../constructors/inputThemeSettings.md | 41 + .../constructors/inputThemeSlug.md | 38 + .../API_docs_v109/constructors/inputUser.md | 39 + .../constructors/inputUserEmpty.md | 33 + .../constructors/inputUserFromMessage.md | 40 + .../constructors/inputUserSelf.md | 33 + .../constructors/inputWallPaper.md | 39 + .../constructors/inputWallPaperNoFile.md | 31 + .../constructors/inputWallPaperSlug.md | 38 + .../constructors/inputWebDocument.md | 41 + .../inputWebFileGeoPointLocation.md | 43 + .../constructors/inputWebFileLocation.md | 39 + .../API_docs_v109/constructors/invoice.md | 47 + .../API_docs_v109/constructors/jsonArray.md | 38 + .../API_docs_v109/constructors/jsonBool.md | 38 + .../API_docs_v109/constructors/jsonNull.md | 33 + .../API_docs_v109/constructors/jsonNumber.md | 38 + .../API_docs_v109/constructors/jsonObject.md | 38 + .../constructors/jsonObjectValue.md | 39 + .../API_docs_v109/constructors/jsonString.md | 38 + .../constructors/keyboardButton.md | 38 + .../constructors/keyboardButtonBuy.md | 38 + .../constructors/keyboardButtonCallback.md | 39 + .../constructors/keyboardButtonGame.md | 38 + .../keyboardButtonRequestGeoLocation.md | 38 + .../keyboardButtonRequestPhone.md | 38 + .../constructors/keyboardButtonRequestPoll.md | 37 + .../constructors/keyboardButtonRow.md | 38 + .../keyboardButtonSwitchInline.md | 40 + .../constructors/keyboardButtonUrl.md | 39 + .../constructors/keyboardButtonUrlAuth.md | 41 + .../constructors/labeledPrice.md | 39 + .../constructors/langPackDifference.md | 41 + .../constructors/langPackLanguage.md | 48 + .../constructors/langPackString.md | 39 + .../constructors/langPackStringDeleted.md | 38 + .../constructors/langPackStringPluralized.md | 44 + .../API_docs_v109/constructors/maskCoords.md | 55 + .../API_docs_v109/constructors/message.md | 67 + .../constructors/messageActionBotAllowed.md | 38 + .../messageActionChannelCreate.md | 38 + .../messageActionChannelMigrateFrom.md | 39 + .../constructors/messageActionChatAddUser.md | 38 + .../constructors/messageActionChatCreate.md | 39 + .../messageActionChatDeletePhoto.md | 33 + .../messageActionChatDeleteUser.md | 38 + .../messageActionChatEditPhoto.md | 38 + .../messageActionChatEditTitle.md | 38 + .../messageActionChatJoinedByLink.md | 38 + .../messageActionChatMigrateTo.md | 38 + .../messageActionContactSignUp.md | 33 + .../constructors/messageActionCustomAction.md | 38 + .../constructors/messageActionEmpty.md | 33 + .../constructors/messageActionGameScore.md | 39 + .../constructors/messageActionHistoryClear.md | 33 + .../constructors/messageActionPaymentSent.md | 39 + .../messageActionPaymentSentMe.md | 43 + .../constructors/messageActionPhoneCall.md | 41 + .../constructors/messageActionPinMessage.md | 33 + .../messageActionScreenshotTaken.md | 33 + .../messageActionSecureValuesSent.md | 38 + .../messageActionSecureValuesSentMe.md | 39 + .../constructors/messageEmpty.md | 38 + .../constructors/messageEntityBlockquote.md | 39 + .../constructors/messageEntityBold.md | 39 + .../constructors/messageEntityBotCommand.md | 39 + .../constructors/messageEntityCashtag.md | 39 + .../constructors/messageEntityCode.md | 39 + .../constructors/messageEntityEmail.md | 39 + .../constructors/messageEntityHashtag.md | 39 + .../constructors/messageEntityItalic.md | 39 + .../constructors/messageEntityMention.md | 39 + .../constructors/messageEntityMentionName.md | 40 + .../constructors/messageEntityPhone.md | 39 + .../constructors/messageEntityPre.md | 40 + .../constructors/messageEntityStrike.md | 39 + .../constructors/messageEntityTextUrl.md | 40 + .../constructors/messageEntityUnderline.md | 39 + .../constructors/messageEntityUnknown.md | 39 + .../constructors/messageEntityUrl.md | 39 + .../constructors/messageFwdHeader.md | 45 + .../constructors/messageMediaContact.md | 42 + .../constructors/messageMediaDocument.md | 39 + .../constructors/messageMediaEmpty.md | 33 + .../constructors/messageMediaGame.md | 38 + .../constructors/messageMediaGeo.md | 38 + .../constructors/messageMediaGeoLive.md | 39 + .../constructors/messageMediaInvoice.md | 46 + .../constructors/messageMediaPhoto.md | 39 + .../constructors/messageMediaPoll.md | 39 + .../constructors/messageMediaUnsupported.md | 33 + .../constructors/messageMediaVenue.md | 43 + .../constructors/messageMediaWebPage.md | 38 + .../constructors/messageRange.md | 39 + .../constructors/messageService.md | 49 + .../constructors/messageUserVote.md | 38 + .../messageUserVoteInputOption.md | 37 + .../constructors/messageUserVoteMultiple.md | 38 + .../constructors/messages.affectedHistory.md | 41 + .../constructors/messages.affectedMessages.md | 40 + .../constructors/messages.allStickers.md | 40 + .../messages.allStickersNotModified.md | 34 + .../constructors/messages.archivedStickers.md | 40 + .../messages.botCallbackAnswer.md | 44 + .../constructors/messages.botResults.md | 45 + .../constructors/messages.channelMessages.md | 44 + .../constructors/messages.chatFull.md | 41 + .../constructors/messages.chats.md | 39 + .../constructors/messages.chatsSlice.md | 40 + .../constructors/messages.dhConfig.md | 42 + .../messages.dhConfigNotModified.md | 39 + .../constructors/messages.dialogs.md | 42 + .../messages.dialogsNotModified.md | 39 + .../constructors/messages.dialogsSlice.md | 43 + .../constructors/messages.favedStickers.md | 41 + .../messages.favedStickersNotModified.md | 34 + .../constructors/messages.featuredStickers.md | 41 + .../messages.featuredStickersNotModified.md | 34 + .../constructors/messages.foundGifs.md | 40 + .../constructors/messages.foundStickerSets.md | 40 + .../messages.foundStickerSetsNotModified.md | 34 + .../constructors/messages.highScores.md | 40 + .../constructors/messages.inactiveChats.md | 39 + .../constructors/messages.messageEditData.md | 39 + .../constructors/messages.messages.md | 41 + .../messages.messagesNotModified.md | 39 + .../constructors/messages.messagesSlice.md | 44 + .../constructors/messages.peerDialogs.md | 43 + .../constructors/messages.recentStickers.md | 42 + .../messages.recentStickersNotModified.md | 34 + .../constructors/messages.savedGifs.md | 40 + .../messages.savedGifsNotModified.md | 34 + .../constructors/messages.searchCounter.md | 41 + .../messages.sentEncryptedFile.md | 40 + .../messages.sentEncryptedMessage.md | 39 + .../constructors/messages.stickerSet.md | 41 + ...messages.stickerSetInstallResultArchive.md | 39 + ...messages.stickerSetInstallResultSuccess.md | 34 + .../constructors/messages.stickers.md | 40 + .../messages.stickersNotModified.md | 34 + .../constructors/messages.votesList.md | 40 + .../API_docs_v109/constructors/nearestDc.md | 40 + .../constructors/notifyBroadcasts.md | 33 + .../API_docs_v109/constructors/notifyChats.md | 33 + .../API_docs_v109/constructors/notifyPeer.md | 38 + .../API_docs_v109/constructors/notifyUsers.md | 33 + old_docs/API_docs_v109/constructors/null.md | 9 + old_docs/API_docs_v109/constructors/page.md | 44 + .../constructors/pageBlockAnchor.md | 38 + .../constructors/pageBlockAudio.md | 39 + .../constructors/pageBlockAuthorDate.md | 39 + .../constructors/pageBlockBlockquote.md | 39 + .../constructors/pageBlockChannel.md | 38 + .../constructors/pageBlockCollage.md | 39 + .../constructors/pageBlockCover.md | 38 + .../constructors/pageBlockDetails.md | 40 + .../constructors/pageBlockDivider.md | 33 + .../constructors/pageBlockEmbed.md | 45 + .../constructors/pageBlockEmbedPost.md | 44 + .../constructors/pageBlockFooter.md | 38 + .../constructors/pageBlockHeader.md | 38 + .../constructors/pageBlockKicker.md | 38 + .../constructors/pageBlockList.md | 38 + .../constructors/pageBlockMap.md | 42 + .../constructors/pageBlockOrderedList.md | 38 + .../constructors/pageBlockParagraph.md | 38 + .../constructors/pageBlockPhoto.md | 41 + .../constructors/pageBlockPreformatted.md | 39 + .../constructors/pageBlockPullquote.md | 39 + .../constructors/pageBlockRelatedArticles.md | 39 + .../constructors/pageBlockSlideshow.md | 39 + .../constructors/pageBlockSubheader.md | 38 + .../constructors/pageBlockSubtitle.md | 38 + .../constructors/pageBlockTable.md | 41 + .../constructors/pageBlockTitle.md | 38 + .../constructors/pageBlockUnsupported.md | 33 + .../constructors/pageBlockVideo.md | 41 + .../API_docs_v109/constructors/pageCaption.md | 39 + .../constructors/pageListItemBlocks.md | 38 + .../constructors/pageListItemText.md | 38 + .../constructors/pageListOrderedItemBlocks.md | 39 + .../constructors/pageListOrderedItemText.md | 39 + .../constructors/pageRelatedArticle.md | 44 + .../constructors/pageTableCell.md | 45 + .../constructors/pageTableRow.md | 38 + ...6PBKDF2HMACSHA512iter100000SHA256ModPow.md | 41 + .../constructors/passwordKdfAlgoUnknown.md | 33 + .../constructors/paymentCharge.md | 39 + .../constructors/paymentRequestedInfo.md | 41 + .../paymentSavedCredentialsCard.md | 39 + .../constructors/payments.paymentForm.md | 49 + .../constructors/payments.paymentReceipt.md | 48 + .../constructors/payments.paymentResult.md | 39 + .../payments.paymentVerificationNeeded.md | 39 + .../constructors/payments.savedInfo.md | 40 + .../payments.validatedRequestedInfo.md | 40 + .../API_docs_v109/constructors/peerChannel.md | 38 + .../API_docs_v109/constructors/peerChat.md | 38 + .../API_docs_v109/constructors/peerLocated.md | 40 + .../constructors/peerNotifySettings.md | 41 + .../constructors/peerSettings.md | 43 + .../API_docs_v109/constructors/peerUser.md | 38 + .../constructors/phone.phoneCall.md | 40 + .../API_docs_v109/constructors/phoneCall.md | 48 + .../constructors/phoneCallAccepted.md | 45 + .../phoneCallDiscardReasonBusy.md | 33 + .../phoneCallDiscardReasonDisconnect.md | 33 + .../phoneCallDiscardReasonHangup.md | 33 + .../phoneCallDiscardReasonMissed.md | 33 + .../constructors/phoneCallDiscarded.md | 43 + .../constructors/phoneCallEmpty.md | 38 + .../constructors/phoneCallProtocol.md | 41 + .../constructors/phoneCallRequested.md | 45 + .../constructors/phoneCallWaiting.md | 45 + .../constructors/phoneConnection.md | 42 + old_docs/API_docs_v109/constructors/photo.md | 44 + .../constructors/photoCachedSize.md | 42 + .../API_docs_v109/constructors/photoEmpty.md | 38 + .../API_docs_v109/constructors/photoSize.md | 42 + .../constructors/photoSizeEmpty.md | 38 + .../constructors/photoStrippedSize.md | 39 + .../constructors/photos.photo.md | 40 + .../constructors/photos.photos.md | 40 + .../constructors/photos.photosSlice.md | 41 + old_docs/API_docs_v109/constructors/poll.md | 44 + .../API_docs_v109/constructors/pollAnswer.md | 39 + .../constructors/pollAnswerVoters.md | 41 + .../API_docs_v109/constructors/pollResults.md | 41 + .../constructors/popularContact.md | 39 + .../API_docs_v109/constructors/postAddress.md | 43 + .../constructors/privacyKeyAddedByPhone.md | 33 + .../constructors/privacyKeyChatInvite.md | 33 + .../constructors/privacyKeyForwards.md | 33 + .../constructors/privacyKeyPhoneCall.md | 33 + .../constructors/privacyKeyPhoneNumber.md | 33 + .../constructors/privacyKeyPhoneP2P.md | 33 + .../constructors/privacyKeyProfilePhoto.md | 33 + .../constructors/privacyKeyStatusTimestamp.md | 33 + .../constructors/privacyValueAllowAll.md | 33 + .../privacyValueAllowChatParticipants.md | 38 + .../constructors/privacyValueAllowContacts.md | 33 + .../constructors/privacyValueAllowUsers.md | 38 + .../constructors/privacyValueDisallowAll.md | 33 + .../privacyValueDisallowChatParticipants.md | 38 + .../privacyValueDisallowContacts.md | 33 + .../constructors/privacyValueDisallowUsers.md | 38 + .../constructors/receivedNotifyMessage.md | 38 + .../constructors/recentMeUrlChat.md | 39 + .../constructors/recentMeUrlChatInvite.md | 39 + .../constructors/recentMeUrlStickerSet.md | 39 + .../constructors/recentMeUrlUnknown.md | 38 + .../constructors/recentMeUrlUser.md | 39 + .../constructors/replyInlineMarkup.md | 38 + .../constructors/replyKeyboardForceReply.md | 39 + .../constructors/replyKeyboardHide.md | 38 + .../constructors/replyKeyboardMarkup.md | 41 + .../constructors/restrictionReason.md | 44 + .../constructors/savedPhoneContact.md | 41 + .../secureCredentialsEncrypted.md | 40 + .../API_docs_v109/constructors/secureData.md | 40 + .../API_docs_v109/constructors/secureFile.md | 44 + .../constructors/secureFileEmpty.md | 33 + ...sswordKdfAlgoPBKDF2HMACSHA512iter100000.md | 38 + .../securePasswordKdfAlgoSHA512.md | 38 + .../securePasswordKdfAlgoUnknown.md | 33 + .../constructors/securePlainEmail.md | 38 + .../constructors/securePlainPhone.md | 38 + .../constructors/secureRequiredType.md | 41 + .../constructors/secureRequiredTypeOneOf.md | 38 + .../constructors/secureSecretSettings.md | 40 + .../API_docs_v109/constructors/secureValue.md | 46 + .../constructors/secureValueError.md | 40 + .../constructors/secureValueErrorData.md | 41 + .../constructors/secureValueErrorFile.md | 40 + .../constructors/secureValueErrorFiles.md | 40 + .../constructors/secureValueErrorFrontSide.md | 40 + .../secureValueErrorReverseSide.md | 40 + .../constructors/secureValueErrorSelfie.md | 40 + .../secureValueErrorTranslationFile.md | 40 + .../secureValueErrorTranslationFiles.md | 40 + .../constructors/secureValueHash.md | 39 + .../constructors/secureValueTypeAddress.md | 33 + .../secureValueTypeBankStatement.md | 33 + .../secureValueTypeDriverLicense.md | 33 + .../constructors/secureValueTypeEmail.md | 33 + .../secureValueTypeIdentityCard.md | 33 + .../secureValueTypeInternalPassport.md | 33 + .../constructors/secureValueTypePassport.md | 33 + .../secureValueTypePassportRegistration.md | 33 + .../secureValueTypePersonalDetails.md | 33 + .../constructors/secureValueTypePhone.md | 33 + .../secureValueTypeRentalAgreement.md | 33 + .../secureValueTypeTemporaryRegistration.md | 33 + .../secureValueTypeUtilityBill.md | 33 + .../constructors/sendMessageCancelAction.md | 33 + .../sendMessageChooseContactAction.md | 33 + .../constructors/sendMessageGamePlayAction.md | 33 + .../sendMessageGeoLocationAction.md | 33 + .../sendMessageRecordAudioAction.md | 33 + .../sendMessageRecordRoundAction.md | 33 + .../sendMessageRecordVideoAction.md | 33 + .../constructors/sendMessageTypingAction.md | 33 + .../sendMessageUploadAudioAction.md | 38 + .../sendMessageUploadDocumentAction.md | 38 + .../sendMessageUploadPhotoAction.md | 38 + .../sendMessageUploadRoundAction.md | 38 + .../sendMessageUploadVideoAction.md | 38 + .../constructors/shippingOption.md | 40 + .../API_docs_v109/constructors/statsURL.md | 38 + .../API_docs_v109/constructors/stickerPack.md | 41 + .../API_docs_v109/constructors/stickerSet.md | 50 + .../constructors/stickerSetCovered.md | 39 + .../constructors/stickerSetMultiCovered.md | 39 + .../constructors/storage.fileGif.md | 34 + .../constructors/storage.fileJpeg.md | 34 + .../constructors/storage.fileMov.md | 34 + .../constructors/storage.fileMp3.md | 34 + .../constructors/storage.fileMp4.md | 34 + .../constructors/storage.filePartial.md | 34 + .../constructors/storage.filePdf.md | 34 + .../constructors/storage.filePng.md | 34 + .../constructors/storage.fileUnknown.md | 34 + .../constructors/storage.fileWebp.md | 34 + .../API_docs_v109/constructors/textAnchor.md | 39 + .../API_docs_v109/constructors/textBold.md | 38 + .../API_docs_v109/constructors/textConcat.md | 38 + .../API_docs_v109/constructors/textEmail.md | 39 + .../API_docs_v109/constructors/textEmpty.md | 33 + .../API_docs_v109/constructors/textFixed.md | 38 + .../API_docs_v109/constructors/textImage.md | 40 + .../API_docs_v109/constructors/textItalic.md | 38 + .../API_docs_v109/constructors/textMarked.md | 38 + .../API_docs_v109/constructors/textPhone.md | 39 + .../API_docs_v109/constructors/textPlain.md | 38 + .../API_docs_v109/constructors/textStrike.md | 38 + .../constructors/textSubscript.md | 38 + .../constructors/textSuperscript.md | 38 + .../constructors/textUnderline.md | 38 + .../API_docs_v109/constructors/textUrl.md | 40 + old_docs/API_docs_v109/constructors/theme.md | 46 + .../constructors/themeSettings.md | 40 + .../API_docs_v109/constructors/topPeer.md | 39 + .../constructors/topPeerCategoryBotsInline.md | 33 + .../constructors/topPeerCategoryBotsPM.md | 33 + .../constructors/topPeerCategoryChannels.md | 33 + .../topPeerCategoryCorrespondents.md | 33 + .../topPeerCategoryForwardChats.md | 33 + .../topPeerCategoryForwardUsers.md | 33 + .../constructors/topPeerCategoryGroups.md | 33 + .../constructors/topPeerCategoryPeers.md | 40 + .../constructors/topPeerCategoryPhoneCalls.md | 33 + old_docs/API_docs_v109/constructors/true.md | 33 + .../constructors/updateBotCallbackQuery.md | 44 + .../constructors/updateBotInlineQuery.md | 42 + .../constructors/updateBotInlineSend.md | 42 + .../constructors/updateBotPrecheckoutQuery.md | 44 + .../constructors/updateBotShippingQuery.md | 41 + .../constructors/updateBotWebhookJSON.md | 38 + .../constructors/updateBotWebhookJSONQuery.md | 40 + .../constructors/updateChannel.md | 38 + .../updateChannelAvailableMessages.md | 39 + .../constructors/updateChannelMessageViews.md | 40 + .../updateChannelPinnedMessage.md | 39 + .../updateChannelReadMessagesContents.md | 39 + .../constructors/updateChannelTooLong.md | 39 + .../constructors/updateChannelWebPage.md | 41 + .../updateChatDefaultBannedRights.md | 40 + .../constructors/updateChatParticipantAdd.md | 42 + .../updateChatParticipantAdmin.md | 41 + .../updateChatParticipantDelete.md | 40 + .../constructors/updateChatParticipants.md | 38 + .../constructors/updateChatPinnedMessage.md | 40 + .../constructors/updateChatUserTyping.md | 40 + .../constructors/updateConfig.md | 33 + .../constructors/updateContactsReset.md | 33 + .../constructors/updateDcOptions.md | 38 + .../updateDeleteChannelMessages.md | 41 + .../constructors/updateDeleteMessages.md | 40 + .../updateDeleteScheduledMessages.md | 39 + .../constructors/updateDialogPinned.md | 40 + .../constructors/updateDialogUnreadMark.md | 39 + .../constructors/updateDraftMessage.md | 39 + .../constructors/updateEditChannelMessage.md | 40 + .../constructors/updateEditMessage.md | 40 + .../constructors/updateEncryptedChatTyping.md | 38 + .../updateEncryptedMessagesRead.md | 40 + .../constructors/updateEncryption.md | 39 + .../constructors/updateFavedStickers.md | 33 + .../constructors/updateFolderPeers.md | 40 + .../constructors/updateGeoLiveViewed.md | 37 + .../updateInlineBotCallbackQuery.md | 43 + .../constructors/updateLangPack.md | 38 + .../constructors/updateLangPackTooLong.md | 38 + .../constructors/updateLoginToken.md | 31 + .../constructors/updateMessageID.md | 38 + .../constructors/updateMessagePoll.md | 40 + .../constructors/updateMessagePollVote.md | 38 + .../constructors/updateNewChannelMessage.md | 40 + .../constructors/updateNewEncryptedMessage.md | 39 + .../constructors/updateNewMessage.md | 40 + .../constructors/updateNewScheduledMessage.md | 38 + .../constructors/updateNewStickerSet.md | 38 + .../constructors/updateNotifySettings.md | 39 + .../constructors/updatePeerLocated.md | 38 + .../constructors/updatePeerSettings.md | 39 + .../constructors/updatePhoneCall.md | 38 + .../constructors/updatePinnedDialogs.md | 39 + .../constructors/updatePrivacy.md | 39 + .../constructors/updatePtsChanged.md | 33 + .../constructors/updateReadChannelInbox.md | 42 + .../constructors/updateReadChannelOutbox.md | 39 + .../updateReadFeaturedStickers.md | 33 + .../constructors/updateReadHistoryInbox.md | 43 + .../constructors/updateReadHistoryOutbox.md | 41 + .../updateReadMessagesContents.md | 40 + .../constructors/updateRecentStickers.md | 33 + .../constructors/updateSavedGifs.md | 33 + .../constructors/updateServiceNotification.md | 47 + .../API_docs_v109/constructors/updateShort.md | 39 + .../constructors/updateShortChatMessage.md | 52 + .../constructors/updateShortMessage.md | 51 + .../constructors/updateShortSentMessage.md | 44 + .../constructors/updateStickerSets.md | 33 + .../constructors/updateStickerSetsOrder.md | 39 + .../API_docs_v109/constructors/updateTheme.md | 38 + .../constructors/updateUserBlocked.md | 39 + .../constructors/updateUserName.md | 41 + .../constructors/updateUserPhone.md | 39 + .../constructors/updateUserPhoto.md | 41 + .../constructors/updateUserPinnedMessage.md | 39 + .../constructors/updateUserStatus.md | 39 + .../constructors/updateUserTyping.md | 39 + .../constructors/updateWebPage.md | 40 + .../constructors/updates.channelDifference.md | 45 + .../updates.channelDifferenceEmpty.md | 41 + .../updates.channelDifferenceTooLong.md | 54 + .../constructors/updates.difference.md | 44 + .../constructors/updates.differenceEmpty.md | 40 + .../constructors/updates.differenceSlice.md | 44 + .../constructors/updates.differenceTooLong.md | 39 + .../API_docs_v109/constructors/updates.md | 42 + .../constructors/updates.state.md | 43 + .../constructors/updatesCombined.md | 43 + .../constructors/updatesTooLong.md | 33 + .../constructors/upload.cdnFile.md | 39 + .../upload.cdnFileReuploadNeeded.md | 39 + .../API_docs_v109/constructors/upload.file.md | 41 + .../constructors/upload.fileCdnRedirect.md | 43 + .../constructors/upload.webFile.md | 43 + .../constructors/urlAuthResultAccepted.md | 38 + .../constructors/urlAuthResultDefault.md | 33 + .../constructors/urlAuthResultRequest.md | 40 + old_docs/API_docs_v109/constructors/user.md | 62 + .../API_docs_v109/constructors/userEmpty.md | 38 + .../API_docs_v109/constructors/userFull.md | 51 + .../constructors/userProfilePhoto.md | 41 + .../constructors/userProfilePhotoEmpty.md | 33 + .../constructors/userStatusEmpty.md | 33 + .../constructors/userStatusLastMonth.md | 33 + .../constructors/userStatusLastWeek.md | 33 + .../constructors/userStatusOffline.md | 38 + .../constructors/userStatusOnline.md | 38 + .../constructors/userStatusRecently.md | 33 + .../API_docs_v109/constructors/wallPaper.md | 46 + .../constructors/wallPaperNoFile.md | 38 + .../constructors/wallPaperSettings.md | 43 + .../constructors/webAuthorization.md | 46 + .../API_docs_v109/constructors/webDocument.md | 42 + .../constructors/webDocumentNoProxy.md | 41 + .../API_docs_v109/constructors/webPage.md | 55 + .../constructors/webPageAttributeTheme.md | 37 + .../constructors/webPageEmpty.md | 38 + .../constructors/webPageNotModified.md | 33 + .../constructors/webPagePending.md | 39 + old_docs/API_docs_v109/methods/README.md | 668 +++++ .../methods/account.acceptAuthorization.md | 49 + .../methods/account.cancelPasswordEmail.md | 40 + .../methods/account.changePhone.md | 55 + .../methods/account.checkUsername.md | 53 + .../methods/account.confirmPasswordEmail.md | 53 + .../methods/account.confirmPhone.md | 54 + .../methods/account.createTheme.md | 48 + .../methods/account.deleteAccount.md | 45 + .../methods/account.deleteSecureValue.md | 45 + .../methods/account.finishTakeoutSession.md | 52 + .../methods/account.getAccountTTL.md | 40 + .../methods/account.getAllSecureValues.md | 40 + .../methods/account.getAuthorizationForm.md | 47 + .../methods/account.getAuthorizations.md | 47 + .../account.getAutoDownloadSettings.md | 40 + .../account.getContactSignUpNotification.md | 40 + .../methods/account.getContentSettings.md | 38 + .../methods/account.getMultiWallPapers.md | 43 + .../methods/account.getNotifyExceptions.md | 46 + .../methods/account.getNotifySettings.md | 52 + .../methods/account.getPassword.md | 40 + .../methods/account.getPasswordSettings.md | 52 + .../methods/account.getPrivacy.md | 52 + .../methods/account.getSecureValue.md | 45 + .../API_docs_v109/methods/account.getTheme.md | 47 + .../methods/account.getThemes.md | 46 + .../methods/account.getTmpPassword.md | 54 + .../methods/account.getWallPaper.md | 45 + .../methods/account.getWallPapers.md | 45 + .../methods/account.getWebAuthorizations.md | 40 + .../methods/account.initTakeoutSession.md | 58 + .../methods/account.installTheme.md | 47 + .../methods/account.installWallPaper.md | 46 + .../methods/account.registerDevice.md | 57 + .../methods/account.reportPeer.md | 53 + .../methods/account.resendPasswordEmail.md | 40 + .../methods/account.resetAuthorization.md | 53 + .../methods/account.resetNotifySettings.md | 40 + .../methods/account.resetWallPapers.md | 40 + .../methods/account.resetWebAuthorization.md | 45 + .../methods/account.resetWebAuthorizations.md | 40 + .../account.saveAutoDownloadSettings.md | 47 + .../methods/account.saveSecureValue.md | 46 + .../methods/account.saveTheme.md | 46 + .../methods/account.saveWallPaper.md | 47 + .../methods/account.sendChangePhoneCode.md | 53 + .../methods/account.sendConfirmPhoneCode.md | 53 + .../methods/account.sendVerifyEmailCode.md | 45 + .../methods/account.sendVerifyPhoneCode.md | 46 + .../methods/account.setAccountTTL.md | 52 + .../account.setContactSignUpNotification.md | 45 + .../methods/account.setContentSettings.md | 43 + .../methods/account.setPrivacy.md | 53 + .../methods/account.unregisterDevice.md | 54 + .../methods/account.updateDeviceLocked.md | 45 + .../methods/account.updateNotifySettings.md | 55 + .../methods/account.updatePasswordSettings.md | 58 + .../methods/account.updateProfile.md | 57 + .../methods/account.updateStatus.md | 54 + .../methods/account.updateTheme.md | 50 + .../methods/account.updateUsername.md | 56 + .../methods/account.uploadTheme.md | 55 + .../methods/account.uploadWallPaper.md | 47 + .../methods/account.verifyEmail.md | 53 + .../methods/account.verifyPhone.md | 54 + old_docs/API_docs_v109/methods/api_README.md | 1340 +++++++++ .../methods/auth.acceptLoginToken.md | 43 + .../methods/auth.bindTempAuthKey.md | 58 + .../API_docs_v109/methods/auth.cancelCode.md | 54 + .../methods/auth.checkPassword.md | 54 + .../methods/auth.dropTempAuthKeys.md | 45 + .../methods/auth.exportAuthorization.md | 52 + .../methods/auth.exportLoginToken.md | 45 + .../methods/auth.importAuthorization.md | 54 + .../methods/auth.importBotAuthorization.md | 57 + .../methods/auth.importLoginToken.md | 43 + old_docs/API_docs_v109/methods/auth.logOut.md | 40 + .../methods/auth.recoverPassword.md | 52 + .../methods/auth.requestPasswordRecovery.md | 47 + .../API_docs_v109/methods/auth.resendCode.md | 55 + .../methods/auth.resetAuthorizations.md | 52 + .../API_docs_v109/methods/auth.sendCode.md | 65 + old_docs/API_docs_v109/methods/auth.signIn.md | 59 + old_docs/API_docs_v109/methods/auth.signUp.md | 61 + .../methods/bots.answerWebhookJSONQuery.md | 54 + .../methods/bots.sendCustomRequest.md | 53 + .../methods/channels.checkUsername.md | 55 + .../methods/channels.createChannel.md | 61 + .../methods/channels.deleteChannel.md | 55 + .../methods/channels.deleteHistory.md | 53 + .../methods/channels.deleteMessages.md | 56 + .../methods/channels.deleteUserHistory.md | 58 + .../methods/channels.editAdmin.md | 68 + .../methods/channels.editBanned.md | 61 + .../methods/channels.editCreator.md | 57 + .../methods/channels.editLocation.md | 47 + .../methods/channels.editPhoto.md | 59 + .../methods/channels.editTitle.md | 57 + .../methods/channels.exportMessageLink.md | 56 + .../methods/channels.getAdminLog.md | 61 + .../channels.getAdminedPublicChannels.md | 46 + .../methods/channels.getChannels.md | 56 + .../methods/channels.getFullChannel.md | 57 + .../channels.getGroupsForDiscussion.md | 40 + .../methods/channels.getInactiveChannels.md | 38 + .../methods/channels.getLeftChannels.md | 52 + .../methods/channels.getMessages.md | 57 + .../methods/channels.getParticipant.md | 58 + .../methods/channels.getParticipants.md | 61 + .../methods/channels.inviteToChannel.md | 71 + .../methods/channels.joinChannel.md | 64 + .../methods/channels.leaveChannel.md | 57 + .../methods/channels.readHistory.md | 56 + .../methods/channels.readMessageContents.md | 54 + .../methods/channels.reportSpam.md | 57 + .../methods/channels.setDiscussionGroup.md | 55 + .../methods/channels.setStickers.md | 54 + .../channels.togglePreHistoryHidden.md | 53 + .../methods/channels.toggleSignatures.md | 54 + .../methods/channels.toggleSlowMode.md | 56 + .../methods/channels.updateUsername.md | 60 + .../methods/contacts.acceptContact.md | 52 + .../methods/contacts.addContact.md | 57 + .../API_docs_v109/methods/contacts.block.md | 53 + .../methods/contacts.deleteByPhones.md | 45 + .../methods/contacts.deleteContacts.md | 52 + .../methods/contacts.getBlocked.md | 46 + .../methods/contacts.getContactIDs.md | 45 + .../methods/contacts.getContacts.md | 45 + .../methods/contacts.getLocated.md | 45 + .../methods/contacts.getSaved.md | 47 + .../methods/contacts.getStatuses.md | 47 + .../methods/contacts.getTopPeers.md | 62 + .../methods/contacts.importContacts.md | 45 + .../methods/contacts.resetSaved.md | 40 + .../methods/contacts.resetTopPeerRating.md | 53 + .../methods/contacts.resolveUsername.md | 56 + .../API_docs_v109/methods/contacts.search.md | 55 + .../methods/contacts.toggleTopPeers.md | 45 + .../API_docs_v109/methods/contacts.unblock.md | 52 + .../methods/folders.deleteFolder.md | 45 + .../methods/folders.editPeerFolders.md | 52 + .../methods/help.acceptTermsOfService.md | 45 + .../methods/help.editUserInfo.md | 90 + .../methods/help.getAppChangelog.md | 45 + .../methods/help.getAppConfig.md | 40 + .../methods/help.getAppUpdate.md | 45 + .../methods/help.getCdnConfig.md | 50 + .../API_docs_v109/methods/help.getConfig.md | 52 + .../methods/help.getDeepLinkInfo.md | 45 + .../methods/help.getInviteText.md | 40 + .../methods/help.getNearestDc.md | 47 + .../methods/help.getPassportConfig.md | 45 + .../methods/help.getProxyData.md | 40 + .../methods/help.getRecentMeUrls.md | 45 + .../API_docs_v109/methods/help.getSupport.md | 40 + .../methods/help.getSupportName.md | 47 + .../methods/help.getTermsOfServiceUpdate.md | 47 + .../API_docs_v109/methods/help.getUserInfo.md | 52 + .../API_docs_v109/methods/help.saveAppLog.md | 45 + .../methods/help.setBotUpdatesStatus.md | 52 + .../API_docs_v109/methods/initConnection.md | 60 + .../API_docs_v109/methods/invokeAfterMsg.md | 45 + .../API_docs_v109/methods/invokeAfterMsgs.md | 45 + .../API_docs_v109/methods/invokeWithLayer.md | 63 + .../methods/invokeWithMessagesRange.md | 45 + .../methods/invokeWithTakeout.md | 45 + .../methods/invokeWithoutUpdates.md | 44 + .../methods/langpack.getDifference.md | 54 + .../methods/langpack.getLangPack.md | 53 + .../methods/langpack.getLanguage.md | 46 + .../methods/langpack.getLanguages.md | 52 + .../methods/langpack.getStrings.md | 54 + .../methods/messages.acceptEncryption.md | 56 + .../methods/messages.acceptUrlAuth.md | 48 + .../methods/messages.addChatUser.md | 62 + .../methods/messages.checkChatInvite.md | 55 + .../methods/messages.clearAllDrafts.md | 40 + .../methods/messages.clearRecentStickers.md | 45 + .../methods/messages.createChat.md | 57 + .../methods/messages.deleteChatUser.md | 56 + .../methods/messages.deleteHistory.md | 56 + .../methods/messages.deleteMessages.md | 53 + .../messages.deleteScheduledMessages.md | 46 + .../methods/messages.discardEncryption.md | 54 + .../methods/messages.editChatAbout.md | 58 + .../methods/messages.editChatAdmin.md | 55 + .../messages.editChatDefaultBannedRights.md | 56 + .../methods/messages.editChatPhoto.md | 58 + .../methods/messages.editChatTitle.md | 56 + .../methods/messages.editInlineBotMessage.md | 107 + .../methods/messages.editMessage.md | 127 + .../methods/messages.exportChatInvite.md | 56 + .../methods/messages.faveSticker.md | 53 + .../methods/messages.forwardMessages.md | 82 + .../methods/messages.getAllChats.md | 52 + .../methods/messages.getAllDrafts.md | 40 + .../methods/messages.getAllStickers.md | 45 + .../methods/messages.getArchivedStickers.md | 47 + .../methods/messages.getAttachedStickers.md | 45 + .../methods/messages.getBotCallbackAnswer.md | 61 + .../methods/messages.getChats.md | 53 + .../methods/messages.getCommonChats.md | 55 + .../methods/messages.getDhConfig.md | 53 + .../methods/messages.getDialogUnreadMarks.md | 40 + .../methods/messages.getDialogs.md | 62 + .../methods/messages.getDocumentByHash.md | 54 + .../methods/messages.getEmojiKeywords.md | 45 + .../messages.getEmojiKeywordsDifference.md | 46 + .../messages.getEmojiKeywordsLanguages.md | 45 + .../methods/messages.getEmojiURL.md | 45 + .../methods/messages.getFavedStickers.md | 45 + .../methods/messages.getFeaturedStickers.md | 45 + .../methods/messages.getFullChat.md | 53 + .../methods/messages.getGameHighScores.md | 56 + .../methods/messages.getHistory.md | 66 + .../methods/messages.getInlineBotResults.md | 59 + .../messages.getInlineGameHighScores.md | 54 + .../methods/messages.getMaskStickers.md | 45 + .../methods/messages.getMessageEditData.md | 55 + .../methods/messages.getMessages.md | 45 + .../methods/messages.getMessagesViews.md | 60 + .../methods/messages.getOnlines.md | 52 + .../methods/messages.getPeerDialogs.md | 55 + .../methods/messages.getPeerSettings.md | 53 + .../methods/messages.getPinnedDialogs.md | 52 + .../methods/messages.getPollResults.md | 53 + .../methods/messages.getPollVotes.md | 47 + .../methods/messages.getRecentLocations.md | 47 + .../methods/messages.getRecentStickers.md | 46 + .../methods/messages.getSavedGifs.md | 45 + .../methods/messages.getScheduledHistory.md | 53 + .../methods/messages.getScheduledMessages.md | 46 + .../methods/messages.getSearchCounters.md | 46 + .../methods/messages.getSplitRanges.md | 40 + .../methods/messages.getStatsURL.md | 54 + .../methods/messages.getStickerSet.md | 52 + .../methods/messages.getStickers.md | 46 + .../methods/messages.getUnreadMentions.md | 57 + .../methods/messages.getWebPage.md | 53 + .../methods/messages.getWebPagePreview.md | 96 + .../methods/messages.hidePeerSettingsBar.md | 45 + .../methods/messages.importChatInvite.md | 63 + .../methods/messages.installStickerSet.md | 53 + .../methods/messages.markDialogUnread.md | 46 + .../methods/messages.migrateChat.md | 54 + .../methods/messages.readEncryptedHistory.md | 53 + .../methods/messages.readFeaturedStickers.md | 45 + .../methods/messages.readHistory.md | 55 + .../methods/messages.readMentions.md | 55 + .../methods/messages.readMessageContents.md | 45 + .../methods/messages.receivedMessages.md | 45 + .../methods/messages.receivedQueue.md | 52 + .../methods/messages.reorderPinnedDialogs.md | 54 + .../methods/messages.reorderStickerSets.md | 46 + .../API_docs_v109/methods/messages.report.md | 47 + .../methods/messages.reportEncryptedSpam.md | 52 + .../methods/messages.reportSpam.md | 52 + .../methods/messages.requestEncryption.md | 54 + .../methods/messages.requestUrlAuth.md | 47 + .../methods/messages.saveDraft.md | 99 + .../API_docs_v109/methods/messages.saveGif.md | 53 + .../methods/messages.saveRecentSticker.md | 54 + .../API_docs_v109/methods/messages.search.md | 71 + .../methods/messages.searchGifs.md | 53 + .../methods/messages.searchGlobal.md | 57 + .../methods/messages.searchStickerSets.md | 47 + .../methods/messages.sendEncrypted.md | 56 + .../methods/messages.sendEncryptedFile.md | 56 + .../methods/messages.sendEncryptedService.md | 57 + .../methods/messages.sendInlineBotResult.md | 77 + .../methods/messages.sendMedia.md | 149 + .../methods/messages.sendMessage.md | 140 + .../methods/messages.sendMultiMedia.md | 62 + .../methods/messages.sendScheduledMessages.md | 53 + .../messages.sendScreenshotNotification.md | 53 + .../methods/messages.sendVote.md | 56 + .../methods/messages.setBotCallbackAnswer.md | 63 + .../messages.setBotPrecheckoutResults.md | 58 + .../methods/messages.setBotShippingResults.md | 54 + .../methods/messages.setEncryptedTyping.md | 53 + .../methods/messages.setGameScore.md | 59 + .../methods/messages.setInlineBotResults.md | 74 + .../methods/messages.setInlineGameScore.md | 57 + .../methods/messages.setTyping.md | 64 + .../methods/messages.startBot.md | 60 + .../methods/messages.toggleDialogPin.md | 53 + .../methods/messages.uninstallStickerSet.md | 52 + .../methods/messages.updatePinnedMessage.md | 57 + .../methods/messages.uploadEncryptedFile.md | 46 + .../methods/messages.uploadMedia.md | 60 + .../methods/payments.clearSavedInfo.md | 46 + .../methods/payments.getPaymentForm.md | 52 + .../methods/payments.getPaymentReceipt.md | 52 + .../methods/payments.getSavedInfo.md | 40 + .../methods/payments.sendPaymentForm.md | 55 + .../methods/payments.validateRequestedInfo.md | 54 + .../API_docs_v109/methods/phone.acceptCall.md | 57 + .../methods/phone.confirmCall.md | 56 + .../methods/phone.discardCall.md | 57 + .../methods/phone.getCallConfig.md | 47 + .../methods/phone.receivedCall.md | 53 + .../methods/phone.requestCall.md | 59 + .../methods/phone.saveCallDebug.md | 54 + .../methods/phone.setCallRating.md | 55 + .../methods/photos.deletePhotos.md | 45 + .../methods/photos.getUserPhotos.md | 56 + .../methods/photos.updateProfilePhoto.md | 56 + .../methods/photos.uploadProfilePhoto.md | 56 + .../methods/stickers.addStickerToSet.md | 54 + .../methods/stickers.changeStickerPosition.md | 54 + .../methods/stickers.createStickerSet.md | 64 + .../methods/stickers.removeStickerFromSet.md | 53 + .../methods/updates.getChannelDifference.md | 66 + .../methods/updates.getDifference.md | 62 + .../API_docs_v109/methods/updates.getState.md | 49 + .../methods/upload.getCdnFile.md | 47 + .../methods/upload.getCdnFileHashes.md | 54 + .../API_docs_v109/methods/upload.getFile.md | 65 + .../methods/upload.getFileHashes.md | 53 + .../methods/upload.getWebFile.md | 54 + .../methods/upload.reuploadCdnFile.md | 53 + .../methods/upload.saveBigFilePart.md | 61 + .../methods/upload.saveFilePart.md | 58 + .../methods/users.getFullUser.md | 55 + .../API_docs_v109/methods/users.getUsers.md | 57 + .../methods/users.setSecureValueErrors.md | 57 + old_docs/API_docs_v109/types/!X.md | 9 + .../API_docs_v109/types/AccountDaysTTL.md | 22 + old_docs/API_docs_v109/types/Authorization.md | 22 + .../types/AutoDownloadSettings.md | 20 + old_docs/API_docs_v109/types/BaseTheme.md | 28 + old_docs/API_docs_v109/types/Bool.md | 9 + old_docs/API_docs_v109/types/BotCommand.md | 20 + old_docs/API_docs_v109/types/BotInfo.md | 20 + .../API_docs_v109/types/BotInlineMessage.md | 28 + .../API_docs_v109/types/BotInlineResult.md | 22 + old_docs/API_docs_v109/types/CdnConfig.md | 22 + old_docs/API_docs_v109/types/CdnPublicKey.md | 20 + .../types/ChannelAdminLogEvent.md | 20 + .../types/ChannelAdminLogEventAction.md | 60 + .../types/ChannelAdminLogEventsFilter.md | 20 + .../API_docs_v109/types/ChannelLocation.md | 22 + .../types/ChannelMessagesFilter.md | 22 + .../API_docs_v109/types/ChannelParticipant.md | 28 + .../types/ChannelParticipantsFilter.md | 32 + old_docs/API_docs_v109/types/Chat.md | 52 + .../API_docs_v109/types/ChatAdminRights.md | 20 + .../API_docs_v109/types/ChatBannedRights.md | 20 + old_docs/API_docs_v109/types/ChatFull.md | 22 + old_docs/API_docs_v109/types/ChatInvite.md | 24 + old_docs/API_docs_v109/types/ChatOnlines.md | 22 + .../API_docs_v109/types/ChatParticipant.md | 24 + .../API_docs_v109/types/ChatParticipants.md | 22 + old_docs/API_docs_v109/types/ChatPhoto.md | 22 + old_docs/API_docs_v109/types/CodeSettings.md | 20 + old_docs/API_docs_v109/types/Config.md | 22 + old_docs/API_docs_v109/types/Contact.md | 20 + .../API_docs_v109/types/ContactBlocked.md | 20 + old_docs/API_docs_v109/types/ContactStatus.md | 22 + old_docs/API_docs_v109/types/DataJSON.md | 9 + old_docs/API_docs_v109/types/DcOption.md | 20 + .../API_docs_v109/types/Dialog.md | 10 +- old_docs/API_docs_v109/types/DialogPeer.md | 48 + old_docs/API_docs_v109/types/Document.md | 26 + .../API_docs_v109/types/DocumentAttribute.md | 32 + old_docs/API_docs_v109/types/DraftMessage.md | 22 + old_docs/API_docs_v109/types/EmojiKeyword.md | 22 + .../types/EmojiKeywordsDifference.md | 24 + old_docs/API_docs_v109/types/EmojiLanguage.md | 22 + old_docs/API_docs_v109/types/EmojiURL.md | 22 + old_docs/API_docs_v109/types/EncryptedChat.md | 32 + old_docs/API_docs_v109/types/EncryptedFile.md | 24 + .../API_docs_v109/types/EncryptedMessage.md | 22 + old_docs/API_docs_v109/types/Error.md | 20 + .../API_docs_v109/types/ExportedChatInvite.md | 24 + .../types/ExportedMessageLink.md | 22 + old_docs/API_docs_v109/types/FileHash.md | 26 + old_docs/API_docs_v109/types/FileLocation.md | 20 + old_docs/API_docs_v109/types/Folder.md | 20 + old_docs/API_docs_v109/types/FolderPeer.md | 20 + old_docs/API_docs_v109/types/FoundGif.md | 22 + old_docs/API_docs_v109/types/Game.md | 20 + old_docs/API_docs_v109/types/GeoPoint.md | 22 + old_docs/API_docs_v109/types/HighScore.md | 20 + .../API_docs_v109/types/ImportedContact.md | 20 + .../API_docs_v109/types/InlineBotSwitchPM.md | 20 + old_docs/API_docs_v109/types/InputAppEvent.md | 20 + .../types/InputBotInlineMessage.md | 30 + .../types/InputBotInlineMessageID.md | 20 + .../types/InputBotInlineResult.md | 26 + old_docs/API_docs_v109/types/InputChannel.md | 48 + .../API_docs_v109/types/InputChatPhoto.md | 24 + .../types/InputCheckPasswordSRP.md | 22 + .../API_docs_v109/types/InputClientProxy.md | 20 + old_docs/API_docs_v109/types/InputContact.md | 20 + .../API_docs_v109/types/InputDialogPeer.md | 46 + old_docs/API_docs_v109/types/InputDocument.md | 24 + .../API_docs_v109/types/InputEncryptedChat.md | 29 + .../API_docs_v109/types/InputEncryptedFile.md | 33 + old_docs/API_docs_v109/types/InputFile.md | 29 + .../API_docs_v109/types/InputFileLocation.md | 36 + .../API_docs_v109/types/InputFolderPeer.md | 20 + old_docs/API_docs_v109/types/InputGame.md | 22 + old_docs/API_docs_v109/types/InputGeoPoint.md | 22 + old_docs/API_docs_v109/types/InputMedia.md | 50 + old_docs/API_docs_v109/types/InputMessage.md | 31 + .../API_docs_v109/types/InputNotifyPeer.md | 50 + .../types/InputPaymentCredentials.md | 26 + old_docs/API_docs_v109/types/InputPeer.md | 56 + .../types/InputPeerNotifySettings.md | 20 + .../API_docs_v109/types/InputPhoneCall.md | 20 + old_docs/API_docs_v109/types/InputPhoto.md | 24 + .../API_docs_v109/types/InputPrivacyKey.md | 34 + .../API_docs_v109/types/InputPrivacyRule.md | 34 + .../API_docs_v109/types/InputSecureFile.md | 22 + .../API_docs_v109/types/InputSecureValue.md | 20 + .../API_docs_v109/types/InputSingleMedia.md | 20 + .../API_docs_v109/types/InputStickerSet.md | 26 + .../types/InputStickerSetItem.md | 20 + .../types/InputStickeredMedia.md | 22 + old_docs/API_docs_v109/types/InputTheme.md | 22 + .../API_docs_v109/types/InputThemeSettings.md | 20 + old_docs/API_docs_v109/types/InputUser.md | 50 + .../API_docs_v109/types/InputWallPaper.md | 24 + .../API_docs_v109/types/InputWebDocument.md | 20 + .../types/InputWebFileLocation.md | 22 + old_docs/API_docs_v109/types/Invoice.md | 20 + .../API_docs_v109/types/JSONObjectValue.md | 20 + old_docs/API_docs_v109/types/JSONValue.md | 32 + .../API_docs_v109/types/KeyboardButton.md | 61 + .../API_docs_v109/types/KeyboardButtonRow.md | 20 + old_docs/API_docs_v109/types/LabeledPrice.md | 20 + .../API_docs_v109/types/LangPackDifference.md | 24 + .../API_docs_v109/types/LangPackLanguage.md | 24 + .../API_docs_v109/types/LangPackString.md | 26 + old_docs/API_docs_v109/types/MaskCoords.md | 20 + old_docs/API_docs_v109/types/Message.md | 24 + old_docs/API_docs_v109/types/MessageAction.md | 64 + old_docs/API_docs_v109/types/MessageEntity.md | 54 + .../API_docs_v109/types/MessageFwdHeader.md | 20 + old_docs/API_docs_v109/types/MessageMedia.md | 46 + old_docs/API_docs_v109/types/MessageRange.md | 22 + .../API_docs_v109/types/MessageUserVote.md | 24 + .../API_docs_v109/types/MessagesFilter.md | 50 + old_docs/API_docs_v109/types/NearestDc.md | 22 + old_docs/API_docs_v109/types/NotifyPeer.md | 50 + old_docs/API_docs_v109/types/Null.md | 20 + old_docs/API_docs_v109/types/Page.md | 20 + old_docs/API_docs_v109/types/PageBlock.md | 76 + old_docs/API_docs_v109/types/PageCaption.md | 20 + old_docs/API_docs_v109/types/PageListItem.md | 22 + .../types/PageListOrderedItem.md | 22 + .../API_docs_v109/types/PageRelatedArticle.md | 20 + old_docs/API_docs_v109/types/PageTableCell.md | 20 + old_docs/API_docs_v109/types/PageTableRow.md | 20 + .../API_docs_v109/types/PasswordKdfAlgo.md | 22 + old_docs/API_docs_v109/types/PaymentCharge.md | 20 + .../types/PaymentRequestedInfo.md | 20 + .../types/PaymentSavedCredentials.md | 20 + old_docs/API_docs_v109/types/Peer.md | 48 + old_docs/API_docs_v109/types/PeerLocated.md | 20 + .../API_docs_v109/types/PeerNotifySettings.md | 22 + old_docs/API_docs_v109/types/PeerSettings.md | 22 + old_docs/API_docs_v109/types/PhoneCall.md | 187 ++ .../types/PhoneCallDiscardReason.md | 26 + .../API_docs_v109/types/PhoneCallProtocol.md | 20 + .../API_docs_v109/types/PhoneConnection.md | 20 + old_docs/API_docs_v109/types/Photo.md | 22 + old_docs/API_docs_v109/types/PhotoSize.md | 26 + old_docs/API_docs_v109/types/Poll.md | 20 + old_docs/API_docs_v109/types/PollAnswer.md | 20 + .../API_docs_v109/types/PollAnswerVoters.md | 20 + old_docs/API_docs_v109/types/PollResults.md | 20 + .../API_docs_v109/types/PopularContact.md | 20 + old_docs/API_docs_v109/types/PostAddress.md | 20 + old_docs/API_docs_v109/types/PrivacyKey.md | 34 + old_docs/API_docs_v109/types/PrivacyRule.md | 34 + old_docs/API_docs_v109/types/README.md | 567 ++++ .../types/ReceivedNotifyMessage.md | 22 + old_docs/API_docs_v109/types/RecentMeUrl.md | 28 + old_docs/API_docs_v109/types/ReplyMarkup.md | 26 + old_docs/API_docs_v109/types/ReportReason.md | 32 + .../API_docs_v109/types/RestrictionReason.md | 20 + old_docs/API_docs_v109/types/RichText.md | 50 + old_docs/API_docs_v109/types/SavedContact.md | 22 + .../types/SecureCredentialsEncrypted.md | 20 + old_docs/API_docs_v109/types/SecureData.md | 20 + old_docs/API_docs_v109/types/SecureFile.md | 22 + .../types/SecurePasswordKdfAlgo.md | 24 + .../API_docs_v109/types/SecurePlainData.md | 22 + .../API_docs_v109/types/SecureRequiredType.md | 22 + .../types/SecureSecretSettings.md | 20 + old_docs/API_docs_v109/types/SecureValue.md | 26 + .../API_docs_v109/types/SecureValueError.md | 36 + .../API_docs_v109/types/SecureValueHash.md | 20 + .../API_docs_v109/types/SecureValueType.md | 44 + .../API_docs_v109/types/SendMessageAction.md | 44 + .../API_docs_v109/types/ShippingOption.md | 20 + old_docs/API_docs_v109/types/StatsURL.md | 22 + old_docs/API_docs_v109/types/StickerPack.md | 20 + old_docs/API_docs_v109/types/StickerSet.md | 20 + .../API_docs_v109/types/StickerSetCovered.md | 24 + old_docs/API_docs_v109/types/Theme.md | 26 + old_docs/API_docs_v109/types/ThemeSettings.md | 20 + old_docs/API_docs_v109/types/TopPeer.md | 20 + .../API_docs_v109/types/TopPeerCategory.md | 34 + .../types/TopPeerCategoryPeers.md | 20 + old_docs/API_docs_v109/types/True.md | 20 + old_docs/API_docs_v109/types/Update.md | 172 ++ old_docs/API_docs_v109/types/Updates.md | 124 + old_docs/API_docs_v109/types/UrlAuthResult.md | 28 + old_docs/API_docs_v109/types/User.md | 54 + old_docs/API_docs_v109/types/UserFull.md | 22 + .../API_docs_v109/types/UserProfilePhoto.md | 24 + old_docs/API_docs_v109/types/UserStatus.md | 30 + old_docs/API_docs_v109/types/WallPaper.md | 28 + .../API_docs_v109/types/WallPaperSettings.md | 20 + .../API_docs_v109/types/WebAuthorization.md | 20 + old_docs/API_docs_v109/types/WebDocument.md | 22 + old_docs/API_docs_v109/types/WebPage.md | 28 + .../API_docs_v109/types/WebPageAttribute.md | 20 + old_docs/API_docs_v109/types/X.md | 9 + .../types/account.AuthorizationForm.md | 23 + .../types/account.Authorizations.md | 23 + .../types/account.AutoDownloadSettings.md | 23 + .../types/account.ContentSettings.md | 23 + .../API_docs_v109/types/account.Password.md | 23 + .../types/account.PasswordInputSettings.md | 21 + .../types/account.PasswordSettings.md | 23 + .../types/account.PrivacyRules.md | 25 + .../types/account.SentEmailCode.md | 23 + .../API_docs_v109/types/account.Takeout.md | 23 + .../API_docs_v109/types/account.Themes.md | 25 + .../types/account.TmpPassword.md | 23 + .../API_docs_v109/types/account.WallPapers.md | 25 + .../types/account.WebAuthorizations.md | 23 + .../API_docs_v109/types/auth.Authorization.md | 35 + old_docs/API_docs_v109/types/auth.CodeType.md | 25 + .../types/auth.ExportedAuthorization.md | 23 + .../API_docs_v109/types/auth.LoginToken.md | 29 + .../types/auth.PasswordRecovery.md | 23 + old_docs/API_docs_v109/types/auth.SentCode.md | 31 + .../API_docs_v109/types/auth.SentCodeType.md | 27 + old_docs/API_docs_v109/types/bytes.md | 21 + .../types/channels.AdminLogResults.md | 23 + .../types/channels.ChannelParticipant.md | 23 + .../types/channels.ChannelParticipants.md | 25 + .../API_docs_v109/types/contacts.Blocked.md | 25 + .../API_docs_v109/types/contacts.Contacts.md | 25 + .../API_docs_v109/types/contacts.Found.md | 23 + .../types/contacts.ImportedContacts.md | 23 + .../types/contacts.ResolvedPeer.md | 23 + .../API_docs_v109/types/contacts.TopPeers.md | 27 + old_docs/API_docs_v109/types/double.md | 9 + .../API_docs_v109/types/help.AppUpdate.md | 25 + .../API_docs_v109/types/help.DeepLinkInfo.md | 25 + .../API_docs_v109/types/help.InviteText.md | 23 + .../types/help.PassportConfig.md | 25 + .../API_docs_v109/types/help.ProxyData.md | 25 + .../API_docs_v109/types/help.RecentMeUrls.md | 23 + old_docs/API_docs_v109/types/help.Support.md | 23 + .../API_docs_v109/types/help.SupportName.md | 23 + .../types/help.TermsOfService.md | 21 + .../types/help.TermsOfServiceUpdate.md | 25 + old_docs/API_docs_v109/types/help.UserInfo.md | 27 + old_docs/API_docs_v109/types/int.md | 9 + old_docs/API_docs_v109/types/int128.md | 9 + old_docs/API_docs_v109/types/int256.md | 9 + old_docs/API_docs_v109/types/int512.md | 9 + old_docs/API_docs_v109/types/int53.md | 9 + old_docs/API_docs_v109/types/long.md | 9 + .../types/messages.AffectedHistory.md | 27 + .../types/messages.AffectedMessages.md | 29 + .../types/messages.AllStickers.md | 27 + .../types/messages.ArchivedStickers.md | 23 + .../types/messages.BotCallbackAnswer.md | 23 + .../types/messages.BotResults.md | 23 + .../API_docs_v109/types/messages.ChatFull.md | 25 + .../API_docs_v109/types/messages.Chats.md | 37 + .../API_docs_v109/types/messages.DhConfig.md | 25 + .../API_docs_v109/types/messages.Dialogs.md | 27 + .../types/messages.FavedStickers.md | 25 + .../types/messages.FeaturedStickers.md | 25 + .../API_docs_v109/types/messages.FoundGifs.md | 23 + .../types/messages.FoundStickerSets.md | 25 + .../types/messages.HighScores.md | 25 + .../types/messages.InactiveChats.md | 23 + .../types/messages.MessageEditData.md | 23 + .../API_docs_v109/types/messages.Messages.md | 45 + .../types/messages.PeerDialogs.md | 25 + .../types/messages.RecentStickers.md | 25 + .../API_docs_v109/types/messages.SavedGifs.md | 25 + .../types/messages.SearchCounter.md | 23 + .../types/messages.SentEncryptedMessage.md | 29 + .../types/messages.StickerSet.md | 31 + .../types/messages.StickerSetInstallResult.md | 25 + .../API_docs_v109/types/messages.Stickers.md | 25 + .../API_docs_v109/types/messages.VotesList.md | 23 + .../types/payments.PaymentForm.md | 23 + .../types/payments.PaymentReceipt.md | 23 + .../types/payments.PaymentResult.md | 25 + .../API_docs_v109/types/payments.SavedInfo.md | 23 + .../types/payments.ValidatedRequestedInfo.md | 23 + .../API_docs_v109/types/phone.PhoneCall.md | 27 + old_docs/API_docs_v109/types/photos.Photo.md | 23 + old_docs/API_docs_v109/types/photos.Photos.md | 25 + .../API_docs_v109/types/storage.FileType.md | 39 + old_docs/API_docs_v109/types/string.md | 9 + .../types/updates.ChannelDifference.md | 27 + .../API_docs_v109/types/updates.Difference.md | 29 + old_docs/API_docs_v109/types/updates.State.md | 23 + .../API_docs_v109/types/upload.CdnFile.md | 25 + old_docs/API_docs_v109/types/upload.File.md | 25 + .../API_docs_v109/types/upload.WebFile.md | 23 + old_docs/README.md | 39 +- 1495 files changed, 62728 insertions(+), 256 deletions(-) delete mode 100644 docs/API_docs/constructors/accessPointRule.md create mode 100644 docs/API_docs/constructors/account.contentSettings.md create mode 100644 docs/API_docs/constructors/auth.loginToken.md create mode 100644 docs/API_docs/constructors/auth.loginTokenMigrateTo.md create mode 100644 docs/API_docs/constructors/auth.loginTokenSuccess.md create mode 100644 docs/API_docs/constructors/baseThemeArctic.md create mode 100644 docs/API_docs/constructors/baseThemeClassic.md create mode 100644 docs/API_docs/constructors/baseThemeDay.md create mode 100644 docs/API_docs/constructors/baseThemeNight.md create mode 100644 docs/API_docs/constructors/baseThemeTinted.md delete mode 100644 docs/API_docs/constructors/help.configSimple.md create mode 100644 docs/API_docs/constructors/inputPhotoLegacyFileLocation.md create mode 100644 docs/API_docs/constructors/inputThemeSettings.md create mode 100644 docs/API_docs/constructors/inputWallPaperNoFile.md delete mode 100644 docs/API_docs/constructors/ipPortSecret.md create mode 100644 docs/API_docs/constructors/keyboardButtonRequestPoll.md create mode 100644 docs/API_docs/constructors/messageUserVote.md create mode 100644 docs/API_docs/constructors/messageUserVoteInputOption.md create mode 100644 docs/API_docs/constructors/messageUserVoteMultiple.md create mode 100644 docs/API_docs/constructors/messages.inactiveChats.md create mode 100644 docs/API_docs/constructors/messages.votesList.md delete mode 100644 docs/API_docs/constructors/themeDocumentNotModified.md create mode 100644 docs/API_docs/constructors/themeSettings.md create mode 100644 docs/API_docs/constructors/updateGeoLiveViewed.md create mode 100644 docs/API_docs/constructors/updateLoginToken.md create mode 100644 docs/API_docs/constructors/updateMessagePollVote.md create mode 100644 docs/API_docs/constructors/wallPaperNoFile.md create mode 100644 docs/API_docs/constructors/webPageAttributeTheme.md create mode 100644 docs/API_docs/methods/account.getContentSettings.md create mode 100644 docs/API_docs/methods/account.getMultiWallPapers.md create mode 100644 docs/API_docs/methods/account.setContentSettings.md create mode 100644 docs/API_docs/methods/auth.acceptLoginToken.md create mode 100644 docs/API_docs/methods/auth.exportLoginToken.md create mode 100644 docs/API_docs/methods/auth.importLoginToken.md create mode 100644 docs/API_docs/methods/channels.getInactiveChannels.md create mode 100644 docs/API_docs/methods/messages.getPollVotes.md create mode 100644 docs/API_docs/types/BaseTheme.md create mode 100644 docs/API_docs/types/InputThemeSettings.md create mode 100644 docs/API_docs/types/MessageUserVote.md rename docs/API_docs/types/{AccessPointRule.md => ThemeSettings.md} (56%) create mode 100644 docs/API_docs/types/WebPageAttribute.md create mode 100644 docs/API_docs/types/account.ContentSettings.md create mode 100644 docs/API_docs/types/auth.LoginToken.md delete mode 100644 docs/API_docs/types/help.ConfigSimple.md create mode 100644 docs/API_docs/types/messages.InactiveChats.md create mode 100644 docs/API_docs/types/messages.VotesList.md create mode 100644 old_docs/API_docs_v109/README.md create mode 100644 old_docs/API_docs_v109/constructors/README.md create mode 100644 old_docs/API_docs_v109/constructors/account.authorizationForm.md create mode 100644 old_docs/API_docs_v109/constructors/account.authorizations.md create mode 100644 old_docs/API_docs_v109/constructors/account.autoDownloadSettings.md create mode 100644 old_docs/API_docs_v109/constructors/account.contentSettings.md create mode 100644 old_docs/API_docs_v109/constructors/account.password.md create mode 100644 old_docs/API_docs_v109/constructors/account.passwordInputSettings.md create mode 100644 old_docs/API_docs_v109/constructors/account.passwordSettings.md create mode 100644 old_docs/API_docs_v109/constructors/account.privacyRules.md create mode 100644 old_docs/API_docs_v109/constructors/account.sentEmailCode.md create mode 100644 old_docs/API_docs_v109/constructors/account.takeout.md create mode 100644 old_docs/API_docs_v109/constructors/account.themes.md create mode 100644 old_docs/API_docs_v109/constructors/account.themesNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/account.tmpPassword.md create mode 100644 old_docs/API_docs_v109/constructors/account.wallPapers.md create mode 100644 old_docs/API_docs_v109/constructors/account.wallPapersNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/account.webAuthorizations.md create mode 100644 old_docs/API_docs_v109/constructors/accountDaysTTL.md create mode 100644 old_docs/API_docs_v109/constructors/auth.authorization.md create mode 100644 old_docs/API_docs_v109/constructors/auth.authorizationSignUpRequired.md create mode 100644 old_docs/API_docs_v109/constructors/auth.codeTypeCall.md create mode 100644 old_docs/API_docs_v109/constructors/auth.codeTypeFlashCall.md create mode 100644 old_docs/API_docs_v109/constructors/auth.codeTypeSms.md create mode 100644 old_docs/API_docs_v109/constructors/auth.exportedAuthorization.md create mode 100644 old_docs/API_docs_v109/constructors/auth.loginToken.md create mode 100644 old_docs/API_docs_v109/constructors/auth.loginTokenMigrateTo.md create mode 100644 old_docs/API_docs_v109/constructors/auth.loginTokenSuccess.md create mode 100644 old_docs/API_docs_v109/constructors/auth.passwordRecovery.md create mode 100644 old_docs/API_docs_v109/constructors/auth.sentCode.md create mode 100644 old_docs/API_docs_v109/constructors/auth.sentCodeTypeApp.md create mode 100644 old_docs/API_docs_v109/constructors/auth.sentCodeTypeCall.md create mode 100644 old_docs/API_docs_v109/constructors/auth.sentCodeTypeFlashCall.md create mode 100644 old_docs/API_docs_v109/constructors/auth.sentCodeTypeSms.md create mode 100644 old_docs/API_docs_v109/constructors/authorization.md create mode 100644 old_docs/API_docs_v109/constructors/autoDownloadSettings.md create mode 100644 old_docs/API_docs_v109/constructors/baseThemeArctic.md create mode 100644 old_docs/API_docs_v109/constructors/baseThemeClassic.md create mode 100644 old_docs/API_docs_v109/constructors/baseThemeDay.md create mode 100644 old_docs/API_docs_v109/constructors/baseThemeNight.md create mode 100644 old_docs/API_docs_v109/constructors/baseThemeTinted.md create mode 100644 old_docs/API_docs_v109/constructors/boolFalse.md create mode 100644 old_docs/API_docs_v109/constructors/boolTrue.md create mode 100644 old_docs/API_docs_v109/constructors/botCommand.md create mode 100644 old_docs/API_docs_v109/constructors/botInfo.md create mode 100644 old_docs/API_docs_v109/constructors/botInlineMediaResult.md create mode 100644 old_docs/API_docs_v109/constructors/botInlineMessageMediaAuto.md create mode 100644 old_docs/API_docs_v109/constructors/botInlineMessageMediaContact.md create mode 100644 old_docs/API_docs_v109/constructors/botInlineMessageMediaGeo.md create mode 100644 old_docs/API_docs_v109/constructors/botInlineMessageMediaVenue.md create mode 100644 old_docs/API_docs_v109/constructors/botInlineMessageText.md create mode 100644 old_docs/API_docs_v109/constructors/botInlineResult.md create mode 100644 old_docs/API_docs_v109/constructors/cdnConfig.md create mode 100644 old_docs/API_docs_v109/constructors/cdnPublicKey.md create mode 100644 old_docs/API_docs_v109/constructors/channel.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEvent.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeAbout.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeLinkedChat.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeLocation.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangePhoto.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeStickerSet.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeTitle.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeUsername.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionDefaultBannedRights.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionDeleteMessage.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionEditMessage.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantInvite.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantJoin.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantLeave.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantToggleAdmin.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantToggleBan.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionStopPoll.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleInvites.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionTogglePreHistoryHidden.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleSignatures.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleSlowMode.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventActionUpdatePinned.md create mode 100644 old_docs/API_docs_v109/constructors/channelAdminLogEventsFilter.md create mode 100644 old_docs/API_docs_v109/constructors/channelForbidden.md create mode 100644 old_docs/API_docs_v109/constructors/channelFull.md create mode 100644 old_docs/API_docs_v109/constructors/channelLocation.md create mode 100644 old_docs/API_docs_v109/constructors/channelLocationEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/channelMessagesFilter.md create mode 100644 old_docs/API_docs_v109/constructors/channelMessagesFilterEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipant.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipantAdmin.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipantBanned.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipantCreator.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipantSelf.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipantsAdmins.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipantsBanned.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipantsBots.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipantsContacts.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipantsKicked.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipantsRecent.md create mode 100644 old_docs/API_docs_v109/constructors/channelParticipantsSearch.md create mode 100644 old_docs/API_docs_v109/constructors/channels.adminLogResults.md create mode 100644 old_docs/API_docs_v109/constructors/channels.channelParticipant.md create mode 100644 old_docs/API_docs_v109/constructors/channels.channelParticipants.md create mode 100644 old_docs/API_docs_v109/constructors/channels.channelParticipantsNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/chat.md create mode 100644 old_docs/API_docs_v109/constructors/chatAdminRights.md create mode 100644 old_docs/API_docs_v109/constructors/chatBannedRights.md create mode 100644 old_docs/API_docs_v109/constructors/chatEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/chatForbidden.md create mode 100644 old_docs/API_docs_v109/constructors/chatFull.md create mode 100644 old_docs/API_docs_v109/constructors/chatInvite.md create mode 100644 old_docs/API_docs_v109/constructors/chatInviteAlready.md create mode 100644 old_docs/API_docs_v109/constructors/chatInviteEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/chatInviteExported.md create mode 100644 old_docs/API_docs_v109/constructors/chatOnlines.md create mode 100644 old_docs/API_docs_v109/constructors/chatParticipant.md create mode 100644 old_docs/API_docs_v109/constructors/chatParticipantAdmin.md create mode 100644 old_docs/API_docs_v109/constructors/chatParticipantCreator.md create mode 100644 old_docs/API_docs_v109/constructors/chatParticipants.md create mode 100644 old_docs/API_docs_v109/constructors/chatParticipantsForbidden.md create mode 100644 old_docs/API_docs_v109/constructors/chatPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/chatPhotoEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/codeSettings.md create mode 100644 old_docs/API_docs_v109/constructors/config.md create mode 100644 old_docs/API_docs_v109/constructors/contact.md create mode 100644 old_docs/API_docs_v109/constructors/contactBlocked.md create mode 100644 old_docs/API_docs_v109/constructors/contactStatus.md create mode 100644 old_docs/API_docs_v109/constructors/contacts.blocked.md create mode 100644 old_docs/API_docs_v109/constructors/contacts.blockedSlice.md create mode 100644 old_docs/API_docs_v109/constructors/contacts.contacts.md create mode 100644 old_docs/API_docs_v109/constructors/contacts.contactsNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/contacts.found.md create mode 100644 old_docs/API_docs_v109/constructors/contacts.importedContacts.md create mode 100644 old_docs/API_docs_v109/constructors/contacts.resolvedPeer.md create mode 100644 old_docs/API_docs_v109/constructors/contacts.topPeers.md create mode 100644 old_docs/API_docs_v109/constructors/contacts.topPeersDisabled.md create mode 100644 old_docs/API_docs_v109/constructors/contacts.topPeersNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/dataJSON.md create mode 100644 old_docs/API_docs_v109/constructors/dcOption.md create mode 100644 old_docs/API_docs_v109/constructors/dialog.md create mode 100644 old_docs/API_docs_v109/constructors/dialogFolder.md rename docs/API_docs/constructors/ipPort.md => old_docs/API_docs_v109/constructors/dialogPeer.md (52%) create mode 100644 old_docs/API_docs_v109/constructors/dialogPeerFolder.md create mode 100644 old_docs/API_docs_v109/constructors/document.md create mode 100644 old_docs/API_docs_v109/constructors/documentAttributeAnimated.md create mode 100644 old_docs/API_docs_v109/constructors/documentAttributeAudio.md create mode 100644 old_docs/API_docs_v109/constructors/documentAttributeFilename.md create mode 100644 old_docs/API_docs_v109/constructors/documentAttributeHasStickers.md create mode 100644 old_docs/API_docs_v109/constructors/documentAttributeImageSize.md create mode 100644 old_docs/API_docs_v109/constructors/documentAttributeSticker.md create mode 100644 old_docs/API_docs_v109/constructors/documentAttributeVideo.md create mode 100644 old_docs/API_docs_v109/constructors/documentEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/draftMessage.md create mode 100644 old_docs/API_docs_v109/constructors/draftMessageEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/emojiKeyword.md create mode 100644 old_docs/API_docs_v109/constructors/emojiKeywordDeleted.md create mode 100644 old_docs/API_docs_v109/constructors/emojiKeywordsDifference.md create mode 100644 old_docs/API_docs_v109/constructors/emojiLanguage.md create mode 100644 old_docs/API_docs_v109/constructors/emojiURL.md create mode 100644 old_docs/API_docs_v109/constructors/encryptedChat.md create mode 100644 old_docs/API_docs_v109/constructors/encryptedChatDiscarded.md create mode 100644 old_docs/API_docs_v109/constructors/encryptedChatEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/encryptedChatRequested.md create mode 100644 old_docs/API_docs_v109/constructors/encryptedChatWaiting.md create mode 100644 old_docs/API_docs_v109/constructors/encryptedFile.md create mode 100644 old_docs/API_docs_v109/constructors/encryptedFileEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/encryptedMessage.md create mode 100644 old_docs/API_docs_v109/constructors/encryptedMessageService.md create mode 100644 old_docs/API_docs_v109/constructors/error.md create mode 100644 old_docs/API_docs_v109/constructors/exportedMessageLink.md create mode 100644 old_docs/API_docs_v109/constructors/fileHash.md create mode 100644 old_docs/API_docs_v109/constructors/fileLocationToBeDeprecated.md create mode 100644 old_docs/API_docs_v109/constructors/folder.md create mode 100644 old_docs/API_docs_v109/constructors/folderPeer.md create mode 100644 old_docs/API_docs_v109/constructors/foundGif.md create mode 100644 old_docs/API_docs_v109/constructors/foundGifCached.md create mode 100644 old_docs/API_docs_v109/constructors/game.md create mode 100644 old_docs/API_docs_v109/constructors/geoPoint.md create mode 100644 old_docs/API_docs_v109/constructors/geoPointEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/help.appUpdate.md create mode 100644 old_docs/API_docs_v109/constructors/help.deepLinkInfo.md create mode 100644 old_docs/API_docs_v109/constructors/help.deepLinkInfoEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/help.inviteText.md create mode 100644 old_docs/API_docs_v109/constructors/help.noAppUpdate.md create mode 100644 old_docs/API_docs_v109/constructors/help.passportConfig.md create mode 100644 old_docs/API_docs_v109/constructors/help.passportConfigNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/help.proxyDataEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/help.proxyDataPromo.md create mode 100644 old_docs/API_docs_v109/constructors/help.recentMeUrls.md create mode 100644 old_docs/API_docs_v109/constructors/help.support.md create mode 100644 old_docs/API_docs_v109/constructors/help.supportName.md create mode 100644 old_docs/API_docs_v109/constructors/help.termsOfService.md create mode 100644 old_docs/API_docs_v109/constructors/help.termsOfServiceUpdate.md create mode 100644 old_docs/API_docs_v109/constructors/help.termsOfServiceUpdateEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/help.userInfo.md create mode 100644 old_docs/API_docs_v109/constructors/help.userInfoEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/highScore.md create mode 100644 old_docs/API_docs_v109/constructors/importedContact.md create mode 100644 old_docs/API_docs_v109/constructors/inlineBotSwitchPM.md create mode 100644 old_docs/API_docs_v109/constructors/inputAppEvent.md create mode 100644 old_docs/API_docs_v109/constructors/inputBotInlineMessageGame.md create mode 100644 old_docs/API_docs_v109/constructors/inputBotInlineMessageID.md create mode 100644 old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaAuto.md create mode 100644 old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaContact.md create mode 100644 old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaGeo.md create mode 100644 old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaVenue.md create mode 100644 old_docs/API_docs_v109/constructors/inputBotInlineMessageText.md create mode 100644 old_docs/API_docs_v109/constructors/inputBotInlineResult.md create mode 100644 old_docs/API_docs_v109/constructors/inputBotInlineResultDocument.md create mode 100644 old_docs/API_docs_v109/constructors/inputBotInlineResultGame.md create mode 100644 old_docs/API_docs_v109/constructors/inputBotInlineResultPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/inputChannel.md create mode 100644 old_docs/API_docs_v109/constructors/inputChannelEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputChannelFromMessage.md create mode 100644 old_docs/API_docs_v109/constructors/inputChatPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/inputChatPhotoEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputChatUploadedPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/inputCheckPasswordEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputCheckPasswordSRP.md create mode 100644 old_docs/API_docs_v109/constructors/inputClientProxy.md create mode 100644 old_docs/API_docs_v109/constructors/inputDialogPeer.md create mode 100644 old_docs/API_docs_v109/constructors/inputDialogPeerFolder.md create mode 100644 old_docs/API_docs_v109/constructors/inputDocument.md create mode 100644 old_docs/API_docs_v109/constructors/inputDocumentEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputDocumentFileLocation.md create mode 100644 old_docs/API_docs_v109/constructors/inputEncryptedChat.md create mode 100644 old_docs/API_docs_v109/constructors/inputEncryptedFile.md create mode 100644 old_docs/API_docs_v109/constructors/inputEncryptedFileBigUploaded.md create mode 100644 old_docs/API_docs_v109/constructors/inputEncryptedFileEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputEncryptedFileLocation.md create mode 100644 old_docs/API_docs_v109/constructors/inputEncryptedFileUploaded.md create mode 100644 old_docs/API_docs_v109/constructors/inputFile.md create mode 100644 old_docs/API_docs_v109/constructors/inputFileBig.md create mode 100644 old_docs/API_docs_v109/constructors/inputFileLocation.md create mode 100644 old_docs/API_docs_v109/constructors/inputFolderPeer.md create mode 100644 old_docs/API_docs_v109/constructors/inputGameID.md create mode 100644 old_docs/API_docs_v109/constructors/inputGameShortName.md create mode 100644 old_docs/API_docs_v109/constructors/inputGeoPoint.md create mode 100644 old_docs/API_docs_v109/constructors/inputGeoPointEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputKeyboardButtonUrlAuth.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaContact.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaDocument.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaDocumentExternal.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaGame.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaGeoLive.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaGeoPoint.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaGifExternal.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaInvoice.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaPhotoExternal.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaPoll.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaUploadedDocument.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaUploadedPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/inputMediaVenue.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessageEntityMentionName.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessageID.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagePinned.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessageReplyTo.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterChatPhotos.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterContacts.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterDocument.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterGeo.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterGif.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterMusic.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterMyMentions.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterPhoneCalls.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterPhotoVideo.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterPhotos.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterRoundVideo.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterRoundVoice.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterUrl.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterVideo.md create mode 100644 old_docs/API_docs_v109/constructors/inputMessagesFilterVoice.md create mode 100644 old_docs/API_docs_v109/constructors/inputNotifyBroadcasts.md create mode 100644 old_docs/API_docs_v109/constructors/inputNotifyChats.md create mode 100644 old_docs/API_docs_v109/constructors/inputNotifyPeer.md create mode 100644 old_docs/API_docs_v109/constructors/inputNotifyUsers.md create mode 100644 old_docs/API_docs_v109/constructors/inputPaymentCredentials.md create mode 100644 old_docs/API_docs_v109/constructors/inputPaymentCredentialsAndroidPay.md create mode 100644 old_docs/API_docs_v109/constructors/inputPaymentCredentialsApplePay.md create mode 100644 old_docs/API_docs_v109/constructors/inputPaymentCredentialsSaved.md create mode 100644 old_docs/API_docs_v109/constructors/inputPeerChannel.md create mode 100644 old_docs/API_docs_v109/constructors/inputPeerChannelFromMessage.md create mode 100644 old_docs/API_docs_v109/constructors/inputPeerChat.md create mode 100644 old_docs/API_docs_v109/constructors/inputPeerEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputPeerNotifySettings.md create mode 100644 old_docs/API_docs_v109/constructors/inputPeerPhotoFileLocation.md create mode 100644 old_docs/API_docs_v109/constructors/inputPeerSelf.md create mode 100644 old_docs/API_docs_v109/constructors/inputPeerUser.md create mode 100644 old_docs/API_docs_v109/constructors/inputPeerUserFromMessage.md create mode 100644 old_docs/API_docs_v109/constructors/inputPhoneCall.md create mode 100644 old_docs/API_docs_v109/constructors/inputPhoneContact.md create mode 100644 old_docs/API_docs_v109/constructors/inputPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/inputPhotoEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputPhotoFileLocation.md create mode 100644 old_docs/API_docs_v109/constructors/inputPhotoLegacyFileLocation.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyKeyAddedByPhone.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyKeyChatInvite.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyKeyForwards.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneCall.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneNumber.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneP2P.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyKeyProfilePhoto.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyKeyStatusTimestamp.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyValueAllowAll.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyValueAllowChatParticipants.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyValueAllowContacts.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyValueAllowUsers.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowAll.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowChatParticipants.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowContacts.md create mode 100644 old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowUsers.md create mode 100644 old_docs/API_docs_v109/constructors/inputReportReasonChildAbuse.md create mode 100644 old_docs/API_docs_v109/constructors/inputReportReasonCopyright.md create mode 100644 old_docs/API_docs_v109/constructors/inputReportReasonGeoIrrelevant.md create mode 100644 old_docs/API_docs_v109/constructors/inputReportReasonOther.md create mode 100644 old_docs/API_docs_v109/constructors/inputReportReasonPornography.md create mode 100644 old_docs/API_docs_v109/constructors/inputReportReasonSpam.md create mode 100644 old_docs/API_docs_v109/constructors/inputReportReasonViolence.md create mode 100644 old_docs/API_docs_v109/constructors/inputSecureFile.md create mode 100644 old_docs/API_docs_v109/constructors/inputSecureFileLocation.md create mode 100644 old_docs/API_docs_v109/constructors/inputSecureFileUploaded.md create mode 100644 old_docs/API_docs_v109/constructors/inputSecureValue.md create mode 100644 old_docs/API_docs_v109/constructors/inputSingleMedia.md create mode 100644 old_docs/API_docs_v109/constructors/inputStickerSetAnimatedEmoji.md create mode 100644 old_docs/API_docs_v109/constructors/inputStickerSetEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputStickerSetID.md create mode 100644 old_docs/API_docs_v109/constructors/inputStickerSetItem.md create mode 100644 old_docs/API_docs_v109/constructors/inputStickerSetShortName.md create mode 100644 old_docs/API_docs_v109/constructors/inputStickerSetThumb.md create mode 100644 old_docs/API_docs_v109/constructors/inputStickeredMediaDocument.md create mode 100644 old_docs/API_docs_v109/constructors/inputStickeredMediaPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/inputTakeoutFileLocation.md create mode 100644 old_docs/API_docs_v109/constructors/inputTheme.md create mode 100644 old_docs/API_docs_v109/constructors/inputThemeSettings.md create mode 100644 old_docs/API_docs_v109/constructors/inputThemeSlug.md create mode 100644 old_docs/API_docs_v109/constructors/inputUser.md create mode 100644 old_docs/API_docs_v109/constructors/inputUserEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/inputUserFromMessage.md create mode 100644 old_docs/API_docs_v109/constructors/inputUserSelf.md create mode 100644 old_docs/API_docs_v109/constructors/inputWallPaper.md create mode 100644 old_docs/API_docs_v109/constructors/inputWallPaperNoFile.md create mode 100644 old_docs/API_docs_v109/constructors/inputWallPaperSlug.md create mode 100644 old_docs/API_docs_v109/constructors/inputWebDocument.md create mode 100644 old_docs/API_docs_v109/constructors/inputWebFileGeoPointLocation.md create mode 100644 old_docs/API_docs_v109/constructors/inputWebFileLocation.md create mode 100644 old_docs/API_docs_v109/constructors/invoice.md create mode 100644 old_docs/API_docs_v109/constructors/jsonArray.md create mode 100644 old_docs/API_docs_v109/constructors/jsonBool.md create mode 100644 old_docs/API_docs_v109/constructors/jsonNull.md create mode 100644 old_docs/API_docs_v109/constructors/jsonNumber.md create mode 100644 old_docs/API_docs_v109/constructors/jsonObject.md create mode 100644 old_docs/API_docs_v109/constructors/jsonObjectValue.md create mode 100644 old_docs/API_docs_v109/constructors/jsonString.md create mode 100644 old_docs/API_docs_v109/constructors/keyboardButton.md create mode 100644 old_docs/API_docs_v109/constructors/keyboardButtonBuy.md create mode 100644 old_docs/API_docs_v109/constructors/keyboardButtonCallback.md create mode 100644 old_docs/API_docs_v109/constructors/keyboardButtonGame.md create mode 100644 old_docs/API_docs_v109/constructors/keyboardButtonRequestGeoLocation.md create mode 100644 old_docs/API_docs_v109/constructors/keyboardButtonRequestPhone.md create mode 100644 old_docs/API_docs_v109/constructors/keyboardButtonRequestPoll.md create mode 100644 old_docs/API_docs_v109/constructors/keyboardButtonRow.md create mode 100644 old_docs/API_docs_v109/constructors/keyboardButtonSwitchInline.md create mode 100644 old_docs/API_docs_v109/constructors/keyboardButtonUrl.md create mode 100644 old_docs/API_docs_v109/constructors/keyboardButtonUrlAuth.md create mode 100644 old_docs/API_docs_v109/constructors/labeledPrice.md create mode 100644 old_docs/API_docs_v109/constructors/langPackDifference.md create mode 100644 old_docs/API_docs_v109/constructors/langPackLanguage.md create mode 100644 old_docs/API_docs_v109/constructors/langPackString.md create mode 100644 old_docs/API_docs_v109/constructors/langPackStringDeleted.md create mode 100644 old_docs/API_docs_v109/constructors/langPackStringPluralized.md create mode 100644 old_docs/API_docs_v109/constructors/maskCoords.md create mode 100644 old_docs/API_docs_v109/constructors/message.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionBotAllowed.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionChannelCreate.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionChannelMigrateFrom.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionChatAddUser.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionChatCreate.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionChatDeletePhoto.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionChatDeleteUser.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionChatEditPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionChatEditTitle.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionChatJoinedByLink.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionChatMigrateTo.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionContactSignUp.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionCustomAction.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionGameScore.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionHistoryClear.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionPaymentSent.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionPaymentSentMe.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionPhoneCall.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionPinMessage.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionScreenshotTaken.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionSecureValuesSent.md create mode 100644 old_docs/API_docs_v109/constructors/messageActionSecureValuesSentMe.md create mode 100644 old_docs/API_docs_v109/constructors/messageEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityBlockquote.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityBold.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityBotCommand.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityCashtag.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityCode.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityEmail.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityHashtag.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityItalic.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityMention.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityMentionName.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityPhone.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityPre.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityStrike.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityTextUrl.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityUnderline.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityUnknown.md create mode 100644 old_docs/API_docs_v109/constructors/messageEntityUrl.md create mode 100644 old_docs/API_docs_v109/constructors/messageFwdHeader.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaContact.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaDocument.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaGame.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaGeo.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaGeoLive.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaInvoice.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaPoll.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaUnsupported.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaVenue.md create mode 100644 old_docs/API_docs_v109/constructors/messageMediaWebPage.md create mode 100644 old_docs/API_docs_v109/constructors/messageRange.md create mode 100644 old_docs/API_docs_v109/constructors/messageService.md create mode 100644 old_docs/API_docs_v109/constructors/messageUserVote.md create mode 100644 old_docs/API_docs_v109/constructors/messageUserVoteInputOption.md create mode 100644 old_docs/API_docs_v109/constructors/messageUserVoteMultiple.md create mode 100644 old_docs/API_docs_v109/constructors/messages.affectedHistory.md create mode 100644 old_docs/API_docs_v109/constructors/messages.affectedMessages.md create mode 100644 old_docs/API_docs_v109/constructors/messages.allStickers.md create mode 100644 old_docs/API_docs_v109/constructors/messages.allStickersNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/messages.archivedStickers.md create mode 100644 old_docs/API_docs_v109/constructors/messages.botCallbackAnswer.md create mode 100644 old_docs/API_docs_v109/constructors/messages.botResults.md create mode 100644 old_docs/API_docs_v109/constructors/messages.channelMessages.md create mode 100644 old_docs/API_docs_v109/constructors/messages.chatFull.md create mode 100644 old_docs/API_docs_v109/constructors/messages.chats.md create mode 100644 old_docs/API_docs_v109/constructors/messages.chatsSlice.md create mode 100644 old_docs/API_docs_v109/constructors/messages.dhConfig.md create mode 100644 old_docs/API_docs_v109/constructors/messages.dhConfigNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/messages.dialogs.md create mode 100644 old_docs/API_docs_v109/constructors/messages.dialogsNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/messages.dialogsSlice.md create mode 100644 old_docs/API_docs_v109/constructors/messages.favedStickers.md create mode 100644 old_docs/API_docs_v109/constructors/messages.favedStickersNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/messages.featuredStickers.md create mode 100644 old_docs/API_docs_v109/constructors/messages.featuredStickersNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/messages.foundGifs.md create mode 100644 old_docs/API_docs_v109/constructors/messages.foundStickerSets.md create mode 100644 old_docs/API_docs_v109/constructors/messages.foundStickerSetsNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/messages.highScores.md create mode 100644 old_docs/API_docs_v109/constructors/messages.inactiveChats.md create mode 100644 old_docs/API_docs_v109/constructors/messages.messageEditData.md create mode 100644 old_docs/API_docs_v109/constructors/messages.messages.md create mode 100644 old_docs/API_docs_v109/constructors/messages.messagesNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/messages.messagesSlice.md create mode 100644 old_docs/API_docs_v109/constructors/messages.peerDialogs.md create mode 100644 old_docs/API_docs_v109/constructors/messages.recentStickers.md create mode 100644 old_docs/API_docs_v109/constructors/messages.recentStickersNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/messages.savedGifs.md create mode 100644 old_docs/API_docs_v109/constructors/messages.savedGifsNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/messages.searchCounter.md create mode 100644 old_docs/API_docs_v109/constructors/messages.sentEncryptedFile.md create mode 100644 old_docs/API_docs_v109/constructors/messages.sentEncryptedMessage.md create mode 100644 old_docs/API_docs_v109/constructors/messages.stickerSet.md create mode 100644 old_docs/API_docs_v109/constructors/messages.stickerSetInstallResultArchive.md create mode 100644 old_docs/API_docs_v109/constructors/messages.stickerSetInstallResultSuccess.md create mode 100644 old_docs/API_docs_v109/constructors/messages.stickers.md create mode 100644 old_docs/API_docs_v109/constructors/messages.stickersNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/messages.votesList.md create mode 100644 old_docs/API_docs_v109/constructors/nearestDc.md create mode 100644 old_docs/API_docs_v109/constructors/notifyBroadcasts.md create mode 100644 old_docs/API_docs_v109/constructors/notifyChats.md create mode 100644 old_docs/API_docs_v109/constructors/notifyPeer.md create mode 100644 old_docs/API_docs_v109/constructors/notifyUsers.md create mode 100644 old_docs/API_docs_v109/constructors/null.md create mode 100644 old_docs/API_docs_v109/constructors/page.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockAnchor.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockAudio.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockAuthorDate.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockBlockquote.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockChannel.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockCollage.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockCover.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockDetails.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockDivider.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockEmbed.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockEmbedPost.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockFooter.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockHeader.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockKicker.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockList.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockMap.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockOrderedList.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockParagraph.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockPreformatted.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockPullquote.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockRelatedArticles.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockSlideshow.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockSubheader.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockSubtitle.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockTable.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockTitle.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockUnsupported.md create mode 100644 old_docs/API_docs_v109/constructors/pageBlockVideo.md create mode 100644 old_docs/API_docs_v109/constructors/pageCaption.md create mode 100644 old_docs/API_docs_v109/constructors/pageListItemBlocks.md create mode 100644 old_docs/API_docs_v109/constructors/pageListItemText.md create mode 100644 old_docs/API_docs_v109/constructors/pageListOrderedItemBlocks.md create mode 100644 old_docs/API_docs_v109/constructors/pageListOrderedItemText.md create mode 100644 old_docs/API_docs_v109/constructors/pageRelatedArticle.md create mode 100644 old_docs/API_docs_v109/constructors/pageTableCell.md create mode 100644 old_docs/API_docs_v109/constructors/pageTableRow.md create mode 100644 old_docs/API_docs_v109/constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md create mode 100644 old_docs/API_docs_v109/constructors/passwordKdfAlgoUnknown.md create mode 100644 old_docs/API_docs_v109/constructors/paymentCharge.md create mode 100644 old_docs/API_docs_v109/constructors/paymentRequestedInfo.md create mode 100644 old_docs/API_docs_v109/constructors/paymentSavedCredentialsCard.md create mode 100644 old_docs/API_docs_v109/constructors/payments.paymentForm.md create mode 100644 old_docs/API_docs_v109/constructors/payments.paymentReceipt.md create mode 100644 old_docs/API_docs_v109/constructors/payments.paymentResult.md create mode 100644 old_docs/API_docs_v109/constructors/payments.paymentVerificationNeeded.md create mode 100644 old_docs/API_docs_v109/constructors/payments.savedInfo.md create mode 100644 old_docs/API_docs_v109/constructors/payments.validatedRequestedInfo.md create mode 100644 old_docs/API_docs_v109/constructors/peerChannel.md create mode 100644 old_docs/API_docs_v109/constructors/peerChat.md create mode 100644 old_docs/API_docs_v109/constructors/peerLocated.md create mode 100644 old_docs/API_docs_v109/constructors/peerNotifySettings.md create mode 100644 old_docs/API_docs_v109/constructors/peerSettings.md create mode 100644 old_docs/API_docs_v109/constructors/peerUser.md create mode 100644 old_docs/API_docs_v109/constructors/phone.phoneCall.md create mode 100644 old_docs/API_docs_v109/constructors/phoneCall.md create mode 100644 old_docs/API_docs_v109/constructors/phoneCallAccepted.md create mode 100644 old_docs/API_docs_v109/constructors/phoneCallDiscardReasonBusy.md create mode 100644 old_docs/API_docs_v109/constructors/phoneCallDiscardReasonDisconnect.md create mode 100644 old_docs/API_docs_v109/constructors/phoneCallDiscardReasonHangup.md create mode 100644 old_docs/API_docs_v109/constructors/phoneCallDiscardReasonMissed.md create mode 100644 old_docs/API_docs_v109/constructors/phoneCallDiscarded.md create mode 100644 old_docs/API_docs_v109/constructors/phoneCallEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/phoneCallProtocol.md create mode 100644 old_docs/API_docs_v109/constructors/phoneCallRequested.md create mode 100644 old_docs/API_docs_v109/constructors/phoneCallWaiting.md create mode 100644 old_docs/API_docs_v109/constructors/phoneConnection.md create mode 100644 old_docs/API_docs_v109/constructors/photo.md create mode 100644 old_docs/API_docs_v109/constructors/photoCachedSize.md create mode 100644 old_docs/API_docs_v109/constructors/photoEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/photoSize.md create mode 100644 old_docs/API_docs_v109/constructors/photoSizeEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/photoStrippedSize.md create mode 100644 old_docs/API_docs_v109/constructors/photos.photo.md create mode 100644 old_docs/API_docs_v109/constructors/photos.photos.md create mode 100644 old_docs/API_docs_v109/constructors/photos.photosSlice.md create mode 100644 old_docs/API_docs_v109/constructors/poll.md create mode 100644 old_docs/API_docs_v109/constructors/pollAnswer.md create mode 100644 old_docs/API_docs_v109/constructors/pollAnswerVoters.md create mode 100644 old_docs/API_docs_v109/constructors/pollResults.md create mode 100644 old_docs/API_docs_v109/constructors/popularContact.md create mode 100644 old_docs/API_docs_v109/constructors/postAddress.md create mode 100644 old_docs/API_docs_v109/constructors/privacyKeyAddedByPhone.md create mode 100644 old_docs/API_docs_v109/constructors/privacyKeyChatInvite.md create mode 100644 old_docs/API_docs_v109/constructors/privacyKeyForwards.md create mode 100644 old_docs/API_docs_v109/constructors/privacyKeyPhoneCall.md create mode 100644 old_docs/API_docs_v109/constructors/privacyKeyPhoneNumber.md create mode 100644 old_docs/API_docs_v109/constructors/privacyKeyPhoneP2P.md create mode 100644 old_docs/API_docs_v109/constructors/privacyKeyProfilePhoto.md create mode 100644 old_docs/API_docs_v109/constructors/privacyKeyStatusTimestamp.md create mode 100644 old_docs/API_docs_v109/constructors/privacyValueAllowAll.md create mode 100644 old_docs/API_docs_v109/constructors/privacyValueAllowChatParticipants.md create mode 100644 old_docs/API_docs_v109/constructors/privacyValueAllowContacts.md create mode 100644 old_docs/API_docs_v109/constructors/privacyValueAllowUsers.md create mode 100644 old_docs/API_docs_v109/constructors/privacyValueDisallowAll.md create mode 100644 old_docs/API_docs_v109/constructors/privacyValueDisallowChatParticipants.md create mode 100644 old_docs/API_docs_v109/constructors/privacyValueDisallowContacts.md create mode 100644 old_docs/API_docs_v109/constructors/privacyValueDisallowUsers.md create mode 100644 old_docs/API_docs_v109/constructors/receivedNotifyMessage.md create mode 100644 old_docs/API_docs_v109/constructors/recentMeUrlChat.md create mode 100644 old_docs/API_docs_v109/constructors/recentMeUrlChatInvite.md create mode 100644 old_docs/API_docs_v109/constructors/recentMeUrlStickerSet.md create mode 100644 old_docs/API_docs_v109/constructors/recentMeUrlUnknown.md create mode 100644 old_docs/API_docs_v109/constructors/recentMeUrlUser.md create mode 100644 old_docs/API_docs_v109/constructors/replyInlineMarkup.md create mode 100644 old_docs/API_docs_v109/constructors/replyKeyboardForceReply.md create mode 100644 old_docs/API_docs_v109/constructors/replyKeyboardHide.md create mode 100644 old_docs/API_docs_v109/constructors/replyKeyboardMarkup.md create mode 100644 old_docs/API_docs_v109/constructors/restrictionReason.md create mode 100644 old_docs/API_docs_v109/constructors/savedPhoneContact.md create mode 100644 old_docs/API_docs_v109/constructors/secureCredentialsEncrypted.md create mode 100644 old_docs/API_docs_v109/constructors/secureData.md create mode 100644 old_docs/API_docs_v109/constructors/secureFile.md create mode 100644 old_docs/API_docs_v109/constructors/secureFileEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md create mode 100644 old_docs/API_docs_v109/constructors/securePasswordKdfAlgoSHA512.md create mode 100644 old_docs/API_docs_v109/constructors/securePasswordKdfAlgoUnknown.md create mode 100644 old_docs/API_docs_v109/constructors/securePlainEmail.md create mode 100644 old_docs/API_docs_v109/constructors/securePlainPhone.md create mode 100644 old_docs/API_docs_v109/constructors/secureRequiredType.md create mode 100644 old_docs/API_docs_v109/constructors/secureRequiredTypeOneOf.md create mode 100644 old_docs/API_docs_v109/constructors/secureSecretSettings.md create mode 100644 old_docs/API_docs_v109/constructors/secureValue.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueError.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueErrorData.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueErrorFile.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueErrorFiles.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueErrorFrontSide.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueErrorReverseSide.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueErrorSelfie.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueErrorTranslationFile.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueErrorTranslationFiles.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueHash.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypeAddress.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypeBankStatement.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypeDriverLicense.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypeEmail.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypeIdentityCard.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypeInternalPassport.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypePassport.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypePassportRegistration.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypePersonalDetails.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypePhone.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypeRentalAgreement.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypeTemporaryRegistration.md create mode 100644 old_docs/API_docs_v109/constructors/secureValueTypeUtilityBill.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageCancelAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageChooseContactAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageGamePlayAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageGeoLocationAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageRecordAudioAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageRecordRoundAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageRecordVideoAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageTypingAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageUploadAudioAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageUploadDocumentAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageUploadPhotoAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageUploadRoundAction.md create mode 100644 old_docs/API_docs_v109/constructors/sendMessageUploadVideoAction.md create mode 100644 old_docs/API_docs_v109/constructors/shippingOption.md create mode 100644 old_docs/API_docs_v109/constructors/statsURL.md create mode 100644 old_docs/API_docs_v109/constructors/stickerPack.md create mode 100644 old_docs/API_docs_v109/constructors/stickerSet.md create mode 100644 old_docs/API_docs_v109/constructors/stickerSetCovered.md create mode 100644 old_docs/API_docs_v109/constructors/stickerSetMultiCovered.md create mode 100644 old_docs/API_docs_v109/constructors/storage.fileGif.md create mode 100644 old_docs/API_docs_v109/constructors/storage.fileJpeg.md create mode 100644 old_docs/API_docs_v109/constructors/storage.fileMov.md create mode 100644 old_docs/API_docs_v109/constructors/storage.fileMp3.md create mode 100644 old_docs/API_docs_v109/constructors/storage.fileMp4.md create mode 100644 old_docs/API_docs_v109/constructors/storage.filePartial.md create mode 100644 old_docs/API_docs_v109/constructors/storage.filePdf.md create mode 100644 old_docs/API_docs_v109/constructors/storage.filePng.md create mode 100644 old_docs/API_docs_v109/constructors/storage.fileUnknown.md create mode 100644 old_docs/API_docs_v109/constructors/storage.fileWebp.md create mode 100644 old_docs/API_docs_v109/constructors/textAnchor.md create mode 100644 old_docs/API_docs_v109/constructors/textBold.md create mode 100644 old_docs/API_docs_v109/constructors/textConcat.md create mode 100644 old_docs/API_docs_v109/constructors/textEmail.md create mode 100644 old_docs/API_docs_v109/constructors/textEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/textFixed.md create mode 100644 old_docs/API_docs_v109/constructors/textImage.md create mode 100644 old_docs/API_docs_v109/constructors/textItalic.md create mode 100644 old_docs/API_docs_v109/constructors/textMarked.md create mode 100644 old_docs/API_docs_v109/constructors/textPhone.md create mode 100644 old_docs/API_docs_v109/constructors/textPlain.md create mode 100644 old_docs/API_docs_v109/constructors/textStrike.md create mode 100644 old_docs/API_docs_v109/constructors/textSubscript.md create mode 100644 old_docs/API_docs_v109/constructors/textSuperscript.md create mode 100644 old_docs/API_docs_v109/constructors/textUnderline.md create mode 100644 old_docs/API_docs_v109/constructors/textUrl.md create mode 100644 old_docs/API_docs_v109/constructors/theme.md create mode 100644 old_docs/API_docs_v109/constructors/themeSettings.md create mode 100644 old_docs/API_docs_v109/constructors/topPeer.md create mode 100644 old_docs/API_docs_v109/constructors/topPeerCategoryBotsInline.md create mode 100644 old_docs/API_docs_v109/constructors/topPeerCategoryBotsPM.md create mode 100644 old_docs/API_docs_v109/constructors/topPeerCategoryChannels.md create mode 100644 old_docs/API_docs_v109/constructors/topPeerCategoryCorrespondents.md create mode 100644 old_docs/API_docs_v109/constructors/topPeerCategoryForwardChats.md create mode 100644 old_docs/API_docs_v109/constructors/topPeerCategoryForwardUsers.md create mode 100644 old_docs/API_docs_v109/constructors/topPeerCategoryGroups.md create mode 100644 old_docs/API_docs_v109/constructors/topPeerCategoryPeers.md create mode 100644 old_docs/API_docs_v109/constructors/topPeerCategoryPhoneCalls.md create mode 100644 old_docs/API_docs_v109/constructors/true.md create mode 100644 old_docs/API_docs_v109/constructors/updateBotCallbackQuery.md create mode 100644 old_docs/API_docs_v109/constructors/updateBotInlineQuery.md create mode 100644 old_docs/API_docs_v109/constructors/updateBotInlineSend.md create mode 100644 old_docs/API_docs_v109/constructors/updateBotPrecheckoutQuery.md create mode 100644 old_docs/API_docs_v109/constructors/updateBotShippingQuery.md create mode 100644 old_docs/API_docs_v109/constructors/updateBotWebhookJSON.md create mode 100644 old_docs/API_docs_v109/constructors/updateBotWebhookJSONQuery.md create mode 100644 old_docs/API_docs_v109/constructors/updateChannel.md create mode 100644 old_docs/API_docs_v109/constructors/updateChannelAvailableMessages.md create mode 100644 old_docs/API_docs_v109/constructors/updateChannelMessageViews.md create mode 100644 old_docs/API_docs_v109/constructors/updateChannelPinnedMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateChannelReadMessagesContents.md create mode 100644 old_docs/API_docs_v109/constructors/updateChannelTooLong.md create mode 100644 old_docs/API_docs_v109/constructors/updateChannelWebPage.md create mode 100644 old_docs/API_docs_v109/constructors/updateChatDefaultBannedRights.md create mode 100644 old_docs/API_docs_v109/constructors/updateChatParticipantAdd.md create mode 100644 old_docs/API_docs_v109/constructors/updateChatParticipantAdmin.md create mode 100644 old_docs/API_docs_v109/constructors/updateChatParticipantDelete.md create mode 100644 old_docs/API_docs_v109/constructors/updateChatParticipants.md create mode 100644 old_docs/API_docs_v109/constructors/updateChatPinnedMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateChatUserTyping.md create mode 100644 old_docs/API_docs_v109/constructors/updateConfig.md create mode 100644 old_docs/API_docs_v109/constructors/updateContactsReset.md create mode 100644 old_docs/API_docs_v109/constructors/updateDcOptions.md create mode 100644 old_docs/API_docs_v109/constructors/updateDeleteChannelMessages.md create mode 100644 old_docs/API_docs_v109/constructors/updateDeleteMessages.md create mode 100644 old_docs/API_docs_v109/constructors/updateDeleteScheduledMessages.md create mode 100644 old_docs/API_docs_v109/constructors/updateDialogPinned.md create mode 100644 old_docs/API_docs_v109/constructors/updateDialogUnreadMark.md create mode 100644 old_docs/API_docs_v109/constructors/updateDraftMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateEditChannelMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateEditMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateEncryptedChatTyping.md create mode 100644 old_docs/API_docs_v109/constructors/updateEncryptedMessagesRead.md create mode 100644 old_docs/API_docs_v109/constructors/updateEncryption.md create mode 100644 old_docs/API_docs_v109/constructors/updateFavedStickers.md create mode 100644 old_docs/API_docs_v109/constructors/updateFolderPeers.md create mode 100644 old_docs/API_docs_v109/constructors/updateGeoLiveViewed.md create mode 100644 old_docs/API_docs_v109/constructors/updateInlineBotCallbackQuery.md create mode 100644 old_docs/API_docs_v109/constructors/updateLangPack.md create mode 100644 old_docs/API_docs_v109/constructors/updateLangPackTooLong.md create mode 100644 old_docs/API_docs_v109/constructors/updateLoginToken.md create mode 100644 old_docs/API_docs_v109/constructors/updateMessageID.md create mode 100644 old_docs/API_docs_v109/constructors/updateMessagePoll.md create mode 100644 old_docs/API_docs_v109/constructors/updateMessagePollVote.md create mode 100644 old_docs/API_docs_v109/constructors/updateNewChannelMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateNewEncryptedMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateNewMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateNewScheduledMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateNewStickerSet.md create mode 100644 old_docs/API_docs_v109/constructors/updateNotifySettings.md create mode 100644 old_docs/API_docs_v109/constructors/updatePeerLocated.md create mode 100644 old_docs/API_docs_v109/constructors/updatePeerSettings.md create mode 100644 old_docs/API_docs_v109/constructors/updatePhoneCall.md create mode 100644 old_docs/API_docs_v109/constructors/updatePinnedDialogs.md create mode 100644 old_docs/API_docs_v109/constructors/updatePrivacy.md create mode 100644 old_docs/API_docs_v109/constructors/updatePtsChanged.md create mode 100644 old_docs/API_docs_v109/constructors/updateReadChannelInbox.md create mode 100644 old_docs/API_docs_v109/constructors/updateReadChannelOutbox.md create mode 100644 old_docs/API_docs_v109/constructors/updateReadFeaturedStickers.md create mode 100644 old_docs/API_docs_v109/constructors/updateReadHistoryInbox.md create mode 100644 old_docs/API_docs_v109/constructors/updateReadHistoryOutbox.md create mode 100644 old_docs/API_docs_v109/constructors/updateReadMessagesContents.md create mode 100644 old_docs/API_docs_v109/constructors/updateRecentStickers.md create mode 100644 old_docs/API_docs_v109/constructors/updateSavedGifs.md create mode 100644 old_docs/API_docs_v109/constructors/updateServiceNotification.md create mode 100644 old_docs/API_docs_v109/constructors/updateShort.md create mode 100644 old_docs/API_docs_v109/constructors/updateShortChatMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateShortMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateShortSentMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateStickerSets.md create mode 100644 old_docs/API_docs_v109/constructors/updateStickerSetsOrder.md create mode 100644 old_docs/API_docs_v109/constructors/updateTheme.md create mode 100644 old_docs/API_docs_v109/constructors/updateUserBlocked.md create mode 100644 old_docs/API_docs_v109/constructors/updateUserName.md create mode 100644 old_docs/API_docs_v109/constructors/updateUserPhone.md create mode 100644 old_docs/API_docs_v109/constructors/updateUserPhoto.md create mode 100644 old_docs/API_docs_v109/constructors/updateUserPinnedMessage.md create mode 100644 old_docs/API_docs_v109/constructors/updateUserStatus.md create mode 100644 old_docs/API_docs_v109/constructors/updateUserTyping.md create mode 100644 old_docs/API_docs_v109/constructors/updateWebPage.md create mode 100644 old_docs/API_docs_v109/constructors/updates.channelDifference.md create mode 100644 old_docs/API_docs_v109/constructors/updates.channelDifferenceEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/updates.channelDifferenceTooLong.md create mode 100644 old_docs/API_docs_v109/constructors/updates.difference.md create mode 100644 old_docs/API_docs_v109/constructors/updates.differenceEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/updates.differenceSlice.md create mode 100644 old_docs/API_docs_v109/constructors/updates.differenceTooLong.md create mode 100644 old_docs/API_docs_v109/constructors/updates.md create mode 100644 old_docs/API_docs_v109/constructors/updates.state.md create mode 100644 old_docs/API_docs_v109/constructors/updatesCombined.md create mode 100644 old_docs/API_docs_v109/constructors/updatesTooLong.md create mode 100644 old_docs/API_docs_v109/constructors/upload.cdnFile.md create mode 100644 old_docs/API_docs_v109/constructors/upload.cdnFileReuploadNeeded.md create mode 100644 old_docs/API_docs_v109/constructors/upload.file.md create mode 100644 old_docs/API_docs_v109/constructors/upload.fileCdnRedirect.md create mode 100644 old_docs/API_docs_v109/constructors/upload.webFile.md create mode 100644 old_docs/API_docs_v109/constructors/urlAuthResultAccepted.md create mode 100644 old_docs/API_docs_v109/constructors/urlAuthResultDefault.md create mode 100644 old_docs/API_docs_v109/constructors/urlAuthResultRequest.md create mode 100644 old_docs/API_docs_v109/constructors/user.md create mode 100644 old_docs/API_docs_v109/constructors/userEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/userFull.md create mode 100644 old_docs/API_docs_v109/constructors/userProfilePhoto.md create mode 100644 old_docs/API_docs_v109/constructors/userProfilePhotoEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/userStatusEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/userStatusLastMonth.md create mode 100644 old_docs/API_docs_v109/constructors/userStatusLastWeek.md create mode 100644 old_docs/API_docs_v109/constructors/userStatusOffline.md create mode 100644 old_docs/API_docs_v109/constructors/userStatusOnline.md create mode 100644 old_docs/API_docs_v109/constructors/userStatusRecently.md create mode 100644 old_docs/API_docs_v109/constructors/wallPaper.md create mode 100644 old_docs/API_docs_v109/constructors/wallPaperNoFile.md create mode 100644 old_docs/API_docs_v109/constructors/wallPaperSettings.md create mode 100644 old_docs/API_docs_v109/constructors/webAuthorization.md create mode 100644 old_docs/API_docs_v109/constructors/webDocument.md create mode 100644 old_docs/API_docs_v109/constructors/webDocumentNoProxy.md create mode 100644 old_docs/API_docs_v109/constructors/webPage.md create mode 100644 old_docs/API_docs_v109/constructors/webPageAttributeTheme.md create mode 100644 old_docs/API_docs_v109/constructors/webPageEmpty.md create mode 100644 old_docs/API_docs_v109/constructors/webPageNotModified.md create mode 100644 old_docs/API_docs_v109/constructors/webPagePending.md create mode 100644 old_docs/API_docs_v109/methods/README.md create mode 100644 old_docs/API_docs_v109/methods/account.acceptAuthorization.md create mode 100644 old_docs/API_docs_v109/methods/account.cancelPasswordEmail.md create mode 100644 old_docs/API_docs_v109/methods/account.changePhone.md create mode 100644 old_docs/API_docs_v109/methods/account.checkUsername.md create mode 100644 old_docs/API_docs_v109/methods/account.confirmPasswordEmail.md create mode 100644 old_docs/API_docs_v109/methods/account.confirmPhone.md create mode 100644 old_docs/API_docs_v109/methods/account.createTheme.md create mode 100644 old_docs/API_docs_v109/methods/account.deleteAccount.md create mode 100644 old_docs/API_docs_v109/methods/account.deleteSecureValue.md create mode 100644 old_docs/API_docs_v109/methods/account.finishTakeoutSession.md create mode 100644 old_docs/API_docs_v109/methods/account.getAccountTTL.md create mode 100644 old_docs/API_docs_v109/methods/account.getAllSecureValues.md create mode 100644 old_docs/API_docs_v109/methods/account.getAuthorizationForm.md create mode 100644 old_docs/API_docs_v109/methods/account.getAuthorizations.md create mode 100644 old_docs/API_docs_v109/methods/account.getAutoDownloadSettings.md create mode 100644 old_docs/API_docs_v109/methods/account.getContactSignUpNotification.md create mode 100644 old_docs/API_docs_v109/methods/account.getContentSettings.md create mode 100644 old_docs/API_docs_v109/methods/account.getMultiWallPapers.md create mode 100644 old_docs/API_docs_v109/methods/account.getNotifyExceptions.md create mode 100644 old_docs/API_docs_v109/methods/account.getNotifySettings.md create mode 100644 old_docs/API_docs_v109/methods/account.getPassword.md create mode 100644 old_docs/API_docs_v109/methods/account.getPasswordSettings.md create mode 100644 old_docs/API_docs_v109/methods/account.getPrivacy.md create mode 100644 old_docs/API_docs_v109/methods/account.getSecureValue.md create mode 100644 old_docs/API_docs_v109/methods/account.getTheme.md create mode 100644 old_docs/API_docs_v109/methods/account.getThemes.md create mode 100644 old_docs/API_docs_v109/methods/account.getTmpPassword.md create mode 100644 old_docs/API_docs_v109/methods/account.getWallPaper.md create mode 100644 old_docs/API_docs_v109/methods/account.getWallPapers.md create mode 100644 old_docs/API_docs_v109/methods/account.getWebAuthorizations.md create mode 100644 old_docs/API_docs_v109/methods/account.initTakeoutSession.md create mode 100644 old_docs/API_docs_v109/methods/account.installTheme.md create mode 100644 old_docs/API_docs_v109/methods/account.installWallPaper.md create mode 100644 old_docs/API_docs_v109/methods/account.registerDevice.md create mode 100644 old_docs/API_docs_v109/methods/account.reportPeer.md create mode 100644 old_docs/API_docs_v109/methods/account.resendPasswordEmail.md create mode 100644 old_docs/API_docs_v109/methods/account.resetAuthorization.md create mode 100644 old_docs/API_docs_v109/methods/account.resetNotifySettings.md create mode 100644 old_docs/API_docs_v109/methods/account.resetWallPapers.md create mode 100644 old_docs/API_docs_v109/methods/account.resetWebAuthorization.md create mode 100644 old_docs/API_docs_v109/methods/account.resetWebAuthorizations.md create mode 100644 old_docs/API_docs_v109/methods/account.saveAutoDownloadSettings.md create mode 100644 old_docs/API_docs_v109/methods/account.saveSecureValue.md create mode 100644 old_docs/API_docs_v109/methods/account.saveTheme.md create mode 100644 old_docs/API_docs_v109/methods/account.saveWallPaper.md create mode 100644 old_docs/API_docs_v109/methods/account.sendChangePhoneCode.md create mode 100644 old_docs/API_docs_v109/methods/account.sendConfirmPhoneCode.md create mode 100644 old_docs/API_docs_v109/methods/account.sendVerifyEmailCode.md create mode 100644 old_docs/API_docs_v109/methods/account.sendVerifyPhoneCode.md create mode 100644 old_docs/API_docs_v109/methods/account.setAccountTTL.md create mode 100644 old_docs/API_docs_v109/methods/account.setContactSignUpNotification.md create mode 100644 old_docs/API_docs_v109/methods/account.setContentSettings.md create mode 100644 old_docs/API_docs_v109/methods/account.setPrivacy.md create mode 100644 old_docs/API_docs_v109/methods/account.unregisterDevice.md create mode 100644 old_docs/API_docs_v109/methods/account.updateDeviceLocked.md create mode 100644 old_docs/API_docs_v109/methods/account.updateNotifySettings.md create mode 100644 old_docs/API_docs_v109/methods/account.updatePasswordSettings.md create mode 100644 old_docs/API_docs_v109/methods/account.updateProfile.md create mode 100644 old_docs/API_docs_v109/methods/account.updateStatus.md create mode 100644 old_docs/API_docs_v109/methods/account.updateTheme.md create mode 100644 old_docs/API_docs_v109/methods/account.updateUsername.md create mode 100644 old_docs/API_docs_v109/methods/account.uploadTheme.md create mode 100644 old_docs/API_docs_v109/methods/account.uploadWallPaper.md create mode 100644 old_docs/API_docs_v109/methods/account.verifyEmail.md create mode 100644 old_docs/API_docs_v109/methods/account.verifyPhone.md create mode 100644 old_docs/API_docs_v109/methods/api_README.md create mode 100644 old_docs/API_docs_v109/methods/auth.acceptLoginToken.md create mode 100644 old_docs/API_docs_v109/methods/auth.bindTempAuthKey.md create mode 100644 old_docs/API_docs_v109/methods/auth.cancelCode.md create mode 100644 old_docs/API_docs_v109/methods/auth.checkPassword.md create mode 100644 old_docs/API_docs_v109/methods/auth.dropTempAuthKeys.md create mode 100644 old_docs/API_docs_v109/methods/auth.exportAuthorization.md create mode 100644 old_docs/API_docs_v109/methods/auth.exportLoginToken.md create mode 100644 old_docs/API_docs_v109/methods/auth.importAuthorization.md create mode 100644 old_docs/API_docs_v109/methods/auth.importBotAuthorization.md create mode 100644 old_docs/API_docs_v109/methods/auth.importLoginToken.md create mode 100644 old_docs/API_docs_v109/methods/auth.logOut.md create mode 100644 old_docs/API_docs_v109/methods/auth.recoverPassword.md create mode 100644 old_docs/API_docs_v109/methods/auth.requestPasswordRecovery.md create mode 100644 old_docs/API_docs_v109/methods/auth.resendCode.md create mode 100644 old_docs/API_docs_v109/methods/auth.resetAuthorizations.md create mode 100644 old_docs/API_docs_v109/methods/auth.sendCode.md create mode 100644 old_docs/API_docs_v109/methods/auth.signIn.md create mode 100644 old_docs/API_docs_v109/methods/auth.signUp.md create mode 100644 old_docs/API_docs_v109/methods/bots.answerWebhookJSONQuery.md create mode 100644 old_docs/API_docs_v109/methods/bots.sendCustomRequest.md create mode 100644 old_docs/API_docs_v109/methods/channels.checkUsername.md create mode 100644 old_docs/API_docs_v109/methods/channels.createChannel.md create mode 100644 old_docs/API_docs_v109/methods/channels.deleteChannel.md create mode 100644 old_docs/API_docs_v109/methods/channels.deleteHistory.md create mode 100644 old_docs/API_docs_v109/methods/channels.deleteMessages.md create mode 100644 old_docs/API_docs_v109/methods/channels.deleteUserHistory.md create mode 100644 old_docs/API_docs_v109/methods/channels.editAdmin.md create mode 100644 old_docs/API_docs_v109/methods/channels.editBanned.md create mode 100644 old_docs/API_docs_v109/methods/channels.editCreator.md create mode 100644 old_docs/API_docs_v109/methods/channels.editLocation.md create mode 100644 old_docs/API_docs_v109/methods/channels.editPhoto.md create mode 100644 old_docs/API_docs_v109/methods/channels.editTitle.md create mode 100644 old_docs/API_docs_v109/methods/channels.exportMessageLink.md create mode 100644 old_docs/API_docs_v109/methods/channels.getAdminLog.md create mode 100644 old_docs/API_docs_v109/methods/channels.getAdminedPublicChannels.md create mode 100644 old_docs/API_docs_v109/methods/channels.getChannels.md create mode 100644 old_docs/API_docs_v109/methods/channels.getFullChannel.md create mode 100644 old_docs/API_docs_v109/methods/channels.getGroupsForDiscussion.md create mode 100644 old_docs/API_docs_v109/methods/channels.getInactiveChannels.md create mode 100644 old_docs/API_docs_v109/methods/channels.getLeftChannels.md create mode 100644 old_docs/API_docs_v109/methods/channels.getMessages.md create mode 100644 old_docs/API_docs_v109/methods/channels.getParticipant.md create mode 100644 old_docs/API_docs_v109/methods/channels.getParticipants.md create mode 100644 old_docs/API_docs_v109/methods/channels.inviteToChannel.md create mode 100644 old_docs/API_docs_v109/methods/channels.joinChannel.md create mode 100644 old_docs/API_docs_v109/methods/channels.leaveChannel.md create mode 100644 old_docs/API_docs_v109/methods/channels.readHistory.md create mode 100644 old_docs/API_docs_v109/methods/channels.readMessageContents.md create mode 100644 old_docs/API_docs_v109/methods/channels.reportSpam.md create mode 100644 old_docs/API_docs_v109/methods/channels.setDiscussionGroup.md create mode 100644 old_docs/API_docs_v109/methods/channels.setStickers.md create mode 100644 old_docs/API_docs_v109/methods/channels.togglePreHistoryHidden.md create mode 100644 old_docs/API_docs_v109/methods/channels.toggleSignatures.md create mode 100644 old_docs/API_docs_v109/methods/channels.toggleSlowMode.md create mode 100644 old_docs/API_docs_v109/methods/channels.updateUsername.md create mode 100644 old_docs/API_docs_v109/methods/contacts.acceptContact.md create mode 100644 old_docs/API_docs_v109/methods/contacts.addContact.md create mode 100644 old_docs/API_docs_v109/methods/contacts.block.md create mode 100644 old_docs/API_docs_v109/methods/contacts.deleteByPhones.md create mode 100644 old_docs/API_docs_v109/methods/contacts.deleteContacts.md create mode 100644 old_docs/API_docs_v109/methods/contacts.getBlocked.md create mode 100644 old_docs/API_docs_v109/methods/contacts.getContactIDs.md create mode 100644 old_docs/API_docs_v109/methods/contacts.getContacts.md create mode 100644 old_docs/API_docs_v109/methods/contacts.getLocated.md create mode 100644 old_docs/API_docs_v109/methods/contacts.getSaved.md create mode 100644 old_docs/API_docs_v109/methods/contacts.getStatuses.md create mode 100644 old_docs/API_docs_v109/methods/contacts.getTopPeers.md create mode 100644 old_docs/API_docs_v109/methods/contacts.importContacts.md create mode 100644 old_docs/API_docs_v109/methods/contacts.resetSaved.md create mode 100644 old_docs/API_docs_v109/methods/contacts.resetTopPeerRating.md create mode 100644 old_docs/API_docs_v109/methods/contacts.resolveUsername.md create mode 100644 old_docs/API_docs_v109/methods/contacts.search.md create mode 100644 old_docs/API_docs_v109/methods/contacts.toggleTopPeers.md create mode 100644 old_docs/API_docs_v109/methods/contacts.unblock.md create mode 100644 old_docs/API_docs_v109/methods/folders.deleteFolder.md create mode 100644 old_docs/API_docs_v109/methods/folders.editPeerFolders.md create mode 100644 old_docs/API_docs_v109/methods/help.acceptTermsOfService.md create mode 100644 old_docs/API_docs_v109/methods/help.editUserInfo.md create mode 100644 old_docs/API_docs_v109/methods/help.getAppChangelog.md create mode 100644 old_docs/API_docs_v109/methods/help.getAppConfig.md create mode 100644 old_docs/API_docs_v109/methods/help.getAppUpdate.md create mode 100644 old_docs/API_docs_v109/methods/help.getCdnConfig.md create mode 100644 old_docs/API_docs_v109/methods/help.getConfig.md create mode 100644 old_docs/API_docs_v109/methods/help.getDeepLinkInfo.md create mode 100644 old_docs/API_docs_v109/methods/help.getInviteText.md create mode 100644 old_docs/API_docs_v109/methods/help.getNearestDc.md create mode 100644 old_docs/API_docs_v109/methods/help.getPassportConfig.md create mode 100644 old_docs/API_docs_v109/methods/help.getProxyData.md create mode 100644 old_docs/API_docs_v109/methods/help.getRecentMeUrls.md create mode 100644 old_docs/API_docs_v109/methods/help.getSupport.md create mode 100644 old_docs/API_docs_v109/methods/help.getSupportName.md create mode 100644 old_docs/API_docs_v109/methods/help.getTermsOfServiceUpdate.md create mode 100644 old_docs/API_docs_v109/methods/help.getUserInfo.md create mode 100644 old_docs/API_docs_v109/methods/help.saveAppLog.md create mode 100644 old_docs/API_docs_v109/methods/help.setBotUpdatesStatus.md create mode 100644 old_docs/API_docs_v109/methods/initConnection.md create mode 100644 old_docs/API_docs_v109/methods/invokeAfterMsg.md create mode 100644 old_docs/API_docs_v109/methods/invokeAfterMsgs.md create mode 100644 old_docs/API_docs_v109/methods/invokeWithLayer.md create mode 100644 old_docs/API_docs_v109/methods/invokeWithMessagesRange.md create mode 100644 old_docs/API_docs_v109/methods/invokeWithTakeout.md create mode 100644 old_docs/API_docs_v109/methods/invokeWithoutUpdates.md create mode 100644 old_docs/API_docs_v109/methods/langpack.getDifference.md create mode 100644 old_docs/API_docs_v109/methods/langpack.getLangPack.md create mode 100644 old_docs/API_docs_v109/methods/langpack.getLanguage.md create mode 100644 old_docs/API_docs_v109/methods/langpack.getLanguages.md create mode 100644 old_docs/API_docs_v109/methods/langpack.getStrings.md create mode 100644 old_docs/API_docs_v109/methods/messages.acceptEncryption.md create mode 100644 old_docs/API_docs_v109/methods/messages.acceptUrlAuth.md create mode 100644 old_docs/API_docs_v109/methods/messages.addChatUser.md create mode 100644 old_docs/API_docs_v109/methods/messages.checkChatInvite.md create mode 100644 old_docs/API_docs_v109/methods/messages.clearAllDrafts.md create mode 100644 old_docs/API_docs_v109/methods/messages.clearRecentStickers.md create mode 100644 old_docs/API_docs_v109/methods/messages.createChat.md create mode 100644 old_docs/API_docs_v109/methods/messages.deleteChatUser.md create mode 100644 old_docs/API_docs_v109/methods/messages.deleteHistory.md create mode 100644 old_docs/API_docs_v109/methods/messages.deleteMessages.md create mode 100644 old_docs/API_docs_v109/methods/messages.deleteScheduledMessages.md create mode 100644 old_docs/API_docs_v109/methods/messages.discardEncryption.md create mode 100644 old_docs/API_docs_v109/methods/messages.editChatAbout.md create mode 100644 old_docs/API_docs_v109/methods/messages.editChatAdmin.md create mode 100644 old_docs/API_docs_v109/methods/messages.editChatDefaultBannedRights.md create mode 100644 old_docs/API_docs_v109/methods/messages.editChatPhoto.md create mode 100644 old_docs/API_docs_v109/methods/messages.editChatTitle.md create mode 100644 old_docs/API_docs_v109/methods/messages.editInlineBotMessage.md create mode 100644 old_docs/API_docs_v109/methods/messages.editMessage.md create mode 100644 old_docs/API_docs_v109/methods/messages.exportChatInvite.md create mode 100644 old_docs/API_docs_v109/methods/messages.faveSticker.md create mode 100644 old_docs/API_docs_v109/methods/messages.forwardMessages.md create mode 100644 old_docs/API_docs_v109/methods/messages.getAllChats.md create mode 100644 old_docs/API_docs_v109/methods/messages.getAllDrafts.md create mode 100644 old_docs/API_docs_v109/methods/messages.getAllStickers.md create mode 100644 old_docs/API_docs_v109/methods/messages.getArchivedStickers.md create mode 100644 old_docs/API_docs_v109/methods/messages.getAttachedStickers.md create mode 100644 old_docs/API_docs_v109/methods/messages.getBotCallbackAnswer.md create mode 100644 old_docs/API_docs_v109/methods/messages.getChats.md create mode 100644 old_docs/API_docs_v109/methods/messages.getCommonChats.md create mode 100644 old_docs/API_docs_v109/methods/messages.getDhConfig.md create mode 100644 old_docs/API_docs_v109/methods/messages.getDialogUnreadMarks.md create mode 100644 old_docs/API_docs_v109/methods/messages.getDialogs.md create mode 100644 old_docs/API_docs_v109/methods/messages.getDocumentByHash.md create mode 100644 old_docs/API_docs_v109/methods/messages.getEmojiKeywords.md create mode 100644 old_docs/API_docs_v109/methods/messages.getEmojiKeywordsDifference.md create mode 100644 old_docs/API_docs_v109/methods/messages.getEmojiKeywordsLanguages.md create mode 100644 old_docs/API_docs_v109/methods/messages.getEmojiURL.md create mode 100644 old_docs/API_docs_v109/methods/messages.getFavedStickers.md create mode 100644 old_docs/API_docs_v109/methods/messages.getFeaturedStickers.md create mode 100644 old_docs/API_docs_v109/methods/messages.getFullChat.md create mode 100644 old_docs/API_docs_v109/methods/messages.getGameHighScores.md create mode 100644 old_docs/API_docs_v109/methods/messages.getHistory.md create mode 100644 old_docs/API_docs_v109/methods/messages.getInlineBotResults.md create mode 100644 old_docs/API_docs_v109/methods/messages.getInlineGameHighScores.md create mode 100644 old_docs/API_docs_v109/methods/messages.getMaskStickers.md create mode 100644 old_docs/API_docs_v109/methods/messages.getMessageEditData.md create mode 100644 old_docs/API_docs_v109/methods/messages.getMessages.md create mode 100644 old_docs/API_docs_v109/methods/messages.getMessagesViews.md create mode 100644 old_docs/API_docs_v109/methods/messages.getOnlines.md create mode 100644 old_docs/API_docs_v109/methods/messages.getPeerDialogs.md create mode 100644 old_docs/API_docs_v109/methods/messages.getPeerSettings.md create mode 100644 old_docs/API_docs_v109/methods/messages.getPinnedDialogs.md create mode 100644 old_docs/API_docs_v109/methods/messages.getPollResults.md create mode 100644 old_docs/API_docs_v109/methods/messages.getPollVotes.md create mode 100644 old_docs/API_docs_v109/methods/messages.getRecentLocations.md create mode 100644 old_docs/API_docs_v109/methods/messages.getRecentStickers.md create mode 100644 old_docs/API_docs_v109/methods/messages.getSavedGifs.md create mode 100644 old_docs/API_docs_v109/methods/messages.getScheduledHistory.md create mode 100644 old_docs/API_docs_v109/methods/messages.getScheduledMessages.md create mode 100644 old_docs/API_docs_v109/methods/messages.getSearchCounters.md create mode 100644 old_docs/API_docs_v109/methods/messages.getSplitRanges.md create mode 100644 old_docs/API_docs_v109/methods/messages.getStatsURL.md create mode 100644 old_docs/API_docs_v109/methods/messages.getStickerSet.md create mode 100644 old_docs/API_docs_v109/methods/messages.getStickers.md create mode 100644 old_docs/API_docs_v109/methods/messages.getUnreadMentions.md create mode 100644 old_docs/API_docs_v109/methods/messages.getWebPage.md create mode 100644 old_docs/API_docs_v109/methods/messages.getWebPagePreview.md create mode 100644 old_docs/API_docs_v109/methods/messages.hidePeerSettingsBar.md create mode 100644 old_docs/API_docs_v109/methods/messages.importChatInvite.md create mode 100644 old_docs/API_docs_v109/methods/messages.installStickerSet.md create mode 100644 old_docs/API_docs_v109/methods/messages.markDialogUnread.md create mode 100644 old_docs/API_docs_v109/methods/messages.migrateChat.md create mode 100644 old_docs/API_docs_v109/methods/messages.readEncryptedHistory.md create mode 100644 old_docs/API_docs_v109/methods/messages.readFeaturedStickers.md create mode 100644 old_docs/API_docs_v109/methods/messages.readHistory.md create mode 100644 old_docs/API_docs_v109/methods/messages.readMentions.md create mode 100644 old_docs/API_docs_v109/methods/messages.readMessageContents.md create mode 100644 old_docs/API_docs_v109/methods/messages.receivedMessages.md create mode 100644 old_docs/API_docs_v109/methods/messages.receivedQueue.md create mode 100644 old_docs/API_docs_v109/methods/messages.reorderPinnedDialogs.md create mode 100644 old_docs/API_docs_v109/methods/messages.reorderStickerSets.md create mode 100644 old_docs/API_docs_v109/methods/messages.report.md create mode 100644 old_docs/API_docs_v109/methods/messages.reportEncryptedSpam.md create mode 100644 old_docs/API_docs_v109/methods/messages.reportSpam.md create mode 100644 old_docs/API_docs_v109/methods/messages.requestEncryption.md create mode 100644 old_docs/API_docs_v109/methods/messages.requestUrlAuth.md create mode 100644 old_docs/API_docs_v109/methods/messages.saveDraft.md create mode 100644 old_docs/API_docs_v109/methods/messages.saveGif.md create mode 100644 old_docs/API_docs_v109/methods/messages.saveRecentSticker.md create mode 100644 old_docs/API_docs_v109/methods/messages.search.md create mode 100644 old_docs/API_docs_v109/methods/messages.searchGifs.md create mode 100644 old_docs/API_docs_v109/methods/messages.searchGlobal.md create mode 100644 old_docs/API_docs_v109/methods/messages.searchStickerSets.md create mode 100644 old_docs/API_docs_v109/methods/messages.sendEncrypted.md create mode 100644 old_docs/API_docs_v109/methods/messages.sendEncryptedFile.md create mode 100644 old_docs/API_docs_v109/methods/messages.sendEncryptedService.md create mode 100644 old_docs/API_docs_v109/methods/messages.sendInlineBotResult.md create mode 100644 old_docs/API_docs_v109/methods/messages.sendMedia.md create mode 100644 old_docs/API_docs_v109/methods/messages.sendMessage.md create mode 100644 old_docs/API_docs_v109/methods/messages.sendMultiMedia.md create mode 100644 old_docs/API_docs_v109/methods/messages.sendScheduledMessages.md create mode 100644 old_docs/API_docs_v109/methods/messages.sendScreenshotNotification.md create mode 100644 old_docs/API_docs_v109/methods/messages.sendVote.md create mode 100644 old_docs/API_docs_v109/methods/messages.setBotCallbackAnswer.md create mode 100644 old_docs/API_docs_v109/methods/messages.setBotPrecheckoutResults.md create mode 100644 old_docs/API_docs_v109/methods/messages.setBotShippingResults.md create mode 100644 old_docs/API_docs_v109/methods/messages.setEncryptedTyping.md create mode 100644 old_docs/API_docs_v109/methods/messages.setGameScore.md create mode 100644 old_docs/API_docs_v109/methods/messages.setInlineBotResults.md create mode 100644 old_docs/API_docs_v109/methods/messages.setInlineGameScore.md create mode 100644 old_docs/API_docs_v109/methods/messages.setTyping.md create mode 100644 old_docs/API_docs_v109/methods/messages.startBot.md create mode 100644 old_docs/API_docs_v109/methods/messages.toggleDialogPin.md create mode 100644 old_docs/API_docs_v109/methods/messages.uninstallStickerSet.md create mode 100644 old_docs/API_docs_v109/methods/messages.updatePinnedMessage.md create mode 100644 old_docs/API_docs_v109/methods/messages.uploadEncryptedFile.md create mode 100644 old_docs/API_docs_v109/methods/messages.uploadMedia.md create mode 100644 old_docs/API_docs_v109/methods/payments.clearSavedInfo.md create mode 100644 old_docs/API_docs_v109/methods/payments.getPaymentForm.md create mode 100644 old_docs/API_docs_v109/methods/payments.getPaymentReceipt.md create mode 100644 old_docs/API_docs_v109/methods/payments.getSavedInfo.md create mode 100644 old_docs/API_docs_v109/methods/payments.sendPaymentForm.md create mode 100644 old_docs/API_docs_v109/methods/payments.validateRequestedInfo.md create mode 100644 old_docs/API_docs_v109/methods/phone.acceptCall.md create mode 100644 old_docs/API_docs_v109/methods/phone.confirmCall.md create mode 100644 old_docs/API_docs_v109/methods/phone.discardCall.md create mode 100644 old_docs/API_docs_v109/methods/phone.getCallConfig.md create mode 100644 old_docs/API_docs_v109/methods/phone.receivedCall.md create mode 100644 old_docs/API_docs_v109/methods/phone.requestCall.md create mode 100644 old_docs/API_docs_v109/methods/phone.saveCallDebug.md create mode 100644 old_docs/API_docs_v109/methods/phone.setCallRating.md create mode 100644 old_docs/API_docs_v109/methods/photos.deletePhotos.md create mode 100644 old_docs/API_docs_v109/methods/photos.getUserPhotos.md create mode 100644 old_docs/API_docs_v109/methods/photos.updateProfilePhoto.md create mode 100644 old_docs/API_docs_v109/methods/photos.uploadProfilePhoto.md create mode 100644 old_docs/API_docs_v109/methods/stickers.addStickerToSet.md create mode 100644 old_docs/API_docs_v109/methods/stickers.changeStickerPosition.md create mode 100644 old_docs/API_docs_v109/methods/stickers.createStickerSet.md create mode 100644 old_docs/API_docs_v109/methods/stickers.removeStickerFromSet.md create mode 100644 old_docs/API_docs_v109/methods/updates.getChannelDifference.md create mode 100644 old_docs/API_docs_v109/methods/updates.getDifference.md create mode 100644 old_docs/API_docs_v109/methods/updates.getState.md create mode 100644 old_docs/API_docs_v109/methods/upload.getCdnFile.md create mode 100644 old_docs/API_docs_v109/methods/upload.getCdnFileHashes.md create mode 100644 old_docs/API_docs_v109/methods/upload.getFile.md create mode 100644 old_docs/API_docs_v109/methods/upload.getFileHashes.md create mode 100644 old_docs/API_docs_v109/methods/upload.getWebFile.md create mode 100644 old_docs/API_docs_v109/methods/upload.reuploadCdnFile.md create mode 100644 old_docs/API_docs_v109/methods/upload.saveBigFilePart.md create mode 100644 old_docs/API_docs_v109/methods/upload.saveFilePart.md create mode 100644 old_docs/API_docs_v109/methods/users.getFullUser.md create mode 100644 old_docs/API_docs_v109/methods/users.getUsers.md create mode 100644 old_docs/API_docs_v109/methods/users.setSecureValueErrors.md create mode 100644 old_docs/API_docs_v109/types/!X.md create mode 100644 old_docs/API_docs_v109/types/AccountDaysTTL.md create mode 100644 old_docs/API_docs_v109/types/Authorization.md create mode 100644 old_docs/API_docs_v109/types/AutoDownloadSettings.md create mode 100644 old_docs/API_docs_v109/types/BaseTheme.md create mode 100644 old_docs/API_docs_v109/types/Bool.md create mode 100644 old_docs/API_docs_v109/types/BotCommand.md create mode 100644 old_docs/API_docs_v109/types/BotInfo.md create mode 100644 old_docs/API_docs_v109/types/BotInlineMessage.md create mode 100644 old_docs/API_docs_v109/types/BotInlineResult.md create mode 100644 old_docs/API_docs_v109/types/CdnConfig.md create mode 100644 old_docs/API_docs_v109/types/CdnPublicKey.md create mode 100644 old_docs/API_docs_v109/types/ChannelAdminLogEvent.md create mode 100644 old_docs/API_docs_v109/types/ChannelAdminLogEventAction.md create mode 100644 old_docs/API_docs_v109/types/ChannelAdminLogEventsFilter.md create mode 100644 old_docs/API_docs_v109/types/ChannelLocation.md create mode 100644 old_docs/API_docs_v109/types/ChannelMessagesFilter.md create mode 100644 old_docs/API_docs_v109/types/ChannelParticipant.md create mode 100644 old_docs/API_docs_v109/types/ChannelParticipantsFilter.md create mode 100644 old_docs/API_docs_v109/types/Chat.md create mode 100644 old_docs/API_docs_v109/types/ChatAdminRights.md create mode 100644 old_docs/API_docs_v109/types/ChatBannedRights.md create mode 100644 old_docs/API_docs_v109/types/ChatFull.md create mode 100644 old_docs/API_docs_v109/types/ChatInvite.md create mode 100644 old_docs/API_docs_v109/types/ChatOnlines.md create mode 100644 old_docs/API_docs_v109/types/ChatParticipant.md create mode 100644 old_docs/API_docs_v109/types/ChatParticipants.md create mode 100644 old_docs/API_docs_v109/types/ChatPhoto.md create mode 100644 old_docs/API_docs_v109/types/CodeSettings.md create mode 100644 old_docs/API_docs_v109/types/Config.md create mode 100644 old_docs/API_docs_v109/types/Contact.md create mode 100644 old_docs/API_docs_v109/types/ContactBlocked.md create mode 100644 old_docs/API_docs_v109/types/ContactStatus.md create mode 100644 old_docs/API_docs_v109/types/DataJSON.md create mode 100644 old_docs/API_docs_v109/types/DcOption.md rename docs/API_docs/types/IpPort.md => old_docs/API_docs_v109/types/Dialog.md (56%) create mode 100644 old_docs/API_docs_v109/types/DialogPeer.md create mode 100644 old_docs/API_docs_v109/types/Document.md create mode 100644 old_docs/API_docs_v109/types/DocumentAttribute.md create mode 100644 old_docs/API_docs_v109/types/DraftMessage.md create mode 100644 old_docs/API_docs_v109/types/EmojiKeyword.md create mode 100644 old_docs/API_docs_v109/types/EmojiKeywordsDifference.md create mode 100644 old_docs/API_docs_v109/types/EmojiLanguage.md create mode 100644 old_docs/API_docs_v109/types/EmojiURL.md create mode 100644 old_docs/API_docs_v109/types/EncryptedChat.md create mode 100644 old_docs/API_docs_v109/types/EncryptedFile.md create mode 100644 old_docs/API_docs_v109/types/EncryptedMessage.md create mode 100644 old_docs/API_docs_v109/types/Error.md create mode 100644 old_docs/API_docs_v109/types/ExportedChatInvite.md create mode 100644 old_docs/API_docs_v109/types/ExportedMessageLink.md create mode 100644 old_docs/API_docs_v109/types/FileHash.md create mode 100644 old_docs/API_docs_v109/types/FileLocation.md create mode 100644 old_docs/API_docs_v109/types/Folder.md create mode 100644 old_docs/API_docs_v109/types/FolderPeer.md create mode 100644 old_docs/API_docs_v109/types/FoundGif.md create mode 100644 old_docs/API_docs_v109/types/Game.md create mode 100644 old_docs/API_docs_v109/types/GeoPoint.md create mode 100644 old_docs/API_docs_v109/types/HighScore.md create mode 100644 old_docs/API_docs_v109/types/ImportedContact.md create mode 100644 old_docs/API_docs_v109/types/InlineBotSwitchPM.md create mode 100644 old_docs/API_docs_v109/types/InputAppEvent.md create mode 100644 old_docs/API_docs_v109/types/InputBotInlineMessage.md create mode 100644 old_docs/API_docs_v109/types/InputBotInlineMessageID.md create mode 100644 old_docs/API_docs_v109/types/InputBotInlineResult.md create mode 100644 old_docs/API_docs_v109/types/InputChannel.md create mode 100644 old_docs/API_docs_v109/types/InputChatPhoto.md create mode 100644 old_docs/API_docs_v109/types/InputCheckPasswordSRP.md create mode 100644 old_docs/API_docs_v109/types/InputClientProxy.md create mode 100644 old_docs/API_docs_v109/types/InputContact.md create mode 100644 old_docs/API_docs_v109/types/InputDialogPeer.md create mode 100644 old_docs/API_docs_v109/types/InputDocument.md create mode 100644 old_docs/API_docs_v109/types/InputEncryptedChat.md create mode 100644 old_docs/API_docs_v109/types/InputEncryptedFile.md create mode 100644 old_docs/API_docs_v109/types/InputFile.md create mode 100644 old_docs/API_docs_v109/types/InputFileLocation.md create mode 100644 old_docs/API_docs_v109/types/InputFolderPeer.md create mode 100644 old_docs/API_docs_v109/types/InputGame.md create mode 100644 old_docs/API_docs_v109/types/InputGeoPoint.md create mode 100644 old_docs/API_docs_v109/types/InputMedia.md create mode 100644 old_docs/API_docs_v109/types/InputMessage.md create mode 100644 old_docs/API_docs_v109/types/InputNotifyPeer.md create mode 100644 old_docs/API_docs_v109/types/InputPaymentCredentials.md create mode 100644 old_docs/API_docs_v109/types/InputPeer.md create mode 100644 old_docs/API_docs_v109/types/InputPeerNotifySettings.md create mode 100644 old_docs/API_docs_v109/types/InputPhoneCall.md create mode 100644 old_docs/API_docs_v109/types/InputPhoto.md create mode 100644 old_docs/API_docs_v109/types/InputPrivacyKey.md create mode 100644 old_docs/API_docs_v109/types/InputPrivacyRule.md create mode 100644 old_docs/API_docs_v109/types/InputSecureFile.md create mode 100644 old_docs/API_docs_v109/types/InputSecureValue.md create mode 100644 old_docs/API_docs_v109/types/InputSingleMedia.md create mode 100644 old_docs/API_docs_v109/types/InputStickerSet.md create mode 100644 old_docs/API_docs_v109/types/InputStickerSetItem.md create mode 100644 old_docs/API_docs_v109/types/InputStickeredMedia.md create mode 100644 old_docs/API_docs_v109/types/InputTheme.md create mode 100644 old_docs/API_docs_v109/types/InputThemeSettings.md create mode 100644 old_docs/API_docs_v109/types/InputUser.md create mode 100644 old_docs/API_docs_v109/types/InputWallPaper.md create mode 100644 old_docs/API_docs_v109/types/InputWebDocument.md create mode 100644 old_docs/API_docs_v109/types/InputWebFileLocation.md create mode 100644 old_docs/API_docs_v109/types/Invoice.md create mode 100644 old_docs/API_docs_v109/types/JSONObjectValue.md create mode 100644 old_docs/API_docs_v109/types/JSONValue.md create mode 100644 old_docs/API_docs_v109/types/KeyboardButton.md create mode 100644 old_docs/API_docs_v109/types/KeyboardButtonRow.md create mode 100644 old_docs/API_docs_v109/types/LabeledPrice.md create mode 100644 old_docs/API_docs_v109/types/LangPackDifference.md create mode 100644 old_docs/API_docs_v109/types/LangPackLanguage.md create mode 100644 old_docs/API_docs_v109/types/LangPackString.md create mode 100644 old_docs/API_docs_v109/types/MaskCoords.md create mode 100644 old_docs/API_docs_v109/types/Message.md create mode 100644 old_docs/API_docs_v109/types/MessageAction.md create mode 100644 old_docs/API_docs_v109/types/MessageEntity.md create mode 100644 old_docs/API_docs_v109/types/MessageFwdHeader.md create mode 100644 old_docs/API_docs_v109/types/MessageMedia.md create mode 100644 old_docs/API_docs_v109/types/MessageRange.md create mode 100644 old_docs/API_docs_v109/types/MessageUserVote.md create mode 100644 old_docs/API_docs_v109/types/MessagesFilter.md create mode 100644 old_docs/API_docs_v109/types/NearestDc.md create mode 100644 old_docs/API_docs_v109/types/NotifyPeer.md create mode 100644 old_docs/API_docs_v109/types/Null.md create mode 100644 old_docs/API_docs_v109/types/Page.md create mode 100644 old_docs/API_docs_v109/types/PageBlock.md create mode 100644 old_docs/API_docs_v109/types/PageCaption.md create mode 100644 old_docs/API_docs_v109/types/PageListItem.md create mode 100644 old_docs/API_docs_v109/types/PageListOrderedItem.md create mode 100644 old_docs/API_docs_v109/types/PageRelatedArticle.md create mode 100644 old_docs/API_docs_v109/types/PageTableCell.md create mode 100644 old_docs/API_docs_v109/types/PageTableRow.md create mode 100644 old_docs/API_docs_v109/types/PasswordKdfAlgo.md create mode 100644 old_docs/API_docs_v109/types/PaymentCharge.md create mode 100644 old_docs/API_docs_v109/types/PaymentRequestedInfo.md create mode 100644 old_docs/API_docs_v109/types/PaymentSavedCredentials.md create mode 100644 old_docs/API_docs_v109/types/Peer.md create mode 100644 old_docs/API_docs_v109/types/PeerLocated.md create mode 100644 old_docs/API_docs_v109/types/PeerNotifySettings.md create mode 100644 old_docs/API_docs_v109/types/PeerSettings.md create mode 100644 old_docs/API_docs_v109/types/PhoneCall.md create mode 100644 old_docs/API_docs_v109/types/PhoneCallDiscardReason.md create mode 100644 old_docs/API_docs_v109/types/PhoneCallProtocol.md create mode 100644 old_docs/API_docs_v109/types/PhoneConnection.md create mode 100644 old_docs/API_docs_v109/types/Photo.md create mode 100644 old_docs/API_docs_v109/types/PhotoSize.md create mode 100644 old_docs/API_docs_v109/types/Poll.md create mode 100644 old_docs/API_docs_v109/types/PollAnswer.md create mode 100644 old_docs/API_docs_v109/types/PollAnswerVoters.md create mode 100644 old_docs/API_docs_v109/types/PollResults.md create mode 100644 old_docs/API_docs_v109/types/PopularContact.md create mode 100644 old_docs/API_docs_v109/types/PostAddress.md create mode 100644 old_docs/API_docs_v109/types/PrivacyKey.md create mode 100644 old_docs/API_docs_v109/types/PrivacyRule.md create mode 100644 old_docs/API_docs_v109/types/README.md create mode 100644 old_docs/API_docs_v109/types/ReceivedNotifyMessage.md create mode 100644 old_docs/API_docs_v109/types/RecentMeUrl.md create mode 100644 old_docs/API_docs_v109/types/ReplyMarkup.md create mode 100644 old_docs/API_docs_v109/types/ReportReason.md create mode 100644 old_docs/API_docs_v109/types/RestrictionReason.md create mode 100644 old_docs/API_docs_v109/types/RichText.md create mode 100644 old_docs/API_docs_v109/types/SavedContact.md create mode 100644 old_docs/API_docs_v109/types/SecureCredentialsEncrypted.md create mode 100644 old_docs/API_docs_v109/types/SecureData.md create mode 100644 old_docs/API_docs_v109/types/SecureFile.md create mode 100644 old_docs/API_docs_v109/types/SecurePasswordKdfAlgo.md create mode 100644 old_docs/API_docs_v109/types/SecurePlainData.md create mode 100644 old_docs/API_docs_v109/types/SecureRequiredType.md create mode 100644 old_docs/API_docs_v109/types/SecureSecretSettings.md create mode 100644 old_docs/API_docs_v109/types/SecureValue.md create mode 100644 old_docs/API_docs_v109/types/SecureValueError.md create mode 100644 old_docs/API_docs_v109/types/SecureValueHash.md create mode 100644 old_docs/API_docs_v109/types/SecureValueType.md create mode 100644 old_docs/API_docs_v109/types/SendMessageAction.md create mode 100644 old_docs/API_docs_v109/types/ShippingOption.md create mode 100644 old_docs/API_docs_v109/types/StatsURL.md create mode 100644 old_docs/API_docs_v109/types/StickerPack.md create mode 100644 old_docs/API_docs_v109/types/StickerSet.md create mode 100644 old_docs/API_docs_v109/types/StickerSetCovered.md create mode 100644 old_docs/API_docs_v109/types/Theme.md create mode 100644 old_docs/API_docs_v109/types/ThemeSettings.md create mode 100644 old_docs/API_docs_v109/types/TopPeer.md create mode 100644 old_docs/API_docs_v109/types/TopPeerCategory.md create mode 100644 old_docs/API_docs_v109/types/TopPeerCategoryPeers.md create mode 100644 old_docs/API_docs_v109/types/True.md create mode 100644 old_docs/API_docs_v109/types/Update.md create mode 100644 old_docs/API_docs_v109/types/Updates.md create mode 100644 old_docs/API_docs_v109/types/UrlAuthResult.md create mode 100644 old_docs/API_docs_v109/types/User.md create mode 100644 old_docs/API_docs_v109/types/UserFull.md create mode 100644 old_docs/API_docs_v109/types/UserProfilePhoto.md create mode 100644 old_docs/API_docs_v109/types/UserStatus.md create mode 100644 old_docs/API_docs_v109/types/WallPaper.md create mode 100644 old_docs/API_docs_v109/types/WallPaperSettings.md create mode 100644 old_docs/API_docs_v109/types/WebAuthorization.md create mode 100644 old_docs/API_docs_v109/types/WebDocument.md create mode 100644 old_docs/API_docs_v109/types/WebPage.md create mode 100644 old_docs/API_docs_v109/types/WebPageAttribute.md create mode 100644 old_docs/API_docs_v109/types/X.md create mode 100644 old_docs/API_docs_v109/types/account.AuthorizationForm.md create mode 100644 old_docs/API_docs_v109/types/account.Authorizations.md create mode 100644 old_docs/API_docs_v109/types/account.AutoDownloadSettings.md create mode 100644 old_docs/API_docs_v109/types/account.ContentSettings.md create mode 100644 old_docs/API_docs_v109/types/account.Password.md create mode 100644 old_docs/API_docs_v109/types/account.PasswordInputSettings.md create mode 100644 old_docs/API_docs_v109/types/account.PasswordSettings.md create mode 100644 old_docs/API_docs_v109/types/account.PrivacyRules.md create mode 100644 old_docs/API_docs_v109/types/account.SentEmailCode.md create mode 100644 old_docs/API_docs_v109/types/account.Takeout.md create mode 100644 old_docs/API_docs_v109/types/account.Themes.md create mode 100644 old_docs/API_docs_v109/types/account.TmpPassword.md create mode 100644 old_docs/API_docs_v109/types/account.WallPapers.md create mode 100644 old_docs/API_docs_v109/types/account.WebAuthorizations.md create mode 100644 old_docs/API_docs_v109/types/auth.Authorization.md create mode 100644 old_docs/API_docs_v109/types/auth.CodeType.md create mode 100644 old_docs/API_docs_v109/types/auth.ExportedAuthorization.md create mode 100644 old_docs/API_docs_v109/types/auth.LoginToken.md create mode 100644 old_docs/API_docs_v109/types/auth.PasswordRecovery.md create mode 100644 old_docs/API_docs_v109/types/auth.SentCode.md create mode 100644 old_docs/API_docs_v109/types/auth.SentCodeType.md create mode 100644 old_docs/API_docs_v109/types/bytes.md create mode 100644 old_docs/API_docs_v109/types/channels.AdminLogResults.md create mode 100644 old_docs/API_docs_v109/types/channels.ChannelParticipant.md create mode 100644 old_docs/API_docs_v109/types/channels.ChannelParticipants.md create mode 100644 old_docs/API_docs_v109/types/contacts.Blocked.md create mode 100644 old_docs/API_docs_v109/types/contacts.Contacts.md create mode 100644 old_docs/API_docs_v109/types/contacts.Found.md create mode 100644 old_docs/API_docs_v109/types/contacts.ImportedContacts.md create mode 100644 old_docs/API_docs_v109/types/contacts.ResolvedPeer.md create mode 100644 old_docs/API_docs_v109/types/contacts.TopPeers.md create mode 100644 old_docs/API_docs_v109/types/double.md create mode 100644 old_docs/API_docs_v109/types/help.AppUpdate.md create mode 100644 old_docs/API_docs_v109/types/help.DeepLinkInfo.md create mode 100644 old_docs/API_docs_v109/types/help.InviteText.md create mode 100644 old_docs/API_docs_v109/types/help.PassportConfig.md create mode 100644 old_docs/API_docs_v109/types/help.ProxyData.md create mode 100644 old_docs/API_docs_v109/types/help.RecentMeUrls.md create mode 100644 old_docs/API_docs_v109/types/help.Support.md create mode 100644 old_docs/API_docs_v109/types/help.SupportName.md create mode 100644 old_docs/API_docs_v109/types/help.TermsOfService.md create mode 100644 old_docs/API_docs_v109/types/help.TermsOfServiceUpdate.md create mode 100644 old_docs/API_docs_v109/types/help.UserInfo.md create mode 100644 old_docs/API_docs_v109/types/int.md create mode 100644 old_docs/API_docs_v109/types/int128.md create mode 100644 old_docs/API_docs_v109/types/int256.md create mode 100644 old_docs/API_docs_v109/types/int512.md create mode 100644 old_docs/API_docs_v109/types/int53.md create mode 100644 old_docs/API_docs_v109/types/long.md create mode 100644 old_docs/API_docs_v109/types/messages.AffectedHistory.md create mode 100644 old_docs/API_docs_v109/types/messages.AffectedMessages.md create mode 100644 old_docs/API_docs_v109/types/messages.AllStickers.md create mode 100644 old_docs/API_docs_v109/types/messages.ArchivedStickers.md create mode 100644 old_docs/API_docs_v109/types/messages.BotCallbackAnswer.md create mode 100644 old_docs/API_docs_v109/types/messages.BotResults.md create mode 100644 old_docs/API_docs_v109/types/messages.ChatFull.md create mode 100644 old_docs/API_docs_v109/types/messages.Chats.md create mode 100644 old_docs/API_docs_v109/types/messages.DhConfig.md create mode 100644 old_docs/API_docs_v109/types/messages.Dialogs.md create mode 100644 old_docs/API_docs_v109/types/messages.FavedStickers.md create mode 100644 old_docs/API_docs_v109/types/messages.FeaturedStickers.md create mode 100644 old_docs/API_docs_v109/types/messages.FoundGifs.md create mode 100644 old_docs/API_docs_v109/types/messages.FoundStickerSets.md create mode 100644 old_docs/API_docs_v109/types/messages.HighScores.md create mode 100644 old_docs/API_docs_v109/types/messages.InactiveChats.md create mode 100644 old_docs/API_docs_v109/types/messages.MessageEditData.md create mode 100644 old_docs/API_docs_v109/types/messages.Messages.md create mode 100644 old_docs/API_docs_v109/types/messages.PeerDialogs.md create mode 100644 old_docs/API_docs_v109/types/messages.RecentStickers.md create mode 100644 old_docs/API_docs_v109/types/messages.SavedGifs.md create mode 100644 old_docs/API_docs_v109/types/messages.SearchCounter.md create mode 100644 old_docs/API_docs_v109/types/messages.SentEncryptedMessage.md create mode 100644 old_docs/API_docs_v109/types/messages.StickerSet.md create mode 100644 old_docs/API_docs_v109/types/messages.StickerSetInstallResult.md create mode 100644 old_docs/API_docs_v109/types/messages.Stickers.md create mode 100644 old_docs/API_docs_v109/types/messages.VotesList.md create mode 100644 old_docs/API_docs_v109/types/payments.PaymentForm.md create mode 100644 old_docs/API_docs_v109/types/payments.PaymentReceipt.md create mode 100644 old_docs/API_docs_v109/types/payments.PaymentResult.md create mode 100644 old_docs/API_docs_v109/types/payments.SavedInfo.md create mode 100644 old_docs/API_docs_v109/types/payments.ValidatedRequestedInfo.md create mode 100644 old_docs/API_docs_v109/types/phone.PhoneCall.md create mode 100644 old_docs/API_docs_v109/types/photos.Photo.md create mode 100644 old_docs/API_docs_v109/types/photos.Photos.md create mode 100644 old_docs/API_docs_v109/types/storage.FileType.md create mode 100644 old_docs/API_docs_v109/types/string.md create mode 100644 old_docs/API_docs_v109/types/updates.ChannelDifference.md create mode 100644 old_docs/API_docs_v109/types/updates.Difference.md create mode 100644 old_docs/API_docs_v109/types/updates.State.md create mode 100644 old_docs/API_docs_v109/types/upload.CdnFile.md create mode 100644 old_docs/API_docs_v109/types/upload.File.md create mode 100644 old_docs/API_docs_v109/types/upload.WebFile.md diff --git a/docs/API_docs/constructors/accessPointRule.md b/docs/API_docs/constructors/accessPointRule.md deleted file mode 100644 index d95c3421..00000000 --- a/docs/API_docs/constructors/accessPointRule.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: accessPointRule -description: Access point rule -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: accessPointRule -[Back to constructors index](index.md) - - - -Access point rule - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_prefix\_rules|[string](../types/string.md) | Yes|Phone prefix rules| -|dc\_id|[int](../types/int.md) | Yes|DC ID| -|ips|Array of [IpPort](../types/IpPort.md) | Yes|Ips| - - - -### Type: [AccessPointRule](../types/AccessPointRule.md) - - -### Example: - -```php -$accessPointRule = ['_' => 'accessPointRule', 'phone_prefix_rules' => 'string', 'dc_id' => int, 'ips' => [IpPort, IpPort]]; -``` - - -Or, if you're into Lua: - -```lua -accessPointRule={_='accessPointRule', phone_prefix_rules='string', dc_id=int, ips={IpPort}} - -``` - - diff --git a/docs/API_docs/constructors/account.contentSettings.md b/docs/API_docs/constructors/account.contentSettings.md new file mode 100644 index 00000000..3ff1948d --- /dev/null +++ b/docs/API_docs/constructors/account.contentSettings.md @@ -0,0 +1,38 @@ +--- +title: account.contentSettings +description: account.contentSettings attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_contentSettings.html +--- +# Constructor: account.contentSettings +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|sensitive\_enabled|[Bool](../types/Bool.md) | Optional| +|sensitive\_can\_change|[Bool](../types/Bool.md) | Optional| + + + +### Type: [account.ContentSettings](../types/account.ContentSettings.md) + + +### Example: + +```php +$account.contentSettings = ['_' => 'account.contentSettings', 'sensitive_enabled' => Bool, 'sensitive_can_change' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +account.contentSettings={_='account.contentSettings', sensitive_enabled=Bool, sensitive_can_change=Bool} + +``` + + diff --git a/docs/API_docs/constructors/auth.loginToken.md b/docs/API_docs/constructors/auth.loginToken.md new file mode 100644 index 00000000..82828717 --- /dev/null +++ b/docs/API_docs/constructors/auth.loginToken.md @@ -0,0 +1,38 @@ +--- +title: auth.loginToken +description: auth.loginToken attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_loginToken.html +--- +# Constructor: auth.loginToken +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|expires|[int](../types/int.md) | Yes| +|token|[bytes](../types/bytes.md) | Yes| + + + +### Type: [auth.LoginToken](../types/auth.LoginToken.md) + + +### Example: + +```php +$auth.loginToken = ['_' => 'auth.loginToken', 'expires' => int, 'token' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +auth.loginToken={_='auth.loginToken', expires=int, token='bytes'} + +``` + + diff --git a/docs/API_docs/constructors/auth.loginTokenMigrateTo.md b/docs/API_docs/constructors/auth.loginTokenMigrateTo.md new file mode 100644 index 00000000..8bde1662 --- /dev/null +++ b/docs/API_docs/constructors/auth.loginTokenMigrateTo.md @@ -0,0 +1,38 @@ +--- +title: auth.loginTokenMigrateTo +description: auth.loginTokenMigrateTo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_loginTokenMigrateTo.html +--- +# Constructor: auth.loginTokenMigrateTo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|dc\_id|[int](../types/int.md) | Yes| +|token|[bytes](../types/bytes.md) | Yes| + + + +### Type: [auth.LoginToken](../types/auth.LoginToken.md) + + +### Example: + +```php +$auth.loginTokenMigrateTo = ['_' => 'auth.loginTokenMigrateTo', 'dc_id' => int, 'token' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +auth.loginTokenMigrateTo={_='auth.loginTokenMigrateTo', dc_id=int, token='bytes'} + +``` + + diff --git a/docs/API_docs/constructors/auth.loginTokenSuccess.md b/docs/API_docs/constructors/auth.loginTokenSuccess.md new file mode 100644 index 00000000..94eb3d9c --- /dev/null +++ b/docs/API_docs/constructors/auth.loginTokenSuccess.md @@ -0,0 +1,37 @@ +--- +title: auth.loginTokenSuccess +description: auth.loginTokenSuccess attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_loginTokenSuccess.html +--- +# Constructor: auth.loginTokenSuccess +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|authorization|[auth.Authorization](../constructors/auth.Authorization.md) | Yes| + + + +### Type: [auth.LoginToken](../types/auth.LoginToken.md) + + +### Example: + +```php +$auth.loginTokenSuccess = ['_' => 'auth.loginTokenSuccess', 'authorization' => auth.Authorization]; +``` + + +Or, if you're into Lua: + +```lua +auth.loginTokenSuccess={_='auth.loginTokenSuccess', authorization=auth.Authorization} + +``` + + diff --git a/docs/API_docs/constructors/autoDownloadSettings.md b/docs/API_docs/constructors/autoDownloadSettings.md index 9f2a535e..64f83144 100644 --- a/docs/API_docs/constructors/autoDownloadSettings.md +++ b/docs/API_docs/constructors/autoDownloadSettings.md @@ -21,6 +21,7 @@ Autodownload settings |photo\_size\_max|[int](../types/int.md) | Yes|Maximum size of photos to preload| |video\_size\_max|[int](../types/int.md) | Yes|Maximum size of videos to preload| |file\_size\_max|[int](../types/int.md) | Yes|Maximum size of other files to preload| +|video\_upload\_maxbitrate|[int](../types/int.md) | Yes|| @@ -30,14 +31,14 @@ Autodownload settings ### Example: ```php -$autoDownloadSettings = ['_' => 'autoDownloadSettings', 'disabled' => Bool, 'video_preload_large' => Bool, 'audio_preload_next' => Bool, 'phonecalls_less_data' => Bool, 'photo_size_max' => int, 'video_size_max' => int, 'file_size_max' => int]; +$autoDownloadSettings = ['_' => 'autoDownloadSettings', 'disabled' => Bool, 'video_preload_large' => Bool, 'audio_preload_next' => Bool, 'phonecalls_less_data' => Bool, 'photo_size_max' => int, 'video_size_max' => int, 'file_size_max' => int, 'video_upload_maxbitrate' => int]; ``` Or, if you're into Lua: ```lua -autoDownloadSettings={_='autoDownloadSettings', disabled=Bool, video_preload_large=Bool, audio_preload_next=Bool, phonecalls_less_data=Bool, photo_size_max=int, video_size_max=int, file_size_max=int} +autoDownloadSettings={_='autoDownloadSettings', disabled=Bool, video_preload_large=Bool, audio_preload_next=Bool, phonecalls_less_data=Bool, photo_size_max=int, video_size_max=int, file_size_max=int, video_upload_maxbitrate=int} ``` diff --git a/docs/API_docs/constructors/baseThemeArctic.md b/docs/API_docs/constructors/baseThemeArctic.md new file mode 100644 index 00000000..38a27268 --- /dev/null +++ b/docs/API_docs/constructors/baseThemeArctic.md @@ -0,0 +1,31 @@ +--- +title: baseThemeArctic +description: baseThemeArctic attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeArctic +[Back to constructors index](index.md) + + + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeArctic = ['_' => 'baseThemeArctic']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeArctic={_='baseThemeArctic'} + +``` + + diff --git a/docs/API_docs/constructors/baseThemeClassic.md b/docs/API_docs/constructors/baseThemeClassic.md new file mode 100644 index 00000000..7a1760e1 --- /dev/null +++ b/docs/API_docs/constructors/baseThemeClassic.md @@ -0,0 +1,31 @@ +--- +title: baseThemeClassic +description: baseThemeClassic attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeClassic +[Back to constructors index](index.md) + + + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeClassic = ['_' => 'baseThemeClassic']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeClassic={_='baseThemeClassic'} + +``` + + diff --git a/docs/API_docs/constructors/baseThemeDay.md b/docs/API_docs/constructors/baseThemeDay.md new file mode 100644 index 00000000..0928893b --- /dev/null +++ b/docs/API_docs/constructors/baseThemeDay.md @@ -0,0 +1,31 @@ +--- +title: baseThemeDay +description: baseThemeDay attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeDay +[Back to constructors index](index.md) + + + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeDay = ['_' => 'baseThemeDay']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeDay={_='baseThemeDay'} + +``` + + diff --git a/docs/API_docs/constructors/baseThemeNight.md b/docs/API_docs/constructors/baseThemeNight.md new file mode 100644 index 00000000..90ff56a1 --- /dev/null +++ b/docs/API_docs/constructors/baseThemeNight.md @@ -0,0 +1,31 @@ +--- +title: baseThemeNight +description: baseThemeNight attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeNight +[Back to constructors index](index.md) + + + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeNight = ['_' => 'baseThemeNight']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeNight={_='baseThemeNight'} + +``` + + diff --git a/docs/API_docs/constructors/baseThemeTinted.md b/docs/API_docs/constructors/baseThemeTinted.md new file mode 100644 index 00000000..c7a2d898 --- /dev/null +++ b/docs/API_docs/constructors/baseThemeTinted.md @@ -0,0 +1,31 @@ +--- +title: baseThemeTinted +description: baseThemeTinted attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeTinted +[Back to constructors index](index.md) + + + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeTinted = ['_' => 'baseThemeTinted']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeTinted={_='baseThemeTinted'} + +``` + + diff --git a/docs/API_docs/constructors/help.configSimple.md b/docs/API_docs/constructors/help.configSimple.md deleted file mode 100644 index 3eae1c9e..00000000 --- a/docs/API_docs/constructors/help.configSimple.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: help.configSimple -description: Config simple -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/constructors/help_configSimple.html ---- -# Constructor: help.configSimple -[Back to constructors index](index.md) - - - -Config simple - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|date|[int](../types/int.md) | Yes|Date| -|expires|[int](../types/int.md) | Yes|Expires| -|rules|Array of [AccessPointRule](../types/AccessPointRule.md) | Yes|Rules| - - - -### Type: [help.ConfigSimple](../types/help.ConfigSimple.md) - - -### Example: - -```php -$help.configSimple = ['_' => 'help.configSimple', 'date' => int, 'expires' => int, 'rules' => [AccessPointRule, AccessPointRule]]; -``` - - -Or, if you're into Lua: - -```lua -help.configSimple={_='help.configSimple', date=int, expires=int, rules={AccessPointRule}} - -``` - - diff --git a/docs/API_docs/constructors/index.md b/docs/API_docs/constructors/index.md index 08cf9f6b..39b8b7bd 100644 --- a/docs/API_docs/constructors/index.md +++ b/docs/API_docs/constructors/index.md @@ -6,9 +6,6 @@ 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)\], \]; - ***

[$account.authorizationForm](../constructors/account.authorizationForm.md) = \['required_types' => \[[SecureRequiredType](../types/SecureRequiredType.md)\], 'values' => \[[SecureValue](../types/SecureValue.md)\], 'errors' => \[[SecureValueError](../types/SecureValueError.md)\], 'users' => \[[User](../types/User.md)\], 'privacy_policy_url' => [string](../types/string.md), \]; @@ -18,6 +15,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

[$account.autoDownloadSettings](../constructors/account.autoDownloadSettings.md) = \['low' => [AutoDownloadSettings](../types/AutoDownloadSettings.md), 'medium' => [AutoDownloadSettings](../types/AutoDownloadSettings.md), 'high' => [AutoDownloadSettings](../types/AutoDownloadSettings.md), \]; +*** +

[$account.contentSettings](../constructors/account.contentSettings.md) = \['sensitive_enabled' => [Bool](../types/Bool.md), 'sensitive_can_change' => [Bool](../types/Bool.md), \]; + ***

[$account.password](../constructors/account.password.md) = \['has_recovery' => [Bool](../types/Bool.md), 'has_secure_values' => [Bool](../types/Bool.md), 'has_password' => [Bool](../types/Bool.md), 'current_algo' => [PasswordKdfAlgo](../types/PasswordKdfAlgo.md), 'srp_B' => [bytes](../types/bytes.md), 'srp_id' => [long](../types/long.md), 'hint' => [string](../types/string.md), 'email_unconfirmed_pattern' => [string](../types/string.md), 'new_algo' => [PasswordKdfAlgo](../types/PasswordKdfAlgo.md), 'new_secure_algo' => [SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md), 'secure_random' => [bytes](../types/bytes.md), \]; @@ -75,6 +75,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

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

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

[$auth.loginTokenMigrateTo](../constructors/auth.loginTokenMigrateTo.md) = \['dc_id' => [int](../types/int.md), 'token' => [bytes](../types/bytes.md), \]; + +*** +

[$auth.loginTokenSuccess](../constructors/auth.loginTokenSuccess.md) = \['authorization' => [auth.Authorization](../types/auth.Authorization.md), \]; + ***

[$auth.passwordRecovery](../constructors/auth.passwordRecovery.md) = \['email_pattern' => [string](../types/string.md), \]; @@ -97,7 +106,22 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

[$authorization](../constructors/authorization.md) = \['current' => [Bool](../types/Bool.md), 'official_app' => [Bool](../types/Bool.md), 'password_pending' => [Bool](../types/Bool.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), \]; *** -

[$autoDownloadSettings](../constructors/autoDownloadSettings.md) = \['disabled' => [Bool](../types/Bool.md), 'video_preload_large' => [Bool](../types/Bool.md), 'audio_preload_next' => [Bool](../types/Bool.md), 'phonecalls_less_data' => [Bool](../types/Bool.md), 'photo_size_max' => [int](../types/int.md), 'video_size_max' => [int](../types/int.md), 'file_size_max' => [int](../types/int.md), \]; +

[$autoDownloadSettings](../constructors/autoDownloadSettings.md) = \['disabled' => [Bool](../types/Bool.md), 'video_preload_large' => [Bool](../types/Bool.md), 'audio_preload_next' => [Bool](../types/Bool.md), 'phonecalls_less_data' => [Bool](../types/Bool.md), 'photo_size_max' => [int](../types/int.md), 'video_size_max' => [int](../types/int.md), 'file_size_max' => [int](../types/int.md), 'video_upload_maxbitrate' => [int](../types/int.md), \]; + +*** +

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

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

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

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

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

[$boolFalse](../constructors/boolFalse.md) = \[\]; @@ -591,9 +615,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

[$help.appUpdate](../constructors/help.appUpdate.md) = \['can_not_skip' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'version' => [string](../types/string.md), 'text' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'document' => [Document](../types/Document.md), 'url' => [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)\], \]; @@ -808,7 +829,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

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

[$inputMediaPoll](../constructors/inputMediaPoll.md) = \['poll' => [Poll](../types/Poll.md), \]; +

[$inputMediaPoll](../constructors/inputMediaPoll.md) = \['poll' => [Poll](../types/Poll.md), 'correct_answers' => \[[bytes](../types/bytes.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), \]; @@ -945,6 +966,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

[$inputPhotoFileLocation](../constructors/inputPhotoFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'thumb_size' => [string](../types/string.md), \]; +*** +

[$inputPhotoLegacyFileLocation](../constructors/inputPhotoLegacyFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), 'secret' => [long](../types/long.md), \]; + ***

[$inputPrivacyKeyAddedByPhone](../constructors/inputPrivacyKeyAddedByPhone.md) = \[\]; @@ -1059,6 +1083,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

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

[$inputThemeSettings](../constructors/inputThemeSettings.md) = \['base_theme' => [BaseTheme](../types/BaseTheme.md), 'accent_color' => [int](../types/int.md), 'message_top_color' => [int](../types/int.md), 'message_bottom_color' => [int](../types/int.md), 'wallpaper' => [InputWallPaper](../types/InputWallPaper.md), 'wallpaper_settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]; + ***

[$inputThemeSlug](../constructors/inputThemeSlug.md) = \['slug' => [string](../types/string.md), \]; @@ -1077,6 +1104,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

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

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

[$inputWallPaperSlug](../constructors/inputWallPaperSlug.md) = \['slug' => [string](../types/string.md), \]; @@ -1092,12 +1122,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

[$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), \]; - ***

[$jsonArray](../constructors/jsonArray.md) = \['value' => \[[JSONValue](../types/JSONValue.md)\], \]; @@ -1137,6 +1161,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

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

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

[$keyboardButtonRow](../constructors/keyboardButtonRow.md) = \['buttons' => \[[KeyboardButton](../types/KeyboardButton.md)\], \]; @@ -1341,6 +1368,15 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

[$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), 'legacy' => [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), \]; +*** +

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

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

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

[$messages.affectedHistory](../constructors/messages.affectedHistory.md) = \['pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), 'offset' => [int](../types/int.md), \]; @@ -1413,6 +1449,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

[$messages.highScores](../constructors/messages.highScores.md) = \['scores' => \[[HighScore](../types/HighScore.md)\], 'users' => \[[User](../types/User.md)\], \]; +*** +

[$messages.inactiveChats](../constructors/messages.inactiveChats.md) = \['dates' => \[[int](../types/int.md)\], 'chats' => \[[Chat](../types/Chat.md)\], 'users' => \[[User](../types/User.md)\], \]; + ***

[$messages.messageEditData](../constructors/messages.messageEditData.md) = \['caption' => [Bool](../types/Bool.md), \]; @@ -1464,6 +1503,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

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

[$messages.votesList](../constructors/messages.votesList.md) = \['count' => [int](../types/int.md), 'votes' => \[[MessageUserVote](../types/MessageUserVote.md)\], 'users' => \[[User](../types/User.md)\], 'next_offset' => [string](../types/string.md), \]; + ***

[$nearestDc](../constructors/nearestDc.md) = \['country' => [string](../types/string.md), 'this_dc' => [int](../types/int.md), 'nearest_dc' => [int](../types/int.md), \]; @@ -1714,16 +1756,16 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

[$photos.photosSlice](../constructors/photos.photosSlice.md) = \['count' => [int](../types/int.md), 'photos' => \[[Photo](../types/Photo.md)\], 'users' => \[[User](../types/User.md)\], \]; *** -

[$poll](../constructors/poll.md) = \['id' => [long](../types/long.md), 'closed' => [Bool](../types/Bool.md), 'question' => [string](../types/string.md), 'answers' => \[[PollAnswer](../types/PollAnswer.md)\], \]; +

[$poll](../constructors/poll.md) = \['id' => [long](../types/long.md), 'closed' => [Bool](../types/Bool.md), 'public_voters' => [Bool](../types/Bool.md), 'multiple_choice' => [Bool](../types/Bool.md), 'quiz' => [Bool](../types/Bool.md), 'question' => [string](../types/string.md), 'answers' => \[[PollAnswer](../types/PollAnswer.md)\], \]; ***

[$pollAnswer](../constructors/pollAnswer.md) = \['text' => [string](../types/string.md), 'option' => [bytes](../types/bytes.md), \]; *** -

[$pollAnswerVoters](../constructors/pollAnswerVoters.md) = \['chosen' => [Bool](../types/Bool.md), 'option' => [bytes](../types/bytes.md), 'voters' => [int](../types/int.md), \]; +

[$pollAnswerVoters](../constructors/pollAnswerVoters.md) = \['chosen' => [Bool](../types/Bool.md), 'correct' => [Bool](../types/Bool.md), 'option' => [bytes](../types/bytes.md), 'voters' => [int](../types/int.md), \]; *** -

[$pollResults](../constructors/pollResults.md) = \['min' => [Bool](../types/Bool.md), 'results' => \[[PollAnswerVoters](../types/PollAnswerVoters.md)\], 'total_voters' => [int](../types/int.md), \]; +

[$pollResults](../constructors/pollResults.md) = \['min' => [Bool](../types/Bool.md), 'results' => \[[PollAnswerVoters](../types/PollAnswerVoters.md)\], 'total_voters' => [int](../types/int.md), 'recent_voters' => \[[int](../types/int.md)\], \]; ***

[$popularContact](../constructors/popularContact.md) = \['client_id' => [long](../types/long.md), 'importers' => [int](../types/int.md), \]; @@ -2062,10 +2104,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

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

[$theme](../constructors/theme.md) = \['creator' => [Bool](../types/Bool.md), 'default' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [Document](../types/Document.md), 'installs_count' => [int](../types/int.md), \]; +

[$theme](../constructors/theme.md) = \['creator' => [Bool](../types/Bool.md), 'default' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [Document](../types/Document.md), 'settings' => [ThemeSettings](../types/ThemeSettings.md), 'installs_count' => [int](../types/int.md), \]; *** -

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

[$themeSettings](../constructors/themeSettings.md) = \['base_theme' => [BaseTheme](../types/BaseTheme.md), 'accent_color' => [int](../types/int.md), 'message_top_color' => [int](../types/int.md), 'message_bottom_color' => [int](../types/int.md), 'wallpaper' => [WallPaper](../types/WallPaper.md), \]; ***

[$topPeer](../constructors/topPeer.md) = \['peer' => [Peer](../types/Peer.md), 'rating' => [double](../types/double.md), \]; @@ -2211,6 +2253,9 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

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

[$updateGeoLiveViewed](../constructors/updateGeoLiveViewed.md) = \['peer' => [Peer](../types/Peer.md), 'msg_id' => [int](../types/int.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), \]; @@ -2220,12 +2265,18 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ***

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

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

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

[$updateMessagePoll](../constructors/updateMessagePoll.md) = \['poll_id' => [long](../types/long.md), 'poll' => [Poll](../types/Poll.md), 'results' => [PollResults](../types/PollResults.md), \]; +*** +

[$updateMessagePollVote](../constructors/updateMessagePollVote.md) = \['poll_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'options' => \[[bytes](../types/bytes.md)\], \]; + ***

[$updateNewChannelMessage](../constructors/updateNewChannelMessage.md) = \['message' => [Message](../types/Message.md), 'pts' => [int](../types/int.md), 'pts_count' => [int](../types/int.md), \]; @@ -2428,7 +2479,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

[$wallPaper](../constructors/wallPaper.md) = \['id' => [long](../types/long.md), 'creator' => [Bool](../types/Bool.md), 'default' => [Bool](../types/Bool.md), 'pattern' => [Bool](../types/Bool.md), 'dark' => [Bool](../types/Bool.md), 'access_hash' => [long](../types/long.md), 'slug' => [string](../types/string.md), 'document' => [Document](../types/Document.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]; *** -

[$wallPaperSettings](../constructors/wallPaperSettings.md) = \['blur' => [Bool](../types/Bool.md), 'motion' => [Bool](../types/Bool.md), 'background_color' => [int](../types/int.md), 'intensity' => [int](../types/int.md), \]; +

[$wallPaperNoFile](../constructors/wallPaperNoFile.md) = \['default' => [Bool](../types/Bool.md), 'dark' => [Bool](../types/Bool.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]; + +*** +

[$wallPaperSettings](../constructors/wallPaperSettings.md) = \['blur' => [Bool](../types/Bool.md), 'motion' => [Bool](../types/Bool.md), 'background_color' => [int](../types/int.md), 'second_background_color' => [int](../types/int.md), 'intensity' => [int](../types/int.md), 'rotation' => [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), \]; @@ -2440,7 +2494,10 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

[$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), 'documents' => \[[Document](../types/Document.md)\], 'cached_page' => [Page](../types/Page.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), 'attributes' => \[[WebPageAttribute](../types/WebPageAttribute.md)\], \]; + +*** +

[$webPageAttributeTheme](../constructors/webPageAttributeTheme.md) = \['documents' => \[[Document](../types/Document.md)\], 'settings' => [ThemeSettings](../types/ThemeSettings.md), \]; ***

[$webPageEmpty](../constructors/webPageEmpty.md) = \['id' => [long](../types/long.md), \]; diff --git a/docs/API_docs/constructors/inputMediaPoll.md b/docs/API_docs/constructors/inputMediaPoll.md index 76144125..1ac336ad 100644 --- a/docs/API_docs/constructors/inputMediaPoll.md +++ b/docs/API_docs/constructors/inputMediaPoll.md @@ -15,6 +15,7 @@ A poll | Name | Type | Required | Description | |----------|---------------|----------|-------------| |poll|[Poll](../types/Poll.md) | Yes|The poll to send| +|correct\_answers|Array of [bytes](../types/bytes.md) | Optional|| @@ -24,14 +25,14 @@ A poll ### Example: ```php -$inputMediaPoll = ['_' => 'inputMediaPoll', 'poll' => Poll]; +$inputMediaPoll = ['_' => 'inputMediaPoll', 'poll' => Poll, 'correct_answers' => ['bytes', 'bytes']]; ``` Or, if you're into Lua: ```lua -inputMediaPoll={_='inputMediaPoll', poll=Poll} +inputMediaPoll={_='inputMediaPoll', poll=Poll, correct_answers={'bytes'}} ``` diff --git a/docs/API_docs/constructors/inputPhotoLegacyFileLocation.md b/docs/API_docs/constructors/inputPhotoLegacyFileLocation.md new file mode 100644 index 00000000..b1cdc68b --- /dev/null +++ b/docs/API_docs/constructors/inputPhotoLegacyFileLocation.md @@ -0,0 +1,43 @@ +--- +title: inputPhotoLegacyFileLocation +description: Legacy file location +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhotoLegacyFileLocation +[Back to constructors index](index.md) + + + +Legacy file location + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Photo ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|file\_reference|[bytes](../types/bytes.md) | Yes|File reference| +|volume\_id|[long](../types/long.md) | Yes|Volume ID| +|local\_id|[int](../types/int.md) | Yes|Local ID| +|secret|[long](../types/long.md) | Yes|Secret| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputPhotoLegacyFileLocation = ['_' => 'inputPhotoLegacyFileLocation', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'volume_id' => long, 'local_id' => int, 'secret' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputPhotoLegacyFileLocation={_='inputPhotoLegacyFileLocation', id=long, access_hash=long, file_reference='bytes', volume_id=long, local_id=int, secret=long} + +``` + + diff --git a/docs/API_docs/constructors/inputThemeSettings.md b/docs/API_docs/constructors/inputThemeSettings.md new file mode 100644 index 00000000..4848c6fc --- /dev/null +++ b/docs/API_docs/constructors/inputThemeSettings.md @@ -0,0 +1,41 @@ +--- +title: inputThemeSettings +description: inputThemeSettings attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputThemeSettings +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|base\_theme|[BaseTheme](../types/BaseTheme.md) | Yes| +|accent\_color|[int](../types/int.md) | Yes| +|message\_top\_color|[int](../types/int.md) | Optional| +|message\_bottom\_color|[int](../types/int.md) | Optional| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Optional| +|wallpaper\_settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional| + + + +### Type: [InputThemeSettings](../types/InputThemeSettings.md) + + +### Example: + +```php +$inputThemeSettings = ['_' => 'inputThemeSettings', 'base_theme' => BaseTheme, 'accent_color' => int, 'message_top_color' => int, 'message_bottom_color' => int, 'wallpaper' => InputWallPaper, 'wallpaper_settings' => WallPaperSettings]; +``` + + +Or, if you're into Lua: + +```lua +inputThemeSettings={_='inputThemeSettings', base_theme=BaseTheme, accent_color=int, message_top_color=int, message_bottom_color=int, wallpaper=InputWallPaper, wallpaper_settings=WallPaperSettings} + +``` + + diff --git a/docs/API_docs/constructors/inputWallPaperNoFile.md b/docs/API_docs/constructors/inputWallPaperNoFile.md new file mode 100644 index 00000000..8a28dccf --- /dev/null +++ b/docs/API_docs/constructors/inputWallPaperNoFile.md @@ -0,0 +1,31 @@ +--- +title: inputWallPaperNoFile +description: inputWallPaperNoFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWallPaperNoFile +[Back to constructors index](index.md) + + + + + + +### Type: [InputWallPaper](../types/InputWallPaper.md) + + +### Example: + +```php +$inputWallPaperNoFile = ['_' => 'inputWallPaperNoFile']; +``` + + +Or, if you're into Lua: + +```lua +inputWallPaperNoFile={_='inputWallPaperNoFile'} + +``` + + diff --git a/docs/API_docs/constructors/ipPortSecret.md b/docs/API_docs/constructors/ipPortSecret.md deleted file mode 100644 index e492b4cd..00000000 --- a/docs/API_docs/constructors/ipPortSecret.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: ipPortSecret -description: Ip port secret -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: ipPortSecret -[Back to constructors index](index.md) - - - -Ip port secret - -### Attributes: - -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ipv4|[int](../types/int.md) | Yes|Ipv4| -|port|[int](../types/int.md) | Yes|Port| -|secret|[bytes](../types/bytes.md) | Yes|Secret| - - - -### Type: [IpPort](../types/IpPort.md) - - -### Example: - -```php -$ipPortSecret = ['_' => 'ipPortSecret', 'ipv4' => int, 'port' => int, 'secret' => 'bytes']; -``` - - -Or, if you're into Lua: - -```lua -ipPortSecret={_='ipPortSecret', ipv4=int, port=int, secret='bytes'} - -``` - - diff --git a/docs/API_docs/constructors/keyboardButtonRequestPoll.md b/docs/API_docs/constructors/keyboardButtonRequestPoll.md new file mode 100644 index 00000000..8cb6fb52 --- /dev/null +++ b/docs/API_docs/constructors/keyboardButtonRequestPoll.md @@ -0,0 +1,37 @@ +--- +title: keyboardButtonRequestPoll +description: keyboardButtonRequestPoll attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonRequestPoll +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|quiz|[Bool](../types/Bool.md) | Optional| +|text|[string](../types/string.md) | Yes| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonRequestPoll = ['_' => 'keyboardButtonRequestPoll', 'quiz' => Bool, 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonRequestPoll={_='keyboardButtonRequestPoll', quiz=Bool, text='string'} + +``` + + diff --git a/docs/API_docs/constructors/messageUserVote.md b/docs/API_docs/constructors/messageUserVote.md new file mode 100644 index 00000000..4a0fa477 --- /dev/null +++ b/docs/API_docs/constructors/messageUserVote.md @@ -0,0 +1,38 @@ +--- +title: messageUserVote +description: messageUserVote attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageUserVote +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|option|[bytes](../types/bytes.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [MessageUserVote](../types/MessageUserVote.md) + + +### Example: + +```php +$messageUserVote = ['_' => 'messageUserVote', 'user_id' => int, 'option' => 'bytes', 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageUserVote={_='messageUserVote', user_id=int, option='bytes', date=int} + +``` + + diff --git a/docs/API_docs/constructors/messageUserVoteInputOption.md b/docs/API_docs/constructors/messageUserVoteInputOption.md new file mode 100644 index 00000000..1e106d81 --- /dev/null +++ b/docs/API_docs/constructors/messageUserVoteInputOption.md @@ -0,0 +1,37 @@ +--- +title: messageUserVoteInputOption +description: messageUserVoteInputOption attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageUserVoteInputOption +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [MessageUserVote](../types/MessageUserVote.md) + + +### Example: + +```php +$messageUserVoteInputOption = ['_' => 'messageUserVoteInputOption', 'user_id' => int, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageUserVoteInputOption={_='messageUserVoteInputOption', user_id=int, date=int} + +``` + + diff --git a/docs/API_docs/constructors/messageUserVoteMultiple.md b/docs/API_docs/constructors/messageUserVoteMultiple.md new file mode 100644 index 00000000..d3ddd7e3 --- /dev/null +++ b/docs/API_docs/constructors/messageUserVoteMultiple.md @@ -0,0 +1,38 @@ +--- +title: messageUserVoteMultiple +description: messageUserVoteMultiple attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageUserVoteMultiple +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|options|Array of [bytes](../types/bytes.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [MessageUserVote](../types/MessageUserVote.md) + + +### Example: + +```php +$messageUserVoteMultiple = ['_' => 'messageUserVoteMultiple', 'user_id' => int, 'options' => ['bytes', 'bytes'], 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageUserVoteMultiple={_='messageUserVoteMultiple', user_id=int, options={'bytes'}, date=int} + +``` + + diff --git a/docs/API_docs/constructors/messages.inactiveChats.md b/docs/API_docs/constructors/messages.inactiveChats.md new file mode 100644 index 00000000..a899629d --- /dev/null +++ b/docs/API_docs/constructors/messages.inactiveChats.md @@ -0,0 +1,39 @@ +--- +title: messages.inactiveChats +description: messages.inactiveChats attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_inactiveChats.html +--- +# Constructor: messages.inactiveChats +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|dates|Array of [int](../types/int.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [messages.InactiveChats](../types/messages.InactiveChats.md) + + +### Example: + +```php +$messages.inactiveChats = ['_' => 'messages.inactiveChats', 'dates' => [int, int], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.inactiveChats={_='messages.inactiveChats', dates={int}, chats={Chat}, users={User}} + +``` + + diff --git a/docs/API_docs/constructors/messages.votesList.md b/docs/API_docs/constructors/messages.votesList.md new file mode 100644 index 00000000..b2f464ff --- /dev/null +++ b/docs/API_docs/constructors/messages.votesList.md @@ -0,0 +1,40 @@ +--- +title: messages.votesList +description: messages.votesList attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_votesList.html +--- +# Constructor: messages.votesList +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|count|[int](../types/int.md) | Yes| +|votes|Array of [MessageUserVote](../types/MessageUserVote.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| +|next\_offset|[string](../types/string.md) | Optional| + + + +### Type: [messages.VotesList](../types/messages.VotesList.md) + + +### Example: + +```php +$messages.votesList = ['_' => 'messages.votesList', 'count' => int, 'votes' => [MessageUserVote, MessageUserVote], 'users' => [User, User], 'next_offset' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messages.votesList={_='messages.votesList', count=int, votes={MessageUserVote}, users={User}, next_offset='string'} + +``` + + diff --git a/docs/API_docs/constructors/poll.md b/docs/API_docs/constructors/poll.md index db8b7e2b..170872c9 100644 --- a/docs/API_docs/constructors/poll.md +++ b/docs/API_docs/constructors/poll.md @@ -16,6 +16,9 @@ Poll |----------|---------------|----------|-------------| |id|[long](../types/long.md) | Yes|ID of the poll| |closed|[Bool](../types/Bool.md) | Optional|Whether the poll is closed and doesn't accept any more answers| +|public\_voters|[Bool](../types/Bool.md) | Optional|| +|multiple\_choice|[Bool](../types/Bool.md) | Optional|| +|quiz|[Bool](../types/Bool.md) | Optional|| |question|[string](../types/string.md) | Yes|The question of the poll| |answers|Array of [PollAnswer](../types/PollAnswer.md) | Yes|Answers| @@ -27,14 +30,14 @@ Poll ### Example: ```php -$poll = ['_' => 'poll', 'id' => long, 'closed' => Bool, 'question' => 'string', 'answers' => [PollAnswer, PollAnswer]]; +$poll = ['_' => 'poll', 'id' => long, 'closed' => Bool, 'public_voters' => Bool, 'multiple_choice' => Bool, 'quiz' => Bool, 'question' => 'string', 'answers' => [PollAnswer, PollAnswer]]; ``` Or, if you're into Lua: ```lua -poll={_='poll', id=long, closed=Bool, question='string', answers={PollAnswer}} +poll={_='poll', id=long, closed=Bool, public_voters=Bool, multiple_choice=Bool, quiz=Bool, question='string', answers={PollAnswer}} ``` diff --git a/docs/API_docs/constructors/pollAnswerVoters.md b/docs/API_docs/constructors/pollAnswerVoters.md index e546082b..f52329a8 100644 --- a/docs/API_docs/constructors/pollAnswerVoters.md +++ b/docs/API_docs/constructors/pollAnswerVoters.md @@ -15,6 +15,7 @@ A poll answer, and how users voted on it | Name | Type | Required | Description | |----------|---------------|----------|-------------| |chosen|[Bool](../types/Bool.md) | Optional|Whether we have chosen this answer| +|correct|[Bool](../types/Bool.md) | Optional|| |option|[bytes](../types/bytes.md) | Yes|The param that has to be passed to [messages.sendVote](../methods/messages.sendVote.md).| |voters|[int](../types/int.md) | Yes|How many users voted for this option| @@ -26,14 +27,14 @@ A poll answer, and how users voted on it ### Example: ```php -$pollAnswerVoters = ['_' => 'pollAnswerVoters', 'chosen' => Bool, 'option' => 'bytes', 'voters' => int]; +$pollAnswerVoters = ['_' => 'pollAnswerVoters', 'chosen' => Bool, 'correct' => Bool, 'option' => 'bytes', 'voters' => int]; ``` Or, if you're into Lua: ```lua -pollAnswerVoters={_='pollAnswerVoters', chosen=Bool, option='bytes', voters=int} +pollAnswerVoters={_='pollAnswerVoters', chosen=Bool, correct=Bool, option='bytes', voters=int} ``` diff --git a/docs/API_docs/constructors/pollResults.md b/docs/API_docs/constructors/pollResults.md index 822d8e2b..3ccfdc6d 100644 --- a/docs/API_docs/constructors/pollResults.md +++ b/docs/API_docs/constructors/pollResults.md @@ -17,6 +17,7 @@ Results of poll |min|[Bool](../types/Bool.md) | Optional|Similar to [min](https://core.telegram.org/api/min) objects, used for poll constructors that are the same for all users so they don't have option chosen by the current user (you can use [messages.getPollResults](../methods/messages.getPollResults.md) to get the full poll results).| |results|Array of [PollAnswerVoters](../types/PollAnswerVoters.md) | Optional|Results| |total\_voters|[int](../types/int.md) | Optional|Total number of people that voted in the poll| +|recent\_voters|Array of [int](../types/int.md) | Optional|| @@ -26,14 +27,14 @@ Results of poll ### Example: ```php -$pollResults = ['_' => 'pollResults', 'min' => Bool, 'results' => [PollAnswerVoters, PollAnswerVoters], 'total_voters' => int]; +$pollResults = ['_' => 'pollResults', 'min' => Bool, 'results' => [PollAnswerVoters, PollAnswerVoters], 'total_voters' => int, 'recent_voters' => [int, int]]; ``` Or, if you're into Lua: ```lua -pollResults={_='pollResults', min=Bool, results={PollAnswerVoters}, total_voters=int} +pollResults={_='pollResults', min=Bool, results={PollAnswerVoters}, total_voters=int, recent_voters={int}} ``` diff --git a/docs/API_docs/constructors/theme.md b/docs/API_docs/constructors/theme.md index 9eeee7a4..77539cf1 100644 --- a/docs/API_docs/constructors/theme.md +++ b/docs/API_docs/constructors/theme.md @@ -21,6 +21,7 @@ Theme |slug|[string](../types/string.md) | Yes|Unique theme ID| |title|[string](../types/string.md) | Yes|Theme name| |document|[Document](../types/Document.md) | Optional|Theme| +|settings|[ThemeSettings](../types/ThemeSettings.md) | Optional|| |installs\_count|[int](../types/int.md) | Yes|Installation count| @@ -31,14 +32,14 @@ Theme ### Example: ```php -$theme = ['_' => 'theme', 'creator' => Bool, 'default' => Bool, 'id' => long, 'access_hash' => long, 'slug' => 'string', 'title' => 'string', 'document' => Document, 'installs_count' => int]; +$theme = ['_' => 'theme', 'creator' => Bool, 'default' => Bool, 'id' => long, 'access_hash' => long, 'slug' => 'string', 'title' => 'string', 'document' => Document, 'settings' => ThemeSettings, 'installs_count' => int]; ``` Or, if you're into Lua: ```lua -theme={_='theme', creator=Bool, default=Bool, id=long, access_hash=long, slug='string', title='string', document=Document, installs_count=int} +theme={_='theme', creator=Bool, default=Bool, id=long, access_hash=long, slug='string', title='string', document=Document, settings=ThemeSettings, installs_count=int} ``` diff --git a/docs/API_docs/constructors/themeDocumentNotModified.md b/docs/API_docs/constructors/themeDocumentNotModified.md deleted file mode 100644 index ef94ddcb..00000000 --- a/docs/API_docs/constructors/themeDocumentNotModified.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: themeDocumentNotModified -description: Theme background hasn't changed -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ---- -# Constructor: themeDocumentNotModified -[Back to constructors index](index.md) - - - -Theme background hasn't changed - - - - -### Type: [Theme](../types/Theme.md) - - -### Example: - -```php -$themeDocumentNotModified = ['_' => 'themeDocumentNotModified']; -``` - - -Or, if you're into Lua: - -```lua -themeDocumentNotModified={_='themeDocumentNotModified'} - -``` - - diff --git a/docs/API_docs/constructors/themeSettings.md b/docs/API_docs/constructors/themeSettings.md new file mode 100644 index 00000000..bbcb4618 --- /dev/null +++ b/docs/API_docs/constructors/themeSettings.md @@ -0,0 +1,40 @@ +--- +title: themeSettings +description: themeSettings attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: themeSettings +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|base\_theme|[BaseTheme](../types/BaseTheme.md) | Yes| +|accent\_color|[int](../types/int.md) | Yes| +|message\_top\_color|[int](../types/int.md) | Optional| +|message\_bottom\_color|[int](../types/int.md) | Optional| +|wallpaper|[WallPaper](../types/WallPaper.md) | Optional| + + + +### Type: [ThemeSettings](../types/ThemeSettings.md) + + +### Example: + +```php +$themeSettings = ['_' => 'themeSettings', 'base_theme' => BaseTheme, 'accent_color' => int, 'message_top_color' => int, 'message_bottom_color' => int, 'wallpaper' => WallPaper]; +``` + + +Or, if you're into Lua: + +```lua +themeSettings={_='themeSettings', base_theme=BaseTheme, accent_color=int, message_top_color=int, message_bottom_color=int, wallpaper=WallPaper} + +``` + + diff --git a/docs/API_docs/constructors/updateGeoLiveViewed.md b/docs/API_docs/constructors/updateGeoLiveViewed.md new file mode 100644 index 00000000..8512ada0 --- /dev/null +++ b/docs/API_docs/constructors/updateGeoLiveViewed.md @@ -0,0 +1,37 @@ +--- +title: updateGeoLiveViewed +description: updateGeoLiveViewed attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateGeoLiveViewed +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Peer](../types/Peer.md) | Yes| +|msg\_id|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateGeoLiveViewed = ['_' => 'updateGeoLiveViewed', 'peer' => Peer, 'msg_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateGeoLiveViewed={_='updateGeoLiveViewed', peer=Peer, msg_id=int} + +``` + + diff --git a/docs/API_docs/constructors/updateLoginToken.md b/docs/API_docs/constructors/updateLoginToken.md new file mode 100644 index 00000000..330ba09a --- /dev/null +++ b/docs/API_docs/constructors/updateLoginToken.md @@ -0,0 +1,31 @@ +--- +title: updateLoginToken +description: updateLoginToken attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateLoginToken +[Back to constructors index](index.md) + + + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateLoginToken = ['_' => 'updateLoginToken']; +``` + + +Or, if you're into Lua: + +```lua +updateLoginToken={_='updateLoginToken'} + +``` + + diff --git a/docs/API_docs/constructors/updateMessagePollVote.md b/docs/API_docs/constructors/updateMessagePollVote.md new file mode 100644 index 00000000..da3e6d3b --- /dev/null +++ b/docs/API_docs/constructors/updateMessagePollVote.md @@ -0,0 +1,38 @@ +--- +title: updateMessagePollVote +description: updateMessagePollVote attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateMessagePollVote +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|poll\_id|[long](../types/long.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|options|Array of [bytes](../types/bytes.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateMessagePollVote = ['_' => 'updateMessagePollVote', 'poll_id' => long, 'user_id' => int, 'options' => ['bytes', 'bytes']]; +``` + + +Or, if you're into Lua: + +```lua +updateMessagePollVote={_='updateMessagePollVote', poll_id=long, user_id=int, options={'bytes'}} + +``` + + diff --git a/docs/API_docs/constructors/wallPaperNoFile.md b/docs/API_docs/constructors/wallPaperNoFile.md new file mode 100644 index 00000000..8caaf1dd --- /dev/null +++ b/docs/API_docs/constructors/wallPaperNoFile.md @@ -0,0 +1,38 @@ +--- +title: wallPaperNoFile +description: wallPaperNoFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: wallPaperNoFile +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|default|[Bool](../types/Bool.md) | Optional| +|dark|[Bool](../types/Bool.md) | Optional| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional| + + + +### Type: [WallPaper](../types/WallPaper.md) + + +### Example: + +```php +$wallPaperNoFile = ['_' => 'wallPaperNoFile', 'default' => Bool, 'dark' => Bool, 'settings' => WallPaperSettings]; +``` + + +Or, if you're into Lua: + +```lua +wallPaperNoFile={_='wallPaperNoFile', default=Bool, dark=Bool, settings=WallPaperSettings} + +``` + + diff --git a/docs/API_docs/constructors/wallPaperSettings.md b/docs/API_docs/constructors/wallPaperSettings.md index 6664bea2..0e4362f1 100644 --- a/docs/API_docs/constructors/wallPaperSettings.md +++ b/docs/API_docs/constructors/wallPaperSettings.md @@ -17,7 +17,9 @@ Wallpaper settings |blur|[Bool](../types/Bool.md) | Optional|If set, the wallpaper must be downscaled to fit in 450x450 square and then box-blurred with radius 12| |motion|[Bool](../types/Bool.md) | Optional|If set, the background needs to be slightly moved when device is rotated| |background\_color|[int](../types/int.md) | Optional|If set, a PNG pattern is to be combined with the `color` chosen by the user: the main color of the background in RGB24 format| +|second\_background\_color|[int](../types/int.md) | Optional|| |intensity|[int](../types/int.md) | Optional|Intensity of the pattern when it is shown above the main background color, 0-100| +|rotation|[int](../types/int.md) | Optional|| @@ -27,14 +29,14 @@ Wallpaper settings ### Example: ```php -$wallPaperSettings = ['_' => 'wallPaperSettings', 'blur' => Bool, 'motion' => Bool, 'background_color' => int, 'intensity' => int]; +$wallPaperSettings = ['_' => 'wallPaperSettings', 'blur' => Bool, 'motion' => Bool, 'background_color' => int, 'second_background_color' => int, 'intensity' => int, 'rotation' => int]; ``` Or, if you're into Lua: ```lua -wallPaperSettings={_='wallPaperSettings', blur=Bool, motion=Bool, background_color=int, intensity=int} +wallPaperSettings={_='wallPaperSettings', blur=Bool, motion=Bool, background_color=int, second_background_color=int, intensity=int, rotation=int} ``` diff --git a/docs/API_docs/constructors/webPage.md b/docs/API_docs/constructors/webPage.md index ba96f9b6..5b68d56d 100644 --- a/docs/API_docs/constructors/webPage.md +++ b/docs/API_docs/constructors/webPage.md @@ -30,8 +30,8 @@ Webpage preview |duration|[int](../types/int.md) | Optional|Duration of the content, in seconds| |author|[string](../types/string.md) | Optional|Author of the content| |document|[Document](../types/Document.md) | Optional|Preview of the content as a media file| -|documents|Array of [Document](../types/Document.md) | Optional|Documents| |cached\_page|[Page](../types/Page.md) | Optional|Page contents in [instant view](https://instantview.telegram.org) format| +|attributes|Array of [WebPageAttribute](../types/WebPageAttribute.md) | Optional|| @@ -41,14 +41,14 @@ Webpage preview ### Example: ```php -$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, 'documents' => [Document, Document], 'cached_page' => Page]; +$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, 'attributes' => [WebPageAttribute, WebPageAttribute]]; ``` Or, if you're into Lua: ```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, documents={Document}, cached_page=Page} +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, attributes={WebPageAttribute}} ``` diff --git a/docs/API_docs/constructors/webPageAttributeTheme.md b/docs/API_docs/constructors/webPageAttributeTheme.md new file mode 100644 index 00000000..60dc5361 --- /dev/null +++ b/docs/API_docs/constructors/webPageAttributeTheme.md @@ -0,0 +1,37 @@ +--- +title: webPageAttributeTheme +description: webPageAttributeTheme attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPageAttributeTheme +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|documents|Array of [Document](../types/Document.md) | Optional| +|settings|[ThemeSettings](../types/ThemeSettings.md) | Optional| + + + +### Type: [WebPageAttribute](../types/WebPageAttribute.md) + + +### Example: + +```php +$webPageAttributeTheme = ['_' => 'webPageAttributeTheme', 'documents' => [Document, Document], 'settings' => ThemeSettings]; +``` + + +Or, if you're into Lua: + +```lua +webPageAttributeTheme={_='webPageAttributeTheme', documents={Document}, settings=ThemeSettings} + +``` + + diff --git a/docs/API_docs/index.md b/docs/API_docs/index.md index cad7462d..8df7719c 100644 --- a/docs/API_docs/index.md +++ b/docs/API_docs/index.md @@ -1,9 +1,9 @@ --- -title: MadelineProto API documentation (layer 105) -description: MadelineProto API documentation (layer 105) +title: MadelineProto API documentation (layer 109) +description: MadelineProto API documentation (layer 109) image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# MadelineProto API documentation (layer 105) +# MadelineProto API documentation (layer 109) [Back to main documentation](..) diff --git a/docs/API_docs/methods/account.createTheme.md b/docs/API_docs/methods/account.createTheme.md index ce17e88c..e11ff1b4 100644 --- a/docs/API_docs/methods/account.createTheme.md +++ b/docs/API_docs/methods/account.createTheme.md @@ -17,6 +17,7 @@ Create a theme |slug|[string](../types/string.md) | Unique theme ID | Yes| |title|[string](../types/string.md) | Theme name | Yes| |document|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Theme file | Optional| +|settings|[InputThemeSettings](../types/InputThemeSettings.md) | | Optional| ### Return type: [Theme](../types/Theme.md) @@ -36,12 +37,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Theme = $MadelineProto->account->createTheme(['slug' => 'string', 'title' => 'string', 'document' => InputDocument, ]); +$Theme = $MadelineProto->account->createTheme(['slug' => 'string', 'title' => 'string', 'document' => InputDocument, 'settings' => InputThemeSettings, ]); ``` Or, if you're into Lua: ```lua -Theme = account.createTheme({slug='string', title='string', document=InputDocument, }) +Theme = account.createTheme({slug='string', title='string', document=InputDocument, settings=InputThemeSettings, }) ``` diff --git a/docs/API_docs/methods/account.getContentSettings.md b/docs/API_docs/methods/account.getContentSettings.md new file mode 100644 index 00000000..d4d99ea9 --- /dev/null +++ b/docs/API_docs/methods/account.getContentSettings.md @@ -0,0 +1,38 @@ +--- +title: account.getContentSettings +description: account.getContentSettings parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getContentSettings.html +--- +# Method: account.getContentSettings +[Back to methods index](index.md) + + + + +### Return type: [account.ContentSettings](../types/account.ContentSettings.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.ContentSettings = $MadelineProto->account->getContentSettings(); +``` + +Or, if you're into Lua: + +```lua +account.ContentSettings = account.getContentSettings({}) +``` + diff --git a/docs/API_docs/methods/account.getMultiWallPapers.md b/docs/API_docs/methods/account.getMultiWallPapers.md new file mode 100644 index 00000000..aa7388a4 --- /dev/null +++ b/docs/API_docs/methods/account.getMultiWallPapers.md @@ -0,0 +1,43 @@ +--- +title: account.getMultiWallPapers +description: account.getMultiWallPapers parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getMultiWallPapers.html +--- +# Method: account.getMultiWallPapers +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|wallpapers|Array of [InputWallPaper](../types/InputWallPaper.md) | Yes| + + +### Return type: [Vector\_of\_WallPaper](../types/WallPaper.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->getMultiWallPapers(['wallpapers' => [InputWallPaper, InputWallPaper], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_WallPaper = account.getMultiWallPapers({wallpapers={InputWallPaper}, }) +``` + diff --git a/docs/API_docs/methods/account.setContentSettings.md b/docs/API_docs/methods/account.setContentSettings.md new file mode 100644 index 00000000..ba6337d4 --- /dev/null +++ b/docs/API_docs/methods/account.setContentSettings.md @@ -0,0 +1,43 @@ +--- +title: account.setContentSettings +description: account.setContentSettings parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_setContentSettings.html +--- +# Method: account.setContentSettings +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|sensitive\_enabled|[Bool](../types/Bool.md) | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->setContentSettings(['sensitive_enabled' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.setContentSettings({sensitive_enabled=Bool, }) +``` + diff --git a/docs/API_docs/methods/account.updateTheme.md b/docs/API_docs/methods/account.updateTheme.md index 73fd016a..8de4d845 100644 --- a/docs/API_docs/methods/account.updateTheme.md +++ b/docs/API_docs/methods/account.updateTheme.md @@ -19,6 +19,7 @@ Update theme |slug|[string](../types/string.md) | Unique theme ID | Optional| |title|[string](../types/string.md) | Theme name | Optional| |document|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Theme file | Optional| +|settings|[InputThemeSettings](../types/InputThemeSettings.md) | | Optional| ### Return type: [Theme](../types/Theme.md) @@ -38,12 +39,12 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$Theme = $MadelineProto->account->updateTheme(['format' => 'string', 'theme' => InputTheme, 'slug' => 'string', 'title' => 'string', 'document' => InputDocument, ]); +$Theme = $MadelineProto->account->updateTheme(['format' => 'string', 'theme' => InputTheme, 'slug' => 'string', 'title' => 'string', 'document' => InputDocument, 'settings' => InputThemeSettings, ]); ``` Or, if you're into Lua: ```lua -Theme = account.updateTheme({format='string', theme=InputTheme, slug='string', title='string', document=InputDocument, }) +Theme = account.updateTheme({format='string', theme=InputTheme, slug='string', title='string', document=InputDocument, settings=InputThemeSettings, }) ``` diff --git a/docs/API_docs/methods/api_index.md b/docs/API_docs/methods/api_index.md index 41b7ce61..1210ca2f 100644 --- a/docs/API_docs/methods/api_index.md +++ b/docs/API_docs/methods/api_index.md @@ -60,7 +60,7 @@ $MadelineProto->[account->confirmPhone](account.confirmPhone.md)(\['phone_code_h ***

-$MadelineProto->[account->createTheme](account.createTheme.md)(\['slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [InputDocument](../types/InputDocument.md), \]) === [$Theme](../types/Theme.md) +$MadelineProto->[account->createTheme](account.createTheme.md)(\['slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [InputDocument](../types/InputDocument.md), 'settings' => [InputThemeSettings](../types/InputThemeSettings.md), \]) === [$Theme](../types/Theme.md) ***

@@ -98,6 +98,14 @@ $MadelineProto->[account->getAutoDownloadSettings](account.getAutoDownloadSettin

$MadelineProto->[account->getContactSignUpNotification](account.getContactSignUpNotification.md)(\[\]) === [$Bool](../types/Bool.md) +*** +

+$MadelineProto->[account->getContentSettings](account.getContentSettings.md)(\[\]) === [$account.ContentSettings](../types/account.ContentSettings.md) + +*** +

+$MadelineProto->[account->getMultiWallPapers](account.getMultiWallPapers.md)(\['wallpapers' => \[[InputWallPaper](../types/InputWallPaper.md)\], \]) === [$Vector\_of\_WallPaper](../types/WallPaper.md) + ***

$MadelineProto->[account->getNotifyExceptions](account.getNotifyExceptions.md)(\['compare_sound' => [Bool](../types/Bool.md), 'peer' => [InputNotifyPeer](../types/InputNotifyPeer.md), \]) === [$Updates](../types/Updates.md) @@ -230,6 +238,10 @@ $MadelineProto->[account->setAccountTTL](account.setAccountTTL.md)(\['ttl' => [A

$MadelineProto->[account->setContactSignUpNotification](account.setContactSignUpNotification.md)(\['silent' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) +*** +

+$MadelineProto->[account->setContentSettings](account.setContentSettings.md)(\['sensitive_enabled' => [Bool](../types/Bool.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) @@ -260,7 +272,7 @@ $MadelineProto->[account->updateStatus](account.updateStatus.md)(\['offline' => ***

-$MadelineProto->[account->updateTheme](account.updateTheme.md)(\['format' => [string](../types/string.md), 'theme' => [InputTheme](../types/InputTheme.md), 'slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [InputDocument](../types/InputDocument.md), \]) === [$Theme](../types/Theme.md) +$MadelineProto->[account->updateTheme](account.updateTheme.md)(\['format' => [string](../types/string.md), 'theme' => [InputTheme](../types/InputTheme.md), 'slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [InputDocument](../types/InputDocument.md), 'settings' => [InputThemeSettings](../types/InputThemeSettings.md), \]) === [$Theme](../types/Theme.md) ***

@@ -282,6 +294,10 @@ $MadelineProto->[account->verifyEmail](account.verifyEmail.md)(\['email' => [str

$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->acceptLoginToken](auth.acceptLoginToken.md)(\['token' => [bytes](../types/bytes.md), \]) === [$Authorization](../types/Authorization.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) @@ -302,6 +318,10 @@ $MadelineProto->[auth->dropTempAuthKeys](auth.dropTempAuthKeys.md)(\['except_aut

$MadelineProto->[auth->exportAuthorization](auth.exportAuthorization.md)(\['dc_id' => [int](../types/int.md), \]) === [$auth.ExportedAuthorization](../types/auth.ExportedAuthorization.md) +*** +

+$MadelineProto->[auth->exportLoginToken](auth.exportLoginToken.md)(\['api_id' => [int](../types/int.md), 'api_hash' => [string](../types/string.md), 'except_ids' => \[[int](../types/int.md)\], \]) === [$auth.LoginToken](../types/auth.LoginToken.md) + ***

$MadelineProto->[auth->importAuthorization](auth.importAuthorization.md)(\['id' => [int](../types/int.md), 'bytes' => [bytes](../types/bytes.md), \]) === [$auth.Authorization](../types/auth.Authorization.md) @@ -310,6 +330,10 @@ $MadelineProto->[auth->importAuthorization](auth.importAuthorization.md)(\['id'

$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->importLoginToken](auth.importLoginToken.md)(\['token' => [bytes](../types/bytes.md), \]) === [$auth.LoginToken](../types/auth.LoginToken.md) + ***

$MadelineProto->[auth->logOut](auth.logOut.md)(\[\]) === [$Bool](../types/Bool.md) @@ -422,6 +446,10 @@ $MadelineProto->[channels->getFullChannel](channels.getFullChannel.md)(\['channe

$MadelineProto->[channels->getGroupsForDiscussion](channels.getGroupsForDiscussion.md)(\[\]) === [$messages.Chats](../types/messages.Chats.md) +*** +

+$MadelineProto->[channels->getInactiveChannels](channels.getInactiveChannels.md)(\[\]) === [$messages.InactiveChats](../types/messages.InactiveChats.md) + ***

$MadelineProto->[channels->getLeftChannels](channels.getLeftChannels.md)(\['offset' => [int](../types/int.md), \]) === [$messages.Chats](../types/messages.Chats.md) @@ -910,6 +938,10 @@ $MadelineProto->[messages->getPinnedDialogs](messages.getPinnedDialogs.md)(\['fo

$MadelineProto->[messages->getPollResults](messages.getPollResults.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) +*** +

+$MadelineProto->[messages->getPollVotes](messages.getPollVotes.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), 'option' => [bytes](../types/bytes.md), 'offset' => [string](../types/string.md), 'limit' => [int](../types/int.md), \]) === [$messages.VotesList](../types/messages.VotesList.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) @@ -1272,7 +1304,7 @@ $MadelineProto->[upload->getCdnFileHashes](upload.getCdnFileHashes.md)(\['file_t ***

-$MadelineProto->[upload->getFile](upload.getFile.md)(\['precise' => [Bool](../types/Bool.md), 'location' => [InputFileLocation](../types/InputFileLocation.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$upload.File](../types/upload.File.md) +$MadelineProto->[upload->getFile](upload.getFile.md)(\['precise' => [Bool](../types/Bool.md), 'cdn_supported' => [Bool](../types/Bool.md), 'location' => [InputFileLocation](../types/InputFileLocation.md), 'offset' => [int](../types/int.md), 'limit' => [int](../types/int.md), \]) === [$upload.File](../types/upload.File.md) ***

diff --git a/docs/API_docs/methods/auth.acceptLoginToken.md b/docs/API_docs/methods/auth.acceptLoginToken.md new file mode 100644 index 00000000..142ec8f0 --- /dev/null +++ b/docs/API_docs/methods/auth.acceptLoginToken.md @@ -0,0 +1,43 @@ +--- +title: auth.acceptLoginToken +description: auth.acceptLoginToken parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_acceptLoginToken.html +--- +# Method: auth.acceptLoginToken +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|token|[bytes](../types/bytes.md) | Yes| + + +### Return type: [Authorization](../types/Authorization.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$Authorization = $MadelineProto->auth->acceptLoginToken(['token' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +Authorization = auth.acceptLoginToken({token='bytes', }) +``` + diff --git a/docs/API_docs/methods/auth.exportLoginToken.md b/docs/API_docs/methods/auth.exportLoginToken.md new file mode 100644 index 00000000..a6587cbc --- /dev/null +++ b/docs/API_docs/methods/auth.exportLoginToken.md @@ -0,0 +1,45 @@ +--- +title: auth.exportLoginToken +description: auth.exportLoginToken parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_exportLoginToken.html +--- +# Method: auth.exportLoginToken +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|api\_id|[int](../types/int.md) | Yes| +|api\_hash|[string](../types/string.md) | Yes| +|except\_ids|Array of [int](../types/int.md) | Yes| + + +### Return type: [auth.LoginToken](../types/auth.LoginToken.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.LoginToken = $MadelineProto->auth->exportLoginToken(['api_id' => int, 'api_hash' => 'string', 'except_ids' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +auth.LoginToken = auth.exportLoginToken({api_id=int, api_hash='string', except_ids={int}, }) +``` + diff --git a/docs/API_docs/methods/auth.importLoginToken.md b/docs/API_docs/methods/auth.importLoginToken.md new file mode 100644 index 00000000..38bb68e0 --- /dev/null +++ b/docs/API_docs/methods/auth.importLoginToken.md @@ -0,0 +1,43 @@ +--- +title: auth.importLoginToken +description: auth.importLoginToken parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_importLoginToken.html +--- +# Method: auth.importLoginToken +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|token|[bytes](../types/bytes.md) | Yes| + + +### Return type: [auth.LoginToken](../types/auth.LoginToken.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.LoginToken = $MadelineProto->auth->importLoginToken(['token' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +auth.LoginToken = auth.importLoginToken({token='bytes', }) +``` + diff --git a/docs/API_docs/methods/channels.getInactiveChannels.md b/docs/API_docs/methods/channels.getInactiveChannels.md new file mode 100644 index 00000000..68ab7dd7 --- /dev/null +++ b/docs/API_docs/methods/channels.getInactiveChannels.md @@ -0,0 +1,38 @@ +--- +title: channels.getInactiveChannels +description: channels.getInactiveChannels parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getInactiveChannels.html +--- +# Method: channels.getInactiveChannels +[Back to methods index](index.md) + + + + +### Return type: [messages.InactiveChats](../types/messages.InactiveChats.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.InactiveChats = $MadelineProto->channels->getInactiveChannels(); +``` + +Or, if you're into Lua: + +```lua +messages.InactiveChats = channels.getInactiveChannels({}) +``` + diff --git a/docs/API_docs/methods/messages.getPollVotes.md b/docs/API_docs/methods/messages.getPollVotes.md new file mode 100644 index 00000000..d8021eb9 --- /dev/null +++ b/docs/API_docs/methods/messages.getPollVotes.md @@ -0,0 +1,47 @@ +--- +title: messages.getPollVotes +description: messages.getPollVotes parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getPollVotes.html +--- +# Method: messages.getPollVotes +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +|id|[int](../types/int.md) | Yes| +|option|[bytes](../types/bytes.md) | Optional| +|offset|[string](../types/string.md) | Optional| +|limit|[int](../types/int.md) | Yes| + + +### Return type: [messages.VotesList](../types/messages.VotesList.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.VotesList = $MadelineProto->messages->getPollVotes(['peer' => InputPeer, 'id' => int, 'option' => 'bytes', 'offset' => 'string', 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.VotesList = messages.getPollVotes({peer=InputPeer, id=int, option='bytes', offset='string', limit=int, }) +``` + diff --git a/docs/API_docs/methods/upload.getFile.md b/docs/API_docs/methods/upload.getFile.md index 8fc16fb7..dc283623 100644 --- a/docs/API_docs/methods/upload.getFile.md +++ b/docs/API_docs/methods/upload.getFile.md @@ -15,6 +15,7 @@ You cannot use this method directly, use the upload, downloadToStream, downloadT | Name | Type | Description | Required | |----------|---------------|-------------|----------| |precise|[Bool](../types/Bool.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Optional| +|cdn\_supported|[Bool](../types/Bool.md) | | Optional| |location|[InputFileLocation](../types/InputFileLocation.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| |offset|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| |limit|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| @@ -37,13 +38,13 @@ include 'madeline.php'; $MadelineProto = new \danog\MadelineProto\API('session.madeline'); $MadelineProto->start(); -$upload.File = $MadelineProto->upload->getFile(['precise' => Bool, 'location' => InputFileLocation, 'offset' => int, 'limit' => int, ]); +$upload.File = $MadelineProto->upload->getFile(['precise' => Bool, 'cdn_supported' => Bool, 'location' => InputFileLocation, 'offset' => int, 'limit' => int, ]); ``` Or, if you're into Lua: ```lua -upload.File = upload.getFile({precise=Bool, location=InputFileLocation, offset=int, limit=int, }) +upload.File = upload.getFile({precise=Bool, cdn_supported=Bool, location=InputFileLocation, offset=int, limit=int, }) ``` ### Errors diff --git a/docs/API_docs/types/Authorization.md b/docs/API_docs/types/Authorization.md index e6760335..147bc9e4 100644 --- a/docs/API_docs/types/Authorization.md +++ b/docs/API_docs/types/Authorization.md @@ -16,5 +16,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ### Methods that return an object of this type (methods): +[$MadelineProto->auth->acceptLoginToken](../methods/auth.acceptLoginToken.md) + diff --git a/docs/API_docs/types/BaseTheme.md b/docs/API_docs/types/BaseTheme.md new file mode 100644 index 00000000..428b09c3 --- /dev/null +++ b/docs/API_docs/types/BaseTheme.md @@ -0,0 +1,28 @@ +--- +title: BaseTheme +description: constructors and methods of type BaseTheme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: BaseTheme +[Back to types index](index.md) + + + +### Possible values (constructors): + +[baseThemeClassic](../constructors/baseThemeClassic.md) + +[baseThemeDay](../constructors/baseThemeDay.md) + +[baseThemeNight](../constructors/baseThemeNight.md) + +[baseThemeTinted](../constructors/baseThemeTinted.md) + +[baseThemeArctic](../constructors/baseThemeArctic.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/API_docs/types/InputFileLocation.md b/docs/API_docs/types/InputFileLocation.md index 1724fbae..c855a312 100644 --- a/docs/API_docs/types/InputFileLocation.md +++ b/docs/API_docs/types/InputFileLocation.md @@ -22,6 +22,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [inputPhotoFileLocation](../constructors/inputPhotoFileLocation.md) +[inputPhotoLegacyFileLocation](../constructors/inputPhotoLegacyFileLocation.md) + [inputPeerPhotoFileLocation](../constructors/inputPeerPhotoFileLocation.md) [inputStickerSetThumb](../constructors/inputStickerSetThumb.md) diff --git a/docs/API_docs/types/InputThemeSettings.md b/docs/API_docs/types/InputThemeSettings.md new file mode 100644 index 00000000..2249b3e3 --- /dev/null +++ b/docs/API_docs/types/InputThemeSettings.md @@ -0,0 +1,20 @@ +--- +title: InputThemeSettings +description: constructors and methods of type InputThemeSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputThemeSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputThemeSettings](../constructors/inputThemeSettings.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/API_docs/types/InputWallPaper.md b/docs/API_docs/types/InputWallPaper.md index e8d29082..fab6fbfe 100644 --- a/docs/API_docs/types/InputWallPaper.md +++ b/docs/API_docs/types/InputWallPaper.md @@ -14,6 +14,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [inputWallPaperSlug](../constructors/inputWallPaperSlug.md) +[inputWallPaperNoFile](../constructors/inputWallPaperNoFile.md) + ### Methods that return an object of this type (methods): diff --git a/docs/API_docs/types/KeyboardButton.md b/docs/API_docs/types/KeyboardButton.md index b7377067..1c29eca6 100644 --- a/docs/API_docs/types/KeyboardButton.md +++ b/docs/API_docs/types/KeyboardButton.md @@ -51,6 +51,8 @@ You can also access the properties of the constructor as a normal array, for exa [inputKeyboardButtonUrlAuth](../constructors/inputKeyboardButtonUrlAuth.md) +[keyboardButtonRequestPoll](../constructors/keyboardButtonRequestPoll.md) + ### Methods that return an object of this type (methods): diff --git a/docs/API_docs/types/MessageUserVote.md b/docs/API_docs/types/MessageUserVote.md new file mode 100644 index 00000000..5d17cedc --- /dev/null +++ b/docs/API_docs/types/MessageUserVote.md @@ -0,0 +1,24 @@ +--- +title: MessageUserVote +description: constructors and methods of type MessageUserVote +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessageUserVote +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageUserVote](../constructors/messageUserVote.md) + +[messageUserVoteInputOption](../constructors/messageUserVoteInputOption.md) + +[messageUserVoteMultiple](../constructors/messageUserVoteMultiple.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/API_docs/types/Theme.md b/docs/API_docs/types/Theme.md index 6fee4443..59cc3bc7 100644 --- a/docs/API_docs/types/Theme.md +++ b/docs/API_docs/types/Theme.md @@ -10,8 +10,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png ### Possible values (constructors): -[themeDocumentNotModified](../constructors/themeDocumentNotModified.md) - [theme](../constructors/theme.md) diff --git a/docs/API_docs/types/AccessPointRule.md b/docs/API_docs/types/ThemeSettings.md similarity index 56% rename from docs/API_docs/types/AccessPointRule.md rename to docs/API_docs/types/ThemeSettings.md index 07450b37..accdb223 100644 --- a/docs/API_docs/types/AccessPointRule.md +++ b/docs/API_docs/types/ThemeSettings.md @@ -1,16 +1,16 @@ --- -title: AccessPointRule -description: constructors and methods of type AccessPointRule +title: ThemeSettings +description: constructors and methods of type ThemeSettings image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: AccessPointRule +# Type: ThemeSettings [Back to types index](index.md) ### Possible values (constructors): -[accessPointRule](../constructors/accessPointRule.md) +[themeSettings](../constructors/themeSettings.md) diff --git a/docs/API_docs/types/Update.md b/docs/API_docs/types/Update.md index 1bfff5b2..71810ae9 100644 --- a/docs/API_docs/types/Update.md +++ b/docs/API_docs/types/Update.md @@ -158,6 +158,12 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [updateTheme](../constructors/updateTheme.md) +[updateGeoLiveViewed](../constructors/updateGeoLiveViewed.md) + +[updateLoginToken](../constructors/updateLoginToken.md) + +[updateMessagePollVote](../constructors/updateMessagePollVote.md) + ### Methods that return an object of this type (methods): diff --git a/docs/API_docs/types/WallPaper.md b/docs/API_docs/types/WallPaper.md index 89033d7e..bdf06088 100644 --- a/docs/API_docs/types/WallPaper.md +++ b/docs/API_docs/types/WallPaper.md @@ -12,6 +12,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [wallPaper](../constructors/wallPaper.md) +[wallPaperNoFile](../constructors/wallPaperNoFile.md) + ### Methods that return an object of this type (methods): @@ -20,5 +22,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [$MadelineProto->account->uploadWallPaper](../methods/account.uploadWallPaper.md) +[$MadelineProto->account->getMultiWallPapers](../methods/account.getMultiWallPapers.md) + diff --git a/docs/API_docs/types/WebPageAttribute.md b/docs/API_docs/types/WebPageAttribute.md new file mode 100644 index 00000000..a14c3bd3 --- /dev/null +++ b/docs/API_docs/types/WebPageAttribute.md @@ -0,0 +1,20 @@ +--- +title: WebPageAttribute +description: constructors and methods of type WebPageAttribute +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: WebPageAttribute +[Back to types index](index.md) + + + +### Possible values (constructors): + +[webPageAttributeTheme](../constructors/webPageAttributeTheme.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/docs/API_docs/types/account.ContentSettings.md b/docs/API_docs/types/account.ContentSettings.md new file mode 100644 index 00000000..17e9b51a --- /dev/null +++ b/docs/API_docs/types/account.ContentSettings.md @@ -0,0 +1,23 @@ +--- +title: account.ContentSettings +description: constructors and methods of type account.ContentSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_ContentSettings.html +--- +# Type: account.ContentSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.contentSettings](../constructors/account.contentSettings.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getContentSettings](../methods/account.getContentSettings.md) + + + diff --git a/docs/API_docs/types/auth.LoginToken.md b/docs/API_docs/types/auth.LoginToken.md new file mode 100644 index 00000000..81360897 --- /dev/null +++ b/docs/API_docs/types/auth.LoginToken.md @@ -0,0 +1,29 @@ +--- +title: auth.LoginToken +description: constructors and methods of type auth.LoginToken +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/auth_LoginToken.html +--- +# Type: auth.LoginToken +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth.loginToken](../constructors/auth.loginToken.md) + +[auth.loginTokenMigrateTo](../constructors/auth.loginTokenMigrateTo.md) + +[auth.loginTokenSuccess](../constructors/auth.loginTokenSuccess.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->auth->exportLoginToken](../methods/auth.exportLoginToken.md) + +[$MadelineProto->auth->importLoginToken](../methods/auth.importLoginToken.md) + + + diff --git a/docs/API_docs/types/help.ConfigSimple.md b/docs/API_docs/types/help.ConfigSimple.md deleted file mode 100644 index 23661a77..00000000 --- a/docs/API_docs/types/help.ConfigSimple.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: help.ConfigSimple -description: constructors and methods of type help.ConfigSimple -image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png -redirect_from: /API_docs/types/help_ConfigSimple.html ---- -# 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/docs/API_docs/types/index.md b/docs/API_docs/types/index.md index 5c1d5fec..76158562 100644 --- a/docs/API_docs/types/index.md +++ b/docs/API_docs/types/index.md @@ -7,14 +7,14 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [Back to API documentation index](..) -[AccessPointRule](AccessPointRule.md) - [AccountDaysTTL](AccountDaysTTL.md) [Authorization](Authorization.md) [AutoDownloadSettings](AutoDownloadSettings.md) +[BaseTheme](BaseTheme.md) + [Bool](Bool.md) [BotCommand](BotCommand.md) @@ -205,6 +205,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [InputTheme](InputTheme.md) +[InputThemeSettings](InputThemeSettings.md) + [InputUser](InputUser.md) [InputWallPaper](InputWallPaper.md) @@ -215,8 +217,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [Invoice](Invoice.md) -[IpPort](IpPort.md) - [JSONObjectValue](JSONObjectValue.md) [JSONValue](JSONValue.md) @@ -247,6 +247,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [MessageRange](MessageRange.md) +[MessageUserVote](MessageUserVote.md) + [MessagesFilter](MessagesFilter.md) [NearestDc](NearestDc.md) @@ -365,6 +367,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [Theme](Theme.md) +[ThemeSettings](ThemeSettings.md) + [TopPeer](TopPeer.md) [TopPeerCategory](TopPeerCategory.md) @@ -397,6 +401,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [WebPage](WebPage.md) +[WebPageAttribute](WebPageAttribute.md) + [X](X.md) [account.AuthorizationForm](account.AuthorizationForm.md) @@ -405,6 +411,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [account.AutoDownloadSettings](account.AutoDownloadSettings.md) +[account.ContentSettings](account.ContentSettings.md) + [account.Password](account.Password.md) [account.PasswordInputSettings](account.PasswordInputSettings.md) @@ -431,6 +439,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [auth.ExportedAuthorization](auth.ExportedAuthorization.md) +[auth.LoginToken](auth.LoginToken.md) + [auth.PasswordRecovery](auth.PasswordRecovery.md) [auth.SentCode](auth.SentCode.md) @@ -457,8 +467,6 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [help.AppUpdate](help.AppUpdate.md) -[help.ConfigSimple](help.ConfigSimple.md) - [help.DeepLinkInfo](help.DeepLinkInfo.md) [help.InviteText](help.InviteText.md) @@ -513,6 +521,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [messages.HighScores](messages.HighScores.md) +[messages.InactiveChats](messages.InactiveChats.md) + [messages.MessageEditData](messages.MessageEditData.md) [messages.Messages](messages.Messages.md) @@ -533,6 +543,8 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png [messages.Stickers](messages.Stickers.md) +[messages.VotesList](messages.VotesList.md) + [payments.PaymentForm](payments.PaymentForm.md) [payments.PaymentReceipt](payments.PaymentReceipt.md) diff --git a/docs/API_docs/types/messages.InactiveChats.md b/docs/API_docs/types/messages.InactiveChats.md new file mode 100644 index 00000000..cb9cd54e --- /dev/null +++ b/docs/API_docs/types/messages.InactiveChats.md @@ -0,0 +1,23 @@ +--- +title: messages.InactiveChats +description: constructors and methods of type messages.InactiveChats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_InactiveChats.html +--- +# Type: messages.InactiveChats +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.inactiveChats](../constructors/messages.inactiveChats.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->channels->getInactiveChannels](../methods/channels.getInactiveChannels.md) + + + diff --git a/docs/API_docs/types/messages.VotesList.md b/docs/API_docs/types/messages.VotesList.md new file mode 100644 index 00000000..3daf9081 --- /dev/null +++ b/docs/API_docs/types/messages.VotesList.md @@ -0,0 +1,23 @@ +--- +title: messages.VotesList +description: constructors and methods of type messages.VotesList +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_VotesList.html +--- +# Type: messages.VotesList +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.votesList](../constructors/messages.votesList.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getPollVotes](../methods/messages.getPollVotes.md) + + + diff --git a/docs/docs/FILES.md b/docs/docs/FILES.md index 64e97d0b..ba5b7252 100644 --- a/docs/docs/FILES.md +++ b/docs/docs/FILES.md @@ -542,4 +542,4 @@ if (!isset($result['file_name'])) { * `$result['file_size']` - File size * `$result['file_name']` - File name -Next section +Next section \ No newline at end of file diff --git a/docs/docs/INSTALLATION.md b/docs/docs/INSTALLATION.md index 2f1ff274..85c3ccb4 100644 --- a/docs/docs/INSTALLATION.md +++ b/docs/docs/INSTALLATION.md @@ -84,4 +84,4 @@ Simply require the package: composer require danog/madelineproto ``` -Next section +Next section \ No newline at end of file diff --git a/docs/docs/UPDATES.md b/docs/docs/UPDATES.md index ddbfc410..daa4203e 100644 --- a/docs/docs/UPDATES.md +++ b/docs/docs/UPDATES.md @@ -210,4 +210,4 @@ You can use the `resetUpdateState` method to reset the update state and fetch al $MadelineProto->resetUpdateState(); ``` -Next section +Next section \ No newline at end of file diff --git a/docs/docs/USING_METHODS.md b/docs/docs/USING_METHODS.md index a7a8402b..00890ded 100644 --- a/docs/docs/USING_METHODS.md +++ b/docs/docs/USING_METHODS.md @@ -7,7 +7,7 @@ image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png There are simplifications for many, if not all of, these methods. -A list of all of the methods that can be called with MadelineProto can be found here: [here (layer 100)](https://docs.madelineproto.xyz/API_docs/). +A list of all of the methods that can be called with MadelineProto can be found here: [here (layer 109)](https://docs.madelineproto.xyz/API_docs/). [Now fully async!](https://docs.madelineproto.xyz/docs/ASYNC.html) diff --git a/old_docs/API_docs_v109/README.md b/old_docs/API_docs_v109/README.md new file mode 100644 index 00000000..8a9e41d0 --- /dev/null +++ b/old_docs/API_docs_v109/README.md @@ -0,0 +1,15 @@ +--- +title: MadelineProto API documentation (layer v109) +description: MadelineProto API documentation (layer v109) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# MadelineProto API documentation (layer v109) + +[Back to main documentation](..) + + +[Methods](methods/) + +[Constructors](constructors/) + +[Types](types/) \ No newline at end of file diff --git a/old_docs/API_docs_v109/constructors/README.md b/old_docs/API_docs_v109/constructors/README.md new file mode 100644 index 00000000..86c93221 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/README.md @@ -0,0 +1,2420 @@ +--- +title: Constructors +description: List of constructors +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructors +[Back to API documentation index](..) + +*** +

[$account.authorizationForm](../constructors/account.authorizationForm.md) = \['required_types' => \[[SecureRequiredType](../types/SecureRequiredType.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.autoDownloadSettings](../constructors/account.autoDownloadSettings.md) = \['low' => [AutoDownloadSettings](../types/AutoDownloadSettings.md), 'medium' => [AutoDownloadSettings](../types/AutoDownloadSettings.md), 'high' => [AutoDownloadSettings](../types/AutoDownloadSettings.md), \]; + +*** +

[$account.contentSettings](../constructors/account.contentSettings.md) = \['sensitive_enabled' => [Bool](../types/Bool.md), 'sensitive_can_change' => [Bool](../types/Bool.md), \]; + +*** +

[$account.password](../constructors/account.password.md) = \['has_recovery' => [Bool](../types/Bool.md), 'has_secure_values' => [Bool](../types/Bool.md), 'has_password' => [Bool](../types/Bool.md), 'current_algo' => [PasswordKdfAlgo](../types/PasswordKdfAlgo.md), 'srp_B' => [bytes](../types/bytes.md), 'srp_id' => [long](../types/long.md), 'hint' => [string](../types/string.md), 'email_unconfirmed_pattern' => [string](../types/string.md), 'new_algo' => [PasswordKdfAlgo](../types/PasswordKdfAlgo.md), 'new_secure_algo' => [SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md), 'secure_random' => [bytes](../types/bytes.md), \]; + +*** +

[$account.passwordInputSettings](../constructors/account.passwordInputSettings.md) = \['new_algo' => [PasswordKdfAlgo](../types/PasswordKdfAlgo.md), 'new_password_hash' => [bytes](../types/bytes.md), 'hint' => [string](../types/string.md), 'email' => [string](../types/string.md), 'new_secure_settings' => [SecureSecretSettings](../types/SecureSecretSettings.md), \]; + +*** +

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

[$account.privacyRules](../constructors/account.privacyRules.md) = \['rules' => \[[PrivacyRule](../types/PrivacyRule.md)\], 'chats' => \[[Chat](../types/Chat.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.themes](../constructors/account.themes.md) = \['hash' => [int](../types/int.md), 'themes' => \[[Theme](../types/Theme.md)\], \]; + +*** +

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

[$account.tmpPassword](../constructors/account.tmpPassword.md) = \['tmp_password' => [bytes](../types/bytes.md), 'valid_until' => [int](../types/int.md), \]; + +*** +

[$account.wallPapers](../constructors/account.wallPapers.md) = \['hash' => [int](../types/int.md), 'wallpapers' => \[[WallPaper](../types/WallPaper.md)\], \]; + +*** +

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

[$account.webAuthorizations](../constructors/account.webAuthorizations.md) = \['authorizations' => \[[WebAuthorization](../types/WebAuthorization.md)\], 'users' => \[[User](../types/User.md)\], \]; + +*** +

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

[$auth.authorization](../constructors/auth.authorization.md) = \['tmp_sessions' => [int](../types/int.md), 'user' => [User](../types/User.md), \]; + +*** +

[$auth.authorizationSignUpRequired](../constructors/auth.authorizationSignUpRequired.md) = \['terms_of_service' => [help.TermsOfService](../types/help.TermsOfService.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.loginToken](../constructors/auth.loginToken.md) = \['expires' => [int](../types/int.md), 'token' => [bytes](../types/bytes.md), \]; + +*** +

[$auth.loginTokenMigrateTo](../constructors/auth.loginTokenMigrateTo.md) = \['dc_id' => [int](../types/int.md), 'token' => [bytes](../types/bytes.md), \]; + +*** +

[$auth.loginTokenSuccess](../constructors/auth.loginTokenSuccess.md) = \['authorization' => [auth.Authorization](../types/auth.Authorization.md), \]; + +*** +

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

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

[$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) = \['current' => [Bool](../types/Bool.md), 'official_app' => [Bool](../types/Bool.md), 'password_pending' => [Bool](../types/Bool.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), \]; + +*** +

[$autoDownloadSettings](../constructors/autoDownloadSettings.md) = \['disabled' => [Bool](../types/Bool.md), 'video_preload_large' => [Bool](../types/Bool.md), 'audio_preload_next' => [Bool](../types/Bool.md), 'phonecalls_less_data' => [Bool](../types/Bool.md), 'photo_size_max' => [int](../types/int.md), 'video_size_max' => [int](../types/int.md), 'file_size_max' => [int](../types/int.md), 'video_upload_maxbitrate' => [int](../types/int.md), \]; + +*** +

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

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

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

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

[$baseThemeTinted](../constructors/baseThemeTinted.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), 'vcard' => [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), 'broadcast' => [Bool](../types/Bool.md), 'verified' => [Bool](../types/Bool.md), 'megagroup' => [Bool](../types/Bool.md), 'restricted' => [Bool](../types/Bool.md), 'signatures' => [Bool](../types/Bool.md), 'min' => [Bool](../types/Bool.md), 'scam' => [Bool](../types/Bool.md), 'has_link' => [Bool](../types/Bool.md), 'has_geo' => [Bool](../types/Bool.md), 'slowmode_enabled' => [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' => \[[RestrictionReason](../types/RestrictionReason.md)\], 'admin_rights' => [ChatAdminRights](../types/ChatAdminRights.md), 'banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), 'default_banned_rights' => [ChatBannedRights](../types/ChatBannedRights.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), \]; + +*** +

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

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

[$channelAdminLogEventActionChangePhoto](../constructors/channelAdminLogEventActionChangePhoto.md) = \['prev_photo' => [Photo](../types/Photo.md), 'new_photo' => [Photo](../types/Photo.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), \]; + +*** +

[$channelAdminLogEventActionDefaultBannedRights](../constructors/channelAdminLogEventActionDefaultBannedRights.md) = \['prev_banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), 'new_banned_rights' => [ChatBannedRights](../types/ChatBannedRights.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), \]; + +*** +

[$channelAdminLogEventActionStopPoll](../constructors/channelAdminLogEventActionStopPoll.md) = \['message' => [Message](../types/Message.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), \]; + +*** +

[$channelAdminLogEventActionToggleSlowMode](../constructors/channelAdminLogEventActionToggleSlowMode.md) = \['prev_value' => [int](../types/int.md), 'new_value' => [int](../types/int.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), \]; + +*** +

[$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), 'can_view_stats' => [Bool](../types/Bool.md), 'can_set_location' => [Bool](../types/Bool.md), 'has_scheduled' => [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), 'online_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), 'folder_id' => [int](../types/int.md), 'linked_chat_id' => [int](../types/int.md), 'location' => [ChannelLocation](../types/ChannelLocation.md), 'slowmode_seconds' => [int](../types/int.md), 'slowmode_next_send_date' => [int](../types/int.md), 'pts' => [int](../types/int.md), \]; + +*** +

[$channelLocation](../constructors/channelLocation.md) = \['geo_point' => [GeoPoint](../types/GeoPoint.md), 'address' => [string](../types/string.md), \]; + +*** +

[$channelLocationEmpty](../constructors/channelLocationEmpty.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), 'self' => [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' => [ChatAdminRights](../types/ChatAdminRights.md), 'rank' => [string](../types/string.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' => [ChatBannedRights](../types/ChatBannedRights.md), \]; + +*** +

[$channelParticipantCreator](../constructors/channelParticipantCreator.md) = \['user_id' => [int](../types/int.md), 'rank' => [string](../types/string.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) = \[\]; + +*** +

[$channelParticipantsContacts](../constructors/channelParticipantsContacts.md) = \['q' => [string](../types/string.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), '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), 'admin_rights' => [ChatAdminRights](../types/ChatAdminRights.md), 'default_banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), \]; + +*** +

[$chatAdminRights](../constructors/chatAdminRights.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), 'pin_messages' => [Bool](../types/Bool.md), 'add_admins' => [Bool](../types/Bool.md), \]; + +*** +

[$chatBannedRights](../constructors/chatBannedRights.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), 'send_polls' => [Bool](../types/Bool.md), 'change_info' => [Bool](../types/Bool.md), 'invite_users' => [Bool](../types/Bool.md), 'pin_messages' => [Bool](../types/Bool.md), 'until_date' => [int](../types/int.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) = \['can_set_username' => [Bool](../types/Bool.md), 'has_scheduled' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'about' => [string](../types/string.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)\], 'pinned_msg_id' => [int](../types/int.md), 'folder_id' => [int](../types/int.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' => [Photo](../types/Photo.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), \]; + +*** +

[$chatOnlines](../constructors/chatOnlines.md) = \['onlines' => [int](../types/int.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), 'dc_id' => [int](../types/int.md), \]; + +*** +

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

[$codeSettings](../constructors/codeSettings.md) = \['allow_flashcall' => [Bool](../types/Bool.md), 'current_number' => [Bool](../types/Bool.md), 'allow_app_hash' => [Bool](../types/Bool.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), 'pfs_enabled' => [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)\], 'dc_txt_domain_name' => [string](../types/string.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), 'pinned_infolder_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), 'gif_search_username' => [string](../types/string.md), 'venue_search_username' => [string](../types/string.md), 'img_search_username' => [string](../types/string.md), 'static_maps_provider' => [string](../types/string.md), 'caption_length_max' => [int](../types/int.md), 'message_length_max' => [int](../types/int.md), 'webfile_dc_id' => [int](../types/int.md), 'suggested_lang_code' => [string](../types/string.md), 'lang_pack_version' => [int](../types/int.md), 'base_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), \]; + +*** +

[$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.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.topPeersDisabled](../constructors/contacts.topPeersDisabled.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), 'unread_mark' => [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), 'folder_id' => [int](../types/int.md), \]; + +*** +

[$dialogFolder](../constructors/dialogFolder.md) = \['pinned' => [Bool](../types/Bool.md), 'folder' => [Folder](../types/Folder.md), 'peer' => [Peer](../types/Peer.md), 'top_message' => [int](../types/int.md), 'unread_muted_peers_count' => [int](../types/int.md), 'unread_unmuted_peers_count' => [int](../types/int.md), 'unread_muted_messages_count' => [int](../types/int.md), 'unread_unmuted_messages_count' => [int](../types/int.md), \]; + +*** +

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

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

[$document](../constructors/document.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'date' => [int](../types/int.md), 'mime_type' => [string](../types/string.md), 'size' => [int](../types/int.md), 'thumbs' => \[[PhotoSize](../types/PhotoSize.md)\], 'dc_id' => [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) = \['date' => [int](../types/int.md), \]; + +*** +

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

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

[$emojiKeywordsDifference](../constructors/emojiKeywordsDifference.md) = \['lang_code' => [string](../types/string.md), 'from_version' => [int](../types/int.md), 'version' => [int](../types/int.md), 'keywords' => \[[EmojiKeyword](../types/EmojiKeyword.md)\], \]; + +*** +

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

[$emojiURL](../constructors/emojiURL.md) = \['url' => [string](../types/string.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), \]; + +*** +

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

[$folder](../constructors/folder.md) = \['autofill_new_broadcasts' => [Bool](../types/Bool.md), 'autofill_public_groups' => [Bool](../types/Bool.md), 'autofill_new_correspondents' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'title' => [string](../types/string.md), 'photo' => [ChatPhoto](../types/ChatPhoto.md), \]; + +*** +

[$folderPeer](../constructors/folderPeer.md) = \['peer' => [Peer](../types/Peer.md), 'folder_id' => [int](../types/int.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), 'access_hash' => [long](../types/long.md), \]; + +*** +

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

[$help.appUpdate](../constructors/help.appUpdate.md) = \['can_not_skip' => [Bool](../types/Bool.md), 'id' => [int](../types/int.md), 'version' => [string](../types/string.md), 'text' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'document' => [Document](../types/Document.md), 'url' => [string](../types/string.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.passportConfig](../constructors/help.passportConfig.md) = \['hash' => [int](../types/int.md), 'countries_langs' => [DataJSON](../types/DataJSON.md), \]; + +*** +

[$help.passportConfigNotModified](../constructors/help.passportConfigNotModified.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.supportName](../constructors/help.supportName.md) = \['name' => [string](../types/string.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), \]; + +*** +

[$help.userInfo](../constructors/help.userInfo.md) = \['message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], 'author' => [string](../types/string.md), 'date' => [int](../types/int.md), \]; + +*** +

[$help.userInfoEmpty](../constructors/help.userInfoEmpty.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' => [JSONValue](../types/JSONValue.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), 'vcard' => [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) = \[\]; + +*** +

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

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

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

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

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

[$inputCheckPasswordSRP](../constructors/inputCheckPasswordSRP.md) = \['srp_id' => [long](../types/long.md), 'A' => [bytes](../types/bytes.md), 'M1' => [bytes](../types/bytes.md), \]; + +*** +

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

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

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

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

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

[$inputDocumentFileLocation](../constructors/inputDocumentFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'thumb_size' => [string](../types/string.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), 'file_reference' => [bytes](../types/bytes.md), \]; + +*** +

[$inputFolderPeer](../constructors/inputFolderPeer.md) = \['peer' => [InputPeer](../types/InputPeer.md), 'folder_id' => [int](../types/int.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) = \[\]; + +*** +

[$inputKeyboardButtonUrlAuth](../constructors/inputKeyboardButtonUrlAuth.md) = \['request_write_access' => [Bool](../types/Bool.md), 'text' => [string](../types/string.md), 'fwd_text' => [string](../types/string.md), 'url' => [string](../types/string.md), 'bot' => [InputUser](../types/InputUser.md), \]; + +*** +

[$inputMediaContact](../constructors/inputMediaContact.md) = \['phone_number' => [string](../types/string.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'vcard' => [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) = \['stopped' => [Bool](../types/Bool.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), \]; + +*** +

[$inputMediaPoll](../constructors/inputMediaPoll.md) = \['poll' => [Poll](../types/Poll.md), 'correct_answers' => \[[bytes](../types/bytes.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) = \[\]; + +*** +

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

[$inputPeerChannelFromMessage](../constructors/inputPeerChannelFromMessage.md) = \['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'channel_id' => [int](../types/int.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), \]; + +*** +

[$inputPeerPhotoFileLocation](../constructors/inputPeerPhotoFileLocation.md) = \['big' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), \]; + +*** +

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

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

[$inputPeerUserFromMessage](../constructors/inputPeerUserFromMessage.md) = \['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'user_id' => [int](../types/int.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), 'file_reference' => [bytes](../types/bytes.md), \]; + +*** +

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

[$inputPhotoFileLocation](../constructors/inputPhotoFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'thumb_size' => [string](../types/string.md), \]; + +*** +

[$inputPhotoLegacyFileLocation](../constructors/inputPhotoLegacyFileLocation.md) = \['id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'volume_id' => [long](../types/long.md), 'local_id' => [int](../types/int.md), 'secret' => [long](../types/long.md), \]; + +*** +

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[$inputThemeSettings](../constructors/inputThemeSettings.md) = \['base_theme' => [BaseTheme](../types/BaseTheme.md), 'accent_color' => [int](../types/int.md), 'message_top_color' => [int](../types/int.md), 'message_bottom_color' => [int](../types/int.md), 'wallpaper' => [InputWallPaper](../types/InputWallPaper.md), 'wallpaper_settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]; + +*** +

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

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

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

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

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

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

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

[$inputWallPaperSlug](../constructors/inputWallPaperSlug.md) = \['slug' => [string](../types/string.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)\], \]; + +*** +

[$inputWebFileGeoPointLocation](../constructors/inputWebFileGeoPointLocation.md) = \['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'access_hash' => [long](../types/long.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'zoom' => [int](../types/int.md), 'scale' => [int](../types/int.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)\], \]; + +*** +

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

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

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

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

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

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

[$jsonString](../constructors/jsonString.md) = \['value' => [string](../types/string.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), \]; + +*** +

[$keyboardButtonRequestPoll](../constructors/keyboardButtonRequestPoll.md) = \['quiz' => [Bool](../types/Bool.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), \]; + +*** +

[$keyboardButtonUrlAuth](../constructors/keyboardButtonUrlAuth.md) = \['text' => [string](../types/string.md), 'fwd_text' => [string](../types/string.md), 'url' => [string](../types/string.md), 'button_id' => [int](../types/int.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) = \['official' => [Bool](../types/Bool.md), 'rtl' => [Bool](../types/Bool.md), 'beta' => [Bool](../types/Bool.md), 'name' => [string](../types/string.md), 'native_name' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), 'base_lang_code' => [string](../types/string.md), 'plural_code' => [string](../types/string.md), 'strings_count' => [int](../types/int.md), 'translated_count' => [int](../types/int.md), 'translations_url' => [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), 'from_scheduled' => [Bool](../types/Bool.md), 'legacy' => [Bool](../types/Bool.md), 'edit_hide' => [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), 'restriction_reason' => \[[RestrictionReason](../types/RestrictionReason.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), \]; + +*** +

[$messageActionContactSignUp](../constructors/messageActionContactSignUp.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) = \['video' => [Bool](../types/Bool.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), \]; + +*** +

[$messageEntityBlockquote](../constructors/messageEntityBlockquote.md) = \['offset' => [int](../types/int.md), 'length' => [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), \]; + +*** +

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

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

[$messageEntityUnderline](../constructors/messageEntityUnderline.md) = \['offset' => [int](../types/int.md), 'length' => [int](../types/int.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), 'from_name' => [string](../types/string.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), 'vcard' => [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), \]; + +*** +

[$messageMediaPoll](../constructors/messageMediaPoll.md) = \['poll' => [Poll](../types/Poll.md), 'results' => [PollResults](../types/PollResults.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), 'legacy' => [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), \]; + +*** +

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

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

[$messageUserVoteMultiple](../constructors/messageUserVoteMultiple.md) = \['user_id' => [int](../types/int.md), 'options' => \[[bytes](../types/bytes.md)\], 'date' => [int](../types/int.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) = \['inexact' => [Bool](../types/Bool.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.dialogsNotModified](../constructors/messages.dialogsNotModified.md) = \['count' => [int](../types/int.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.inactiveChats](../constructors/messages.inactiveChats.md) = \['dates' => \[[int](../types/int.md)\], 'chats' => \[[Chat](../types/Chat.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) = \['inexact' => [Bool](../types/Bool.md), 'count' => [int](../types/int.md), 'next_rate' => [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.searchCounter](../constructors/messages.searchCounter.md) = \['inexact' => [Bool](../types/Bool.md), 'filter' => [MessagesFilter](../types/MessagesFilter.md), 'count' => [int](../types/int.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) = \[\]; + +*** +

[$messages.votesList](../constructors/messages.votesList.md) = \['count' => [int](../types/int.md), 'votes' => \[[MessageUserVote](../types/MessageUserVote.md)\], 'users' => \[[User](../types/User.md)\], 'next_offset' => [string](../types/string.md), \]; + +*** +

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

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

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

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

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

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

[$page](../constructors/page.md) = \['part' => [Bool](../types/Bool.md), 'rtl' => [Bool](../types/Bool.md), 'v2' => [Bool](../types/Bool.md), 'url' => [string](../types/string.md), 'blocks' => \[[PageBlock](../types/PageBlock.md)\], 'photos' => \[[Photo](../types/Photo.md)\], 'documents' => \[[Document](../types/Document.md)\], \]; + +*** +

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

[$pageBlockAudio](../constructors/pageBlockAudio.md) = \['audio_id' => [long](../types/long.md), 'caption' => [PageCaption](../types/PageCaption.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' => [PageCaption](../types/PageCaption.md), \]; + +*** +

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

[$pageBlockDetails](../constructors/pageBlockDetails.md) = \['open' => [Bool](../types/Bool.md), 'blocks' => \[[PageBlock](../types/PageBlock.md)\], 'title' => [RichText](../types/RichText.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' => [PageCaption](../types/PageCaption.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' => [PageCaption](../types/PageCaption.md), \]; + +*** +

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

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

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

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

[$pageBlockMap](../constructors/pageBlockMap.md) = \['geo' => [GeoPoint](../types/GeoPoint.md), 'zoom' => [int](../types/int.md), 'w' => [int](../types/int.md), 'h' => [int](../types/int.md), 'caption' => [PageCaption](../types/PageCaption.md), \]; + +*** +

[$pageBlockOrderedList](../constructors/pageBlockOrderedList.md) = \['items' => \[[PageListOrderedItem](../types/PageListOrderedItem.md)\], \]; + +*** +

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

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

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

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

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

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

[$pageBlockTable](../constructors/pageBlockTable.md) = \['bordered' => [Bool](../types/Bool.md), 'striped' => [Bool](../types/Bool.md), 'title' => [RichText](../types/RichText.md), 'rows' => \[[PageTableRow](../types/PageTableRow.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' => [PageCaption](../types/PageCaption.md), \]; + +*** +

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

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

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

[$pageListOrderedItemBlocks](../constructors/pageListOrderedItemBlocks.md) = \['num' => [string](../types/string.md), 'blocks' => \[[PageBlock](../types/PageBlock.md)\], \]; + +*** +

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

[$pageRelatedArticle](../constructors/pageRelatedArticle.md) = \['url' => [string](../types/string.md), 'webpage_id' => [long](../types/long.md), 'title' => [string](../types/string.md), 'description' => [string](../types/string.md), 'photo_id' => [long](../types/long.md), 'author' => [string](../types/string.md), 'published_date' => [int](../types/int.md), \]; + +*** +

[$pageTableCell](../constructors/pageTableCell.md) = \['header' => [Bool](../types/Bool.md), 'align_center' => [Bool](../types/Bool.md), 'align_right' => [Bool](../types/Bool.md), 'valign_middle' => [Bool](../types/Bool.md), 'valign_bottom' => [Bool](../types/Bool.md), 'text' => [RichText](../types/RichText.md), 'colspan' => [int](../types/int.md), 'rowspan' => [int](../types/int.md), \]; + +*** +

[$pageTableRow](../constructors/pageTableRow.md) = \['cells' => \[[PageTableCell](../types/PageTableCell.md)\], \]; + +*** +

[$passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow](../constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md) = \['salt1' => [bytes](../types/bytes.md), 'salt2' => [bytes](../types/bytes.md), 'g' => [int](../types/int.md), 'p' => [bytes](../types/bytes.md), \]; + +*** +

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

[$peerLocated](../constructors/peerLocated.md) = \['peer' => [Peer](../types/Peer.md), 'expires' => [int](../types/int.md), 'distance' => [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), 'add_contact' => [Bool](../types/Bool.md), 'block_contact' => [Bool](../types/Bool.md), 'share_contact' => [Bool](../types/Bool.md), 'need_contacts_exception' => [Bool](../types/Bool.md), 'report_geo' => [Bool](../types/Bool.md), \]; + +*** +

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

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

[$phoneCall](../constructors/phoneCall.md) = \['p2p_allowed' => [Bool](../types/Bool.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), 'connections' => \[[PhoneConnection](../types/PhoneConnection.md)\], 'start_date' => [int](../types/int.md), \]; + +*** +

[$phoneCallAccepted](../constructors/phoneCallAccepted.md) = \['video' => [Bool](../types/Bool.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), 'video' => [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) = \['video' => [Bool](../types/Bool.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) = \['video' => [Bool](../types/Bool.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), \]; + +*** +

[$photo](../constructors/photo.md) = \['has_stickers' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'file_reference' => [bytes](../types/bytes.md), 'date' => [int](../types/int.md), 'sizes' => \[[PhotoSize](../types/PhotoSize.md)\], 'dc_id' => [int](../types/int.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), \]; + +*** +

[$photoStrippedSize](../constructors/photoStrippedSize.md) = \['type' => [string](../types/string.md), 'bytes' => [bytes](../types/bytes.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)\], \]; + +*** +

[$poll](../constructors/poll.md) = \['id' => [long](../types/long.md), 'closed' => [Bool](../types/Bool.md), 'public_voters' => [Bool](../types/Bool.md), 'multiple_choice' => [Bool](../types/Bool.md), 'quiz' => [Bool](../types/Bool.md), 'question' => [string](../types/string.md), 'answers' => \[[PollAnswer](../types/PollAnswer.md)\], \]; + +*** +

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

[$pollAnswerVoters](../constructors/pollAnswerVoters.md) = \['chosen' => [Bool](../types/Bool.md), 'correct' => [Bool](../types/Bool.md), 'option' => [bytes](../types/bytes.md), 'voters' => [int](../types/int.md), \]; + +*** +

[$pollResults](../constructors/pollResults.md) = \['min' => [Bool](../types/Bool.md), 'results' => \[[PollAnswerVoters](../types/PollAnswerVoters.md)\], 'total_voters' => [int](../types/int.md), 'recent_voters' => \[[int](../types/int.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), \]; + +*** +

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

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

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

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

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

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

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

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

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

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

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

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

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

[$privacyValueDisallowChatParticipants](../constructors/privacyValueDisallowChatParticipants.md) = \['chats' => \[[int](../types/int.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)\], \]; + +*** +

[$restrictionReason](../constructors/restrictionReason.md) = \['platform' => [string](../types/string.md), 'reason' => [string](../types/string.md), 'text' => [string](../types/string.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) = \[\]; + +*** +

[$securePasswordKdfAlgoPBKDF2HMACSHA512iter100000](../constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md) = \['salt' => [bytes](../types/bytes.md), \]; + +*** +

[$securePasswordKdfAlgoSHA512](../constructors/securePasswordKdfAlgoSHA512.md) = \['salt' => [bytes](../types/bytes.md), \]; + +*** +

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

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

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

[$secureRequiredType](../constructors/secureRequiredType.md) = \['native_names' => [Bool](../types/Bool.md), 'selfie_required' => [Bool](../types/Bool.md), 'translation_required' => [Bool](../types/Bool.md), 'type' => [SecureValueType](../types/SecureValueType.md), \]; + +*** +

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

[$secureSecretSettings](../constructors/secureSecretSettings.md) = \['secure_algo' => [SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md), 'secure_secret' => [bytes](../types/bytes.md), 'secure_secret_id' => [long](../types/long.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), 'translation' => \[[SecureFile](../types/SecureFile.md)\], 'files' => \[[SecureFile](../types/SecureFile.md)\], 'plain_data' => [SecurePlainData](../types/SecurePlainData.md), 'hash' => [bytes](../types/bytes.md), \]; + +*** +

[$secureValueError](../constructors/secureValueError.md) = \['type' => [SecureValueType](../types/SecureValueType.md), 'hash' => [bytes](../types/bytes.md), 'text' => [string](../types/string.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), \]; + +*** +

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

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

[$statsURL](../constructors/statsURL.md) = \['url' => [string](../types/string.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), 'animated' => [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), 'thumb' => [PhotoSize](../types/PhotoSize.md), 'thumb_dc_id' => [int](../types/int.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) = \[\]; + +*** +

[$textAnchor](../constructors/textAnchor.md) = \['text' => [RichText](../types/RichText.md), 'name' => [string](../types/string.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), \]; + +*** +

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

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

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

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

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

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

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

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

[$theme](../constructors/theme.md) = \['creator' => [Bool](../types/Bool.md), 'default' => [Bool](../types/Bool.md), 'id' => [long](../types/long.md), 'access_hash' => [long](../types/long.md), 'slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [Document](../types/Document.md), 'settings' => [ThemeSettings](../types/ThemeSettings.md), 'installs_count' => [int](../types/int.md), \]; + +*** +

[$themeSettings](../constructors/themeSettings.md) = \['base_theme' => [BaseTheme](../types/BaseTheme.md), 'accent_color' => [int](../types/int.md), 'message_top_color' => [int](../types/int.md), 'message_bottom_color' => [int](../types/int.md), 'wallpaper' => [WallPaper](../types/WallPaper.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) = \[\]; + +*** +

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

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

[$updateChatDefaultBannedRights](../constructors/updateChatDefaultBannedRights.md) = \['peer' => [Peer](../types/Peer.md), 'default_banned_rights' => [ChatBannedRights](../types/ChatBannedRights.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), \]; + +*** +

[$updateChatPinnedMessage](../constructors/updateChatPinnedMessage.md) = \['chat_id' => [int](../types/int.md), 'id' => [int](../types/int.md), 'version' => [int](../types/int.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) = \[\]; + +*** +

[$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), \]; + +*** +

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

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

[$updateDialogUnreadMark](../constructors/updateDialogUnreadMark.md) = \['unread' => [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) = \[\]; + +*** +

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

[$updateGeoLiveViewed](../constructors/updateGeoLiveViewed.md) = \['peer' => [Peer](../types/Peer.md), 'msg_id' => [int](../types/int.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) = \['lang_code' => [string](../types/string.md), \]; + +*** +

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

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

[$updateMessagePoll](../constructors/updateMessagePoll.md) = \['poll_id' => [long](../types/long.md), 'poll' => [Poll](../types/Poll.md), 'results' => [PollResults](../types/PollResults.md), \]; + +*** +

[$updateMessagePollVote](../constructors/updateMessagePollVote.md) = \['poll_id' => [long](../types/long.md), 'user_id' => [int](../types/int.md), 'options' => \[[bytes](../types/bytes.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), \]; + +*** +

[$updateNewScheduledMessage](../constructors/updateNewScheduledMessage.md) = \['message' => [Message](../types/Message.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), \]; + +*** +

[$updatePeerLocated](../constructors/updatePeerLocated.md) = \['peers' => \[[PeerLocated](../types/PeerLocated.md)\], \]; + +*** +

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

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

[$updatePinnedDialogs](../constructors/updatePinnedDialogs.md) = \['folder_id' => [int](../types/int.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) = \['folder_id' => [int](../types/int.md), 'channel_id' => [int](../types/int.md), 'max_id' => [int](../types/int.md), 'still_unread_count' => [int](../types/int.md), 'pts' => [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) = \['folder_id' => [int](../types/int.md), 'peer' => [Peer](../types/Peer.md), 'max_id' => [int](../types/int.md), 'still_unread_count' => [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)\], \]; + +*** +

[$updateTheme](../constructors/updateTheme.md) = \['theme' => [Theme](../types/Theme.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), \]; + +*** +

[$updateUserPinnedMessage](../constructors/updateUserPinnedMessage.md) = \['user_id' => [int](../types/int.md), 'id' => [int](../types/int.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), \]; + +*** +

[$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), 'timeout' => [int](../types/int.md), 'dialog' => [Dialog](../types/Dialog.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), \]; + +*** +

[$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) = \[\]; + +*** +

[$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), \]; + +*** +

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

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

[$urlAuthResultRequest](../constructors/urlAuthResultRequest.md) = \['request_write_access' => [Bool](../types/Bool.md), 'bot' => [User](../types/User.md), 'domain' => [string](../types/string.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), 'support' => [Bool](../types/Bool.md), 'scam' => [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' => \[[RestrictionReason](../types/RestrictionReason.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), 'can_pin_message' => [Bool](../types/Bool.md), 'has_scheduled' => [Bool](../types/Bool.md), 'user' => [User](../types/User.md), 'about' => [string](../types/string.md), 'settings' => [PeerSettings](../types/PeerSettings.md), 'profile_photo' => [Photo](../types/Photo.md), 'notify_settings' => [PeerNotifySettings](../types/PeerNotifySettings.md), 'bot_info' => [BotInfo](../types/BotInfo.md), 'pinned_msg_id' => [int](../types/int.md), 'common_chats_count' => [int](../types/int.md), 'folder_id' => [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), 'dc_id' => [int](../types/int.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' => [long](../types/long.md), 'creator' => [Bool](../types/Bool.md), 'default' => [Bool](../types/Bool.md), 'pattern' => [Bool](../types/Bool.md), 'dark' => [Bool](../types/Bool.md), 'access_hash' => [long](../types/long.md), 'slug' => [string](../types/string.md), 'document' => [Document](../types/Document.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]; + +*** +

[$wallPaperNoFile](../constructors/wallPaperNoFile.md) = \['default' => [Bool](../types/Bool.md), 'dark' => [Bool](../types/Bool.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]; + +*** +

[$wallPaperSettings](../constructors/wallPaperSettings.md) = \['blur' => [Bool](../types/Bool.md), 'motion' => [Bool](../types/Bool.md), 'background_color' => [int](../types/int.md), 'second_background_color' => [int](../types/int.md), 'intensity' => [int](../types/int.md), 'rotation' => [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)\], \]; + +*** +

[$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), 'attributes' => \[[WebPageAttribute](../types/WebPageAttribute.md)\], \]; + +*** +

[$webPageAttributeTheme](../constructors/webPageAttributeTheme.md) = \['documents' => \[[Document](../types/Document.md)\], 'settings' => [ThemeSettings](../types/ThemeSettings.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_v109/constructors/account.authorizationForm.md b/old_docs/API_docs_v109/constructors/account.authorizationForm.md new file mode 100644 index 00000000..f7ec34e2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.authorizationForm.md @@ -0,0 +1,43 @@ +--- +title: account.authorizationForm +description: [Telegram Passport](https://core.telegram.org/passport) authorization form +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_authorizationForm.html +--- +# Constructor: account.authorizationForm +[Back to constructors index](index.md) + + + +[Telegram Passport](https://core.telegram.org/passport) authorization form + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|required\_types|Array of [SecureRequiredType](../types/SecureRequiredType.md) | Yes|Required types| +|values|Array of [SecureValue](../types/SecureValue.md) | Yes|Values| +|errors|Array of [SecureValueError](../types/SecureValueError.md) | Yes|Errors| +|users|Array of [User](../types/User.md) | Yes|Users| +|privacy\_policy\_url|[string](../types/string.md) | Optional|URL of the service's privacy policy| + + + +### Type: [account.AuthorizationForm](../types/account.AuthorizationForm.md) + + +### Example: + +```php +$account.authorizationForm = ['_' => 'account.authorizationForm', 'required_types' => [SecureRequiredType, SecureRequiredType], 'values' => [SecureValue, SecureValue], 'errors' => [SecureValueError, SecureValueError], 'users' => [User, User], 'privacy_policy_url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +account.authorizationForm={_='account.authorizationForm', required_types={SecureRequiredType}, values={SecureValue}, errors={SecureValueError}, users={User}, privacy_policy_url='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.authorizations.md b/old_docs/API_docs_v109/constructors/account.authorizations.md new file mode 100644 index 00000000..409f413b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.authorizations.md @@ -0,0 +1,39 @@ +--- +title: account.authorizations +description: Logged-in sessions +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_authorizations.html +--- +# Constructor: account.authorizations +[Back to constructors index](index.md) + + + +Logged-in sessions + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|authorizations|Array of [Authorization](../types/Authorization.md) | Yes|Authorizations| + + + +### Type: [account.Authorizations](../types/account.Authorizations.md) + + +### Example: + +```php +$account.authorizations = ['_' => 'account.authorizations', 'authorizations' => [Authorization, Authorization]]; +``` + + +Or, if you're into Lua: + +```lua +account.authorizations={_='account.authorizations', authorizations={Authorization}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.autoDownloadSettings.md b/old_docs/API_docs_v109/constructors/account.autoDownloadSettings.md new file mode 100644 index 00000000..8ee5eae2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.autoDownloadSettings.md @@ -0,0 +1,41 @@ +--- +title: account.autoDownloadSettings +description: Media autodownload settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_autoDownloadSettings.html +--- +# Constructor: account.autoDownloadSettings +[Back to constructors index](index.md) + + + +Media autodownload settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|low|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Low data usage preset| +|medium|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|Medium data usage preset| +|high|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Yes|High data usage preset| + + + +### Type: [account.AutoDownloadSettings](../types/account.AutoDownloadSettings.md) + + +### Example: + +```php +$account.autoDownloadSettings = ['_' => 'account.autoDownloadSettings', 'low' => AutoDownloadSettings, 'medium' => AutoDownloadSettings, 'high' => AutoDownloadSettings]; +``` + + +Or, if you're into Lua: + +```lua +account.autoDownloadSettings={_='account.autoDownloadSettings', low=AutoDownloadSettings, medium=AutoDownloadSettings, high=AutoDownloadSettings} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.contentSettings.md b/old_docs/API_docs_v109/constructors/account.contentSettings.md new file mode 100644 index 00000000..3ff1948d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.contentSettings.md @@ -0,0 +1,38 @@ +--- +title: account.contentSettings +description: account.contentSettings attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_contentSettings.html +--- +# Constructor: account.contentSettings +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|sensitive\_enabled|[Bool](../types/Bool.md) | Optional| +|sensitive\_can\_change|[Bool](../types/Bool.md) | Optional| + + + +### Type: [account.ContentSettings](../types/account.ContentSettings.md) + + +### Example: + +```php +$account.contentSettings = ['_' => 'account.contentSettings', 'sensitive_enabled' => Bool, 'sensitive_can_change' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +account.contentSettings={_='account.contentSettings', sensitive_enabled=Bool, sensitive_can_change=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.password.md b/old_docs/API_docs_v109/constructors/account.password.md new file mode 100644 index 00000000..aac3a9cb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.password.md @@ -0,0 +1,49 @@ +--- +title: account.password +description: Configuration for two-factor authorization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_password.html +--- +# Constructor: account.password +[Back to constructors index](index.md) + + + +Configuration for two-factor authorization + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|has\_recovery|[Bool](../types/Bool.md) | Optional|Whether the user has a recovery method configured| +|has\_secure\_values|[Bool](../types/Bool.md) | Optional|Whether telegram [passport](https://core.telegram.org/passport) is enabled| +|has\_password|[Bool](../types/Bool.md) | Optional|Whether the user has a password| +|current\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|The [KDF algorithm for SRP two-factor authentication](https://core.telegram.org/api/srp) of the current password| +|srp\_B|[bytes](../types/bytes.md) | Optional|Srp B param for [SRP authorization](https://core.telegram.org/api/srp)| +|srp\_id|[long](../types/long.md) | Optional|Srp ID param for [SRP authorization](https://core.telegram.org/api/srp)| +|hint|[string](../types/string.md) | Optional|Text hint for the password| +|email\_unconfirmed\_pattern|[string](../types/string.md) | Optional|A [password recovery email](https://core.telegram.org/api/srp#email-verification) with the specified [pattern](https://core.telegram.org/api/pattern) is still awaiting verification| +|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Yes|The [KDF algorithm for SRP two-factor authentication](https://core.telegram.org/api/srp) to use when creating new passwords| +|new\_secure\_algo|[SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) | Yes|The KDF algorithm for telegram [passport](https://core.telegram.org/passport)| +|secure\_random|[bytes](../types/bytes.md) | Yes|Secure random string| + + + +### Type: [account.Password](../types/account.Password.md) + + +### Example: + +```php +$account.password = ['_' => 'account.password', 'has_recovery' => Bool, 'has_secure_values' => Bool, 'has_password' => Bool, 'current_algo' => PasswordKdfAlgo, 'srp_B' => 'bytes', 'srp_id' => long, 'hint' => 'string', 'email_unconfirmed_pattern' => 'string', 'new_algo' => PasswordKdfAlgo, 'new_secure_algo' => SecurePasswordKdfAlgo, 'secure_random' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +account.password={_='account.password', has_recovery=Bool, has_secure_values=Bool, has_password=Bool, current_algo=PasswordKdfAlgo, srp_B='bytes', srp_id=long, hint='string', email_unconfirmed_pattern='string', new_algo=PasswordKdfAlgo, new_secure_algo=SecurePasswordKdfAlgo, secure_random='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.passwordInputSettings.md b/old_docs/API_docs_v109/constructors/account.passwordInputSettings.md new file mode 100644 index 00000000..5ee5bb14 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.passwordInputSettings.md @@ -0,0 +1,43 @@ +--- +title: account.passwordInputSettings +description: Settings for setting up a new password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_passwordInputSettings.html +--- +# Constructor: account.passwordInputSettings +[Back to constructors index](index.md) + + + +Settings for setting up a new password + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|new\_algo|[PasswordKdfAlgo](../types/PasswordKdfAlgo.md) | Optional|The [SRP algorithm](https://core.telegram.org/api/srp) to use| +|new\_password\_hash|[bytes](../types/bytes.md) | Optional|The [computed password hash](https://core.telegram.org/api/srp)| +|hint|[string](../types/string.md) | Optional|Text hint for the password| +|email|[string](../types/string.md) | Optional|Password recovery email| +|new\_secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|Telegram [passport](https://core.telegram.org/passport) settings| + + + +### Type: [account.PasswordInputSettings](../types/account.PasswordInputSettings.md) + + +### Example: + +```php +$account.passwordInputSettings = ['_' => 'account.passwordInputSettings', 'new_algo' => PasswordKdfAlgo, 'new_password_hash' => 'bytes', 'hint' => 'string', 'email' => 'string', 'new_secure_settings' => SecureSecretSettings]; +``` + + +Or, if you're into Lua: + +```lua +account.passwordInputSettings={_='account.passwordInputSettings', new_algo=PasswordKdfAlgo, new_password_hash='bytes', hint='string', email='string', new_secure_settings=SecureSecretSettings} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.passwordSettings.md b/old_docs/API_docs_v109/constructors/account.passwordSettings.md new file mode 100644 index 00000000..48ea719d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.passwordSettings.md @@ -0,0 +1,40 @@ +--- +title: account.passwordSettings +description: Private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_passwordSettings.html +--- +# Constructor: account.passwordSettings +[Back to constructors index](index.md) + + + +Private info associated to the password info (recovery email, telegram [passport](https://core.telegram.org/passport) info & so on) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|email|[string](../types/string.md) | Optional|[2FA Recovery email](https://core.telegram.org/api/srp#email-verification)| +|secure\_settings|[SecureSecretSettings](../types/SecureSecretSettings.md) | Optional|Telegram [passport](https://core.telegram.org/passport) settings| + + + +### Type: [account.PasswordSettings](../types/account.PasswordSettings.md) + + +### Example: + +```php +$account.passwordSettings = ['_' => 'account.passwordSettings', 'email' => 'string', 'secure_settings' => SecureSecretSettings]; +``` + + +Or, if you're into Lua: + +```lua +account.passwordSettings={_='account.passwordSettings', email='string', secure_settings=SecureSecretSettings} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.privacyRules.md b/old_docs/API_docs_v109/constructors/account.privacyRules.md new file mode 100644 index 00000000..ce37689a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.privacyRules.md @@ -0,0 +1,41 @@ +--- +title: account.privacyRules +description: Privacy rules +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_privacyRules.html +--- +# Constructor: account.privacyRules +[Back to constructors index](index.md) + + + +Privacy rules + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes|Rules| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats allowed?| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [account.PrivacyRules](../types/account.PrivacyRules.md) + + +### Example: + +```php +$account.privacyRules = ['_' => 'account.privacyRules', 'rules' => [PrivacyRule, PrivacyRule], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +account.privacyRules={_='account.privacyRules', rules={PrivacyRule}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.sentEmailCode.md b/old_docs/API_docs_v109/constructors/account.sentEmailCode.md new file mode 100644 index 00000000..f8224f8f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.sentEmailCode.md @@ -0,0 +1,40 @@ +--- +title: account.sentEmailCode +description: The sent email code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_sentEmailCode.html +--- +# Constructor: account.sentEmailCode +[Back to constructors index](index.md) + + + +The sent email code + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|email\_pattern|[string](../types/string.md) | Yes|The email (to which the code was sent) must match this [pattern](https://core.telegram.org/api/pattern)| +|length|[int](../types/int.md) | Yes|The length of the verification code| + + + +### Type: [account.SentEmailCode](../types/account.SentEmailCode.md) + + +### Example: + +```php +$account.sentEmailCode = ['_' => 'account.sentEmailCode', 'email_pattern' => 'string', 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +account.sentEmailCode={_='account.sentEmailCode', email_pattern='string', length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.takeout.md b/old_docs/API_docs_v109/constructors/account.takeout.md new file mode 100644 index 00000000..5607b9f1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.takeout.md @@ -0,0 +1,39 @@ +--- +title: account.takeout +description: Takout info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_takeout.html +--- +# Constructor: account.takeout +[Back to constructors index](index.md) + + + +Takout info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Takeout ID| + + + +### Type: [account.Takeout](../types/account.Takeout.md) + + +### Example: + +```php +$account.takeout = ['_' => 'account.takeout', 'id' => long]; +``` + + +Or, if you're into Lua: + +```lua +account.takeout={_='account.takeout', id=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.themes.md b/old_docs/API_docs_v109/constructors/account.themes.md new file mode 100644 index 00000000..ac568454 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.themes.md @@ -0,0 +1,40 @@ +--- +title: account.themes +description: Installed themes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_themes.html +--- +# Constructor: account.themes +[Back to constructors index](index.md) + + + +Installed themes + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| +|themes|Array of [Theme](../types/Theme.md) | Yes|Themes| + + + +### Type: [account.Themes](../types/account.Themes.md) + + +### Example: + +```php +$account.themes = ['_' => 'account.themes', 'hash' => int, 'themes' => [Theme, Theme]]; +``` + + +Or, if you're into Lua: + +```lua +account.themes={_='account.themes', hash=int, themes={Theme}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.themesNotModified.md b/old_docs/API_docs_v109/constructors/account.themesNotModified.md new file mode 100644 index 00000000..68e94240 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.themesNotModified.md @@ -0,0 +1,34 @@ +--- +title: account.themesNotModified +description: No new themes were installed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_themesNotModified.html +--- +# Constructor: account.themesNotModified +[Back to constructors index](index.md) + + + +No new themes were installed + + + + +### Type: [account.Themes](../types/account.Themes.md) + + +### Example: + +```php +$account.themesNotModified = ['_' => 'account.themesNotModified']; +``` + + +Or, if you're into Lua: + +```lua +account.themesNotModified={_='account.themesNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.tmpPassword.md b/old_docs/API_docs_v109/constructors/account.tmpPassword.md new file mode 100644 index 00000000..3c1e5177 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.tmpPassword.md @@ -0,0 +1,40 @@ +--- +title: account.tmpPassword +description: Temporary payment password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_tmpPassword.html +--- +# Constructor: account.tmpPassword +[Back to constructors index](index.md) + + + +Temporary payment password + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|tmp\_password|[bytes](../types/bytes.md) | Yes|Temporary password| +|valid\_until|[int](../types/int.md) | Yes|Validity period| + + + +### Type: [account.TmpPassword](../types/account.TmpPassword.md) + + +### Example: + +```php +$account.tmpPassword = ['_' => 'account.tmpPassword', 'tmp_password' => 'bytes', 'valid_until' => int]; +``` + + +Or, if you're into Lua: + +```lua +account.tmpPassword={_='account.tmpPassword', tmp_password='bytes', valid_until=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.wallPapers.md b/old_docs/API_docs_v109/constructors/account.wallPapers.md new file mode 100644 index 00000000..951b6df8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.wallPapers.md @@ -0,0 +1,40 @@ +--- +title: account.wallPapers +description: Installed wallpapers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_wallPapers.html +--- +# Constructor: account.wallPapers +[Back to constructors index](index.md) + + + +Installed wallpapers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| +|wallpapers|Array of [WallPaper](../types/WallPaper.md) | Yes|Wallpapers| + + + +### Type: [account.WallPapers](../types/account.WallPapers.md) + + +### Example: + +```php +$account.wallPapers = ['_' => 'account.wallPapers', 'hash' => int, 'wallpapers' => [WallPaper, WallPaper]]; +``` + + +Or, if you're into Lua: + +```lua +account.wallPapers={_='account.wallPapers', hash=int, wallpapers={WallPaper}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.wallPapersNotModified.md b/old_docs/API_docs_v109/constructors/account.wallPapersNotModified.md new file mode 100644 index 00000000..ea17552d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.wallPapersNotModified.md @@ -0,0 +1,34 @@ +--- +title: account.wallPapersNotModified +description: No new wallpapers were found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_wallPapersNotModified.html +--- +# Constructor: account.wallPapersNotModified +[Back to constructors index](index.md) + + + +No new wallpapers were found + + + + +### Type: [account.WallPapers](../types/account.WallPapers.md) + + +### Example: + +```php +$account.wallPapersNotModified = ['_' => 'account.wallPapersNotModified']; +``` + + +Or, if you're into Lua: + +```lua +account.wallPapersNotModified={_='account.wallPapersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/account.webAuthorizations.md b/old_docs/API_docs_v109/constructors/account.webAuthorizations.md new file mode 100644 index 00000000..cfb4d6ba --- /dev/null +++ b/old_docs/API_docs_v109/constructors/account.webAuthorizations.md @@ -0,0 +1,40 @@ +--- +title: account.webAuthorizations +description: Web authorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/account_webAuthorizations.html +--- +# Constructor: account.webAuthorizations +[Back to constructors index](index.md) + + + +Web authorizations + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|authorizations|Array of [WebAuthorization](../types/WebAuthorization.md) | Yes|Authorizations| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [account.WebAuthorizations](../types/account.WebAuthorizations.md) + + +### Example: + +```php +$account.webAuthorizations = ['_' => 'account.webAuthorizations', 'authorizations' => [WebAuthorization, WebAuthorization], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +account.webAuthorizations={_='account.webAuthorizations', authorizations={WebAuthorization}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/accountDaysTTL.md b/old_docs/API_docs_v109/constructors/accountDaysTTL.md new file mode 100644 index 00000000..ccad27c4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/accountDaysTTL.md @@ -0,0 +1,38 @@ +--- +title: accountDaysTTL +description: Time to live in days of the current account +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: accountDaysTTL +[Back to constructors index](index.md) + + + +Time to live in days of the current account + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|days|[int](../types/int.md) | Yes|This account will self-destruct in the specified number of days| + + + +### Type: [AccountDaysTTL](../types/AccountDaysTTL.md) + + +### Example: + +```php +$accountDaysTTL = ['_' => 'accountDaysTTL', 'days' => int]; +``` + + +Or, if you're into Lua: + +```lua +accountDaysTTL={_='accountDaysTTL', days=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.authorization.md b/old_docs/API_docs_v109/constructors/auth.authorization.md new file mode 100644 index 00000000..e08628fb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.authorization.md @@ -0,0 +1,40 @@ +--- +title: auth.authorization +description: Contains user authorization info. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_authorization.html +--- +# Constructor: auth.authorization +[Back to constructors index](index.md) + + + +Contains user authorization info. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|tmp\_sessions|[int](../types/int.md) | Optional|Temporary [passport](https://core.telegram.org/passport) sessions| +|user|[User](../types/User.md) | Optional|Info on authorized user| + + + +### Type: [auth.Authorization](../types/auth.Authorization.md) + + +### Example: + +```php +$auth.authorization = ['_' => 'auth.authorization', 'tmp_sessions' => int, 'user' => User]; +``` + + +Or, if you're into Lua: + +```lua +auth.authorization={_='auth.authorization', tmp_sessions=int, user=User} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.authorizationSignUpRequired.md b/old_docs/API_docs_v109/constructors/auth.authorizationSignUpRequired.md new file mode 100644 index 00000000..8a91fccb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.authorizationSignUpRequired.md @@ -0,0 +1,39 @@ +--- +title: auth.authorizationSignUpRequired +description: An account with this phone number doesn't exist on telegram: the user has to [enter basic information and sign up](https://core.telegram.org/api/auth) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_authorizationSignUpRequired.html +--- +# Constructor: auth.authorizationSignUpRequired +[Back to constructors index](index.md) + + + +An account with this phone number doesn't exist on telegram: the user has to [enter basic information and sign up](https://core.telegram.org/api/auth) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|terms\_of\_service|[help.TermsOfService](../constructors/help.TermsOfService.md) | Optional|Telegram's terms of service: the user must read and accept the terms of service before signing up to telegram| + + + +### Type: [auth.Authorization](../types/auth.Authorization.md) + + +### Example: + +```php +$auth.authorizationSignUpRequired = ['_' => 'auth.authorizationSignUpRequired', 'terms_of_service' => help.TermsOfService]; +``` + + +Or, if you're into Lua: + +```lua +auth.authorizationSignUpRequired={_='auth.authorizationSignUpRequired', terms_of_service=help.TermsOfService} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.codeTypeCall.md b/old_docs/API_docs_v109/constructors/auth.codeTypeCall.md new file mode 100644 index 00000000..9296b8f4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.codeTypeCall.md @@ -0,0 +1,34 @@ +--- +title: auth.codeTypeCall +description: Type of verification code that will be sent next if you call the resendCode method: SMS code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_codeTypeCall.html +--- +# Constructor: auth.codeTypeCall +[Back to constructors index](index.md) + + + +Type of verification code that will be sent next if you call the resendCode method: SMS code + + + + +### Type: [auth.CodeType](../types/auth.CodeType.md) + + +### Example: + +```php +$auth.codeTypeCall = ['_' => 'auth.codeTypeCall']; +``` + + +Or, if you're into Lua: + +```lua +auth.codeTypeCall={_='auth.codeTypeCall'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.codeTypeFlashCall.md b/old_docs/API_docs_v109/constructors/auth.codeTypeFlashCall.md new file mode 100644 index 00000000..6e27ca34 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.codeTypeFlashCall.md @@ -0,0 +1,34 @@ +--- +title: auth.codeTypeFlashCall +description: Type of verification code that will be sent next if you call the resendCode method: SMS code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_codeTypeFlashCall.html +--- +# Constructor: auth.codeTypeFlashCall +[Back to constructors index](index.md) + + + +Type of verification code that will be sent next if you call the resendCode method: SMS code + + + + +### Type: [auth.CodeType](../types/auth.CodeType.md) + + +### Example: + +```php +$auth.codeTypeFlashCall = ['_' => 'auth.codeTypeFlashCall']; +``` + + +Or, if you're into Lua: + +```lua +auth.codeTypeFlashCall={_='auth.codeTypeFlashCall'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.codeTypeSms.md b/old_docs/API_docs_v109/constructors/auth.codeTypeSms.md new file mode 100644 index 00000000..084bcbd2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.codeTypeSms.md @@ -0,0 +1,34 @@ +--- +title: auth.codeTypeSms +description: Type of verification code that will be sent next if you call the resendCode method: SMS code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_codeTypeSms.html +--- +# Constructor: auth.codeTypeSms +[Back to constructors index](index.md) + + + +Type of verification code that will be sent next if you call the resendCode method: SMS code + + + + +### Type: [auth.CodeType](../types/auth.CodeType.md) + + +### Example: + +```php +$auth.codeTypeSms = ['_' => 'auth.codeTypeSms']; +``` + + +Or, if you're into Lua: + +```lua +auth.codeTypeSms={_='auth.codeTypeSms'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.exportedAuthorization.md b/old_docs/API_docs_v109/constructors/auth.exportedAuthorization.md new file mode 100644 index 00000000..842ed2e9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.exportedAuthorization.md @@ -0,0 +1,40 @@ +--- +title: auth.exportedAuthorization +description: Data for copying of authorization between data centres. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_exportedAuthorization.html +--- +# Constructor: auth.exportedAuthorization +[Back to constructors index](index.md) + + + +Data for copying of authorization between data centres. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Current user identifier| +|bytes|[bytes](../types/bytes.md) | Yes|Authorizes key| + + + +### Type: [auth.ExportedAuthorization](../types/auth.ExportedAuthorization.md) + + +### Example: + +```php +$auth.exportedAuthorization = ['_' => 'auth.exportedAuthorization', 'id' => int, 'bytes' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +auth.exportedAuthorization={_='auth.exportedAuthorization', id=int, bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.loginToken.md b/old_docs/API_docs_v109/constructors/auth.loginToken.md new file mode 100644 index 00000000..82828717 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.loginToken.md @@ -0,0 +1,38 @@ +--- +title: auth.loginToken +description: auth.loginToken attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_loginToken.html +--- +# Constructor: auth.loginToken +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|expires|[int](../types/int.md) | Yes| +|token|[bytes](../types/bytes.md) | Yes| + + + +### Type: [auth.LoginToken](../types/auth.LoginToken.md) + + +### Example: + +```php +$auth.loginToken = ['_' => 'auth.loginToken', 'expires' => int, 'token' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +auth.loginToken={_='auth.loginToken', expires=int, token='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.loginTokenMigrateTo.md b/old_docs/API_docs_v109/constructors/auth.loginTokenMigrateTo.md new file mode 100644 index 00000000..8bde1662 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.loginTokenMigrateTo.md @@ -0,0 +1,38 @@ +--- +title: auth.loginTokenMigrateTo +description: auth.loginTokenMigrateTo attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_loginTokenMigrateTo.html +--- +# Constructor: auth.loginTokenMigrateTo +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|dc\_id|[int](../types/int.md) | Yes| +|token|[bytes](../types/bytes.md) | Yes| + + + +### Type: [auth.LoginToken](../types/auth.LoginToken.md) + + +### Example: + +```php +$auth.loginTokenMigrateTo = ['_' => 'auth.loginTokenMigrateTo', 'dc_id' => int, 'token' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +auth.loginTokenMigrateTo={_='auth.loginTokenMigrateTo', dc_id=int, token='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.loginTokenSuccess.md b/old_docs/API_docs_v109/constructors/auth.loginTokenSuccess.md new file mode 100644 index 00000000..94eb3d9c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.loginTokenSuccess.md @@ -0,0 +1,37 @@ +--- +title: auth.loginTokenSuccess +description: auth.loginTokenSuccess attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_loginTokenSuccess.html +--- +# Constructor: auth.loginTokenSuccess +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|authorization|[auth.Authorization](../constructors/auth.Authorization.md) | Yes| + + + +### Type: [auth.LoginToken](../types/auth.LoginToken.md) + + +### Example: + +```php +$auth.loginTokenSuccess = ['_' => 'auth.loginTokenSuccess', 'authorization' => auth.Authorization]; +``` + + +Or, if you're into Lua: + +```lua +auth.loginTokenSuccess={_='auth.loginTokenSuccess', authorization=auth.Authorization} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.passwordRecovery.md b/old_docs/API_docs_v109/constructors/auth.passwordRecovery.md new file mode 100644 index 00000000..7022f8f2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.passwordRecovery.md @@ -0,0 +1,39 @@ +--- +title: auth.passwordRecovery +description: Recovery info of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_passwordRecovery.html +--- +# Constructor: auth.passwordRecovery +[Back to constructors index](index.md) + + + +Recovery info of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|email\_pattern|[string](../types/string.md) | Yes|The email to which the recovery code was sent must match this [pattern](https://core.telegram.org/api/pattern).| + + + +### Type: [auth.PasswordRecovery](../types/auth.PasswordRecovery.md) + + +### Example: + +```php +$auth.passwordRecovery = ['_' => 'auth.passwordRecovery', 'email_pattern' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +auth.passwordRecovery={_='auth.passwordRecovery', email_pattern='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.sentCode.md b/old_docs/API_docs_v109/constructors/auth.sentCode.md new file mode 100644 index 00000000..6ee30f4d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.sentCode.md @@ -0,0 +1,42 @@ +--- +title: auth.sentCode +description: Contains info about a sent verification code. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_sentCode.html +--- +# Constructor: auth.sentCode +[Back to constructors index](index.md) + + + +Contains info about a sent verification code. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[auth.SentCodeType](../constructors/auth.SentCodeType.md) | Yes|Phone code type| +|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash, to be stored and later re-used with [auth.signIn](../methods/auth.signIn.md)| +|next\_type|[auth.CodeType](../constructors/auth.CodeType.md) | Optional|Phone code type that will be sent next, if the phone code is not received within `timeout` seconds: to send it use [auth.resendCode](../methods/auth.resendCode.md)| +|timeout|[int](../types/int.md) | Optional|Timeout for reception of the phone code| + + + +### Type: [auth.SentCode](../types/auth.SentCode.md) + + +### Example: + +```php +$auth.sentCode = ['_' => 'auth.sentCode', 'type' => auth.SentCodeType, 'phone_code_hash' => 'string', 'next_type' => auth.CodeType, 'timeout' => int]; +``` + + +Or, if you're into Lua: + +```lua +auth.sentCode={_='auth.sentCode', type=auth.SentCodeType, phone_code_hash='string', next_type=auth.CodeType, timeout=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.sentCodeTypeApp.md b/old_docs/API_docs_v109/constructors/auth.sentCodeTypeApp.md new file mode 100644 index 00000000..1f92677c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.sentCodeTypeApp.md @@ -0,0 +1,39 @@ +--- +title: auth.sentCodeTypeApp +description: The code was sent through the telegram app +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_sentCodeTypeApp.html +--- +# Constructor: auth.sentCodeTypeApp +[Back to constructors index](index.md) + + + +The code was sent through the telegram app + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|length|[int](../types/int.md) | Yes|Length of the code in bytes| + + + +### Type: [auth.SentCodeType](../types/auth.SentCodeType.md) + + +### Example: + +```php +$auth.sentCodeTypeApp = ['_' => 'auth.sentCodeTypeApp', 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +auth.sentCodeTypeApp={_='auth.sentCodeTypeApp', length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.sentCodeTypeCall.md b/old_docs/API_docs_v109/constructors/auth.sentCodeTypeCall.md new file mode 100644 index 00000000..9cdce935 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.sentCodeTypeCall.md @@ -0,0 +1,39 @@ +--- +title: auth.sentCodeTypeCall +description: The code will be sent via a phone call: a synthesized voice will tell the user which verification code to input. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_sentCodeTypeCall.html +--- +# Constructor: auth.sentCodeTypeCall +[Back to constructors index](index.md) + + + +The code will be sent via a phone call: a synthesized voice will tell the user which verification code to input. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|length|[int](../types/int.md) | Yes|Length of the verification code| + + + +### Type: [auth.SentCodeType](../types/auth.SentCodeType.md) + + +### Example: + +```php +$auth.sentCodeTypeCall = ['_' => 'auth.sentCodeTypeCall', 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +auth.sentCodeTypeCall={_='auth.sentCodeTypeCall', length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.sentCodeTypeFlashCall.md b/old_docs/API_docs_v109/constructors/auth.sentCodeTypeFlashCall.md new file mode 100644 index 00000000..38e2b195 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.sentCodeTypeFlashCall.md @@ -0,0 +1,39 @@ +--- +title: auth.sentCodeTypeFlashCall +description: The code will be sent via a flash phone call, that will be closed immediately. The phone code will then be the phone number itself, just make sure that the phone number matches the specified pattern. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_sentCodeTypeFlashCall.html +--- +# Constructor: auth.sentCodeTypeFlashCall +[Back to constructors index](index.md) + + + +The code will be sent via a flash phone call, that will be closed immediately. The phone code will then be the phone number itself, just make sure that the phone number matches the specified pattern. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pattern|[string](../types/string.md) | Yes|[pattern](https://core.telegram.org/api/pattern) to match| + + + +### Type: [auth.SentCodeType](../types/auth.SentCodeType.md) + + +### Example: + +```php +$auth.sentCodeTypeFlashCall = ['_' => 'auth.sentCodeTypeFlashCall', 'pattern' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +auth.sentCodeTypeFlashCall={_='auth.sentCodeTypeFlashCall', pattern='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/auth.sentCodeTypeSms.md b/old_docs/API_docs_v109/constructors/auth.sentCodeTypeSms.md new file mode 100644 index 00000000..bb4d5084 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/auth.sentCodeTypeSms.md @@ -0,0 +1,39 @@ +--- +title: auth.sentCodeTypeSms +description: The code was sent via SMS +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/auth_sentCodeTypeSms.html +--- +# Constructor: auth.sentCodeTypeSms +[Back to constructors index](index.md) + + + +The code was sent via SMS + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|length|[int](../types/int.md) | Yes|Length of the code in bytes| + + + +### Type: [auth.SentCodeType](../types/auth.SentCodeType.md) + + +### Example: + +```php +$auth.sentCodeTypeSms = ['_' => 'auth.sentCodeTypeSms', 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +auth.sentCodeTypeSms={_='auth.sentCodeTypeSms', length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/authorization.md b/old_docs/API_docs_v109/constructors/authorization.md new file mode 100644 index 00000000..a9862412 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/authorization.md @@ -0,0 +1,52 @@ +--- +title: authorization +description: Logged-in session +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: authorization +[Back to constructors index](index.md) + + + +Logged-in session + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|current|[Bool](../types/Bool.md) | Optional|Whether this is the current session| +|official\_app|[Bool](../types/Bool.md) | Optional|Whether the session is from an official app| +|password\_pending|[Bool](../types/Bool.md) | Optional|Whether the session is still waiting for a 2FA password| +|hash|[long](../types/long.md) | Yes|Identifier| +|device\_model|[string](../types/string.md) | Yes|Device model| +|platform|[string](../types/string.md) | Yes|Platform| +|system\_version|[string](../types/string.md) | Yes|System version| +|api\_id|[int](../types/int.md) | Yes|[API ID](https://core.telegram.org/api/obtaining_api_id)| +|app\_name|[string](../types/string.md) | Yes|App name| +|app\_version|[string](../types/string.md) | Yes|App version| +|date\_created|[int](../types/int.md) | Yes|When was the session created| +|date\_active|[int](../types/int.md) | Yes|When was the session last active| +|ip|[string](../types/string.md) | Yes|Last known IP| +|country|[string](../types/string.md) | Yes|Country determined from IP| +|region|[string](../types/string.md) | Yes|Region determined from IP| + + + +### Type: [Authorization](../types/Authorization.md) + + +### Example: + +```php +$authorization = ['_' => 'authorization', 'current' => Bool, 'official_app' => Bool, 'password_pending' => Bool, '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: + +```lua +authorization={_='authorization', current=Bool, official_app=Bool, password_pending=Bool, 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_v109/constructors/autoDownloadSettings.md b/old_docs/API_docs_v109/constructors/autoDownloadSettings.md new file mode 100644 index 00000000..64f83144 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/autoDownloadSettings.md @@ -0,0 +1,45 @@ +--- +title: autoDownloadSettings +description: Autodownload settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: autoDownloadSettings +[Back to constructors index](index.md) + + + +Autodownload settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|disabled|[Bool](../types/Bool.md) | Optional|Disable automatic media downloads?| +|video\_preload\_large|[Bool](../types/Bool.md) | Optional|Whether to preload the first seconds of videos larger than the specified limit| +|audio\_preload\_next|[Bool](../types/Bool.md) | Optional|Whether to preload the next audio track when you're listening to music| +|phonecalls\_less\_data|[Bool](../types/Bool.md) | Optional|Whether to enable data saving mode in phone calls| +|photo\_size\_max|[int](../types/int.md) | Yes|Maximum size of photos to preload| +|video\_size\_max|[int](../types/int.md) | Yes|Maximum size of videos to preload| +|file\_size\_max|[int](../types/int.md) | Yes|Maximum size of other files to preload| +|video\_upload\_maxbitrate|[int](../types/int.md) | Yes|| + + + +### Type: [AutoDownloadSettings](../types/AutoDownloadSettings.md) + + +### Example: + +```php +$autoDownloadSettings = ['_' => 'autoDownloadSettings', 'disabled' => Bool, 'video_preload_large' => Bool, 'audio_preload_next' => Bool, 'phonecalls_less_data' => Bool, 'photo_size_max' => int, 'video_size_max' => int, 'file_size_max' => int, 'video_upload_maxbitrate' => int]; +``` + + +Or, if you're into Lua: + +```lua +autoDownloadSettings={_='autoDownloadSettings', disabled=Bool, video_preload_large=Bool, audio_preload_next=Bool, phonecalls_less_data=Bool, photo_size_max=int, video_size_max=int, file_size_max=int, video_upload_maxbitrate=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/baseThemeArctic.md b/old_docs/API_docs_v109/constructors/baseThemeArctic.md new file mode 100644 index 00000000..38a27268 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/baseThemeArctic.md @@ -0,0 +1,31 @@ +--- +title: baseThemeArctic +description: baseThemeArctic attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeArctic +[Back to constructors index](index.md) + + + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeArctic = ['_' => 'baseThemeArctic']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeArctic={_='baseThemeArctic'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/baseThemeClassic.md b/old_docs/API_docs_v109/constructors/baseThemeClassic.md new file mode 100644 index 00000000..7a1760e1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/baseThemeClassic.md @@ -0,0 +1,31 @@ +--- +title: baseThemeClassic +description: baseThemeClassic attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeClassic +[Back to constructors index](index.md) + + + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeClassic = ['_' => 'baseThemeClassic']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeClassic={_='baseThemeClassic'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/baseThemeDay.md b/old_docs/API_docs_v109/constructors/baseThemeDay.md new file mode 100644 index 00000000..0928893b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/baseThemeDay.md @@ -0,0 +1,31 @@ +--- +title: baseThemeDay +description: baseThemeDay attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeDay +[Back to constructors index](index.md) + + + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeDay = ['_' => 'baseThemeDay']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeDay={_='baseThemeDay'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/baseThemeNight.md b/old_docs/API_docs_v109/constructors/baseThemeNight.md new file mode 100644 index 00000000..90ff56a1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/baseThemeNight.md @@ -0,0 +1,31 @@ +--- +title: baseThemeNight +description: baseThemeNight attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeNight +[Back to constructors index](index.md) + + + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeNight = ['_' => 'baseThemeNight']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeNight={_='baseThemeNight'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/baseThemeTinted.md b/old_docs/API_docs_v109/constructors/baseThemeTinted.md new file mode 100644 index 00000000..c7a2d898 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/baseThemeTinted.md @@ -0,0 +1,31 @@ +--- +title: baseThemeTinted +description: baseThemeTinted attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: baseThemeTinted +[Back to constructors index](index.md) + + + + + + +### Type: [BaseTheme](../types/BaseTheme.md) + + +### Example: + +```php +$baseThemeTinted = ['_' => 'baseThemeTinted']; +``` + + +Or, if you're into Lua: + +```lua +baseThemeTinted={_='baseThemeTinted'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/boolFalse.md b/old_docs/API_docs_v109/constructors/boolFalse.md new file mode 100644 index 00000000..350811df --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/constructors/boolTrue.md b/old_docs/API_docs_v109/constructors/boolTrue.md new file mode 100644 index 00000000..a7de7705 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/constructors/botCommand.md b/old_docs/API_docs_v109/constructors/botCommand.md new file mode 100644 index 00000000..0ef50e29 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/botCommand.md @@ -0,0 +1,39 @@ +--- +title: botCommand +description: Describes a bot command that can be used in a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botCommand +[Back to constructors index](index.md) + + + +Describes a bot command that can be used in a chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|command|[string](../types/string.md) | Yes|`/command` name| +|description|[string](../types/string.md) | Yes|Description of the command| + + + +### Type: [BotCommand](../types/BotCommand.md) + + +### Example: + +```php +$botCommand = ['_' => 'botCommand', 'command' => 'string', 'description' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +botCommand={_='botCommand', command='string', description='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/botInfo.md b/old_docs/API_docs_v109/constructors/botInfo.md new file mode 100644 index 00000000..2eafa260 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/botInfo.md @@ -0,0 +1,40 @@ +--- +title: botInfo +description: Info about bots (available bot commands, etc) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInfo +[Back to constructors index](index.md) + + + +Info about bots (available bot commands, etc) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|ID of the bot| +|description|[string](../types/string.md) | Yes|Description of the bot| +|commands|Array of [BotCommand](../types/BotCommand.md) | Yes|Commands| + + + +### Type: [BotInfo](../types/BotInfo.md) + + +### Example: + +```php +$botInfo = ['_' => 'botInfo', 'user_id' => int, 'description' => 'string', 'commands' => [BotCommand, BotCommand]]; +``` + + +Or, if you're into Lua: + +```lua +botInfo={_='botInfo', user_id=int, description='string', commands={BotCommand}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/botInlineMediaResult.md b/old_docs/API_docs_v109/constructors/botInlineMediaResult.md new file mode 100644 index 00000000..c128149f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/botInlineMediaResult.md @@ -0,0 +1,44 @@ +--- +title: botInlineMediaResult +description: Media result +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMediaResult +[Back to constructors index](index.md) + + + +Media result + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Result ID| +|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))| +|photo|[Photo](../types/Photo.md) | Optional|If type is `photo`, the photo to send| +|document|[Document](../types/Document.md) | Optional|If type is `document`, the document to send| +|title|[string](../types/string.md) | Optional|Result title| +|description|[string](../types/string.md) | Optional|Description| +|send\_message|[BotInlineMessage](../types/BotInlineMessage.md) | Yes|Depending on the `type` and on the [constructor](../types/BotInlineMessage.md), contains the caption of the media or the content of the message to be sent **instead** of the media| + + + +### Type: [BotInlineResult](../types/BotInlineResult.md) + + +### Example: + +```php +$botInlineMediaResult = ['_' => 'botInlineMediaResult', 'id' => 'string', 'type' => 'string', 'photo' => Photo, 'document' => Document, 'title' => 'string', 'description' => 'string', 'send_message' => BotInlineMessage]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/botInlineMessageMediaAuto.md b/old_docs/API_docs_v109/constructors/botInlineMessageMediaAuto.md new file mode 100644 index 00000000..298fce7a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/botInlineMessageMediaAuto.md @@ -0,0 +1,46 @@ +--- +title: botInlineMessageMediaAuto +description: Send whatever media is attached to the [botInlineMediaResult](../constructors/botInlineMediaResult.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaAuto +[Back to constructors index](index.md) + + + +Send whatever media is attached to the [botInlineMediaResult](../constructors/botInlineMediaResult.md) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[string](../types/string.md) | Yes|Caption| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +```php +$botInlineMessageMediaAuto = ['_' => 'botInlineMessageMediaAuto', 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/botInlineMessageMediaContact.md b/old_docs/API_docs_v109/constructors/botInlineMessageMediaContact.md new file mode 100644 index 00000000..f9041fb5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/botInlineMessageMediaContact.md @@ -0,0 +1,48 @@ +--- +title: botInlineMessageMediaContact +description: Send a contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaContact +[Back to constructors index](index.md) + + + +Send a contact + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|first\_name|[string](../types/string.md) | Yes|First name| +|last\_name|[string](../types/string.md) | Yes|Last name| +|vcard|[string](../types/string.md) | Yes|VCard info| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +```php +$botInlineMessageMediaContact = ['_' => 'botInlineMessageMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'vcard' => 'string', 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +botInlineMessageMediaContact={_='botInlineMessageMediaContact', phone_number='string', first_name='string', last_name='string', vcard='string', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v109/constructors/botInlineMessageMediaGeo.md b/old_docs/API_docs_v109/constructors/botInlineMessageMediaGeo.md new file mode 100644 index 00000000..b9b01f35 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/botInlineMessageMediaGeo.md @@ -0,0 +1,46 @@ +--- +title: botInlineMessageMediaGeo +description: Send a geolocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaGeo +[Back to constructors index](index.md) + + + +Send a geolocation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Geolocation| +|period|[int](../types/int.md) | Yes|Validity period| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +```php +$botInlineMessageMediaGeo = ['_' => 'botInlineMessageMediaGeo', 'geo' => GeoPoint, 'period' => int, 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/botInlineMessageMediaVenue.md b/old_docs/API_docs_v109/constructors/botInlineMessageMediaVenue.md new file mode 100644 index 00000000..1ac6c581 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/botInlineMessageMediaVenue.md @@ -0,0 +1,50 @@ +--- +title: botInlineMessageMediaVenue +description: Send a venue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageMediaVenue +[Back to constructors index](index.md) + + + +Send a venue + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Geolocation of venue| +|title|[string](../types/string.md) | Yes|Venue name| +|address|[string](../types/string.md) | Yes|Address| +|provider|[string](../types/string.md) | Yes|Venue provider: currently only "foursquare" needs to be supported| +|venue\_id|[string](../types/string.md) | Yes|Venue ID in the provider's database| +|venue\_type|[string](../types/string.md) | Yes|Venue type in the provider's database| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +```php +$botInlineMessageMediaVenue = ['_' => 'botInlineMessageMediaVenue', 'geo' => GeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string', 'venue_type' => 'string', 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/botInlineMessageText.md b/old_docs/API_docs_v109/constructors/botInlineMessageText.md new file mode 100644 index 00000000..cd352f67 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/botInlineMessageText.md @@ -0,0 +1,47 @@ +--- +title: botInlineMessageText +description: Send a simple text message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineMessageText +[Back to constructors index](index.md) + + + +Send a simple text message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|message|[string](../types/string.md) | Yes|The message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [BotInlineMessage](../types/BotInlineMessage.md) + + +### Example: + +```php +$botInlineMessageText = ['_' => 'botInlineMessageText', 'no_webpage' => Bool, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/botInlineResult.md b/old_docs/API_docs_v109/constructors/botInlineResult.md new file mode 100644 index 00000000..839d1def --- /dev/null +++ b/old_docs/API_docs_v109/constructors/botInlineResult.md @@ -0,0 +1,45 @@ +--- +title: botInlineResult +description: Generic result +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: botInlineResult +[Back to constructors index](index.md) + + + +Generic result + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Result ID| +|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))| +|title|[string](../types/string.md) | Optional|Result title| +|description|[string](../types/string.md) | Optional|Result description| +|url|[string](../types/string.md) | Optional|URL of article or webpage| +|thumb|[WebDocument](../types/WebDocument.md) | Optional|Thumbnail for the result| +|content|[WebDocument](../types/WebDocument.md) | Optional|Content of the result| +|send\_message|[BotInlineMessage](../types/BotInlineMessage.md) | Yes|Message to send| + + + +### Type: [BotInlineResult](../types/BotInlineResult.md) + + +### Example: + +```php +$botInlineResult = ['_' => 'botInlineResult', 'id' => 'string', 'type' => 'string', 'title' => 'string', 'description' => 'string', 'url' => 'string', 'thumb' => WebDocument, 'content' => WebDocument, 'send_message' => BotInlineMessage]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/cdnConfig.md b/old_docs/API_docs_v109/constructors/cdnConfig.md new file mode 100644 index 00000000..54cf4e8c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/cdnConfig.md @@ -0,0 +1,38 @@ +--- +title: cdnConfig +description: Configuration for [CDN](https://core.telegram.org/cdn) file downloads. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: cdnConfig +[Back to constructors index](index.md) + + + +Configuration for [CDN](https://core.telegram.org/cdn) file downloads. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|public\_keys|Array of [CdnPublicKey](../types/CdnPublicKey.md) | Yes|Public keys| + + + +### Type: [CdnConfig](../types/CdnConfig.md) + + +### Example: + +```php +$cdnConfig = ['_' => 'cdnConfig', 'public_keys' => [CdnPublicKey, CdnPublicKey]]; +``` + + +Or, if you're into Lua: + +```lua +cdnConfig={_='cdnConfig', public_keys={CdnPublicKey}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/cdnPublicKey.md b/old_docs/API_docs_v109/constructors/cdnPublicKey.md new file mode 100644 index 00000000..72642834 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/cdnPublicKey.md @@ -0,0 +1,39 @@ +--- +title: cdnPublicKey +description: Public key to use **only** during handshakes to [CDN](https://core.telegram.org/cdn) DCs. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: cdnPublicKey +[Back to constructors index](index.md) + + + +Public key to use **only** during handshakes to [CDN](https://core.telegram.org/cdn) DCs. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dc\_id|[int](../types/int.md) | Yes|[CDN DC](https://core.telegram.org/cdn) ID| +|public\_key|[string](../types/string.md) | Yes|RSA public key| + + + +### Type: [CdnPublicKey](../types/CdnPublicKey.md) + + +### Example: + +```php +$cdnPublicKey = ['_' => 'cdnPublicKey', 'dc_id' => int, 'public_key' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +cdnPublicKey={_='cdnPublicKey', dc_id=int, public_key='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channel.md b/old_docs/API_docs_v109/constructors/channel.md new file mode 100644 index 00000000..b4632b1a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channel.md @@ -0,0 +1,61 @@ +--- +title: channel +description: Channel/supergroup info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channel +[Back to constructors index](index.md) + + + +Channel/supergroup info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|creator|[Bool](../types/Bool.md) | Optional|Whether the current user is the creator of this channel| +|left|[Bool](../types/Bool.md) | Optional|Whether the current user has left this channel| +|broadcast|[Bool](../types/Bool.md) | Optional|Is this a channel?| +|verified|[Bool](../types/Bool.md) | Optional|Is this channel verified by telegram?| +|megagroup|[Bool](../types/Bool.md) | Optional|Is this a supergroup?| +|restricted|[Bool](../types/Bool.md) | Optional|Whether viewing/writing in this channel for a reason (see `restriction_reason`| +|signatures|[Bool](../types/Bool.md) | Optional|Whether signatures are enabled (channels)| +|min|[Bool](../types/Bool.md) | Optional|See [min](https://core.telegram.org/api/min)| +|scam|[Bool](../types/Bool.md) | Optional|This channel/supergroup is probably a scam| +|has\_link|[Bool](../types/Bool.md) | Optional|Whether this channel has a private join link| +|has\_geo|[Bool](../types/Bool.md) | Optional|Whether this chanel has a geoposition| +|slowmode\_enabled|[Bool](../types/Bool.md) | Optional|Whether slow mode is enabled for groups to prevent flood in chat| +|id|[int](../types/int.md) | Yes|ID of the channel| +|access\_hash|[long](../types/long.md) | Optional|Access hash| +|title|[string](../types/string.md) | Yes|Title| +|username|[string](../types/string.md) | Optional|Username| +|photo|[ChatPhoto](../types/ChatPhoto.md) | Optional|Profile photo| +|date|[int](../types/int.md) | Yes|Creation date| +|version|[int](../types/int.md) | Yes|Version of the channel (always `0`)| +|restriction\_reason|Array of [RestrictionReason](../types/RestrictionReason.md) | Optional|Restriction reason| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|Admin rights of the user in this channel (see [rights](https://core.telegram.org/api/rights))| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Banned rights of the user in this channel (see [rights](https://core.telegram.org/api/rights))| +|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|Default chat rights (see [rights](https://core.telegram.org/api/rights))| +|participants\_count|[int](../types/int.md) | Optional|Participant count| + + + +### Type: [Chat](../types/Chat.md) + + +### Example: + +```php +$channel = ['_' => 'channel', 'creator' => Bool, 'left' => Bool, 'broadcast' => Bool, 'verified' => Bool, 'megagroup' => Bool, 'restricted' => Bool, 'signatures' => Bool, 'min' => Bool, 'scam' => Bool, 'has_link' => Bool, 'has_geo' => Bool, 'slowmode_enabled' => Bool, 'id' => int, 'access_hash' => long, 'title' => 'string', 'username' => 'string', 'photo' => ChatPhoto, 'date' => int, 'version' => int, 'restriction_reason' => [RestrictionReason, RestrictionReason], 'admin_rights' => ChatAdminRights, 'banned_rights' => ChatBannedRights, 'default_banned_rights' => ChatBannedRights, 'participants_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +channel={_='channel', creator=Bool, left=Bool, broadcast=Bool, verified=Bool, megagroup=Bool, restricted=Bool, signatures=Bool, min=Bool, scam=Bool, has_link=Bool, has_geo=Bool, slowmode_enabled=Bool, id=int, access_hash=long, title='string', username='string', photo=ChatPhoto, date=int, version=int, restriction_reason={RestrictionReason}, admin_rights=ChatAdminRights, banned_rights=ChatBannedRights, default_banned_rights=ChatBannedRights, participants_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEvent.md b/old_docs/API_docs_v109/constructors/channelAdminLogEvent.md new file mode 100644 index 00000000..7256713a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEvent.md @@ -0,0 +1,41 @@ +--- +title: channelAdminLogEvent +description: Admin log event +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEvent +[Back to constructors index](index.md) + + + +Admin log event + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Event ID| +|date|[int](../types/int.md) | Yes|Date| +|user\_id|[int](../types/int.md) | Yes|User ID| +|action|[ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) | Yes|Action| + + + +### Type: [ChannelAdminLogEvent](../types/ChannelAdminLogEvent.md) + + +### Example: + +```php +$channelAdminLogEvent = ['_' => 'channelAdminLogEvent', 'id' => long, 'date' => int, 'user_id' => int, 'action' => ChannelAdminLogEventAction]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEvent={_='channelAdminLogEvent', id=long, date=int, user_id=int, action=ChannelAdminLogEventAction} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeAbout.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeAbout.md new file mode 100644 index 00000000..1677fc06 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeAbout.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeAbout +description: The description was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeAbout +[Back to constructors index](index.md) + + + +The description was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[string](../types/string.md) | Yes|Previous description| +|new\_value|[string](../types/string.md) | Yes|New description| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeAbout = ['_' => 'channelAdminLogEventActionChangeAbout', 'prev_value' => 'string', 'new_value' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeAbout={_='channelAdminLogEventActionChangeAbout', prev_value='string', new_value='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeLinkedChat.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeLinkedChat.md new file mode 100644 index 00000000..fd7ed7bb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeLinkedChat.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeLinkedChat +description: The linked chat was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeLinkedChat +[Back to constructors index](index.md) + + + +The linked chat was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[int](../types/int.md) | Yes|Previous linked chat| +|new\_value|[int](../types/int.md) | Yes|New linked chat| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeLinkedChat = ['_' => 'channelAdminLogEventActionChangeLinkedChat', 'prev_value' => int, 'new_value' => int]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeLinkedChat={_='channelAdminLogEventActionChangeLinkedChat', prev_value=int, new_value=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeLocation.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeLocation.md new file mode 100644 index 00000000..663022fd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeLocation.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeLocation +description: The geogroup location was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeLocation +[Back to constructors index](index.md) + + + +The geogroup location was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[ChannelLocation](../types/ChannelLocation.md) | Optional|Previous location| +|new\_value|[ChannelLocation](../types/ChannelLocation.md) | Optional|New location| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeLocation = ['_' => 'channelAdminLogEventActionChangeLocation', 'prev_value' => ChannelLocation, 'new_value' => ChannelLocation]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeLocation={_='channelAdminLogEventActionChangeLocation', prev_value=ChannelLocation, new_value=ChannelLocation} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangePhoto.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangePhoto.md new file mode 100644 index 00000000..a7726c14 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangePhoto.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangePhoto +description: The channel/supergroup's picture was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangePhoto +[Back to constructors index](index.md) + + + +The channel/supergroup's picture was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_photo|[Photo](../types/Photo.md) | Optional|Previous picture| +|new\_photo|[Photo](../types/Photo.md) | Optional|New picture| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangePhoto = ['_' => 'channelAdminLogEventActionChangePhoto', 'prev_photo' => Photo, 'new_photo' => Photo]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangePhoto={_='channelAdminLogEventActionChangePhoto', prev_photo=Photo, new_photo=Photo} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeStickerSet.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeStickerSet.md new file mode 100644 index 00000000..5a70ab9b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeStickerSet.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeStickerSet +description: The supergroup's stickerset was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeStickerSet +[Back to constructors index](index.md) + + + +The supergroup's stickerset was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|Previous stickerset| +|new\_stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|New stickerset| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeStickerSet = ['_' => 'channelAdminLogEventActionChangeStickerSet', 'prev_stickerset' => InputStickerSet, 'new_stickerset' => InputStickerSet]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeStickerSet={_='channelAdminLogEventActionChangeStickerSet', prev_stickerset=InputStickerSet, new_stickerset=InputStickerSet} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeTitle.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeTitle.md new file mode 100644 index 00000000..46d2cf4e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeTitle.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeTitle +description: Channel/supergroup title was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeTitle +[Back to constructors index](index.md) + + + +Channel/supergroup title was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[string](../types/string.md) | Yes|Previous title| +|new\_value|[string](../types/string.md) | Yes|New title| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeTitle = ['_' => 'channelAdminLogEventActionChangeTitle', 'prev_value' => 'string', 'new_value' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeTitle={_='channelAdminLogEventActionChangeTitle', prev_value='string', new_value='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeUsername.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeUsername.md new file mode 100644 index 00000000..d83efacf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionChangeUsername.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionChangeUsername +description: Channel/supergroup username was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionChangeUsername +[Back to constructors index](index.md) + + + +Channel/supergroup username was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[string](../types/string.md) | Yes|Old username| +|new\_value|[string](../types/string.md) | Yes|New username| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionChangeUsername = ['_' => 'channelAdminLogEventActionChangeUsername', 'prev_value' => 'string', 'new_value' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionChangeUsername={_='channelAdminLogEventActionChangeUsername', prev_value='string', new_value='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionDefaultBannedRights.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionDefaultBannedRights.md new file mode 100644 index 00000000..4c5ad54c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionDefaultBannedRights.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionDefaultBannedRights +description: The default banned rights were modified +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionDefaultBannedRights +[Back to constructors index](index.md) + + + +The default banned rights were modified + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|Previous global [banned rights](https://core.telegram.org/api/rights)| +|new\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|New glboal [banned rights](https://core.telegram.org/api/rights).| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionDefaultBannedRights = ['_' => 'channelAdminLogEventActionDefaultBannedRights', 'prev_banned_rights' => ChatBannedRights, 'new_banned_rights' => ChatBannedRights]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionDefaultBannedRights={_='channelAdminLogEventActionDefaultBannedRights', prev_banned_rights=ChatBannedRights, new_banned_rights=ChatBannedRights} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionDeleteMessage.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionDeleteMessage.md new file mode 100644 index 00000000..dfc3f998 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionDeleteMessage.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionDeleteMessage +description: A message was deleted +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionDeleteMessage +[Back to constructors index](index.md) + + + +A message was deleted + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|The message that was deleted| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionDeleteMessage = ['_' => 'channelAdminLogEventActionDeleteMessage', 'message' => Message]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionDeleteMessage={_='channelAdminLogEventActionDeleteMessage', message=Message} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionEditMessage.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionEditMessage.md new file mode 100644 index 00000000..1304749d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionEditMessage.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionEditMessage +description: A message was edited +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionEditMessage +[Back to constructors index](index.md) + + + +A message was edited + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_message|[Message](../types/Message.md) | Optional|Old message| +|new\_message|[Message](../types/Message.md) | Optional|New message| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionEditMessage = ['_' => 'channelAdminLogEventActionEditMessage', 'prev_message' => Message, 'new_message' => Message]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionEditMessage={_='channelAdminLogEventActionEditMessage', prev_message=Message, new_message=Message} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantInvite.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantInvite.md new file mode 100644 index 00000000..0f7fd685 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantInvite.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionParticipantInvite +description: A user was invited to the group +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantInvite +[Back to constructors index](index.md) + + + +A user was invited to the group + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|The user that was invited| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionParticipantInvite = ['_' => 'channelAdminLogEventActionParticipantInvite', 'participant' => ChannelParticipant]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionParticipantInvite={_='channelAdminLogEventActionParticipantInvite', participant=ChannelParticipant} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantJoin.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantJoin.md new file mode 100644 index 00000000..aabef495 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantJoin.md @@ -0,0 +1,33 @@ +--- +title: channelAdminLogEventActionParticipantJoin +description: A user has joined the group (in the case of big groups, info of the user that has joined isn't shown) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantJoin +[Back to constructors index](index.md) + + + +A user has joined the group (in the case of big groups, info of the user that has joined isn't shown) + + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionParticipantJoin = ['_' => 'channelAdminLogEventActionParticipantJoin']; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionParticipantJoin={_='channelAdminLogEventActionParticipantJoin'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantLeave.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantLeave.md new file mode 100644 index 00000000..4a51e021 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantLeave.md @@ -0,0 +1,33 @@ +--- +title: channelAdminLogEventActionParticipantLeave +description: A user left the channel/supergroup (in the case of big groups, info of the user that has joined isn't shown) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantLeave +[Back to constructors index](index.md) + + + +A user left the channel/supergroup (in the case of big groups, info of the user that has joined isn't shown) + + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionParticipantLeave = ['_' => 'channelAdminLogEventActionParticipantLeave']; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionParticipantLeave={_='channelAdminLogEventActionParticipantLeave'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantToggleAdmin.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantToggleAdmin.md new file mode 100644 index 00000000..34f97d2f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantToggleAdmin.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionParticipantToggleAdmin +description: The admin [rights](https://core.telegram.org/api/rights) of a user were changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantToggleAdmin +[Back to constructors index](index.md) + + + +The admin [rights](https://core.telegram.org/api/rights) of a user were changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|Previous admin rights| +|new\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|New admin rights| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionParticipantToggleAdmin = ['_' => 'channelAdminLogEventActionParticipantToggleAdmin', 'prev_participant' => ChannelParticipant, 'new_participant' => ChannelParticipant]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionParticipantToggleAdmin={_='channelAdminLogEventActionParticipantToggleAdmin', prev_participant=ChannelParticipant, new_participant=ChannelParticipant} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantToggleBan.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantToggleBan.md new file mode 100644 index 00000000..e9007cbc --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionParticipantToggleBan.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionParticipantToggleBan +description: The banned [rights](https://core.telegram.org/api/rights) of a user were changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionParticipantToggleBan +[Back to constructors index](index.md) + + + +The banned [rights](https://core.telegram.org/api/rights) of a user were changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|Old banned rights of user| +|new\_participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|New banned rights of user| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionParticipantToggleBan = ['_' => 'channelAdminLogEventActionParticipantToggleBan', 'prev_participant' => ChannelParticipant, 'new_participant' => ChannelParticipant]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionParticipantToggleBan={_='channelAdminLogEventActionParticipantToggleBan', prev_participant=ChannelParticipant, new_participant=ChannelParticipant} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionStopPoll.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionStopPoll.md new file mode 100644 index 00000000..d184c992 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionStopPoll.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionStopPoll +description: A poll was stopped +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionStopPoll +[Back to constructors index](index.md) + + + +A poll was stopped + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|The poll that was stopped| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionStopPoll = ['_' => 'channelAdminLogEventActionStopPoll', 'message' => Message]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionStopPoll={_='channelAdminLogEventActionStopPoll', message=Message} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleInvites.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleInvites.md new file mode 100644 index 00000000..bdcafee5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleInvites.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionToggleInvites +description: Invites were enabled/disabled +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionToggleInvites +[Back to constructors index](index.md) + + + +Invites were enabled/disabled + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|new\_value|[Bool](../types/Bool.md) | Yes|New value| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionToggleInvites = ['_' => 'channelAdminLogEventActionToggleInvites', 'new_value' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionToggleInvites={_='channelAdminLogEventActionToggleInvites', new_value=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionTogglePreHistoryHidden.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionTogglePreHistoryHidden.md new file mode 100644 index 00000000..c14e2a74 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionTogglePreHistoryHidden.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionTogglePreHistoryHidden +description: The hidden prehistory setting was [changed](../methods/channels.togglePreHistoryHidden.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionTogglePreHistoryHidden +[Back to constructors index](index.md) + + + +The hidden prehistory setting was [changed](../methods/channels.togglePreHistoryHidden.md) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|new\_value|[Bool](../types/Bool.md) | Yes|New value| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionTogglePreHistoryHidden = ['_' => 'channelAdminLogEventActionTogglePreHistoryHidden', 'new_value' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionTogglePreHistoryHidden={_='channelAdminLogEventActionTogglePreHistoryHidden', new_value=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleSignatures.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleSignatures.md new file mode 100644 index 00000000..6a73dadb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleSignatures.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionToggleSignatures +description: Channel signatures were enabled/disabled +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionToggleSignatures +[Back to constructors index](index.md) + + + +Channel signatures were enabled/disabled + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|new\_value|[Bool](../types/Bool.md) | Yes|New value| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionToggleSignatures = ['_' => 'channelAdminLogEventActionToggleSignatures', 'new_value' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionToggleSignatures={_='channelAdminLogEventActionToggleSignatures', new_value=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleSlowMode.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleSlowMode.md new file mode 100644 index 00000000..0a653a45 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionToggleSlowMode.md @@ -0,0 +1,39 @@ +--- +title: channelAdminLogEventActionToggleSlowMode +description: [Slow mode setting for supergroups was changed](../methods/channels.toggleSlowMode.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionToggleSlowMode +[Back to constructors index](index.md) + + + +[Slow mode setting for supergroups was changed](../methods/channels.toggleSlowMode.md) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_value|[int](../types/int.md) | Yes|Previous slow mode value| +|new\_value|[int](../types/int.md) | Yes|New slow mode value| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionToggleSlowMode = ['_' => 'channelAdminLogEventActionToggleSlowMode', 'prev_value' => int, 'new_value' => int]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionToggleSlowMode={_='channelAdminLogEventActionToggleSlowMode', prev_value=int, new_value=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventActionUpdatePinned.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionUpdatePinned.md new file mode 100644 index 00000000..d1154dc4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventActionUpdatePinned.md @@ -0,0 +1,38 @@ +--- +title: channelAdminLogEventActionUpdatePinned +description: A message was pinned +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventActionUpdatePinned +[Back to constructors index](index.md) + + + +A message was pinned + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|The message that was pinned| + + + +### Type: [ChannelAdminLogEventAction](../types/ChannelAdminLogEventAction.md) + + +### Example: + +```php +$channelAdminLogEventActionUpdatePinned = ['_' => 'channelAdminLogEventActionUpdatePinned', 'message' => Message]; +``` + + +Or, if you're into Lua: + +```lua +channelAdminLogEventActionUpdatePinned={_='channelAdminLogEventActionUpdatePinned', message=Message} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelAdminLogEventsFilter.md b/old_docs/API_docs_v109/constructors/channelAdminLogEventsFilter.md new file mode 100644 index 00000000..8ef585ee --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelAdminLogEventsFilter.md @@ -0,0 +1,51 @@ +--- +title: channelAdminLogEventsFilter +description: Filter only certain admin log events +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelAdminLogEventsFilter +[Back to constructors index](index.md) + + + +Filter only certain admin log events + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|join|[Bool](../types/Bool.md) | Optional|[Join events](../constructors/channelAdminLogEventActionParticipantJoin.md)| +|leave|[Bool](../types/Bool.md) | Optional|[Leave events](../constructors/channelAdminLogEventActionParticipantLeave.md)| +|invite|[Bool](../types/Bool.md) | Optional|[Invite events](../constructors/channelAdminLogEventActionParticipantInvite.md)| +|ban|[Bool](../types/Bool.md) | Optional|[Ban events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)| +|unban|[Bool](../types/Bool.md) | Optional|[Unban events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)| +|kick|[Bool](../types/Bool.md) | Optional|[Kick events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)| +|unkick|[Bool](../types/Bool.md) | Optional|[Unkick events](../constructors/channelAdminLogEventActionParticipantToggleBan.md)| +|promote|[Bool](../types/Bool.md) | Optional|[Admin promotion events](../constructors/channelAdminLogEventActionParticipantToggleAdmin.md)| +|demote|[Bool](../types/Bool.md) | Optional|[Admin demotion events](../constructors/channelAdminLogEventActionParticipantToggleAdmin.md)| +|info|[Bool](../types/Bool.md) | Optional|Info change events (when [about](../constructors/channelAdminLogEventActionChangeAbout.md), [linked chat](../constructors/channelAdminLogEventActionChangeLinkedChat.md), [location](../constructors/channelAdminLogEventActionChangeLocation.md), [photo](../constructors/channelAdminLogEventActionChangePhoto.md), [stickerset](../constructors/channelAdminLogEventActionChangeStickerSet.md), [title](../constructors/channelAdminLogEventActionChangeTitle.md) or [username](../constructors/channelAdminLogEventActionChangeUsername.md) data of a channel gets modified)| +|settings|[Bool](../types/Bool.md) | Optional|Settings change events ([invites](../constructors/channelAdminLogEventActionToggleInvites.md), [hidden prehistory](../constructors/channelAdminLogEventActionTogglePreHistoryHidden.md), [signatures](../constructors/channelAdminLogEventActionToggleSignatures.md), [default banned rights](../constructors/channelAdminLogEventActionDefaultBannedRights.md))| +|pinned|[Bool](../types/Bool.md) | Optional|[Message pin events](../constructors/channelAdminLogEventActionUpdatePinned.md)| +|edit|[Bool](../types/Bool.md) | Optional|[Message edit events](../constructors/channelAdminLogEventActionEditMessage.md)| +|delete|[Bool](../types/Bool.md) | Optional|[Message deletion events](../constructors/channelAdminLogEventActionDeleteMessage.md)| + + + +### Type: [ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) + + +### Example: + +```php +$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]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/channelForbidden.md b/old_docs/API_docs_v109/constructors/channelForbidden.md new file mode 100644 index 00000000..71c20970 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelForbidden.md @@ -0,0 +1,43 @@ +--- +title: channelForbidden +description: Indicates a channel/supergroup we can't access because we were banned, or for some other reason. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelForbidden +[Back to constructors index](index.md) + + + +Indicates a channel/supergroup we can't access because we were banned, or for some other reason. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[Bool](../types/Bool.md) | Optional|Is this a channel| +|megagroup|[Bool](../types/Bool.md) | Optional|Is this a supergroup| +|id|[int](../types/int.md) | Yes|Channel ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|title|[string](../types/string.md) | Yes|Title| +|until\_date|[int](../types/int.md) | Optional|The ban is valid until the specified date| + + + +### Type: [Chat](../types/Chat.md) + + +### Example: + +```php +$channelForbidden = ['_' => 'channelForbidden', 'broadcast' => Bool, 'megagroup' => Bool, 'id' => int, 'access_hash' => long, 'title' => 'string', 'until_date' => int]; +``` + + +Or, if you're into Lua: + +```lua +channelForbidden={_='channelForbidden', broadcast=Bool, megagroup=Bool, id=int, access_hash=long, title='string', until_date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelFull.md b/old_docs/API_docs_v109/constructors/channelFull.md new file mode 100644 index 00000000..332a670e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelFull.md @@ -0,0 +1,69 @@ +--- +title: channelFull +description: Full info about a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelFull +[Back to constructors index](index.md) + + + +Full info about a [channel/supergroup](https://core.telegram.org/api/channel) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|can\_view\_participants|[Bool](../types/Bool.md) | Optional|Can we vew the participant list?| +|can\_set\_username|[Bool](../types/Bool.md) | Optional|Can we set the channel's username?| +|can\_set\_stickers|[Bool](../types/Bool.md) | Optional|Can we [associate](../methods/channels.setStickers.md) a stickerpack to the supergroup?| +|hidden\_prehistory|[Bool](../types/Bool.md) | Optional|Is the history before we joined hidden to us?| +|can\_view\_stats|[Bool](../types/Bool.md) | Optional|Can the user call [messages.getStatsURL](../methods/messages.getStatsURL.md) on this channel| +|can\_set\_location|[Bool](../types/Bool.md) | Optional|Can we set the geolocation of this group (for geogroups)| +|has\_scheduled|[Bool](../types/Bool.md) | Optional|Whether scheduled messages are available| +|id|[int](../types/int.md) | Yes|ID of the channel| +|about|[string](../types/string.md) | Yes|Info about the channel| +|participants\_count|[int](../types/int.md) | Optional|Number of participants of the channel| +|admins\_count|[int](../types/int.md) | Optional|Number of channel admins| +|kicked\_count|[int](../types/int.md) | Optional|Number of users [kicked](https://core.telegram.org/api/rights) from the channel| +|banned\_count|[int](../types/int.md) | Optional|Number of users [banned](https://core.telegram.org/api/rights) from the channel| +|online\_count|[int](../types/int.md) | Optional|Number of users currently online| +|read\_inbox\_max\_id|[int](../types/int.md) | Yes|Position up to which all incoming messages are read.| +|read\_outbox\_max\_id|[int](../types/int.md) | Yes|Position up to which all outgoing messages are read.| +|unread\_count|[int](../types/int.md) | Yes|Count of unread messages| +|chat\_photo|[Photo](../types/Photo.md) | Optional|Channel picture| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notification settings| +|exported\_invite|[ExportedChatInvite](../types/ExportedChatInvite.md) | Yes|Invite link| +|bot\_info|Array of [BotInfo](../types/BotInfo.md) | Yes|Bot info| +|migrated\_from\_chat\_id|[int](../types/int.md) | Optional|The chat ID from which this group was [migrated](https://core.telegram.org/api/channel)| +|migrated\_from\_max\_id|[int](../types/int.md) | Optional|The message ID in the original chat at which this group was [migrated](https://core.telegram.org/api/channel)| +|pinned\_msg\_id|[int](../types/int.md) | Optional|Message ID of the pinned message| +|stickerset|[StickerSet](../types/StickerSet.md) | Optional|Associated stickerset| +|available\_min\_id|[int](../types/int.md) | Optional|Identifier of a maximum unavailable message in a channel due to hidden history.| +|folder\_id|[int](../types/int.md) | Optional|Folder ID| +|linked\_chat\_id|[int](../types/int.md) | Optional|ID of the linked discussion chat for channels| +|location|[ChannelLocation](../types/ChannelLocation.md) | Optional|Location of the geogroup| +|slowmode\_seconds|[int](../types/int.md) | Optional|If specified, users in supergroups will only be able to send one message every `slowmode_seconds` seconds| +|slowmode\_next\_send\_date|[int](../types/int.md) | Optional|Indicates when the user will be allowed to send another message in the supergroup (unixdate)| +|pts|[int](../types/int.md) | Yes|Latest [PTS](https://core.telegram.org/api/updates) for this channel| + + + +### Type: [ChatFull](../types/ChatFull.md) + + +### Example: + +```php +$channelFull = ['_' => 'channelFull', 'can_view_participants' => Bool, 'can_set_username' => Bool, 'can_set_stickers' => Bool, 'hidden_prehistory' => Bool, 'can_view_stats' => Bool, 'can_set_location' => Bool, 'has_scheduled' => Bool, 'id' => int, 'about' => 'string', 'participants_count' => int, 'admins_count' => int, 'kicked_count' => int, 'banned_count' => int, 'online_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, 'folder_id' => int, 'linked_chat_id' => int, 'location' => ChannelLocation, 'slowmode_seconds' => int, 'slowmode_next_send_date' => int, 'pts' => int]; +``` + + +Or, if you're into Lua: + +```lua +channelFull={_='channelFull', can_view_participants=Bool, can_set_username=Bool, can_set_stickers=Bool, hidden_prehistory=Bool, can_view_stats=Bool, can_set_location=Bool, has_scheduled=Bool, id=int, about='string', participants_count=int, admins_count=int, kicked_count=int, banned_count=int, online_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, folder_id=int, linked_chat_id=int, location=ChannelLocation, slowmode_seconds=int, slowmode_next_send_date=int, pts=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelLocation.md b/old_docs/API_docs_v109/constructors/channelLocation.md new file mode 100644 index 00000000..9d533950 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelLocation.md @@ -0,0 +1,39 @@ +--- +title: channelLocation +description: Geographical location of supergroup (geogroups) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelLocation +[Back to constructors index](index.md) + + + +Geographical location of supergroup (geogroups) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo\_point|[GeoPoint](../types/GeoPoint.md) | Optional|Geographical location of supergrup| +|address|[string](../types/string.md) | Yes|Textual description of the address| + + + +### Type: [ChannelLocation](../types/ChannelLocation.md) + + +### Example: + +```php +$channelLocation = ['_' => 'channelLocation', 'geo_point' => GeoPoint, 'address' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelLocation={_='channelLocation', geo_point=GeoPoint, address='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelLocationEmpty.md b/old_docs/API_docs_v109/constructors/channelLocationEmpty.md new file mode 100644 index 00000000..3cb7f0c7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelLocationEmpty.md @@ -0,0 +1,33 @@ +--- +title: channelLocationEmpty +description: No location (normal supergroup) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelLocationEmpty +[Back to constructors index](index.md) + + + +No location (normal supergroup) + + + + +### Type: [ChannelLocation](../types/ChannelLocation.md) + + +### Example: + +```php +$channelLocationEmpty = ['_' => 'channelLocationEmpty']; +``` + + +Or, if you're into Lua: + +```lua +channelLocationEmpty={_='channelLocationEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelMessagesFilter.md b/old_docs/API_docs_v109/constructors/channelMessagesFilter.md new file mode 100644 index 00000000..e36f60fb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelMessagesFilter.md @@ -0,0 +1,39 @@ +--- +title: channelMessagesFilter +description: Filter for getting only certain types of channel messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelMessagesFilter +[Back to constructors index](index.md) + + + +Filter for getting only certain types of channel messages + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|exclude\_new\_messages|[Bool](../types/Bool.md) | Optional|Whether to exclude new messages from the search| +|ranges|Array of [MessageRange](../types/MessageRange.md) | Yes|Ranges| + + + +### Type: [ChannelMessagesFilter](../types/ChannelMessagesFilter.md) + + +### Example: + +```php +$channelMessagesFilter = ['_' => 'channelMessagesFilter', 'exclude_new_messages' => Bool, 'ranges' => [MessageRange, MessageRange]]; +``` + + +Or, if you're into Lua: + +```lua +channelMessagesFilter={_='channelMessagesFilter', exclude_new_messages=Bool, ranges={MessageRange}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelMessagesFilterEmpty.md b/old_docs/API_docs_v109/constructors/channelMessagesFilterEmpty.md new file mode 100644 index 00000000..32aea9ff --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelMessagesFilterEmpty.md @@ -0,0 +1,33 @@ +--- +title: channelMessagesFilterEmpty +description: No filter +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelMessagesFilterEmpty +[Back to constructors index](index.md) + + + +No filter + + + + +### Type: [ChannelMessagesFilter](../types/ChannelMessagesFilter.md) + + +### Example: + +```php +$channelMessagesFilterEmpty = ['_' => 'channelMessagesFilterEmpty']; +``` + + +Or, if you're into Lua: + +```lua +channelMessagesFilterEmpty={_='channelMessagesFilterEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipant.md b/old_docs/API_docs_v109/constructors/channelParticipant.md new file mode 100644 index 00000000..a84e8389 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipant.md @@ -0,0 +1,39 @@ +--- +title: channelParticipant +description: Channel/supergroup participant +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipant +[Back to constructors index](index.md) + + + +Channel/supergroup participant + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|Pariticipant user ID| +|date|[int](../types/int.md) | Yes|Date joined| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +```php +$channelParticipant = ['_' => 'channelParticipant', 'user_id' => int, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +channelParticipant={_='channelParticipant', user_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipantAdmin.md b/old_docs/API_docs_v109/constructors/channelParticipantAdmin.md new file mode 100644 index 00000000..07be6817 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipantAdmin.md @@ -0,0 +1,45 @@ +--- +title: channelParticipantAdmin +description: Admin +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantAdmin +[Back to constructors index](index.md) + + + +Admin + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|can\_edit|[Bool](../types/Bool.md) | Optional|Can this admin promote other admins with the same permissions?| +|self|[Bool](../types/Bool.md) | Optional|Is this the current user| +|user\_id|[int](../types/int.md) | Yes|Admin user ID| +|inviter\_id|[int](../types/int.md) | Optional|User that invited the admin to the channel/group| +|promoted\_by|[int](../types/int.md) | Yes|User that promoted the user to admin| +|date|[int](../types/int.md) | Yes|When did the user join| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Yes|Admin [rights](https://core.telegram.org/api/rights)| +|rank|[string](../types/string.md) | Optional|The role (rank) of the admin in the group: just an arbitrary string, `admin` by default| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +```php +$channelParticipantAdmin = ['_' => 'channelParticipantAdmin', 'can_edit' => Bool, 'self' => Bool, 'user_id' => int, 'inviter_id' => int, 'promoted_by' => int, 'date' => int, 'admin_rights' => ChatAdminRights, 'rank' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantAdmin={_='channelParticipantAdmin', can_edit=Bool, self=Bool, user_id=int, inviter_id=int, promoted_by=int, date=int, admin_rights=ChatAdminRights, rank='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipantBanned.md b/old_docs/API_docs_v109/constructors/channelParticipantBanned.md new file mode 100644 index 00000000..e8784630 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipantBanned.md @@ -0,0 +1,42 @@ +--- +title: channelParticipantBanned +description: Banned/kicked user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantBanned +[Back to constructors index](index.md) + + + +Banned/kicked user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|left|[Bool](../types/Bool.md) | Optional|Whether the user has left the group| +|user\_id|[int](../types/int.md) | Yes|User ID| +|kicked\_by|[int](../types/int.md) | Yes|User was kicked by the specified admin| +|date|[int](../types/int.md) | Yes|When did the user join the group| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|Banned [rights](https://core.telegram.org/api/rights)| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +```php +$channelParticipantBanned = ['_' => 'channelParticipantBanned', 'left' => Bool, 'user_id' => int, 'kicked_by' => int, 'date' => int, 'banned_rights' => ChatBannedRights]; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantBanned={_='channelParticipantBanned', left=Bool, user_id=int, kicked_by=int, date=int, banned_rights=ChatBannedRights} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipantCreator.md b/old_docs/API_docs_v109/constructors/channelParticipantCreator.md new file mode 100644 index 00000000..0de76c13 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipantCreator.md @@ -0,0 +1,39 @@ +--- +title: channelParticipantCreator +description: Channel/supergroup creator +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantCreator +[Back to constructors index](index.md) + + + +Channel/supergroup creator + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User ID| +|rank|[string](../types/string.md) | Optional|The role (rank) of the group creator in the group: just an arbitrary string, `admin` by default| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +```php +$channelParticipantCreator = ['_' => 'channelParticipantCreator', 'user_id' => int, 'rank' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantCreator={_='channelParticipantCreator', user_id=int, rank='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipantSelf.md b/old_docs/API_docs_v109/constructors/channelParticipantSelf.md new file mode 100644 index 00000000..b61b598b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipantSelf.md @@ -0,0 +1,40 @@ +--- +title: channelParticipantSelf +description: Myself +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantSelf +[Back to constructors index](index.md) + + + +Myself + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User ID| +|inviter\_id|[int](../types/int.md) | Yes|User that invited me to the channel/supergroup| +|date|[int](../types/int.md) | Yes|When did I join the channel/supergroup| + + + +### Type: [ChannelParticipant](../types/ChannelParticipant.md) + + +### Example: + +```php +$channelParticipantSelf = ['_' => 'channelParticipantSelf', 'user_id' => int, 'inviter_id' => int, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantSelf={_='channelParticipantSelf', user_id=int, inviter_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipantsAdmins.md b/old_docs/API_docs_v109/constructors/channelParticipantsAdmins.md new file mode 100644 index 00000000..9f767404 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipantsAdmins.md @@ -0,0 +1,33 @@ +--- +title: channelParticipantsAdmins +description: Fetch only admin participants +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsAdmins +[Back to constructors index](index.md) + + + +Fetch only admin participants + + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +```php +$channelParticipantsAdmins = ['_' => 'channelParticipantsAdmins']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantsAdmins={_='channelParticipantsAdmins'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipantsBanned.md b/old_docs/API_docs_v109/constructors/channelParticipantsBanned.md new file mode 100644 index 00000000..60bc77c8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipantsBanned.md @@ -0,0 +1,38 @@ +--- +title: channelParticipantsBanned +description: Fetch only banned participants +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsBanned +[Back to constructors index](index.md) + + + +Fetch only banned participants + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|Optional filter for searching banned participants by name (otherwise empty)| + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +```php +$channelParticipantsBanned = ['_' => 'channelParticipantsBanned', 'q' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantsBanned={_='channelParticipantsBanned', q='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipantsBots.md b/old_docs/API_docs_v109/constructors/channelParticipantsBots.md new file mode 100644 index 00000000..6c9ae5ad --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipantsBots.md @@ -0,0 +1,33 @@ +--- +title: channelParticipantsBots +description: Fetch only bot participants +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsBots +[Back to constructors index](index.md) + + + +Fetch only bot participants + + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +```php +$channelParticipantsBots = ['_' => 'channelParticipantsBots']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantsBots={_='channelParticipantsBots'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipantsContacts.md b/old_docs/API_docs_v109/constructors/channelParticipantsContacts.md new file mode 100644 index 00000000..38981ff4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipantsContacts.md @@ -0,0 +1,38 @@ +--- +title: channelParticipantsContacts +description: Fetch only participants that are also contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsContacts +[Back to constructors index](index.md) + + + +Fetch only participants that are also contacts + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|Optional search query for searching contact participants by name| + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +```php +$channelParticipantsContacts = ['_' => 'channelParticipantsContacts', 'q' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantsContacts={_='channelParticipantsContacts', q='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipantsKicked.md b/old_docs/API_docs_v109/constructors/channelParticipantsKicked.md new file mode 100644 index 00000000..8566e1fc --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipantsKicked.md @@ -0,0 +1,38 @@ +--- +title: channelParticipantsKicked +description: Fetch only kicked participants +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsKicked +[Back to constructors index](index.md) + + + +Fetch only kicked participants + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|Optional filter for searching kicked participants by name (otherwise empty)| + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +```php +$channelParticipantsKicked = ['_' => 'channelParticipantsKicked', 'q' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantsKicked={_='channelParticipantsKicked', q='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipantsRecent.md b/old_docs/API_docs_v109/constructors/channelParticipantsRecent.md new file mode 100644 index 00000000..a30f0156 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipantsRecent.md @@ -0,0 +1,33 @@ +--- +title: channelParticipantsRecent +description: Fetch only recent participants +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsRecent +[Back to constructors index](index.md) + + + +Fetch only recent participants + + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +```php +$channelParticipantsRecent = ['_' => 'channelParticipantsRecent']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantsRecent={_='channelParticipantsRecent'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channelParticipantsSearch.md b/old_docs/API_docs_v109/constructors/channelParticipantsSearch.md new file mode 100644 index 00000000..e3649fbf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channelParticipantsSearch.md @@ -0,0 +1,38 @@ +--- +title: channelParticipantsSearch +description: Query participants by name +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: channelParticipantsSearch +[Back to constructors index](index.md) + + + +Query participants by name + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[string](../types/string.md) | Yes|Search query| + + + +### Type: [ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) + + +### Example: + +```php +$channelParticipantsSearch = ['_' => 'channelParticipantsSearch', 'q' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +channelParticipantsSearch={_='channelParticipantsSearch', q='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channels.adminLogResults.md b/old_docs/API_docs_v109/constructors/channels.adminLogResults.md new file mode 100644 index 00000000..2c9ca701 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channels.adminLogResults.md @@ -0,0 +1,41 @@ +--- +title: channels.adminLogResults +description: Admin log events +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/channels_adminLogResults.html +--- +# Constructor: channels.adminLogResults +[Back to constructors index](index.md) + + + +Admin log events + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [ChannelAdminLogEvent](../types/ChannelAdminLogEvent.md) | Yes|Events| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [channels.AdminLogResults](../types/channels.AdminLogResults.md) + + +### Example: + +```php +$channels.adminLogResults = ['_' => 'channels.adminLogResults', 'events' => [ChannelAdminLogEvent, ChannelAdminLogEvent], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +channels.adminLogResults={_='channels.adminLogResults', events={ChannelAdminLogEvent}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channels.channelParticipant.md b/old_docs/API_docs_v109/constructors/channels.channelParticipant.md new file mode 100644 index 00000000..5a0d7168 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channels.channelParticipant.md @@ -0,0 +1,40 @@ +--- +title: channels.channelParticipant +description: Represents a channel participant +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/channels_channelParticipant.html +--- +# Constructor: channels.channelParticipant +[Back to constructors index](index.md) + + + +Represents a channel participant + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|participant|[ChannelParticipant](../types/ChannelParticipant.md) | Yes|The channel participant| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [channels.ChannelParticipant](../types/channels.ChannelParticipant.md) + + +### Example: + +```php +$channels.channelParticipant = ['_' => 'channels.channelParticipant', 'participant' => ChannelParticipant, 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +channels.channelParticipant={_='channels.channelParticipant', participant=ChannelParticipant, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channels.channelParticipants.md b/old_docs/API_docs_v109/constructors/channels.channelParticipants.md new file mode 100644 index 00000000..780dc002 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channels.channelParticipants.md @@ -0,0 +1,41 @@ +--- +title: channels.channelParticipants +description: Represents multiple channel participants +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/channels_channelParticipants.html +--- +# Constructor: channels.channelParticipants +[Back to constructors index](index.md) + + + +Represents multiple channel participants + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Total number of participants that correspond to the given query| +|participants|Array of [ChannelParticipant](../types/ChannelParticipant.md) | Yes|Participants| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [channels.ChannelParticipants](../types/channels.ChannelParticipants.md) + + +### Example: + +```php +$channels.channelParticipants = ['_' => 'channels.channelParticipants', 'count' => int, 'participants' => [ChannelParticipant, ChannelParticipant], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +channels.channelParticipants={_='channels.channelParticipants', count=int, participants={ChannelParticipant}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/channels.channelParticipantsNotModified.md b/old_docs/API_docs_v109/constructors/channels.channelParticipantsNotModified.md new file mode 100644 index 00000000..aebdbb36 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/channels.channelParticipantsNotModified.md @@ -0,0 +1,34 @@ +--- +title: channels.channelParticipantsNotModified +description: No new participant info could be found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/channels_channelParticipantsNotModified.html +--- +# Constructor: channels.channelParticipantsNotModified +[Back to constructors index](index.md) + + + +No new participant info could be found + + + + +### Type: [channels.ChannelParticipants](../types/channels.ChannelParticipants.md) + + +### Example: + +```php +$channels.channelParticipantsNotModified = ['_' => 'channels.channelParticipantsNotModified']; +``` + + +Or, if you're into Lua: + +```lua +channels.channelParticipantsNotModified={_='channels.channelParticipantsNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chat.md b/old_docs/API_docs_v109/constructors/chat.md new file mode 100644 index 00000000..16a4e157 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chat.md @@ -0,0 +1,50 @@ +--- +title: chat +description: Info about a group +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chat +[Back to constructors index](index.md) + + + +Info about a group + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|creator|[Bool](../types/Bool.md) | Optional|Whether the current user is the creator of the group| +|kicked|[Bool](../types/Bool.md) | Optional|Whether the current user was kicked from the group| +|left|[Bool](../types/Bool.md) | Optional|Whether the current user has left the group| +|deactivated|[Bool](../types/Bool.md) | Optional|Whether the group was [migrated](https://core.telegram.org/api/channel)| +|id|[int](../types/int.md) | Yes|ID of the group| +|title|[string](../types/string.md) | Yes|Title| +|photo|[ChatPhoto](../types/ChatPhoto.md) | Optional|Chat photo| +|participants\_count|[int](../types/int.md) | Yes|Participant count| +|date|[int](../types/int.md) | Yes|Date of creation of the group| +|version|[int](../types/int.md) | Yes|Used in basic groups to reorder updates and make sure that all of them were received.| +|migrated\_to|[InputChannel](../types/InputChannel.md) | Optional|Means this chat was [upgraded](https://core.telegram.org/api/channel) to a supergroup| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | Optional|[Admin rights](https://core.telegram.org/api/rights) of the user in the group| +|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Optional|[Default banned rights](https://core.telegram.org/api/rights) of all users in the group| + + + +### Type: [Chat](../types/Chat.md) + + +### Example: + +```php +$chat = ['_' => 'chat', 'creator' => Bool, 'kicked' => Bool, 'left' => Bool, 'deactivated' => Bool, 'id' => int, 'title' => 'string', 'photo' => ChatPhoto, 'participants_count' => int, 'date' => int, 'version' => int, 'migrated_to' => InputChannel, 'admin_rights' => ChatAdminRights, 'default_banned_rights' => ChatBannedRights]; +``` + + +Or, if you're into Lua: + +```lua +chat={_='chat', creator=Bool, kicked=Bool, left=Bool, deactivated=Bool, id=int, title='string', photo=ChatPhoto, participants_count=int, date=int, version=int, migrated_to=InputChannel, admin_rights=ChatAdminRights, default_banned_rights=ChatBannedRights} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatAdminRights.md b/old_docs/API_docs_v109/constructors/chatAdminRights.md new file mode 100644 index 00000000..f80ff21b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatAdminRights.md @@ -0,0 +1,45 @@ +--- +title: chatAdminRights +description: Represents the rights of an admin in a [channel/supergroup](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatAdminRights +[Back to constructors index](index.md) + + + +Represents the rights of an admin in a [channel/supergroup](https://core.telegram.org/api/channel). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|change\_info|[Bool](../types/Bool.md) | Optional|If set, allows the admin to modify the description of the [channel/supergroup](https://core.telegram.org/api/channel)| +|post\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to post messages in the [channel](https://core.telegram.org/api/channel)| +|edit\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to also edit messages from other admins in the [channel](https://core.telegram.org/api/channel)| +|delete\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to also delete messages from other admins in the [channel](https://core.telegram.org/api/channel)| +|ban\_users|[Bool](../types/Bool.md) | Optional|If set, allows the admin to ban users from the [channel/supergroup](https://core.telegram.org/api/channel)| +|invite\_users|[Bool](../types/Bool.md) | Optional|If set, allows the admin to invite users in the [channel/supergroup](https://core.telegram.org/api/channel)| +|pin\_messages|[Bool](../types/Bool.md) | Optional|If set, allows the admin to pin messages in the [channel/supergroup](https://core.telegram.org/api/channel)| +|add\_admins|[Bool](../types/Bool.md) | Optional|If set, allows the admin to add other admins with the same (or more limited) permissions in the [channel/supergroup](https://core.telegram.org/api/channel)| + + + +### Type: [ChatAdminRights](../types/ChatAdminRights.md) + + +### Example: + +```php +$chatAdminRights = ['_' => 'chatAdminRights', 'change_info' => Bool, 'post_messages' => Bool, 'edit_messages' => Bool, 'delete_messages' => Bool, 'ban_users' => Bool, 'invite_users' => Bool, 'pin_messages' => Bool, 'add_admins' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +chatAdminRights={_='chatAdminRights', change_info=Bool, post_messages=Bool, edit_messages=Bool, delete_messages=Bool, ban_users=Bool, invite_users=Bool, pin_messages=Bool, add_admins=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatBannedRights.md b/old_docs/API_docs_v109/constructors/chatBannedRights.md new file mode 100644 index 00000000..f53db6d3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatBannedRights.md @@ -0,0 +1,50 @@ +--- +title: chatBannedRights +description: Represents the rights of a normal user in a [supergroup/channel/chat](https://core.telegram.org/api/channel). In this case, the flags are inverted: if set, a flag **does not allow** a user to do X. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatBannedRights +[Back to constructors index](index.md) + + + +Represents the rights of a normal user in a [supergroup/channel/chat](https://core.telegram.org/api/channel). In this case, the flags are inverted: if set, a flag **does not allow** a user to do X. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|view\_messages|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to view messages in a [supergroup/channel/chat](https://core.telegram.org/api/channel)| +|send\_messages|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send messages in a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_media|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send any media in a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_stickers|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send stickers in a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_gifs|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send gifs in a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_games|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send games in a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_inline|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to use inline bots in a [supergroup/chat](https://core.telegram.org/api/channel)| +|embed\_links|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to embed links in the messages of a [supergroup/chat](https://core.telegram.org/api/channel)| +|send\_polls|[Bool](../types/Bool.md) | Optional|If set, does not allow a user to send stickers in a [supergroup/chat](https://core.telegram.org/api/channel)| +|change\_info|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to change the description of a [supergroup/chat](https://core.telegram.org/api/channel)| +|invite\_users|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to invite users in a [supergroup/chat](https://core.telegram.org/api/channel)| +|pin\_messages|[Bool](../types/Bool.md) | Optional|If set, does not allow any user to pin messages in a [supergroup/chat](https://core.telegram.org/api/channel)| +|until\_date|[int](../types/int.md) | Yes|Validity of said permissions (0 = forever, forever = 2^31-1 for now).| + + + +### Type: [ChatBannedRights](../types/ChatBannedRights.md) + + +### Example: + +```php +$chatBannedRights = ['_' => 'chatBannedRights', 'view_messages' => Bool, 'send_messages' => Bool, 'send_media' => Bool, 'send_stickers' => Bool, 'send_gifs' => Bool, 'send_games' => Bool, 'send_inline' => Bool, 'embed_links' => Bool, 'send_polls' => Bool, 'change_info' => Bool, 'invite_users' => Bool, 'pin_messages' => Bool, 'until_date' => int]; +``` + + +Or, if you're into Lua: + +```lua +chatBannedRights={_='chatBannedRights', view_messages=Bool, send_messages=Bool, send_media=Bool, send_stickers=Bool, send_gifs=Bool, send_games=Bool, send_inline=Bool, embed_links=Bool, send_polls=Bool, change_info=Bool, invite_users=Bool, pin_messages=Bool, until_date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatEmpty.md b/old_docs/API_docs_v109/constructors/chatEmpty.md new file mode 100644 index 00000000..903328d2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatEmpty.md @@ -0,0 +1,38 @@ +--- +title: chatEmpty +description: Empty constructor, group doesn't exist +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatEmpty +[Back to constructors index](index.md) + + + +Empty constructor, group doesn't exist + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Group identifier| + + + +### Type: [Chat](../types/Chat.md) + + +### Example: + +```php +$chatEmpty = ['_' => 'chatEmpty', 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +chatEmpty={_='chatEmpty', id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatForbidden.md b/old_docs/API_docs_v109/constructors/chatForbidden.md new file mode 100644 index 00000000..7b65fee4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatForbidden.md @@ -0,0 +1,39 @@ +--- +title: chatForbidden +description: A group to which the user has no access. E.g., because the user was kicked from the group. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatForbidden +[Back to constructors index](index.md) + + + +A group to which the user has no access. E.g., because the user was kicked from the group. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|User identifier| +|title|[string](../types/string.md) | Yes|Group name| + + + +### Type: [Chat](../types/Chat.md) + + +### Example: + +```php +$chatForbidden = ['_' => 'chatForbidden', 'id' => int, 'title' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +chatForbidden={_='chatForbidden', id=int, title='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatFull.md b/old_docs/API_docs_v109/constructors/chatFull.md new file mode 100644 index 00000000..8188511e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatFull.md @@ -0,0 +1,48 @@ +--- +title: chatFull +description: Detailed chat info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatFull +[Back to constructors index](index.md) + + + +Detailed chat info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|can\_set\_username|[Bool](../types/Bool.md) | Optional|Can we change the username of this chat| +|has\_scheduled|[Bool](../types/Bool.md) | Optional|Whether scheduled messages are available| +|id|[int](../types/int.md) | Yes|ID of the chat| +|about|[string](../types/string.md) | Yes|About string for this chat| +|participants|[ChatParticipants](../types/ChatParticipants.md) | Yes|Participant list| +|chat\_photo|[Photo](../types/Photo.md) | Optional|Chat photo| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notification settings| +|exported\_invite|[ExportedChatInvite](../types/ExportedChatInvite.md) | Yes|Chat invite| +|bot\_info|Array of [BotInfo](../types/BotInfo.md) | Optional|Bot info| +|pinned\_msg\_id|[int](../types/int.md) | Optional|Message ID of the pinned message| +|folder\_id|[int](../types/int.md) | Optional|Folder ID| + + + +### Type: [ChatFull](../types/ChatFull.md) + + +### Example: + +```php +$chatFull = ['_' => 'chatFull', 'can_set_username' => Bool, 'has_scheduled' => Bool, 'id' => int, 'about' => 'string', 'participants' => ChatParticipants, 'chat_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'exported_invite' => ExportedChatInvite, 'bot_info' => [BotInfo, BotInfo], 'pinned_msg_id' => int, 'folder_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +chatFull={_='chatFull', can_set_username=Bool, has_scheduled=Bool, id=int, about='string', participants=ChatParticipants, chat_photo=Photo, notify_settings=PeerNotifySettings, exported_invite=ExportedChatInvite, bot_info={BotInfo}, pinned_msg_id=int, folder_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatInvite.md b/old_docs/API_docs_v109/constructors/chatInvite.md new file mode 100644 index 00000000..ee61f321 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatInvite.md @@ -0,0 +1,45 @@ +--- +title: chatInvite +description: Chat invite info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatInvite +[Back to constructors index](index.md) + + + +Chat invite info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Bool](../types/Bool.md) | Optional|Whether this is a [channel/supergroup](https://core.telegram.org/api/channel) or a [normal group](https://core.telegram.org/api/channel)| +|broadcast|[Bool](../types/Bool.md) | Optional|Whether this is a [channel](https://core.telegram.org/api/channel)| +|public|[Bool](../types/Bool.md) | Optional|Whether this is a public [channel/supergroup](https://core.telegram.org/api/channel)| +|megagroup|[Bool](../types/Bool.md) | Optional|Whether this is a [supergroup](https://core.telegram.org/api/channel)| +|title|[string](../types/string.md) | Yes|Chat/supergroup/channel title| +|photo|[Photo](../types/Photo.md) | Optional|Chat/supergroup/channel photo| +|participants\_count|[int](../types/int.md) | Yes|Participant count| +|participants|Array of [User](../types/User.md) | Optional|Participants| + + + +### Type: [ChatInvite](../types/ChatInvite.md) + + +### Example: + +```php +$chatInvite = ['_' => 'chatInvite', 'channel' => Bool, 'broadcast' => Bool, 'public' => Bool, 'megagroup' => Bool, 'title' => 'string', 'photo' => Photo, 'participants_count' => int, 'participants' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +chatInvite={_='chatInvite', channel=Bool, broadcast=Bool, public=Bool, megagroup=Bool, title='string', photo=Photo, participants_count=int, participants={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatInviteAlready.md b/old_docs/API_docs_v109/constructors/chatInviteAlready.md new file mode 100644 index 00000000..cd888566 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatInviteAlready.md @@ -0,0 +1,38 @@ +--- +title: chatInviteAlready +description: The user has already joined this chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatInviteAlready +[Back to constructors index](index.md) + + + +The user has already joined this chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat|[Chat](../types/Chat.md) | Optional|The chat connected to the invite| + + + +### Type: [ChatInvite](../types/ChatInvite.md) + + +### Example: + +```php +$chatInviteAlready = ['_' => 'chatInviteAlready', 'chat' => Chat]; +``` + + +Or, if you're into Lua: + +```lua +chatInviteAlready={_='chatInviteAlready', chat=Chat} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatInviteEmpty.md b/old_docs/API_docs_v109/constructors/chatInviteEmpty.md new file mode 100644 index 00000000..4cc73ee9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatInviteEmpty.md @@ -0,0 +1,33 @@ +--- +title: chatInviteEmpty +description: No info is associated to the chat invite +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatInviteEmpty +[Back to constructors index](index.md) + + + +No info is associated to the chat invite + + + + +### Type: [ExportedChatInvite](../types/ExportedChatInvite.md) + + +### Example: + +```php +$chatInviteEmpty = ['_' => 'chatInviteEmpty']; +``` + + +Or, if you're into Lua: + +```lua +chatInviteEmpty={_='chatInviteEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatInviteExported.md b/old_docs/API_docs_v109/constructors/chatInviteExported.md new file mode 100644 index 00000000..b0008637 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatInviteExported.md @@ -0,0 +1,38 @@ +--- +title: chatInviteExported +description: Exported chat invite +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatInviteExported +[Back to constructors index](index.md) + + + +Exported chat invite + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|link|[string](../types/string.md) | Yes|Chat invitation link| + + + +### Type: [ExportedChatInvite](../types/ExportedChatInvite.md) + + +### Example: + +```php +$chatInviteExported = ['_' => 'chatInviteExported', 'link' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +chatInviteExported={_='chatInviteExported', link='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatOnlines.md b/old_docs/API_docs_v109/constructors/chatOnlines.md new file mode 100644 index 00000000..f86f29d3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatOnlines.md @@ -0,0 +1,38 @@ +--- +title: chatOnlines +description: Number of online users in a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatOnlines +[Back to constructors index](index.md) + + + +Number of online users in a chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|onlines|[int](../types/int.md) | Yes|Number of online users| + + + +### Type: [ChatOnlines](../types/ChatOnlines.md) + + +### Example: + +```php +$chatOnlines = ['_' => 'chatOnlines', 'onlines' => int]; +``` + + +Or, if you're into Lua: + +```lua +chatOnlines={_='chatOnlines', onlines=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatParticipant.md b/old_docs/API_docs_v109/constructors/chatParticipant.md new file mode 100644 index 00000000..7a050583 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatParticipant.md @@ -0,0 +1,40 @@ +--- +title: chatParticipant +description: Group member. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatParticipant +[Back to constructors index](index.md) + + + +Group member. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|Member user ID| +|inviter\_id|[int](../types/int.md) | Yes|ID of the user that added the member to the group| +|date|[int](../types/int.md) | Yes|Date added to the group| + + + +### Type: [ChatParticipant](../types/ChatParticipant.md) + + +### Example: + +```php +$chatParticipant = ['_' => 'chatParticipant', 'user_id' => int, 'inviter_id' => int, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +chatParticipant={_='chatParticipant', user_id=int, inviter_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatParticipantAdmin.md b/old_docs/API_docs_v109/constructors/chatParticipantAdmin.md new file mode 100644 index 00000000..d85279d9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatParticipantAdmin.md @@ -0,0 +1,40 @@ +--- +title: chatParticipantAdmin +description: Chat admin +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatParticipantAdmin +[Back to constructors index](index.md) + + + +Chat admin + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|ID of a group member that is admin| +|inviter\_id|[int](../types/int.md) | Yes|ID of the user that added the member to the group| +|date|[int](../types/int.md) | Yes|Date when the user was added| + + + +### Type: [ChatParticipant](../types/ChatParticipant.md) + + +### Example: + +```php +$chatParticipantAdmin = ['_' => 'chatParticipantAdmin', 'user_id' => int, 'inviter_id' => int, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +chatParticipantAdmin={_='chatParticipantAdmin', user_id=int, inviter_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatParticipantCreator.md b/old_docs/API_docs_v109/constructors/chatParticipantCreator.md new file mode 100644 index 00000000..396cd411 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatParticipantCreator.md @@ -0,0 +1,38 @@ +--- +title: chatParticipantCreator +description: Represents the creator of the group +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatParticipantCreator +[Back to constructors index](index.md) + + + +Represents the creator of the group + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|ID of the user that created the group| + + + +### Type: [ChatParticipant](../types/ChatParticipant.md) + + +### Example: + +```php +$chatParticipantCreator = ['_' => 'chatParticipantCreator', 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +chatParticipantCreator={_='chatParticipantCreator', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatParticipants.md b/old_docs/API_docs_v109/constructors/chatParticipants.md new file mode 100644 index 00000000..44c9d94e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatParticipants.md @@ -0,0 +1,40 @@ +--- +title: chatParticipants +description: Group members. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatParticipants +[Back to constructors index](index.md) + + + +Group members. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|Group identifier| +|participants|Array of [ChatParticipant](../types/ChatParticipant.md) | Yes|Participants| +|version|[int](../types/int.md) | Yes|Group version number| + + + +### Type: [ChatParticipants](../types/ChatParticipants.md) + + +### Example: + +```php +$chatParticipants = ['_' => 'chatParticipants', 'chat_id' => int, 'participants' => [ChatParticipant, ChatParticipant], 'version' => int]; +``` + + +Or, if you're into Lua: + +```lua +chatParticipants={_='chatParticipants', chat_id=int, participants={ChatParticipant}, version=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatParticipantsForbidden.md b/old_docs/API_docs_v109/constructors/chatParticipantsForbidden.md new file mode 100644 index 00000000..9a12020c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatParticipantsForbidden.md @@ -0,0 +1,39 @@ +--- +title: chatParticipantsForbidden +description: Info on members is unavailable +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatParticipantsForbidden +[Back to constructors index](index.md) + + + +Info on members is unavailable + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|Group ID| +|self\_participant|[ChatParticipant](../types/ChatParticipant.md) | Optional|Info about the group membership of the current user| + + + +### Type: [ChatParticipants](../types/ChatParticipants.md) + + +### Example: + +```php +$chatParticipantsForbidden = ['_' => 'chatParticipantsForbidden', 'chat_id' => int, 'self_participant' => ChatParticipant]; +``` + + +Or, if you're into Lua: + +```lua +chatParticipantsForbidden={_='chatParticipantsForbidden', chat_id=int, self_participant=ChatParticipant} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatPhoto.md b/old_docs/API_docs_v109/constructors/chatPhoto.md new file mode 100644 index 00000000..94d34ce0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatPhoto.md @@ -0,0 +1,40 @@ +--- +title: chatPhoto +description: Group profile photo. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatPhoto +[Back to constructors index](index.md) + + + +Group profile photo. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|photo\_small|[FileLocation](../types/FileLocation.md) | Yes|Location of the file corresponding to the small thumbnail for group profile photo| +|photo\_big|[FileLocation](../types/FileLocation.md) | Yes|Location of the file corresponding to the small thumbnail for group profile photo| +|dc\_id|[int](../types/int.md) | Yes|DC where this photo is stored| + + + +### Type: [ChatPhoto](../types/ChatPhoto.md) + + +### Example: + +```php +$chatPhoto = ['_' => 'chatPhoto', 'photo_small' => FileLocation, 'photo_big' => FileLocation, 'dc_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +chatPhoto={_='chatPhoto', photo_small=FileLocation, photo_big=FileLocation, dc_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/chatPhotoEmpty.md b/old_docs/API_docs_v109/constructors/chatPhotoEmpty.md new file mode 100644 index 00000000..d8441372 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/chatPhotoEmpty.md @@ -0,0 +1,33 @@ +--- +title: chatPhotoEmpty +description: Group photo is not set. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: chatPhotoEmpty +[Back to constructors index](index.md) + + + +Group photo is not set. + + + + +### Type: [ChatPhoto](../types/ChatPhoto.md) + + +### Example: + +```php +$chatPhotoEmpty = ['_' => 'chatPhotoEmpty']; +``` + + +Or, if you're into Lua: + +```lua +chatPhotoEmpty={_='chatPhotoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/codeSettings.md b/old_docs/API_docs_v109/constructors/codeSettings.md new file mode 100644 index 00000000..b8a92d46 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/codeSettings.md @@ -0,0 +1,44 @@ +--- +title: codeSettings +description: Settings used by telegram servers for sending the confirm code. + +Example implementations: [telegram for android](https://github.com/DrKLO/Telegram/blob/master/TMessagesProj/src/main/java/org/telegram/ui/LoginActivity.java), [tdlib](https://github.com/tdlib/td/tree/master/td/telegram/SendCodeHelper.cpp). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: codeSettings +[Back to constructors index](index.md) + + + +Settings used by telegram servers for sending the confirm code. + +Example implementations: [telegram for android](https://github.com/DrKLO/Telegram/blob/master/TMessagesProj/src/main/java/org/telegram/ui/LoginActivity.java), [tdlib](https://github.com/tdlib/td/tree/master/td/telegram/SendCodeHelper.cpp). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|allow\_flashcall|[Bool](../types/Bool.md) | Optional|Whether to allow phone verification via [phone calls](https://core.telegram.org/api/auth).| +|current\_number|[Bool](../types/Bool.md) | Optional|Pass true if the phone number is used on the current device. Ignored if allow\_flashcall is not set.| +|allow\_app\_hash|[Bool](../types/Bool.md) | Optional|If a token that will be included in eventually sent SMSs is required: required in newer versions of android, to use the [android SMS receiver APIs](https://developers.google.com/identity/sms-retriever/overview)| + + + +### Type: [CodeSettings](../types/CodeSettings.md) + + +### Example: + +```php +$codeSettings = ['_' => 'codeSettings', 'allow_flashcall' => Bool, 'current_number' => Bool, 'allow_app_hash' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +codeSettings={_='codeSettings', allow_flashcall=Bool, current_number=Bool, allow_app_hash=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/config.md b/old_docs/API_docs_v109/constructors/config.md new file mode 100644 index 00000000..c08b9e67 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/config.md @@ -0,0 +1,88 @@ +--- +title: config +description: Current configuration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: config +[Back to constructors index](index.md) + + + +Current configuration + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phonecalls\_enabled|[Bool](../types/Bool.md) | Optional|Whether phone calls can be used| +|default\_p2p\_contacts|[Bool](../types/Bool.md) | Optional|Whether the client should use P2P by default for phone calls with contacts| +|preload\_featured\_stickers|[Bool](../types/Bool.md) | Optional|Whether the client should preload featured stickers| +|ignore\_phone\_entities|[Bool](../types/Bool.md) | Optional|Whether the client should ignore phone [entities](https://core.telegram.org/api/entities)| +|revoke\_pm\_inbox|[Bool](../types/Bool.md) | Optional|Whether incoming private messages can be deleted for both participants| +|blocked\_mode|[Bool](../types/Bool.md) | Optional|Indicates that telegram is *probably* censored by governments/ISPs in the current region| +|pfs\_enabled|[Bool](../types/Bool.md) | Optional|Whether [pfs](https://core.telegram.org/api/pfs) was used| +|date|[int](../types/int.md) | Yes|Current date at the server| +|expires|[int](../types/int.md) | Yes|Expiration date of this config: when it expires it'll have to be refetched using [help.getConfig](../methods/help.getConfig.md)| +|test\_mode|[Bool](../types/Bool.md) | Yes|Whether we're connected to the test DCs| +|this\_dc|[int](../types/int.md) | Yes|ID of the DC that returned the reply| +|dc\_options|Array of [DcOption](../types/DcOption.md) | Yes|DC options| +|dc\_txt\_domain\_name|[string](../types/string.md) | Yes|Domain name for fetching encrypted DC list from DNS TXT record| +|chat\_size\_max|[int](../types/int.md) | Yes|Maximum member count for normal [groups](https://core.telegram.org/api/channel)| +|megagroup\_size\_max|[int](../types/int.md) | Yes|Maximum member count for [supergroups](https://core.telegram.org/api/channel)| +|forwarded\_count\_max|[int](../types/int.md) | Yes|Maximum number of messages that can be forwarded at once using [messages.forwardMessages](../methods/messages.forwardMessages.md).| +|online\_update\_period\_ms|[int](../types/int.md) | Yes|The client should [update its online status](../methods/account.updateStatus.md) every N milliseconds| +|offline\_blur\_timeout\_ms|[int](../types/int.md) | Yes|Delay before offline status needs to be sent to the server| +|offline\_idle\_timeout\_ms|[int](../types/int.md) | Yes|Time without any user activity after which it should be treated offline| +|online\_cloud\_timeout\_ms|[int](../types/int.md) | Yes|If we are offline, but were online from some other client in last `online_cloud_timeout_ms` milliseconds after we had gone offline, then delay offline notification for `notify_cloud_delay_ms` milliseconds.| +|notify\_cloud\_delay\_ms|[int](../types/int.md) | Yes|If we are offline, but online from some other client then delay sending the offline notification for `notify_cloud_delay_ms` milliseconds.| +|notify\_default\_delay\_ms|[int](../types/int.md) | Yes|If some other client is online, then delay notification for `notification_default_delay_ms` milliseconds| +|push\_chat\_period\_ms|[int](../types/int.md) | Yes|Not for client use| +|push\_chat\_limit|[int](../types/int.md) | Yes|Not for client use| +|saved\_gifs\_limit|[int](../types/int.md) | Yes|Maximum count of saved gifs| +|edit\_time\_limit|[int](../types/int.md) | Yes|Only messages with age smaller than the one specified can be edited| +|revoke\_time\_limit|[int](../types/int.md) | Yes|Only channel/supergroup messages with age smaller than the specified can be deleted| +|revoke\_pm\_time\_limit|[int](../types/int.md) | Yes|Only private messages with age smaller than the specified can be deleted| +|rating\_e\_decay|[int](../types/int.md) | Yes|Exponential decay rate for computing [top peer rating](https://core.telegram.org/api/top-rating)| +|stickers\_recent\_limit|[int](../types/int.md) | Yes|Maximum number of recent stickers| +|stickers\_faved\_limit|[int](../types/int.md) | Yes|Maximum number of faved stickers| +|channels\_read\_media\_period|[int](../types/int.md) | Yes|Indicates that round videos (video notes) and voice messages sent in channels and older than the specified period must be marked as read| +|tmp\_sessions|[int](../types/int.md) | Optional|Temporary [passport](https://core.telegram.org/passport) sessions| +|pinned\_dialogs\_count\_max|[int](../types/int.md) | Yes|Maximum count of pinned dialogs| +|pinned\_infolder\_count\_max|[int](../types/int.md) | Yes|Maximum count of dialogs per folder| +|call\_receive\_timeout\_ms|[int](../types/int.md) | Yes|Maximum allowed outgoing ring time in VoIP calls: if the user we're calling doesn't reply within the specified time (in milliseconds), we should hang up the call| +|call\_ring\_timeout\_ms|[int](../types/int.md) | Yes|Maximum allowed incoming ring time in VoIP calls: if the current user doesn't reply within the specified time (in milliseconds), the call will be automatically refused| +|call\_connect\_timeout\_ms|[int](../types/int.md) | Yes|VoIP connection timeout: if the instance of libtgvoip on the other side of the call doesn't connect to our instance of libtgvoip within the specified time (in milliseconds), the call must be aborted| +|call\_packet\_timeout\_ms|[int](../types/int.md) | Yes|If during a VoIP call a packet isn't received for the specified period of time, the call must be aborted| +|me\_url\_prefix|[string](../types/string.md) | Yes|The domain to use to parse in-app links.
For example t.me indicates that t.me/username links should parsed to @username, t.me/addsticker/name should be parsed to the appropriate stickerset and so on...| +|autoupdate\_url\_prefix|[string](../types/string.md) | Optional|URL to use to auto-update the current app| +|gif\_search\_username|[string](../types/string.md) | Optional|Username of the bot to use to search for GIFs| +|venue\_search\_username|[string](../types/string.md) | Optional|Username of the bot to use to search for venues| +|img\_search\_username|[string](../types/string.md) | Optional|Username of the bot to use for image search| +|static\_maps\_provider|[string](../types/string.md) | Optional|ID of the map provider to use for venues| +|caption\_length\_max|[int](../types/int.md) | Yes|Maximum length of caption (length in utf8 codepoints)| +|message\_length\_max|[int](../types/int.md) | Yes|Maximum length of messages (length in utf8 codepoints)| +|webfile\_dc\_id|[int](../types/int.md) | Yes|DC ID to use to download [webfiles](https://core.telegram.org/api/files)| +|suggested\_lang\_code|[string](../types/string.md) | Optional|Suggested language code| +|lang\_pack\_version|[int](../types/int.md) | Optional|Language pack version| +|base\_lang\_pack\_version|[int](../types/int.md) | Optional|Basic language pack version| + + + +### Type: [Config](../types/Config.md) + + +### Example: + +```php +$config = ['_' => 'config', 'phonecalls_enabled' => Bool, 'default_p2p_contacts' => Bool, 'preload_featured_stickers' => Bool, 'ignore_phone_entities' => Bool, 'revoke_pm_inbox' => Bool, 'blocked_mode' => Bool, 'pfs_enabled' => Bool, 'date' => int, 'expires' => int, 'test_mode' => Bool, 'this_dc' => int, 'dc_options' => [DcOption, DcOption], 'dc_txt_domain_name' => 'string', '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, 'pinned_infolder_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', 'gif_search_username' => 'string', 'venue_search_username' => 'string', 'img_search_username' => 'string', 'static_maps_provider' => 'string', 'caption_length_max' => int, 'message_length_max' => int, 'webfile_dc_id' => int, 'suggested_lang_code' => 'string', 'lang_pack_version' => int, 'base_lang_pack_version' => int]; +``` + + +Or, if you're into Lua: + +```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, pfs_enabled=Bool, date=int, expires=int, test_mode=Bool, this_dc=int, dc_options={DcOption}, dc_txt_domain_name='string', 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, pinned_infolder_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', gif_search_username='string', venue_search_username='string', img_search_username='string', static_maps_provider='string', caption_length_max=int, message_length_max=int, webfile_dc_id=int, suggested_lang_code='string', lang_pack_version=int, base_lang_pack_version=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contact.md b/old_docs/API_docs_v109/constructors/contact.md new file mode 100644 index 00000000..1a055c17 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contact.md @@ -0,0 +1,39 @@ +--- +title: contact +description: A contact of the current user that is registered in the system. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contact +[Back to constructors index](index.md) + + + +A contact of the current user that is registered in the system. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|mutual|[Bool](../types/Bool.md) | Yes|Current user is in the user's contact list| + + + +### Type: [Contact](../types/Contact.md) + + +### Example: + +```php +$contact = ['_' => 'contact', 'user_id' => int, 'mutual' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +contact={_='contact', user_id=int, mutual=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contactBlocked.md b/old_docs/API_docs_v109/constructors/contactBlocked.md new file mode 100644 index 00000000..43052f8d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contactBlocked.md @@ -0,0 +1,39 @@ +--- +title: contactBlocked +description: A blocked user. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contactBlocked +[Back to constructors index](index.md) + + + +A blocked user. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|date|[int](../types/int.md) | Yes|Date blacklisted| + + + +### Type: [ContactBlocked](../types/ContactBlocked.md) + + +### Example: + +```php +$contactBlocked = ['_' => 'contactBlocked', 'user_id' => int, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +contactBlocked={_='contactBlocked', user_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contactStatus.md b/old_docs/API_docs_v109/constructors/contactStatus.md new file mode 100644 index 00000000..40dbd762 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contactStatus.md @@ -0,0 +1,39 @@ +--- +title: contactStatus +description: Contact status: online / offline. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: contactStatus +[Back to constructors index](index.md) + + + +Contact status: online / offline. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|status|[UserStatus](../types/UserStatus.md) | Optional|Online status| + + + +### Type: [ContactStatus](../types/ContactStatus.md) + + +### Example: + +```php +$contactStatus = ['_' => 'contactStatus', 'user_id' => int, 'status' => UserStatus]; +``` + + +Or, if you're into Lua: + +```lua +contactStatus={_='contactStatus', user_id=int, status=UserStatus} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contacts.blocked.md b/old_docs/API_docs_v109/constructors/contacts.blocked.md new file mode 100644 index 00000000..d1013bf1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contacts.blocked.md @@ -0,0 +1,40 @@ +--- +title: contacts.blocked +description: Full list of blocked users. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_blocked.html +--- +# Constructor: contacts.blocked +[Back to constructors index](index.md) + + + +Full list of blocked users. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|Blocked| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [contacts.Blocked](../types/contacts.Blocked.md) + + +### Example: + +```php +$contacts.blocked = ['_' => 'contacts.blocked', 'blocked' => [ContactBlocked, ContactBlocked], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +contacts.blocked={_='contacts.blocked', blocked={ContactBlocked}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contacts.blockedSlice.md b/old_docs/API_docs_v109/constructors/contacts.blockedSlice.md new file mode 100644 index 00000000..8f0031bf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contacts.blockedSlice.md @@ -0,0 +1,41 @@ +--- +title: contacts.blockedSlice +description: Incomplete list of blocked users. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_blockedSlice.html +--- +# Constructor: contacts.blockedSlice +[Back to constructors index](index.md) + + + +Incomplete list of blocked users. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Total number of elements in the list| +|blocked|Array of [ContactBlocked](../types/ContactBlocked.md) | Yes|Blocked| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [contacts.Blocked](../types/contacts.Blocked.md) + + +### Example: + +```php +$contacts.blockedSlice = ['_' => 'contacts.blockedSlice', 'count' => int, 'blocked' => [ContactBlocked, ContactBlocked], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +contacts.blockedSlice={_='contacts.blockedSlice', count=int, blocked={ContactBlocked}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contacts.contacts.md b/old_docs/API_docs_v109/constructors/contacts.contacts.md new file mode 100644 index 00000000..7fbb1ece --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contacts.contacts.md @@ -0,0 +1,41 @@ +--- +title: contacts.contacts +description: The current user's contact list and info on users. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_contacts.html +--- +# Constructor: contacts.contacts +[Back to constructors index](index.md) + + + +The current user's contact list and info on users. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|contacts|Array of [Contact](../types/Contact.md) | Yes|Contacts| +|saved\_count|[int](../types/int.md) | Yes|Number of contacts that were saved successfully| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [contacts.Contacts](../types/contacts.Contacts.md) + + +### Example: + +```php +$contacts.contacts = ['_' => 'contacts.contacts', 'contacts' => [Contact, Contact], 'saved_count' => int, 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +contacts.contacts={_='contacts.contacts', contacts={Contact}, saved_count=int, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contacts.contactsNotModified.md b/old_docs/API_docs_v109/constructors/contacts.contactsNotModified.md new file mode 100644 index 00000000..b8d13283 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contacts.contactsNotModified.md @@ -0,0 +1,34 @@ +--- +title: contacts.contactsNotModified +description: Contact list on the server is the same as the list on the client. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_contactsNotModified.html +--- +# Constructor: contacts.contactsNotModified +[Back to constructors index](index.md) + + + +Contact list on the server is the same as the list on the client. + + + + +### Type: [contacts.Contacts](../types/contacts.Contacts.md) + + +### Example: + +```php +$contacts.contactsNotModified = ['_' => 'contacts.contactsNotModified']; +``` + + +Or, if you're into Lua: + +```lua +contacts.contactsNotModified={_='contacts.contactsNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contacts.found.md b/old_docs/API_docs_v109/constructors/contacts.found.md new file mode 100644 index 00000000..02f0b4c2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contacts.found.md @@ -0,0 +1,42 @@ +--- +title: contacts.found +description: Users found by name substring and auxiliary data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_found.html +--- +# Constructor: contacts.found +[Back to constructors index](index.md) + + + +Users found by name substring and auxiliary data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|my\_results|Array of [Peer](../types/Peer.md) | Yes|My results| +|results|Array of [Peer](../types/Peer.md) | Yes|Results| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [contacts.Found](../types/contacts.Found.md) + + +### Example: + +```php +$contacts.found = ['_' => 'contacts.found', 'my_results' => [Peer, Peer], 'results' => [Peer, Peer], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +contacts.found={_='contacts.found', my_results={Peer}, results={Peer}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contacts.importedContacts.md b/old_docs/API_docs_v109/constructors/contacts.importedContacts.md new file mode 100644 index 00000000..0e793a61 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contacts.importedContacts.md @@ -0,0 +1,42 @@ +--- +title: contacts.importedContacts +description: Info on succesfully imported contacts. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_importedContacts.html +--- +# Constructor: contacts.importedContacts +[Back to constructors index](index.md) + + + +Info on succesfully imported contacts. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|imported|Array of [ImportedContact](../types/ImportedContact.md) | Yes|Imported| +|popular\_invites|Array of [PopularContact](../types/PopularContact.md) | Yes|Popular invites| +|retry\_contacts|Array of [long](../types/long.md) | Yes|Retry importing contacts whose client IDs appear here| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [contacts.ImportedContacts](../types/contacts.ImportedContacts.md) + + +### Example: + +```php +$contacts.importedContacts = ['_' => 'contacts.importedContacts', 'imported' => [ImportedContact, ImportedContact], 'popular_invites' => [PopularContact, PopularContact], 'retry_contacts' => [long, long], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +contacts.importedContacts={_='contacts.importedContacts', imported={ImportedContact}, popular_invites={PopularContact}, retry_contacts={long}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contacts.resolvedPeer.md b/old_docs/API_docs_v109/constructors/contacts.resolvedPeer.md new file mode 100644 index 00000000..169865b6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contacts.resolvedPeer.md @@ -0,0 +1,41 @@ +--- +title: contacts.resolvedPeer +description: Resolved peer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_resolvedPeer.html +--- +# Constructor: contacts.resolvedPeer +[Back to constructors index](index.md) + + + +Resolved peer + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|The peer| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [contacts.ResolvedPeer](../types/contacts.ResolvedPeer.md) + + +### Example: + +```php +$contacts.resolvedPeer = ['_' => 'contacts.resolvedPeer', 'peer' => Peer, 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +contacts.resolvedPeer={_='contacts.resolvedPeer', peer=Peer, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contacts.topPeers.md b/old_docs/API_docs_v109/constructors/contacts.topPeers.md new file mode 100644 index 00000000..0588e3d2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contacts.topPeers.md @@ -0,0 +1,41 @@ +--- +title: contacts.topPeers +description: Top peers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_topPeers.html +--- +# Constructor: contacts.topPeers +[Back to constructors index](index.md) + + + +Top peers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|categories|Array of [TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md) | Yes|Categories| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [contacts.TopPeers](../types/contacts.TopPeers.md) + + +### Example: + +```php +$contacts.topPeers = ['_' => 'contacts.topPeers', 'categories' => [TopPeerCategoryPeers, TopPeerCategoryPeers], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +contacts.topPeers={_='contacts.topPeers', categories={TopPeerCategoryPeers}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contacts.topPeersDisabled.md b/old_docs/API_docs_v109/constructors/contacts.topPeersDisabled.md new file mode 100644 index 00000000..e699f926 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contacts.topPeersDisabled.md @@ -0,0 +1,34 @@ +--- +title: contacts.topPeersDisabled +description: Top peers disabled +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_topPeersDisabled.html +--- +# Constructor: contacts.topPeersDisabled +[Back to constructors index](index.md) + + + +Top peers disabled + + + + +### Type: [contacts.TopPeers](../types/contacts.TopPeers.md) + + +### Example: + +```php +$contacts.topPeersDisabled = ['_' => 'contacts.topPeersDisabled']; +``` + + +Or, if you're into Lua: + +```lua +contacts.topPeersDisabled={_='contacts.topPeersDisabled'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/contacts.topPeersNotModified.md b/old_docs/API_docs_v109/constructors/contacts.topPeersNotModified.md new file mode 100644 index 00000000..260e3614 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/contacts.topPeersNotModified.md @@ -0,0 +1,34 @@ +--- +title: contacts.topPeersNotModified +description: Top peer info hasn't changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/contacts_topPeersNotModified.html +--- +# Constructor: contacts.topPeersNotModified +[Back to constructors index](index.md) + + + +Top peer info hasn't changed + + + + +### Type: [contacts.TopPeers](../types/contacts.TopPeers.md) + + +### Example: + +```php +$contacts.topPeersNotModified = ['_' => 'contacts.topPeersNotModified']; +``` + + +Or, if you're into Lua: + +```lua +contacts.topPeersNotModified={_='contacts.topPeersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/dataJSON.md b/old_docs/API_docs_v109/constructors/dataJSON.md new file mode 100644 index 00000000..5038e19b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/dataJSON.md @@ -0,0 +1,38 @@ +--- +title: dataJSON +description: Represents a json-encoded object +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dataJSON +[Back to constructors index](index.md) + + + +Represents a json-encoded object + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|data|[string](../types/string.md) | Yes|JSON-encoded object| + + + +### Type: [DataJSON](../types/DataJSON.md) + + +### Example: + +```php +$dataJSON = ['_' => 'dataJSON', 'data' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +dataJSON={_='dataJSON', data='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/dcOption.md b/old_docs/API_docs_v109/constructors/dcOption.md new file mode 100644 index 00000000..b6b7a166 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/dcOption.md @@ -0,0 +1,46 @@ +--- +title: dcOption +description: Data centre +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dcOption +[Back to constructors index](index.md) + + + +Data centre + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|ipv6|[Bool](../types/Bool.md) | Optional|Whether the specified IP is an IPv6 address| +|media\_only|[Bool](../types/Bool.md) | Optional|Whether this DC should only be used to [download or upload files](https://core.telegram.org/api/files)| +|tcpo\_only|[Bool](../types/Bool.md) | Optional|Whether this DC only supports connection with [transport obfuscation](https://core.telegram.org/mtproto/mtproto-transports#transport-obfuscation)| +|cdn|[Bool](../types/Bool.md) | Optional|Whether this is a [CDN DC](https://core.telegram.org/cdn).| +|static|[Bool](../types/Bool.md) | Optional|If set, this IP should be used when connecting through a proxy| +|id|[int](../types/int.md) | Yes|DC ID| +|ip\_address|[string](../types/string.md) | Yes|IP address of DC| +|port|[int](../types/int.md) | Yes|Port| +|secret|[bytes](../types/bytes.md) | Optional|If the `tcpo_only` flag is set, specifies the secret to use when connecting using [transport obfuscation](https://core.telegram.org/mtproto/mtproto-transports#transport-obfuscation)| + + + +### Type: [DcOption](../types/DcOption.md) + + +### Example: + +```php +$dcOption = ['_' => 'dcOption', 'ipv6' => Bool, 'media_only' => Bool, 'tcpo_only' => Bool, 'cdn' => Bool, 'static' => Bool, 'id' => int, 'ip_address' => 'string', 'port' => int, 'secret' => 'bytes']; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/dialog.md b/old_docs/API_docs_v109/constructors/dialog.md new file mode 100644 index 00000000..32ee9464 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/dialog.md @@ -0,0 +1,49 @@ +--- +title: dialog +description: Chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dialog +[Back to constructors index](index.md) + + + +Chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[Bool](../types/Bool.md) | Optional|Is the dialog pinned| +|unread\_mark|[Bool](../types/Bool.md) | Optional|Whether the chat was manually marked as unread| +|peer|[Peer](../types/Peer.md) | Yes|The chat| +|top\_message|[int](../types/int.md) | Yes|The latest message ID| +|read\_inbox\_max\_id|[int](../types/int.md) | Yes|Position up to which all incoming messages are read.| +|read\_outbox\_max\_id|[int](../types/int.md) | Yes|Position up to which all outgoing messages are read.| +|unread\_count|[int](../types/int.md) | Yes|Number of unread messages| +|unread\_mentions\_count|[int](../types/int.md) | Yes|Number of unread mentions| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notification settings| +|pts|[int](../types/int.md) | Optional|[PTS](https://core.telegram.org/api/updates)| +|draft|[DraftMessage](../types/DraftMessage.md) | Optional|Message draft| +|folder\_id|[int](../types/int.md) | Optional|Folder ID| + + + +### Type: [Dialog](../types/Dialog.md) + + +### Example: + +```php +$dialog = ['_' => 'dialog', 'pinned' => Bool, 'unread_mark' => 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, 'folder_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +dialog={_='dialog', pinned=Bool, unread_mark=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, folder_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/dialogFolder.md b/old_docs/API_docs_v109/constructors/dialogFolder.md new file mode 100644 index 00000000..9c8b3ac1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/dialogFolder.md @@ -0,0 +1,45 @@ +--- +title: dialogFolder +description: Dialog in folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dialogFolder +[Back to constructors index](index.md) + + + +Dialog in folder + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[Bool](../types/Bool.md) | Optional|Is this folder pinned| +|folder|[Folder](../types/Folder.md) | Yes|The folder| +|peer|[Peer](../types/Peer.md) | Yes|Peer in folder| +|top\_message|[int](../types/int.md) | Yes|Latest message ID of dialog| +|unread\_muted\_peers\_count|[int](../types/int.md) | Yes|Number of unread muted peers in folder| +|unread\_unmuted\_peers\_count|[int](../types/int.md) | Yes|Number of unread unmuted peers in folder| +|unread\_muted\_messages\_count|[int](../types/int.md) | Yes|Number of unread messages from muted peers in folder| +|unread\_unmuted\_messages\_count|[int](../types/int.md) | Yes|Number of unread messages from unmuted peers in folder| + + + +### Type: [Dialog](../types/Dialog.md) + + +### Example: + +```php +$dialogFolder = ['_' => 'dialogFolder', 'pinned' => Bool, 'folder' => Folder, 'peer' => Peer, 'top_message' => int, 'unread_muted_peers_count' => int, 'unread_unmuted_peers_count' => int, 'unread_muted_messages_count' => int, 'unread_unmuted_messages_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +dialogFolder={_='dialogFolder', pinned=Bool, folder=Folder, peer=Peer, top_message=int, unread_muted_peers_count=int, unread_unmuted_peers_count=int, unread_muted_messages_count=int, unread_unmuted_messages_count=int} + +``` + + diff --git a/docs/API_docs/constructors/ipPort.md b/old_docs/API_docs_v109/constructors/dialogPeer.md similarity index 52% rename from docs/API_docs/constructors/ipPort.md rename to old_docs/API_docs_v109/constructors/dialogPeer.md index 3173c09d..5a2f5e8d 100644 --- a/docs/API_docs/constructors/ipPort.md +++ b/old_docs/API_docs_v109/constructors/dialogPeer.md @@ -1,38 +1,37 @@ --- -title: ipPort -description: Ip port +title: dialogPeer +description: Peer image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Constructor: ipPort +# Constructor: dialogPeer [Back to constructors index](index.md) -Ip port +Peer ### Attributes: | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|ipv4|[int](../types/int.md) | Yes|Ipv4| -|port|[int](../types/int.md) | Yes|Port| +|peer|[Peer](../types/Peer.md) | Yes|Peer| -### Type: [IpPort](../types/IpPort.md) +### Type: [DialogPeer](../types/DialogPeer.md) ### Example: ```php -$ipPort = ['_' => 'ipPort', 'ipv4' => int, 'port' => int]; +$dialogPeer = ['_' => 'dialogPeer', 'peer' => Peer]; ``` Or, if you're into Lua: ```lua -ipPort={_='ipPort', ipv4=int, port=int} +dialogPeer={_='dialogPeer', peer=Peer} ``` diff --git a/old_docs/API_docs_v109/constructors/dialogPeerFolder.md b/old_docs/API_docs_v109/constructors/dialogPeerFolder.md new file mode 100644 index 00000000..56f6d114 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/dialogPeerFolder.md @@ -0,0 +1,38 @@ +--- +title: dialogPeerFolder +description: Folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: dialogPeerFolder +[Back to constructors index](index.md) + + + +Folder + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|folder\_id|[int](../types/int.md) | Yes|Folder ID| + + + +### Type: [DialogPeer](../types/DialogPeer.md) + + +### Example: + +```php +$dialogPeerFolder = ['_' => 'dialogPeerFolder', 'folder_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +dialogPeerFolder={_='dialogPeerFolder', folder_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/document.md b/old_docs/API_docs_v109/constructors/document.md new file mode 100644 index 00000000..35d3c09b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/document.md @@ -0,0 +1,46 @@ +--- +title: document +description: Document +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: document +[Back to constructors index](index.md) + + + +Document + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Document ID| +|access\_hash|[long](../types/long.md) | Yes|Check sum, dependant on document ID| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| +|date|[int](../types/int.md) | Yes|Creation date| +|mime\_type|[string](../types/string.md) | Yes|MIME type| +|size|[int](../types/int.md) | Yes|Size| +|thumbs|Array of [PhotoSize](../types/PhotoSize.md) | Optional|Thumbnails| +|dc\_id|[int](../types/int.md) | Yes|DC ID| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes| + + + +### Type: [Document](../types/Document.md) + + +### Example: + +```php +$document = ['_' => 'document', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'date' => int, 'mime_type' => 'string', 'size' => int, 'thumbs' => [PhotoSize, PhotoSize], 'dc_id' => int, 'attributes' => [DocumentAttribute, DocumentAttribute]]; +``` + + +Or, if you're into Lua: + +```lua +document={_='document', id=long, access_hash=long, file_reference='bytes', date=int, mime_type='string', size=int, thumbs={PhotoSize}, dc_id=int, attributes={DocumentAttribute}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/documentAttributeAnimated.md b/old_docs/API_docs_v109/constructors/documentAttributeAnimated.md new file mode 100644 index 00000000..e7f5ed7b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/documentAttributeAnimated.md @@ -0,0 +1,33 @@ +--- +title: documentAttributeAnimated +description: Defines an animated GIF +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeAnimated +[Back to constructors index](index.md) + + + +Defines an animated GIF + + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +```php +$documentAttributeAnimated = ['_' => 'documentAttributeAnimated']; +``` + + +Or, if you're into Lua: + +```lua +documentAttributeAnimated={_='documentAttributeAnimated'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/documentAttributeAudio.md b/old_docs/API_docs_v109/constructors/documentAttributeAudio.md new file mode 100644 index 00000000..2f38c9e0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/documentAttributeAudio.md @@ -0,0 +1,42 @@ +--- +title: documentAttributeAudio +description: Represents an audio file +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeAudio +[Back to constructors index](index.md) + + + +Represents an audio file + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|voice|[Bool](../types/Bool.md) | Optional|Whether this is a voice message| +|duration|[int](../types/int.md) | Optional|Duration in seconds| +|title|[string](../types/string.md) | Optional|Name of song| +|performer|[string](../types/string.md) | Optional|Performer| +|waveform|[bytes](../types/bytes.md) | Optional|Waveform| + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +```php +$documentAttributeAudio = ['_' => 'documentAttributeAudio', 'voice' => Bool, 'duration' => int, 'title' => 'string', 'performer' => 'string', 'waveform' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +documentAttributeAudio={_='documentAttributeAudio', voice=Bool, duration=int, title='string', performer='string', waveform='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/documentAttributeFilename.md b/old_docs/API_docs_v109/constructors/documentAttributeFilename.md new file mode 100644 index 00000000..d0d140e9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/documentAttributeFilename.md @@ -0,0 +1,38 @@ +--- +title: documentAttributeFilename +description: A simple document with a file name +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeFilename +[Back to constructors index](index.md) + + + +A simple document with a file name + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file\_name|[string](../types/string.md) | Yes|The file name| + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +```php +$documentAttributeFilename = ['_' => 'documentAttributeFilename', 'file_name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +documentAttributeFilename={_='documentAttributeFilename', file_name='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/documentAttributeHasStickers.md b/old_docs/API_docs_v109/constructors/documentAttributeHasStickers.md new file mode 100644 index 00000000..ef501438 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/documentAttributeHasStickers.md @@ -0,0 +1,33 @@ +--- +title: documentAttributeHasStickers +description: Whether the current document has stickers attached +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeHasStickers +[Back to constructors index](index.md) + + + +Whether the current document has stickers attached + + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +```php +$documentAttributeHasStickers = ['_' => 'documentAttributeHasStickers']; +``` + + +Or, if you're into Lua: + +```lua +documentAttributeHasStickers={_='documentAttributeHasStickers'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/documentAttributeImageSize.md b/old_docs/API_docs_v109/constructors/documentAttributeImageSize.md new file mode 100644 index 00000000..17341669 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/documentAttributeImageSize.md @@ -0,0 +1,39 @@ +--- +title: documentAttributeImageSize +description: Defines the width and height of an image uploaded as document +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeImageSize +[Back to constructors index](index.md) + + + +Defines the width and height of an image uploaded as document + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|w|[int](../types/int.md) | Optional|Width of image| +|h|[int](../types/int.md) | Optional|Height of image| + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +```php +$documentAttributeImageSize = ['_' => 'documentAttributeImageSize', 'w' => int, 'h' => int]; +``` + + +Or, if you're into Lua: + +```lua +documentAttributeImageSize={_='documentAttributeImageSize', w=int, h=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/documentAttributeSticker.md b/old_docs/API_docs_v109/constructors/documentAttributeSticker.md new file mode 100644 index 00000000..a556b961 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/documentAttributeSticker.md @@ -0,0 +1,41 @@ +--- +title: documentAttributeSticker +description: Defines a sticker +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeSticker +[Back to constructors index](index.md) + + + +Defines a sticker + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|mask|[Bool](../types/Bool.md) | Optional|Whether this is a mask sticker| +|alt|[string](../types/string.md) | Yes|Alternative emoji representation of sticker| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|Associated stickerset| +|mask\_coords|[MaskCoords](../types/MaskCoords.md) | Optional|Mask coordinates (if this is a mask sticker, attached to a photo)| + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +```php +$documentAttributeSticker = ['_' => 'documentAttributeSticker', 'mask' => Bool, 'alt' => 'string', 'stickerset' => InputStickerSet, 'mask_coords' => MaskCoords]; +``` + + +Or, if you're into Lua: + +```lua +documentAttributeSticker={_='documentAttributeSticker', mask=Bool, alt='string', stickerset=InputStickerSet, mask_coords=MaskCoords} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/documentAttributeVideo.md b/old_docs/API_docs_v109/constructors/documentAttributeVideo.md new file mode 100644 index 00000000..c829c191 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/documentAttributeVideo.md @@ -0,0 +1,42 @@ +--- +title: documentAttributeVideo +description: Defines a video +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentAttributeVideo +[Back to constructors index](index.md) + + + +Defines a video + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|round\_message|[Bool](../types/Bool.md) | Optional|Whether this is a round video| +|supports\_streaming|[Bool](../types/Bool.md) | Optional|Whether the video supports streaming| +|duration|[int](../types/int.md) | Optional|Duration in seconds| +|w|[int](../types/int.md) | Optional|Video width| +|h|[int](../types/int.md) | Optional|Video height| + + + +### Type: [DocumentAttribute](../types/DocumentAttribute.md) + + +### Example: + +```php +$documentAttributeVideo = ['_' => 'documentAttributeVideo', 'round_message' => Bool, 'supports_streaming' => Bool, 'duration' => int, 'w' => int, 'h' => int]; +``` + + +Or, if you're into Lua: + +```lua +documentAttributeVideo={_='documentAttributeVideo', round_message=Bool, supports_streaming=Bool, duration=int, w=int, h=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/documentEmpty.md b/old_docs/API_docs_v109/constructors/documentEmpty.md new file mode 100644 index 00000000..f0194983 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/documentEmpty.md @@ -0,0 +1,38 @@ +--- +title: documentEmpty +description: Empty constructor, document doesn't exist. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: documentEmpty +[Back to constructors index](index.md) + + + +Empty constructor, document doesn't exist. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Document ID or `0`| + + + +### Type: [Document](../types/Document.md) + + +### Example: + +```php +$documentEmpty = ['_' => 'documentEmpty', 'id' => long]; +``` + + +Or, if you're into Lua: + +```lua +documentEmpty={_='documentEmpty', id=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/draftMessage.md b/old_docs/API_docs_v109/constructors/draftMessage.md new file mode 100644 index 00000000..26cf93c6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/draftMessage.md @@ -0,0 +1,42 @@ +--- +title: draftMessage +description: Represents a message [draft](https://core.telegram.org/api/drafts). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: draftMessage +[Back to constructors index](index.md) + + + +Represents a message [draft](https://core.telegram.org/api/drafts). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Whether no webpage preview will be generated| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|The message this message will reply to| +|message|[string](../types/string.md) | Yes|The draft| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| +|date|[int](../types/int.md) | Yes|Date of last update of the draft.| + + + +### Type: [DraftMessage](../types/DraftMessage.md) + + +### Example: + +```php +$draftMessage = ['_' => 'draftMessage', 'no_webpage' => Bool, 'reply_to_msg_id' => int, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +draftMessage={_='draftMessage', no_webpage=Bool, reply_to_msg_id=int, message='string', entities={MessageEntity}, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/draftMessageEmpty.md b/old_docs/API_docs_v109/constructors/draftMessageEmpty.md new file mode 100644 index 00000000..e56048e4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/draftMessageEmpty.md @@ -0,0 +1,38 @@ +--- +title: draftMessageEmpty +description: Empty draft +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: draftMessageEmpty +[Back to constructors index](index.md) + + + +Empty draft + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|date|[int](../types/int.md) | Optional|When was the draft last updated| + + + +### Type: [DraftMessage](../types/DraftMessage.md) + + +### Example: + +```php +$draftMessageEmpty = ['_' => 'draftMessageEmpty', 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +draftMessageEmpty={_='draftMessageEmpty', date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/emojiKeyword.md b/old_docs/API_docs_v109/constructors/emojiKeyword.md new file mode 100644 index 00000000..c5335298 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/emojiKeyword.md @@ -0,0 +1,39 @@ +--- +title: emojiKeyword +description: Emoji keyword +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: emojiKeyword +[Back to constructors index](index.md) + + + +Emoji keyword + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|keyword|[string](../types/string.md) | Yes|Keyword| +|emoticons|Array of [string](../types/string.md) | Yes|Emoticons| + + + +### Type: [EmojiKeyword](../types/EmojiKeyword.md) + + +### Example: + +```php +$emojiKeyword = ['_' => 'emojiKeyword', 'keyword' => 'string', 'emoticons' => ['string', 'string']]; +``` + + +Or, if you're into Lua: + +```lua +emojiKeyword={_='emojiKeyword', keyword='string', emoticons={'string'}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/emojiKeywordDeleted.md b/old_docs/API_docs_v109/constructors/emojiKeywordDeleted.md new file mode 100644 index 00000000..2d97ff6f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/emojiKeywordDeleted.md @@ -0,0 +1,39 @@ +--- +title: emojiKeywordDeleted +description: Deleted emoji keyword +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: emojiKeywordDeleted +[Back to constructors index](index.md) + + + +Deleted emoji keyword + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|keyword|[string](../types/string.md) | Yes|Keyword| +|emoticons|Array of [string](../types/string.md) | Yes|Emoticons| + + + +### Type: [EmojiKeyword](../types/EmojiKeyword.md) + + +### Example: + +```php +$emojiKeywordDeleted = ['_' => 'emojiKeywordDeleted', 'keyword' => 'string', 'emoticons' => ['string', 'string']]; +``` + + +Or, if you're into Lua: + +```lua +emojiKeywordDeleted={_='emojiKeywordDeleted', keyword='string', emoticons={'string'}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/emojiKeywordsDifference.md b/old_docs/API_docs_v109/constructors/emojiKeywordsDifference.md new file mode 100644 index 00000000..5d6e2e3a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/emojiKeywordsDifference.md @@ -0,0 +1,41 @@ +--- +title: emojiKeywordsDifference +description: Changes to emoji keywords +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: emojiKeywordsDifference +[Back to constructors index](index.md) + + + +Changes to emoji keywords + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[string](../types/string.md) | Yes|Language code for keywords| +|from\_version|[int](../types/int.md) | Yes|Previous emoji keyword list version| +|version|[int](../types/int.md) | Yes|Current version of emoji keyword list| +|keywords|Array of [EmojiKeyword](../types/EmojiKeyword.md) | Yes|Keywords| + + + +### Type: [EmojiKeywordsDifference](../types/EmojiKeywordsDifference.md) + + +### Example: + +```php +$emojiKeywordsDifference = ['_' => 'emojiKeywordsDifference', 'lang_code' => 'string', 'from_version' => int, 'version' => int, 'keywords' => [EmojiKeyword, EmojiKeyword]]; +``` + + +Or, if you're into Lua: + +```lua +emojiKeywordsDifference={_='emojiKeywordsDifference', lang_code='string', from_version=int, version=int, keywords={EmojiKeyword}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/emojiLanguage.md b/old_docs/API_docs_v109/constructors/emojiLanguage.md new file mode 100644 index 00000000..f7cc4ddf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/emojiLanguage.md @@ -0,0 +1,38 @@ +--- +title: emojiLanguage +description: Emoji language +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: emojiLanguage +[Back to constructors index](index.md) + + + +Emoji language + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[string](../types/string.md) | Yes|Language code| + + + +### Type: [EmojiLanguage](../types/EmojiLanguage.md) + + +### Example: + +```php +$emojiLanguage = ['_' => 'emojiLanguage', 'lang_code' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +emojiLanguage={_='emojiLanguage', lang_code='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/emojiURL.md b/old_docs/API_docs_v109/constructors/emojiURL.md new file mode 100644 index 00000000..e4b11c6c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/emojiURL.md @@ -0,0 +1,38 @@ +--- +title: emojiURL +description: An HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: emojiURL +[Back to constructors index](index.md) + + + +An HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|An HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation| + + + +### Type: [EmojiURL](../types/EmojiURL.md) + + +### Example: + +```php +$emojiURL = ['_' => 'emojiURL', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +emojiURL={_='emojiURL', url='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/encryptedChat.md b/old_docs/API_docs_v109/constructors/encryptedChat.md new file mode 100644 index 00000000..10ff4ffa --- /dev/null +++ b/old_docs/API_docs_v109/constructors/encryptedChat.md @@ -0,0 +1,44 @@ +--- +title: encryptedChat +description: Encrypted chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedChat +[Back to constructors index](index.md) + + + +Encrypted chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Chat ID| +|access\_hash|[long](../types/long.md) | Yes|Check sum dependant on the user ID| +|date|[int](../types/int.md) | Yes|Date chat was created| +|admin\_id|[int](../types/int.md) | Yes|Chat creator ID| +|participant\_id|[int](../types/int.md) | Yes|ID of the second chat participant| +|g\_a\_or\_b|[bytes](../types/bytes.md) | Yes|`B = g ^ b mod p`, if the currently authorized user is the chat's creator,
or `A = g ^ a mod p` otherwise
See [Wikipedia](https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange) for more info| +|key\_fingerprint|[long](../types/long.md) | Yes|64-bit fingerprint of received key| + + + +### Type: [EncryptedChat](../types/EncryptedChat.md) + + +### Example: + +```php +$encryptedChat = ['_' => 'encryptedChat', 'id' => int, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a_or_b' => 'bytes', 'key_fingerprint' => long]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/encryptedChatDiscarded.md b/old_docs/API_docs_v109/constructors/encryptedChatDiscarded.md new file mode 100644 index 00000000..f37386fe --- /dev/null +++ b/old_docs/API_docs_v109/constructors/encryptedChatDiscarded.md @@ -0,0 +1,38 @@ +--- +title: encryptedChatDiscarded +description: Discarded or deleted chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedChatDiscarded +[Back to constructors index](index.md) + + + +Discarded or deleted chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Chat ID| + + + +### Type: [EncryptedChat](../types/EncryptedChat.md) + + +### Example: + +```php +$encryptedChatDiscarded = ['_' => 'encryptedChatDiscarded', 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +encryptedChatDiscarded={_='encryptedChatDiscarded', id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/encryptedChatEmpty.md b/old_docs/API_docs_v109/constructors/encryptedChatEmpty.md new file mode 100644 index 00000000..d26dd846 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/encryptedChatEmpty.md @@ -0,0 +1,38 @@ +--- +title: encryptedChatEmpty +description: Empty constructor. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedChatEmpty +[Back to constructors index](index.md) + + + +Empty constructor. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Chat ID| + + + +### Type: [EncryptedChat](../types/EncryptedChat.md) + + +### Example: + +```php +$encryptedChatEmpty = ['_' => 'encryptedChatEmpty', 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +encryptedChatEmpty={_='encryptedChatEmpty', id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/encryptedChatRequested.md b/old_docs/API_docs_v109/constructors/encryptedChatRequested.md new file mode 100644 index 00000000..99809e9b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/encryptedChatRequested.md @@ -0,0 +1,43 @@ +--- +title: encryptedChatRequested +description: Request to create an encrypted chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedChatRequested +[Back to constructors index](index.md) + + + +Request to create an encrypted chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Chat ID| +|access\_hash|[long](../types/long.md) | Yes|Check sum depending on user ID| +|date|[int](../types/int.md) | Yes|Chat creation date| +|admin\_id|[int](../types/int.md) | Yes|Chat creator ID| +|participant\_id|[int](../types/int.md) | Yes|ID of second chat participant| +|g\_a|[bytes](../types/bytes.md) | Yes|`A = g ^ a mod p`, see [Wikipedia](https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange)| + + + +### Type: [EncryptedChat](../types/EncryptedChat.md) + + +### Example: + +```php +$encryptedChatRequested = ['_' => 'encryptedChatRequested', 'id' => int, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a' => 'bytes']; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/encryptedChatWaiting.md b/old_docs/API_docs_v109/constructors/encryptedChatWaiting.md new file mode 100644 index 00000000..9e9f6cca --- /dev/null +++ b/old_docs/API_docs_v109/constructors/encryptedChatWaiting.md @@ -0,0 +1,42 @@ +--- +title: encryptedChatWaiting +description: Chat waiting for approval of second participant. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedChatWaiting +[Back to constructors index](index.md) + + + +Chat waiting for approval of second participant. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Chat ID| +|access\_hash|[long](../types/long.md) | Yes|Checking sum depending on user ID| +|date|[int](../types/int.md) | Yes|Date of chat creation| +|admin\_id|[int](../types/int.md) | Yes|Chat creator ID| +|participant\_id|[int](../types/int.md) | Yes|ID of second chat participant| + + + +### Type: [EncryptedChat](../types/EncryptedChat.md) + + +### Example: + +```php +$encryptedChatWaiting = ['_' => 'encryptedChatWaiting', 'id' => int, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +encryptedChatWaiting={_='encryptedChatWaiting', id=int, access_hash=long, date=int, admin_id=int, participant_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/encryptedFile.md b/old_docs/API_docs_v109/constructors/encryptedFile.md new file mode 100644 index 00000000..ee7b33ef --- /dev/null +++ b/old_docs/API_docs_v109/constructors/encryptedFile.md @@ -0,0 +1,42 @@ +--- +title: encryptedFile +description: Encrypted file. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedFile +[Back to constructors index](index.md) + + + +Encrypted file. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|File ID| +|access\_hash|[long](../types/long.md) | Yes|Checking sum depending on user ID| +|size|[int](../types/int.md) | Yes|File size in bytes| +|dc\_id|[int](../types/int.md) | Yes|Number of data centre| +|key\_fingerprint|[int](../types/int.md) | Yes|32-bit fingerprint of key used for file encryption| + + + +### Type: [EncryptedFile](../types/EncryptedFile.md) + + +### Example: + +```php +$encryptedFile = ['_' => 'encryptedFile', 'id' => long, 'access_hash' => long, 'size' => int, 'dc_id' => int, 'key_fingerprint' => int]; +``` + + +Or, if you're into Lua: + +```lua +encryptedFile={_='encryptedFile', id=long, access_hash=long, size=int, dc_id=int, key_fingerprint=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/encryptedFileEmpty.md b/old_docs/API_docs_v109/constructors/encryptedFileEmpty.md new file mode 100644 index 00000000..7b95e5fb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/encryptedFileEmpty.md @@ -0,0 +1,33 @@ +--- +title: encryptedFileEmpty +description: Empty constructor, unexisitng file. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedFileEmpty +[Back to constructors index](index.md) + + + +Empty constructor, unexisitng file. + + + + +### Type: [EncryptedFile](../types/EncryptedFile.md) + + +### Example: + +```php +$encryptedFileEmpty = ['_' => 'encryptedFileEmpty']; +``` + + +Or, if you're into Lua: + +```lua +encryptedFileEmpty={_='encryptedFileEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/encryptedMessage.md b/old_docs/API_docs_v109/constructors/encryptedMessage.md new file mode 100644 index 00000000..42397df3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/encryptedMessage.md @@ -0,0 +1,41 @@ +--- +title: encryptedMessage +description: Encrypted message. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedMessage +[Back to constructors index](index.md) + + + +Encrypted message. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|ID of encrypted chat| +|date|[int](../types/int.md) | Yes|Date of sending| +|decrypted\_message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|Decrypted message| +|file|[EncryptedFile](../types/EncryptedFile.md) | Optional|Attached encrypted file| + + + +### Type: [EncryptedMessage](../types/EncryptedMessage.md) + + +### Example: + +```php +$encryptedMessage = ['_' => 'encryptedMessage', 'chat_id' => int, 'date' => int, 'decrypted_message' => DecryptedMessage, 'file' => EncryptedFile]; +``` + + +Or, if you're into Lua: + +```lua +encryptedMessage={_='encryptedMessage', chat_id=int, date=int, decrypted_message=DecryptedMessage, file=EncryptedFile} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/encryptedMessageService.md b/old_docs/API_docs_v109/constructors/encryptedMessageService.md new file mode 100644 index 00000000..1ce100a5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/encryptedMessageService.md @@ -0,0 +1,40 @@ +--- +title: encryptedMessageService +description: Encrypted service message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: encryptedMessageService +[Back to constructors index](index.md) + + + +Encrypted service message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|ID of encrypted chat| +|date|[int](../types/int.md) | Yes|Date of sending| +|decrypted\_message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|Decrypted message| + + + +### Type: [EncryptedMessage](../types/EncryptedMessage.md) + + +### Example: + +```php +$encryptedMessageService = ['_' => 'encryptedMessageService', 'chat_id' => int, 'date' => int, 'decrypted_message' => DecryptedMessage]; +``` + + +Or, if you're into Lua: + +```lua +encryptedMessageService={_='encryptedMessageService', chat_id=int, date=int, decrypted_message=DecryptedMessage} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/error.md b/old_docs/API_docs_v109/constructors/error.md new file mode 100644 index 00000000..5f0daf90 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/error.md @@ -0,0 +1,39 @@ +--- +title: error +description: Error. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: error +[Back to constructors index](index.md) + + + +Error. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|code|[int](../types/int.md) | Yes|Error code| +|text|[string](../types/string.md) | Yes|Message| + + + +### Type: [Error](../types/Error.md) + + +### Example: + +```php +$error = ['_' => 'error', 'code' => int, 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +error={_='error', code=int, text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/exportedMessageLink.md b/old_docs/API_docs_v109/constructors/exportedMessageLink.md new file mode 100644 index 00000000..ec35c657 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/exportedMessageLink.md @@ -0,0 +1,39 @@ +--- +title: exportedMessageLink +description: Link to a message in a supergroup/channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: exportedMessageLink +[Back to constructors index](index.md) + + + +Link to a message in a supergroup/channel + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|link|[string](../types/string.md) | Yes|URL| +|html|[string](../types/string.md) | Yes|Embed code| + + + +### Type: [ExportedMessageLink](../types/ExportedMessageLink.md) + + +### Example: + +```php +$exportedMessageLink = ['_' => 'exportedMessageLink', 'link' => 'string', 'html' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +exportedMessageLink={_='exportedMessageLink', link='string', html='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/fileHash.md b/old_docs/API_docs_v109/constructors/fileHash.md new file mode 100644 index 00000000..ab9e46e8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/fileHash.md @@ -0,0 +1,40 @@ +--- +title: fileHash +description: SHA256 Hash of an uploaded file, to be checked for validity after download +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: fileHash +[Back to constructors index](index.md) + + + +SHA256 Hash of an uploaded file, to be checked for validity after download + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset from where to start computing SHA-256 hash| +|limit|[int](../types/int.md) | Yes|Length| +|hash|[bytes](../types/bytes.md) | Yes|SHA-256 Hash of file chunk, to be checked for validity after download| + + + +### Type: [FileHash](../types/FileHash.md) + + +### Example: + +```php +$fileHash = ['_' => 'fileHash', 'offset' => int, 'limit' => int, 'hash' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +fileHash={_='fileHash', offset=int, limit=int, hash='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/fileLocationToBeDeprecated.md b/old_docs/API_docs_v109/constructors/fileLocationToBeDeprecated.md new file mode 100644 index 00000000..715304b3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/fileLocationToBeDeprecated.md @@ -0,0 +1,39 @@ +--- +title: fileLocationToBeDeprecated +description: Indicates the location of a photo, will be deprecated soon +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: fileLocationToBeDeprecated +[Back to constructors index](index.md) + + + +Indicates the location of a photo, will be deprecated soon + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|volume\_id|[long](../types/long.md) | Yes|Volume ID| +|local\_id|[int](../types/int.md) | Yes|Local ID| + + + +### Type: [FileLocation](../types/FileLocation.md) + + +### Example: + +```php +$fileLocationToBeDeprecated = ['_' => 'fileLocationToBeDeprecated', 'volume_id' => long, 'local_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +fileLocationToBeDeprecated={_='fileLocationToBeDeprecated', volume_id=long, local_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/folder.md b/old_docs/API_docs_v109/constructors/folder.md new file mode 100644 index 00000000..669096a8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/folder.md @@ -0,0 +1,43 @@ +--- +title: folder +description: Folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: folder +[Back to constructors index](index.md) + + + +Folder + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|autofill\_new\_broadcasts|[Bool](../types/Bool.md) | Optional|Automatically add new channels to this folder| +|autofill\_public\_groups|[Bool](../types/Bool.md) | Optional|Automatically add joined new public supergroups to this folder| +|autofill\_new\_correspondents|[Bool](../types/Bool.md) | Optional|Automatically add new private chats to this folder| +|id|[int](../types/int.md) | Yes|Folder ID| +|title|[string](../types/string.md) | Yes|Folder title| +|photo|[ChatPhoto](../types/ChatPhoto.md) | Optional|Folder picture| + + + +### Type: [Folder](../types/Folder.md) + + +### Example: + +```php +$folder = ['_' => 'folder', 'autofill_new_broadcasts' => Bool, 'autofill_public_groups' => Bool, 'autofill_new_correspondents' => Bool, 'id' => int, 'title' => 'string', 'photo' => ChatPhoto]; +``` + + +Or, if you're into Lua: + +```lua +folder={_='folder', autofill_new_broadcasts=Bool, autofill_public_groups=Bool, autofill_new_correspondents=Bool, id=int, title='string', photo=ChatPhoto} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/folderPeer.md b/old_docs/API_docs_v109/constructors/folderPeer.md new file mode 100644 index 00000000..594c9478 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/folderPeer.md @@ -0,0 +1,39 @@ +--- +title: folderPeer +description: Peer in a folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: folderPeer +[Back to constructors index](index.md) + + + +Peer in a folder + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|Folder peer info| +|folder\_id|[int](../types/int.md) | Yes|Folder ID| + + + +### Type: [FolderPeer](../types/FolderPeer.md) + + +### Example: + +```php +$folderPeer = ['_' => 'folderPeer', 'peer' => Peer, 'folder_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +folderPeer={_='folderPeer', peer=Peer, folder_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/foundGif.md b/old_docs/API_docs_v109/constructors/foundGif.md new file mode 100644 index 00000000..8096dedc --- /dev/null +++ b/old_docs/API_docs_v109/constructors/foundGif.md @@ -0,0 +1,43 @@ +--- +title: foundGif +description: Found GIF +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: foundGif +[Back to constructors index](index.md) + + + +Found GIF + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|GIF URL| +|thumb\_url|[string](../types/string.md) | Yes|Thumbnail URL| +|content\_url|[string](../types/string.md) | Yes|Actual URL of the content to send| +|content\_type|[string](../types/string.md) | Yes|Content-type of media| +|w|[int](../types/int.md) | Yes|Width of GIF| +|h|[int](../types/int.md) | Yes|Height of GIF| + + + +### Type: [FoundGif](../types/FoundGif.md) + + +### Example: + +```php +$foundGif = ['_' => 'foundGif', 'url' => 'string', 'thumb_url' => 'string', 'content_url' => 'string', 'content_type' => 'string', 'w' => int, 'h' => int]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/foundGifCached.md b/old_docs/API_docs_v109/constructors/foundGifCached.md new file mode 100644 index 00000000..80f6329e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/foundGifCached.md @@ -0,0 +1,40 @@ +--- +title: foundGifCached +description: Found cached results +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: foundGifCached +[Back to constructors index](index.md) + + + +Found cached results + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|GIF URL| +|photo|[Photo](../types/Photo.md) | Optional|Thumbnail| +|document|[Document](../types/Document.md) | Optional|Actual GIF document to send| + + + +### Type: [FoundGif](../types/FoundGif.md) + + +### Example: + +```php +$foundGifCached = ['_' => 'foundGifCached', 'url' => 'string', 'photo' => Photo, 'document' => Document]; +``` + + +Or, if you're into Lua: + +```lua +foundGifCached={_='foundGifCached', url='string', photo=Photo, document=Document} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/game.md b/old_docs/API_docs_v109/constructors/game.md new file mode 100644 index 00000000..812c2707 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/game.md @@ -0,0 +1,44 @@ +--- +title: game +description: Indicates an already sent game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: game +[Back to constructors index](index.md) + + + +Indicates an already sent game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|ID of the game| +|access\_hash|[long](../types/long.md) | Yes|Access hash of the game| +|short\_name|[string](../types/string.md) | Yes|Short name for the game| +|title|[string](../types/string.md) | Yes|Title of the game| +|description|[string](../types/string.md) | Yes|Game description| +|photo|[Photo](../types/Photo.md) | Optional|Game preview| +|document|[Document](../types/Document.md) | Optional|Optional attached document| + + + +### Type: [Game](../types/Game.md) + + +### Example: + +```php +$game = ['_' => 'game', 'id' => long, 'access_hash' => long, 'short_name' => 'string', 'title' => 'string', 'description' => 'string', 'photo' => Photo, 'document' => Document]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/geoPoint.md b/old_docs/API_docs_v109/constructors/geoPoint.md new file mode 100644 index 00000000..98db4e1a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/geoPoint.md @@ -0,0 +1,40 @@ +--- +title: geoPoint +description: GeoPoint. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: geoPoint +[Back to constructors index](index.md) + + + +GeoPoint. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|long|[double](../types/double.md) | Yes|Longtitude| +|lat|[double](../types/double.md) | Yes|Latitude| +|access\_hash|[long](../types/long.md) | Yes|Access hash| + + + +### Type: [GeoPoint](../types/GeoPoint.md) + + +### Example: + +```php +$geoPoint = ['_' => 'geoPoint', 'long' => double, 'lat' => double, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +geoPoint={_='geoPoint', long=double, lat=double, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/geoPointEmpty.md b/old_docs/API_docs_v109/constructors/geoPointEmpty.md new file mode 100644 index 00000000..d5f96ae8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/geoPointEmpty.md @@ -0,0 +1,33 @@ +--- +title: geoPointEmpty +description: Empty constructor. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: geoPointEmpty +[Back to constructors index](index.md) + + + +Empty constructor. + + + + +### Type: [GeoPoint](../types/GeoPoint.md) + + +### Example: + +```php +$geoPointEmpty = ['_' => 'geoPointEmpty']; +``` + + +Or, if you're into Lua: + +```lua +geoPointEmpty={_='geoPointEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.appUpdate.md b/old_docs/API_docs_v109/constructors/help.appUpdate.md new file mode 100644 index 00000000..999cb9b8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.appUpdate.md @@ -0,0 +1,45 @@ +--- +title: help.appUpdate +description: An update is available for the application. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_appUpdate.html +--- +# Constructor: help.appUpdate +[Back to constructors index](index.md) + + + +An update is available for the application. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|can\_not\_skip|[Bool](../types/Bool.md) | Optional|Unskippable, the new info must be shown to the user (with a popup or something else)| +|id|[int](../types/int.md) | Yes|Update ID| +|version|[string](../types/string.md) | Yes|New version name| +|text|[string](../types/string.md) | Yes|Text description of the update| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|Entities| +|document|[Document](../types/Document.md) | Optional|Attached document| +|url|[string](../types/string.md) | Optional|Application download URL| + + + +### Type: [help.AppUpdate](../types/help.AppUpdate.md) + + +### Example: + +```php +$help.appUpdate = ['_' => 'help.appUpdate', 'can_not_skip' => Bool, 'id' => int, 'version' => 'string', 'text' => 'string', 'entities' => [MessageEntity, MessageEntity], 'document' => Document, 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +help.appUpdate={_='help.appUpdate', can_not_skip=Bool, id=int, version='string', text='string', entities={MessageEntity}, document=Document, url='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.deepLinkInfo.md b/old_docs/API_docs_v109/constructors/help.deepLinkInfo.md new file mode 100644 index 00000000..9276bdd4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.deepLinkInfo.md @@ -0,0 +1,41 @@ +--- +title: help.deepLinkInfo +description: Deep linking info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_deepLinkInfo.html +--- +# Constructor: help.deepLinkInfo +[Back to constructors index](index.md) + + + +Deep linking info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|update\_app|[Bool](../types/Bool.md) | Optional|An update of the app is required to parse this link| +|message|[string](../types/string.md) | Yes|Message to show to the user| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| + + + +### Type: [help.DeepLinkInfo](../types/help.DeepLinkInfo.md) + + +### Example: + +```php +$help.deepLinkInfo = ['_' => 'help.deepLinkInfo', 'update_app' => Bool, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]]; +``` + + +Or, if you're into Lua: + +```lua +help.deepLinkInfo={_='help.deepLinkInfo', update_app=Bool, message='string', entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.deepLinkInfoEmpty.md b/old_docs/API_docs_v109/constructors/help.deepLinkInfoEmpty.md new file mode 100644 index 00000000..016b846a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.deepLinkInfoEmpty.md @@ -0,0 +1,34 @@ +--- +title: help.deepLinkInfoEmpty +description: Deep link info empty +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_deepLinkInfoEmpty.html +--- +# Constructor: help.deepLinkInfoEmpty +[Back to constructors index](index.md) + + + +Deep link info empty + + + + +### Type: [help.DeepLinkInfo](../types/help.DeepLinkInfo.md) + + +### Example: + +```php +$help.deepLinkInfoEmpty = ['_' => 'help.deepLinkInfoEmpty']; +``` + + +Or, if you're into Lua: + +```lua +help.deepLinkInfoEmpty={_='help.deepLinkInfoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.inviteText.md b/old_docs/API_docs_v109/constructors/help.inviteText.md new file mode 100644 index 00000000..4e220483 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.inviteText.md @@ -0,0 +1,39 @@ +--- +title: help.inviteText +description: Text of a text message with an invitation to install application. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_inviteText.html +--- +# Constructor: help.inviteText +[Back to constructors index](index.md) + + + +Text of a text message with an invitation to install application. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[string](../types/string.md) | Yes|Text of a message| + + + +### Type: [help.InviteText](../types/help.InviteText.md) + + +### Example: + +```php +$help.inviteText = ['_' => 'help.inviteText', 'message' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +help.inviteText={_='help.inviteText', message='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.noAppUpdate.md b/old_docs/API_docs_v109/constructors/help.noAppUpdate.md new file mode 100644 index 00000000..7356918e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.noAppUpdate.md @@ -0,0 +1,34 @@ +--- +title: help.noAppUpdate +description: No updates are available for the application. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_noAppUpdate.html +--- +# Constructor: help.noAppUpdate +[Back to constructors index](index.md) + + + +No updates are available for the application. + + + + +### Type: [help.AppUpdate](../types/help.AppUpdate.md) + + +### Example: + +```php +$help.noAppUpdate = ['_' => 'help.noAppUpdate']; +``` + + +Or, if you're into Lua: + +```lua +help.noAppUpdate={_='help.noAppUpdate'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.passportConfig.md b/old_docs/API_docs_v109/constructors/help.passportConfig.md new file mode 100644 index 00000000..e98c5406 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.passportConfig.md @@ -0,0 +1,40 @@ +--- +title: help.passportConfig +description: Telegram [passport](https://core.telegram.org/passport) configuration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_passportConfig.html +--- +# Constructor: help.passportConfig +[Back to constructors index](index.md) + + + +Telegram [passport](https://core.telegram.org/passport) configuration + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| +|countries\_langs|[DataJSON](../types/DataJSON.md) | Yes|Localization| + + + +### Type: [help.PassportConfig](../types/help.PassportConfig.md) + + +### Example: + +```php +$help.passportConfig = ['_' => 'help.passportConfig', 'hash' => int, 'countries_langs' => DataJSON]; +``` + + +Or, if you're into Lua: + +```lua +help.passportConfig={_='help.passportConfig', hash=int, countries_langs=DataJSON} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.passportConfigNotModified.md b/old_docs/API_docs_v109/constructors/help.passportConfigNotModified.md new file mode 100644 index 00000000..f84475c7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.passportConfigNotModified.md @@ -0,0 +1,34 @@ +--- +title: help.passportConfigNotModified +description: Password configuration not modified +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_passportConfigNotModified.html +--- +# Constructor: help.passportConfigNotModified +[Back to constructors index](index.md) + + + +Password configuration not modified + + + + +### Type: [help.PassportConfig](../types/help.PassportConfig.md) + + +### Example: + +```php +$help.passportConfigNotModified = ['_' => 'help.passportConfigNotModified']; +``` + + +Or, if you're into Lua: + +```lua +help.passportConfigNotModified={_='help.passportConfigNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.proxyDataEmpty.md b/old_docs/API_docs_v109/constructors/help.proxyDataEmpty.md new file mode 100644 index 00000000..bcbb9619 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.proxyDataEmpty.md @@ -0,0 +1,39 @@ +--- +title: help.proxyDataEmpty +description: No proxy was used to connect to tg (or none was provided to [initConnection](../methods/initConnection.md), or the used proxy doesn't have a promotion channel associated to it) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_proxyDataEmpty.html +--- +# Constructor: help.proxyDataEmpty +[Back to constructors index](index.md) + + + +No proxy was used to connect to tg (or none was provided to [initConnection](../methods/initConnection.md), or the used proxy doesn't have a promotion channel associated to it) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|expires|[int](../types/int.md) | Yes|Expiration date of proxy info, will have to be refetched in `expires` seconds| + + + +### Type: [help.ProxyData](../types/help.ProxyData.md) + + +### Example: + +```php +$help.proxyDataEmpty = ['_' => 'help.proxyDataEmpty', 'expires' => int]; +``` + + +Or, if you're into Lua: + +```lua +help.proxyDataEmpty={_='help.proxyDataEmpty', expires=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.proxyDataPromo.md b/old_docs/API_docs_v109/constructors/help.proxyDataPromo.md new file mode 100644 index 00000000..151dd944 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.proxyDataPromo.md @@ -0,0 +1,42 @@ +--- +title: help.proxyDataPromo +description: Promotion channel associated to a certain MTProxy +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_proxyDataPromo.html +--- +# Constructor: help.proxyDataPromo +[Back to constructors index](index.md) + + + +Promotion channel associated to a certain MTProxy + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|expires|[int](../types/int.md) | Yes|Expiration date of proxy info, will have to be refetched in `expires` seconds| +|peer|[Peer](../types/Peer.md) | Yes|The promoted channel| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [help.ProxyData](../types/help.ProxyData.md) + + +### Example: + +```php +$help.proxyDataPromo = ['_' => 'help.proxyDataPromo', 'expires' => int, 'peer' => Peer, 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +help.proxyDataPromo={_='help.proxyDataPromo', expires=int, peer=Peer, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.recentMeUrls.md b/old_docs/API_docs_v109/constructors/help.recentMeUrls.md new file mode 100644 index 00000000..ed957ccd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.recentMeUrls.md @@ -0,0 +1,41 @@ +--- +title: help.recentMeUrls +description: Recent t.me URLs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_recentMeUrls.html +--- +# Constructor: help.recentMeUrls +[Back to constructors index](index.md) + + + +Recent t.me URLs + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|urls|Array of [RecentMeUrl](../types/RecentMeUrl.md) | Yes|URLs| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [help.RecentMeUrls](../types/help.RecentMeUrls.md) + + +### Example: + +```php +$help.recentMeUrls = ['_' => 'help.recentMeUrls', 'urls' => [RecentMeUrl, RecentMeUrl], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +help.recentMeUrls={_='help.recentMeUrls', urls={RecentMeUrl}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.support.md b/old_docs/API_docs_v109/constructors/help.support.md new file mode 100644 index 00000000..16e5ce15 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.support.md @@ -0,0 +1,40 @@ +--- +title: help.support +description: Info on support user. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_support.html +--- +# Constructor: help.support +[Back to constructors index](index.md) + + + +Info on support user. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|user|[User](../types/User.md) | Optional|User| + + + +### Type: [help.Support](../types/help.Support.md) + + +### Example: + +```php +$help.support = ['_' => 'help.support', 'phone_number' => 'string', 'user' => User]; +``` + + +Or, if you're into Lua: + +```lua +help.support={_='help.support', phone_number='string', user=User} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.supportName.md b/old_docs/API_docs_v109/constructors/help.supportName.md new file mode 100644 index 00000000..a7b2f698 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.supportName.md @@ -0,0 +1,39 @@ +--- +title: help.supportName +description: Localized name for telegram support +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_supportName.html +--- +# Constructor: help.supportName +[Back to constructors index](index.md) + + + +Localized name for telegram support + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|name|[string](../types/string.md) | Yes|Localized name| + + + +### Type: [help.SupportName](../types/help.SupportName.md) + + +### Example: + +```php +$help.supportName = ['_' => 'help.supportName', 'name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +help.supportName={_='help.supportName', name='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.termsOfService.md b/old_docs/API_docs_v109/constructors/help.termsOfService.md new file mode 100644 index 00000000..911d1d0c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.termsOfService.md @@ -0,0 +1,43 @@ +--- +title: help.termsOfService +description: Info about the latest telegram Terms Of Service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_termsOfService.html +--- +# Constructor: help.termsOfService +[Back to constructors index](index.md) + + + +Info about the latest telegram Terms Of Service + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|popup|[Bool](../types/Bool.md) | Optional|Whether a prompt must be showed to the user, in order to accept the new terms.| +|id|[DataJSON](../types/DataJSON.md) | Yes|ID of the new terms| +|text|[string](../types/string.md) | Yes|Text of the new terms| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|Entities| +|min\_age\_confirm|[int](../types/int.md) | Optional|Minimum age required to sign up to telegram, the user must confirm that they is older than the minimum age.| + + + +### Type: [help.TermsOfService](../types/help.TermsOfService.md) + + +### Example: + +```php +$help.termsOfService = ['_' => 'help.termsOfService', 'popup' => Bool, 'id' => DataJSON, 'text' => 'string', 'entities' => [MessageEntity, MessageEntity], 'min_age_confirm' => int]; +``` + + +Or, if you're into Lua: + +```lua +help.termsOfService={_='help.termsOfService', popup=Bool, id=DataJSON, text='string', entities={MessageEntity}, min_age_confirm=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.termsOfServiceUpdate.md b/old_docs/API_docs_v109/constructors/help.termsOfServiceUpdate.md new file mode 100644 index 00000000..5daa8776 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.termsOfServiceUpdate.md @@ -0,0 +1,40 @@ +--- +title: help.termsOfServiceUpdate +description: Info about an update of telegram's terms of service. If the terms of service are declined, then the [account.deleteAccount](../methods/account.deleteAccount.md) method should be called with the reason "Decline ToS update" +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_termsOfServiceUpdate.html +--- +# Constructor: help.termsOfServiceUpdate +[Back to constructors index](index.md) + + + +Info about an update of telegram's terms of service. If the terms of service are declined, then the [account.deleteAccount](../methods/account.deleteAccount.md) method should be called with the reason "Decline ToS update" + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|expires|[int](../types/int.md) | Yes|New TOS updates will have to be queried using [help.getTermsOfServiceUpdate](../methods/help.getTermsOfServiceUpdate.md) in `expires` seconds| +|terms\_of\_service|[help.TermsOfService](../constructors/help.TermsOfService.md) | Yes|New terms of service| + + + +### Type: [help.TermsOfServiceUpdate](../types/help.TermsOfServiceUpdate.md) + + +### Example: + +```php +$help.termsOfServiceUpdate = ['_' => 'help.termsOfServiceUpdate', 'expires' => int, 'terms_of_service' => help.TermsOfService]; +``` + + +Or, if you're into Lua: + +```lua +help.termsOfServiceUpdate={_='help.termsOfServiceUpdate', expires=int, terms_of_service=help.TermsOfService} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.termsOfServiceUpdateEmpty.md b/old_docs/API_docs_v109/constructors/help.termsOfServiceUpdateEmpty.md new file mode 100644 index 00000000..75d973a5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.termsOfServiceUpdateEmpty.md @@ -0,0 +1,39 @@ +--- +title: help.termsOfServiceUpdateEmpty +description: No changes were made to telegram's terms of service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_termsOfServiceUpdateEmpty.html +--- +# Constructor: help.termsOfServiceUpdateEmpty +[Back to constructors index](index.md) + + + +No changes were made to telegram's terms of service + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|expires|[int](../types/int.md) | Yes|New TOS updates will have to be queried using [help.getTermsOfServiceUpdate](../methods/help.getTermsOfServiceUpdate.md) in `expires` seconds| + + + +### Type: [help.TermsOfServiceUpdate](../types/help.TermsOfServiceUpdate.md) + + +### Example: + +```php +$help.termsOfServiceUpdateEmpty = ['_' => 'help.termsOfServiceUpdateEmpty', 'expires' => int]; +``` + + +Or, if you're into Lua: + +```lua +help.termsOfServiceUpdateEmpty={_='help.termsOfServiceUpdateEmpty', expires=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.userInfo.md b/old_docs/API_docs_v109/constructors/help.userInfo.md new file mode 100644 index 00000000..7ce97148 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.userInfo.md @@ -0,0 +1,42 @@ +--- +title: help.userInfo +description: Internal use +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_userInfo.html +--- +# Constructor: help.userInfo +[Back to constructors index](index.md) + + + +Internal use + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[string](../types/string.md) | Yes|Info| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|Entities| +|author|[string](../types/string.md) | Yes|Author| +|date|[int](../types/int.md) | Yes|Date| + + + +### Type: [help.UserInfo](../types/help.UserInfo.md) + + +### Example: + +```php +$help.userInfo = ['_' => 'help.userInfo', 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'author' => 'string', 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +help.userInfo={_='help.userInfo', message='string', entities={MessageEntity}, author='string', date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/help.userInfoEmpty.md b/old_docs/API_docs_v109/constructors/help.userInfoEmpty.md new file mode 100644 index 00000000..3225ff3c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/help.userInfoEmpty.md @@ -0,0 +1,34 @@ +--- +title: help.userInfoEmpty +description: Internal use +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/help_userInfoEmpty.html +--- +# Constructor: help.userInfoEmpty +[Back to constructors index](index.md) + + + +Internal use + + + + +### Type: [help.UserInfo](../types/help.UserInfo.md) + + +### Example: + +```php +$help.userInfoEmpty = ['_' => 'help.userInfoEmpty']; +``` + + +Or, if you're into Lua: + +```lua +help.userInfoEmpty={_='help.userInfoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/highScore.md b/old_docs/API_docs_v109/constructors/highScore.md new file mode 100644 index 00000000..26f43d91 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/highScore.md @@ -0,0 +1,40 @@ +--- +title: highScore +description: Game highscore +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: highScore +[Back to constructors index](index.md) + + + +Game highscore + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pos|[int](../types/int.md) | Yes|Position in highscore list| +|user\_id|[int](../types/int.md) | Yes|User ID| +|score|[int](../types/int.md) | Yes|Score| + + + +### Type: [HighScore](../types/HighScore.md) + + +### Example: + +```php +$highScore = ['_' => 'highScore', 'pos' => int, 'user_id' => int, 'score' => int]; +``` + + +Or, if you're into Lua: + +```lua +highScore={_='highScore', pos=int, user_id=int, score=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/importedContact.md b/old_docs/API_docs_v109/constructors/importedContact.md new file mode 100644 index 00000000..bda98e99 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/importedContact.md @@ -0,0 +1,39 @@ +--- +title: importedContact +description: Successfully imported contact. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: importedContact +[Back to constructors index](index.md) + + + +Successfully imported contact. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|client\_id|[long](../types/long.md) | Yes|The contact's client identifier (passed to one of the [InputContact](../types/InputContact.md) constructors)| + + + +### Type: [ImportedContact](../types/ImportedContact.md) + + +### Example: + +```php +$importedContact = ['_' => 'importedContact', 'user_id' => int, 'client_id' => long]; +``` + + +Or, if you're into Lua: + +```lua +importedContact={_='importedContact', user_id=int, client_id=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inlineBotSwitchPM.md b/old_docs/API_docs_v109/constructors/inlineBotSwitchPM.md new file mode 100644 index 00000000..f4ac504a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inlineBotSwitchPM.md @@ -0,0 +1,39 @@ +--- +title: inlineBotSwitchPM +description: The bot requested the user to message him in private +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inlineBotSwitchPM +[Back to constructors index](index.md) + + + +The bot requested the user to message him in private + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Text for the button that switches the user to a private chat with the bot and sends the bot a start message with the parameter `start_parameter` (can be empty)| +|start\_param|[string](../types/string.md) | Yes|The parameter for the `/start parameter`| + + + +### Type: [InlineBotSwitchPM](../types/InlineBotSwitchPM.md) + + +### Example: + +```php +$inlineBotSwitchPM = ['_' => 'inlineBotSwitchPM', 'text' => 'string', 'start_param' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inlineBotSwitchPM={_='inlineBotSwitchPM', text='string', start_param='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputAppEvent.md b/old_docs/API_docs_v109/constructors/inputAppEvent.md new file mode 100644 index 00000000..c67f92aa --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputAppEvent.md @@ -0,0 +1,41 @@ +--- +title: inputAppEvent +description: Event that occured in the application. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputAppEvent +[Back to constructors index](index.md) + + + +Event that occured in the application. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|time|[double](../types/double.md) | Yes|Client's exact timestamp for the event| +|type|[string](../types/string.md) | Yes|Type of event| +|peer|[long](../types/long.md) | Yes|Arbitrary numeric value for more convenient selection of certain event types, or events referring to a certain object| +|data|[JSONValue](../types/JSONValue.md) | Yes|Details of the event| + + + +### Type: [InputAppEvent](../types/InputAppEvent.md) + + +### Example: + +```php +$inputAppEvent = ['_' => 'inputAppEvent', 'time' => double, 'type' => 'string', 'peer' => long, 'data' => JSONValue]; +``` + + +Or, if you're into Lua: + +```lua +inputAppEvent={_='inputAppEvent', time=double, type='string', peer=long, data=JSONValue} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputBotInlineMessageGame.md b/old_docs/API_docs_v109/constructors/inputBotInlineMessageGame.md new file mode 100644 index 00000000..38d1df54 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputBotInlineMessageGame.md @@ -0,0 +1,44 @@ +--- +title: inputBotInlineMessageGame +description: A game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageGame +[Back to constructors index](index.md) + + + +A game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageGame = ['_' => 'inputBotInlineMessageGame', 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/inputBotInlineMessageID.md b/old_docs/API_docs_v109/constructors/inputBotInlineMessageID.md new file mode 100644 index 00000000..e0272c70 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputBotInlineMessageID.md @@ -0,0 +1,40 @@ +--- +title: inputBotInlineMessageID +description: Represents a sent inline message from the perspective of a bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageID +[Back to constructors index](index.md) + + + +Represents a sent inline message from the perspective of a bot + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dc\_id|[int](../types/int.md) | Yes|DC ID to use when working with this inline message| +|id|[long](../types/long.md) | Yes|ID of message| +|access\_hash|[long](../types/long.md) | Yes|Access hash of message| + + + +### Type: [InputBotInlineMessageID](../types/InputBotInlineMessageID.md) + + +### Example: + +```php +$inputBotInlineMessageID = ['_' => 'inputBotInlineMessageID', 'dc_id' => int, 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineMessageID={_='inputBotInlineMessageID', dc_id=int, id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaAuto.md b/old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaAuto.md new file mode 100644 index 00000000..d09c7752 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaAuto.md @@ -0,0 +1,46 @@ +--- +title: inputBotInlineMessageMediaAuto +description: A media +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaAuto +[Back to constructors index](index.md) + + + +A media + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[string](../types/string.md) | Yes|Caption| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageMediaAuto = ['_' => 'inputBotInlineMessageMediaAuto', 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/inputBotInlineMessageMediaContact.md b/old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaContact.md new file mode 100644 index 00000000..723cd7b1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaContact.md @@ -0,0 +1,48 @@ +--- +title: inputBotInlineMessageMediaContact +description: A contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaContact +[Back to constructors index](index.md) + + + +A contact + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|first\_name|[string](../types/string.md) | Yes|First name| +|last\_name|[string](../types/string.md) | Yes|Last name| +|vcard|[string](../types/string.md) | Yes|VCard info| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageMediaContact = ['_' => 'inputBotInlineMessageMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'vcard' => 'string', 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineMessageMediaContact={_='inputBotInlineMessageMediaContact', phone_number='string', first_name='string', last_name='string', vcard='string', reply_markup=ReplyMarkup} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaGeo.md b/old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaGeo.md new file mode 100644 index 00000000..e3f2f1c2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaGeo.md @@ -0,0 +1,46 @@ +--- +title: inputBotInlineMessageMediaGeo +description: Geolocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaGeo +[Back to constructors index](index.md) + + + +Geolocation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geolocation| +|period|[int](../types/int.md) | Yes|Validity period| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup for bot/inline keyboards| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageMediaGeo = ['_' => 'inputBotInlineMessageMediaGeo', 'geo_point' => InputGeoPoint, 'period' => int, 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/inputBotInlineMessageMediaVenue.md b/old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaVenue.md new file mode 100644 index 00000000..8dfa7a54 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputBotInlineMessageMediaVenue.md @@ -0,0 +1,50 @@ +--- +title: inputBotInlineMessageMediaVenue +description: Venue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageMediaVenue +[Back to constructors index](index.md) + + + +Venue + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geolocation| +|title|[string](../types/string.md) | Yes|Venue name| +|address|[string](../types/string.md) | Yes|Address| +|provider|[string](../types/string.md) | Yes|Venue provider: currently only "foursquare" needs to be supported| +|venue\_id|[string](../types/string.md) | Yes|Venue ID in the provider's database| +|venue\_type|[string](../types/string.md) | Yes|Venue type in the provider's database| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageMediaVenue = ['_' => '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: + +```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_v109/constructors/inputBotInlineMessageText.md b/old_docs/API_docs_v109/constructors/inputBotInlineMessageText.md new file mode 100644 index 00000000..a91bbd5d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputBotInlineMessageText.md @@ -0,0 +1,47 @@ +--- +title: inputBotInlineMessageText +description: Simple text message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineMessageText +[Back to constructors index](index.md) + + + +Simple text message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| +|message|[string](../types/string.md) | Yes|Message| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Inline keyboard| + + + +### Type: [InputBotInlineMessage](../types/InputBotInlineMessage.md) + + +### Example: + +```php +$inputBotInlineMessageText = ['_' => 'inputBotInlineMessageText', 'no_webpage' => Bool, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'reply_markup' => ReplyMarkup]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/inputBotInlineResult.md b/old_docs/API_docs_v109/constructors/inputBotInlineResult.md new file mode 100644 index 00000000..04f2c162 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputBotInlineResult.md @@ -0,0 +1,45 @@ +--- +title: inputBotInlineResult +description: An inline bot result +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResult +[Back to constructors index](index.md) + + + +An inline bot result + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|ID of result| +|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))| +|title|[string](../types/string.md) | Optional|Result title| +|description|[string](../types/string.md) | Optional|Result description| +|url|[string](../types/string.md) | Optional|URL of result| +|thumb|[InputWebDocument](../types/InputWebDocument.md) | Optional|Thumbnail for result| +|content|[InputWebDocument](../types/InputWebDocument.md) | Optional|Result contents| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes|Message to send when the result is selected| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +```php +$inputBotInlineResult = ['_' => 'inputBotInlineResult', 'id' => 'string', 'type' => 'string', 'title' => 'string', 'description' => 'string', 'url' => 'string', 'thumb' => InputWebDocument, 'content' => InputWebDocument, 'send_message' => InputBotInlineMessage]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/inputBotInlineResultDocument.md b/old_docs/API_docs_v109/constructors/inputBotInlineResultDocument.md new file mode 100644 index 00000000..294bfc74 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputBotInlineResultDocument.md @@ -0,0 +1,43 @@ +--- +title: inputBotInlineResultDocument +description: Document (media of any type except for photos) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResultDocument +[Back to constructors index](index.md) + + + +Document (media of any type except for photos) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Result ID| +|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))| +|title|[string](../types/string.md) | Optional|Result title| +|description|[string](../types/string.md) | Optional|Result description| +|document|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|Document to send| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes|Message to send when the result is selected| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +```php +$inputBotInlineResultDocument = ['_' => 'inputBotInlineResultDocument', 'id' => 'string', 'type' => 'string', 'title' => 'string', 'description' => 'string', 'document' => InputDocument, 'send_message' => InputBotInlineMessage]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineResultDocument={_='inputBotInlineResultDocument', id='string', type='string', title='string', description='string', document=InputDocument, send_message=InputBotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputBotInlineResultGame.md b/old_docs/API_docs_v109/constructors/inputBotInlineResultGame.md new file mode 100644 index 00000000..3f92c03f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputBotInlineResultGame.md @@ -0,0 +1,40 @@ +--- +title: inputBotInlineResultGame +description: Game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResultGame +[Back to constructors index](index.md) + + + +Game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Result ID| +|short\_name|[string](../types/string.md) | Yes|Game short name| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes|Message to send when the result is selected| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +```php +$inputBotInlineResultGame = ['_' => 'inputBotInlineResultGame', 'id' => 'string', 'short_name' => 'string', 'send_message' => InputBotInlineMessage]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineResultGame={_='inputBotInlineResultGame', id='string', short_name='string', send_message=InputBotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputBotInlineResultPhoto.md b/old_docs/API_docs_v109/constructors/inputBotInlineResultPhoto.md new file mode 100644 index 00000000..a60583cd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputBotInlineResultPhoto.md @@ -0,0 +1,41 @@ +--- +title: inputBotInlineResultPhoto +description: Photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputBotInlineResultPhoto +[Back to constructors index](index.md) + + + +Photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Result ID| +|type|[string](../types/string.md) | Yes|Result type (see [bot API docs](https://core.telegram.org/bots/api#inlinequeryresult))| +|photo|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional|Photo to send| +|send\_message|[InputBotInlineMessage](../types/InputBotInlineMessage.md) | Yes|Message to send when the result is selected| + + + +### Type: [InputBotInlineResult](../types/InputBotInlineResult.md) + + +### Example: + +```php +$inputBotInlineResultPhoto = ['_' => 'inputBotInlineResultPhoto', 'id' => 'string', 'type' => 'string', 'photo' => InputPhoto, 'send_message' => InputBotInlineMessage]; +``` + + +Or, if you're into Lua: + +```lua +inputBotInlineResultPhoto={_='inputBotInlineResultPhoto', id='string', type='string', photo=InputPhoto, send_message=InputBotInlineMessage} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputChannel.md b/old_docs/API_docs_v109/constructors/inputChannel.md new file mode 100644 index 00000000..8bf3b28a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputChannel.md @@ -0,0 +1,39 @@ +--- +title: inputChannel +description: Represents a channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChannel +[Back to constructors index](index.md) + + + +Represents a channel + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash taken from the [channel](../constructors/channel.md) constructor| + + + +### Type: [InputChannel](../types/InputChannel.md) + + +### Example: + +```php +$inputChannel = ['_' => 'inputChannel', 'channel_id' => int, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputChannel={_='inputChannel', channel_id=int, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputChannelEmpty.md b/old_docs/API_docs_v109/constructors/inputChannelEmpty.md new file mode 100644 index 00000000..f77e65a3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputChannelEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputChannelEmpty +description: Represents the absence of a channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChannelEmpty +[Back to constructors index](index.md) + + + +Represents the absence of a channel + + + + +### Type: [InputChannel](../types/InputChannel.md) + + +### Example: + +```php +$inputChannelEmpty = ['_' => 'inputChannelEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputChannelEmpty={_='inputChannelEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputChannelFromMessage.md b/old_docs/API_docs_v109/constructors/inputChannelFromMessage.md new file mode 100644 index 00000000..0fb18022 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputChannelFromMessage.md @@ -0,0 +1,40 @@ +--- +title: inputChannelFromMessage +description: Defines a [min](https://core.telegram.org/api/min) channel that was seen in a certain message of a certain chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChannelFromMessage +[Back to constructors index](index.md) + + + +Defines a [min](https://core.telegram.org/api/min) channel that was seen in a certain message of a certain chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the channel was seen| +|msg\_id|[int](../types/int.md) | Yes|The message ID in the chat where the channel was seen| +|channel\_id|[int](../types/int.md) | Yes|The channel ID| + + + +### Type: [InputChannel](../types/InputChannel.md) + + +### Example: + +```php +$inputChannelFromMessage = ['_' => 'inputChannelFromMessage', 'peer' => InputPeer, 'msg_id' => int, 'channel_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputChannelFromMessage={_='inputChannelFromMessage', peer=InputPeer, msg_id=int, channel_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputChatPhoto.md b/old_docs/API_docs_v109/constructors/inputChatPhoto.md new file mode 100644 index 00000000..ec0afc88 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputChatPhoto.md @@ -0,0 +1,38 @@ +--- +title: inputChatPhoto +description: Existing photo to be set as a chat profile photo. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChatPhoto +[Back to constructors index](index.md) + + + +Existing photo to be set as a chat profile photo. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional|Existing photo| + + + +### Type: [InputChatPhoto](../types/InputChatPhoto.md) + + +### Example: + +```php +$inputChatPhoto = ['_' => 'inputChatPhoto', 'id' => InputPhoto]; +``` + + +Or, if you're into Lua: + +```lua +inputChatPhoto={_='inputChatPhoto', id=InputPhoto} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputChatPhotoEmpty.md b/old_docs/API_docs_v109/constructors/inputChatPhotoEmpty.md new file mode 100644 index 00000000..48994cab --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputChatPhotoEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputChatPhotoEmpty +description: Empty constructor, remove group photo. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChatPhotoEmpty +[Back to constructors index](index.md) + + + +Empty constructor, remove group photo. + + + + +### Type: [InputChatPhoto](../types/InputChatPhoto.md) + + +### Example: + +```php +$inputChatPhotoEmpty = ['_' => 'inputChatPhotoEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputChatPhotoEmpty={_='inputChatPhotoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputChatUploadedPhoto.md b/old_docs/API_docs_v109/constructors/inputChatUploadedPhoto.md new file mode 100644 index 00000000..a385d112 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputChatUploadedPhoto.md @@ -0,0 +1,38 @@ +--- +title: inputChatUploadedPhoto +description: New photo to be set as group profile photo. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputChatUploadedPhoto +[Back to constructors index](index.md) + + + +New photo to be set as group profile photo. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|File saved in parts using the method [upload.saveFilePart](../methods/upload.saveFilePart.md)| + + + +### Type: [InputChatPhoto](../types/InputChatPhoto.md) + + +### Example: + +```php +$inputChatUploadedPhoto = ['_' => 'inputChatUploadedPhoto', 'file' => InputFile]; +``` + + +Or, if you're into Lua: + +```lua +inputChatUploadedPhoto={_='inputChatUploadedPhoto', file=InputFile} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputCheckPasswordEmpty.md b/old_docs/API_docs_v109/constructors/inputCheckPasswordEmpty.md new file mode 100644 index 00000000..4811921d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputCheckPasswordEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputCheckPasswordEmpty +description: There is no password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputCheckPasswordEmpty +[Back to constructors index](index.md) + + + +There is no password + + + + +### Type: [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) + + +### Example: + +```php +$inputCheckPasswordEmpty = ['_' => 'inputCheckPasswordEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputCheckPasswordEmpty={_='inputCheckPasswordEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputCheckPasswordSRP.md b/old_docs/API_docs_v109/constructors/inputCheckPasswordSRP.md new file mode 100644 index 00000000..82db7595 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputCheckPasswordSRP.md @@ -0,0 +1,40 @@ +--- +title: inputCheckPasswordSRP +description: Constructor for checking the validity of a 2FA SRP password (see [SRP](https://core.telegram.org/api/srp)) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputCheckPasswordSRP +[Back to constructors index](index.md) + + + +Constructor for checking the validity of a 2FA SRP password (see [SRP](https://core.telegram.org/api/srp)) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|srp\_id|[long](../types/long.md) | Yes|[SRP ID](https://core.telegram.org/api/srp)| +|A|[bytes](../types/bytes.md) | Yes|`A` parameter (see [SRP](https://core.telegram.org/api/srp))| +|M1|[bytes](../types/bytes.md) | Yes|`M1` parameter (see [SRP](https://core.telegram.org/api/srp))| + + + +### Type: [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) + + +### Example: + +```php +$inputCheckPasswordSRP = ['_' => 'inputCheckPasswordSRP', 'srp_id' => long, 'A' => 'bytes', 'M1' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +inputCheckPasswordSRP={_='inputCheckPasswordSRP', srp_id=long, A='bytes', M1='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputClientProxy.md b/old_docs/API_docs_v109/constructors/inputClientProxy.md new file mode 100644 index 00000000..3a4f8a68 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputClientProxy.md @@ -0,0 +1,39 @@ +--- +title: inputClientProxy +description: Info about an [MTProxy](https://core.telegram.org/mtproto/mtproto-transports#transport-obfuscation) used to connect. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputClientProxy +[Back to constructors index](index.md) + + + +Info about an [MTProxy](https://core.telegram.org/mtproto/mtproto-transports#transport-obfuscation) used to connect. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|address|[string](../types/string.md) | Yes|Proxy address| +|port|[int](../types/int.md) | Yes|Proxy port| + + + +### Type: [InputClientProxy](../types/InputClientProxy.md) + + +### Example: + +```php +$inputClientProxy = ['_' => 'inputClientProxy', 'address' => 'string', 'port' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputClientProxy={_='inputClientProxy', address='string', port=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputDialogPeer.md b/old_docs/API_docs_v109/constructors/inputDialogPeer.md new file mode 100644 index 00000000..d7f2f20b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputDialogPeer.md @@ -0,0 +1,38 @@ +--- +title: inputDialogPeer +description: A peer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputDialogPeer +[Back to constructors index](index.md) + + + +A peer + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| + + + +### Type: [InputDialogPeer](../types/InputDialogPeer.md) + + +### Example: + +```php +$inputDialogPeer = ['_' => 'inputDialogPeer', 'peer' => InputPeer]; +``` + + +Or, if you're into Lua: + +```lua +inputDialogPeer={_='inputDialogPeer', peer=InputPeer} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputDialogPeerFolder.md b/old_docs/API_docs_v109/constructors/inputDialogPeerFolder.md new file mode 100644 index 00000000..71f36afa --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputDialogPeerFolder.md @@ -0,0 +1,38 @@ +--- +title: inputDialogPeerFolder +description: All peers in a folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputDialogPeerFolder +[Back to constructors index](index.md) + + + +All peers in a folder + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|folder\_id|[int](../types/int.md) | Yes|Folder ID| + + + +### Type: [InputDialogPeer](../types/InputDialogPeer.md) + + +### Example: + +```php +$inputDialogPeerFolder = ['_' => 'inputDialogPeerFolder', 'folder_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputDialogPeerFolder={_='inputDialogPeerFolder', folder_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputDocument.md b/old_docs/API_docs_v109/constructors/inputDocument.md new file mode 100644 index 00000000..9b5d5ffb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputDocument.md @@ -0,0 +1,40 @@ +--- +title: inputDocument +description: Defines a video for subsequent interaction. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputDocument +[Back to constructors index](index.md) + + + +Defines a video for subsequent interaction. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Document ID| +|access\_hash|[long](../types/long.md) | Yes|**access\_hash** parameter from the [document](../constructors/document.md) constructor| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| + + + +### Type: [InputDocument](../types/InputDocument.md) + + +### Example: + +```php +$inputDocument = ['_' => 'inputDocument', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +inputDocument={_='inputDocument', id=long, access_hash=long, file_reference='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputDocumentEmpty.md b/old_docs/API_docs_v109/constructors/inputDocumentEmpty.md new file mode 100644 index 00000000..4e0f6721 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputDocumentEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputDocumentEmpty +description: Empty constructor. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputDocumentEmpty +[Back to constructors index](index.md) + + + +Empty constructor. + + + + +### Type: [InputDocument](../types/InputDocument.md) + + +### Example: + +```php +$inputDocumentEmpty = ['_' => 'inputDocumentEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputDocumentEmpty={_='inputDocumentEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputDocumentFileLocation.md b/old_docs/API_docs_v109/constructors/inputDocumentFileLocation.md new file mode 100644 index 00000000..81405f93 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputDocumentFileLocation.md @@ -0,0 +1,41 @@ +--- +title: inputDocumentFileLocation +description: Document location (video, voice, audio, basically every type except photo) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputDocumentFileLocation +[Back to constructors index](index.md) + + + +Document location (video, voice, audio, basically every type except photo) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Document ID| +|access\_hash|[long](../types/long.md) | Yes|**access\_hash** parameter from the [document](../constructors/document.md) constructor| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| +|thumb\_size|[string](../types/string.md) | Yes|Thumbnail size to download the thumbnail| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputDocumentFileLocation = ['_' => 'inputDocumentFileLocation', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'thumb_size' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputDocumentFileLocation={_='inputDocumentFileLocation', id=long, access_hash=long, file_reference='bytes', thumb_size='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputEncryptedChat.md b/old_docs/API_docs_v109/constructors/inputEncryptedChat.md new file mode 100644 index 00000000..7e3642c6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputEncryptedChat.md @@ -0,0 +1,39 @@ +--- +title: inputEncryptedChat +description: Creates an encrypted chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedChat +[Back to constructors index](index.md) + + + +Creates an encrypted chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|Chat ID| +|access\_hash|[long](../types/long.md) | Yes|Checking sum from constructor [encryptedChat](../constructors/encryptedChat.md), [encryptedChatWaiting](../constructors/encryptedChatWaiting.md) or [encryptedChatRequested](../constructors/encryptedChatRequested.md)| + + + +### Type: [InputEncryptedChat](../types/InputEncryptedChat.md) + + +### Example: + +```php +$inputEncryptedChat = ['_' => 'inputEncryptedChat', 'chat_id' => int, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputEncryptedChat={_='inputEncryptedChat', chat_id=int, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputEncryptedFile.md b/old_docs/API_docs_v109/constructors/inputEncryptedFile.md new file mode 100644 index 00000000..9cce9e74 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputEncryptedFile.md @@ -0,0 +1,39 @@ +--- +title: inputEncryptedFile +description: Sets forwarded encrypted file for attachment. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedFile +[Back to constructors index](index.md) + + + +Sets forwarded encrypted file for attachment. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|File ID, value of **id** parameter from [encryptedFile](../constructors/encryptedFile.md)| +|access\_hash|[long](../types/long.md) | Yes|Checking sum, value of **access\_hash** parameter from [encryptedFile](../constructors/encryptedFile.md)| + + + +### Type: [InputEncryptedFile](../types/InputEncryptedFile.md) + + +### Example: + +```php +$inputEncryptedFile = ['_' => 'inputEncryptedFile', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputEncryptedFile={_='inputEncryptedFile', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputEncryptedFileBigUploaded.md b/old_docs/API_docs_v109/constructors/inputEncryptedFileBigUploaded.md new file mode 100644 index 00000000..9aef07e0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputEncryptedFileBigUploaded.md @@ -0,0 +1,40 @@ +--- +title: inputEncryptedFileBigUploaded +description: Assigns a new big encrypted file (over 10Mb in size), saved in parts using the method [upload.saveBigFilePart](../methods/upload.saveBigFilePart.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedFileBigUploaded +[Back to constructors index](index.md) + + + +Assigns a new big encrypted file (over 10Mb in size), saved in parts using the method [upload.saveBigFilePart](../methods/upload.saveBigFilePart.md). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Random file id, created by the client| +|parts|[int](../types/int.md) | Yes|Number of saved parts| +|key\_fingerprint|[int](../types/int.md) | Yes|32-bit imprint of the key used to encrypt the file| + + + +### Type: [InputEncryptedFile](../types/InputEncryptedFile.md) + + +### Example: + +```php +$inputEncryptedFileBigUploaded = ['_' => 'inputEncryptedFileBigUploaded', 'id' => long, 'parts' => int, 'key_fingerprint' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputEncryptedFileBigUploaded={_='inputEncryptedFileBigUploaded', id=long, parts=int, key_fingerprint=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputEncryptedFileEmpty.md b/old_docs/API_docs_v109/constructors/inputEncryptedFileEmpty.md new file mode 100644 index 00000000..579b5225 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputEncryptedFileEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputEncryptedFileEmpty +description: Empty constructor. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedFileEmpty +[Back to constructors index](index.md) + + + +Empty constructor. + + + + +### Type: [InputEncryptedFile](../types/InputEncryptedFile.md) + + +### Example: + +```php +$inputEncryptedFileEmpty = ['_' => 'inputEncryptedFileEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputEncryptedFileEmpty={_='inputEncryptedFileEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputEncryptedFileLocation.md b/old_docs/API_docs_v109/constructors/inputEncryptedFileLocation.md new file mode 100644 index 00000000..0057ce78 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputEncryptedFileLocation.md @@ -0,0 +1,39 @@ +--- +title: inputEncryptedFileLocation +description: Location of encrypted secret chat file. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedFileLocation +[Back to constructors index](index.md) + + + +Location of encrypted secret chat file. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|File ID, **id** parameter value from [encryptedFile](../constructors/encryptedFile.md)| +|access\_hash|[long](../types/long.md) | Yes|Checksum, **access\_hash** parameter value from [encryptedFile](../constructors/encryptedFile.md)| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputEncryptedFileLocation = ['_' => 'inputEncryptedFileLocation', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputEncryptedFileLocation={_='inputEncryptedFileLocation', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputEncryptedFileUploaded.md b/old_docs/API_docs_v109/constructors/inputEncryptedFileUploaded.md new file mode 100644 index 00000000..12527ba0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputEncryptedFileUploaded.md @@ -0,0 +1,41 @@ +--- +title: inputEncryptedFileUploaded +description: Sets new encrypted file saved by parts using upload.saveFilePart method. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputEncryptedFileUploaded +[Back to constructors index](index.md) + + + +Sets new encrypted file saved by parts using upload.saveFilePart method. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Random file ID created by clien| +|parts|[int](../types/int.md) | Yes|Number of saved parts| +|md5\_checksum|[string](../types/string.md) | Yes|In case [md5-HASH](https://en.wikipedia.org/wiki/MD5) of the (already encrypted) file was transmitted, file content will be checked prior to use| +|key\_fingerprint|[int](../types/int.md) | Yes|32-bit fingerprint of the key used to encrypt a file| + + + +### Type: [InputEncryptedFile](../types/InputEncryptedFile.md) + + +### Example: + +```php +$inputEncryptedFileUploaded = ['_' => 'inputEncryptedFileUploaded', 'id' => long, 'parts' => int, 'md5_checksum' => 'string', 'key_fingerprint' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputEncryptedFileUploaded={_='inputEncryptedFileUploaded', id=long, parts=int, md5_checksum='string', key_fingerprint=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputFile.md b/old_docs/API_docs_v109/constructors/inputFile.md new file mode 100644 index 00000000..9d8aaddd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputFile.md @@ -0,0 +1,41 @@ +--- +title: inputFile +description: Defines a file saved in parts using the method [upload.saveFilePart](../methods/upload.saveFilePart.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputFile +[Back to constructors index](index.md) + + + +Defines a file saved in parts using the method [upload.saveFilePart](../methods/upload.saveFilePart.md). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Random file identifier created by the client| +|parts|[int](../types/int.md) | Yes|Number of parts saved| +|name|[string](../types/string.md) | Yes|Full name of the file| +|md5\_checksum|[string](../types/string.md) | Yes|In case the file's [md5-hash](https://en.wikipedia.org/wiki/MD5#MD5_hashes) was passed, contents of the file will be checked prior to use| + + + +### Type: [InputFile](../types/InputFile.md) + + +### Example: + +```php +$inputFile = ['_' => 'inputFile', 'id' => long, 'parts' => int, 'name' => 'string', 'md5_checksum' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputFile={_='inputFile', id=long, parts=int, name='string', md5_checksum='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputFileBig.md b/old_docs/API_docs_v109/constructors/inputFileBig.md new file mode 100644 index 00000000..64305632 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputFileBig.md @@ -0,0 +1,40 @@ +--- +title: inputFileBig +description: Assigns a big file (over 10Mb in size), saved in part using the method [upload.saveBigFilePart](../methods/upload.saveBigFilePart.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputFileBig +[Back to constructors index](index.md) + + + +Assigns a big file (over 10Mb in size), saved in part using the method [upload.saveBigFilePart](../methods/upload.saveBigFilePart.md). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Random file id, created by the client| +|parts|[int](../types/int.md) | Yes|Number of parts saved| +|name|[string](../types/string.md) | Yes|Full file name| + + + +### Type: [InputFile](../types/InputFile.md) + + +### Example: + +```php +$inputFileBig = ['_' => 'inputFileBig', 'id' => long, 'parts' => int, 'name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputFileBig={_='inputFileBig', id=long, parts=int, name='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputFileLocation.md b/old_docs/API_docs_v109/constructors/inputFileLocation.md new file mode 100644 index 00000000..e53d7615 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputFileLocation.md @@ -0,0 +1,41 @@ +--- +title: inputFileLocation +description: DEPRECATED location of a photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputFileLocation +[Back to constructors index](index.md) + + + +DEPRECATED location of a photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|volume\_id|[long](../types/long.md) | Yes|Server volume| +|local\_id|[int](../types/int.md) | Yes|File identifier| +|secret|[long](../types/long.md) | Yes|Check sum to access the file| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputFileLocation = ['_' => 'inputFileLocation', 'volume_id' => long, 'local_id' => int, 'secret' => long, 'file_reference' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +inputFileLocation={_='inputFileLocation', volume_id=long, local_id=int, secret=long, file_reference='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputFolderPeer.md b/old_docs/API_docs_v109/constructors/inputFolderPeer.md new file mode 100644 index 00000000..d9480272 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputFolderPeer.md @@ -0,0 +1,39 @@ +--- +title: inputFolderPeer +description: Peer in a folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputFolderPeer +[Back to constructors index](index.md) + + + +Peer in a folder + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| +|folder\_id|[int](../types/int.md) | Yes|Folder ID| + + + +### Type: [InputFolderPeer](../types/InputFolderPeer.md) + + +### Example: + +```php +$inputFolderPeer = ['_' => 'inputFolderPeer', 'peer' => InputPeer, 'folder_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputFolderPeer={_='inputFolderPeer', peer=InputPeer, folder_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputGameID.md b/old_docs/API_docs_v109/constructors/inputGameID.md new file mode 100644 index 00000000..e9ecf995 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputGameID.md @@ -0,0 +1,39 @@ +--- +title: inputGameID +description: Indicates an already sent game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputGameID +[Back to constructors index](index.md) + + + +Indicates an already sent game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Game ID from [Game](../types/Game.md) constructor| +|access\_hash|[long](../types/long.md) | Yes|Access hash from [Game](../types/Game.md) constructor| + + + +### Type: [InputGame](../types/InputGame.md) + + +### Example: + +```php +$inputGameID = ['_' => 'inputGameID', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputGameID={_='inputGameID', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputGameShortName.md b/old_docs/API_docs_v109/constructors/inputGameShortName.md new file mode 100644 index 00000000..016c1105 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputGameShortName.md @@ -0,0 +1,39 @@ +--- +title: inputGameShortName +description: Game by short name +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputGameShortName +[Back to constructors index](index.md) + + + +Game by short name + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot that provides the game| +|short\_name|[string](../types/string.md) | Yes|The game's short name| + + + +### Type: [InputGame](../types/InputGame.md) + + +### Example: + +```php +$inputGameShortName = ['_' => 'inputGameShortName', 'bot_id' => InputUser, 'short_name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputGameShortName={_='inputGameShortName', bot_id=InputUser, short_name='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputGeoPoint.md b/old_docs/API_docs_v109/constructors/inputGeoPoint.md new file mode 100644 index 00000000..6d9b83c8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputGeoPoint.md @@ -0,0 +1,39 @@ +--- +title: inputGeoPoint +description: Defines a GeoPoint by its coordinates. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputGeoPoint +[Back to constructors index](index.md) + + + +Defines a GeoPoint by its coordinates. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lat|[double](../types/double.md) | Yes|Latitide| +|long|[double](../types/double.md) | Yes|Longtitude| + + + +### Type: [InputGeoPoint](../types/InputGeoPoint.md) + + +### Example: + +```php +$inputGeoPoint = ['_' => 'inputGeoPoint', 'lat' => double, 'long' => double]; +``` + + +Or, if you're into Lua: + +```lua +inputGeoPoint={_='inputGeoPoint', lat=double, long=double} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputGeoPointEmpty.md b/old_docs/API_docs_v109/constructors/inputGeoPointEmpty.md new file mode 100644 index 00000000..a9105ee1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputGeoPointEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputGeoPointEmpty +description: Empty GeoPoint constructor. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputGeoPointEmpty +[Back to constructors index](index.md) + + + +Empty GeoPoint constructor. + + + + +### Type: [InputGeoPoint](../types/InputGeoPoint.md) + + +### Example: + +```php +$inputGeoPointEmpty = ['_' => 'inputGeoPointEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputGeoPointEmpty={_='inputGeoPointEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputKeyboardButtonUrlAuth.md b/old_docs/API_docs_v109/constructors/inputKeyboardButtonUrlAuth.md new file mode 100644 index 00000000..00662373 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputKeyboardButtonUrlAuth.md @@ -0,0 +1,42 @@ +--- +title: inputKeyboardButtonUrlAuth +description: Button to request a user to [authorize](../methods/messages.acceptUrlAuth.md) via URL using [Seamless Telegram Login](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputKeyboardButtonUrlAuth +[Back to constructors index](index.md) + + + +Button to request a user to [authorize](../methods/messages.acceptUrlAuth.md) via URL using [Seamless Telegram Login](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|request\_write\_access|[Bool](../types/Bool.md) | Optional|Set this flag to request the permission for your bot to send messages to the user.| +|text|[string](../types/string.md) | Yes|Button text| +|fwd\_text|[string](../types/string.md) | Optional|New text of the button in forwarded messages.| +|url|[string](../types/string.md) | Yes|An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in [Receiving authorization data](https://core.telegram.org/widgets/login#receiving-authorization-data).
NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in [Checking authorization](https://core.telegram.org/widgets/login#checking-authorization).| +|bot|[InputUser](../types/InputUser.md) | Optional|Username of a bot, which will be used for user authorization. See [Setting up a bot](https://core.telegram.org/widgets/login#setting-up-a-bot) for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See [Linking your domain to the bot](https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot) for more details.| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$inputKeyboardButtonUrlAuth = ['_' => 'inputKeyboardButtonUrlAuth', 'request_write_access' => Bool, 'text' => 'string', 'fwd_text' => 'string', 'url' => 'string', 'bot' => InputUser]; +``` + + +Or, if you're into Lua: + +```lua +inputKeyboardButtonUrlAuth={_='inputKeyboardButtonUrlAuth', request_write_access=Bool, text='string', fwd_text='string', url='string', bot=InputUser} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaContact.md b/old_docs/API_docs_v109/constructors/inputMediaContact.md new file mode 100644 index 00000000..655f0d32 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaContact.md @@ -0,0 +1,41 @@ +--- +title: inputMediaContact +description: Phonebook contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaContact +[Back to constructors index](index.md) + + + +Phonebook contact + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|first\_name|[string](../types/string.md) | Yes|Contact's first name| +|last\_name|[string](../types/string.md) | Yes|Contact's last name| +|vcard|[string](../types/string.md) | Yes|Contact vcard| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaContact = ['_' => 'inputMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'vcard' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputMediaContact={_='inputMediaContact', phone_number='string', first_name='string', last_name='string', vcard='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaDocument.md b/old_docs/API_docs_v109/constructors/inputMediaDocument.md new file mode 100644 index 00000000..f4cd3916 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaDocument.md @@ -0,0 +1,39 @@ +--- +title: inputMediaDocument +description: Forwarded document +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaDocument +[Back to constructors index](index.md) + + + +Forwarded document + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|The document to be forwarded.| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live of self-destructing document| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaDocument = ['_' => 'inputMediaDocument', 'id' => InputDocument, 'ttl_seconds' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaDocument={_='inputMediaDocument', id=InputDocument, ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaDocumentExternal.md b/old_docs/API_docs_v109/constructors/inputMediaDocumentExternal.md new file mode 100644 index 00000000..caa729d2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaDocumentExternal.md @@ -0,0 +1,39 @@ +--- +title: inputMediaDocumentExternal +description: Document that will be downloaded by the telegram servers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaDocumentExternal +[Back to constructors index](index.md) + + + +Document that will be downloaded by the telegram servers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL of the document| +|ttl\_seconds|[int](../types/int.md) | Optional|Self-destruct time to live of document| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaDocumentExternal = ['_' => 'inputMediaDocumentExternal', 'url' => 'string', 'ttl_seconds' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaDocumentExternal={_='inputMediaDocumentExternal', url='string', ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaEmpty.md b/old_docs/API_docs_v109/constructors/inputMediaEmpty.md new file mode 100644 index 00000000..038929ba --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputMediaEmpty +description: Empty media content of a message. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaEmpty +[Back to constructors index](index.md) + + + +Empty media content of a message. + + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaEmpty = ['_' => 'inputMediaEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputMediaEmpty={_='inputMediaEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaGame.md b/old_docs/API_docs_v109/constructors/inputMediaGame.md new file mode 100644 index 00000000..293b1d9b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaGame.md @@ -0,0 +1,38 @@ +--- +title: inputMediaGame +description: A game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaGame +[Back to constructors index](index.md) + + + +A game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[InputGame](../types/InputGame.md) | Yes|The game to forward| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaGame = ['_' => 'inputMediaGame', 'id' => InputGame]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaGame={_='inputMediaGame', id=InputGame} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaGeoLive.md b/old_docs/API_docs_v109/constructors/inputMediaGeoLive.md new file mode 100644 index 00000000..0e899bb1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaGeoLive.md @@ -0,0 +1,40 @@ +--- +title: inputMediaGeoLive +description: Live geographical location +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaGeoLive +[Back to constructors index](index.md) + + + +Live geographical location + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stopped|[Bool](../types/Bool.md) | Optional|Whether sending of the geolocation was stopped| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current geolocation| +|period|[int](../types/int.md) | Optional|Validity period of the current location| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaGeoLive = ['_' => 'inputMediaGeoLive', 'stopped' => Bool, 'geo_point' => InputGeoPoint, 'period' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaGeoLive={_='inputMediaGeoLive', stopped=Bool, geo_point=InputGeoPoint, period=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaGeoPoint.md b/old_docs/API_docs_v109/constructors/inputMediaGeoPoint.md new file mode 100644 index 00000000..a63e1fec --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaGeoPoint.md @@ -0,0 +1,38 @@ +--- +title: inputMediaGeoPoint +description: Map. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaGeoPoint +[Back to constructors index](index.md) + + + +Map. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|GeoPoint| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaGeoPoint = ['_' => 'inputMediaGeoPoint', 'geo_point' => InputGeoPoint]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaGeoPoint={_='inputMediaGeoPoint', geo_point=InputGeoPoint} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaGifExternal.md b/old_docs/API_docs_v109/constructors/inputMediaGifExternal.md new file mode 100644 index 00000000..1b2934e7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaGifExternal.md @@ -0,0 +1,39 @@ +--- +title: inputMediaGifExternal +description: New GIF animation that will be uploaded by the server using the specified URL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaGifExternal +[Back to constructors index](index.md) + + + +New GIF animation that will be uploaded by the server using the specified URL + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL| +|q|[string](../types/string.md) | Yes|Query| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaGifExternal = ['_' => 'inputMediaGifExternal', 'url' => 'string', 'q' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputMediaGifExternal={_='inputMediaGifExternal', url='string', q='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaInvoice.md b/old_docs/API_docs_v109/constructors/inputMediaInvoice.md new file mode 100644 index 00000000..8de50c5e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaInvoice.md @@ -0,0 +1,45 @@ +--- +title: inputMediaInvoice +description: Generated invoice of a [bot payment](https://core.telegram.org/bots/payments) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaInvoice +[Back to constructors index](index.md) + + + +Generated invoice of a [bot payment](https://core.telegram.org/bots/payments) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[string](../types/string.md) | Yes|Product name, 1-32 characters| +|description|[string](../types/string.md) | Yes|Product description, 1-255 characters| +|photo|[InputWebDocument](../types/InputWebDocument.md) | Optional|URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.| +|invoice|[Invoice](../types/Invoice.md) | Yes|The actual invoice| +|payload|[bytes](../types/bytes.md) | Yes|Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.| +|provider|[string](../types/string.md) | Yes|Payments provider token, obtained via [Botfather](https://t.me/botfather)| +|provider\_data|[DataJSON](../types/DataJSON.md) | Yes|JSON-encoded data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.| +|start\_param|[string](../types/string.md) | Yes|Start parameter| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaInvoice = ['_' => 'inputMediaInvoice', 'title' => 'string', 'description' => 'string', 'photo' => InputWebDocument, 'invoice' => Invoice, 'payload' => 'bytes', 'provider' => 'string', 'provider_data' => DataJSON, 'start_param' => 'string']; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/inputMediaPhoto.md b/old_docs/API_docs_v109/constructors/inputMediaPhoto.md new file mode 100644 index 00000000..e42acf33 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaPhoto.md @@ -0,0 +1,39 @@ +--- +title: inputMediaPhoto +description: Forwarded photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaPhoto +[Back to constructors index](index.md) + + + +Forwarded photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional|Photo to be forwarded| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live in seconds of self-destructing photo| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaPhoto = ['_' => 'inputMediaPhoto', 'id' => InputPhoto, 'ttl_seconds' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaPhoto={_='inputMediaPhoto', id=InputPhoto, ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaPhotoExternal.md b/old_docs/API_docs_v109/constructors/inputMediaPhotoExternal.md new file mode 100644 index 00000000..75f82119 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaPhotoExternal.md @@ -0,0 +1,39 @@ +--- +title: inputMediaPhotoExternal +description: New photo that will be uploaded by the server using the specified URL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaPhotoExternal +[Back to constructors index](index.md) + + + +New photo that will be uploaded by the server using the specified URL + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL of the photo| +|ttl\_seconds|[int](../types/int.md) | Optional|Self-destruct time to live of photo| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaPhotoExternal = ['_' => 'inputMediaPhotoExternal', 'url' => 'string', 'ttl_seconds' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaPhotoExternal={_='inputMediaPhotoExternal', url='string', ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaPoll.md b/old_docs/API_docs_v109/constructors/inputMediaPoll.md new file mode 100644 index 00000000..1ac336ad --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaPoll.md @@ -0,0 +1,39 @@ +--- +title: inputMediaPoll +description: A poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaPoll +[Back to constructors index](index.md) + + + +A poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|poll|[Poll](../types/Poll.md) | Yes|The poll to send| +|correct\_answers|Array of [bytes](../types/bytes.md) | Optional|| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaPoll = ['_' => 'inputMediaPoll', 'poll' => Poll, 'correct_answers' => ['bytes', 'bytes']]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaPoll={_='inputMediaPoll', poll=Poll, correct_answers={'bytes'}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaUploadedDocument.md b/old_docs/API_docs_v109/constructors/inputMediaUploadedDocument.md new file mode 100644 index 00000000..ffa07798 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaUploadedDocument.md @@ -0,0 +1,44 @@ +--- +title: inputMediaUploadedDocument +description: New document +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaUploadedDocument +[Back to constructors index](index.md) + + + +New document + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|nosound\_video|[Bool](../types/Bool.md) | Optional|Whether the specified document is a video file with no audio tracks (a GIF animation (even as MPEG4), for example)| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The [uploaded file](https://core.telegram.org/api/files)| +|thumb|[File path or InputFile](../types/InputFile.md) | Optional|Thumbnail of the document, uploaded as for the file| +|mime\_type|[string](../types/string.md) | Optional|MIME type of document| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes| +|stickers|Array of [MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|Stickers| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live in seconds of self-destructing document| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaUploadedDocument = ['_' => 'inputMediaUploadedDocument', 'nosound_video' => Bool, 'file' => InputFile, 'thumb' => InputFile, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute], 'stickers' => [InputDocument, InputDocument], 'ttl_seconds' => int]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/inputMediaUploadedPhoto.md b/old_docs/API_docs_v109/constructors/inputMediaUploadedPhoto.md new file mode 100644 index 00000000..b56b3207 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaUploadedPhoto.md @@ -0,0 +1,40 @@ +--- +title: inputMediaUploadedPhoto +description: Photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaUploadedPhoto +[Back to constructors index](index.md) + + + +Photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The [uploaded file](https://core.telegram.org/api/files)| +|stickers|Array of [MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|Stickers| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live in seconds of self-destructing photo| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaUploadedPhoto = ['_' => 'inputMediaUploadedPhoto', 'file' => InputFile, 'stickers' => [InputDocument, InputDocument], 'ttl_seconds' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMediaUploadedPhoto={_='inputMediaUploadedPhoto', file=InputFile, stickers={InputDocument}, ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMediaVenue.md b/old_docs/API_docs_v109/constructors/inputMediaVenue.md new file mode 100644 index 00000000..b6361d36 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMediaVenue.md @@ -0,0 +1,43 @@ +--- +title: inputMediaVenue +description: Can be used to send a venue geolocation. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMediaVenue +[Back to constructors index](index.md) + + + +Can be used to send a venue geolocation. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geolocation| +|title|[string](../types/string.md) | Yes|Venue name| +|address|[string](../types/string.md) | Yes|Physical address of the venue| +|provider|[string](../types/string.md) | Yes|Venue provider: currently only "foursquare" needs to be supported| +|venue\_id|[string](../types/string.md) | Yes|Venue ID in the provider's database| +|venue\_type|[string](../types/string.md) | Yes|Venue type in the provider's database| + + + +### Type: [InputMedia](../types/InputMedia.md) + + +### Example: + +```php +$inputMediaVenue = ['_' => 'inputMediaVenue', 'geo_point' => InputGeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string', 'venue_type' => 'string']; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/inputMessageEntityMentionName.md b/old_docs/API_docs_v109/constructors/inputMessageEntityMentionName.md new file mode 100644 index 00000000..31bee751 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessageEntityMentionName.md @@ -0,0 +1,40 @@ +--- +title: inputMessageEntityMentionName +description: Message entity that can be used to create a user [user mention](https://t.me/test): received mentions use the [messageEntityMentionName](../constructors/messageEntityMentionName.md) constructor, instead. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessageEntityMentionName +[Back to constructors index](index.md) + + + +Message entity that can be used to create a user [user mention](https://t.me/test): received mentions use the [messageEntityMentionName](../constructors/messageEntityMentionName.md) constructor, instead. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| +|user\_id|[InputUser](../types/InputUser.md) | Optional|Identifier of the user that was mentioned| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$inputMessageEntityMentionName = ['_' => 'inputMessageEntityMentionName', 'offset' => int, 'length' => int, 'user_id' => InputUser]; +``` + + +Or, if you're into Lua: + +```lua +inputMessageEntityMentionName={_='inputMessageEntityMentionName', offset=int, length=int, user_id=InputUser} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessageID.md b/old_docs/API_docs_v109/constructors/inputMessageID.md new file mode 100644 index 00000000..46260dcc --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessageID.md @@ -0,0 +1,38 @@ +--- +title: inputMessageID +description: Message by ID +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessageID +[Back to constructors index](index.md) + + + +Message by ID + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Message ID| + + + +### Type: [InputMessage](../types/InputMessage.md) + + +### Example: + +```php +$inputMessageID = ['_' => 'inputMessageID', 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMessageID={_='inputMessageID', id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagePinned.md b/old_docs/API_docs_v109/constructors/inputMessagePinned.md new file mode 100644 index 00000000..db74a775 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagePinned.md @@ -0,0 +1,33 @@ +--- +title: inputMessagePinned +description: Pinned message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagePinned +[Back to constructors index](index.md) + + + +Pinned message + + + + +### Type: [InputMessage](../types/InputMessage.md) + + +### Example: + +```php +$inputMessagePinned = ['_' => 'inputMessagePinned']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagePinned={_='inputMessagePinned'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessageReplyTo.md b/old_docs/API_docs_v109/constructors/inputMessageReplyTo.md new file mode 100644 index 00000000..992ded1a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessageReplyTo.md @@ -0,0 +1,38 @@ +--- +title: inputMessageReplyTo +description: Message to which the specified message replies to +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessageReplyTo +[Back to constructors index](index.md) + + + +Message to which the specified message replies to + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|ID of the message that replies to the message we need| + + + +### Type: [InputMessage](../types/InputMessage.md) + + +### Example: + +```php +$inputMessageReplyTo = ['_' => 'inputMessageReplyTo', 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputMessageReplyTo={_='inputMessageReplyTo', id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterChatPhotos.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterChatPhotos.md new file mode 100644 index 00000000..bbaad234 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterChatPhotos.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterChatPhotos +description: Return only chat photo changes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterChatPhotos +[Back to constructors index](index.md) + + + +Return only chat photo changes + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterChatPhotos = ['_' => 'inputMessagesFilterChatPhotos']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterChatPhotos={_='inputMessagesFilterChatPhotos'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterContacts.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterContacts.md new file mode 100644 index 00000000..94994f6f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterContacts.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterContacts +description: Return only messages containing contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterContacts +[Back to constructors index](index.md) + + + +Return only messages containing contacts + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterContacts = ['_' => 'inputMessagesFilterContacts']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterContacts={_='inputMessagesFilterContacts'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterDocument.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterDocument.md new file mode 100644 index 00000000..ee7e11e1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterDocument.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterDocument +description: Filter for messages containing documents. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterDocument +[Back to constructors index](index.md) + + + +Filter for messages containing documents. + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterDocument = ['_' => 'inputMessagesFilterDocument']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterDocument={_='inputMessagesFilterDocument'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterEmpty.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterEmpty.md new file mode 100644 index 00000000..26a0dbfc --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterEmpty +description: Filter is absent. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterEmpty +[Back to constructors index](index.md) + + + +Filter is absent. + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterEmpty = ['_' => 'inputMessagesFilterEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterEmpty={_='inputMessagesFilterEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterGeo.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterGeo.md new file mode 100644 index 00000000..a3e24fd0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterGeo.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterGeo +description: Return only messages containing geolocations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterGeo +[Back to constructors index](index.md) + + + +Return only messages containing geolocations + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterGeo = ['_' => 'inputMessagesFilterGeo']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterGeo={_='inputMessagesFilterGeo'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterGif.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterGif.md new file mode 100644 index 00000000..dc9218d4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterGif.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterGif +description: Return only messages containing gifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterGif +[Back to constructors index](index.md) + + + +Return only messages containing gifs + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterGif = ['_' => 'inputMessagesFilterGif']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterGif={_='inputMessagesFilterGif'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterMusic.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterMusic.md new file mode 100644 index 00000000..c7159158 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterMusic.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterMusic +description: Return only messages containing audio files +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterMusic +[Back to constructors index](index.md) + + + +Return only messages containing audio files + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterMusic = ['_' => 'inputMessagesFilterMusic']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterMusic={_='inputMessagesFilterMusic'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterMyMentions.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterMyMentions.md new file mode 100644 index 00000000..181f68b3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterMyMentions.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterMyMentions +description: Return only messages where the current user was mentioned +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterMyMentions +[Back to constructors index](index.md) + + + +Return only messages where the current user was mentioned + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterMyMentions = ['_' => 'inputMessagesFilterMyMentions']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterMyMentions={_='inputMessagesFilterMyMentions'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterPhoneCalls.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterPhoneCalls.md new file mode 100644 index 00000000..5ad65ba9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterPhoneCalls.md @@ -0,0 +1,38 @@ +--- +title: inputMessagesFilterPhoneCalls +description: Return only phone calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterPhoneCalls +[Back to constructors index](index.md) + + + +Return only phone calls + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|missed|[Bool](../types/Bool.md) | Optional|Return only missed phone calls| + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterPhoneCalls = ['_' => 'inputMessagesFilterPhoneCalls', 'missed' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterPhoneCalls={_='inputMessagesFilterPhoneCalls', missed=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterPhotoVideo.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterPhotoVideo.md new file mode 100644 index 00000000..586c216d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterPhotoVideo.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterPhotoVideo +description: Filter for messages containing photos or videos. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterPhotoVideo +[Back to constructors index](index.md) + + + +Filter for messages containing photos or videos. + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterPhotoVideo = ['_' => 'inputMessagesFilterPhotoVideo']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterPhotoVideo={_='inputMessagesFilterPhotoVideo'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterPhotos.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterPhotos.md new file mode 100644 index 00000000..dc70aad1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterPhotos.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterPhotos +description: Filter for messages containing photos. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterPhotos +[Back to constructors index](index.md) + + + +Filter for messages containing photos. + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterPhotos = ['_' => 'inputMessagesFilterPhotos']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterPhotos={_='inputMessagesFilterPhotos'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterRoundVideo.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterRoundVideo.md new file mode 100644 index 00000000..d10eeba0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterRoundVideo.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterRoundVideo +description: Return only round videos +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterRoundVideo +[Back to constructors index](index.md) + + + +Return only round videos + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterRoundVideo = ['_' => 'inputMessagesFilterRoundVideo']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterRoundVideo={_='inputMessagesFilterRoundVideo'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterRoundVoice.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterRoundVoice.md new file mode 100644 index 00000000..db0f1f94 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterRoundVoice.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterRoundVoice +description: Return only round videos and voice notes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterRoundVoice +[Back to constructors index](index.md) + + + +Return only round videos and voice notes + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterRoundVoice = ['_' => 'inputMessagesFilterRoundVoice']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterRoundVoice={_='inputMessagesFilterRoundVoice'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterUrl.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterUrl.md new file mode 100644 index 00000000..a038b2a0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterUrl.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterUrl +description: Return only messages containing URLs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterUrl +[Back to constructors index](index.md) + + + +Return only messages containing URLs + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterUrl = ['_' => 'inputMessagesFilterUrl']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterUrl={_='inputMessagesFilterUrl'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterVideo.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterVideo.md new file mode 100644 index 00000000..55738697 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterVideo.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterVideo +description: Filter for messages containing videos. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterVideo +[Back to constructors index](index.md) + + + +Filter for messages containing videos. + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterVideo = ['_' => 'inputMessagesFilterVideo']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterVideo={_='inputMessagesFilterVideo'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputMessagesFilterVoice.md b/old_docs/API_docs_v109/constructors/inputMessagesFilterVoice.md new file mode 100644 index 00000000..c997d4c3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputMessagesFilterVoice.md @@ -0,0 +1,33 @@ +--- +title: inputMessagesFilterVoice +description: Return only messages containing voice notes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputMessagesFilterVoice +[Back to constructors index](index.md) + + + +Return only messages containing voice notes + + + + +### Type: [MessagesFilter](../types/MessagesFilter.md) + + +### Example: + +```php +$inputMessagesFilterVoice = ['_' => 'inputMessagesFilterVoice']; +``` + + +Or, if you're into Lua: + +```lua +inputMessagesFilterVoice={_='inputMessagesFilterVoice'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputNotifyBroadcasts.md b/old_docs/API_docs_v109/constructors/inputNotifyBroadcasts.md new file mode 100644 index 00000000..175adcdf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputNotifyBroadcasts.md @@ -0,0 +1,33 @@ +--- +title: inputNotifyBroadcasts +description: All [channels](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputNotifyBroadcasts +[Back to constructors index](index.md) + + + +All [channels](https://core.telegram.org/api/channel) + + + + +### Type: [InputNotifyPeer](../types/InputNotifyPeer.md) + + +### Example: + +```php +$inputNotifyBroadcasts = ['_' => 'inputNotifyBroadcasts']; +``` + + +Or, if you're into Lua: + +```lua +inputNotifyBroadcasts={_='inputNotifyBroadcasts'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputNotifyChats.md b/old_docs/API_docs_v109/constructors/inputNotifyChats.md new file mode 100644 index 00000000..63de306d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputNotifyChats.md @@ -0,0 +1,33 @@ +--- +title: inputNotifyChats +description: Notifications generated by all groups. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputNotifyChats +[Back to constructors index](index.md) + + + +Notifications generated by all groups. + + + + +### Type: [InputNotifyPeer](../types/InputNotifyPeer.md) + + +### Example: + +```php +$inputNotifyChats = ['_' => 'inputNotifyChats']; +``` + + +Or, if you're into Lua: + +```lua +inputNotifyChats={_='inputNotifyChats'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputNotifyPeer.md b/old_docs/API_docs_v109/constructors/inputNotifyPeer.md new file mode 100644 index 00000000..857a84a8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputNotifyPeer.md @@ -0,0 +1,38 @@ +--- +title: inputNotifyPeer +description: Notifications generated by a certain user or group. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputNotifyPeer +[Back to constructors index](index.md) + + + +Notifications generated by a certain user or group. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|User or group| + + + +### Type: [InputNotifyPeer](../types/InputNotifyPeer.md) + + +### Example: + +```php +$inputNotifyPeer = ['_' => 'inputNotifyPeer', 'peer' => InputPeer]; +``` + + +Or, if you're into Lua: + +```lua +inputNotifyPeer={_='inputNotifyPeer', peer=InputPeer} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputNotifyUsers.md b/old_docs/API_docs_v109/constructors/inputNotifyUsers.md new file mode 100644 index 00000000..d1809903 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputNotifyUsers.md @@ -0,0 +1,33 @@ +--- +title: inputNotifyUsers +description: Notifications generated by all users. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputNotifyUsers +[Back to constructors index](index.md) + + + +Notifications generated by all users. + + + + +### Type: [InputNotifyPeer](../types/InputNotifyPeer.md) + + +### Example: + +```php +$inputNotifyUsers = ['_' => 'inputNotifyUsers']; +``` + + +Or, if you're into Lua: + +```lua +inputNotifyUsers={_='inputNotifyUsers'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPaymentCredentials.md b/old_docs/API_docs_v109/constructors/inputPaymentCredentials.md new file mode 100644 index 00000000..5ac8ce14 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPaymentCredentials.md @@ -0,0 +1,39 @@ +--- +title: inputPaymentCredentials +description: Payment credentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentials +[Back to constructors index](index.md) + + + +Payment credentials + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|save|[Bool](../types/Bool.md) | Optional|Save payment credential for future use| +|data|[DataJSON](../types/DataJSON.md) | Yes|Payment credentials| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +```php +$inputPaymentCredentials = ['_' => 'inputPaymentCredentials', 'save' => Bool, 'data' => DataJSON]; +``` + + +Or, if you're into Lua: + +```lua +inputPaymentCredentials={_='inputPaymentCredentials', save=Bool, data=DataJSON} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPaymentCredentialsAndroidPay.md b/old_docs/API_docs_v109/constructors/inputPaymentCredentialsAndroidPay.md new file mode 100644 index 00000000..81030684 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPaymentCredentialsAndroidPay.md @@ -0,0 +1,39 @@ +--- +title: inputPaymentCredentialsAndroidPay +description: Android pay payment credentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentialsAndroidPay +[Back to constructors index](index.md) + + + +Android pay payment credentials + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|payment\_token|[DataJSON](../types/DataJSON.md) | Yes|Android pay payment token| +|google\_transaction\_id|[string](../types/string.md) | Yes|Google transaction ID| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +```php +$inputPaymentCredentialsAndroidPay = ['_' => 'inputPaymentCredentialsAndroidPay', 'payment_token' => DataJSON, 'google_transaction_id' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputPaymentCredentialsAndroidPay={_='inputPaymentCredentialsAndroidPay', payment_token=DataJSON, google_transaction_id='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPaymentCredentialsApplePay.md b/old_docs/API_docs_v109/constructors/inputPaymentCredentialsApplePay.md new file mode 100644 index 00000000..748af34d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPaymentCredentialsApplePay.md @@ -0,0 +1,38 @@ +--- +title: inputPaymentCredentialsApplePay +description: Apple pay payment credentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentialsApplePay +[Back to constructors index](index.md) + + + +Apple pay payment credentials + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|payment\_data|[DataJSON](../types/DataJSON.md) | Yes|Payment data| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +```php +$inputPaymentCredentialsApplePay = ['_' => 'inputPaymentCredentialsApplePay', 'payment_data' => DataJSON]; +``` + + +Or, if you're into Lua: + +```lua +inputPaymentCredentialsApplePay={_='inputPaymentCredentialsApplePay', payment_data=DataJSON} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPaymentCredentialsSaved.md b/old_docs/API_docs_v109/constructors/inputPaymentCredentialsSaved.md new file mode 100644 index 00000000..27bd7f81 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPaymentCredentialsSaved.md @@ -0,0 +1,39 @@ +--- +title: inputPaymentCredentialsSaved +description: Saved payment credentials +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPaymentCredentialsSaved +[Back to constructors index](index.md) + + + +Saved payment credentials + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Credential ID| +|tmp\_password|[bytes](../types/bytes.md) | Yes|Temporary password| + + + +### Type: [InputPaymentCredentials](../types/InputPaymentCredentials.md) + + +### Example: + +```php +$inputPaymentCredentialsSaved = ['_' => 'inputPaymentCredentialsSaved', 'id' => 'string', 'tmp_password' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +inputPaymentCredentialsSaved={_='inputPaymentCredentialsSaved', id='string', tmp_password='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPeerChannel.md b/old_docs/API_docs_v109/constructors/inputPeerChannel.md new file mode 100644 index 00000000..739afc19 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPeerChannel.md @@ -0,0 +1,39 @@ +--- +title: inputPeerChannel +description: Defines a channel for further interaction. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerChannel +[Back to constructors index](index.md) + + + +Defines a channel for further interaction. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel identifier| +|access\_hash|[long](../types/long.md) | Yes|**access\_hash** value from the [channel](../constructors/channel.md) constructor| + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +```php +$inputPeerChannel = ['_' => 'inputPeerChannel', 'channel_id' => int, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputPeerChannel={_='inputPeerChannel', channel_id=int, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPeerChannelFromMessage.md b/old_docs/API_docs_v109/constructors/inputPeerChannelFromMessage.md new file mode 100644 index 00000000..98f51db1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPeerChannelFromMessage.md @@ -0,0 +1,40 @@ +--- +title: inputPeerChannelFromMessage +description: Defines a [min](https://core.telegram.org/api/min) channel that was seen in a certain message of a certain chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerChannelFromMessage +[Back to constructors index](index.md) + + + +Defines a [min](https://core.telegram.org/api/min) channel that was seen in a certain message of a certain chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the channel's message was seen| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|channel\_id|[int](../types/int.md) | Yes|The identifier of the channel that was seen| + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +```php +$inputPeerChannelFromMessage = ['_' => 'inputPeerChannelFromMessage', 'peer' => InputPeer, 'msg_id' => int, 'channel_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputPeerChannelFromMessage={_='inputPeerChannelFromMessage', peer=InputPeer, msg_id=int, channel_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPeerChat.md b/old_docs/API_docs_v109/constructors/inputPeerChat.md new file mode 100644 index 00000000..5800eda5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPeerChat.md @@ -0,0 +1,38 @@ +--- +title: inputPeerChat +description: Defines a chat for further interaction. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerChat +[Back to constructors index](index.md) + + + +Defines a chat for further interaction. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|Chat idientifier| + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +```php +$inputPeerChat = ['_' => 'inputPeerChat', 'chat_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputPeerChat={_='inputPeerChat', chat_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPeerEmpty.md b/old_docs/API_docs_v109/constructors/inputPeerEmpty.md new file mode 100644 index 00000000..71ac627b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPeerEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputPeerEmpty +description: An empty constructor, no user or chat is defined. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerEmpty +[Back to constructors index](index.md) + + + +An empty constructor, no user or chat is defined. + + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +```php +$inputPeerEmpty = ['_' => 'inputPeerEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputPeerEmpty={_='inputPeerEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPeerNotifySettings.md b/old_docs/API_docs_v109/constructors/inputPeerNotifySettings.md new file mode 100644 index 00000000..780e7a16 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPeerNotifySettings.md @@ -0,0 +1,41 @@ +--- +title: inputPeerNotifySettings +description: Notification settings. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerNotifySettings +[Back to constructors index](index.md) + + + +Notification settings. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|show\_previews|[Bool](../types/Bool.md) | Optional|If the text of the message shall be displayed in notification| +|silent|[Bool](../types/Bool.md) | Optional|Peer was muted?| +|mute\_until|[int](../types/int.md) | Optional|Date until which all notifications shall be switched off| +|sound|[string](../types/string.md) | Optional|Name of an audio file for notification| + + + +### Type: [InputPeerNotifySettings](../types/InputPeerNotifySettings.md) + + +### Example: + +```php +$inputPeerNotifySettings = ['_' => 'inputPeerNotifySettings', 'show_previews' => Bool, 'silent' => Bool, 'mute_until' => int, 'sound' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputPeerNotifySettings={_='inputPeerNotifySettings', show_previews=Bool, silent=Bool, mute_until=int, sound='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPeerPhotoFileLocation.md b/old_docs/API_docs_v109/constructors/inputPeerPhotoFileLocation.md new file mode 100644 index 00000000..f6816693 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPeerPhotoFileLocation.md @@ -0,0 +1,41 @@ +--- +title: inputPeerPhotoFileLocation +description: Location of profile photo of channel/group/supergroup/user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerPhotoFileLocation +[Back to constructors index](index.md) + + + +Location of profile photo of channel/group/supergroup/user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|big|[Bool](../types/Bool.md) | Optional|Whether to download the high-quality version of the picture| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer whose profile picture should be downloaded| +|volume\_id|[long](../types/long.md) | Yes|Volume ID from [FileLocation](../types/FileLocation.md) met in the profile photo container.| +|local\_id|[int](../types/int.md) | Yes|Local ID from [FileLocation](../types/FileLocation.md) met in the profile photo container.| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputPeerPhotoFileLocation = ['_' => 'inputPeerPhotoFileLocation', 'big' => Bool, 'peer' => InputPeer, 'volume_id' => long, 'local_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputPeerPhotoFileLocation={_='inputPeerPhotoFileLocation', big=Bool, peer=InputPeer, volume_id=long, local_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPeerSelf.md b/old_docs/API_docs_v109/constructors/inputPeerSelf.md new file mode 100644 index 00000000..880dd605 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPeerSelf.md @@ -0,0 +1,33 @@ +--- +title: inputPeerSelf +description: Defines the current user. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerSelf +[Back to constructors index](index.md) + + + +Defines the current user. + + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +```php +$inputPeerSelf = ['_' => 'inputPeerSelf']; +``` + + +Or, if you're into Lua: + +```lua +inputPeerSelf={_='inputPeerSelf'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPeerUser.md b/old_docs/API_docs_v109/constructors/inputPeerUser.md new file mode 100644 index 00000000..f91a42c8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPeerUser.md @@ -0,0 +1,39 @@ +--- +title: inputPeerUser +description: Defines a user for further interaction. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerUser +[Back to constructors index](index.md) + + + +Defines a user for further interaction. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|access\_hash|[long](../types/long.md) | Yes|**access\_hash** value from the [user](../constructors/user.md) constructor| + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +```php +$inputPeerUser = ['_' => 'inputPeerUser', 'user_id' => int, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputPeerUser={_='inputPeerUser', user_id=int, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPeerUserFromMessage.md b/old_docs/API_docs_v109/constructors/inputPeerUserFromMessage.md new file mode 100644 index 00000000..b5d5a676 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPeerUserFromMessage.md @@ -0,0 +1,40 @@ +--- +title: inputPeerUserFromMessage +description: Defines a [min](https://core.telegram.org/api/min) user that was seen in a certain message of a certain chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPeerUserFromMessage +[Back to constructors index](index.md) + + + +Defines a [min](https://core.telegram.org/api/min) user that was seen in a certain message of a certain chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the user was seen| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|user\_id|[int](../types/int.md) | Yes|The identifier of the user that was seen| + + + +### Type: [InputPeer](../types/InputPeer.md) + + +### Example: + +```php +$inputPeerUserFromMessage = ['_' => 'inputPeerUserFromMessage', 'peer' => InputPeer, 'msg_id' => int, 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputPeerUserFromMessage={_='inputPeerUserFromMessage', peer=InputPeer, msg_id=int, user_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPhoneCall.md b/old_docs/API_docs_v109/constructors/inputPhoneCall.md new file mode 100644 index 00000000..c0f2fc09 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPhoneCall.md @@ -0,0 +1,39 @@ +--- +title: inputPhoneCall +description: Phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhoneCall +[Back to constructors index](index.md) + + + +Phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Call ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| + + + +### Type: [InputPhoneCall](../types/InputPhoneCall.md) + + +### Example: + +```php +$inputPhoneCall = ['_' => 'inputPhoneCall', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputPhoneCall={_='inputPhoneCall', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPhoneContact.md b/old_docs/API_docs_v109/constructors/inputPhoneContact.md new file mode 100644 index 00000000..c3e2a258 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPhoneContact.md @@ -0,0 +1,41 @@ +--- +title: inputPhoneContact +description: Phone contact. The `client_id` is just an arbitrary contact ID: it should be set, for example, to an incremental number when using [contacts.importContacts](../methods/contacts.importContacts.md), in order to retry importing only the contacts that weren't imported successfully. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhoneContact +[Back to constructors index](index.md) + + + +Phone contact. The `client_id` is just an arbitrary contact ID: it should be set, for example, to an incremental number when using [contacts.importContacts](../methods/contacts.importContacts.md), in order to retry importing only the contacts that weren't imported successfully. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|client\_id|[long](../types/long.md) | Yes|User identifier on the client| +|phone|[string](../types/string.md) | Yes|Phone number| +|first\_name|[string](../types/string.md) | Yes|Contact's first name| +|last\_name|[string](../types/string.md) | Yes|Contact's last name| + + + +### Type: [InputContact](../types/InputContact.md) + + +### Example: + +```php +$inputPhoneContact = ['_' => 'inputPhoneContact', 'client_id' => long, 'phone' => 'string', 'first_name' => 'string', 'last_name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputPhoneContact={_='inputPhoneContact', client_id=long, phone='string', first_name='string', last_name='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPhoto.md b/old_docs/API_docs_v109/constructors/inputPhoto.md new file mode 100644 index 00000000..6064993f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPhoto.md @@ -0,0 +1,40 @@ +--- +title: inputPhoto +description: Defines a photo for further interaction. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhoto +[Back to constructors index](index.md) + + + +Defines a photo for further interaction. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Photo identifier| +|access\_hash|[long](../types/long.md) | Yes|**access\_hash** value from the [photo](../constructors/photo.md) constructor| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| + + + +### Type: [InputPhoto](../types/InputPhoto.md) + + +### Example: + +```php +$inputPhoto = ['_' => 'inputPhoto', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +inputPhoto={_='inputPhoto', id=long, access_hash=long, file_reference='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPhotoEmpty.md b/old_docs/API_docs_v109/constructors/inputPhotoEmpty.md new file mode 100644 index 00000000..fdc7a275 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPhotoEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputPhotoEmpty +description: Empty constructor. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhotoEmpty +[Back to constructors index](index.md) + + + +Empty constructor. + + + + +### Type: [InputPhoto](../types/InputPhoto.md) + + +### Example: + +```php +$inputPhotoEmpty = ['_' => 'inputPhotoEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputPhotoEmpty={_='inputPhotoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPhotoFileLocation.md b/old_docs/API_docs_v109/constructors/inputPhotoFileLocation.md new file mode 100644 index 00000000..908b4abe --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPhotoFileLocation.md @@ -0,0 +1,41 @@ +--- +title: inputPhotoFileLocation +description: Use this object to download a photo with [upload.getFile](../methods/upload.getFile.md) method +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhotoFileLocation +[Back to constructors index](index.md) + + + +Use this object to download a photo with [upload.getFile](../methods/upload.getFile.md) method + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Photo ID, obtained from the [photo](../constructors/photo.md) object| +|access\_hash|[long](../types/long.md) | Yes|Photo's access hash, obtained from the [photo](../constructors/photo.md) object| +|file\_reference|[bytes](../types/bytes.md) | Yes|[File reference](https://core.telegram.org/api/file_reference)| +|thumb\_size|[string](../types/string.md) | Yes|The [PhotoSize](../types/PhotoSize.md) to download: must be set to the `type` field of the desired PhotoSize object of the [photo](../constructors/photo.md)| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputPhotoFileLocation = ['_' => 'inputPhotoFileLocation', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'thumb_size' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputPhotoFileLocation={_='inputPhotoFileLocation', id=long, access_hash=long, file_reference='bytes', thumb_size='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPhotoLegacyFileLocation.md b/old_docs/API_docs_v109/constructors/inputPhotoLegacyFileLocation.md new file mode 100644 index 00000000..b1cdc68b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPhotoLegacyFileLocation.md @@ -0,0 +1,43 @@ +--- +title: inputPhotoLegacyFileLocation +description: Legacy file location +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPhotoLegacyFileLocation +[Back to constructors index](index.md) + + + +Legacy file location + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Photo ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|file\_reference|[bytes](../types/bytes.md) | Yes|File reference| +|volume\_id|[long](../types/long.md) | Yes|Volume ID| +|local\_id|[int](../types/int.md) | Yes|Local ID| +|secret|[long](../types/long.md) | Yes|Secret| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputPhotoLegacyFileLocation = ['_' => 'inputPhotoLegacyFileLocation', 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'volume_id' => long, 'local_id' => int, 'secret' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputPhotoLegacyFileLocation={_='inputPhotoLegacyFileLocation', id=long, access_hash=long, file_reference='bytes', volume_id=long, local_id=int, secret=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyKeyAddedByPhone.md b/old_docs/API_docs_v109/constructors/inputPrivacyKeyAddedByPhone.md new file mode 100644 index 00000000..e0ed36bb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyKeyAddedByPhone.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyAddedByPhone +description: Whether people can add you to their contact list by your phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyAddedByPhone +[Back to constructors index](index.md) + + + +Whether people can add you to their contact list by your phone number + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyAddedByPhone = ['_' => 'inputPrivacyKeyAddedByPhone']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyAddedByPhone={_='inputPrivacyKeyAddedByPhone'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyKeyChatInvite.md b/old_docs/API_docs_v109/constructors/inputPrivacyKeyChatInvite.md new file mode 100644 index 00000000..8540d520 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyKeyChatInvite.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyChatInvite +description: Whether the user can be invited to chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyChatInvite +[Back to constructors index](index.md) + + + +Whether the user can be invited to chats + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyChatInvite = ['_' => 'inputPrivacyKeyChatInvite']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyChatInvite={_='inputPrivacyKeyChatInvite'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyKeyForwards.md b/old_docs/API_docs_v109/constructors/inputPrivacyKeyForwards.md new file mode 100644 index 00000000..3731887a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyKeyForwards.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyForwards +description: Whether messages forwarded from this user will be [anonymous](https://telegram.org/blog/unsend-privacy-emoji#anonymous-forwarding) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyForwards +[Back to constructors index](index.md) + + + +Whether messages forwarded from this user will be [anonymous](https://telegram.org/blog/unsend-privacy-emoji#anonymous-forwarding) + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyForwards = ['_' => 'inputPrivacyKeyForwards']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyForwards={_='inputPrivacyKeyForwards'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneCall.md b/old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneCall.md new file mode 100644 index 00000000..65198433 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneCall.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyPhoneCall +description: Whether the user will accept phone calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyPhoneCall +[Back to constructors index](index.md) + + + +Whether the user will accept phone calls + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyPhoneCall = ['_' => 'inputPrivacyKeyPhoneCall']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyPhoneCall={_='inputPrivacyKeyPhoneCall'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneNumber.md b/old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneNumber.md new file mode 100644 index 00000000..ef715dbf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneNumber.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyPhoneNumber +description: Whether people will be able to see the user's phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyPhoneNumber +[Back to constructors index](index.md) + + + +Whether people will be able to see the user's phone number + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyPhoneNumber = ['_' => 'inputPrivacyKeyPhoneNumber']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyPhoneNumber={_='inputPrivacyKeyPhoneNumber'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneP2P.md b/old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneP2P.md new file mode 100644 index 00000000..8bec8a77 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyKeyPhoneP2P.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyPhoneP2P +description: Whether the user allows P2P communication during VoIP calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyPhoneP2P +[Back to constructors index](index.md) + + + +Whether the user allows P2P communication during VoIP calls + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyPhoneP2P = ['_' => 'inputPrivacyKeyPhoneP2P']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyPhoneP2P={_='inputPrivacyKeyPhoneP2P'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyKeyProfilePhoto.md b/old_docs/API_docs_v109/constructors/inputPrivacyKeyProfilePhoto.md new file mode 100644 index 00000000..ece82c63 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyKeyProfilePhoto.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyProfilePhoto +description: Whether people will be able to see the user's profile picture +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyProfilePhoto +[Back to constructors index](index.md) + + + +Whether people will be able to see the user's profile picture + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyProfilePhoto = ['_' => 'inputPrivacyKeyProfilePhoto']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyProfilePhoto={_='inputPrivacyKeyProfilePhoto'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyKeyStatusTimestamp.md b/old_docs/API_docs_v109/constructors/inputPrivacyKeyStatusTimestamp.md new file mode 100644 index 00000000..353763c3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyKeyStatusTimestamp.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyKeyStatusTimestamp +description: Whether we can see the exact last online timestamp of the user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyKeyStatusTimestamp +[Back to constructors index](index.md) + + + +Whether we can see the exact last online timestamp of the user + + + + +### Type: [InputPrivacyKey](../types/InputPrivacyKey.md) + + +### Example: + +```php +$inputPrivacyKeyStatusTimestamp = ['_' => 'inputPrivacyKeyStatusTimestamp']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyKeyStatusTimestamp={_='inputPrivacyKeyStatusTimestamp'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowAll.md b/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowAll.md new file mode 100644 index 00000000..ad24998a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowAll.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyValueAllowAll +description: Allow all users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueAllowAll +[Back to constructors index](index.md) + + + +Allow all users + + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +```php +$inputPrivacyValueAllowAll = ['_' => 'inputPrivacyValueAllowAll']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyValueAllowAll={_='inputPrivacyValueAllowAll'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowChatParticipants.md b/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowChatParticipants.md new file mode 100644 index 00000000..074a4747 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowChatParticipants.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyValueAllowChatParticipants +description: Allow only participants of certain chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueAllowChatParticipants +[Back to constructors index](index.md) + + + +Allow only participants of certain chats + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chats|Array of [int](../types/int.md) | Yes|Chats| + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +```php +$inputPrivacyValueAllowChatParticipants = ['_' => 'inputPrivacyValueAllowChatParticipants', 'chats' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyValueAllowChatParticipants={_='inputPrivacyValueAllowChatParticipants', chats={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowContacts.md b/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowContacts.md new file mode 100644 index 00000000..176ef62c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowContacts.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyValueAllowContacts +description: Allow only contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueAllowContacts +[Back to constructors index](index.md) + + + +Allow only contacts + + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +```php +$inputPrivacyValueAllowContacts = ['_' => 'inputPrivacyValueAllowContacts']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyValueAllowContacts={_='inputPrivacyValueAllowContacts'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowUsers.md b/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowUsers.md new file mode 100644 index 00000000..7edf1c49 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyValueAllowUsers.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyValueAllowUsers +description: Allow only certain users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueAllowUsers +[Back to constructors index](index.md) + + + +Allow only certain users + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|Users| + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +```php +$inputPrivacyValueAllowUsers = ['_' => 'inputPrivacyValueAllowUsers', 'users' => [InputUser, InputUser]]; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyValueAllowUsers={_='inputPrivacyValueAllowUsers', users={InputUser}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowAll.md b/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowAll.md new file mode 100644 index 00000000..cddd9f41 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowAll.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyValueDisallowAll +description: Disallow all +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueDisallowAll +[Back to constructors index](index.md) + + + +Disallow all + + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +```php +$inputPrivacyValueDisallowAll = ['_' => 'inputPrivacyValueDisallowAll']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyValueDisallowAll={_='inputPrivacyValueDisallowAll'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowChatParticipants.md b/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowChatParticipants.md new file mode 100644 index 00000000..cebc9724 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowChatParticipants.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyValueDisallowChatParticipants +description: Disallow only participants of certain chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueDisallowChatParticipants +[Back to constructors index](index.md) + + + +Disallow only participants of certain chats + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chats|Array of [int](../types/int.md) | Yes|CHats| + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +```php +$inputPrivacyValueDisallowChatParticipants = ['_' => 'inputPrivacyValueDisallowChatParticipants', 'chats' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyValueDisallowChatParticipants={_='inputPrivacyValueDisallowChatParticipants', chats={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowContacts.md b/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowContacts.md new file mode 100644 index 00000000..2d4a8337 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowContacts.md @@ -0,0 +1,33 @@ +--- +title: inputPrivacyValueDisallowContacts +description: Disallow only contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueDisallowContacts +[Back to constructors index](index.md) + + + +Disallow only contacts + + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +```php +$inputPrivacyValueDisallowContacts = ['_' => 'inputPrivacyValueDisallowContacts']; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyValueDisallowContacts={_='inputPrivacyValueDisallowContacts'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowUsers.md b/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowUsers.md new file mode 100644 index 00000000..e3015589 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputPrivacyValueDisallowUsers.md @@ -0,0 +1,38 @@ +--- +title: inputPrivacyValueDisallowUsers +description: Disallow only certain users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputPrivacyValueDisallowUsers +[Back to constructors index](index.md) + + + +Disallow only certain users + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|Users| + + + +### Type: [InputPrivacyRule](../types/InputPrivacyRule.md) + + +### Example: + +```php +$inputPrivacyValueDisallowUsers = ['_' => 'inputPrivacyValueDisallowUsers', 'users' => [InputUser, InputUser]]; +``` + + +Or, if you're into Lua: + +```lua +inputPrivacyValueDisallowUsers={_='inputPrivacyValueDisallowUsers', users={InputUser}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputReportReasonChildAbuse.md b/old_docs/API_docs_v109/constructors/inputReportReasonChildAbuse.md new file mode 100644 index 00000000..8e71704b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputReportReasonChildAbuse.md @@ -0,0 +1,33 @@ +--- +title: inputReportReasonChildAbuse +description: Report for child abuse +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonChildAbuse +[Back to constructors index](index.md) + + + +Report for child abuse + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +```php +$inputReportReasonChildAbuse = ['_' => 'inputReportReasonChildAbuse']; +``` + + +Or, if you're into Lua: + +```lua +inputReportReasonChildAbuse={_='inputReportReasonChildAbuse'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputReportReasonCopyright.md b/old_docs/API_docs_v109/constructors/inputReportReasonCopyright.md new file mode 100644 index 00000000..96575a8c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputReportReasonCopyright.md @@ -0,0 +1,33 @@ +--- +title: inputReportReasonCopyright +description: Report for copyrighted content +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonCopyright +[Back to constructors index](index.md) + + + +Report for copyrighted content + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +```php +$inputReportReasonCopyright = ['_' => 'inputReportReasonCopyright']; +``` + + +Or, if you're into Lua: + +```lua +inputReportReasonCopyright={_='inputReportReasonCopyright'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputReportReasonGeoIrrelevant.md b/old_docs/API_docs_v109/constructors/inputReportReasonGeoIrrelevant.md new file mode 100644 index 00000000..c66b64b2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputReportReasonGeoIrrelevant.md @@ -0,0 +1,33 @@ +--- +title: inputReportReasonGeoIrrelevant +description: Report an irrelevant geogroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonGeoIrrelevant +[Back to constructors index](index.md) + + + +Report an irrelevant geogroup + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +```php +$inputReportReasonGeoIrrelevant = ['_' => 'inputReportReasonGeoIrrelevant']; +``` + + +Or, if you're into Lua: + +```lua +inputReportReasonGeoIrrelevant={_='inputReportReasonGeoIrrelevant'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputReportReasonOther.md b/old_docs/API_docs_v109/constructors/inputReportReasonOther.md new file mode 100644 index 00000000..be96ba89 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputReportReasonOther.md @@ -0,0 +1,38 @@ +--- +title: inputReportReasonOther +description: Other +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonOther +[Back to constructors index](index.md) + + + +Other + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Other report reason| + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +```php +$inputReportReasonOther = ['_' => 'inputReportReasonOther', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputReportReasonOther={_='inputReportReasonOther', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputReportReasonPornography.md b/old_docs/API_docs_v109/constructors/inputReportReasonPornography.md new file mode 100644 index 00000000..5dcd578a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputReportReasonPornography.md @@ -0,0 +1,33 @@ +--- +title: inputReportReasonPornography +description: Report for pornography +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonPornography +[Back to constructors index](index.md) + + + +Report for pornography + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +```php +$inputReportReasonPornography = ['_' => 'inputReportReasonPornography']; +``` + + +Or, if you're into Lua: + +```lua +inputReportReasonPornography={_='inputReportReasonPornography'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputReportReasonSpam.md b/old_docs/API_docs_v109/constructors/inputReportReasonSpam.md new file mode 100644 index 00000000..2befc7f1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputReportReasonSpam.md @@ -0,0 +1,33 @@ +--- +title: inputReportReasonSpam +description: Report for spam +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonSpam +[Back to constructors index](index.md) + + + +Report for spam + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +```php +$inputReportReasonSpam = ['_' => 'inputReportReasonSpam']; +``` + + +Or, if you're into Lua: + +```lua +inputReportReasonSpam={_='inputReportReasonSpam'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputReportReasonViolence.md b/old_docs/API_docs_v109/constructors/inputReportReasonViolence.md new file mode 100644 index 00000000..c7b8e887 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputReportReasonViolence.md @@ -0,0 +1,33 @@ +--- +title: inputReportReasonViolence +description: Report for violence +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputReportReasonViolence +[Back to constructors index](index.md) + + + +Report for violence + + + + +### Type: [ReportReason](../types/ReportReason.md) + + +### Example: + +```php +$inputReportReasonViolence = ['_' => 'inputReportReasonViolence']; +``` + + +Or, if you're into Lua: + +```lua +inputReportReasonViolence={_='inputReportReasonViolence'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputSecureFile.md b/old_docs/API_docs_v109/constructors/inputSecureFile.md new file mode 100644 index 00000000..80552121 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputSecureFile.md @@ -0,0 +1,39 @@ +--- +title: inputSecureFile +description: Preuploaded [passport](https://core.telegram.org/passport) file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureFile +[Back to constructors index](index.md) + + + +Preuploaded [passport](https://core.telegram.org/passport) file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Secure file ID| +|access\_hash|[long](../types/long.md) | Yes|Secure file access hash| + + + +### Type: [InputSecureFile](../types/InputSecureFile.md) + + +### Example: + +```php +$inputSecureFile = ['_' => 'inputSecureFile', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputSecureFile={_='inputSecureFile', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputSecureFileLocation.md b/old_docs/API_docs_v109/constructors/inputSecureFileLocation.md new file mode 100644 index 00000000..7002f48d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputSecureFileLocation.md @@ -0,0 +1,39 @@ +--- +title: inputSecureFileLocation +description: Location of encrypted telegram [passport](https://core.telegram.org/passport) file. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureFileLocation +[Back to constructors index](index.md) + + + +Location of encrypted telegram [passport](https://core.telegram.org/passport) file. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|File ID, **id** parameter value from [secureFile](../constructors/secureFile.md)| +|access\_hash|[long](../types/long.md) | Yes|Checksum, **access\_hash** parameter value from [secureFile](../constructors/secureFile.md)| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputSecureFileLocation = ['_' => 'inputSecureFileLocation', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputSecureFileLocation={_='inputSecureFileLocation', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputSecureFileUploaded.md b/old_docs/API_docs_v109/constructors/inputSecureFileUploaded.md new file mode 100644 index 00000000..51a9c5db --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputSecureFileUploaded.md @@ -0,0 +1,42 @@ +--- +title: inputSecureFileUploaded +description: Uploaded secure file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureFileUploaded +[Back to constructors index](index.md) + + + +Uploaded secure file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Secure file ID| +|parts|[int](../types/int.md) | Yes|Secure file part count| +|md5\_checksum|[string](../types/string.md) | Yes|MD5 hash of encrypted uploaded file, to be checked server-side| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|secret|[bytes](../types/bytes.md) | Yes|Secret| + + + +### Type: [InputSecureFile](../types/InputSecureFile.md) + + +### Example: + +```php +$inputSecureFileUploaded = ['_' => 'inputSecureFileUploaded', 'id' => long, 'parts' => int, 'md5_checksum' => 'string', 'file_hash' => 'bytes', 'secret' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +inputSecureFileUploaded={_='inputSecureFileUploaded', id=long, parts=int, md5_checksum='string', file_hash='bytes', secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputSecureValue.md b/old_docs/API_docs_v109/constructors/inputSecureValue.md new file mode 100644 index 00000000..95fd9b81 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputSecureValue.md @@ -0,0 +1,45 @@ +--- +title: inputSecureValue +description: Secure value, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSecureValue +[Back to constructors index](index.md) + + + +Secure value, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|Secure [passport](https://core.telegram.org/passport) value type| +|data|[SecureData](../types/SecureData.md) | Optional|Encrypted [Telegram Passport](https://core.telegram.org/passport) element data| +|front\_side|[InputSecureFile](../types/InputSecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with the front side of the document| +|reverse\_side|[InputSecureFile](../types/InputSecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with the reverse side of the document| +|selfie|[InputSecureFile](../types/InputSecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with a selfie of the user holding the document| +|translation|Array of [InputSecureFile](../types/InputSecureFile.md) | Optional|Translation| +|files|Array of [InputSecureFile](../types/InputSecureFile.md) | Optional|Files| +|plain\_data|[SecurePlainData](../types/SecurePlainData.md) | Optional|Plaintext verified [passport](https://core.telegram.org/passport) data| + + + +### Type: [InputSecureValue](../types/InputSecureValue.md) + + +### Example: + +```php +$inputSecureValue = ['_' => 'inputSecureValue', 'type' => SecureValueType, 'data' => SecureData, 'front_side' => InputSecureFile, 'reverse_side' => InputSecureFile, 'selfie' => InputSecureFile, 'translation' => [InputSecureFile, InputSecureFile], 'files' => [InputSecureFile, InputSecureFile], 'plain_data' => SecurePlainData]; +``` + + +Or, if you're into Lua: + +```lua +inputSecureValue={_='inputSecureValue', type=SecureValueType, data=SecureData, front_side=InputSecureFile, reverse_side=InputSecureFile, selfie=InputSecureFile, translation={InputSecureFile}, files={InputSecureFile}, plain_data=SecurePlainData} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputSingleMedia.md b/old_docs/API_docs_v109/constructors/inputSingleMedia.md new file mode 100644 index 00000000..b152fb0f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputSingleMedia.md @@ -0,0 +1,40 @@ +--- +title: inputSingleMedia +description: A single media in an album sent with [messages.sendMultiMedia](../methods/messages.sendMultiMedia.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputSingleMedia +[Back to constructors index](index.md) + + + +A single media in an album sent with [messages.sendMultiMedia](../methods/messages.sendMultiMedia.md). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[MessageMedia, Message, Update or InputMedia](../types/InputMedia.md) | Optional|The media| +|message|[string](../types/string.md) | Yes|A caption for the media| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| + + + +### Type: [InputSingleMedia](../types/InputSingleMedia.md) + + +### Example: + +```php +$inputSingleMedia = ['_' => 'inputSingleMedia', 'media' => InputMedia, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity]]; +``` + + +Or, if you're into Lua: + +```lua +inputSingleMedia={_='inputSingleMedia', media=InputMedia, message='string', entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputStickerSetAnimatedEmoji.md b/old_docs/API_docs_v109/constructors/inputStickerSetAnimatedEmoji.md new file mode 100644 index 00000000..61e5c133 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputStickerSetAnimatedEmoji.md @@ -0,0 +1,33 @@ +--- +title: inputStickerSetAnimatedEmoji +description: Animated emojis stickerset +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetAnimatedEmoji +[Back to constructors index](index.md) + + + +Animated emojis stickerset + + + + +### Type: [InputStickerSet](../types/InputStickerSet.md) + + +### Example: + +```php +$inputStickerSetAnimatedEmoji = ['_' => 'inputStickerSetAnimatedEmoji']; +``` + + +Or, if you're into Lua: + +```lua +inputStickerSetAnimatedEmoji={_='inputStickerSetAnimatedEmoji'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputStickerSetEmpty.md b/old_docs/API_docs_v109/constructors/inputStickerSetEmpty.md new file mode 100644 index 00000000..256badc9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputStickerSetEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputStickerSetEmpty +description: Empty constructor +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetEmpty +[Back to constructors index](index.md) + + + +Empty constructor + + + + +### Type: [InputStickerSet](../types/InputStickerSet.md) + + +### Example: + +```php +$inputStickerSetEmpty = ['_' => 'inputStickerSetEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputStickerSetEmpty={_='inputStickerSetEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputStickerSetID.md b/old_docs/API_docs_v109/constructors/inputStickerSetID.md new file mode 100644 index 00000000..49af2c0e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputStickerSetID.md @@ -0,0 +1,39 @@ +--- +title: inputStickerSetID +description: Stickerset by ID +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetID +[Back to constructors index](index.md) + + + +Stickerset by ID + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| + + + +### Type: [InputStickerSet](../types/InputStickerSet.md) + + +### Example: + +```php +$inputStickerSetID = ['_' => 'inputStickerSetID', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputStickerSetID={_='inputStickerSetID', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputStickerSetItem.md b/old_docs/API_docs_v109/constructors/inputStickerSetItem.md new file mode 100644 index 00000000..b20cc934 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputStickerSetItem.md @@ -0,0 +1,40 @@ +--- +title: inputStickerSetItem +description: Sticker in a stickerset +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetItem +[Back to constructors index](index.md) + + + +Sticker in a stickerset + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|document|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|emoji|[string](../types/string.md) | Yes|Associated emoji| +|mask\_coords|[MaskCoords](../types/MaskCoords.md) | Optional|Coordinates for mask sticker| + + + +### Type: [InputStickerSetItem](../types/InputStickerSetItem.md) + + +### Example: + +```php +$inputStickerSetItem = ['_' => 'inputStickerSetItem', 'document' => InputDocument, 'emoji' => 'string', 'mask_coords' => MaskCoords]; +``` + + +Or, if you're into Lua: + +```lua +inputStickerSetItem={_='inputStickerSetItem', document=InputDocument, emoji='string', mask_coords=MaskCoords} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputStickerSetShortName.md b/old_docs/API_docs_v109/constructors/inputStickerSetShortName.md new file mode 100644 index 00000000..75726409 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputStickerSetShortName.md @@ -0,0 +1,38 @@ +--- +title: inputStickerSetShortName +description: Stickerset by short name, from `tg://addstickers?set=short_name` +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetShortName +[Back to constructors index](index.md) + + + +Stickerset by short name, from `tg://addstickers?set=short_name` + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|short\_name|[string](../types/string.md) | Yes|From `tg://addstickers?set=short_name`| + + + +### Type: [InputStickerSet](../types/InputStickerSet.md) + + +### Example: + +```php +$inputStickerSetShortName = ['_' => 'inputStickerSetShortName', 'short_name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputStickerSetShortName={_='inputStickerSetShortName', short_name='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputStickerSetThumb.md b/old_docs/API_docs_v109/constructors/inputStickerSetThumb.md new file mode 100644 index 00000000..7a7d730e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputStickerSetThumb.md @@ -0,0 +1,40 @@ +--- +title: inputStickerSetThumb +description: Location of stickerset thumbnail (see [files](https://core.telegram.org/api/files)) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickerSetThumb +[Back to constructors index](index.md) + + + +Location of stickerset thumbnail (see [files](https://core.telegram.org/api/files)) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|Sticker set| +|volume\_id|[long](../types/long.md) | Yes|Volume ID| +|local\_id|[int](../types/int.md) | Yes|Local ID| + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputStickerSetThumb = ['_' => 'inputStickerSetThumb', 'stickerset' => InputStickerSet, 'volume_id' => long, 'local_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputStickerSetThumb={_='inputStickerSetThumb', stickerset=InputStickerSet, volume_id=long, local_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputStickeredMediaDocument.md b/old_docs/API_docs_v109/constructors/inputStickeredMediaDocument.md new file mode 100644 index 00000000..a5f0aeed --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputStickeredMediaDocument.md @@ -0,0 +1,38 @@ +--- +title: inputStickeredMediaDocument +description: A document with stickers attached +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickeredMediaDocument +[Back to constructors index](index.md) + + + +A document with stickers attached + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Message, Update or InputDocument](../types/InputDocument.md) | Optional|The document| + + + +### Type: [InputStickeredMedia](../types/InputStickeredMedia.md) + + +### Example: + +```php +$inputStickeredMediaDocument = ['_' => 'inputStickeredMediaDocument', 'id' => InputDocument]; +``` + + +Or, if you're into Lua: + +```lua +inputStickeredMediaDocument={_='inputStickeredMediaDocument', id=InputDocument} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputStickeredMediaPhoto.md b/old_docs/API_docs_v109/constructors/inputStickeredMediaPhoto.md new file mode 100644 index 00000000..264365cd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputStickeredMediaPhoto.md @@ -0,0 +1,38 @@ +--- +title: inputStickeredMediaPhoto +description: A photo with stickers attached +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputStickeredMediaPhoto +[Back to constructors index](index.md) + + + +A photo with stickers attached + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Message, Update or InputPhoto](../types/InputPhoto.md) | Optional|The photo| + + + +### Type: [InputStickeredMedia](../types/InputStickeredMedia.md) + + +### Example: + +```php +$inputStickeredMediaPhoto = ['_' => 'inputStickeredMediaPhoto', 'id' => InputPhoto]; +``` + + +Or, if you're into Lua: + +```lua +inputStickeredMediaPhoto={_='inputStickeredMediaPhoto', id=InputPhoto} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputTakeoutFileLocation.md b/old_docs/API_docs_v109/constructors/inputTakeoutFileLocation.md new file mode 100644 index 00000000..98957405 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputTakeoutFileLocation.md @@ -0,0 +1,33 @@ +--- +title: inputTakeoutFileLocation +description: Empty constructor for takeout +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputTakeoutFileLocation +[Back to constructors index](index.md) + + + +Empty constructor for takeout + + + + +### Type: [InputFileLocation](../types/InputFileLocation.md) + + +### Example: + +```php +$inputTakeoutFileLocation = ['_' => 'inputTakeoutFileLocation']; +``` + + +Or, if you're into Lua: + +```lua +inputTakeoutFileLocation={_='inputTakeoutFileLocation'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputTheme.md b/old_docs/API_docs_v109/constructors/inputTheme.md new file mode 100644 index 00000000..d6b8b66f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputTheme.md @@ -0,0 +1,39 @@ +--- +title: inputTheme +description: Theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputTheme +[Back to constructors index](index.md) + + + +Theme + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| + + + +### Type: [InputTheme](../types/InputTheme.md) + + +### Example: + +```php +$inputTheme = ['_' => 'inputTheme', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputTheme={_='inputTheme', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputThemeSettings.md b/old_docs/API_docs_v109/constructors/inputThemeSettings.md new file mode 100644 index 00000000..4848c6fc --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputThemeSettings.md @@ -0,0 +1,41 @@ +--- +title: inputThemeSettings +description: inputThemeSettings attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputThemeSettings +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|base\_theme|[BaseTheme](../types/BaseTheme.md) | Yes| +|accent\_color|[int](../types/int.md) | Yes| +|message\_top\_color|[int](../types/int.md) | Optional| +|message\_bottom\_color|[int](../types/int.md) | Optional| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Optional| +|wallpaper\_settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional| + + + +### Type: [InputThemeSettings](../types/InputThemeSettings.md) + + +### Example: + +```php +$inputThemeSettings = ['_' => 'inputThemeSettings', 'base_theme' => BaseTheme, 'accent_color' => int, 'message_top_color' => int, 'message_bottom_color' => int, 'wallpaper' => InputWallPaper, 'wallpaper_settings' => WallPaperSettings]; +``` + + +Or, if you're into Lua: + +```lua +inputThemeSettings={_='inputThemeSettings', base_theme=BaseTheme, accent_color=int, message_top_color=int, message_bottom_color=int, wallpaper=InputWallPaper, wallpaper_settings=WallPaperSettings} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputThemeSlug.md b/old_docs/API_docs_v109/constructors/inputThemeSlug.md new file mode 100644 index 00000000..d7cdf470 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputThemeSlug.md @@ -0,0 +1,38 @@ +--- +title: inputThemeSlug +description: Theme by theme ID +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputThemeSlug +[Back to constructors index](index.md) + + + +Theme by theme ID + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|slug|[string](../types/string.md) | Yes|Unique theme ID| + + + +### Type: [InputTheme](../types/InputTheme.md) + + +### Example: + +```php +$inputThemeSlug = ['_' => 'inputThemeSlug', 'slug' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputThemeSlug={_='inputThemeSlug', slug='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputUser.md b/old_docs/API_docs_v109/constructors/inputUser.md new file mode 100644 index 00000000..3e5b934e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputUser.md @@ -0,0 +1,39 @@ +--- +title: inputUser +description: Defines a user for further interaction. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputUser +[Back to constructors index](index.md) + + + +Defines a user for further interaction. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|access\_hash|[long](../types/long.md) | Yes|**access\_hash** value from the [user](../constructors/user.md) constructor| + + + +### Type: [InputUser](../types/InputUser.md) + + +### Example: + +```php +$inputUser = ['_' => 'inputUser', 'user_id' => int, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputUser={_='inputUser', user_id=int, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputUserEmpty.md b/old_docs/API_docs_v109/constructors/inputUserEmpty.md new file mode 100644 index 00000000..6183b092 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputUserEmpty.md @@ -0,0 +1,33 @@ +--- +title: inputUserEmpty +description: Empty constructor, does not define a user. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputUserEmpty +[Back to constructors index](index.md) + + + +Empty constructor, does not define a user. + + + + +### Type: [InputUser](../types/InputUser.md) + + +### Example: + +```php +$inputUserEmpty = ['_' => 'inputUserEmpty']; +``` + + +Or, if you're into Lua: + +```lua +inputUserEmpty={_='inputUserEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputUserFromMessage.md b/old_docs/API_docs_v109/constructors/inputUserFromMessage.md new file mode 100644 index 00000000..2e8c152e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputUserFromMessage.md @@ -0,0 +1,40 @@ +--- +title: inputUserFromMessage +description: Defines a [min](https://core.telegram.org/api/min) user that was seen in a certain message of a certain chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputUserFromMessage +[Back to constructors index](index.md) + + + +Defines a [min](https://core.telegram.org/api/min) user that was seen in a certain message of a certain chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the user was seen| +|msg\_id|[int](../types/int.md) | Yes|The message ID| +|user\_id|[int](../types/int.md) | Yes|The identifier of the user that was seen| + + + +### Type: [InputUser](../types/InputUser.md) + + +### Example: + +```php +$inputUserFromMessage = ['_' => 'inputUserFromMessage', 'peer' => InputPeer, 'msg_id' => int, 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputUserFromMessage={_='inputUserFromMessage', peer=InputPeer, msg_id=int, user_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputUserSelf.md b/old_docs/API_docs_v109/constructors/inputUserSelf.md new file mode 100644 index 00000000..f84e1823 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputUserSelf.md @@ -0,0 +1,33 @@ +--- +title: inputUserSelf +description: Defines the current user. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputUserSelf +[Back to constructors index](index.md) + + + +Defines the current user. + + + + +### Type: [InputUser](../types/InputUser.md) + + +### Example: + +```php +$inputUserSelf = ['_' => 'inputUserSelf']; +``` + + +Or, if you're into Lua: + +```lua +inputUserSelf={_='inputUserSelf'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputWallPaper.md b/old_docs/API_docs_v109/constructors/inputWallPaper.md new file mode 100644 index 00000000..b4ca01ef --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputWallPaper.md @@ -0,0 +1,39 @@ +--- +title: inputWallPaper +description: Wallpaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWallPaper +[Back to constructors index](index.md) + + + +Wallpaper + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Wallpaper ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| + + + +### Type: [InputWallPaper](../types/InputWallPaper.md) + + +### Example: + +```php +$inputWallPaper = ['_' => 'inputWallPaper', 'id' => long, 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputWallPaper={_='inputWallPaper', id=long, access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputWallPaperNoFile.md b/old_docs/API_docs_v109/constructors/inputWallPaperNoFile.md new file mode 100644 index 00000000..8a28dccf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputWallPaperNoFile.md @@ -0,0 +1,31 @@ +--- +title: inputWallPaperNoFile +description: inputWallPaperNoFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWallPaperNoFile +[Back to constructors index](index.md) + + + + + + +### Type: [InputWallPaper](../types/InputWallPaper.md) + + +### Example: + +```php +$inputWallPaperNoFile = ['_' => 'inputWallPaperNoFile']; +``` + + +Or, if you're into Lua: + +```lua +inputWallPaperNoFile={_='inputWallPaperNoFile'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputWallPaperSlug.md b/old_docs/API_docs_v109/constructors/inputWallPaperSlug.md new file mode 100644 index 00000000..eb3def9f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputWallPaperSlug.md @@ -0,0 +1,38 @@ +--- +title: inputWallPaperSlug +description: Wallpaper by slug (a unique ID) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWallPaperSlug +[Back to constructors index](index.md) + + + +Wallpaper by slug (a unique ID) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|slug|[string](../types/string.md) | Yes|Unique wallpaper ID| + + + +### Type: [InputWallPaper](../types/InputWallPaper.md) + + +### Example: + +```php +$inputWallPaperSlug = ['_' => 'inputWallPaperSlug', 'slug' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +inputWallPaperSlug={_='inputWallPaperSlug', slug='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputWebDocument.md b/old_docs/API_docs_v109/constructors/inputWebDocument.md new file mode 100644 index 00000000..8c1e4956 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputWebDocument.md @@ -0,0 +1,41 @@ +--- +title: inputWebDocument +description: The document +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWebDocument +[Back to constructors index](index.md) + + + +The document + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Remote document URL to be downloaded using the appropriate [method](https://core.telegram.org/api/files)| +|size|[int](../types/int.md) | Yes|Remote file size| +|mime\_type|[string](../types/string.md) | Yes|Mime type| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes| + + + +### Type: [InputWebDocument](../types/InputWebDocument.md) + + +### Example: + +```php +$inputWebDocument = ['_' => 'inputWebDocument', 'url' => 'string', 'size' => int, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute]]; +``` + + +Or, if you're into Lua: + +```lua +inputWebDocument={_='inputWebDocument', url='string', size=int, mime_type='string', attributes={DocumentAttribute}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputWebFileGeoPointLocation.md b/old_docs/API_docs_v109/constructors/inputWebFileGeoPointLocation.md new file mode 100644 index 00000000..d9a5bd50 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputWebFileGeoPointLocation.md @@ -0,0 +1,43 @@ +--- +title: inputWebFileGeoPointLocation +description: Geolocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWebFileGeoPointLocation +[Back to constructors index](index.md) + + + +Geolocation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geolocation| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|w|[int](../types/int.md) | Yes|Map width in pixels before applying scale; 16-1024| +|h|[int](../types/int.md) | Yes|Map height in pixels before applying scale; 16-1024| +|zoom|[int](../types/int.md) | Yes|Map zoom level; 13-20| +|scale|[int](../types/int.md) | Yes|Map scale; 1-3| + + + +### Type: [InputWebFileLocation](../types/InputWebFileLocation.md) + + +### Example: + +```php +$inputWebFileGeoPointLocation = ['_' => 'inputWebFileGeoPointLocation', 'geo_point' => InputGeoPoint, 'access_hash' => long, 'w' => int, 'h' => int, 'zoom' => int, 'scale' => int]; +``` + + +Or, if you're into Lua: + +```lua +inputWebFileGeoPointLocation={_='inputWebFileGeoPointLocation', geo_point=InputGeoPoint, access_hash=long, w=int, h=int, zoom=int, scale=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/inputWebFileLocation.md b/old_docs/API_docs_v109/constructors/inputWebFileLocation.md new file mode 100644 index 00000000..23aa7632 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/inputWebFileLocation.md @@ -0,0 +1,39 @@ +--- +title: inputWebFileLocation +description: Location of a remote HTTP(s) file +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: inputWebFileLocation +[Back to constructors index](index.md) + + + +Location of a remote HTTP(s) file + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|HTTP URL of file| +|access\_hash|[long](../types/long.md) | Yes|Access hash| + + + +### Type: [InputWebFileLocation](../types/InputWebFileLocation.md) + + +### Example: + +```php +$inputWebFileLocation = ['_' => 'inputWebFileLocation', 'url' => 'string', 'access_hash' => long]; +``` + + +Or, if you're into Lua: + +```lua +inputWebFileLocation={_='inputWebFileLocation', url='string', access_hash=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/invoice.md b/old_docs/API_docs_v109/constructors/invoice.md new file mode 100644 index 00000000..16da52c7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/invoice.md @@ -0,0 +1,47 @@ +--- +title: invoice +description: Invoice +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: invoice +[Back to constructors index](index.md) + + + +Invoice + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|test|[Bool](../types/Bool.md) | Optional|Test invoice| +|name\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's full name to complete the order| +|phone\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's phone number to complete the order| +|email\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's email address to complete the order| +|shipping\_address\_requested|[Bool](../types/Bool.md) | Optional|Set this flag if you require the user's shipping address to complete the order| +|flexible|[Bool](../types/Bool.md) | Optional|Set this flag if the final price depends on the shipping method| +|phone\_to\_provider|[Bool](../types/Bool.md) | Optional|Set this flag if user's phone number should be sent to provider| +|email\_to\_provider|[Bool](../types/Bool.md) | Optional|Set this flag if user's email address should be sent to provider| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|prices|Array of [LabeledPrice](../types/LabeledPrice.md) | Yes|Prices| + + + +### Type: [Invoice](../types/Invoice.md) + + +### Example: + +```php +$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]]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/jsonArray.md b/old_docs/API_docs_v109/constructors/jsonArray.md new file mode 100644 index 00000000..bef235a2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/jsonArray.md @@ -0,0 +1,38 @@ +--- +title: jsonArray +description: JSON array +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonArray +[Back to constructors index](index.md) + + + +JSON array + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|Array of [JSONValue](../types/JSONValue.md) | Yes|Value| + + + +### Type: [JSONValue](../types/JSONValue.md) + + +### Example: + +```php +$jsonArray = ['_' => 'jsonArray', 'value' => [JSONValue, JSONValue]]; +``` + + +Or, if you're into Lua: + +```lua +jsonArray={_='jsonArray', value={JSONValue}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/jsonBool.md b/old_docs/API_docs_v109/constructors/jsonBool.md new file mode 100644 index 00000000..82f8f4c3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/jsonBool.md @@ -0,0 +1,38 @@ +--- +title: jsonBool +description: JSON boolean value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonBool +[Back to constructors index](index.md) + + + +JSON boolean value + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|[Bool](../types/Bool.md) | Yes|Value| + + + +### Type: [JSONValue](../types/JSONValue.md) + + +### Example: + +```php +$jsonBool = ['_' => 'jsonBool', 'value' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +jsonBool={_='jsonBool', value=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/jsonNull.md b/old_docs/API_docs_v109/constructors/jsonNull.md new file mode 100644 index 00000000..e542027d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/jsonNull.md @@ -0,0 +1,33 @@ +--- +title: jsonNull +description: Null JSON value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonNull +[Back to constructors index](index.md) + + + +Null JSON value + + + + +### Type: [JSONValue](../types/JSONValue.md) + + +### Example: + +```php +$jsonNull = ['_' => 'jsonNull']; +``` + + +Or, if you're into Lua: + +```lua +jsonNull={_='jsonNull'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/jsonNumber.md b/old_docs/API_docs_v109/constructors/jsonNumber.md new file mode 100644 index 00000000..5af7e3b6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/jsonNumber.md @@ -0,0 +1,38 @@ +--- +title: jsonNumber +description: JSON numeric value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonNumber +[Back to constructors index](index.md) + + + +JSON numeric value + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|[double](../types/double.md) | Yes|Value| + + + +### Type: [JSONValue](../types/JSONValue.md) + + +### Example: + +```php +$jsonNumber = ['_' => 'jsonNumber', 'value' => double]; +``` + + +Or, if you're into Lua: + +```lua +jsonNumber={_='jsonNumber', value=double} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/jsonObject.md b/old_docs/API_docs_v109/constructors/jsonObject.md new file mode 100644 index 00000000..9d6f1e56 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/jsonObject.md @@ -0,0 +1,38 @@ +--- +title: jsonObject +description: JSON object value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonObject +[Back to constructors index](index.md) + + + +JSON object value + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|Array of [JSONObjectValue](../types/JSONObjectValue.md) | Yes|Value| + + + +### Type: [JSONValue](../types/JSONValue.md) + + +### Example: + +```php +$jsonObject = ['_' => 'jsonObject', 'value' => [JSONObjectValue, JSONObjectValue]]; +``` + + +Or, if you're into Lua: + +```lua +jsonObject={_='jsonObject', value={JSONObjectValue}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/jsonObjectValue.md b/old_docs/API_docs_v109/constructors/jsonObjectValue.md new file mode 100644 index 00000000..56fa49e8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/jsonObjectValue.md @@ -0,0 +1,39 @@ +--- +title: jsonObjectValue +description: JSON key: value pair +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonObjectValue +[Back to constructors index](index.md) + + + +JSON key: value pair + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|key|[string](../types/string.md) | Yes|Key| +|value|[JSONValue](../types/JSONValue.md) | Yes|Value| + + + +### Type: [JSONObjectValue](../types/JSONObjectValue.md) + + +### Example: + +```php +$jsonObjectValue = ['_' => 'jsonObjectValue', 'key' => 'string', 'value' => JSONValue]; +``` + + +Or, if you're into Lua: + +```lua +jsonObjectValue={_='jsonObjectValue', key='string', value=JSONValue} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/jsonString.md b/old_docs/API_docs_v109/constructors/jsonString.md new file mode 100644 index 00000000..a6c052fa --- /dev/null +++ b/old_docs/API_docs_v109/constructors/jsonString.md @@ -0,0 +1,38 @@ +--- +title: jsonString +description: JSON string +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: jsonString +[Back to constructors index](index.md) + + + +JSON string + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|value|[string](../types/string.md) | Yes|Value| + + + +### Type: [JSONValue](../types/JSONValue.md) + + +### Example: + +```php +$jsonString = ['_' => 'jsonString', 'value' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +jsonString={_='jsonString', value='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/keyboardButton.md b/old_docs/API_docs_v109/constructors/keyboardButton.md new file mode 100644 index 00000000..0f15c87f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/keyboardButton.md @@ -0,0 +1,38 @@ +--- +title: keyboardButton +description: Bot keyboard button +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButton +[Back to constructors index](index.md) + + + +Bot keyboard button + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button text| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButton = ['_' => 'keyboardButton', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButton={_='keyboardButton', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/keyboardButtonBuy.md b/old_docs/API_docs_v109/constructors/keyboardButtonBuy.md new file mode 100644 index 00000000..d327d308 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/keyboardButtonBuy.md @@ -0,0 +1,38 @@ +--- +title: keyboardButtonBuy +description: Button to buy a product +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonBuy +[Back to constructors index](index.md) + + + +Button to buy a product + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button text| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonBuy = ['_' => 'keyboardButtonBuy', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonBuy={_='keyboardButtonBuy', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/keyboardButtonCallback.md b/old_docs/API_docs_v109/constructors/keyboardButtonCallback.md new file mode 100644 index 00000000..19251d80 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/keyboardButtonCallback.md @@ -0,0 +1,39 @@ +--- +title: keyboardButtonCallback +description: Callback button +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonCallback +[Back to constructors index](index.md) + + + +Callback button + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button text| +|data|[bytes](../types/bytes.md) | Yes|Callback data| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonCallback = ['_' => 'keyboardButtonCallback', 'text' => 'string', 'data' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonCallback={_='keyboardButtonCallback', text='string', data='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/keyboardButtonGame.md b/old_docs/API_docs_v109/constructors/keyboardButtonGame.md new file mode 100644 index 00000000..c9b6b121 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/keyboardButtonGame.md @@ -0,0 +1,38 @@ +--- +title: keyboardButtonGame +description: Button to start a game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonGame +[Back to constructors index](index.md) + + + +Button to start a game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button text| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonGame = ['_' => 'keyboardButtonGame', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonGame={_='keyboardButtonGame', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/keyboardButtonRequestGeoLocation.md b/old_docs/API_docs_v109/constructors/keyboardButtonRequestGeoLocation.md new file mode 100644 index 00000000..4dc969f1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/keyboardButtonRequestGeoLocation.md @@ -0,0 +1,38 @@ +--- +title: keyboardButtonRequestGeoLocation +description: Button to request a user's geolocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonRequestGeoLocation +[Back to constructors index](index.md) + + + +Button to request a user's geolocation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button text| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonRequestGeoLocation = ['_' => 'keyboardButtonRequestGeoLocation', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonRequestGeoLocation={_='keyboardButtonRequestGeoLocation', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/keyboardButtonRequestPhone.md b/old_docs/API_docs_v109/constructors/keyboardButtonRequestPhone.md new file mode 100644 index 00000000..14ec8e59 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/keyboardButtonRequestPhone.md @@ -0,0 +1,38 @@ +--- +title: keyboardButtonRequestPhone +description: Button to request a user's phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonRequestPhone +[Back to constructors index](index.md) + + + +Button to request a user's phone number + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button text| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonRequestPhone = ['_' => 'keyboardButtonRequestPhone', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonRequestPhone={_='keyboardButtonRequestPhone', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/keyboardButtonRequestPoll.md b/old_docs/API_docs_v109/constructors/keyboardButtonRequestPoll.md new file mode 100644 index 00000000..8cb6fb52 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/keyboardButtonRequestPoll.md @@ -0,0 +1,37 @@ +--- +title: keyboardButtonRequestPoll +description: keyboardButtonRequestPoll attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonRequestPoll +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|quiz|[Bool](../types/Bool.md) | Optional| +|text|[string](../types/string.md) | Yes| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonRequestPoll = ['_' => 'keyboardButtonRequestPoll', 'quiz' => Bool, 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonRequestPoll={_='keyboardButtonRequestPoll', quiz=Bool, text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/keyboardButtonRow.md b/old_docs/API_docs_v109/constructors/keyboardButtonRow.md new file mode 100644 index 00000000..f19537b3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/keyboardButtonRow.md @@ -0,0 +1,38 @@ +--- +title: keyboardButtonRow +description: Inline keyboard row +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonRow +[Back to constructors index](index.md) + + + +Inline keyboard row + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|buttons|Array of [KeyboardButton](../types/KeyboardButton.md) | Yes|Buttons| + + + +### Type: [KeyboardButtonRow](../types/KeyboardButtonRow.md) + + +### Example: + +```php +$keyboardButtonRow = ['_' => 'keyboardButtonRow', 'buttons' => [KeyboardButton, KeyboardButton]]; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonRow={_='keyboardButtonRow', buttons={KeyboardButton}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/keyboardButtonSwitchInline.md b/old_docs/API_docs_v109/constructors/keyboardButtonSwitchInline.md new file mode 100644 index 00000000..98deb2c1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/keyboardButtonSwitchInline.md @@ -0,0 +1,40 @@ +--- +title: keyboardButtonSwitchInline +description: Button to force a user to switch to inline mode Pressing the button will prompt the user to select one of their chats, open that chat and insert the bot‘s username and the specified inline query in the input field. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonSwitchInline +[Back to constructors index](index.md) + + + +Button to force a user to switch to inline mode Pressing the button will prompt the user to select one of their chats, open that chat and insert the bot‘s username and the specified inline query in the input field. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|same\_peer|[Bool](../types/Bool.md) | Optional|If set, pressing the button will insert the bot‘s username and the specified inline `query` in the current chat's input field.| +|text|[string](../types/string.md) | Yes|Button label| +|query|[string](../types/string.md) | Yes|The inline query to use| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonSwitchInline = ['_' => 'keyboardButtonSwitchInline', 'same_peer' => Bool, 'text' => 'string', 'query' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonSwitchInline={_='keyboardButtonSwitchInline', same_peer=Bool, text='string', query='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/keyboardButtonUrl.md b/old_docs/API_docs_v109/constructors/keyboardButtonUrl.md new file mode 100644 index 00000000..39589559 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/keyboardButtonUrl.md @@ -0,0 +1,39 @@ +--- +title: keyboardButtonUrl +description: URL button +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonUrl +[Back to constructors index](index.md) + + + +URL button + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button label| +|url|[string](../types/string.md) | Yes|URL| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonUrl = ['_' => 'keyboardButtonUrl', 'text' => 'string', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonUrl={_='keyboardButtonUrl', text='string', url='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/keyboardButtonUrlAuth.md b/old_docs/API_docs_v109/constructors/keyboardButtonUrlAuth.md new file mode 100644 index 00000000..29443267 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/keyboardButtonUrlAuth.md @@ -0,0 +1,41 @@ +--- +title: keyboardButtonUrlAuth +description: Button to request a user to authorize via URL using [Seamless Telegram Login](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots). When the user clicks on such a button, [messages.requestUrlAuth](../methods/messages.requestUrlAuth.md) should be called, providing the `button_id` and the ID of the container message. The returned [urlAuthResultRequest](../constructors/urlAuthResultRequest.md) object will contain more details about the authorization request (`request_write_access` if the bot would like to send messages to the user along with the username of the bot which will be used for user authorization). Finally, the user can choose to call [messages.acceptUrlAuth](../methods/messages.acceptUrlAuth.md) to get a [urlAuthResultAccepted](../constructors/urlAuthResultAccepted.md) with the URL to open instead of the `url` of this constructor, or a [urlAuthResultDefault](../constructors/urlAuthResultDefault.md), in which case the `url` of this constructor must be opened, instead. If the user refuses the authorization request but still wants to open the link, the `url` of this constructor must be used. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: keyboardButtonUrlAuth +[Back to constructors index](index.md) + + + +Button to request a user to authorize via URL using [Seamless Telegram Login](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots). When the user clicks on such a button, [messages.requestUrlAuth](../methods/messages.requestUrlAuth.md) should be called, providing the `button_id` and the ID of the container message. The returned [urlAuthResultRequest](../constructors/urlAuthResultRequest.md) object will contain more details about the authorization request (`request_write_access` if the bot would like to send messages to the user along with the username of the bot which will be used for user authorization). Finally, the user can choose to call [messages.acceptUrlAuth](../methods/messages.acceptUrlAuth.md) to get a [urlAuthResultAccepted](../constructors/urlAuthResultAccepted.md) with the URL to open instead of the `url` of this constructor, or a [urlAuthResultDefault](../constructors/urlAuthResultDefault.md), in which case the `url` of this constructor must be opened, instead. If the user refuses the authorization request but still wants to open the link, the `url` of this constructor must be used. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Button label| +|fwd\_text|[string](../types/string.md) | Optional|New text of the button in forwarded messages.| +|url|[string](../types/string.md) | Yes|An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in [Receiving authorization data](https://core.telegram.org/widgets/login#receiving-authorization-data).

**NOTE**: Services must **always** check the hash of the received data to verify the authentication and the integrity of the data as described in [Checking authorization](https://core.telegram.org/widgets/login#checking-authorization).| +|button\_id|[int](../types/int.md) | Yes|ID of the button to pass to [messages.requestUrlAuth](../methods/messages.requestUrlAuth.md)| + + + +### Type: [KeyboardButton](../types/KeyboardButton.md) + + +### Example: + +```php +$keyboardButtonUrlAuth = ['_' => 'keyboardButtonUrlAuth', 'text' => 'string', 'fwd_text' => 'string', 'url' => 'string', 'button_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +keyboardButtonUrlAuth={_='keyboardButtonUrlAuth', text='string', fwd_text='string', url='string', button_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/labeledPrice.md b/old_docs/API_docs_v109/constructors/labeledPrice.md new file mode 100644 index 00000000..5c33cec5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/labeledPrice.md @@ -0,0 +1,39 @@ +--- +title: labeledPrice +description: This object represents a portion of the price for goods or services. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: labeledPrice +[Back to constructors index](index.md) + + + +This object represents a portion of the price for goods or services. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|label|[string](../types/string.md) | Yes|Portion label| +|amount|[long](../types/long.md) | Yes|Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| + + + +### Type: [LabeledPrice](../types/LabeledPrice.md) + + +### Example: + +```php +$labeledPrice = ['_' => 'labeledPrice', 'label' => 'string', 'amount' => long]; +``` + + +Or, if you're into Lua: + +```lua +labeledPrice={_='labeledPrice', label='string', amount=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/langPackDifference.md b/old_docs/API_docs_v109/constructors/langPackDifference.md new file mode 100644 index 00000000..66dc624c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/langPackDifference.md @@ -0,0 +1,41 @@ +--- +title: langPackDifference +description: Changes to the app's localization pack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackDifference +[Back to constructors index](index.md) + + + +Changes to the app's localization pack + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[string](../types/string.md) | Yes|Language code| +|from\_version|[int](../types/int.md) | Yes|Previous version number| +|version|[int](../types/int.md) | Yes|New version number| +|strings|Array of [LangPackString](../types/LangPackString.md) | Yes|Strings| + + + +### Type: [LangPackDifference](../types/LangPackDifference.md) + + +### Example: + +```php +$langPackDifference = ['_' => 'langPackDifference', 'lang_code' => 'string', 'from_version' => int, 'version' => int, 'strings' => [LangPackString, LangPackString]]; +``` + + +Or, if you're into Lua: + +```lua +langPackDifference={_='langPackDifference', lang_code='string', from_version=int, version=int, strings={LangPackString}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/langPackLanguage.md b/old_docs/API_docs_v109/constructors/langPackLanguage.md new file mode 100644 index 00000000..8824132c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/langPackLanguage.md @@ -0,0 +1,48 @@ +--- +title: langPackLanguage +description: Identifies a localization pack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackLanguage +[Back to constructors index](index.md) + + + +Identifies a localization pack + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|official|[Bool](../types/Bool.md) | Optional|Whether the language pack is official| +|rtl|[Bool](../types/Bool.md) | Optional|Is this a localization pack for an RTL language| +|beta|[Bool](../types/Bool.md) | Optional|Is this a beta localization pack?| +|name|[string](../types/string.md) | Yes|Language name| +|native\_name|[string](../types/string.md) | Yes|Language name in the language itself| +|lang\_code|[string](../types/string.md) | Yes|Language code (pack identifier)| +|base\_lang\_code|[string](../types/string.md) | Optional|Identifier of a base language pack; may be empty. If a string is missed in the language pack, then it should be fetched from base language pack. Unsupported in custom language packs| +|plural\_code|[string](../types/string.md) | Yes|A language code to be used to apply plural forms. See [https://www.unicode.org/cldr/charts/latest/supplemental/language\_plural\_rules.html](https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html) for more info| +|strings\_count|[int](../types/int.md) | Yes|Total number of non-deleted strings from the language pack| +|translated\_count|[int](../types/int.md) | Yes|Total number of translated strings from the language pack| +|translations\_url|[string](../types/string.md) | Yes|Link to language translation interface; empty for custom local language packs| + + + +### Type: [LangPackLanguage](../types/LangPackLanguage.md) + + +### Example: + +```php +$langPackLanguage = ['_' => 'langPackLanguage', 'official' => Bool, 'rtl' => Bool, 'beta' => Bool, 'name' => 'string', 'native_name' => 'string', 'lang_code' => 'string', 'base_lang_code' => 'string', 'plural_code' => 'string', 'strings_count' => int, 'translated_count' => int, 'translations_url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +langPackLanguage={_='langPackLanguage', official=Bool, rtl=Bool, beta=Bool, name='string', native_name='string', lang_code='string', base_lang_code='string', plural_code='string', strings_count=int, translated_count=int, translations_url='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/langPackString.md b/old_docs/API_docs_v109/constructors/langPackString.md new file mode 100644 index 00000000..24e2537e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/langPackString.md @@ -0,0 +1,39 @@ +--- +title: langPackString +description: Translated localization string +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackString +[Back to constructors index](index.md) + + + +Translated localization string + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|key|[string](../types/string.md) | Yes|Language key| +|value|[string](../types/string.md) | Yes|Value| + + + +### Type: [LangPackString](../types/LangPackString.md) + + +### Example: + +```php +$langPackString = ['_' => 'langPackString', 'key' => 'string', 'value' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +langPackString={_='langPackString', key='string', value='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/langPackStringDeleted.md b/old_docs/API_docs_v109/constructors/langPackStringDeleted.md new file mode 100644 index 00000000..2c8cc573 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/langPackStringDeleted.md @@ -0,0 +1,38 @@ +--- +title: langPackStringDeleted +description: Deleted localization string +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackStringDeleted +[Back to constructors index](index.md) + + + +Deleted localization string + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|key|[string](../types/string.md) | Yes|Localization key| + + + +### Type: [LangPackString](../types/LangPackString.md) + + +### Example: + +```php +$langPackStringDeleted = ['_' => 'langPackStringDeleted', 'key' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +langPackStringDeleted={_='langPackStringDeleted', key='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/langPackStringPluralized.md b/old_docs/API_docs_v109/constructors/langPackStringPluralized.md new file mode 100644 index 00000000..dd0dc602 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/langPackStringPluralized.md @@ -0,0 +1,44 @@ +--- +title: langPackStringPluralized +description: A language pack string which has different forms based on the number of some object it mentions. See [https://www.unicode.org/cldr/charts/latest/supplemental/language\_plural\_rules.html](https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html) for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: langPackStringPluralized +[Back to constructors index](index.md) + + + +A language pack string which has different forms based on the number of some object it mentions. See [https://www.unicode.org/cldr/charts/latest/supplemental/language\_plural\_rules.html](https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html) for more info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|key|[string](../types/string.md) | Yes|Localization key| +|zero\_value|[string](../types/string.md) | Optional|Value for zero objects| +|one\_value|[string](../types/string.md) | Optional|Value for one object| +|two\_value|[string](../types/string.md) | Optional|Value for two objects| +|few\_value|[string](../types/string.md) | Optional|Value for a few objects| +|many\_value|[string](../types/string.md) | Optional|Value for many objects| +|other\_value|[string](../types/string.md) | Yes|Default value| + + + +### Type: [LangPackString](../types/LangPackString.md) + + +### Example: + +```php +$langPackStringPluralized = ['_' => '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: + +```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_v109/constructors/maskCoords.md b/old_docs/API_docs_v109/constructors/maskCoords.md new file mode 100644 index 00000000..eddc77b6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/maskCoords.md @@ -0,0 +1,55 @@ +--- +title: maskCoords +description: Position on a photo where a mask should be placed + +The `n` position indicates where the mask should be placed: + +- 0 => Relative to the forehead +- 1 => Relative to the eyes +- 2 => Relative to the mouth +- 3 => Relative to the chin +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: maskCoords +[Back to constructors index](index.md) + + + +Position on a photo where a mask should be placed + +The `n` position indicates where the mask should be placed: + +- 0 => Relative to the forehead +- 1 => Relative to the eyes +- 2 => Relative to the mouth +- 3 => Relative to the chin + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|n|[int](../types/int.md) | Yes|Part of the face, relative to which the mask should be placed| +|x|[double](../types/double.md) | Yes|Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. (For example, -1.0 will place the mask just to the left of the default mask position)| +|y|[double](../types/double.md) | Yes|Shift by Y-axis measured in widths of the mask scaled to the face size, from left to right. (For example, -1.0 will place the mask just to the left of the default mask position)| +|zoom|[double](../types/double.md) | Yes|Mask scaling coefficient. (For example, 2.0 means a doubled size)| + + + +### Type: [MaskCoords](../types/MaskCoords.md) + + +### Example: + +```php +$maskCoords = ['_' => 'maskCoords', 'n' => int, 'x' => double, 'y' => double, 'zoom' => double]; +``` + + +Or, if you're into Lua: + +```lua +maskCoords={_='maskCoords', n=int, x=double, y=double, zoom=double} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/message.md b/old_docs/API_docs_v109/constructors/message.md new file mode 100644 index 00000000..f2d54305 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/message.md @@ -0,0 +1,67 @@ +--- +title: message +description: A message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: message +[Back to constructors index](index.md) + + + +A message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|out|[Bool](../types/Bool.md) | Optional|Is this an outgoing message| +|mentioned|[Bool](../types/Bool.md) | Optional|Whether we were mentioned in this message| +|media\_unread|[Bool](../types/Bool.md) | Optional|Whether there are unread media attachments in this message| +|silent|[Bool](../types/Bool.md) | Optional|Whether this is a silent message (no notification triggered)| +|post|[Bool](../types/Bool.md) | Optional|Whether this is a channel post| +|from\_scheduled|[Bool](../types/Bool.md) | Optional|Whether this is a scheduled post| +|legacy|[Bool](../types/Bool.md) | Optional|This is a legacy message: it has to be refetched with the new layer| +|edit\_hide|[Bool](../types/Bool.md) | Optional|Whether the message should be shown as not modified to the user, even if an edit date is present| +|id|[int](../types/int.md) | Yes|ID of the message| +|from\_id|[int](../types/int.md) | Optional|ID of the sender of the message| +|to\_id|[Peer](../types/Peer.md) | Yes|ID of the chat were the message was sent| +|fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional|Info about forwarded messages| +|via\_bot\_id|[int](../types/int.md) | Optional|ID of the inline bot that generated the message| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to| +|date|[int](../types/int.md) | Yes|Date of the message| +|message|[string](../types/string.md) | Yes|The message| +|media|[MessageMedia](../types/MessageMedia.md) | Optional|Media attachment| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Reply markup (bot/inline keyboards)| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| +|views|[int](../types/int.md) | Optional|View count for channel posts| +|edit\_date|[int](../types/int.md) | Optional|Last edit date of this message| +|post\_author|[string](../types/string.md) | Optional|Name of the author of this message for channel posts (with signatures enabled)| +|grouped\_id|[long](../types/long.md) | Optional|Multiple media messages sent using [messages.sendMultiMedia](../methods/messages.sendMultiMedia.md) with the same grouped ID indicate an album| +|restriction\_reason|Array of [RestrictionReason](../types/RestrictionReason.md) | Optional|Restriction reason| + + + +### Type: [Message](../types/Message.md) + + +### Example: + +```php +$message = ['_' => 'message', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'post' => Bool, 'from_scheduled' => Bool, 'legacy' => Bool, 'edit_hide' => 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, 'restriction_reason' => [RestrictionReason, RestrictionReason]]; +``` + + +Or, if you're into Lua: + +```lua +message={_='message', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, post=Bool, from_scheduled=Bool, legacy=Bool, edit_hide=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, restriction_reason={RestrictionReason}} + +``` + + + +## Usage of reply_markup + +You can provide bot API reply_markup objects here. + + diff --git a/old_docs/API_docs_v109/constructors/messageActionBotAllowed.md b/old_docs/API_docs_v109/constructors/messageActionBotAllowed.md new file mode 100644 index 00000000..3b0b5119 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionBotAllowed.md @@ -0,0 +1,38 @@ +--- +title: messageActionBotAllowed +description: The domain name of the website on which the user has logged in. [More about Telegram Login »](https://core.telegram.org/widgets/login) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionBotAllowed +[Back to constructors index](index.md) + + + +The domain name of the website on which the user has logged in. [More about Telegram Login »](https://core.telegram.org/widgets/login) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|domain|[string](../types/string.md) | Yes|The domain name of the website on which the user has logged in.| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionBotAllowed = ['_' => 'messageActionBotAllowed', 'domain' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageActionBotAllowed={_='messageActionBotAllowed', domain='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionChannelCreate.md b/old_docs/API_docs_v109/constructors/messageActionChannelCreate.md new file mode 100644 index 00000000..af68b8db --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionChannelCreate.md @@ -0,0 +1,38 @@ +--- +title: messageActionChannelCreate +description: The channel was created +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChannelCreate +[Back to constructors index](index.md) + + + +The channel was created + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[string](../types/string.md) | Yes|Original channel/supergroup title| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionChannelCreate = ['_' => 'messageActionChannelCreate', 'title' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageActionChannelCreate={_='messageActionChannelCreate', title='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionChannelMigrateFrom.md b/old_docs/API_docs_v109/constructors/messageActionChannelMigrateFrom.md new file mode 100644 index 00000000..e014a4d8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionChannelMigrateFrom.md @@ -0,0 +1,39 @@ +--- +title: messageActionChannelMigrateFrom +description: Indicates the channel was [migrated](https://core.telegram.org/api/channel) from the specified chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChannelMigrateFrom +[Back to constructors index](index.md) + + + +Indicates the channel was [migrated](https://core.telegram.org/api/channel) from the specified chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[string](../types/string.md) | Yes|The old chat tite| +|chat\_id|[int](../types/int.md) | Yes|The old chat ID| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionChannelMigrateFrom = ['_' => 'messageActionChannelMigrateFrom', 'title' => 'string', 'chat_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageActionChannelMigrateFrom={_='messageActionChannelMigrateFrom', title='string', chat_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionChatAddUser.md b/old_docs/API_docs_v109/constructors/messageActionChatAddUser.md new file mode 100644 index 00000000..b475a59a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionChatAddUser.md @@ -0,0 +1,38 @@ +--- +title: messageActionChatAddUser +description: New member in the group +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatAddUser +[Back to constructors index](index.md) + + + +New member in the group + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|users|Array of [int](../types/int.md) | Yes|Users| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionChatAddUser = ['_' => 'messageActionChatAddUser', 'users' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +messageActionChatAddUser={_='messageActionChatAddUser', users={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionChatCreate.md b/old_docs/API_docs_v109/constructors/messageActionChatCreate.md new file mode 100644 index 00000000..4a75cfbf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionChatCreate.md @@ -0,0 +1,39 @@ +--- +title: messageActionChatCreate +description: Group created +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatCreate +[Back to constructors index](index.md) + + + +Group created + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[string](../types/string.md) | Yes|Group name| +|users|Array of [int](../types/int.md) | Yes|Users| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionChatCreate = ['_' => 'messageActionChatCreate', 'title' => 'string', 'users' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +messageActionChatCreate={_='messageActionChatCreate', title='string', users={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionChatDeletePhoto.md b/old_docs/API_docs_v109/constructors/messageActionChatDeletePhoto.md new file mode 100644 index 00000000..ea18d3ce --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionChatDeletePhoto.md @@ -0,0 +1,33 @@ +--- +title: messageActionChatDeletePhoto +description: Group profile photo removed. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatDeletePhoto +[Back to constructors index](index.md) + + + +Group profile photo removed. + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionChatDeletePhoto = ['_' => 'messageActionChatDeletePhoto']; +``` + + +Or, if you're into Lua: + +```lua +messageActionChatDeletePhoto={_='messageActionChatDeletePhoto'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionChatDeleteUser.md b/old_docs/API_docs_v109/constructors/messageActionChatDeleteUser.md new file mode 100644 index 00000000..55bab510 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionChatDeleteUser.md @@ -0,0 +1,38 @@ +--- +title: messageActionChatDeleteUser +description: User left the group. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatDeleteUser +[Back to constructors index](index.md) + + + +User left the group. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|Leaving user ID| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionChatDeleteUser = ['_' => 'messageActionChatDeleteUser', 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageActionChatDeleteUser={_='messageActionChatDeleteUser', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionChatEditPhoto.md b/old_docs/API_docs_v109/constructors/messageActionChatEditPhoto.md new file mode 100644 index 00000000..769b648c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionChatEditPhoto.md @@ -0,0 +1,38 @@ +--- +title: messageActionChatEditPhoto +description: Group profile changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatEditPhoto +[Back to constructors index](index.md) + + + +Group profile changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|photo|[Photo](../types/Photo.md) | Optional|New group pofile photo| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionChatEditPhoto = ['_' => 'messageActionChatEditPhoto', 'photo' => Photo]; +``` + + +Or, if you're into Lua: + +```lua +messageActionChatEditPhoto={_='messageActionChatEditPhoto', photo=Photo} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionChatEditTitle.md b/old_docs/API_docs_v109/constructors/messageActionChatEditTitle.md new file mode 100644 index 00000000..3d89f254 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionChatEditTitle.md @@ -0,0 +1,38 @@ +--- +title: messageActionChatEditTitle +description: Group name changed. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatEditTitle +[Back to constructors index](index.md) + + + +Group name changed. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[string](../types/string.md) | Yes|New group name| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionChatEditTitle = ['_' => 'messageActionChatEditTitle', 'title' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageActionChatEditTitle={_='messageActionChatEditTitle', title='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionChatJoinedByLink.md b/old_docs/API_docs_v109/constructors/messageActionChatJoinedByLink.md new file mode 100644 index 00000000..76aef4a1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionChatJoinedByLink.md @@ -0,0 +1,38 @@ +--- +title: messageActionChatJoinedByLink +description: A user joined the chat via an invite link +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatJoinedByLink +[Back to constructors index](index.md) + + + +A user joined the chat via an invite link + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|inviter\_id|[int](../types/int.md) | Yes|ID of the user that created the invite link| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionChatJoinedByLink = ['_' => 'messageActionChatJoinedByLink', 'inviter_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageActionChatJoinedByLink={_='messageActionChatJoinedByLink', inviter_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionChatMigrateTo.md b/old_docs/API_docs_v109/constructors/messageActionChatMigrateTo.md new file mode 100644 index 00000000..285e4f12 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionChatMigrateTo.md @@ -0,0 +1,38 @@ +--- +title: messageActionChatMigrateTo +description: Indicates the chat was [migrated](https://core.telegram.org/api/channel) to the specified supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionChatMigrateTo +[Back to constructors index](index.md) + + + +Indicates the chat was [migrated](https://core.telegram.org/api/channel) to the specified supergroup + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|The supergroup it was migrated to| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionChatMigrateTo = ['_' => 'messageActionChatMigrateTo', 'channel_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageActionChatMigrateTo={_='messageActionChatMigrateTo', channel_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionContactSignUp.md b/old_docs/API_docs_v109/constructors/messageActionContactSignUp.md new file mode 100644 index 00000000..363af97a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionContactSignUp.md @@ -0,0 +1,33 @@ +--- +title: messageActionContactSignUp +description: A contact just signed up to telegram +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionContactSignUp +[Back to constructors index](index.md) + + + +A contact just signed up to telegram + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionContactSignUp = ['_' => 'messageActionContactSignUp']; +``` + + +Or, if you're into Lua: + +```lua +messageActionContactSignUp={_='messageActionContactSignUp'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionCustomAction.md b/old_docs/API_docs_v109/constructors/messageActionCustomAction.md new file mode 100644 index 00000000..f5c1c354 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionCustomAction.md @@ -0,0 +1,38 @@ +--- +title: messageActionCustomAction +description: Custom action (most likely not supported by the current layer, an upgrade might be needed) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionCustomAction +[Back to constructors index](index.md) + + + +Custom action (most likely not supported by the current layer, an upgrade might be needed) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[string](../types/string.md) | Yes|Action message| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionCustomAction = ['_' => 'messageActionCustomAction', 'message' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageActionCustomAction={_='messageActionCustomAction', message='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionEmpty.md b/old_docs/API_docs_v109/constructors/messageActionEmpty.md new file mode 100644 index 00000000..9f2ad11f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionEmpty.md @@ -0,0 +1,33 @@ +--- +title: messageActionEmpty +description: Empty constructor. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionEmpty +[Back to constructors index](index.md) + + + +Empty constructor. + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionEmpty = ['_' => 'messageActionEmpty']; +``` + + +Or, if you're into Lua: + +```lua +messageActionEmpty={_='messageActionEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionGameScore.md b/old_docs/API_docs_v109/constructors/messageActionGameScore.md new file mode 100644 index 00000000..aed301e2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionGameScore.md @@ -0,0 +1,39 @@ +--- +title: messageActionGameScore +description: Someone scored in a game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionGameScore +[Back to constructors index](index.md) + + + +Someone scored in a game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game\_id|[long](../types/long.md) | Yes|Game ID| +|score|[int](../types/int.md) | Yes|Score| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionGameScore = ['_' => 'messageActionGameScore', 'game_id' => long, 'score' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageActionGameScore={_='messageActionGameScore', game_id=long, score=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionHistoryClear.md b/old_docs/API_docs_v109/constructors/messageActionHistoryClear.md new file mode 100644 index 00000000..cc1560e9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionHistoryClear.md @@ -0,0 +1,33 @@ +--- +title: messageActionHistoryClear +description: Chat history was cleared +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionHistoryClear +[Back to constructors index](index.md) + + + +Chat history was cleared + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionHistoryClear = ['_' => 'messageActionHistoryClear']; +``` + + +Or, if you're into Lua: + +```lua +messageActionHistoryClear={_='messageActionHistoryClear'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionPaymentSent.md b/old_docs/API_docs_v109/constructors/messageActionPaymentSent.md new file mode 100644 index 00000000..2850e8b8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionPaymentSent.md @@ -0,0 +1,39 @@ +--- +title: messageActionPaymentSent +description: A payment was sent +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPaymentSent +[Back to constructors index](index.md) + + + +A payment was sent + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|total\_amount|[long](../types/long.md) | Yes|Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionPaymentSent = ['_' => 'messageActionPaymentSent', 'currency' => 'string', 'total_amount' => long]; +``` + + +Or, if you're into Lua: + +```lua +messageActionPaymentSent={_='messageActionPaymentSent', currency='string', total_amount=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionPaymentSentMe.md b/old_docs/API_docs_v109/constructors/messageActionPaymentSentMe.md new file mode 100644 index 00000000..07e7361a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionPaymentSentMe.md @@ -0,0 +1,43 @@ +--- +title: messageActionPaymentSentMe +description: A user just sent a payment to me (a bot) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPaymentSentMe +[Back to constructors index](index.md) + + + +A user just sent a payment to me (a bot) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|total\_amount|[long](../types/long.md) | Yes|Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| +|payload|[bytes](../types/bytes.md) | Yes|Bot specified invoice payload| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional|Order info provided by the user| +|shipping\_option\_id|[string](../types/string.md) | Optional|Identifier of the shipping option chosen by the user| +|charge|[PaymentCharge](../types/PaymentCharge.md) | Yes|Provider payment identifier| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionPaymentSentMe = ['_' => 'messageActionPaymentSentMe', 'currency' => 'string', 'total_amount' => long, 'payload' => 'bytes', 'info' => PaymentRequestedInfo, 'shipping_option_id' => 'string', 'charge' => PaymentCharge]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/messageActionPhoneCall.md b/old_docs/API_docs_v109/constructors/messageActionPhoneCall.md new file mode 100644 index 00000000..94d9b2f3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionPhoneCall.md @@ -0,0 +1,41 @@ +--- +title: messageActionPhoneCall +description: A phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPhoneCall +[Back to constructors index](index.md) + + + +A phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|video|[Bool](../types/Bool.md) | Optional|Is this a video call?| +|call\_id|[long](../types/long.md) | Yes|Call ID| +|reason|[PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) | Optional|If the call has ended, the reason why it ended| +|duration|[int](../types/int.md) | Optional|Duration of the call in seconds| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionPhoneCall = ['_' => 'messageActionPhoneCall', 'video' => Bool, 'call_id' => long, 'reason' => PhoneCallDiscardReason, 'duration' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageActionPhoneCall={_='messageActionPhoneCall', video=Bool, call_id=long, reason=PhoneCallDiscardReason, duration=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionPinMessage.md b/old_docs/API_docs_v109/constructors/messageActionPinMessage.md new file mode 100644 index 00000000..af8881cc --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionPinMessage.md @@ -0,0 +1,33 @@ +--- +title: messageActionPinMessage +description: A message was pinned +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionPinMessage +[Back to constructors index](index.md) + + + +A message was pinned + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionPinMessage = ['_' => 'messageActionPinMessage']; +``` + + +Or, if you're into Lua: + +```lua +messageActionPinMessage={_='messageActionPinMessage'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionScreenshotTaken.md b/old_docs/API_docs_v109/constructors/messageActionScreenshotTaken.md new file mode 100644 index 00000000..6f5df8d1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionScreenshotTaken.md @@ -0,0 +1,33 @@ +--- +title: messageActionScreenshotTaken +description: A screenshot of the chat was taken +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionScreenshotTaken +[Back to constructors index](index.md) + + + +A screenshot of the chat was taken + + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionScreenshotTaken = ['_' => 'messageActionScreenshotTaken']; +``` + + +Or, if you're into Lua: + +```lua +messageActionScreenshotTaken={_='messageActionScreenshotTaken'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionSecureValuesSent.md b/old_docs/API_docs_v109/constructors/messageActionSecureValuesSent.md new file mode 100644 index 00000000..0ad1eab2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionSecureValuesSent.md @@ -0,0 +1,38 @@ +--- +title: messageActionSecureValuesSent +description: Request for secure [telegram passport](https://core.telegram.org/passport) values was sent +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionSecureValuesSent +[Back to constructors index](index.md) + + + +Request for secure [telegram passport](https://core.telegram.org/passport) values was sent + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|types|Array of [SecureValueType](../types/SecureValueType.md) | Yes|Types| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionSecureValuesSent = ['_' => 'messageActionSecureValuesSent', 'types' => [SecureValueType, SecureValueType]]; +``` + + +Or, if you're into Lua: + +```lua +messageActionSecureValuesSent={_='messageActionSecureValuesSent', types={SecureValueType}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageActionSecureValuesSentMe.md b/old_docs/API_docs_v109/constructors/messageActionSecureValuesSentMe.md new file mode 100644 index 00000000..a575b487 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageActionSecureValuesSentMe.md @@ -0,0 +1,39 @@ +--- +title: messageActionSecureValuesSentMe +description: Secure [telegram passport](https://core.telegram.org/passport) values were received +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageActionSecureValuesSentMe +[Back to constructors index](index.md) + + + +Secure [telegram passport](https://core.telegram.org/passport) values were received + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|values|Array of [SecureValue](../types/SecureValue.md) | Yes|Values| +|credentials|[SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md) | Yes|Encrypted credentials required to decrypt the data| + + + +### Type: [MessageAction](../types/MessageAction.md) + + +### Example: + +```php +$messageActionSecureValuesSentMe = ['_' => 'messageActionSecureValuesSentMe', 'values' => [SecureValue, SecureValue], 'credentials' => SecureCredentialsEncrypted]; +``` + + +Or, if you're into Lua: + +```lua +messageActionSecureValuesSentMe={_='messageActionSecureValuesSentMe', values={SecureValue}, credentials=SecureCredentialsEncrypted} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEmpty.md b/old_docs/API_docs_v109/constructors/messageEmpty.md new file mode 100644 index 00000000..0542c16f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEmpty.md @@ -0,0 +1,38 @@ +--- +title: messageEmpty +description: Empty constructor, non-existent message. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEmpty +[Back to constructors index](index.md) + + + +Empty constructor, non-existent message. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Message identifier| + + + +### Type: [Message](../types/Message.md) + + +### Example: + +```php +$messageEmpty = ['_' => 'messageEmpty', 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEmpty={_='messageEmpty', id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityBlockquote.md b/old_docs/API_docs_v109/constructors/messageEntityBlockquote.md new file mode 100644 index 00000000..3fe46f32 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityBlockquote.md @@ -0,0 +1,39 @@ +--- +title: messageEntityBlockquote +description: Message entity representing a block quote. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityBlockquote +[Back to constructors index](index.md) + + + +Message entity representing a block quote. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityBlockquote = ['_' => 'messageEntityBlockquote', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityBlockquote={_='messageEntityBlockquote', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityBold.md b/old_docs/API_docs_v109/constructors/messageEntityBold.md new file mode 100644 index 00000000..3e353ca6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityBold.md @@ -0,0 +1,39 @@ +--- +title: messageEntityBold +description: Message entity representing **bold text**. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityBold +[Back to constructors index](index.md) + + + +Message entity representing **bold text**. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityBold = ['_' => 'messageEntityBold', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityBold={_='messageEntityBold', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityBotCommand.md b/old_docs/API_docs_v109/constructors/messageEntityBotCommand.md new file mode 100644 index 00000000..5adf26ed --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityBotCommand.md @@ -0,0 +1,39 @@ +--- +title: messageEntityBotCommand +description: Message entity representing a bot /command +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityBotCommand +[Back to constructors index](index.md) + + + +Message entity representing a bot /command + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityBotCommand = ['_' => 'messageEntityBotCommand', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityBotCommand={_='messageEntityBotCommand', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityCashtag.md b/old_docs/API_docs_v109/constructors/messageEntityCashtag.md new file mode 100644 index 00000000..ba480e37 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityCashtag.md @@ -0,0 +1,39 @@ +--- +title: messageEntityCashtag +description: Message entity representing a **$cashtag**. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityCashtag +[Back to constructors index](index.md) + + + +Message entity representing a **$cashtag**. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityCashtag = ['_' => 'messageEntityCashtag', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityCashtag={_='messageEntityCashtag', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityCode.md b/old_docs/API_docs_v109/constructors/messageEntityCode.md new file mode 100644 index 00000000..5e621555 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityCode.md @@ -0,0 +1,39 @@ +--- +title: messageEntityCode +description: Message entity representing a `codeblock`. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityCode +[Back to constructors index](index.md) + + + +Message entity representing a `codeblock`. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityCode = ['_' => 'messageEntityCode', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityCode={_='messageEntityCode', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityEmail.md b/old_docs/API_docs_v109/constructors/messageEntityEmail.md new file mode 100644 index 00000000..96c6aad1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityEmail.md @@ -0,0 +1,39 @@ +--- +title: messageEntityEmail +description: Message entity representing an . +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityEmail +[Back to constructors index](index.md) + + + +Message entity representing an . + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityEmail = ['_' => 'messageEntityEmail', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityEmail={_='messageEntityEmail', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityHashtag.md b/old_docs/API_docs_v109/constructors/messageEntityHashtag.md new file mode 100644 index 00000000..2eaf83e1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityHashtag.md @@ -0,0 +1,39 @@ +--- +title: messageEntityHashtag +description: **\#hashtag** message entity +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityHashtag +[Back to constructors index](index.md) + + + +**\#hashtag** message entity + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityHashtag = ['_' => 'messageEntityHashtag', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityHashtag={_='messageEntityHashtag', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityItalic.md b/old_docs/API_docs_v109/constructors/messageEntityItalic.md new file mode 100644 index 00000000..30212986 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityItalic.md @@ -0,0 +1,39 @@ +--- +title: messageEntityItalic +description: Message entity representing *italic text*. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityItalic +[Back to constructors index](index.md) + + + +Message entity representing *italic text*. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityItalic = ['_' => 'messageEntityItalic', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityItalic={_='messageEntityItalic', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityMention.md b/old_docs/API_docs_v109/constructors/messageEntityMention.md new file mode 100644 index 00000000..6595d037 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityMention.md @@ -0,0 +1,39 @@ +--- +title: messageEntityMention +description: Message entity mentioning the current user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityMention +[Back to constructors index](index.md) + + + +Message entity mentioning the current user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityMention = ['_' => 'messageEntityMention', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityMention={_='messageEntityMention', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityMentionName.md b/old_docs/API_docs_v109/constructors/messageEntityMentionName.md new file mode 100644 index 00000000..76524eaf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityMentionName.md @@ -0,0 +1,40 @@ +--- +title: messageEntityMentionName +description: Message entity representing a [user mention](https://t.me/test): for *creating* a mention use [inputMessageEntityMentionName](../constructors/inputMessageEntityMentionName.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityMentionName +[Back to constructors index](index.md) + + + +Message entity representing a [user mention](https://t.me/test): for *creating* a mention use [inputMessageEntityMentionName](../constructors/inputMessageEntityMentionName.md). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| +|user\_id|[int](../types/int.md) | Yes|Identifier of the user that was mentioned| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityMentionName = ['_' => 'messageEntityMentionName', 'offset' => int, 'length' => int, 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityMentionName={_='messageEntityMentionName', offset=int, length=int, user_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityPhone.md b/old_docs/API_docs_v109/constructors/messageEntityPhone.md new file mode 100644 index 00000000..19b30658 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityPhone.md @@ -0,0 +1,39 @@ +--- +title: messageEntityPhone +description: Message entity representing a phone number. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityPhone +[Back to constructors index](index.md) + + + +Message entity representing a phone number. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityPhone = ['_' => 'messageEntityPhone', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityPhone={_='messageEntityPhone', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityPre.md b/old_docs/API_docs_v109/constructors/messageEntityPre.md new file mode 100644 index 00000000..ed5e5932 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityPre.md @@ -0,0 +1,40 @@ +--- +title: messageEntityPre +description: Message entity representing a preformatted `codeblock`, allowing the user to specify a programming language for the codeblock. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityPre +[Back to constructors index](index.md) + + + +Message entity representing a preformatted `codeblock`, allowing the user to specify a programming language for the codeblock. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| +|language|[string](../types/string.md) | Yes|Programming language of the code| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityPre = ['_' => 'messageEntityPre', 'offset' => int, 'length' => int, 'language' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageEntityPre={_='messageEntityPre', offset=int, length=int, language='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityStrike.md b/old_docs/API_docs_v109/constructors/messageEntityStrike.md new file mode 100644 index 00000000..32d3c490 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityStrike.md @@ -0,0 +1,39 @@ +--- +title: messageEntityStrike +description: Message entity representing strikethrough text. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityStrike +[Back to constructors index](index.md) + + + +Message entity representing strikethrough text. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityStrike = ['_' => 'messageEntityStrike', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityStrike={_='messageEntityStrike', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityTextUrl.md b/old_docs/API_docs_v109/constructors/messageEntityTextUrl.md new file mode 100644 index 00000000..9524d5bf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityTextUrl.md @@ -0,0 +1,40 @@ +--- +title: messageEntityTextUrl +description: Message entity representing a [text url](https://google.com): for in-text urls like use [messageEntityUrl](../constructors/messageEntityUrl.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityTextUrl +[Back to constructors index](index.md) + + + +Message entity representing a [text url](https://google.com): for in-text urls like use [messageEntityUrl](../constructors/messageEntityUrl.md). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| +|url|[string](../types/string.md) | Yes|The actual URL| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityTextUrl = ['_' => 'messageEntityTextUrl', 'offset' => int, 'length' => int, 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageEntityTextUrl={_='messageEntityTextUrl', offset=int, length=int, url='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityUnderline.md b/old_docs/API_docs_v109/constructors/messageEntityUnderline.md new file mode 100644 index 00000000..2a94a886 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityUnderline.md @@ -0,0 +1,39 @@ +--- +title: messageEntityUnderline +description: Message entity representing underlined text. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityUnderline +[Back to constructors index](index.md) + + + +Message entity representing underlined text. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityUnderline = ['_' => 'messageEntityUnderline', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityUnderline={_='messageEntityUnderline', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityUnknown.md b/old_docs/API_docs_v109/constructors/messageEntityUnknown.md new file mode 100644 index 00000000..a29eb975 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityUnknown.md @@ -0,0 +1,39 @@ +--- +title: messageEntityUnknown +description: Unknown message entity +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityUnknown +[Back to constructors index](index.md) + + + +Unknown message entity + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityUnknown = ['_' => 'messageEntityUnknown', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityUnknown={_='messageEntityUnknown', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageEntityUrl.md b/old_docs/API_docs_v109/constructors/messageEntityUrl.md new file mode 100644 index 00000000..8ad52908 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageEntityUrl.md @@ -0,0 +1,39 @@ +--- +title: messageEntityUrl +description: Message entity representing an in-text url: ; for [text urls](https://google.com), use [messageEntityTextUrl](../constructors/messageEntityTextUrl.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageEntityUrl +[Back to constructors index](index.md) + + + +Message entity representing an in-text url: ; for [text urls](https://google.com), use [messageEntityTextUrl](../constructors/messageEntityTextUrl.md). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset|[int](../types/int.md) | Yes|Offset of message entity within message (in UTF-8 codepoints)| +|length|[int](../types/int.md) | Yes|Length of message entity within message (in UTF-8 codepoints)| + + + +### Type: [MessageEntity](../types/MessageEntity.md) + + +### Example: + +```php +$messageEntityUrl = ['_' => 'messageEntityUrl', 'offset' => int, 'length' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageEntityUrl={_='messageEntityUrl', offset=int, length=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageFwdHeader.md b/old_docs/API_docs_v109/constructors/messageFwdHeader.md new file mode 100644 index 00000000..d8298a03 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageFwdHeader.md @@ -0,0 +1,45 @@ +--- +title: messageFwdHeader +description: Info about a forwarded message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageFwdHeader +[Back to constructors index](index.md) + + + +Info about a forwarded message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|from\_id|[int](../types/int.md) | Optional|The ID of the user that originally sent the message| +|from\_name|[string](../types/string.md) | Optional|The name of the user that originally sent the message| +|date|[int](../types/int.md) | Yes|When was the message originally sent| +|channel\_id|[int](../types/int.md) | Optional|ID of the channel from which the message was forwarded| +|channel\_post|[int](../types/int.md) | Optional|ID of the channel message that was forwarded| +|post\_author|[string](../types/string.md) | Optional|For channels and if signatures are enabled, author of the channel message| +|saved\_from\_peer|[Peer](../types/Peer.md) | Optional|Only for messages forwarded to the current user (inputPeerSelf), full info about the user/channel that originally sent the message| +|saved\_from\_msg\_id|[int](../types/int.md) | Optional|Only for messages forwarded to the current user (inputPeerSelf), ID of the message that was forwarded from the original user/channel| + + + +### Type: [MessageFwdHeader](../types/MessageFwdHeader.md) + + +### Example: + +```php +$messageFwdHeader = ['_' => 'messageFwdHeader', 'from_id' => int, 'from_name' => 'string', '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: + +```lua +messageFwdHeader={_='messageFwdHeader', from_id=int, from_name='string', 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_v109/constructors/messageMediaContact.md b/old_docs/API_docs_v109/constructors/messageMediaContact.md new file mode 100644 index 00000000..fbd3645f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaContact.md @@ -0,0 +1,42 @@ +--- +title: messageMediaContact +description: Attached contact. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaContact +[Back to constructors index](index.md) + + + +Attached contact. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_number|[string](../types/string.md) | Yes|Phone number| +|first\_name|[string](../types/string.md) | Yes|Contact's first name| +|last\_name|[string](../types/string.md) | Yes|Contact's last name| +|vcard|[string](../types/string.md) | Yes|VCARD of contact| +|user\_id|[int](../types/int.md) | Yes|User identifier or `0`, if the user with the given phone number is not registered| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaContact = ['_' => 'messageMediaContact', 'phone_number' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'vcard' => 'string', 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageMediaContact={_='messageMediaContact', phone_number='string', first_name='string', last_name='string', vcard='string', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageMediaDocument.md b/old_docs/API_docs_v109/constructors/messageMediaDocument.md new file mode 100644 index 00000000..a7f48e48 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaDocument.md @@ -0,0 +1,39 @@ +--- +title: messageMediaDocument +description: Document (video, audio, voice, sticker, any media type except photo) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaDocument +[Back to constructors index](index.md) + + + +Document (video, audio, voice, sticker, any media type except photo) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|document|[Document](../types/Document.md) | Optional|Attached document| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live of self-destructing document| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaDocument = ['_' => 'messageMediaDocument', 'document' => Document, 'ttl_seconds' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageMediaDocument={_='messageMediaDocument', document=Document, ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageMediaEmpty.md b/old_docs/API_docs_v109/constructors/messageMediaEmpty.md new file mode 100644 index 00000000..ff9b70d8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaEmpty.md @@ -0,0 +1,33 @@ +--- +title: messageMediaEmpty +description: Empty constructor. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaEmpty +[Back to constructors index](index.md) + + + +Empty constructor. + + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaEmpty = ['_' => 'messageMediaEmpty']; +``` + + +Or, if you're into Lua: + +```lua +messageMediaEmpty={_='messageMediaEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageMediaGame.md b/old_docs/API_docs_v109/constructors/messageMediaGame.md new file mode 100644 index 00000000..d5a08477 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaGame.md @@ -0,0 +1,38 @@ +--- +title: messageMediaGame +description: Telegram game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaGame +[Back to constructors index](index.md) + + + +Telegram game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[Game](../types/Game.md) | Yes|Game| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaGame = ['_' => 'messageMediaGame', 'game' => Game]; +``` + + +Or, if you're into Lua: + +```lua +messageMediaGame={_='messageMediaGame', game=Game} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageMediaGeo.md b/old_docs/API_docs_v109/constructors/messageMediaGeo.md new file mode 100644 index 00000000..63884853 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaGeo.md @@ -0,0 +1,38 @@ +--- +title: messageMediaGeo +description: Attached map. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaGeo +[Back to constructors index](index.md) + + + +Attached map. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|GeoPoint| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaGeo = ['_' => 'messageMediaGeo', 'geo' => GeoPoint]; +``` + + +Or, if you're into Lua: + +```lua +messageMediaGeo={_='messageMediaGeo', geo=GeoPoint} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageMediaGeoLive.md b/old_docs/API_docs_v109/constructors/messageMediaGeoLive.md new file mode 100644 index 00000000..f31a8536 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaGeoLive.md @@ -0,0 +1,39 @@ +--- +title: messageMediaGeoLive +description: Indicates a live geolocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaGeoLive +[Back to constructors index](index.md) + + + +Indicates a live geolocation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Geolocation| +|period|[int](../types/int.md) | Yes|Validity period of provided geolocation| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaGeoLive = ['_' => 'messageMediaGeoLive', 'geo' => GeoPoint, 'period' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageMediaGeoLive={_='messageMediaGeoLive', geo=GeoPoint, period=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageMediaInvoice.md b/old_docs/API_docs_v109/constructors/messageMediaInvoice.md new file mode 100644 index 00000000..33490172 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaInvoice.md @@ -0,0 +1,46 @@ +--- +title: messageMediaInvoice +description: Invoice +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaInvoice +[Back to constructors index](index.md) + + + +Invoice + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|shipping\_address\_requested|[Bool](../types/Bool.md) | Optional|Whether the shipping address was requested| +|test|[Bool](../types/Bool.md) | Optional|Whether this is an example invoice| +|title|[string](../types/string.md) | Yes|Product name, 1-32 characters| +|description|[string](../types/string.md) | Yes|Product description, 1-255 characters| +|photo|[WebDocument](../types/WebDocument.md) | Optional|URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.| +|receipt\_msg\_id|[int](../types/int.md) | Optional|Message ID of receipt: if set, clients should change the text of the first [keyboardButtonBuy](../constructors/keyboardButtonBuy.md) button always attached to the [message](../constructors/message.md) to a localized version of the word `Receipt`| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|total\_amount|[long](../types/long.md) | Yes|Total price in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| +|start\_param|[string](../types/string.md) | Yes|Unique bot deep-linking parameter that can be used to generate this invoice| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$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']; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/messageMediaPhoto.md b/old_docs/API_docs_v109/constructors/messageMediaPhoto.md new file mode 100644 index 00000000..1ab6d134 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaPhoto.md @@ -0,0 +1,39 @@ +--- +title: messageMediaPhoto +description: Attached photo. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaPhoto +[Back to constructors index](index.md) + + + +Attached photo. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|photo|[Photo](../types/Photo.md) | Optional|Photo| +|ttl\_seconds|[int](../types/int.md) | Optional|Time to live in seconds of self-destructing photo| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaPhoto = ['_' => 'messageMediaPhoto', 'photo' => Photo, 'ttl_seconds' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageMediaPhoto={_='messageMediaPhoto', photo=Photo, ttl_seconds=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageMediaPoll.md b/old_docs/API_docs_v109/constructors/messageMediaPoll.md new file mode 100644 index 00000000..4527e406 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaPoll.md @@ -0,0 +1,39 @@ +--- +title: messageMediaPoll +description: Poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaPoll +[Back to constructors index](index.md) + + + +Poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|poll|[Poll](../types/Poll.md) | Yes|The poll| +|results|[PollResults](../types/PollResults.md) | Yes|The results of the poll| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaPoll = ['_' => 'messageMediaPoll', 'poll' => Poll, 'results' => PollResults]; +``` + + +Or, if you're into Lua: + +```lua +messageMediaPoll={_='messageMediaPoll', poll=Poll, results=PollResults} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageMediaUnsupported.md b/old_docs/API_docs_v109/constructors/messageMediaUnsupported.md new file mode 100644 index 00000000..84e9a8ac --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaUnsupported.md @@ -0,0 +1,33 @@ +--- +title: messageMediaUnsupported +description: Current version of the client does not support this media type. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaUnsupported +[Back to constructors index](index.md) + + + +Current version of the client does not support this media type. + + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaUnsupported = ['_' => 'messageMediaUnsupported']; +``` + + +Or, if you're into Lua: + +```lua +messageMediaUnsupported={_='messageMediaUnsupported'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageMediaVenue.md b/old_docs/API_docs_v109/constructors/messageMediaVenue.md new file mode 100644 index 00000000..430d2c32 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaVenue.md @@ -0,0 +1,43 @@ +--- +title: messageMediaVenue +description: Venue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaVenue +[Back to constructors index](index.md) + + + +Venue + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Geolocation of venue| +|title|[string](../types/string.md) | Yes|Venue name| +|address|[string](../types/string.md) | Yes|Address| +|provider|[string](../types/string.md) | Yes|Venue provider: currently only "foursquare" needs to be supported| +|venue\_id|[string](../types/string.md) | Yes|Venue ID in the provider's database| +|venue\_type|[string](../types/string.md) | Yes|Venue type in the provider's database| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaVenue = ['_' => 'messageMediaVenue', 'geo' => GeoPoint, 'title' => 'string', 'address' => 'string', 'provider' => 'string', 'venue_id' => 'string', 'venue_type' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messageMediaVenue={_='messageMediaVenue', geo=GeoPoint, title='string', address='string', provider='string', venue_id='string', venue_type='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageMediaWebPage.md b/old_docs/API_docs_v109/constructors/messageMediaWebPage.md new file mode 100644 index 00000000..888fa1ce --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageMediaWebPage.md @@ -0,0 +1,38 @@ +--- +title: messageMediaWebPage +description: Preview of webpage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageMediaWebPage +[Back to constructors index](index.md) + + + +Preview of webpage + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|webpage|[WebPage](../types/WebPage.md) | Optional|Webpage preview| + + + +### Type: [MessageMedia](../types/MessageMedia.md) + + +### Example: + +```php +$messageMediaWebPage = ['_' => 'messageMediaWebPage', 'webpage' => WebPage]; +``` + + +Or, if you're into Lua: + +```lua +messageMediaWebPage={_='messageMediaWebPage', webpage=WebPage} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageRange.md b/old_docs/API_docs_v109/constructors/messageRange.md new file mode 100644 index 00000000..9e0f318a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageRange.md @@ -0,0 +1,39 @@ +--- +title: messageRange +description: Indicates a range of chat messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageRange +[Back to constructors index](index.md) + + + +Indicates a range of chat messages + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|min\_id|[int](../types/int.md) | Yes|Start of range (message ID)| +|max\_id|[int](../types/int.md) | Yes|End of range (message ID)| + + + +### Type: [MessageRange](../types/MessageRange.md) + + +### Example: + +```php +$messageRange = ['_' => 'messageRange', 'min_id' => int, 'max_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageRange={_='messageRange', min_id=int, max_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageService.md b/old_docs/API_docs_v109/constructors/messageService.md new file mode 100644 index 00000000..553a4973 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageService.md @@ -0,0 +1,49 @@ +--- +title: messageService +description: Indicates a service message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageService +[Back to constructors index](index.md) + + + +Indicates a service message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|out|[Bool](../types/Bool.md) | Optional|Whether the message is outgoing| +|mentioned|[Bool](../types/Bool.md) | Optional|Whether we were mentioned in the message| +|media\_unread|[Bool](../types/Bool.md) | Optional|Whether the message contains unread media| +|silent|[Bool](../types/Bool.md) | Optional|Whether the message is silent| +|post|[Bool](../types/Bool.md) | Optional|Whether it's a channel post| +|legacy|[Bool](../types/Bool.md) | Optional|This is a legacy message: it has to be refetched with the new layer| +|id|[int](../types/int.md) | Yes|Message ID| +|from\_id|[int](../types/int.md) | Optional|Id of te sender of the message| +|to\_id|[Peer](../types/Peer.md) | Yes|ID of the destination of the message| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to| +|date|[int](../types/int.md) | Yes|Message date| +|action|[MessageAction](../types/MessageAction.md) | Optional|Event connected with the service message| + + + +### Type: [Message](../types/Message.md) + + +### Example: + +```php +$messageService = ['_' => 'messageService', 'out' => Bool, 'mentioned' => Bool, 'media_unread' => Bool, 'silent' => Bool, 'post' => Bool, 'legacy' => Bool, 'id' => int, 'from_id' => int, 'to_id' => Peer, 'reply_to_msg_id' => int, 'date' => int, 'action' => MessageAction]; +``` + + +Or, if you're into Lua: + +```lua +messageService={_='messageService', out=Bool, mentioned=Bool, media_unread=Bool, silent=Bool, post=Bool, legacy=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_v109/constructors/messageUserVote.md b/old_docs/API_docs_v109/constructors/messageUserVote.md new file mode 100644 index 00000000..4a0fa477 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageUserVote.md @@ -0,0 +1,38 @@ +--- +title: messageUserVote +description: messageUserVote attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageUserVote +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|option|[bytes](../types/bytes.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [MessageUserVote](../types/MessageUserVote.md) + + +### Example: + +```php +$messageUserVote = ['_' => 'messageUserVote', 'user_id' => int, 'option' => 'bytes', 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageUserVote={_='messageUserVote', user_id=int, option='bytes', date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageUserVoteInputOption.md b/old_docs/API_docs_v109/constructors/messageUserVoteInputOption.md new file mode 100644 index 00000000..1e106d81 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageUserVoteInputOption.md @@ -0,0 +1,37 @@ +--- +title: messageUserVoteInputOption +description: messageUserVoteInputOption attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageUserVoteInputOption +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [MessageUserVote](../types/MessageUserVote.md) + + +### Example: + +```php +$messageUserVoteInputOption = ['_' => 'messageUserVoteInputOption', 'user_id' => int, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageUserVoteInputOption={_='messageUserVoteInputOption', user_id=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messageUserVoteMultiple.md b/old_docs/API_docs_v109/constructors/messageUserVoteMultiple.md new file mode 100644 index 00000000..d3ddd7e3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messageUserVoteMultiple.md @@ -0,0 +1,38 @@ +--- +title: messageUserVoteMultiple +description: messageUserVoteMultiple attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: messageUserVoteMultiple +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|user\_id|[int](../types/int.md) | Yes| +|options|Array of [bytes](../types/bytes.md) | Yes| +|date|[int](../types/int.md) | Yes| + + + +### Type: [MessageUserVote](../types/MessageUserVote.md) + + +### Example: + +```php +$messageUserVoteMultiple = ['_' => 'messageUserVoteMultiple', 'user_id' => int, 'options' => ['bytes', 'bytes'], 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +messageUserVoteMultiple={_='messageUserVoteMultiple', user_id=int, options={'bytes'}, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.affectedHistory.md b/old_docs/API_docs_v109/constructors/messages.affectedHistory.md new file mode 100644 index 00000000..83258216 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.affectedHistory.md @@ -0,0 +1,41 @@ +--- +title: messages.affectedHistory +description: Affected part of communication history with the user or in a chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_affectedHistory.html +--- +# Constructor: messages.affectedHistory +[Back to constructors index](index.md) + + + +Affected part of communication history with the user or in a chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pts|[int](../types/int.md) | Yes|Number of events occured in a text box| +|pts\_count|[int](../types/int.md) | Yes|Number of affected events| +|offset|[int](../types/int.md) | Yes|If a parameter contains positive value, it is necessary to repeat the method call using the given value; during the proceeding of all the history the value itself shall gradually decrease| + + + +### Type: [messages.AffectedHistory](../types/messages.AffectedHistory.md) + + +### Example: + +```php +$messages.affectedHistory = ['_' => 'messages.affectedHistory', 'pts' => int, 'pts_count' => int, 'offset' => int]; +``` + + +Or, if you're into Lua: + +```lua +messages.affectedHistory={_='messages.affectedHistory', pts=int, pts_count=int, offset=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.affectedMessages.md b/old_docs/API_docs_v109/constructors/messages.affectedMessages.md new file mode 100644 index 00000000..84f531c0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.affectedMessages.md @@ -0,0 +1,40 @@ +--- +title: messages.affectedMessages +description: Events affected by operation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_affectedMessages.html +--- +# Constructor: messages.affectedMessages +[Back to constructors index](index.md) + + + +Events affected by operation + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [messages.AffectedMessages](../types/messages.AffectedMessages.md) + + +### Example: + +```php +$messages.affectedMessages = ['_' => 'messages.affectedMessages', 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +messages.affectedMessages={_='messages.affectedMessages', pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.allStickers.md b/old_docs/API_docs_v109/constructors/messages.allStickers.md new file mode 100644 index 00000000..99c19e62 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.allStickers.md @@ -0,0 +1,40 @@ +--- +title: messages.allStickers +description: Info about all installed stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_allStickers.html +--- +# Constructor: messages.allStickers +[Back to constructors index](index.md) + + + +Info about all installed stickers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| +|sets|Array of [StickerSet](../types/StickerSet.md) | Yes|Sets| + + + +### Type: [messages.AllStickers](../types/messages.AllStickers.md) + + +### Example: + +```php +$messages.allStickers = ['_' => 'messages.allStickers', 'hash' => int, 'sets' => [StickerSet, StickerSet]]; +``` + + +Or, if you're into Lua: + +```lua +messages.allStickers={_='messages.allStickers', hash=int, sets={StickerSet}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.allStickersNotModified.md b/old_docs/API_docs_v109/constructors/messages.allStickersNotModified.md new file mode 100644 index 00000000..9e2f8faa --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.allStickersNotModified.md @@ -0,0 +1,34 @@ +--- +title: messages.allStickersNotModified +description: Info about all installed stickers hasn't changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_allStickersNotModified.html +--- +# Constructor: messages.allStickersNotModified +[Back to constructors index](index.md) + + + +Info about all installed stickers hasn't changed + + + + +### Type: [messages.AllStickers](../types/messages.AllStickers.md) + + +### Example: + +```php +$messages.allStickersNotModified = ['_' => 'messages.allStickersNotModified']; +``` + + +Or, if you're into Lua: + +```lua +messages.allStickersNotModified={_='messages.allStickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.archivedStickers.md b/old_docs/API_docs_v109/constructors/messages.archivedStickers.md new file mode 100644 index 00000000..c71c1190 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.archivedStickers.md @@ -0,0 +1,40 @@ +--- +title: messages.archivedStickers +description: Archived stickersets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_archivedStickers.html +--- +# Constructor: messages.archivedStickers +[Back to constructors index](index.md) + + + +Archived stickersets + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Number of archived stickers| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes|Sets| + + + +### Type: [messages.ArchivedStickers](../types/messages.ArchivedStickers.md) + + +### Example: + +```php +$messages.archivedStickers = ['_' => 'messages.archivedStickers', 'count' => int, 'sets' => [StickerSetCovered, StickerSetCovered]]; +``` + + +Or, if you're into Lua: + +```lua +messages.archivedStickers={_='messages.archivedStickers', count=int, sets={StickerSetCovered}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.botCallbackAnswer.md b/old_docs/API_docs_v109/constructors/messages.botCallbackAnswer.md new file mode 100644 index 00000000..31a3eb1e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.botCallbackAnswer.md @@ -0,0 +1,44 @@ +--- +title: messages.botCallbackAnswer +description: Callback answer sent by the bot in response to a button press +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_botCallbackAnswer.html +--- +# Constructor: messages.botCallbackAnswer +[Back to constructors index](index.md) + + + +Callback answer sent by the bot in response to a button press + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[Bool](../types/Bool.md) | Optional|Whether an alert should be shown to the user instead of a toast notification| +|has\_url|[Bool](../types/Bool.md) | Optional|Whether an URL is present| +|native\_ui|[Bool](../types/Bool.md) | Optional|Whether to show games in WebView or in native UI.| +|message|[string](../types/string.md) | Optional|Alert to show| +|url|[string](../types/string.md) | Optional|URL to open| +|cache\_time|[int](../types/int.md) | Yes|For how long should this answer be cached| + + + +### Type: [messages.BotCallbackAnswer](../types/messages.BotCallbackAnswer.md) + + +### Example: + +```php +$messages.botCallbackAnswer = ['_' => 'messages.botCallbackAnswer', 'alert' => Bool, 'has_url' => Bool, 'native_ui' => Bool, 'message' => 'string', 'url' => 'string', 'cache_time' => int]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/messages.botResults.md b/old_docs/API_docs_v109/constructors/messages.botResults.md new file mode 100644 index 00000000..5282c654 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.botResults.md @@ -0,0 +1,45 @@ +--- +title: messages.botResults +description: Result of a query to an inline bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_botResults.html +--- +# Constructor: messages.botResults +[Back to constructors index](index.md) + + + +Result of a query to an inline bot + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[Bool](../types/Bool.md) | Optional|Whether the result is a picture gallery| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|next\_offset|[string](../types/string.md) | Optional|The next offset to use when navigating through results| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Whether the bot requested the user to message him in private| +|results|Array of [BotInlineResult](../types/BotInlineResult.md) | Yes|Results| +|cache\_time|[int](../types/int.md) | Yes|Caching validity of the results| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [messages.BotResults](../types/messages.BotResults.md) + + +### Example: + +```php +$messages.botResults = ['_' => 'messages.botResults', 'gallery' => Bool, 'query_id' => long, 'next_offset' => 'string', 'switch_pm' => InlineBotSwitchPM, 'results' => [BotInlineResult, BotInlineResult], 'cache_time' => int, 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/messages.channelMessages.md b/old_docs/API_docs_v109/constructors/messages.channelMessages.md new file mode 100644 index 00000000..a273ffc7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.channelMessages.md @@ -0,0 +1,44 @@ +--- +title: messages.channelMessages +description: Channel messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_channelMessages.html +--- +# Constructor: messages.channelMessages +[Back to constructors index](index.md) + + + +Channel messages + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|inexact|[Bool](../types/Bool.md) | Optional|If set, returned results may be inexact| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|count|[int](../types/int.md) | Yes|Total number of results were found server-side (may not be all included here)| +|messages|Array of [Message](../types/Message.md) | Yes|Messages| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [messages.Messages](../types/messages.Messages.md) + + +### Example: + +```php +$messages.channelMessages = ['_' => 'messages.channelMessages', 'inexact' => Bool, 'pts' => int, 'count' => int, 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.channelMessages={_='messages.channelMessages', inexact=Bool, pts=int, count=int, messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.chatFull.md b/old_docs/API_docs_v109/constructors/messages.chatFull.md new file mode 100644 index 00000000..ada5153a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.chatFull.md @@ -0,0 +1,41 @@ +--- +title: messages.chatFull +description: Extended info on chat and auxiliary data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_chatFull.html +--- +# Constructor: messages.chatFull +[Back to constructors index](index.md) + + + +Extended info on chat and auxiliary data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|full\_chat|[ChatFull](../types/ChatFull.md) | Yes|Extended info on a chat| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [messages.ChatFull](../types/messages.ChatFull.md) + + +### Example: + +```php +$messages.chatFull = ['_' => 'messages.chatFull', 'full_chat' => ChatFull, 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.chatFull={_='messages.chatFull', full_chat=ChatFull, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.chats.md b/old_docs/API_docs_v109/constructors/messages.chats.md new file mode 100644 index 00000000..06cd8363 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.chats.md @@ -0,0 +1,39 @@ +--- +title: messages.chats +description: List of chats with auxiliary data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_chats.html +--- +# Constructor: messages.chats +[Back to constructors index](index.md) + + + +List of chats with auxiliary data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| + + + +### Type: [messages.Chats](../types/messages.Chats.md) + + +### Example: + +```php +$messages.chats = ['_' => 'messages.chats', 'chats' => [Chat, Chat]]; +``` + + +Or, if you're into Lua: + +```lua +messages.chats={_='messages.chats', chats={Chat}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.chatsSlice.md b/old_docs/API_docs_v109/constructors/messages.chatsSlice.md new file mode 100644 index 00000000..a40d1e20 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.chatsSlice.md @@ -0,0 +1,40 @@ +--- +title: messages.chatsSlice +description: Partial list of chats, more would have to be fetched with [pagination](https://core.telegram.org/api/offsets) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_chatsSlice.html +--- +# Constructor: messages.chatsSlice +[Back to constructors index](index.md) + + + +Partial list of chats, more would have to be fetched with [pagination](https://core.telegram.org/api/offsets) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Total number of results that were found server-side (not all are included in `chats`)| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| + + + +### Type: [messages.Chats](../types/messages.Chats.md) + + +### Example: + +```php +$messages.chatsSlice = ['_' => 'messages.chatsSlice', 'count' => int, 'chats' => [Chat, Chat]]; +``` + + +Or, if you're into Lua: + +```lua +messages.chatsSlice={_='messages.chatsSlice', count=int, chats={Chat}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.dhConfig.md b/old_docs/API_docs_v109/constructors/messages.dhConfig.md new file mode 100644 index 00000000..76b1ba39 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.dhConfig.md @@ -0,0 +1,42 @@ +--- +title: messages.dhConfig +description: New set of configuring parameters. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_dhConfig.html +--- +# Constructor: messages.dhConfig +[Back to constructors index](index.md) + + + +New set of configuring parameters. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|g|[int](../types/int.md) | Yes|New value **prime**, see [Wikipedia](https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange)| +|p|[bytes](../types/bytes.md) | Yes|New value **primitive root**, see [Wikipedia](https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange)| +|version|[int](../types/int.md) | Yes|Vestion of set of parameters| +|random|[bytes](../types/bytes.md) | Yes|Random sequence of bytes of assigned length| + + + +### Type: [messages.DhConfig](../types/messages.DhConfig.md) + + +### Example: + +```php +$messages.dhConfig = ['_' => 'messages.dhConfig', 'g' => int, 'p' => 'bytes', 'version' => int, 'random' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +messages.dhConfig={_='messages.dhConfig', g=int, p='bytes', version=int, random='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.dhConfigNotModified.md b/old_docs/API_docs_v109/constructors/messages.dhConfigNotModified.md new file mode 100644 index 00000000..6af9b747 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.dhConfigNotModified.md @@ -0,0 +1,39 @@ +--- +title: messages.dhConfigNotModified +description: Configuring parameters did not change. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_dhConfigNotModified.html +--- +# Constructor: messages.dhConfigNotModified +[Back to constructors index](index.md) + + + +Configuring parameters did not change. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|random|[bytes](../types/bytes.md) | Yes|Random sequence of bytes of assigned length| + + + +### Type: [messages.DhConfig](../types/messages.DhConfig.md) + + +### Example: + +```php +$messages.dhConfigNotModified = ['_' => 'messages.dhConfigNotModified', 'random' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +messages.dhConfigNotModified={_='messages.dhConfigNotModified', random='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.dialogs.md b/old_docs/API_docs_v109/constructors/messages.dialogs.md new file mode 100644 index 00000000..b8c4aceb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.dialogs.md @@ -0,0 +1,42 @@ +--- +title: messages.dialogs +description: Full list of chats with messages and auxiliary data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_dialogs.html +--- +# Constructor: messages.dialogs +[Back to constructors index](index.md) + + + +Full list of chats with messages and auxiliary data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dialogs|Array of [Dialog](../types/Dialog.md) | Yes|Dialogs| +|messages|Array of [Message](../types/Message.md) | Yes|Messages| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [messages.Dialogs](../types/messages.Dialogs.md) + + +### Example: + +```php +$messages.dialogs = ['_' => 'messages.dialogs', 'dialogs' => [Dialog, Dialog], 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.dialogs={_='messages.dialogs', dialogs={Dialog}, messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.dialogsNotModified.md b/old_docs/API_docs_v109/constructors/messages.dialogsNotModified.md new file mode 100644 index 00000000..2ffc9dfa --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.dialogsNotModified.md @@ -0,0 +1,39 @@ +--- +title: messages.dialogsNotModified +description: Dialogs haven't changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_dialogsNotModified.html +--- +# Constructor: messages.dialogsNotModified +[Back to constructors index](index.md) + + + +Dialogs haven't changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Number of dialogs found server-side by the query| + + + +### Type: [messages.Dialogs](../types/messages.Dialogs.md) + + +### Example: + +```php +$messages.dialogsNotModified = ['_' => 'messages.dialogsNotModified', 'count' => int]; +``` + + +Or, if you're into Lua: + +```lua +messages.dialogsNotModified={_='messages.dialogsNotModified', count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.dialogsSlice.md b/old_docs/API_docs_v109/constructors/messages.dialogsSlice.md new file mode 100644 index 00000000..4d2c9a4a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.dialogsSlice.md @@ -0,0 +1,43 @@ +--- +title: messages.dialogsSlice +description: Incomplete list of dialogs with messages and auxiliary data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_dialogsSlice.html +--- +# Constructor: messages.dialogsSlice +[Back to constructors index](index.md) + + + +Incomplete list of dialogs with messages and auxiliary data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Total number of dialogs| +|dialogs|Array of [Dialog](../types/Dialog.md) | Yes|Dialogs| +|messages|Array of [Message](../types/Message.md) | Yes|Messages| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [messages.Dialogs](../types/messages.Dialogs.md) + + +### Example: + +```php +$messages.dialogsSlice = ['_' => 'messages.dialogsSlice', 'count' => int, 'dialogs' => [Dialog, Dialog], 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.dialogsSlice={_='messages.dialogsSlice', count=int, dialogs={Dialog}, messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.favedStickers.md b/old_docs/API_docs_v109/constructors/messages.favedStickers.md new file mode 100644 index 00000000..3c80a80b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.favedStickers.md @@ -0,0 +1,41 @@ +--- +title: messages.favedStickers +description: Favorited stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_favedStickers.html +--- +# Constructor: messages.favedStickers +[Back to constructors index](index.md) + + + +Favorited stickers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| +|packs|Array of [StickerPack](../types/StickerPack.md) | Yes|Packs| +|stickers|Array of [Document](../types/Document.md) | Yes|Stickers| + + + +### Type: [messages.FavedStickers](../types/messages.FavedStickers.md) + + +### Example: + +```php +$messages.favedStickers = ['_' => 'messages.favedStickers', 'hash' => int, 'packs' => [StickerPack, StickerPack], 'stickers' => [Document, Document]]; +``` + + +Or, if you're into Lua: + +```lua +messages.favedStickers={_='messages.favedStickers', hash=int, packs={StickerPack}, stickers={Document}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.favedStickersNotModified.md b/old_docs/API_docs_v109/constructors/messages.favedStickersNotModified.md new file mode 100644 index 00000000..9b76f9a2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.favedStickersNotModified.md @@ -0,0 +1,34 @@ +--- +title: messages.favedStickersNotModified +description: No new favorited stickers were found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_favedStickersNotModified.html +--- +# Constructor: messages.favedStickersNotModified +[Back to constructors index](index.md) + + + +No new favorited stickers were found + + + + +### Type: [messages.FavedStickers](../types/messages.FavedStickers.md) + + +### Example: + +```php +$messages.favedStickersNotModified = ['_' => 'messages.favedStickersNotModified']; +``` + + +Or, if you're into Lua: + +```lua +messages.favedStickersNotModified={_='messages.favedStickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.featuredStickers.md b/old_docs/API_docs_v109/constructors/messages.featuredStickers.md new file mode 100644 index 00000000..1e8652fd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.featuredStickers.md @@ -0,0 +1,41 @@ +--- +title: messages.featuredStickers +description: Featured stickersets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_featuredStickers.html +--- +# Constructor: messages.featuredStickers +[Back to constructors index](index.md) + + + +Featured stickersets + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes|Sets| +|unread|Array of [long](../types/long.md) | Yes|Unread| + + + +### Type: [messages.FeaturedStickers](../types/messages.FeaturedStickers.md) + + +### Example: + +```php +$messages.featuredStickers = ['_' => 'messages.featuredStickers', 'hash' => int, 'sets' => [StickerSetCovered, StickerSetCovered], 'unread' => [long, long]]; +``` + + +Or, if you're into Lua: + +```lua +messages.featuredStickers={_='messages.featuredStickers', hash=int, sets={StickerSetCovered}, unread={long}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.featuredStickersNotModified.md b/old_docs/API_docs_v109/constructors/messages.featuredStickersNotModified.md new file mode 100644 index 00000000..961c3a86 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.featuredStickersNotModified.md @@ -0,0 +1,34 @@ +--- +title: messages.featuredStickersNotModified +description: Featured stickers haven't changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_featuredStickersNotModified.html +--- +# Constructor: messages.featuredStickersNotModified +[Back to constructors index](index.md) + + + +Featured stickers haven't changed + + + + +### Type: [messages.FeaturedStickers](../types/messages.FeaturedStickers.md) + + +### Example: + +```php +$messages.featuredStickersNotModified = ['_' => 'messages.featuredStickersNotModified']; +``` + + +Or, if you're into Lua: + +```lua +messages.featuredStickersNotModified={_='messages.featuredStickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.foundGifs.md b/old_docs/API_docs_v109/constructors/messages.foundGifs.md new file mode 100644 index 00000000..6f10d2c4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.foundGifs.md @@ -0,0 +1,40 @@ +--- +title: messages.foundGifs +description: Found GIFs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_foundGifs.html +--- +# Constructor: messages.foundGifs +[Back to constructors index](index.md) + + + +Found GIFs + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|next\_offset|[int](../types/int.md) | Yes|Next offset to use when trying to [load more results](../methods/messages.searchGifs.md)| +|results|Array of [FoundGif](../types/FoundGif.md) | Yes|Results| + + + +### Type: [messages.FoundGifs](../types/messages.FoundGifs.md) + + +### Example: + +```php +$messages.foundGifs = ['_' => 'messages.foundGifs', 'next_offset' => int, 'results' => [FoundGif, FoundGif]]; +``` + + +Or, if you're into Lua: + +```lua +messages.foundGifs={_='messages.foundGifs', next_offset=int, results={FoundGif}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.foundStickerSets.md b/old_docs/API_docs_v109/constructors/messages.foundStickerSets.md new file mode 100644 index 00000000..beb7f845 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.foundStickerSets.md @@ -0,0 +1,40 @@ +--- +title: messages.foundStickerSets +description: Found stickersets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_foundStickerSets.html +--- +# Constructor: messages.foundStickerSets +[Back to constructors index](index.md) + + + +Found stickersets + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes|Sets| + + + +### Type: [messages.FoundStickerSets](../types/messages.FoundStickerSets.md) + + +### Example: + +```php +$messages.foundStickerSets = ['_' => 'messages.foundStickerSets', 'hash' => int, 'sets' => [StickerSetCovered, StickerSetCovered]]; +``` + + +Or, if you're into Lua: + +```lua +messages.foundStickerSets={_='messages.foundStickerSets', hash=int, sets={StickerSetCovered}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.foundStickerSetsNotModified.md b/old_docs/API_docs_v109/constructors/messages.foundStickerSetsNotModified.md new file mode 100644 index 00000000..b989b44a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.foundStickerSetsNotModified.md @@ -0,0 +1,34 @@ +--- +title: messages.foundStickerSetsNotModified +description: No further results were found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_foundStickerSetsNotModified.html +--- +# Constructor: messages.foundStickerSetsNotModified +[Back to constructors index](index.md) + + + +No further results were found + + + + +### Type: [messages.FoundStickerSets](../types/messages.FoundStickerSets.md) + + +### Example: + +```php +$messages.foundStickerSetsNotModified = ['_' => 'messages.foundStickerSetsNotModified']; +``` + + +Or, if you're into Lua: + +```lua +messages.foundStickerSetsNotModified={_='messages.foundStickerSetsNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.highScores.md b/old_docs/API_docs_v109/constructors/messages.highScores.md new file mode 100644 index 00000000..61f159ec --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.highScores.md @@ -0,0 +1,40 @@ +--- +title: messages.highScores +description: Highscores in a game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_highScores.html +--- +# Constructor: messages.highScores +[Back to constructors index](index.md) + + + +Highscores in a game + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|scores|Array of [HighScore](../types/HighScore.md) | Yes|Scores| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [messages.HighScores](../types/messages.HighScores.md) + + +### Example: + +```php +$messages.highScores = ['_' => 'messages.highScores', 'scores' => [HighScore, HighScore], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.highScores={_='messages.highScores', scores={HighScore}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.inactiveChats.md b/old_docs/API_docs_v109/constructors/messages.inactiveChats.md new file mode 100644 index 00000000..a899629d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.inactiveChats.md @@ -0,0 +1,39 @@ +--- +title: messages.inactiveChats +description: messages.inactiveChats attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_inactiveChats.html +--- +# Constructor: messages.inactiveChats +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|dates|Array of [int](../types/int.md) | Yes| +|chats|Array of [Chat](../types/Chat.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| + + + +### Type: [messages.InactiveChats](../types/messages.InactiveChats.md) + + +### Example: + +```php +$messages.inactiveChats = ['_' => 'messages.inactiveChats', 'dates' => [int, int], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.inactiveChats={_='messages.inactiveChats', dates={int}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.messageEditData.md b/old_docs/API_docs_v109/constructors/messages.messageEditData.md new file mode 100644 index 00000000..f2288b96 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.messageEditData.md @@ -0,0 +1,39 @@ +--- +title: messages.messageEditData +description: Message edit data for media +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_messageEditData.html +--- +# Constructor: messages.messageEditData +[Back to constructors index](index.md) + + + +Message edit data for media + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|caption|[Bool](../types/Bool.md) | Optional|Media caption, if the specified media's caption can be edited| + + + +### Type: [messages.MessageEditData](../types/messages.MessageEditData.md) + + +### Example: + +```php +$messages.messageEditData = ['_' => 'messages.messageEditData', 'caption' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +messages.messageEditData={_='messages.messageEditData', caption=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.messages.md b/old_docs/API_docs_v109/constructors/messages.messages.md new file mode 100644 index 00000000..471c4844 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.messages.md @@ -0,0 +1,41 @@ +--- +title: messages.messages +description: Full list of messages with auxilary data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_messages.html +--- +# Constructor: messages.messages +[Back to constructors index](index.md) + + + +Full list of messages with auxilary data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|messages|Array of [Message](../types/Message.md) | Yes|Messages| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [messages.Messages](../types/messages.Messages.md) + + +### Example: + +```php +$messages.messages = ['_' => 'messages.messages', 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.messages={_='messages.messages', messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.messagesNotModified.md b/old_docs/API_docs_v109/constructors/messages.messagesNotModified.md new file mode 100644 index 00000000..a52e8c80 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.messagesNotModified.md @@ -0,0 +1,39 @@ +--- +title: messages.messagesNotModified +description: No new messages matching the query were found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_messagesNotModified.html +--- +# Constructor: messages.messagesNotModified +[Back to constructors index](index.md) + + + +No new messages matching the query were found + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Number of results found server-side by the given query| + + + +### Type: [messages.Messages](../types/messages.Messages.md) + + +### Example: + +```php +$messages.messagesNotModified = ['_' => 'messages.messagesNotModified', 'count' => int]; +``` + + +Or, if you're into Lua: + +```lua +messages.messagesNotModified={_='messages.messagesNotModified', count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.messagesSlice.md b/old_docs/API_docs_v109/constructors/messages.messagesSlice.md new file mode 100644 index 00000000..f3bcad3f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.messagesSlice.md @@ -0,0 +1,44 @@ +--- +title: messages.messagesSlice +description: Incomplete list of messages and auxiliary data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_messagesSlice.html +--- +# Constructor: messages.messagesSlice +[Back to constructors index](index.md) + + + +Incomplete list of messages and auxiliary data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|inexact|[Bool](../types/Bool.md) | Optional|If set, indicates that the results may be inexact| +|count|[int](../types/int.md) | Yes|Total number of messages in the list| +|next\_rate|[int](../types/int.md) | Optional|Rate to use in the `offset_rate` parameter in the next call to [messages.searchGlobal](../methods/messages.searchGlobal.md)| +|messages|Array of [Message](../types/Message.md) | Yes|Messages| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [messages.Messages](../types/messages.Messages.md) + + +### Example: + +```php +$messages.messagesSlice = ['_' => 'messages.messagesSlice', 'inexact' => Bool, 'count' => int, 'next_rate' => int, 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +messages.messagesSlice={_='messages.messagesSlice', inexact=Bool, count=int, next_rate=int, messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.peerDialogs.md b/old_docs/API_docs_v109/constructors/messages.peerDialogs.md new file mode 100644 index 00000000..89675e81 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.peerDialogs.md @@ -0,0 +1,43 @@ +--- +title: messages.peerDialogs +description: Dialog info of multiple peers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_peerDialogs.html +--- +# Constructor: messages.peerDialogs +[Back to constructors index](index.md) + + + +Dialog info of multiple peers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dialogs|Array of [Dialog](../types/Dialog.md) | Yes|Dialogs| +|messages|Array of [Message](../types/Message.md) | Yes|Messages| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| +|state|[updates.State](../constructors/updates.State.md) | Yes|Current [update state of dialog](https://core.telegram.org/api/updates)| + + + +### Type: [messages.PeerDialogs](../types/messages.PeerDialogs.md) + + +### Example: + +```php +$messages.peerDialogs = ['_' => 'messages.peerDialogs', 'dialogs' => [Dialog, Dialog], 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User], 'state' => updates.State]; +``` + + +Or, if you're into Lua: + +```lua +messages.peerDialogs={_='messages.peerDialogs', dialogs={Dialog}, messages={Message}, chats={Chat}, users={User}, state=updates.State} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.recentStickers.md b/old_docs/API_docs_v109/constructors/messages.recentStickers.md new file mode 100644 index 00000000..966b237d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.recentStickers.md @@ -0,0 +1,42 @@ +--- +title: messages.recentStickers +description: Recently used stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_recentStickers.html +--- +# Constructor: messages.recentStickers +[Back to constructors index](index.md) + + + +Recently used stickers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| +|packs|Array of [StickerPack](../types/StickerPack.md) | Yes|Packs| +|stickers|Array of [Document](../types/Document.md) | Yes|Stickers| +|dates|Array of [int](../types/int.md) | Yes|Dates| + + + +### Type: [messages.RecentStickers](../types/messages.RecentStickers.md) + + +### Example: + +```php +$messages.recentStickers = ['_' => 'messages.recentStickers', 'hash' => int, 'packs' => [StickerPack, StickerPack], 'stickers' => [Document, Document], 'dates' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +messages.recentStickers={_='messages.recentStickers', hash=int, packs={StickerPack}, stickers={Document}, dates={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.recentStickersNotModified.md b/old_docs/API_docs_v109/constructors/messages.recentStickersNotModified.md new file mode 100644 index 00000000..ea35f802 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.recentStickersNotModified.md @@ -0,0 +1,34 @@ +--- +title: messages.recentStickersNotModified +description: No new recent sticker was found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_recentStickersNotModified.html +--- +# Constructor: messages.recentStickersNotModified +[Back to constructors index](index.md) + + + +No new recent sticker was found + + + + +### Type: [messages.RecentStickers](../types/messages.RecentStickers.md) + + +### Example: + +```php +$messages.recentStickersNotModified = ['_' => 'messages.recentStickersNotModified']; +``` + + +Or, if you're into Lua: + +```lua +messages.recentStickersNotModified={_='messages.recentStickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.savedGifs.md b/old_docs/API_docs_v109/constructors/messages.savedGifs.md new file mode 100644 index 00000000..ef5449e6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.savedGifs.md @@ -0,0 +1,40 @@ +--- +title: messages.savedGifs +description: Saved gifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_savedGifs.html +--- +# Constructor: messages.savedGifs +[Back to constructors index](index.md) + + + +Saved gifs + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| +|gifs|Array of [Document](../types/Document.md) | Yes|Gifs| + + + +### Type: [messages.SavedGifs](../types/messages.SavedGifs.md) + + +### Example: + +```php +$messages.savedGifs = ['_' => 'messages.savedGifs', 'hash' => int, 'gifs' => [Document, Document]]; +``` + + +Or, if you're into Lua: + +```lua +messages.savedGifs={_='messages.savedGifs', hash=int, gifs={Document}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.savedGifsNotModified.md b/old_docs/API_docs_v109/constructors/messages.savedGifsNotModified.md new file mode 100644 index 00000000..1a437d96 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.savedGifsNotModified.md @@ -0,0 +1,34 @@ +--- +title: messages.savedGifsNotModified +description: No new saved gifs were found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_savedGifsNotModified.html +--- +# Constructor: messages.savedGifsNotModified +[Back to constructors index](index.md) + + + +No new saved gifs were found + + + + +### Type: [messages.SavedGifs](../types/messages.SavedGifs.md) + + +### Example: + +```php +$messages.savedGifsNotModified = ['_' => 'messages.savedGifsNotModified']; +``` + + +Or, if you're into Lua: + +```lua +messages.savedGifsNotModified={_='messages.savedGifsNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.searchCounter.md b/old_docs/API_docs_v109/constructors/messages.searchCounter.md new file mode 100644 index 00000000..616eadc3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.searchCounter.md @@ -0,0 +1,41 @@ +--- +title: messages.searchCounter +description: Indicates how many results would be found by a [messages.search](../methods/messages.search.md) call with the same parameters +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_searchCounter.html +--- +# Constructor: messages.searchCounter +[Back to constructors index](index.md) + + + +Indicates how many results would be found by a [messages.search](../methods/messages.search.md) call with the same parameters + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|inexact|[Bool](../types/Bool.md) | Optional|If set, the results may be inexact| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Provided message filter| +|count|[int](../types/int.md) | Yes|Number of results that were found server-side| + + + +### Type: [messages.SearchCounter](../types/messages.SearchCounter.md) + + +### Example: + +```php +$messages.searchCounter = ['_' => 'messages.searchCounter', 'inexact' => Bool, 'filter' => MessagesFilter, 'count' => int]; +``` + + +Or, if you're into Lua: + +```lua +messages.searchCounter={_='messages.searchCounter', inexact=Bool, filter=MessagesFilter, count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.sentEncryptedFile.md b/old_docs/API_docs_v109/constructors/messages.sentEncryptedFile.md new file mode 100644 index 00000000..01aa7f22 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.sentEncryptedFile.md @@ -0,0 +1,40 @@ +--- +title: messages.sentEncryptedFile +description: Message with a file enclosure sent to a protected chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_sentEncryptedFile.html +--- +# Constructor: messages.sentEncryptedFile +[Back to constructors index](index.md) + + + +Message with a file enclosure sent to a protected chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|date|[int](../types/int.md) | Yes|Sending date| +|file|[EncryptedFile](../types/EncryptedFile.md) | Optional|Attached file| + + + +### Type: [messages.SentEncryptedMessage](../types/messages.SentEncryptedMessage.md) + + +### Example: + +```php +$messages.sentEncryptedFile = ['_' => 'messages.sentEncryptedFile', 'date' => int, 'file' => EncryptedFile]; +``` + + +Or, if you're into Lua: + +```lua +messages.sentEncryptedFile={_='messages.sentEncryptedFile', date=int, file=EncryptedFile} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.sentEncryptedMessage.md b/old_docs/API_docs_v109/constructors/messages.sentEncryptedMessage.md new file mode 100644 index 00000000..30eb2143 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.sentEncryptedMessage.md @@ -0,0 +1,39 @@ +--- +title: messages.sentEncryptedMessage +description: Message without file attachemts sent to an encrypted file. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_sentEncryptedMessage.html +--- +# Constructor: messages.sentEncryptedMessage +[Back to constructors index](index.md) + + + +Message without file attachemts sent to an encrypted file. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|date|[int](../types/int.md) | Yes|Date of sending| + + + +### Type: [messages.SentEncryptedMessage](../types/messages.SentEncryptedMessage.md) + + +### Example: + +```php +$messages.sentEncryptedMessage = ['_' => 'messages.sentEncryptedMessage', 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +messages.sentEncryptedMessage={_='messages.sentEncryptedMessage', date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.stickerSet.md b/old_docs/API_docs_v109/constructors/messages.stickerSet.md new file mode 100644 index 00000000..61033ea5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.stickerSet.md @@ -0,0 +1,41 @@ +--- +title: messages.stickerSet +description: Stickerset and stickers inside it +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_stickerSet.html +--- +# Constructor: messages.stickerSet +[Back to constructors index](index.md) + + + +Stickerset and stickers inside it + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|set|[StickerSet](../types/StickerSet.md) | Yes|The stickerset| +|packs|Array of [StickerPack](../types/StickerPack.md) | Yes|Packs| +|documents|Array of [Document](../types/Document.md) | Yes|Documents| + + + +### Type: [messages.StickerSet](../types/messages.StickerSet.md) + + +### Example: + +```php +$messages.stickerSet = ['_' => 'messages.stickerSet', 'set' => StickerSet, 'packs' => [StickerPack, StickerPack], 'documents' => [Document, Document]]; +``` + + +Or, if you're into Lua: + +```lua +messages.stickerSet={_='messages.stickerSet', set=StickerSet, packs={StickerPack}, documents={Document}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.stickerSetInstallResultArchive.md b/old_docs/API_docs_v109/constructors/messages.stickerSetInstallResultArchive.md new file mode 100644 index 00000000..88c2ca56 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.stickerSetInstallResultArchive.md @@ -0,0 +1,39 @@ +--- +title: messages.stickerSetInstallResultArchive +description: The stickerset was installed, but since there are too many stickersets some were archived +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_stickerSetInstallResultArchive.html +--- +# Constructor: messages.stickerSetInstallResultArchive +[Back to constructors index](index.md) + + + +The stickerset was installed, but since there are too many stickersets some were archived + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sets|Array of [StickerSetCovered](../types/StickerSetCovered.md) | Yes|Sets| + + + +### Type: [messages.StickerSetInstallResult](../types/messages.StickerSetInstallResult.md) + + +### Example: + +```php +$messages.stickerSetInstallResultArchive = ['_' => 'messages.stickerSetInstallResultArchive', 'sets' => [StickerSetCovered, StickerSetCovered]]; +``` + + +Or, if you're into Lua: + +```lua +messages.stickerSetInstallResultArchive={_='messages.stickerSetInstallResultArchive', sets={StickerSetCovered}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.stickerSetInstallResultSuccess.md b/old_docs/API_docs_v109/constructors/messages.stickerSetInstallResultSuccess.md new file mode 100644 index 00000000..0e78206b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.stickerSetInstallResultSuccess.md @@ -0,0 +1,34 @@ +--- +title: messages.stickerSetInstallResultSuccess +description: The stickerset was installed successfully +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_stickerSetInstallResultSuccess.html +--- +# Constructor: messages.stickerSetInstallResultSuccess +[Back to constructors index](index.md) + + + +The stickerset was installed successfully + + + + +### Type: [messages.StickerSetInstallResult](../types/messages.StickerSetInstallResult.md) + + +### Example: + +```php +$messages.stickerSetInstallResultSuccess = ['_' => 'messages.stickerSetInstallResultSuccess']; +``` + + +Or, if you're into Lua: + +```lua +messages.stickerSetInstallResultSuccess={_='messages.stickerSetInstallResultSuccess'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.stickers.md b/old_docs/API_docs_v109/constructors/messages.stickers.md new file mode 100644 index 00000000..5f90894c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.stickers.md @@ -0,0 +1,40 @@ +--- +title: messages.stickers +description: Found stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_stickers.html +--- +# Constructor: messages.stickers +[Back to constructors index](index.md) + + + +Found stickers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| +|stickers|Array of [Document](../types/Document.md) | Yes|Stickers| + + + +### Type: [messages.Stickers](../types/messages.Stickers.md) + + +### Example: + +```php +$messages.stickers = ['_' => 'messages.stickers', 'hash' => int, 'stickers' => [Document, Document]]; +``` + + +Or, if you're into Lua: + +```lua +messages.stickers={_='messages.stickers', hash=int, stickers={Document}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.stickersNotModified.md b/old_docs/API_docs_v109/constructors/messages.stickersNotModified.md new file mode 100644 index 00000000..8df079ca --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.stickersNotModified.md @@ -0,0 +1,34 @@ +--- +title: messages.stickersNotModified +description: No new stickers were found for the given query +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_stickersNotModified.html +--- +# Constructor: messages.stickersNotModified +[Back to constructors index](index.md) + + + +No new stickers were found for the given query + + + + +### Type: [messages.Stickers](../types/messages.Stickers.md) + + +### Example: + +```php +$messages.stickersNotModified = ['_' => 'messages.stickersNotModified']; +``` + + +Or, if you're into Lua: + +```lua +messages.stickersNotModified={_='messages.stickersNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/messages.votesList.md b/old_docs/API_docs_v109/constructors/messages.votesList.md new file mode 100644 index 00000000..b2f464ff --- /dev/null +++ b/old_docs/API_docs_v109/constructors/messages.votesList.md @@ -0,0 +1,40 @@ +--- +title: messages.votesList +description: messages.votesList attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/messages_votesList.html +--- +# Constructor: messages.votesList +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|count|[int](../types/int.md) | Yes| +|votes|Array of [MessageUserVote](../types/MessageUserVote.md) | Yes| +|users|Array of [User](../types/User.md) | Yes| +|next\_offset|[string](../types/string.md) | Optional| + + + +### Type: [messages.VotesList](../types/messages.VotesList.md) + + +### Example: + +```php +$messages.votesList = ['_' => 'messages.votesList', 'count' => int, 'votes' => [MessageUserVote, MessageUserVote], 'users' => [User, User], 'next_offset' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +messages.votesList={_='messages.votesList', count=int, votes={MessageUserVote}, users={User}, next_offset='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/nearestDc.md b/old_docs/API_docs_v109/constructors/nearestDc.md new file mode 100644 index 00000000..0b3f5dbe --- /dev/null +++ b/old_docs/API_docs_v109/constructors/nearestDc.md @@ -0,0 +1,40 @@ +--- +title: nearestDc +description: Nearest data centre, according to geo-ip. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: nearestDc +[Back to constructors index](index.md) + + + +Nearest data centre, according to geo-ip. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|country|[string](../types/string.md) | Yes|Country code determined by geo-ip| +|this\_dc|[int](../types/int.md) | Yes|Number of current data centre| +|nearest\_dc|[int](../types/int.md) | Yes|Number of nearest data centre| + + + +### Type: [NearestDc](../types/NearestDc.md) + + +### Example: + +```php +$nearestDc = ['_' => 'nearestDc', 'country' => 'string', 'this_dc' => int, 'nearest_dc' => int]; +``` + + +Or, if you're into Lua: + +```lua +nearestDc={_='nearestDc', country='string', this_dc=int, nearest_dc=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/notifyBroadcasts.md b/old_docs/API_docs_v109/constructors/notifyBroadcasts.md new file mode 100644 index 00000000..ef5b3600 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/notifyBroadcasts.md @@ -0,0 +1,33 @@ +--- +title: notifyBroadcasts +description: Channel notification settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: notifyBroadcasts +[Back to constructors index](index.md) + + + +Channel notification settings + + + + +### Type: [NotifyPeer](../types/NotifyPeer.md) + + +### Example: + +```php +$notifyBroadcasts = ['_' => 'notifyBroadcasts']; +``` + + +Or, if you're into Lua: + +```lua +notifyBroadcasts={_='notifyBroadcasts'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/notifyChats.md b/old_docs/API_docs_v109/constructors/notifyChats.md new file mode 100644 index 00000000..63081b19 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/notifyChats.md @@ -0,0 +1,33 @@ +--- +title: notifyChats +description: Notifications generated by all groups. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: notifyChats +[Back to constructors index](index.md) + + + +Notifications generated by all groups. + + + + +### Type: [NotifyPeer](../types/NotifyPeer.md) + + +### Example: + +```php +$notifyChats = ['_' => 'notifyChats']; +``` + + +Or, if you're into Lua: + +```lua +notifyChats={_='notifyChats'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/notifyPeer.md b/old_docs/API_docs_v109/constructors/notifyPeer.md new file mode 100644 index 00000000..2ac77fb4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/notifyPeer.md @@ -0,0 +1,38 @@ +--- +title: notifyPeer +description: Notifications generated by a certain user or group. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: notifyPeer +[Back to constructors index](index.md) + + + +Notifications generated by a certain user or group. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|User or group| + + + +### Type: [NotifyPeer](../types/NotifyPeer.md) + + +### Example: + +```php +$notifyPeer = ['_' => 'notifyPeer', 'peer' => Peer]; +``` + + +Or, if you're into Lua: + +```lua +notifyPeer={_='notifyPeer', peer=Peer} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/notifyUsers.md b/old_docs/API_docs_v109/constructors/notifyUsers.md new file mode 100644 index 00000000..a422168d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/notifyUsers.md @@ -0,0 +1,33 @@ +--- +title: notifyUsers +description: Notifications generated by all users. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: notifyUsers +[Back to constructors index](index.md) + + + +Notifications generated by all users. + + + + +### Type: [NotifyPeer](../types/NotifyPeer.md) + + +### Example: + +```php +$notifyUsers = ['_' => 'notifyUsers']; +``` + + +Or, if you're into Lua: + +```lua +notifyUsers={_='notifyUsers'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/null.md b/old_docs/API_docs_v109/constructors/null.md new file mode 100644 index 00000000..29862cf2 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/constructors/page.md b/old_docs/API_docs_v109/constructors/page.md new file mode 100644 index 00000000..980d9513 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/page.md @@ -0,0 +1,44 @@ +--- +title: page +description: [Instant view](https://instantview.telegram.org) page +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: page +[Back to constructors index](index.md) + + + +[Instant view](https://instantview.telegram.org) page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|part|[Bool](../types/Bool.md) | Optional|Indicates that not full page preview is available to the client and it will need to fetch full Instant View from the server using [messages.getWebPagePreview](../methods/messages.getWebPagePreview.md).| +|rtl|[Bool](../types/Bool.md) | Optional|Whether the page contains RTL text| +|v2|[Bool](../types/Bool.md) | Optional|Whether this is an [IV v2](https://instantview.telegram.org/docs#what-39s-new-in-2-0) page| +|url|[string](../types/string.md) | Yes|Original page HTTP URL| +|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes|Blocks| +|photos|Array of [Photo](../types/Photo.md) | Yes|Photos| +|documents|Array of [Document](../types/Document.md) | Yes|Documents| + + + +### Type: [Page](../types/Page.md) + + +### Example: + +```php +$page = ['_' => 'page', 'part' => Bool, 'rtl' => Bool, 'v2' => Bool, 'url' => 'string', 'blocks' => [PageBlock, PageBlock], 'photos' => [Photo, Photo], 'documents' => [Document, Document]]; +``` + + +Or, if you're into Lua: + +```lua +page={_='page', part=Bool, rtl=Bool, v2=Bool, url='string', blocks={PageBlock}, photos={Photo}, documents={Document}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockAnchor.md b/old_docs/API_docs_v109/constructors/pageBlockAnchor.md new file mode 100644 index 00000000..f1a6a0cf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockAnchor.md @@ -0,0 +1,38 @@ +--- +title: pageBlockAnchor +description: Link to section within the page itself (like `anchor`) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockAnchor +[Back to constructors index](index.md) + + + +Link to section within the page itself (like `anchor`) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|name|[string](../types/string.md) | Yes|Name of target section| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockAnchor = ['_' => 'pageBlockAnchor', 'name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +pageBlockAnchor={_='pageBlockAnchor', name='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockAudio.md b/old_docs/API_docs_v109/constructors/pageBlockAudio.md new file mode 100644 index 00000000..640cc7e7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockAudio.md @@ -0,0 +1,39 @@ +--- +title: pageBlockAudio +description: Audio +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockAudio +[Back to constructors index](index.md) + + + +Audio + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|audio\_id|[long](../types/long.md) | Yes|Audio ID (to be fetched from the container [page](../constructors/page.md) constructor| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Audio caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockAudio = ['_' => 'pageBlockAudio', 'audio_id' => long, 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockAudio={_='pageBlockAudio', audio_id=long, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockAuthorDate.md b/old_docs/API_docs_v109/constructors/pageBlockAuthorDate.md new file mode 100644 index 00000000..2e23dac6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockAuthorDate.md @@ -0,0 +1,39 @@ +--- +title: pageBlockAuthorDate +description: Author and date of creation of article +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockAuthorDate +[Back to constructors index](index.md) + + + +Author and date of creation of article + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|author|[RichText](../types/RichText.md) | Yes|Author name| +|published\_date|[int](../types/int.md) | Yes|Date of pubblication| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockAuthorDate = ['_' => 'pageBlockAuthorDate', 'author' => RichText, 'published_date' => int]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockAuthorDate={_='pageBlockAuthorDate', author=RichText, published_date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockBlockquote.md b/old_docs/API_docs_v109/constructors/pageBlockBlockquote.md new file mode 100644 index 00000000..ef0cb454 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockBlockquote.md @@ -0,0 +1,39 @@ +--- +title: pageBlockBlockquote +description: Quote (equivalent to the HTML `
`) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockBlockquote +[Back to constructors index](index.md) + + + +Quote (equivalent to the HTML `
`) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Quote contents| +|caption|[RichText](../types/RichText.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockBlockquote = ['_' => 'pageBlockBlockquote', 'text' => RichText, 'caption' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockBlockquote={_='pageBlockBlockquote', text=RichText, caption=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockChannel.md b/old_docs/API_docs_v109/constructors/pageBlockChannel.md new file mode 100644 index 00000000..a77cf8d7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockChannel.md @@ -0,0 +1,38 @@ +--- +title: pageBlockChannel +description: Reference to a telegram channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockChannel +[Back to constructors index](index.md) + + + +Reference to a telegram channel + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Chat](../types/Chat.md) | Optional|The channel/supergroup/chat| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockChannel = ['_' => 'pageBlockChannel', 'channel' => Chat]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockChannel={_='pageBlockChannel', channel=Chat} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockCollage.md b/old_docs/API_docs_v109/constructors/pageBlockCollage.md new file mode 100644 index 00000000..1e68d4f4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockCollage.md @@ -0,0 +1,39 @@ +--- +title: pageBlockCollage +description: Collage of media +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockCollage +[Back to constructors index](index.md) + + + +Collage of media + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|items|Array of [PageBlock](../types/PageBlock.md) | Yes|Items| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockCollage = ['_' => 'pageBlockCollage', 'items' => [PageBlock, PageBlock], 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockCollage={_='pageBlockCollage', items={PageBlock}, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockCover.md b/old_docs/API_docs_v109/constructors/pageBlockCover.md new file mode 100644 index 00000000..ce197e51 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockCover.md @@ -0,0 +1,38 @@ +--- +title: pageBlockCover +description: A page cover +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockCover +[Back to constructors index](index.md) + + + +A page cover + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|cover|[PageBlock](../types/PageBlock.md) | Yes|Cover| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockCover = ['_' => 'pageBlockCover', 'cover' => PageBlock]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockCover={_='pageBlockCover', cover=PageBlock} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockDetails.md b/old_docs/API_docs_v109/constructors/pageBlockDetails.md new file mode 100644 index 00000000..d58a37eb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockDetails.md @@ -0,0 +1,40 @@ +--- +title: pageBlockDetails +description: A collapsible details block +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockDetails +[Back to constructors index](index.md) + + + +A collapsible details block + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|open|[Bool](../types/Bool.md) | Optional|Whether the block is open by default| +|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes|Blocks| +|title|[RichText](../types/RichText.md) | Yes|Always visible heading for the block| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockDetails = ['_' => 'pageBlockDetails', 'open' => Bool, 'blocks' => [PageBlock, PageBlock], 'title' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockDetails={_='pageBlockDetails', open=Bool, blocks={PageBlock}, title=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockDivider.md b/old_docs/API_docs_v109/constructors/pageBlockDivider.md new file mode 100644 index 00000000..ee75b91c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockDivider.md @@ -0,0 +1,33 @@ +--- +title: pageBlockDivider +description: An empty block separating a page +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockDivider +[Back to constructors index](index.md) + + + +An empty block separating a page + + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockDivider = ['_' => 'pageBlockDivider']; +``` + + +Or, if you're into Lua: + +```lua +pageBlockDivider={_='pageBlockDivider'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockEmbed.md b/old_docs/API_docs_v109/constructors/pageBlockEmbed.md new file mode 100644 index 00000000..f72464d8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockEmbed.md @@ -0,0 +1,45 @@ +--- +title: pageBlockEmbed +description: An embedded webpage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockEmbed +[Back to constructors index](index.md) + + + +An embedded webpage + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|full\_width|[Bool](../types/Bool.md) | Optional|Whether the block should be full width| +|allow\_scrolling|[Bool](../types/Bool.md) | Optional|Whether scrolling should be allowed| +|url|[string](../types/string.md) | Optional|Web page URL, if available| +|html|[string](../types/string.md) | Optional|HTML-markup of the embedded page| +|poster\_photo\_id|[long](../types/long.md) | Optional|Poster photo, if available| +|w|[int](../types/int.md) | Optional|Block width, if known| +|h|[int](../types/int.md) | Optional|Block height, if known| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockEmbed = ['_' => 'pageBlockEmbed', 'full_width' => Bool, 'allow_scrolling' => Bool, 'url' => 'string', 'html' => 'string', 'poster_photo_id' => long, 'w' => int, 'h' => int, 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockEmbed={_='pageBlockEmbed', full_width=Bool, allow_scrolling=Bool, url='string', html='string', poster_photo_id=long, w=int, h=int, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockEmbedPost.md b/old_docs/API_docs_v109/constructors/pageBlockEmbedPost.md new file mode 100644 index 00000000..68f76300 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockEmbedPost.md @@ -0,0 +1,44 @@ +--- +title: pageBlockEmbedPost +description: An embedded post +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockEmbedPost +[Back to constructors index](index.md) + + + +An embedded post + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Web page URL| +|webpage\_id|[long](../types/long.md) | Yes|ID of generated webpage preview| +|author\_photo\_id|[long](../types/long.md) | Yes|ID of the author's photo| +|author|[string](../types/string.md) | Yes|Author name| +|date|[int](../types/int.md) | Yes|Creation date| +|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes|Blocks| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockEmbedPost = ['_' => 'pageBlockEmbedPost', 'url' => 'string', 'webpage_id' => long, 'author_photo_id' => long, 'author' => 'string', 'date' => int, 'blocks' => [PageBlock, PageBlock], 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockEmbedPost={_='pageBlockEmbedPost', url='string', webpage_id=long, author_photo_id=long, author='string', date=int, blocks={PageBlock}, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockFooter.md b/old_docs/API_docs_v109/constructors/pageBlockFooter.md new file mode 100644 index 00000000..af49ca1d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockFooter.md @@ -0,0 +1,38 @@ +--- +title: pageBlockFooter +description: Page footer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockFooter +[Back to constructors index](index.md) + + + +Page footer + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Contents| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockFooter = ['_' => 'pageBlockFooter', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockFooter={_='pageBlockFooter', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockHeader.md b/old_docs/API_docs_v109/constructors/pageBlockHeader.md new file mode 100644 index 00000000..c2049a5c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockHeader.md @@ -0,0 +1,38 @@ +--- +title: pageBlockHeader +description: Page header +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockHeader +[Back to constructors index](index.md) + + + +Page header + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Contents| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockHeader = ['_' => 'pageBlockHeader', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockHeader={_='pageBlockHeader', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockKicker.md b/old_docs/API_docs_v109/constructors/pageBlockKicker.md new file mode 100644 index 00000000..0b91112e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockKicker.md @@ -0,0 +1,38 @@ +--- +title: pageBlockKicker +description: Kicker +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockKicker +[Back to constructors index](index.md) + + + +Kicker + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Contents| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockKicker = ['_' => 'pageBlockKicker', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockKicker={_='pageBlockKicker', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockList.md b/old_docs/API_docs_v109/constructors/pageBlockList.md new file mode 100644 index 00000000..cb40ba69 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockList.md @@ -0,0 +1,38 @@ +--- +title: pageBlockList +description: Unordered list of IV blocks +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockList +[Back to constructors index](index.md) + + + +Unordered list of IV blocks + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|items|Array of [PageListItem](../types/PageListItem.md) | Yes|Items| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockList = ['_' => 'pageBlockList', 'items' => [PageListItem, PageListItem]]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockList={_='pageBlockList', items={PageListItem}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockMap.md b/old_docs/API_docs_v109/constructors/pageBlockMap.md new file mode 100644 index 00000000..9d68d956 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockMap.md @@ -0,0 +1,42 @@ +--- +title: pageBlockMap +description: A map +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockMap +[Back to constructors index](index.md) + + + +A map + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Location of the map center| +|zoom|[int](../types/int.md) | Yes|Map zoom level; 13-20| +|w|[int](../types/int.md) | Yes|Map width in pixels before applying scale; 16-102| +|h|[int](../types/int.md) | Yes|Map height in pixels before applying scale; 16-1024| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockMap = ['_' => 'pageBlockMap', 'geo' => GeoPoint, 'zoom' => int, 'w' => int, 'h' => int, 'caption' => PageCaption]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockMap={_='pageBlockMap', geo=GeoPoint, zoom=int, w=int, h=int, caption=PageCaption} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockOrderedList.md b/old_docs/API_docs_v109/constructors/pageBlockOrderedList.md new file mode 100644 index 00000000..04632128 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockOrderedList.md @@ -0,0 +1,38 @@ +--- +title: pageBlockOrderedList +description: Ordered list of IV blocks +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockOrderedList +[Back to constructors index](index.md) + + + +Ordered list of IV blocks + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|items|Array of [PageListOrderedItem](../types/PageListOrderedItem.md) | Yes|Items| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockOrderedList = ['_' => 'pageBlockOrderedList', 'items' => [PageListOrderedItem, PageListOrderedItem]]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockOrderedList={_='pageBlockOrderedList', items={PageListOrderedItem}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockParagraph.md b/old_docs/API_docs_v109/constructors/pageBlockParagraph.md new file mode 100644 index 00000000..0c25d546 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockParagraph.md @@ -0,0 +1,38 @@ +--- +title: pageBlockParagraph +description: A paragraph +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockParagraph +[Back to constructors index](index.md) + + + +A paragraph + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockParagraph = ['_' => 'pageBlockParagraph', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockParagraph={_='pageBlockParagraph', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockPhoto.md b/old_docs/API_docs_v109/constructors/pageBlockPhoto.md new file mode 100644 index 00000000..c4c9115e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockPhoto.md @@ -0,0 +1,41 @@ +--- +title: pageBlockPhoto +description: A photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pageBlockPhoto +[Back to constructors index](index.md) + + + +A photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|photo\_id|[long](../types/long.md) | Yes|Photo ID| +|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption| +|url|[string](../types/string.md) | Optional|HTTP URL of page the photo leads to when clicked| +|webpage\_id|[long](../types/long.md) | Optional|ID of preview of the page the photo leads to when clicked| + + + +### Type: [PageBlock](../types/PageBlock.md) + + +### Example: + +```php +$pageBlockPhoto = ['_' => 'pageBlockPhoto', 'photo_id' => long, 'caption' => PageCaption, 'url' => 'string', 'webpage_id' => long]; +``` + + +Or, if you're into Lua: + +```lua +pageBlockPhoto={_='pageBlockPhoto', photo_id=long, caption=PageCaption, url='string', webpage_id=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pageBlockPreformatted.md b/old_docs/API_docs_v109/constructors/pageBlockPreformatted.md new file mode 100644 index 00000000..837c444a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pageBlockPreformatted.md @@ -0,0 +1,39 @@ +--- +title: pageBlockPreformatted +description: Preformatted (`
` text)
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageBlockPreformatted  
+[Back to constructors index](index.md)
+
+
+
+Preformatted (`
` text)
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|text|[RichText](../types/RichText.md) | Yes|Text|
+|language|[string](../types/string.md) | Yes|Programming language of preformatted text|
+
+
+
+### Type: [PageBlock](../types/PageBlock.md)
+
+
+### Example:
+
+```php
+$pageBlockPreformatted = ['_' => 'pageBlockPreformatted', 'text' => RichText, 'language' => 'string'];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageBlockPreformatted={_='pageBlockPreformatted', text=RichText, language='string'}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageBlockPullquote.md b/old_docs/API_docs_v109/constructors/pageBlockPullquote.md
new file mode 100644
index 00000000..700f4fc0
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageBlockPullquote.md
@@ -0,0 +1,39 @@
+---
+title: pageBlockPullquote
+description: Pullquote
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageBlockPullquote  
+[Back to constructors index](index.md)
+
+
+
+Pullquote
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|text|[RichText](../types/RichText.md) | Yes|Text|
+|caption|[RichText](../types/RichText.md) | Yes|Caption|
+
+
+
+### Type: [PageBlock](../types/PageBlock.md)
+
+
+### Example:
+
+```php
+$pageBlockPullquote = ['_' => 'pageBlockPullquote', 'text' => RichText, 'caption' => RichText];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageBlockPullquote={_='pageBlockPullquote', text=RichText, caption=RichText}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageBlockRelatedArticles.md b/old_docs/API_docs_v109/constructors/pageBlockRelatedArticles.md
new file mode 100644
index 00000000..e20ed00c
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageBlockRelatedArticles.md
@@ -0,0 +1,39 @@
+---
+title: pageBlockRelatedArticles
+description: Related articles
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageBlockRelatedArticles  
+[Back to constructors index](index.md)
+
+
+
+Related articles
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|title|[RichText](../types/RichText.md) | Yes|Title|
+|articles|Array of [PageRelatedArticle](../types/PageRelatedArticle.md) | Yes|Articles|
+
+
+
+### Type: [PageBlock](../types/PageBlock.md)
+
+
+### Example:
+
+```php
+$pageBlockRelatedArticles = ['_' => 'pageBlockRelatedArticles', 'title' => RichText, 'articles' => [PageRelatedArticle, PageRelatedArticle]];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageBlockRelatedArticles={_='pageBlockRelatedArticles', title=RichText, articles={PageRelatedArticle}}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageBlockSlideshow.md b/old_docs/API_docs_v109/constructors/pageBlockSlideshow.md
new file mode 100644
index 00000000..224f2330
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageBlockSlideshow.md
@@ -0,0 +1,39 @@
+---
+title: pageBlockSlideshow
+description: Slideshow
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageBlockSlideshow  
+[Back to constructors index](index.md)
+
+
+
+Slideshow
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|items|Array of [PageBlock](../types/PageBlock.md) | Yes|Items|
+|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption|
+
+
+
+### Type: [PageBlock](../types/PageBlock.md)
+
+
+### Example:
+
+```php
+$pageBlockSlideshow = ['_' => 'pageBlockSlideshow', 'items' => [PageBlock, PageBlock], 'caption' => PageCaption];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageBlockSlideshow={_='pageBlockSlideshow', items={PageBlock}, caption=PageCaption}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageBlockSubheader.md b/old_docs/API_docs_v109/constructors/pageBlockSubheader.md
new file mode 100644
index 00000000..600ddbd1
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageBlockSubheader.md
@@ -0,0 +1,38 @@
+---
+title: pageBlockSubheader
+description: Subheader
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageBlockSubheader  
+[Back to constructors index](index.md)
+
+
+
+Subheader
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|text|[RichText](../types/RichText.md) | Yes|Subheader|
+
+
+
+### Type: [PageBlock](../types/PageBlock.md)
+
+
+### Example:
+
+```php
+$pageBlockSubheader = ['_' => 'pageBlockSubheader', 'text' => RichText];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageBlockSubheader={_='pageBlockSubheader', text=RichText}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageBlockSubtitle.md b/old_docs/API_docs_v109/constructors/pageBlockSubtitle.md
new file mode 100644
index 00000000..8164a832
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageBlockSubtitle.md
@@ -0,0 +1,38 @@
+---
+title: pageBlockSubtitle
+description: Subtitle
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageBlockSubtitle  
+[Back to constructors index](index.md)
+
+
+
+Subtitle
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|text|[RichText](../types/RichText.md) | Yes|Text|
+
+
+
+### Type: [PageBlock](../types/PageBlock.md)
+
+
+### Example:
+
+```php
+$pageBlockSubtitle = ['_' => 'pageBlockSubtitle', 'text' => RichText];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageBlockSubtitle={_='pageBlockSubtitle', text=RichText}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageBlockTable.md b/old_docs/API_docs_v109/constructors/pageBlockTable.md
new file mode 100644
index 00000000..049afebb
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageBlockTable.md
@@ -0,0 +1,41 @@
+---
+title: pageBlockTable
+description: Table
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageBlockTable  
+[Back to constructors index](index.md)
+
+
+
+Table
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|bordered|[Bool](../types/Bool.md) | Optional|Does the table have a visible border?|
+|striped|[Bool](../types/Bool.md) | Optional|Is the table striped?|
+|title|[RichText](../types/RichText.md) | Yes|Title|
+|rows|Array of [PageTableRow](../types/PageTableRow.md) | Yes|Rows|
+
+
+
+### Type: [PageBlock](../types/PageBlock.md)
+
+
+### Example:
+
+```php
+$pageBlockTable = ['_' => 'pageBlockTable', 'bordered' => Bool, 'striped' => Bool, 'title' => RichText, 'rows' => [PageTableRow, PageTableRow]];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageBlockTable={_='pageBlockTable', bordered=Bool, striped=Bool, title=RichText, rows={PageTableRow}}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageBlockTitle.md b/old_docs/API_docs_v109/constructors/pageBlockTitle.md
new file mode 100644
index 00000000..ffe57558
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageBlockTitle.md
@@ -0,0 +1,38 @@
+---
+title: pageBlockTitle
+description: Title
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageBlockTitle  
+[Back to constructors index](index.md)
+
+
+
+Title
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|text|[RichText](../types/RichText.md) | Yes|Title|
+
+
+
+### Type: [PageBlock](../types/PageBlock.md)
+
+
+### Example:
+
+```php
+$pageBlockTitle = ['_' => 'pageBlockTitle', 'text' => RichText];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageBlockTitle={_='pageBlockTitle', text=RichText}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageBlockUnsupported.md b/old_docs/API_docs_v109/constructors/pageBlockUnsupported.md
new file mode 100644
index 00000000..52927ae3
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageBlockUnsupported.md
@@ -0,0 +1,33 @@
+---
+title: pageBlockUnsupported
+description: Unsupported IV element
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageBlockUnsupported  
+[Back to constructors index](index.md)
+
+
+
+Unsupported IV element
+
+
+
+
+### Type: [PageBlock](../types/PageBlock.md)
+
+
+### Example:
+
+```php
+$pageBlockUnsupported = ['_' => 'pageBlockUnsupported'];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageBlockUnsupported={_='pageBlockUnsupported'}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageBlockVideo.md b/old_docs/API_docs_v109/constructors/pageBlockVideo.md
new file mode 100644
index 00000000..57a55aaa
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageBlockVideo.md
@@ -0,0 +1,41 @@
+---
+title: pageBlockVideo
+description: Video
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageBlockVideo  
+[Back to constructors index](index.md)
+
+
+
+Video
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|autoplay|[Bool](../types/Bool.md) | Optional|Whether the video is set to autoplay|
+|loop|[Bool](../types/Bool.md) | Optional|Whether the video is set to loop|
+|video\_id|[long](../types/long.md) | Yes|Video ID|
+|caption|[PageCaption](../types/PageCaption.md) | Yes|Caption|
+
+
+
+### Type: [PageBlock](../types/PageBlock.md)
+
+
+### Example:
+
+```php
+$pageBlockVideo = ['_' => 'pageBlockVideo', 'autoplay' => Bool, 'loop' => Bool, 'video_id' => long, 'caption' => PageCaption];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageBlockVideo={_='pageBlockVideo', autoplay=Bool, loop=Bool, video_id=long, caption=PageCaption}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageCaption.md b/old_docs/API_docs_v109/constructors/pageCaption.md
new file mode 100644
index 00000000..323f2925
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageCaption.md
@@ -0,0 +1,39 @@
+---
+title: pageCaption
+description: Page caption
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageCaption  
+[Back to constructors index](index.md)
+
+
+
+Page caption
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|text|[RichText](../types/RichText.md) | Yes|Caption|
+|credit|[RichText](../types/RichText.md) | Yes|Credits|
+
+
+
+### Type: [PageCaption](../types/PageCaption.md)
+
+
+### Example:
+
+```php
+$pageCaption = ['_' => 'pageCaption', 'text' => RichText, 'credit' => RichText];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageCaption={_='pageCaption', text=RichText, credit=RichText}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageListItemBlocks.md b/old_docs/API_docs_v109/constructors/pageListItemBlocks.md
new file mode 100644
index 00000000..935652de
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageListItemBlocks.md
@@ -0,0 +1,38 @@
+---
+title: pageListItemBlocks
+description: List item
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageListItemBlocks  
+[Back to constructors index](index.md)
+
+
+
+List item
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes|Blocks|
+
+
+
+### Type: [PageListItem](../types/PageListItem.md)
+
+
+### Example:
+
+```php
+$pageListItemBlocks = ['_' => 'pageListItemBlocks', 'blocks' => [PageBlock, PageBlock]];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageListItemBlocks={_='pageListItemBlocks', blocks={PageBlock}}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageListItemText.md b/old_docs/API_docs_v109/constructors/pageListItemText.md
new file mode 100644
index 00000000..d41f65c0
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageListItemText.md
@@ -0,0 +1,38 @@
+---
+title: pageListItemText
+description: List item
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageListItemText  
+[Back to constructors index](index.md)
+
+
+
+List item
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|text|[RichText](../types/RichText.md) | Yes|Text|
+
+
+
+### Type: [PageListItem](../types/PageListItem.md)
+
+
+### Example:
+
+```php
+$pageListItemText = ['_' => 'pageListItemText', 'text' => RichText];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageListItemText={_='pageListItemText', text=RichText}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageListOrderedItemBlocks.md b/old_docs/API_docs_v109/constructors/pageListOrderedItemBlocks.md
new file mode 100644
index 00000000..0982d82e
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageListOrderedItemBlocks.md
@@ -0,0 +1,39 @@
+---
+title: pageListOrderedItemBlocks
+description: Ordered list of [IV](https://instantview.telegram.org) blocks
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageListOrderedItemBlocks  
+[Back to constructors index](index.md)
+
+
+
+Ordered list of [IV](https://instantview.telegram.org) blocks
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|num|[string](../types/string.md) | Yes|Number of element within ordered list|
+|blocks|Array of [PageBlock](../types/PageBlock.md) | Yes|Blocks|
+
+
+
+### Type: [PageListOrderedItem](../types/PageListOrderedItem.md)
+
+
+### Example:
+
+```php
+$pageListOrderedItemBlocks = ['_' => 'pageListOrderedItemBlocks', 'num' => 'string', 'blocks' => [PageBlock, PageBlock]];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageListOrderedItemBlocks={_='pageListOrderedItemBlocks', num='string', blocks={PageBlock}}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageListOrderedItemText.md b/old_docs/API_docs_v109/constructors/pageListOrderedItemText.md
new file mode 100644
index 00000000..de4b66dd
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageListOrderedItemText.md
@@ -0,0 +1,39 @@
+---
+title: pageListOrderedItemText
+description: Ordered list of text items
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageListOrderedItemText  
+[Back to constructors index](index.md)
+
+
+
+Ordered list of text items
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|num|[string](../types/string.md) | Yes|Number of element within ordered list|
+|text|[RichText](../types/RichText.md) | Yes|Text|
+
+
+
+### Type: [PageListOrderedItem](../types/PageListOrderedItem.md)
+
+
+### Example:
+
+```php
+$pageListOrderedItemText = ['_' => 'pageListOrderedItemText', 'num' => 'string', 'text' => RichText];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageListOrderedItemText={_='pageListOrderedItemText', num='string', text=RichText}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageRelatedArticle.md b/old_docs/API_docs_v109/constructors/pageRelatedArticle.md
new file mode 100644
index 00000000..917b0ba9
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageRelatedArticle.md
@@ -0,0 +1,44 @@
+---
+title: pageRelatedArticle
+description: Related article
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageRelatedArticle  
+[Back to constructors index](index.md)
+
+
+
+Related article
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|url|[string](../types/string.md) | Yes|URL of article|
+|webpage\_id|[long](../types/long.md) | Yes|Webpage ID of generated IV preview|
+|title|[string](../types/string.md) | Optional|Title|
+|description|[string](../types/string.md) | Optional|Description|
+|photo\_id|[long](../types/long.md) | Optional|ID of preview photo|
+|author|[string](../types/string.md) | Optional|Author name|
+|published\_date|[int](../types/int.md) | Optional|Date of pubblication|
+
+
+
+### Type: [PageRelatedArticle](../types/PageRelatedArticle.md)
+
+
+### Example:
+
+```php
+$pageRelatedArticle = ['_' => 'pageRelatedArticle', 'url' => 'string', 'webpage_id' => long, 'title' => 'string', 'description' => 'string', 'photo_id' => long, 'author' => 'string', 'published_date' => int];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageRelatedArticle={_='pageRelatedArticle', url='string', webpage_id=long, title='string', description='string', photo_id=long, author='string', published_date=int}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageTableCell.md b/old_docs/API_docs_v109/constructors/pageTableCell.md
new file mode 100644
index 00000000..2249b3e4
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageTableCell.md
@@ -0,0 +1,45 @@
+---
+title: pageTableCell
+description: Table cell
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageTableCell  
+[Back to constructors index](index.md)
+
+
+
+Table cell
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|header|[Bool](../types/Bool.md) | Optional|Is this element part of the column header|
+|align\_center|[Bool](../types/Bool.md) | Optional|Horizontally centered block|
+|align\_right|[Bool](../types/Bool.md) | Optional|Right-aligned block|
+|valign\_middle|[Bool](../types/Bool.md) | Optional|Vertically centered block|
+|valign\_bottom|[Bool](../types/Bool.md) | Optional|Block vertically-alligned to the bottom|
+|text|[RichText](../types/RichText.md) | Optional|Content|
+|colspan|[int](../types/int.md) | Optional|For how many columns should this cell extend|
+|rowspan|[int](../types/int.md) | Optional|For how many rows should this cell extend|
+
+
+
+### Type: [PageTableCell](../types/PageTableCell.md)
+
+
+### Example:
+
+```php
+$pageTableCell = ['_' => 'pageTableCell', 'header' => Bool, 'align_center' => Bool, 'align_right' => Bool, 'valign_middle' => Bool, 'valign_bottom' => Bool, 'text' => RichText, 'colspan' => int, 'rowspan' => int];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageTableCell={_='pageTableCell', header=Bool, align_center=Bool, align_right=Bool, valign_middle=Bool, valign_bottom=Bool, text=RichText, colspan=int, rowspan=int}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/pageTableRow.md b/old_docs/API_docs_v109/constructors/pageTableRow.md
new file mode 100644
index 00000000..5d5148b8
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/pageTableRow.md
@@ -0,0 +1,38 @@
+---
+title: pageTableRow
+description: Table row
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: pageTableRow  
+[Back to constructors index](index.md)
+
+
+
+Table row
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|cells|Array of [PageTableCell](../types/PageTableCell.md) | Yes|Cells|
+
+
+
+### Type: [PageTableRow](../types/PageTableRow.md)
+
+
+### Example:
+
+```php
+$pageTableRow = ['_' => 'pageTableRow', 'cells' => [PageTableCell, PageTableCell]];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+pageTableRow={_='pageTableRow', cells={PageTableCell}}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md b/old_docs/API_docs_v109/constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md
new file mode 100644
index 00000000..3491c657
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md
@@ -0,0 +1,41 @@
+---
+title: passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow
+description: This key derivation algorithm defines that [SRP 2FA login](https://core.telegram.org/api/srp) must be used
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow  
+[Back to constructors index](index.md)
+
+
+
+This key derivation algorithm defines that [SRP 2FA login](https://core.telegram.org/api/srp) must be used
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|salt1|[bytes](../types/bytes.md) | Yes|One of two salts used by the derivation function (see [SRP 2FA login](https://core.telegram.org/api/srp))|
+|salt2|[bytes](../types/bytes.md) | Yes|One of two salts used by the derivation function (see [SRP 2FA login](https://core.telegram.org/api/srp))|
+|g|[int](../types/int.md) | Yes|Base (see [SRP 2FA login](https://core.telegram.org/api/srp))|
+|p|[bytes](../types/bytes.md) | Yes|2048-bit modulus (see [SRP 2FA login](https://core.telegram.org/api/srp))|
+
+
+
+### Type: [PasswordKdfAlgo](../types/PasswordKdfAlgo.md)
+
+
+### Example:
+
+```php
+$passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow = ['_' => 'passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow', 'salt1' => 'bytes', 'salt2' => 'bytes', 'g' => int, 'p' => 'bytes'];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow={_='passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow', salt1='bytes', salt2='bytes', g=int, p='bytes'}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/passwordKdfAlgoUnknown.md b/old_docs/API_docs_v109/constructors/passwordKdfAlgoUnknown.md
new file mode 100644
index 00000000..02ea7f8e
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/passwordKdfAlgoUnknown.md
@@ -0,0 +1,33 @@
+---
+title: passwordKdfAlgoUnknown
+description: Unknown KDF (most likely, the client is outdated and does not support the specified KDF algorithm)
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: passwordKdfAlgoUnknown  
+[Back to constructors index](index.md)
+
+
+
+Unknown KDF (most likely, the client is outdated and does not support the specified KDF algorithm)
+
+
+
+
+### Type: [PasswordKdfAlgo](../types/PasswordKdfAlgo.md)
+
+
+### Example:
+
+```php
+$passwordKdfAlgoUnknown = ['_' => 'passwordKdfAlgoUnknown'];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+passwordKdfAlgoUnknown={_='passwordKdfAlgoUnknown'}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/paymentCharge.md b/old_docs/API_docs_v109/constructors/paymentCharge.md
new file mode 100644
index 00000000..ef51d80b
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/paymentCharge.md
@@ -0,0 +1,39 @@
+---
+title: paymentCharge
+description: Payment identifier
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: paymentCharge  
+[Back to constructors index](index.md)
+
+
+
+Payment identifier
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|id|[string](../types/string.md) | Yes|Telegram payment identifier|
+|provider\_charge\_id|[string](../types/string.md) | Yes|Provider payment identifier|
+
+
+
+### Type: [PaymentCharge](../types/PaymentCharge.md)
+
+
+### Example:
+
+```php
+$paymentCharge = ['_' => 'paymentCharge', 'id' => 'string', 'provider_charge_id' => 'string'];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+paymentCharge={_='paymentCharge', id='string', provider_charge_id='string'}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/paymentRequestedInfo.md b/old_docs/API_docs_v109/constructors/paymentRequestedInfo.md
new file mode 100644
index 00000000..ec4bd7cf
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/paymentRequestedInfo.md
@@ -0,0 +1,41 @@
+---
+title: paymentRequestedInfo
+description: Order info provided by the user
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: paymentRequestedInfo  
+[Back to constructors index](index.md)
+
+
+
+Order info provided by the user
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|name|[string](../types/string.md) | Optional|User's full name|
+|phone|[string](../types/string.md) | Optional|User's phone number|
+|email|[string](../types/string.md) | Optional|User's email address|
+|shipping\_address|[PostAddress](../types/PostAddress.md) | Optional|User's shipping address|
+
+
+
+### Type: [PaymentRequestedInfo](../types/PaymentRequestedInfo.md)
+
+
+### Example:
+
+```php
+$paymentRequestedInfo = ['_' => 'paymentRequestedInfo', 'name' => 'string', 'phone' => 'string', 'email' => 'string', 'shipping_address' => PostAddress];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+paymentRequestedInfo={_='paymentRequestedInfo', name='string', phone='string', email='string', shipping_address=PostAddress}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/paymentSavedCredentialsCard.md b/old_docs/API_docs_v109/constructors/paymentSavedCredentialsCard.md
new file mode 100644
index 00000000..83f3b314
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/paymentSavedCredentialsCard.md
@@ -0,0 +1,39 @@
+---
+title: paymentSavedCredentialsCard
+description: Saved credit card
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+---
+# Constructor: paymentSavedCredentialsCard  
+[Back to constructors index](index.md)
+
+
+
+Saved credit card
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|id|[string](../types/string.md) | Yes|Card ID|
+|title|[string](../types/string.md) | Yes|Title|
+
+
+
+### Type: [PaymentSavedCredentials](../types/PaymentSavedCredentials.md)
+
+
+### Example:
+
+```php
+$paymentSavedCredentialsCard = ['_' => 'paymentSavedCredentialsCard', 'id' => 'string', 'title' => 'string'];
+```  
+
+
+Or, if you're into Lua:
+
+```lua
+paymentSavedCredentialsCard={_='paymentSavedCredentialsCard', id='string', title='string'}
+
+```
+
+
diff --git a/old_docs/API_docs_v109/constructors/payments.paymentForm.md b/old_docs/API_docs_v109/constructors/payments.paymentForm.md
new file mode 100644
index 00000000..fda8519d
--- /dev/null
+++ b/old_docs/API_docs_v109/constructors/payments.paymentForm.md
@@ -0,0 +1,49 @@
+---
+title: payments.paymentForm
+description: Payment form
+image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
+redirect_from: /API_docs/constructors/payments_paymentForm.html
+---
+# Constructor: payments.paymentForm  
+[Back to constructors index](index.md)
+
+
+
+Payment form
+
+### Attributes:
+
+| Name     |    Type       | Required | Description |
+|----------|---------------|----------|-------------|
+|can\_save\_credentials|[Bool](../types/Bool.md) | Optional|Whether the user can choose to save credentials.|
+|password\_missing|[Bool](../types/Bool.md) | Optional|Indicates that the user can save payment credentials, but only after setting up a [2FA password](https://core.telegram.org/api/srp) (currently the account doesn't have a [2FA password](https://core.telegram.org/api/srp))|
+|bot\_id|[int](../types/int.md) | Yes|Bot ID|
+|invoice|[Invoice](../types/Invoice.md) | Yes|Invoice|
+|provider\_id|[int](../types/int.md) | Yes|Payment provider ID.|
+|url|[string](../types/string.md) | Yes|Payment form URL|
+|native\_provider|[string](../types/string.md) | Optional|Payment provider name.
One of the following:
\- `stripe`| +|native\_params|[DataJSON](../types/DataJSON.md) | Optional|Contains information about the payment provider, if available, to support it natively without the need for opening the URL.
A JSON object that can contain the following fields:

\- `publishable_key`: Stripe API publishable key
\- `apple_pay_merchant_id`: Apple Pay merchant ID
\- `android_pay_public_key`: Android Pay public key
\- `android_pay_bgcolor`: Android Pay form background color
\- `android_pay_inverse`: Whether to use the dark theme in the Android Pay form
\- `need_country`: True, if the user country must be provided,
\- `need_zip`: True, if the user ZIP/postal code must be provided,
\- `need_cardholder_name`: True, if the cardholder name must be provided
| +|saved\_info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional|Saved server-side order information| +|saved\_credentials|[PaymentSavedCredentials](../types/PaymentSavedCredentials.md) | Optional|Contains information about saved card credentials| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [payments.PaymentForm](../types/payments.PaymentForm.md) + + +### Example: + +```php +$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]]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/payments.paymentReceipt.md b/old_docs/API_docs_v109/constructors/payments.paymentReceipt.md new file mode 100644 index 00000000..0dea8fbe --- /dev/null +++ b/old_docs/API_docs_v109/constructors/payments.paymentReceipt.md @@ -0,0 +1,48 @@ +--- +title: payments.paymentReceipt +description: Receipt +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_paymentReceipt.html +--- +# Constructor: payments.paymentReceipt +[Back to constructors index](index.md) + + + +Receipt + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|date|[int](../types/int.md) | Yes|Date of generation| +|bot\_id|[int](../types/int.md) | Yes|Bot ID| +|invoice|[Invoice](../types/Invoice.md) | Yes|Invoice| +|provider\_id|[int](../types/int.md) | Yes|Provider ID| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional|Info| +|shipping|[ShippingOption](../types/ShippingOption.md) | Optional|Selected shipping option| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|total\_amount|[long](../types/long.md) | Yes|Total amount in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| +|credentials\_title|[string](../types/string.md) | Yes|Payment credential name| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [payments.PaymentReceipt](../types/payments.PaymentReceipt.md) + + +### Example: + +```php +$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]]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/payments.paymentResult.md b/old_docs/API_docs_v109/constructors/payments.paymentResult.md new file mode 100644 index 00000000..46b129d3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/payments.paymentResult.md @@ -0,0 +1,39 @@ +--- +title: payments.paymentResult +description: Payment result +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_paymentResult.html +--- +# Constructor: payments.paymentResult +[Back to constructors index](index.md) + + + +Payment result + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|updates|[Updates](../types/Updates.md) | Yes|Info about the payment| + + + +### Type: [payments.PaymentResult](../types/payments.PaymentResult.md) + + +### Example: + +```php +$payments.paymentResult = ['_' => 'payments.paymentResult', 'updates' => Updates]; +``` + + +Or, if you're into Lua: + +```lua +payments.paymentResult={_='payments.paymentResult', updates=Updates} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/payments.paymentVerificationNeeded.md b/old_docs/API_docs_v109/constructors/payments.paymentVerificationNeeded.md new file mode 100644 index 00000000..a640f5b5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/payments.paymentVerificationNeeded.md @@ -0,0 +1,39 @@ +--- +title: payments.paymentVerificationNeeded +description: Payment was not successful, additional verification is needed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_paymentVerificationNeeded.html +--- +# Constructor: payments.paymentVerificationNeeded +[Back to constructors index](index.md) + + + +Payment was not successful, additional verification is needed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL for additional payment credentials verification| + + + +### Type: [payments.PaymentResult](../types/payments.PaymentResult.md) + + +### Example: + +```php +$payments.paymentVerificationNeeded = ['_' => 'payments.paymentVerificationNeeded', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +payments.paymentVerificationNeeded={_='payments.paymentVerificationNeeded', url='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/payments.savedInfo.md b/old_docs/API_docs_v109/constructors/payments.savedInfo.md new file mode 100644 index 00000000..09e78c54 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/payments.savedInfo.md @@ -0,0 +1,40 @@ +--- +title: payments.savedInfo +description: Saved server-side order information +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_savedInfo.html +--- +# Constructor: payments.savedInfo +[Back to constructors index](index.md) + + + +Saved server-side order information + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|has\_saved\_credentials|[Bool](../types/Bool.md) | Optional|Whether the user has some saved payment credentials| +|saved\_info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional|Saved server-side order information| + + + +### Type: [payments.SavedInfo](../types/payments.SavedInfo.md) + + +### Example: + +```php +$payments.savedInfo = ['_' => 'payments.savedInfo', 'has_saved_credentials' => Bool, 'saved_info' => PaymentRequestedInfo]; +``` + + +Or, if you're into Lua: + +```lua +payments.savedInfo={_='payments.savedInfo', has_saved_credentials=Bool, saved_info=PaymentRequestedInfo} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/payments.validatedRequestedInfo.md b/old_docs/API_docs_v109/constructors/payments.validatedRequestedInfo.md new file mode 100644 index 00000000..62130156 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/payments.validatedRequestedInfo.md @@ -0,0 +1,40 @@ +--- +title: payments.validatedRequestedInfo +description: Validated user-provided info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/payments_validatedRequestedInfo.html +--- +# Constructor: payments.validatedRequestedInfo +[Back to constructors index](index.md) + + + +Validated user-provided info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Optional|ID| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| + + + +### Type: [payments.ValidatedRequestedInfo](../types/payments.ValidatedRequestedInfo.md) + + +### Example: + +```php +$payments.validatedRequestedInfo = ['_' => 'payments.validatedRequestedInfo', 'id' => 'string', 'shipping_options' => [ShippingOption, ShippingOption]]; +``` + + +Or, if you're into Lua: + +```lua +payments.validatedRequestedInfo={_='payments.validatedRequestedInfo', id='string', shipping_options={ShippingOption}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/peerChannel.md b/old_docs/API_docs_v109/constructors/peerChannel.md new file mode 100644 index 00000000..bdedbf22 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/peerChannel.md @@ -0,0 +1,38 @@ +--- +title: peerChannel +description: Channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerChannel +[Back to constructors index](index.md) + + + +Channel/supergroup + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel ID| + + + +### Type: [Peer](../types/Peer.md) + + +### Example: + +```php +$peerChannel = ['_' => 'peerChannel', 'channel_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +peerChannel={_='peerChannel', channel_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/peerChat.md b/old_docs/API_docs_v109/constructors/peerChat.md new file mode 100644 index 00000000..05a951cd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/peerChat.md @@ -0,0 +1,38 @@ +--- +title: peerChat +description: Group. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerChat +[Back to constructors index](index.md) + + + +Group. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|Group identifier| + + + +### Type: [Peer](../types/Peer.md) + + +### Example: + +```php +$peerChat = ['_' => 'peerChat', 'chat_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +peerChat={_='peerChat', chat_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/peerLocated.md b/old_docs/API_docs_v109/constructors/peerLocated.md new file mode 100644 index 00000000..125dc1d9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/peerLocated.md @@ -0,0 +1,40 @@ +--- +title: peerLocated +description: Peer geolocated nearby +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerLocated +[Back to constructors index](index.md) + + + +Peer geolocated nearby + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|Peer| +|expires|[int](../types/int.md) | Yes|Validity period of current data| +|distance|[int](../types/int.md) | Yes|Distance from the peer in meters| + + + +### Type: [PeerLocated](../types/PeerLocated.md) + + +### Example: + +```php +$peerLocated = ['_' => 'peerLocated', 'peer' => Peer, 'expires' => int, 'distance' => int]; +``` + + +Or, if you're into Lua: + +```lua +peerLocated={_='peerLocated', peer=Peer, expires=int, distance=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/peerNotifySettings.md b/old_docs/API_docs_v109/constructors/peerNotifySettings.md new file mode 100644 index 00000000..580bbfe2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/peerNotifySettings.md @@ -0,0 +1,41 @@ +--- +title: peerNotifySettings +description: Notification settings. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerNotifySettings +[Back to constructors index](index.md) + + + +Notification settings. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|show\_previews|[Bool](../types/Bool.md) | Optional|Display text in notifications| +|silent|[Bool](../types/Bool.md) | Optional|Mute peer?| +|mute\_until|[int](../types/int.md) | Optional|Mute all notifications until this date| +|sound|[string](../types/string.md) | Optional|Audio file name for notifications| + + + +### Type: [PeerNotifySettings](../types/PeerNotifySettings.md) + + +### Example: + +```php +$peerNotifySettings = ['_' => 'peerNotifySettings', 'show_previews' => Bool, 'silent' => Bool, 'mute_until' => int, 'sound' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +peerNotifySettings={_='peerNotifySettings', show_previews=Bool, silent=Bool, mute_until=int, sound='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/peerSettings.md b/old_docs/API_docs_v109/constructors/peerSettings.md new file mode 100644 index 00000000..1f1643f3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/peerSettings.md @@ -0,0 +1,43 @@ +--- +title: peerSettings +description: Peer settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerSettings +[Back to constructors index](index.md) + + + +Peer settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|report\_spam|[Bool](../types/Bool.md) | Optional|Whether we can still report the user for spam| +|add\_contact|[Bool](../types/Bool.md) | Optional|Whether we can add the user as contact| +|block\_contact|[Bool](../types/Bool.md) | Optional|Whether we can block the user| +|share\_contact|[Bool](../types/Bool.md) | Optional|Whether we can share the user's contact| +|need\_contacts\_exception|[Bool](../types/Bool.md) | Optional|Whether a special exception for contacts is needed| +|report\_geo|[Bool](../types/Bool.md) | Optional|Whether we can report a geogroup is irrelevant for this location| + + + +### Type: [PeerSettings](../types/PeerSettings.md) + + +### Example: + +```php +$peerSettings = ['_' => 'peerSettings', 'report_spam' => Bool, 'add_contact' => Bool, 'block_contact' => Bool, 'share_contact' => Bool, 'need_contacts_exception' => Bool, 'report_geo' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +peerSettings={_='peerSettings', report_spam=Bool, add_contact=Bool, block_contact=Bool, share_contact=Bool, need_contacts_exception=Bool, report_geo=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/peerUser.md b/old_docs/API_docs_v109/constructors/peerUser.md new file mode 100644 index 00000000..2497e186 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/peerUser.md @@ -0,0 +1,38 @@ +--- +title: peerUser +description: Chat partner +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: peerUser +[Back to constructors index](index.md) + + + +Chat partner + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User identifier| + + + +### Type: [Peer](../types/Peer.md) + + +### Example: + +```php +$peerUser = ['_' => 'peerUser', 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +peerUser={_='peerUser', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/phone.phoneCall.md b/old_docs/API_docs_v109/constructors/phone.phoneCall.md new file mode 100644 index 00000000..d13ed32a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phone.phoneCall.md @@ -0,0 +1,40 @@ +--- +title: phone.phoneCall +description: A VoIP phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/phone_phoneCall.html +--- +# Constructor: phone.phoneCall +[Back to constructors index](index.md) + + + +A VoIP phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_call|[PhoneCall](../types/PhoneCall.md) | Optional|The VoIP phone call| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [phone.PhoneCall](../types/phone.PhoneCall.md) + + +### Example: + +```php +$phone.phoneCall = ['_' => 'phone.phoneCall', 'phone_call' => PhoneCall, 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +phone.phoneCall={_='phone.phoneCall', phone_call=PhoneCall, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/phoneCall.md b/old_docs/API_docs_v109/constructors/phoneCall.md new file mode 100644 index 00000000..d058d0cb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneCall.md @@ -0,0 +1,48 @@ +--- +title: phoneCall +description: Phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCall +[Back to constructors index](index.md) + + + +Phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|p2p\_allowed|[Bool](../types/Bool.md) | Optional|Whether P2P connection to the other peer is allowed| +|id|[long](../types/long.md) | Yes|Call ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|date|[int](../types/int.md) | Yes|Date of creation of the call| +|admin\_id|[int](../types/int.md) | Yes|User ID of the creator of the call| +|participant\_id|[int](../types/int.md) | Yes|User ID of the other participant in the call| +|g\_a\_or\_b|[bytes](../types/bytes.md) | Yes|[Parameter for key exchange](https://core.telegram.org/api/end-to-end/voice-calls)| +|key\_fingerprint|[long](../types/long.md) | Yes|[Key fingerprint](https://core.telegram.org/api/end-to-end/voice-calls)| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes|Call protocol info to be passed to libtgvoip| +|connections|Array of [PhoneConnection](../types/PhoneConnection.md) | Yes|Phone connections| +|start\_date|[int](../types/int.md) | Yes|When was the call actually started| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$phoneCall = ['_' => 'phoneCall', 'p2p_allowed' => Bool, 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a_or_b' => 'bytes', 'key_fingerprint' => long, 'protocol' => PhoneCallProtocol, 'connections' => [PhoneConnection, PhoneConnection], 'start_date' => int]; +``` + + +Or, if you're into Lua: + +```lua +phoneCall={_='phoneCall', p2p_allowed=Bool, id=long, access_hash=long, date=int, admin_id=int, participant_id=int, g_a_or_b='bytes', key_fingerprint=long, protocol=PhoneCallProtocol, connections={PhoneConnection}, start_date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/phoneCallAccepted.md b/old_docs/API_docs_v109/constructors/phoneCallAccepted.md new file mode 100644 index 00000000..2f7a2660 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneCallAccepted.md @@ -0,0 +1,45 @@ +--- +title: phoneCallAccepted +description: An accepted phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallAccepted +[Back to constructors index](index.md) + + + +An accepted phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|video|[Bool](../types/Bool.md) | Optional|Whether this is a video call| +|id|[long](../types/long.md) | Yes|ID of accepted phone call| +|access\_hash|[long](../types/long.md) | Yes|Access hash of phone call| +|date|[int](../types/int.md) | Yes|When was the call accepted| +|admin\_id|[int](../types/int.md) | Yes|ID of the call creator| +|participant\_id|[int](../types/int.md) | Yes|ID of the other user in the call| +|g\_b|[bytes](../types/bytes.md) | Yes|B parameter for [secure E2E phone call key exchange](https://core.telegram.org/api/end-to-end/voice-calls)| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes|Protocol to use for phone call| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$phoneCallAccepted = ['_' => 'phoneCallAccepted', 'video' => Bool, 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_b' => 'bytes', 'protocol' => PhoneCallProtocol]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallAccepted={_='phoneCallAccepted', video=Bool, 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_v109/constructors/phoneCallDiscardReasonBusy.md b/old_docs/API_docs_v109/constructors/phoneCallDiscardReasonBusy.md new file mode 100644 index 00000000..97e36a67 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneCallDiscardReasonBusy.md @@ -0,0 +1,33 @@ +--- +title: phoneCallDiscardReasonBusy +description: The phone call was discared because the user is busy in another call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonBusy +[Back to constructors index](index.md) + + + +The phone call was discared because the user is busy in another call + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +```php +$phoneCallDiscardReasonBusy = ['_' => 'phoneCallDiscardReasonBusy']; +``` + + +Or, if you're into Lua: + +```lua +phoneCallDiscardReasonBusy={_='phoneCallDiscardReasonBusy'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/phoneCallDiscardReasonDisconnect.md b/old_docs/API_docs_v109/constructors/phoneCallDiscardReasonDisconnect.md new file mode 100644 index 00000000..bc7c231d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneCallDiscardReasonDisconnect.md @@ -0,0 +1,33 @@ +--- +title: phoneCallDiscardReasonDisconnect +description: The phone call was disconnected +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonDisconnect +[Back to constructors index](index.md) + + + +The phone call was disconnected + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +```php +$phoneCallDiscardReasonDisconnect = ['_' => 'phoneCallDiscardReasonDisconnect']; +``` + + +Or, if you're into Lua: + +```lua +phoneCallDiscardReasonDisconnect={_='phoneCallDiscardReasonDisconnect'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/phoneCallDiscardReasonHangup.md b/old_docs/API_docs_v109/constructors/phoneCallDiscardReasonHangup.md new file mode 100644 index 00000000..86288ba8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneCallDiscardReasonHangup.md @@ -0,0 +1,33 @@ +--- +title: phoneCallDiscardReasonHangup +description: The phone call was ended normally +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonHangup +[Back to constructors index](index.md) + + + +The phone call was ended normally + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +```php +$phoneCallDiscardReasonHangup = ['_' => 'phoneCallDiscardReasonHangup']; +``` + + +Or, if you're into Lua: + +```lua +phoneCallDiscardReasonHangup={_='phoneCallDiscardReasonHangup'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/phoneCallDiscardReasonMissed.md b/old_docs/API_docs_v109/constructors/phoneCallDiscardReasonMissed.md new file mode 100644 index 00000000..a2505a14 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneCallDiscardReasonMissed.md @@ -0,0 +1,33 @@ +--- +title: phoneCallDiscardReasonMissed +description: The phone call was missed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscardReasonMissed +[Back to constructors index](index.md) + + + +The phone call was missed + + + + +### Type: [PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) + + +### Example: + +```php +$phoneCallDiscardReasonMissed = ['_' => 'phoneCallDiscardReasonMissed']; +``` + + +Or, if you're into Lua: + +```lua +phoneCallDiscardReasonMissed={_='phoneCallDiscardReasonMissed'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/phoneCallDiscarded.md b/old_docs/API_docs_v109/constructors/phoneCallDiscarded.md new file mode 100644 index 00000000..6156f979 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneCallDiscarded.md @@ -0,0 +1,43 @@ +--- +title: phoneCallDiscarded +description: Indicates a discarded phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallDiscarded +[Back to constructors index](index.md) + + + +Indicates a discarded phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|need\_rating|[Bool](../types/Bool.md) | Optional|Whether the server required the user to [rate](../methods/phone.setCallRating.md) the call| +|need\_debug|[Bool](../types/Bool.md) | Optional|Whether the server required the client to [send](../methods/phone.saveCallDebug.md) the libtgvoip call debug data| +|video|[Bool](../types/Bool.md) | Optional|Whether the call was a video call| +|id|[long](../types/long.md) | Yes|Call ID| +|reason|[PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) | Optional|Why was the phone call discarded| +|duration|[int](../types/int.md) | Optional|Duration of the phone call in seconds| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$phoneCallDiscarded = ['_' => 'phoneCallDiscarded', 'need_rating' => Bool, 'need_debug' => Bool, 'video' => Bool, 'id' => long, 'reason' => PhoneCallDiscardReason, 'duration' => int]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallDiscarded={_='phoneCallDiscarded', need_rating=Bool, need_debug=Bool, video=Bool, id=long, reason=PhoneCallDiscardReason, duration=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/phoneCallEmpty.md b/old_docs/API_docs_v109/constructors/phoneCallEmpty.md new file mode 100644 index 00000000..0187014c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneCallEmpty.md @@ -0,0 +1,38 @@ +--- +title: phoneCallEmpty +description: Empty constructor +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallEmpty +[Back to constructors index](index.md) + + + +Empty constructor + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Call ID| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$phoneCallEmpty = ['_' => 'phoneCallEmpty', 'id' => long]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallEmpty={_='phoneCallEmpty', id=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/phoneCallProtocol.md b/old_docs/API_docs_v109/constructors/phoneCallProtocol.md new file mode 100644 index 00000000..6531ea79 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneCallProtocol.md @@ -0,0 +1,41 @@ +--- +title: phoneCallProtocol +description: Protocol info for libtgvoip +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallProtocol +[Back to constructors index](index.md) + + + +Protocol info for libtgvoip + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|udp\_p2p|[Bool](../types/Bool.md) | Optional|Whether to allow P2P connection to the other participant| +|udp\_reflector|[Bool](../types/Bool.md) | Optional|Whether to allow connection to the other participants through the reflector servers| +|min\_layer|[int](../types/int.md) | Yes|Minimum layer for remote libtgvoip| +|max\_layer|[int](../types/int.md) | Yes|Maximum layer for remote libtgvoip| + + + +### Type: [PhoneCallProtocol](../types/PhoneCallProtocol.md) + + +### Example: + +```php +$phoneCallProtocol = ['_' => 'phoneCallProtocol', 'udp_p2p' => Bool, 'udp_reflector' => Bool, 'min_layer' => int, 'max_layer' => int]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallProtocol={_='phoneCallProtocol', udp_p2p=Bool, udp_reflector=Bool, min_layer=int, max_layer=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/phoneCallRequested.md b/old_docs/API_docs_v109/constructors/phoneCallRequested.md new file mode 100644 index 00000000..cb8f40d6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneCallRequested.md @@ -0,0 +1,45 @@ +--- +title: phoneCallRequested +description: Requested phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallRequested +[Back to constructors index](index.md) + + + +Requested phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|video|[Bool](../types/Bool.md) | Optional|Whether this is a video call| +|id|[long](../types/long.md) | Yes|Phone call ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|date|[int](../types/int.md) | Yes|When was the phone call created| +|admin\_id|[int](../types/int.md) | Yes|ID of the creator of the phone call| +|participant\_id|[int](../types/int.md) | Yes|ID of the other participant of the phone call| +|g\_a\_hash|[bytes](../types/bytes.md) | Yes|[Parameter for key exchange](https://core.telegram.org/api/end-to-end/voice-calls)| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes|Call protocol info to be passed to libtgvoip| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$phoneCallRequested = ['_' => 'phoneCallRequested', 'video' => Bool, 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'g_a_hash' => 'bytes', 'protocol' => PhoneCallProtocol]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallRequested={_='phoneCallRequested', video=Bool, 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_v109/constructors/phoneCallWaiting.md b/old_docs/API_docs_v109/constructors/phoneCallWaiting.md new file mode 100644 index 00000000..17018d14 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneCallWaiting.md @@ -0,0 +1,45 @@ +--- +title: phoneCallWaiting +description: Incoming phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneCallWaiting +[Back to constructors index](index.md) + + + +Incoming phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|video|[Bool](../types/Bool.md) | Optional|Is this a video call| +|id|[long](../types/long.md) | Yes|Call ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|date|[int](../types/int.md) | Yes|Date| +|admin\_id|[int](../types/int.md) | Yes|Admin ID| +|participant\_id|[int](../types/int.md) | Yes|Participant ID| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | Yes|Phone call protocol info| +|receive\_date|[int](../types/int.md) | Optional|When was the phone call received| + + + +### Type: [PhoneCall](../types/PhoneCall.md) + + +### Example: + +```php +$phoneCallWaiting = ['_' => 'phoneCallWaiting', 'video' => Bool, 'id' => long, 'access_hash' => long, 'date' => int, 'admin_id' => int, 'participant_id' => int, 'protocol' => PhoneCallProtocol, 'receive_date' => int]; +``` + + +Or, if you're into Lua: + +```lua +phoneCallWaiting={_='phoneCallWaiting', video=Bool, 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_v109/constructors/phoneConnection.md b/old_docs/API_docs_v109/constructors/phoneConnection.md new file mode 100644 index 00000000..846c5615 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/phoneConnection.md @@ -0,0 +1,42 @@ +--- +title: phoneConnection +description: Identifies an endpoint that can be used to connect to the other user in a phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: phoneConnection +[Back to constructors index](index.md) + + + +Identifies an endpoint that can be used to connect to the other user in a phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Endpoint ID| +|ip|[string](../types/string.md) | Yes|IP address of endpoint| +|ipv6|[string](../types/string.md) | Yes|IPv6 address of endpoint| +|port|[int](../types/int.md) | Yes|Port ID| +|peer\_tag|[bytes](../types/bytes.md) | Yes|Our peer tag| + + + +### Type: [PhoneConnection](../types/PhoneConnection.md) + + +### Example: + +```php +$phoneConnection = ['_' => 'phoneConnection', 'id' => long, 'ip' => 'string', 'ipv6' => 'string', 'port' => int, 'peer_tag' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +phoneConnection={_='phoneConnection', id=long, ip='string', ipv6='string', port=int, peer_tag='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/photo.md b/old_docs/API_docs_v109/constructors/photo.md new file mode 100644 index 00000000..dbe64c67 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/photo.md @@ -0,0 +1,44 @@ +--- +title: photo +description: Photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photo +[Back to constructors index](index.md) + + + +Photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|has\_stickers|[Bool](../types/Bool.md) | Optional|Whether the photo has mask stickers attached to it| +|id|[long](../types/long.md) | Yes|ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|file\_reference|[bytes](../types/bytes.md) | Yes|[file reference](https://core.telegram.org/api/file_reference)| +|date|[int](../types/int.md) | Yes|Date of upload| +|sizes|Array of [PhotoSize](../types/PhotoSize.md) | Yes|Sizes| +|dc\_id|[int](../types/int.md) | Yes|DC ID to use for download| + + + +### Type: [Photo](../types/Photo.md) + + +### Example: + +```php +$photo = ['_' => 'photo', 'has_stickers' => Bool, 'id' => long, 'access_hash' => long, 'file_reference' => 'bytes', 'date' => int, 'sizes' => [PhotoSize, PhotoSize], 'dc_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +photo={_='photo', has_stickers=Bool, id=long, access_hash=long, file_reference='bytes', date=int, sizes={PhotoSize}, dc_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/photoCachedSize.md b/old_docs/API_docs_v109/constructors/photoCachedSize.md new file mode 100644 index 00000000..566d7400 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/photoCachedSize.md @@ -0,0 +1,42 @@ +--- +title: photoCachedSize +description: Description of an image and its content. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photoCachedSize +[Back to constructors index](index.md) + + + +Description of an image and its content. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[string](../types/string.md) | Yes|Thumbnail type| +|location|[FileLocation](../types/FileLocation.md) | Yes|File location| +|w|[int](../types/int.md) | Yes|Image width| +|h|[int](../types/int.md) | Yes|Image height| +|bytes|[bytes](../types/bytes.md) | Yes|Binary data, file content| + + + +### Type: [PhotoSize](../types/PhotoSize.md) + + +### Example: + +```php +$photoCachedSize = ['_' => 'photoCachedSize', 'type' => 'string', 'location' => FileLocation, 'w' => int, 'h' => int, 'bytes' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +photoCachedSize={_='photoCachedSize', type='string', location=FileLocation, w=int, h=int, bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/photoEmpty.md b/old_docs/API_docs_v109/constructors/photoEmpty.md new file mode 100644 index 00000000..a306e9b7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/photoEmpty.md @@ -0,0 +1,38 @@ +--- +title: photoEmpty +description: Empty constructor, non-existent photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photoEmpty +[Back to constructors index](index.md) + + + +Empty constructor, non-existent photo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Photo identifier| + + + +### Type: [Photo](../types/Photo.md) + + +### Example: + +```php +$photoEmpty = ['_' => 'photoEmpty', 'id' => long]; +``` + + +Or, if you're into Lua: + +```lua +photoEmpty={_='photoEmpty', id=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/photoSize.md b/old_docs/API_docs_v109/constructors/photoSize.md new file mode 100644 index 00000000..06ba3a09 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/photoSize.md @@ -0,0 +1,42 @@ +--- +title: photoSize +description: Image description. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photoSize +[Back to constructors index](index.md) + + + +Image description. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[string](../types/string.md) | Yes|Thumbnail type| +|location|[FileLocation](../types/FileLocation.md) | Yes|File location| +|w|[int](../types/int.md) | Yes|Image width| +|h|[int](../types/int.md) | Yes|Image height| +|size|[int](../types/int.md) | Yes|File size| + + + +### Type: [PhotoSize](../types/PhotoSize.md) + + +### Example: + +```php +$photoSize = ['_' => 'photoSize', 'type' => 'string', 'location' => FileLocation, 'w' => int, 'h' => int, 'size' => int]; +``` + + +Or, if you're into Lua: + +```lua +photoSize={_='photoSize', type='string', location=FileLocation, w=int, h=int, size=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/photoSizeEmpty.md b/old_docs/API_docs_v109/constructors/photoSizeEmpty.md new file mode 100644 index 00000000..cc7714ac --- /dev/null +++ b/old_docs/API_docs_v109/constructors/photoSizeEmpty.md @@ -0,0 +1,38 @@ +--- +title: photoSizeEmpty +description: Empty constructor. Image with this thumbnail is unavailable. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photoSizeEmpty +[Back to constructors index](index.md) + + + +Empty constructor. Image with this thumbnail is unavailable. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[string](../types/string.md) | Yes|Thumbnail type (see. [photoSize](../constructors/photoSize.md))| + + + +### Type: [PhotoSize](../types/PhotoSize.md) + + +### Example: + +```php +$photoSizeEmpty = ['_' => 'photoSizeEmpty', 'type' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +photoSizeEmpty={_='photoSizeEmpty', type='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/photoStrippedSize.md b/old_docs/API_docs_v109/constructors/photoStrippedSize.md new file mode 100644 index 00000000..adbbd5eb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/photoStrippedSize.md @@ -0,0 +1,39 @@ +--- +title: photoStrippedSize +description: Just the image's content +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: photoStrippedSize +[Back to constructors index](index.md) + + + +Just the image's content + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[string](../types/string.md) | Yes|Thumbnail type| +|bytes|[bytes](../types/bytes.md) | Yes|Thumbnail data| + + + +### Type: [PhotoSize](../types/PhotoSize.md) + + +### Example: + +```php +$photoStrippedSize = ['_' => 'photoStrippedSize', 'type' => 'string', 'bytes' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +photoStrippedSize={_='photoStrippedSize', type='string', bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/photos.photo.md b/old_docs/API_docs_v109/constructors/photos.photo.md new file mode 100644 index 00000000..883a71ba --- /dev/null +++ b/old_docs/API_docs_v109/constructors/photos.photo.md @@ -0,0 +1,40 @@ +--- +title: photos.photo +description: Photo with auxiliary data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/photos_photo.html +--- +# Constructor: photos.photo +[Back to constructors index](index.md) + + + +Photo with auxiliary data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|photo|[Photo](../types/Photo.md) | Optional|Photo| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [photos.Photo](../types/photos.Photo.md) + + +### Example: + +```php +$photos.photo = ['_' => 'photos.photo', 'photo' => Photo, 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +photos.photo={_='photos.photo', photo=Photo, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/photos.photos.md b/old_docs/API_docs_v109/constructors/photos.photos.md new file mode 100644 index 00000000..4517899a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/photos.photos.md @@ -0,0 +1,40 @@ +--- +title: photos.photos +description: Full list of photos with auxiliary data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/photos_photos.html +--- +# Constructor: photos.photos +[Back to constructors index](index.md) + + + +Full list of photos with auxiliary data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|photos|Array of [Photo](../types/Photo.md) | Yes|Photos| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [photos.Photos](../types/photos.Photos.md) + + +### Example: + +```php +$photos.photos = ['_' => 'photos.photos', 'photos' => [Photo, Photo], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +photos.photos={_='photos.photos', photos={Photo}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/photos.photosSlice.md b/old_docs/API_docs_v109/constructors/photos.photosSlice.md new file mode 100644 index 00000000..49ff4d30 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/photos.photosSlice.md @@ -0,0 +1,41 @@ +--- +title: photos.photosSlice +description: Incomplete list of photos with auxiliary data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/photos_photosSlice.html +--- +# Constructor: photos.photosSlice +[Back to constructors index](index.md) + + + +Incomplete list of photos with auxiliary data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|count|[int](../types/int.md) | Yes|Total number of photos| +|photos|Array of [Photo](../types/Photo.md) | Yes|Photos| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [photos.Photos](../types/photos.Photos.md) + + +### Example: + +```php +$photos.photosSlice = ['_' => 'photos.photosSlice', 'count' => int, 'photos' => [Photo, Photo], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +photos.photosSlice={_='photos.photosSlice', count=int, photos={Photo}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/poll.md b/old_docs/API_docs_v109/constructors/poll.md new file mode 100644 index 00000000..170872c9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/poll.md @@ -0,0 +1,44 @@ +--- +title: poll +description: Poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: poll +[Back to constructors index](index.md) + + + +Poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|ID of the poll| +|closed|[Bool](../types/Bool.md) | Optional|Whether the poll is closed and doesn't accept any more answers| +|public\_voters|[Bool](../types/Bool.md) | Optional|| +|multiple\_choice|[Bool](../types/Bool.md) | Optional|| +|quiz|[Bool](../types/Bool.md) | Optional|| +|question|[string](../types/string.md) | Yes|The question of the poll| +|answers|Array of [PollAnswer](../types/PollAnswer.md) | Yes|Answers| + + + +### Type: [Poll](../types/Poll.md) + + +### Example: + +```php +$poll = ['_' => 'poll', 'id' => long, 'closed' => Bool, 'public_voters' => Bool, 'multiple_choice' => Bool, 'quiz' => Bool, 'question' => 'string', 'answers' => [PollAnswer, PollAnswer]]; +``` + + +Or, if you're into Lua: + +```lua +poll={_='poll', id=long, closed=Bool, public_voters=Bool, multiple_choice=Bool, quiz=Bool, question='string', answers={PollAnswer}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pollAnswer.md b/old_docs/API_docs_v109/constructors/pollAnswer.md new file mode 100644 index 00000000..405ba73a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pollAnswer.md @@ -0,0 +1,39 @@ +--- +title: pollAnswer +description: A possible answer of a poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pollAnswer +[Back to constructors index](index.md) + + + +A possible answer of a poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Textual representation of the answer| +|option|[bytes](../types/bytes.md) | Yes|The param that has to be passed to [messages.sendVote](../methods/messages.sendVote.md).| + + + +### Type: [PollAnswer](../types/PollAnswer.md) + + +### Example: + +```php +$pollAnswer = ['_' => 'pollAnswer', 'text' => 'string', 'option' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +pollAnswer={_='pollAnswer', text='string', option='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pollAnswerVoters.md b/old_docs/API_docs_v109/constructors/pollAnswerVoters.md new file mode 100644 index 00000000..f52329a8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pollAnswerVoters.md @@ -0,0 +1,41 @@ +--- +title: pollAnswerVoters +description: A poll answer, and how users voted on it +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pollAnswerVoters +[Back to constructors index](index.md) + + + +A poll answer, and how users voted on it + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chosen|[Bool](../types/Bool.md) | Optional|Whether we have chosen this answer| +|correct|[Bool](../types/Bool.md) | Optional|| +|option|[bytes](../types/bytes.md) | Yes|The param that has to be passed to [messages.sendVote](../methods/messages.sendVote.md).| +|voters|[int](../types/int.md) | Yes|How many users voted for this option| + + + +### Type: [PollAnswerVoters](../types/PollAnswerVoters.md) + + +### Example: + +```php +$pollAnswerVoters = ['_' => 'pollAnswerVoters', 'chosen' => Bool, 'correct' => Bool, 'option' => 'bytes', 'voters' => int]; +``` + + +Or, if you're into Lua: + +```lua +pollAnswerVoters={_='pollAnswerVoters', chosen=Bool, correct=Bool, option='bytes', voters=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/pollResults.md b/old_docs/API_docs_v109/constructors/pollResults.md new file mode 100644 index 00000000..3ccfdc6d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/pollResults.md @@ -0,0 +1,41 @@ +--- +title: pollResults +description: Results of poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: pollResults +[Back to constructors index](index.md) + + + +Results of poll + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|min|[Bool](../types/Bool.md) | Optional|Similar to [min](https://core.telegram.org/api/min) objects, used for poll constructors that are the same for all users so they don't have option chosen by the current user (you can use [messages.getPollResults](../methods/messages.getPollResults.md) to get the full poll results).| +|results|Array of [PollAnswerVoters](../types/PollAnswerVoters.md) | Optional|Results| +|total\_voters|[int](../types/int.md) | Optional|Total number of people that voted in the poll| +|recent\_voters|Array of [int](../types/int.md) | Optional|| + + + +### Type: [PollResults](../types/PollResults.md) + + +### Example: + +```php +$pollResults = ['_' => 'pollResults', 'min' => Bool, 'results' => [PollAnswerVoters, PollAnswerVoters], 'total_voters' => int, 'recent_voters' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +pollResults={_='pollResults', min=Bool, results={PollAnswerVoters}, total_voters=int, recent_voters={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/popularContact.md b/old_docs/API_docs_v109/constructors/popularContact.md new file mode 100644 index 00000000..c0ce7513 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/popularContact.md @@ -0,0 +1,39 @@ +--- +title: popularContact +description: Popular contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: popularContact +[Back to constructors index](index.md) + + + +Popular contact + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|client\_id|[long](../types/long.md) | Yes|Contact identifier| +|importers|[int](../types/int.md) | Yes|How many people imported this contact| + + + +### Type: [PopularContact](../types/PopularContact.md) + + +### Example: + +```php +$popularContact = ['_' => 'popularContact', 'client_id' => long, 'importers' => int]; +``` + + +Or, if you're into Lua: + +```lua +popularContact={_='popularContact', client_id=long, importers=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/postAddress.md b/old_docs/API_docs_v109/constructors/postAddress.md new file mode 100644 index 00000000..8083f1da --- /dev/null +++ b/old_docs/API_docs_v109/constructors/postAddress.md @@ -0,0 +1,43 @@ +--- +title: postAddress +description: Shipping address +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: postAddress +[Back to constructors index](index.md) + + + +Shipping address + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|street\_line1|[string](../types/string.md) | Yes|First line for the address| +|street\_line2|[string](../types/string.md) | Yes|Second line for the address| +|city|[string](../types/string.md) | Yes|City| +|state|[string](../types/string.md) | Yes|State, if applicable (empty otherwise)| +|country\_iso2|[string](../types/string.md) | Yes|ISO 3166-1 alpha-2 country code| +|post\_code|[string](../types/string.md) | Yes|Address post code| + + + +### Type: [PostAddress](../types/PostAddress.md) + + +### Example: + +```php +$postAddress = ['_' => 'postAddress', 'street_line1' => 'string', 'street_line2' => 'string', 'city' => 'string', 'state' => 'string', 'country_iso2' => 'string', 'post_code' => 'string']; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/privacyKeyAddedByPhone.md b/old_docs/API_docs_v109/constructors/privacyKeyAddedByPhone.md new file mode 100644 index 00000000..72a2e3bd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyKeyAddedByPhone.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyAddedByPhone +description: Whether people can add you to their contact list by your phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyAddedByPhone +[Back to constructors index](index.md) + + + +Whether people can add you to their contact list by your phone number + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyAddedByPhone = ['_' => 'privacyKeyAddedByPhone']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyAddedByPhone={_='privacyKeyAddedByPhone'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyKeyChatInvite.md b/old_docs/API_docs_v109/constructors/privacyKeyChatInvite.md new file mode 100644 index 00000000..5acbff55 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyKeyChatInvite.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyChatInvite +description: Whether the user can be invited to chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyChatInvite +[Back to constructors index](index.md) + + + +Whether the user can be invited to chats + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyChatInvite = ['_' => 'privacyKeyChatInvite']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyChatInvite={_='privacyKeyChatInvite'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyKeyForwards.md b/old_docs/API_docs_v109/constructors/privacyKeyForwards.md new file mode 100644 index 00000000..934eaf40 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyKeyForwards.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyForwards +description: Whether messages forwarded from the user will be [anonymously forwarded](https://telegram.org/blog/unsend-privacy-emoji#anonymous-forwarding) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyForwards +[Back to constructors index](index.md) + + + +Whether messages forwarded from the user will be [anonymously forwarded](https://telegram.org/blog/unsend-privacy-emoji#anonymous-forwarding) + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyForwards = ['_' => 'privacyKeyForwards']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyForwards={_='privacyKeyForwards'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyKeyPhoneCall.md b/old_docs/API_docs_v109/constructors/privacyKeyPhoneCall.md new file mode 100644 index 00000000..e8fecc92 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyKeyPhoneCall.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyPhoneCall +description: Whether the user accepts phone calls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyPhoneCall +[Back to constructors index](index.md) + + + +Whether the user accepts phone calls + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyPhoneCall = ['_' => 'privacyKeyPhoneCall']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyPhoneCall={_='privacyKeyPhoneCall'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyKeyPhoneNumber.md b/old_docs/API_docs_v109/constructors/privacyKeyPhoneNumber.md new file mode 100644 index 00000000..14338118 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyKeyPhoneNumber.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyPhoneNumber +description: Whether the user allows us to see his phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyPhoneNumber +[Back to constructors index](index.md) + + + +Whether the user allows us to see his phone number + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyPhoneNumber = ['_' => 'privacyKeyPhoneNumber']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyPhoneNumber={_='privacyKeyPhoneNumber'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyKeyPhoneP2P.md b/old_docs/API_docs_v109/constructors/privacyKeyPhoneP2P.md new file mode 100644 index 00000000..6b23dabb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyKeyPhoneP2P.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyPhoneP2P +description: Whether P2P connections in phone calls are allowed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyPhoneP2P +[Back to constructors index](index.md) + + + +Whether P2P connections in phone calls are allowed + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyPhoneP2P = ['_' => 'privacyKeyPhoneP2P']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyPhoneP2P={_='privacyKeyPhoneP2P'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyKeyProfilePhoto.md b/old_docs/API_docs_v109/constructors/privacyKeyProfilePhoto.md new file mode 100644 index 00000000..7d9845be --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyKeyProfilePhoto.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyProfilePhoto +description: Whether the profile picture of the user is visible +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyProfilePhoto +[Back to constructors index](index.md) + + + +Whether the profile picture of the user is visible + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyProfilePhoto = ['_' => 'privacyKeyProfilePhoto']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyProfilePhoto={_='privacyKeyProfilePhoto'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyKeyStatusTimestamp.md b/old_docs/API_docs_v109/constructors/privacyKeyStatusTimestamp.md new file mode 100644 index 00000000..c0026731 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyKeyStatusTimestamp.md @@ -0,0 +1,33 @@ +--- +title: privacyKeyStatusTimestamp +description: Whether we can see the last online timestamp +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyKeyStatusTimestamp +[Back to constructors index](index.md) + + + +Whether we can see the last online timestamp + + + + +### Type: [PrivacyKey](../types/PrivacyKey.md) + + +### Example: + +```php +$privacyKeyStatusTimestamp = ['_' => 'privacyKeyStatusTimestamp']; +``` + + +Or, if you're into Lua: + +```lua +privacyKeyStatusTimestamp={_='privacyKeyStatusTimestamp'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyValueAllowAll.md b/old_docs/API_docs_v109/constructors/privacyValueAllowAll.md new file mode 100644 index 00000000..2bd419d2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyValueAllowAll.md @@ -0,0 +1,33 @@ +--- +title: privacyValueAllowAll +description: Allow all users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueAllowAll +[Back to constructors index](index.md) + + + +Allow all users + + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +```php +$privacyValueAllowAll = ['_' => 'privacyValueAllowAll']; +``` + + +Or, if you're into Lua: + +```lua +privacyValueAllowAll={_='privacyValueAllowAll'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyValueAllowChatParticipants.md b/old_docs/API_docs_v109/constructors/privacyValueAllowChatParticipants.md new file mode 100644 index 00000000..d3329f3e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyValueAllowChatParticipants.md @@ -0,0 +1,38 @@ +--- +title: privacyValueAllowChatParticipants +description: Allow all participants of certain chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueAllowChatParticipants +[Back to constructors index](index.md) + + + +Allow all participants of certain chats + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chats|Array of [int](../types/int.md) | Yes|Allowed chats| + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +```php +$privacyValueAllowChatParticipants = ['_' => 'privacyValueAllowChatParticipants', 'chats' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +privacyValueAllowChatParticipants={_='privacyValueAllowChatParticipants', chats={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyValueAllowContacts.md b/old_docs/API_docs_v109/constructors/privacyValueAllowContacts.md new file mode 100644 index 00000000..40d838be --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyValueAllowContacts.md @@ -0,0 +1,33 @@ +--- +title: privacyValueAllowContacts +description: Allow all contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueAllowContacts +[Back to constructors index](index.md) + + + +Allow all contacts + + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +```php +$privacyValueAllowContacts = ['_' => 'privacyValueAllowContacts']; +``` + + +Or, if you're into Lua: + +```lua +privacyValueAllowContacts={_='privacyValueAllowContacts'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyValueAllowUsers.md b/old_docs/API_docs_v109/constructors/privacyValueAllowUsers.md new file mode 100644 index 00000000..937f8e4b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyValueAllowUsers.md @@ -0,0 +1,38 @@ +--- +title: privacyValueAllowUsers +description: Allow only certain users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueAllowUsers +[Back to constructors index](index.md) + + + +Allow only certain users + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|users|Array of [int](../types/int.md) | Yes|Users| + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +```php +$privacyValueAllowUsers = ['_' => 'privacyValueAllowUsers', 'users' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +privacyValueAllowUsers={_='privacyValueAllowUsers', users={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyValueDisallowAll.md b/old_docs/API_docs_v109/constructors/privacyValueDisallowAll.md new file mode 100644 index 00000000..cd0271ed --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyValueDisallowAll.md @@ -0,0 +1,33 @@ +--- +title: privacyValueDisallowAll +description: Disallow all users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueDisallowAll +[Back to constructors index](index.md) + + + +Disallow all users + + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +```php +$privacyValueDisallowAll = ['_' => 'privacyValueDisallowAll']; +``` + + +Or, if you're into Lua: + +```lua +privacyValueDisallowAll={_='privacyValueDisallowAll'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyValueDisallowChatParticipants.md b/old_docs/API_docs_v109/constructors/privacyValueDisallowChatParticipants.md new file mode 100644 index 00000000..a4c604d0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyValueDisallowChatParticipants.md @@ -0,0 +1,38 @@ +--- +title: privacyValueDisallowChatParticipants +description: Disallow only participants of certain chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueDisallowChatParticipants +[Back to constructors index](index.md) + + + +Disallow only participants of certain chats + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chats|Array of [int](../types/int.md) | Yes|Disallowed chats| + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +```php +$privacyValueDisallowChatParticipants = ['_' => 'privacyValueDisallowChatParticipants', 'chats' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +privacyValueDisallowChatParticipants={_='privacyValueDisallowChatParticipants', chats={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyValueDisallowContacts.md b/old_docs/API_docs_v109/constructors/privacyValueDisallowContacts.md new file mode 100644 index 00000000..bee3a87e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyValueDisallowContacts.md @@ -0,0 +1,33 @@ +--- +title: privacyValueDisallowContacts +description: Disallow only contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueDisallowContacts +[Back to constructors index](index.md) + + + +Disallow only contacts + + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +```php +$privacyValueDisallowContacts = ['_' => 'privacyValueDisallowContacts']; +``` + + +Or, if you're into Lua: + +```lua +privacyValueDisallowContacts={_='privacyValueDisallowContacts'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/privacyValueDisallowUsers.md b/old_docs/API_docs_v109/constructors/privacyValueDisallowUsers.md new file mode 100644 index 00000000..58aeff12 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/privacyValueDisallowUsers.md @@ -0,0 +1,38 @@ +--- +title: privacyValueDisallowUsers +description: Disallow only certain users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: privacyValueDisallowUsers +[Back to constructors index](index.md) + + + +Disallow only certain users + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|users|Array of [int](../types/int.md) | Yes|Users| + + + +### Type: [PrivacyRule](../types/PrivacyRule.md) + + +### Example: + +```php +$privacyValueDisallowUsers = ['_' => 'privacyValueDisallowUsers', 'users' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +privacyValueDisallowUsers={_='privacyValueDisallowUsers', users={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/receivedNotifyMessage.md b/old_docs/API_docs_v109/constructors/receivedNotifyMessage.md new file mode 100644 index 00000000..a6cffab7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/receivedNotifyMessage.md @@ -0,0 +1,38 @@ +--- +title: receivedNotifyMessage +description: Message ID, for which PUSH-notifications were cancelled. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: receivedNotifyMessage +[Back to constructors index](index.md) + + + +Message ID, for which PUSH-notifications were cancelled. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|Message ID, for which PUSH-notifications were canceled| + + + +### Type: [ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) + + +### Example: + +```php +$receivedNotifyMessage = ['_' => 'receivedNotifyMessage', 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +receivedNotifyMessage={_='receivedNotifyMessage', id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/recentMeUrlChat.md b/old_docs/API_docs_v109/constructors/recentMeUrlChat.md new file mode 100644 index 00000000..d44773fd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/recentMeUrlChat.md @@ -0,0 +1,39 @@ +--- +title: recentMeUrlChat +description: Recent t.me link to a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlChat +[Back to constructors index](index.md) + + + +Recent t.me link to a chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|T.me URL| +|chat\_id|[int](../types/int.md) | Yes|Chat ID| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +```php +$recentMeUrlChat = ['_' => 'recentMeUrlChat', 'url' => 'string', 'chat_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +recentMeUrlChat={_='recentMeUrlChat', url='string', chat_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/recentMeUrlChatInvite.md b/old_docs/API_docs_v109/constructors/recentMeUrlChatInvite.md new file mode 100644 index 00000000..4c64530f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/recentMeUrlChatInvite.md @@ -0,0 +1,39 @@ +--- +title: recentMeUrlChatInvite +description: Recent t.me invite link to a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlChatInvite +[Back to constructors index](index.md) + + + +Recent t.me invite link to a chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|T.me URL| +|chat\_invite|[ChatInvite](../types/ChatInvite.md) | Optional|Chat invitation| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +```php +$recentMeUrlChatInvite = ['_' => 'recentMeUrlChatInvite', 'url' => 'string', 'chat_invite' => ChatInvite]; +``` + + +Or, if you're into Lua: + +```lua +recentMeUrlChatInvite={_='recentMeUrlChatInvite', url='string', chat_invite=ChatInvite} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/recentMeUrlStickerSet.md b/old_docs/API_docs_v109/constructors/recentMeUrlStickerSet.md new file mode 100644 index 00000000..7913a023 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/recentMeUrlStickerSet.md @@ -0,0 +1,39 @@ +--- +title: recentMeUrlStickerSet +description: Recent t.me stickerset installation URL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlStickerSet +[Back to constructors index](index.md) + + + +Recent t.me stickerset installation URL + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|T.me URL| +|set|[StickerSetCovered](../types/StickerSetCovered.md) | Yes|Stickerset| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +```php +$recentMeUrlStickerSet = ['_' => 'recentMeUrlStickerSet', 'url' => 'string', 'set' => StickerSetCovered]; +``` + + +Or, if you're into Lua: + +```lua +recentMeUrlStickerSet={_='recentMeUrlStickerSet', url='string', set=StickerSetCovered} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/recentMeUrlUnknown.md b/old_docs/API_docs_v109/constructors/recentMeUrlUnknown.md new file mode 100644 index 00000000..d14e7671 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/recentMeUrlUnknown.md @@ -0,0 +1,38 @@ +--- +title: recentMeUrlUnknown +description: Unknown t.me url +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlUnknown +[Back to constructors index](index.md) + + + +Unknown t.me url + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +```php +$recentMeUrlUnknown = ['_' => 'recentMeUrlUnknown', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +recentMeUrlUnknown={_='recentMeUrlUnknown', url='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/recentMeUrlUser.md b/old_docs/API_docs_v109/constructors/recentMeUrlUser.md new file mode 100644 index 00000000..ff80c818 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/recentMeUrlUser.md @@ -0,0 +1,39 @@ +--- +title: recentMeUrlUser +description: Recent t.me link to a user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: recentMeUrlUser +[Back to constructors index](index.md) + + + +Recent t.me link to a user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|URL| +|user\_id|[int](../types/int.md) | Yes|User ID| + + + +### Type: [RecentMeUrl](../types/RecentMeUrl.md) + + +### Example: + +```php +$recentMeUrlUser = ['_' => 'recentMeUrlUser', 'url' => 'string', 'user_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +recentMeUrlUser={_='recentMeUrlUser', url='string', user_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/replyInlineMarkup.md b/old_docs/API_docs_v109/constructors/replyInlineMarkup.md new file mode 100644 index 00000000..bd5bead2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/replyInlineMarkup.md @@ -0,0 +1,38 @@ +--- +title: replyInlineMarkup +description: Bot or inline keyboard +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: replyInlineMarkup +[Back to constructors index](index.md) + + + +Bot or inline keyboard + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|rows|Array of [KeyboardButtonRow](../types/KeyboardButtonRow.md) | Yes|Rows| + + + +### Type: [ReplyMarkup](../types/ReplyMarkup.md) + + +### Example: + +```php +$replyInlineMarkup = ['_' => 'replyInlineMarkup', 'rows' => [KeyboardButtonRow, KeyboardButtonRow]]; +``` + + +Or, if you're into Lua: + +```lua +replyInlineMarkup={_='replyInlineMarkup', rows={KeyboardButtonRow}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/replyKeyboardForceReply.md b/old_docs/API_docs_v109/constructors/replyKeyboardForceReply.md new file mode 100644 index 00000000..5458b06a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/replyKeyboardForceReply.md @@ -0,0 +1,39 @@ +--- +title: replyKeyboardForceReply +description: Force the user to send a reply +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: replyKeyboardForceReply +[Back to constructors index](index.md) + + + +Force the user to send a reply + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|single\_use|[Bool](../types/Bool.md) | Optional|Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again.| +|selective|[Bool](../types/Bool.md) | Optional|Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply\_to\_message\_id), sender of the original message.
Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.| + + + +### Type: [ReplyMarkup](../types/ReplyMarkup.md) + + +### Example: + +```php +$replyKeyboardForceReply = ['_' => 'replyKeyboardForceReply', 'single_use' => Bool, 'selective' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +replyKeyboardForceReply={_='replyKeyboardForceReply', single_use=Bool, selective=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/replyKeyboardHide.md b/old_docs/API_docs_v109/constructors/replyKeyboardHide.md new file mode 100644 index 00000000..7ff91292 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/replyKeyboardHide.md @@ -0,0 +1,38 @@ +--- +title: replyKeyboardHide +description: Hide sent bot keyboard +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: replyKeyboardHide +[Back to constructors index](index.md) + + + +Hide sent bot keyboard + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|selective|[Bool](../types/Bool.md) | Optional|Use this flag if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply\_to\_message\_id), sender of the original message.

Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet| + + + +### Type: [ReplyMarkup](../types/ReplyMarkup.md) + + +### Example: + +```php +$replyKeyboardHide = ['_' => 'replyKeyboardHide', 'selective' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +replyKeyboardHide={_='replyKeyboardHide', selective=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/replyKeyboardMarkup.md b/old_docs/API_docs_v109/constructors/replyKeyboardMarkup.md new file mode 100644 index 00000000..f95ea6c4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/replyKeyboardMarkup.md @@ -0,0 +1,41 @@ +--- +title: replyKeyboardMarkup +description: Bot keyboard +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: replyKeyboardMarkup +[Back to constructors index](index.md) + + + +Bot keyboard + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|resize|[Bool](../types/Bool.md) | Optional|Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). If not set, the custom keyboard is always of the same height as the app's standard keyboard.| +|single\_use|[Bool](../types/Bool.md) | Optional|Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again.| +|selective|[Bool](../types/Bool.md) | Optional|Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply\_to\_message\_id), sender of the original message.

Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.| +|rows|Array of [KeyboardButtonRow](../types/KeyboardButtonRow.md) | Yes|Rows| + + + +### Type: [ReplyMarkup](../types/ReplyMarkup.md) + + +### Example: + +```php +$replyKeyboardMarkup = ['_' => 'replyKeyboardMarkup', 'resize' => Bool, 'single_use' => Bool, 'selective' => Bool, 'rows' => [KeyboardButtonRow, KeyboardButtonRow]]; +``` + + +Or, if you're into Lua: + +```lua +replyKeyboardMarkup={_='replyKeyboardMarkup', resize=Bool, single_use=Bool, selective=Bool, rows={KeyboardButtonRow}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/restrictionReason.md b/old_docs/API_docs_v109/constructors/restrictionReason.md new file mode 100644 index 00000000..918027a4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/restrictionReason.md @@ -0,0 +1,44 @@ +--- +title: restrictionReason +description: Restriction reason. + +Contains the reason why access to a certain object must be restricted. Clients are supposed to deny access to the channel if the `platform` field is equal to `all` or to the current platform (`ios`, `android`, `wp`, etc.). Platforms can be concatenated (`ios-android`, `ios-wp`), unknown platforms are to be ignored. The `text` is the error message that should be shown to the user. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: restrictionReason +[Back to constructors index](index.md) + + + +Restriction reason. + +Contains the reason why access to a certain object must be restricted. Clients are supposed to deny access to the channel if the `platform` field is equal to `all` or to the current platform (`ios`, `android`, `wp`, etc.). Platforms can be concatenated (`ios-android`, `ios-wp`), unknown platforms are to be ignored. The `text` is the error message that should be shown to the user. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|platform|[string](../types/string.md) | Yes|Platform identifier (ios, android, wp, all, etc.), can be concatenated with a dash as separator (`android-ios`, `ios-wp`, etc)| +|reason|[string](../types/string.md) | Yes|Restriction reason (`porno`, `terms`, etc.)| +|text|[string](../types/string.md) | Yes|Error message to be shown to the user| + + + +### Type: [RestrictionReason](../types/RestrictionReason.md) + + +### Example: + +```php +$restrictionReason = ['_' => 'restrictionReason', 'platform' => 'string', 'reason' => 'string', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +restrictionReason={_='restrictionReason', platform='string', reason='string', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/savedPhoneContact.md b/old_docs/API_docs_v109/constructors/savedPhoneContact.md new file mode 100644 index 00000000..64983bb3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/savedPhoneContact.md @@ -0,0 +1,41 @@ +--- +title: savedPhoneContact +description: Saved contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: savedPhoneContact +[Back to constructors index](index.md) + + + +Saved contact + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone|[string](../types/string.md) | Yes|Phone number| +|first\_name|[string](../types/string.md) | Yes|First name| +|last\_name|[string](../types/string.md) | Yes|Last name| +|date|[int](../types/int.md) | Yes|Date added| + + + +### Type: [SavedContact](../types/SavedContact.md) + + +### Example: + +```php +$savedPhoneContact = ['_' => 'savedPhoneContact', 'phone' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +savedPhoneContact={_='savedPhoneContact', phone='string', first_name='string', last_name='string', date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureCredentialsEncrypted.md b/old_docs/API_docs_v109/constructors/secureCredentialsEncrypted.md new file mode 100644 index 00000000..c693ef97 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureCredentialsEncrypted.md @@ -0,0 +1,40 @@ +--- +title: secureCredentialsEncrypted +description: Encrypted credentials required to decrypt [telegram passport](https://core.telegram.org/passport) data. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureCredentialsEncrypted +[Back to constructors index](index.md) + + + +Encrypted credentials required to decrypt [telegram passport](https://core.telegram.org/passport) data. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|data|[bytes](../types/bytes.md) | Yes|Encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication, as described in [decrypting data »](https://core.telegram.org/passport#decrypting-data)| +|hash|[bytes](../types/bytes.md) | Yes|Data hash for data authentication as described in [decrypting data »](https://core.telegram.org/passport#decrypting-data)| +|secret|[bytes](../types/bytes.md) | Yes|Secret, encrypted with the bot's public RSA key, required for data decryption as described in [decrypting data »](https://core.telegram.org/passport#decrypting-data)| + + + +### Type: [SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md) + + +### Example: + +```php +$secureCredentialsEncrypted = ['_' => 'secureCredentialsEncrypted', 'data' => 'bytes', 'hash' => 'bytes', 'secret' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +secureCredentialsEncrypted={_='secureCredentialsEncrypted', data='bytes', hash='bytes', secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureData.md b/old_docs/API_docs_v109/constructors/secureData.md new file mode 100644 index 00000000..b3d896e3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureData.md @@ -0,0 +1,40 @@ +--- +title: secureData +description: Secure [passport](https://core.telegram.org/passport) data, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#securedata) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureData +[Back to constructors index](index.md) + + + +Secure [passport](https://core.telegram.org/passport) data, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#securedata) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|data|[bytes](../types/bytes.md) | Yes|Data| +|data\_hash|[bytes](../types/bytes.md) | Yes|Data hash| +|secret|[bytes](../types/bytes.md) | Yes|Secret| + + + +### Type: [SecureData](../types/SecureData.md) + + +### Example: + +```php +$secureData = ['_' => 'secureData', 'data' => 'bytes', 'data_hash' => 'bytes', 'secret' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +secureData={_='secureData', data='bytes', data_hash='bytes', secret='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureFile.md b/old_docs/API_docs_v109/constructors/secureFile.md new file mode 100644 index 00000000..13b462d7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureFile.md @@ -0,0 +1,44 @@ +--- +title: secureFile +description: Secure [passport](https://core.telegram.org/passport) file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureFile +[Back to constructors index](index.md) + + + +Secure [passport](https://core.telegram.org/passport) file, for more info [see the passport docs »](https://core.telegram.org/passport/encryption#inputsecurefile) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|ID| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|size|[int](../types/int.md) | Yes|File size| +|dc\_id|[int](../types/int.md) | Yes|DC ID| +|date|[int](../types/int.md) | Yes|Date of upload| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|secret|[bytes](../types/bytes.md) | Yes|Secret| + + + +### Type: [SecureFile](../types/SecureFile.md) + + +### Example: + +```php +$secureFile = ['_' => 'secureFile', 'id' => long, 'access_hash' => long, 'size' => int, 'dc_id' => int, 'date' => int, 'file_hash' => 'bytes', 'secret' => 'bytes']; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/secureFileEmpty.md b/old_docs/API_docs_v109/constructors/secureFileEmpty.md new file mode 100644 index 00000000..be9dbffe --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureFileEmpty.md @@ -0,0 +1,33 @@ +--- +title: secureFileEmpty +description: Empty constructor +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureFileEmpty +[Back to constructors index](index.md) + + + +Empty constructor + + + + +### Type: [SecureFile](../types/SecureFile.md) + + +### Example: + +```php +$secureFileEmpty = ['_' => 'secureFileEmpty']; +``` + + +Or, if you're into Lua: + +```lua +secureFileEmpty={_='secureFileEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md b/old_docs/API_docs_v109/constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md new file mode 100644 index 00000000..636dd230 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md @@ -0,0 +1,38 @@ +--- +title: securePasswordKdfAlgoPBKDF2HMACSHA512iter100000 +description: PBKDF2 with SHA512 and 100000 iterations KDF algo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePasswordKdfAlgoPBKDF2HMACSHA512iter100000 +[Back to constructors index](index.md) + + + +PBKDF2 with SHA512 and 100000 iterations KDF algo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|salt|[bytes](../types/bytes.md) | Yes|Salt| + + + +### Type: [SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) + + +### Example: + +```php +$securePasswordKdfAlgoPBKDF2HMACSHA512iter100000 = ['_' => 'securePasswordKdfAlgoPBKDF2HMACSHA512iter100000', 'salt' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +securePasswordKdfAlgoPBKDF2HMACSHA512iter100000={_='securePasswordKdfAlgoPBKDF2HMACSHA512iter100000', salt='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/securePasswordKdfAlgoSHA512.md b/old_docs/API_docs_v109/constructors/securePasswordKdfAlgoSHA512.md new file mode 100644 index 00000000..ec40a7d8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/securePasswordKdfAlgoSHA512.md @@ -0,0 +1,38 @@ +--- +title: securePasswordKdfAlgoSHA512 +description: SHA512 KDF algo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePasswordKdfAlgoSHA512 +[Back to constructors index](index.md) + + + +SHA512 KDF algo + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|salt|[bytes](../types/bytes.md) | Yes|Salt| + + + +### Type: [SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) + + +### Example: + +```php +$securePasswordKdfAlgoSHA512 = ['_' => 'securePasswordKdfAlgoSHA512', 'salt' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +securePasswordKdfAlgoSHA512={_='securePasswordKdfAlgoSHA512', salt='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/securePasswordKdfAlgoUnknown.md b/old_docs/API_docs_v109/constructors/securePasswordKdfAlgoUnknown.md new file mode 100644 index 00000000..ef53df6a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/securePasswordKdfAlgoUnknown.md @@ -0,0 +1,33 @@ +--- +title: securePasswordKdfAlgoUnknown +description: Unknown KDF algo (most likely the client has to be updated) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePasswordKdfAlgoUnknown +[Back to constructors index](index.md) + + + +Unknown KDF algo (most likely the client has to be updated) + + + + +### Type: [SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) + + +### Example: + +```php +$securePasswordKdfAlgoUnknown = ['_' => 'securePasswordKdfAlgoUnknown']; +``` + + +Or, if you're into Lua: + +```lua +securePasswordKdfAlgoUnknown={_='securePasswordKdfAlgoUnknown'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/securePlainEmail.md b/old_docs/API_docs_v109/constructors/securePlainEmail.md new file mode 100644 index 00000000..626e8985 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/securePlainEmail.md @@ -0,0 +1,38 @@ +--- +title: securePlainEmail +description: Email address to use in [telegram passport](https://core.telegram.org/passport): [it must be verified, first »](https://core.telegram.org/passport/encryption#secureplaindata). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePlainEmail +[Back to constructors index](index.md) + + + +Email address to use in [telegram passport](https://core.telegram.org/passport): [it must be verified, first »](https://core.telegram.org/passport/encryption#secureplaindata). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|email|[string](../types/string.md) | Yes|Email address| + + + +### Type: [SecurePlainData](../types/SecurePlainData.md) + + +### Example: + +```php +$securePlainEmail = ['_' => 'securePlainEmail', 'email' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +securePlainEmail={_='securePlainEmail', email='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/securePlainPhone.md b/old_docs/API_docs_v109/constructors/securePlainPhone.md new file mode 100644 index 00000000..7b83ef38 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/securePlainPhone.md @@ -0,0 +1,38 @@ +--- +title: securePlainPhone +description: Phone number to use in [telegram passport](https://core.telegram.org/passport): [it must be verified, first »](https://core.telegram.org/passport/encryption#secureplaindata). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: securePlainPhone +[Back to constructors index](index.md) + + + +Phone number to use in [telegram passport](https://core.telegram.org/passport): [it must be verified, first »](https://core.telegram.org/passport/encryption#secureplaindata). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone|[string](../types/string.md) | Yes|Phone number| + + + +### Type: [SecurePlainData](../types/SecurePlainData.md) + + +### Example: + +```php +$securePlainPhone = ['_' => 'securePlainPhone', 'phone' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +securePlainPhone={_='securePlainPhone', phone='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureRequiredType.md b/old_docs/API_docs_v109/constructors/secureRequiredType.md new file mode 100644 index 00000000..46c8a374 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureRequiredType.md @@ -0,0 +1,41 @@ +--- +title: secureRequiredType +description: Required type +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureRequiredType +[Back to constructors index](index.md) + + + +Required type + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|native\_names|[Bool](../types/Bool.md) | Optional|Native names| +|selfie\_required|[Bool](../types/Bool.md) | Optional|Is a selfie required| +|translation\_required|[Bool](../types/Bool.md) | Optional|Is a translation required| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|Secure value type| + + + +### Type: [SecureRequiredType](../types/SecureRequiredType.md) + + +### Example: + +```php +$secureRequiredType = ['_' => 'secureRequiredType', 'native_names' => Bool, 'selfie_required' => Bool, 'translation_required' => Bool, 'type' => SecureValueType]; +``` + + +Or, if you're into Lua: + +```lua +secureRequiredType={_='secureRequiredType', native_names=Bool, selfie_required=Bool, translation_required=Bool, type=SecureValueType} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureRequiredTypeOneOf.md b/old_docs/API_docs_v109/constructors/secureRequiredTypeOneOf.md new file mode 100644 index 00000000..d6fcf63b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureRequiredTypeOneOf.md @@ -0,0 +1,38 @@ +--- +title: secureRequiredTypeOneOf +description: One of +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureRequiredTypeOneOf +[Back to constructors index](index.md) + + + +One of + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|types|Array of [SecureRequiredType](../types/SecureRequiredType.md) | Yes|Types| + + + +### Type: [SecureRequiredType](../types/SecureRequiredType.md) + + +### Example: + +```php +$secureRequiredTypeOneOf = ['_' => 'secureRequiredTypeOneOf', 'types' => [SecureRequiredType, SecureRequiredType]]; +``` + + +Or, if you're into Lua: + +```lua +secureRequiredTypeOneOf={_='secureRequiredTypeOneOf', types={SecureRequiredType}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureSecretSettings.md b/old_docs/API_docs_v109/constructors/secureSecretSettings.md new file mode 100644 index 00000000..400dae89 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureSecretSettings.md @@ -0,0 +1,40 @@ +--- +title: secureSecretSettings +description: Secure settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureSecretSettings +[Back to constructors index](index.md) + + + +Secure settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|secure\_algo|[SecurePasswordKdfAlgo](../types/SecurePasswordKdfAlgo.md) | Yes|Secure KDF algo| +|secure\_secret|[bytes](../types/bytes.md) | Yes|Secure secret| +|secure\_secret\_id|[long](../types/long.md) | Yes|Secret ID| + + + +### Type: [SecureSecretSettings](../types/SecureSecretSettings.md) + + +### Example: + +```php +$secureSecretSettings = ['_' => 'secureSecretSettings', 'secure_algo' => SecurePasswordKdfAlgo, 'secure_secret' => 'bytes', 'secure_secret_id' => long]; +``` + + +Or, if you're into Lua: + +```lua +secureSecretSettings={_='secureSecretSettings', secure_algo=SecurePasswordKdfAlgo, secure_secret='bytes', secure_secret_id=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValue.md b/old_docs/API_docs_v109/constructors/secureValue.md new file mode 100644 index 00000000..f7731159 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValue.md @@ -0,0 +1,46 @@ +--- +title: secureValue +description: Secure value +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValue +[Back to constructors index](index.md) + + + +Secure value + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|Secure [passport](https://core.telegram.org/passport) value type| +|data|[SecureData](../types/SecureData.md) | Optional|Encrypted [Telegram Passport](https://core.telegram.org/passport) element data| +|front\_side|[SecureFile](../types/SecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with the front side of the document| +|reverse\_side|[SecureFile](../types/SecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with the reverse side of the document| +|selfie|[SecureFile](../types/SecureFile.md) | Optional|Encrypted [passport](https://core.telegram.org/passport) file with a selfie of the user holding the document| +|translation|Array of [SecureFile](../types/SecureFile.md) | Optional|Translation| +|files|Array of [SecureFile](../types/SecureFile.md) | Optional|Files| +|plain\_data|[SecurePlainData](../types/SecurePlainData.md) | Optional|Plaintext verified [passport](https://core.telegram.org/passport) data| +|hash|[bytes](../types/bytes.md) | Yes|Data hash| + + + +### Type: [SecureValue](../types/SecureValue.md) + + +### Example: + +```php +$secureValue = ['_' => 'secureValue', 'type' => SecureValueType, 'data' => SecureData, 'front_side' => SecureFile, 'reverse_side' => SecureFile, 'selfie' => SecureFile, 'translation' => [SecureFile, SecureFile], 'files' => [SecureFile, SecureFile], 'plain_data' => SecurePlainData, 'hash' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +secureValue={_='secureValue', type=SecureValueType, data=SecureData, front_side=SecureFile, reverse_side=SecureFile, selfie=SecureFile, translation={SecureFile}, files={SecureFile}, plain_data=SecurePlainData, hash='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueError.md b/old_docs/API_docs_v109/constructors/secureValueError.md new file mode 100644 index 00000000..62f5f96a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueError.md @@ -0,0 +1,40 @@ +--- +title: secureValueError +description: Secure value error +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueError +[Back to constructors index](index.md) + + + +Secure value error + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|Type of element which has the issue| +|hash|[bytes](../types/bytes.md) | Yes|Hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueError = ['_' => 'secureValueError', 'type' => SecureValueType, 'hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueError={_='secureValueError', type=SecureValueType, hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueErrorData.md b/old_docs/API_docs_v109/constructors/secureValueErrorData.md new file mode 100644 index 00000000..e1f1f6ed --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueErrorData.md @@ -0,0 +1,41 @@ +--- +title: secureValueErrorData +description: Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorData +[Back to constructors index](index.md) + + + +Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|The section of the user's Telegram Passport which has the error, one of [secureValueTypePersonalDetails](../constructors/secureValueTypePersonalDetails.md), [secureValueTypePassport](../constructors/secureValueTypePassport.md), [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md), [secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md), [secureValueTypeAddress](../constructors/secureValueTypeAddress.md)| +|data\_hash|[bytes](../types/bytes.md) | Yes|Data hash| +|field|[string](../types/string.md) | Yes|Name of the data field which has the error| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorData = ['_' => 'secureValueErrorData', 'type' => SecureValueType, 'data_hash' => 'bytes', 'field' => 'string', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorData={_='secureValueErrorData', type=SecureValueType, data_hash='bytes', field='string', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueErrorFile.md b/old_docs/API_docs_v109/constructors/secureValueErrorFile.md new file mode 100644 index 00000000..fd0b14dd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueErrorFile.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorFile +description: Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorFile +[Back to constructors index](index.md) + + + +Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md), [secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md), [secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md), [secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md), [secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md)| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorFile = ['_' => 'secureValueErrorFile', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorFile={_='secureValueErrorFile', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueErrorFiles.md b/old_docs/API_docs_v109/constructors/secureValueErrorFiles.md new file mode 100644 index 00000000..f74ae027 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueErrorFiles.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorFiles +description: Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorFiles +[Back to constructors index](index.md) + + + +Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md), [secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md), [secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md), [secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md), [secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md)| +|file\_hash|Array of [bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorFiles = ['_' => 'secureValueErrorFiles', 'type' => SecureValueType, 'file_hash' => ['bytes', 'bytes'], 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorFiles={_='secureValueErrorFiles', type=SecureValueType, file_hash={'bytes'}, text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueErrorFrontSide.md b/old_docs/API_docs_v109/constructors/secureValueErrorFrontSide.md new file mode 100644 index 00000000..9e6d63d9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueErrorFrontSide.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorFrontSide +description: Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorFrontSide +[Back to constructors index](index.md) + + + +Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypePassport](../constructors/secureValueTypePassport.md), [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md), [secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md)| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorFrontSide = ['_' => 'secureValueErrorFrontSide', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorFrontSide={_='secureValueErrorFrontSide', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueErrorReverseSide.md b/old_docs/API_docs_v109/constructors/secureValueErrorReverseSide.md new file mode 100644 index 00000000..ca7acdad --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueErrorReverseSide.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorReverseSide +description: Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorReverseSide +[Back to constructors index](index.md) + + + +Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md)| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorReverseSide = ['_' => 'secureValueErrorReverseSide', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorReverseSide={_='secureValueErrorReverseSide', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueErrorSelfie.md b/old_docs/API_docs_v109/constructors/secureValueErrorSelfie.md new file mode 100644 index 00000000..7c69b69e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueErrorSelfie.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorSelfie +description: Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorSelfie +[Back to constructors index](index.md) + + + +Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypePassport](../constructors/secureValueTypePassport.md), [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md), [secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md)| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorSelfie = ['_' => 'secureValueErrorSelfie', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorSelfie={_='secureValueErrorSelfie', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueErrorTranslationFile.md b/old_docs/API_docs_v109/constructors/secureValueErrorTranslationFile.md new file mode 100644 index 00000000..898ebd90 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueErrorTranslationFile.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorTranslationFile +description: Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorTranslationFile +[Back to constructors index](index.md) + + + +Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypePersonalDetails](../constructors/secureValueTypePersonalDetails.md), [secureValueTypePassport](../constructors/secureValueTypePassport.md), [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md), [secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md), [secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md), [secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md), [secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md), [secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md), [secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md)| +|file\_hash|[bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorTranslationFile = ['_' => 'secureValueErrorTranslationFile', 'type' => SecureValueType, 'file_hash' => 'bytes', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorTranslationFile={_='secureValueErrorTranslationFile', type=SecureValueType, file_hash='bytes', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueErrorTranslationFiles.md b/old_docs/API_docs_v109/constructors/secureValueErrorTranslationFiles.md new file mode 100644 index 00000000..6d777781 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueErrorTranslationFiles.md @@ -0,0 +1,40 @@ +--- +title: secureValueErrorTranslationFiles +description: Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation changes. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueErrorTranslationFiles +[Back to constructors index](index.md) + + + +Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation changes. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|One of [secureValueTypePersonalDetails](../constructors/secureValueTypePersonalDetails.md), [secureValueTypePassport](../constructors/secureValueTypePassport.md), [secureValueTypeDriverLicense](../constructors/secureValueTypeDriverLicense.md), [secureValueTypeIdentityCard](../constructors/secureValueTypeIdentityCard.md), [secureValueTypeInternalPassport](../constructors/secureValueTypeInternalPassport.md), [secureValueTypeUtilityBill](../constructors/secureValueTypeUtilityBill.md), [secureValueTypeBankStatement](../constructors/secureValueTypeBankStatement.md), [secureValueTypeRentalAgreement](../constructors/secureValueTypeRentalAgreement.md), [secureValueTypePassportRegistration](../constructors/secureValueTypePassportRegistration.md), [secureValueTypeTemporaryRegistration](../constructors/secureValueTypeTemporaryRegistration.md)| +|file\_hash|Array of [bytes](../types/bytes.md) | Yes|File hash| +|text|[string](../types/string.md) | Yes|Error message| + + + +### Type: [SecureValueError](../types/SecureValueError.md) + + +### Example: + +```php +$secureValueErrorTranslationFiles = ['_' => 'secureValueErrorTranslationFiles', 'type' => SecureValueType, 'file_hash' => ['bytes', 'bytes'], 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +secureValueErrorTranslationFiles={_='secureValueErrorTranslationFiles', type=SecureValueType, file_hash={'bytes'}, text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueHash.md b/old_docs/API_docs_v109/constructors/secureValueHash.md new file mode 100644 index 00000000..5035b7d0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueHash.md @@ -0,0 +1,39 @@ +--- +title: secureValueHash +description: Secure value hash +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueHash +[Back to constructors index](index.md) + + + +Secure value hash + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[SecureValueType](../types/SecureValueType.md) | Yes|Secure value type| +|hash|[bytes](../types/bytes.md) | Yes|Hash| + + + +### Type: [SecureValueHash](../types/SecureValueHash.md) + + +### Example: + +```php +$secureValueHash = ['_' => 'secureValueHash', 'type' => SecureValueType, 'hash' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +secureValueHash={_='secureValueHash', type=SecureValueType, hash='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypeAddress.md b/old_docs/API_docs_v109/constructors/secureValueTypeAddress.md new file mode 100644 index 00000000..cb1aea2a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypeAddress.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeAddress +description: Address +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeAddress +[Back to constructors index](index.md) + + + +Address + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeAddress = ['_' => 'secureValueTypeAddress']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeAddress={_='secureValueTypeAddress'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypeBankStatement.md b/old_docs/API_docs_v109/constructors/secureValueTypeBankStatement.md new file mode 100644 index 00000000..acdeca36 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypeBankStatement.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeBankStatement +description: Bank statement +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeBankStatement +[Back to constructors index](index.md) + + + +Bank statement + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeBankStatement = ['_' => 'secureValueTypeBankStatement']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeBankStatement={_='secureValueTypeBankStatement'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypeDriverLicense.md b/old_docs/API_docs_v109/constructors/secureValueTypeDriverLicense.md new file mode 100644 index 00000000..931a4787 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypeDriverLicense.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeDriverLicense +description: Driver's license +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeDriverLicense +[Back to constructors index](index.md) + + + +Driver's license + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeDriverLicense = ['_' => 'secureValueTypeDriverLicense']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeDriverLicense={_='secureValueTypeDriverLicense'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypeEmail.md b/old_docs/API_docs_v109/constructors/secureValueTypeEmail.md new file mode 100644 index 00000000..6ff8f3d9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypeEmail.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeEmail +description: Email +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeEmail +[Back to constructors index](index.md) + + + +Email + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeEmail = ['_' => 'secureValueTypeEmail']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeEmail={_='secureValueTypeEmail'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypeIdentityCard.md b/old_docs/API_docs_v109/constructors/secureValueTypeIdentityCard.md new file mode 100644 index 00000000..5ec80560 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypeIdentityCard.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeIdentityCard +description: Identity card +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeIdentityCard +[Back to constructors index](index.md) + + + +Identity card + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeIdentityCard = ['_' => 'secureValueTypeIdentityCard']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeIdentityCard={_='secureValueTypeIdentityCard'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypeInternalPassport.md b/old_docs/API_docs_v109/constructors/secureValueTypeInternalPassport.md new file mode 100644 index 00000000..0cd5b18f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypeInternalPassport.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeInternalPassport +description: Internal [passport](https://core.telegram.org/passport) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeInternalPassport +[Back to constructors index](index.md) + + + +Internal [passport](https://core.telegram.org/passport) + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeInternalPassport = ['_' => 'secureValueTypeInternalPassport']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeInternalPassport={_='secureValueTypeInternalPassport'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypePassport.md b/old_docs/API_docs_v109/constructors/secureValueTypePassport.md new file mode 100644 index 00000000..cb62c8bb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypePassport.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypePassport +description: Passport +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePassport +[Back to constructors index](index.md) + + + +Passport + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypePassport = ['_' => 'secureValueTypePassport']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypePassport={_='secureValueTypePassport'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypePassportRegistration.md b/old_docs/API_docs_v109/constructors/secureValueTypePassportRegistration.md new file mode 100644 index 00000000..dd1dec1f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypePassportRegistration.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypePassportRegistration +description: Internal registration [passport](https://core.telegram.org/passport) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePassportRegistration +[Back to constructors index](index.md) + + + +Internal registration [passport](https://core.telegram.org/passport) + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypePassportRegistration = ['_' => 'secureValueTypePassportRegistration']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypePassportRegistration={_='secureValueTypePassportRegistration'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypePersonalDetails.md b/old_docs/API_docs_v109/constructors/secureValueTypePersonalDetails.md new file mode 100644 index 00000000..ec3af9ab --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypePersonalDetails.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypePersonalDetails +description: Personal details +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePersonalDetails +[Back to constructors index](index.md) + + + +Personal details + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypePersonalDetails = ['_' => 'secureValueTypePersonalDetails']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypePersonalDetails={_='secureValueTypePersonalDetails'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypePhone.md b/old_docs/API_docs_v109/constructors/secureValueTypePhone.md new file mode 100644 index 00000000..63a5e60c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypePhone.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypePhone +description: Phone +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypePhone +[Back to constructors index](index.md) + + + +Phone + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypePhone = ['_' => 'secureValueTypePhone']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypePhone={_='secureValueTypePhone'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypeRentalAgreement.md b/old_docs/API_docs_v109/constructors/secureValueTypeRentalAgreement.md new file mode 100644 index 00000000..5c789815 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypeRentalAgreement.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeRentalAgreement +description: Rental agreement +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeRentalAgreement +[Back to constructors index](index.md) + + + +Rental agreement + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeRentalAgreement = ['_' => 'secureValueTypeRentalAgreement']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeRentalAgreement={_='secureValueTypeRentalAgreement'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypeTemporaryRegistration.md b/old_docs/API_docs_v109/constructors/secureValueTypeTemporaryRegistration.md new file mode 100644 index 00000000..fd6c6d1a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypeTemporaryRegistration.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeTemporaryRegistration +description: Temporary registration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeTemporaryRegistration +[Back to constructors index](index.md) + + + +Temporary registration + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeTemporaryRegistration = ['_' => 'secureValueTypeTemporaryRegistration']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeTemporaryRegistration={_='secureValueTypeTemporaryRegistration'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/secureValueTypeUtilityBill.md b/old_docs/API_docs_v109/constructors/secureValueTypeUtilityBill.md new file mode 100644 index 00000000..8ea49b4e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/secureValueTypeUtilityBill.md @@ -0,0 +1,33 @@ +--- +title: secureValueTypeUtilityBill +description: Utility bill +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: secureValueTypeUtilityBill +[Back to constructors index](index.md) + + + +Utility bill + + + + +### Type: [SecureValueType](../types/SecureValueType.md) + + +### Example: + +```php +$secureValueTypeUtilityBill = ['_' => 'secureValueTypeUtilityBill']; +``` + + +Or, if you're into Lua: + +```lua +secureValueTypeUtilityBill={_='secureValueTypeUtilityBill'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageCancelAction.md b/old_docs/API_docs_v109/constructors/sendMessageCancelAction.md new file mode 100644 index 00000000..c86c4cd5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageCancelAction.md @@ -0,0 +1,33 @@ +--- +title: sendMessageCancelAction +description: Invalidate all previous action updates. E.g. when user deletes entered text or aborts a video upload. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageCancelAction +[Back to constructors index](index.md) + + + +Invalidate all previous action updates. E.g. when user deletes entered text or aborts a video upload. + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageCancelAction = ['_' => 'sendMessageCancelAction']; +``` + + +Or, if you're into Lua: + +```lua +sendMessageCancelAction={_='sendMessageCancelAction'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageChooseContactAction.md b/old_docs/API_docs_v109/constructors/sendMessageChooseContactAction.md new file mode 100644 index 00000000..66502316 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageChooseContactAction.md @@ -0,0 +1,33 @@ +--- +title: sendMessageChooseContactAction +description: User is selecting a contact to share. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageChooseContactAction +[Back to constructors index](index.md) + + + +User is selecting a contact to share. + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageChooseContactAction = ['_' => 'sendMessageChooseContactAction']; +``` + + +Or, if you're into Lua: + +```lua +sendMessageChooseContactAction={_='sendMessageChooseContactAction'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageGamePlayAction.md b/old_docs/API_docs_v109/constructors/sendMessageGamePlayAction.md new file mode 100644 index 00000000..23ed8757 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageGamePlayAction.md @@ -0,0 +1,33 @@ +--- +title: sendMessageGamePlayAction +description: User is playing a game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageGamePlayAction +[Back to constructors index](index.md) + + + +User is playing a game + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageGamePlayAction = ['_' => 'sendMessageGamePlayAction']; +``` + + +Or, if you're into Lua: + +```lua +sendMessageGamePlayAction={_='sendMessageGamePlayAction'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageGeoLocationAction.md b/old_docs/API_docs_v109/constructors/sendMessageGeoLocationAction.md new file mode 100644 index 00000000..98df3831 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageGeoLocationAction.md @@ -0,0 +1,33 @@ +--- +title: sendMessageGeoLocationAction +description: User is selecting a location to share. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageGeoLocationAction +[Back to constructors index](index.md) + + + +User is selecting a location to share. + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageGeoLocationAction = ['_' => 'sendMessageGeoLocationAction']; +``` + + +Or, if you're into Lua: + +```lua +sendMessageGeoLocationAction={_='sendMessageGeoLocationAction'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageRecordAudioAction.md b/old_docs/API_docs_v109/constructors/sendMessageRecordAudioAction.md new file mode 100644 index 00000000..0ed652a4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageRecordAudioAction.md @@ -0,0 +1,33 @@ +--- +title: sendMessageRecordAudioAction +description: User is recording a voice message. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageRecordAudioAction +[Back to constructors index](index.md) + + + +User is recording a voice message. + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageRecordAudioAction = ['_' => 'sendMessageRecordAudioAction']; +``` + + +Or, if you're into Lua: + +```lua +sendMessageRecordAudioAction={_='sendMessageRecordAudioAction'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageRecordRoundAction.md b/old_docs/API_docs_v109/constructors/sendMessageRecordRoundAction.md new file mode 100644 index 00000000..7a7d2586 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageRecordRoundAction.md @@ -0,0 +1,33 @@ +--- +title: sendMessageRecordRoundAction +description: User is recording a round video to share +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageRecordRoundAction +[Back to constructors index](index.md) + + + +User is recording a round video to share + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageRecordRoundAction = ['_' => 'sendMessageRecordRoundAction']; +``` + + +Or, if you're into Lua: + +```lua +sendMessageRecordRoundAction={_='sendMessageRecordRoundAction'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageRecordVideoAction.md b/old_docs/API_docs_v109/constructors/sendMessageRecordVideoAction.md new file mode 100644 index 00000000..cb3aa225 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageRecordVideoAction.md @@ -0,0 +1,33 @@ +--- +title: sendMessageRecordVideoAction +description: User is recording a video. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageRecordVideoAction +[Back to constructors index](index.md) + + + +User is recording a video. + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageRecordVideoAction = ['_' => 'sendMessageRecordVideoAction']; +``` + + +Or, if you're into Lua: + +```lua +sendMessageRecordVideoAction={_='sendMessageRecordVideoAction'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageTypingAction.md b/old_docs/API_docs_v109/constructors/sendMessageTypingAction.md new file mode 100644 index 00000000..6afda6b2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageTypingAction.md @@ -0,0 +1,33 @@ +--- +title: sendMessageTypingAction +description: User is typing. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageTypingAction +[Back to constructors index](index.md) + + + +User is typing. + + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageTypingAction = ['_' => 'sendMessageTypingAction']; +``` + + +Or, if you're into Lua: + +```lua +sendMessageTypingAction={_='sendMessageTypingAction'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageUploadAudioAction.md b/old_docs/API_docs_v109/constructors/sendMessageUploadAudioAction.md new file mode 100644 index 00000000..3b915af2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageUploadAudioAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageUploadAudioAction +description: User is uploading a voice message. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageUploadAudioAction +[Back to constructors index](index.md) + + + +User is uploading a voice message. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|progress|[int](../types/int.md) | Yes|Progress percentage| + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageUploadAudioAction = ['_' => 'sendMessageUploadAudioAction', 'progress' => int]; +``` + + +Or, if you're into Lua: + +```lua +sendMessageUploadAudioAction={_='sendMessageUploadAudioAction', progress=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageUploadDocumentAction.md b/old_docs/API_docs_v109/constructors/sendMessageUploadDocumentAction.md new file mode 100644 index 00000000..b0292344 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageUploadDocumentAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageUploadDocumentAction +description: User is uploading a file. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageUploadDocumentAction +[Back to constructors index](index.md) + + + +User is uploading a file. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|progress|[int](../types/int.md) | Yes|Progress percentage| + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageUploadDocumentAction = ['_' => 'sendMessageUploadDocumentAction', 'progress' => int]; +``` + + +Or, if you're into Lua: + +```lua +sendMessageUploadDocumentAction={_='sendMessageUploadDocumentAction', progress=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageUploadPhotoAction.md b/old_docs/API_docs_v109/constructors/sendMessageUploadPhotoAction.md new file mode 100644 index 00000000..3e59cb6e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageUploadPhotoAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageUploadPhotoAction +description: User is uploading a photo. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageUploadPhotoAction +[Back to constructors index](index.md) + + + +User is uploading a photo. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|progress|[int](../types/int.md) | Yes|Progress percentage| + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageUploadPhotoAction = ['_' => 'sendMessageUploadPhotoAction', 'progress' => int]; +``` + + +Or, if you're into Lua: + +```lua +sendMessageUploadPhotoAction={_='sendMessageUploadPhotoAction', progress=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageUploadRoundAction.md b/old_docs/API_docs_v109/constructors/sendMessageUploadRoundAction.md new file mode 100644 index 00000000..a52b1021 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageUploadRoundAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageUploadRoundAction +description: User is uploading a round video +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageUploadRoundAction +[Back to constructors index](index.md) + + + +User is uploading a round video + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|progress|[int](../types/int.md) | Yes|Progress percentage| + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageUploadRoundAction = ['_' => 'sendMessageUploadRoundAction', 'progress' => int]; +``` + + +Or, if you're into Lua: + +```lua +sendMessageUploadRoundAction={_='sendMessageUploadRoundAction', progress=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/sendMessageUploadVideoAction.md b/old_docs/API_docs_v109/constructors/sendMessageUploadVideoAction.md new file mode 100644 index 00000000..75102a1b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/sendMessageUploadVideoAction.md @@ -0,0 +1,38 @@ +--- +title: sendMessageUploadVideoAction +description: User is uploading a video. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: sendMessageUploadVideoAction +[Back to constructors index](index.md) + + + +User is uploading a video. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|progress|[int](../types/int.md) | Yes|Progress percentage| + + + +### Type: [SendMessageAction](../types/SendMessageAction.md) + + +### Example: + +```php +$sendMessageUploadVideoAction = ['_' => 'sendMessageUploadVideoAction', 'progress' => int]; +``` + + +Or, if you're into Lua: + +```lua +sendMessageUploadVideoAction={_='sendMessageUploadVideoAction', progress=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/shippingOption.md b/old_docs/API_docs_v109/constructors/shippingOption.md new file mode 100644 index 00000000..e0dcb726 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/shippingOption.md @@ -0,0 +1,40 @@ +--- +title: shippingOption +description: Shipping option +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: shippingOption +[Back to constructors index](index.md) + + + +Shipping option + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[string](../types/string.md) | Yes|Option ID| +|title|[string](../types/string.md) | Yes|Title| +|prices|Array of [LabeledPrice](../types/LabeledPrice.md) | Yes|Prices| + + + +### Type: [ShippingOption](../types/ShippingOption.md) + + +### Example: + +```php +$shippingOption = ['_' => 'shippingOption', 'id' => 'string', 'title' => 'string', 'prices' => [LabeledPrice, LabeledPrice]]; +``` + + +Or, if you're into Lua: + +```lua +shippingOption={_='shippingOption', id='string', title='string', prices={LabeledPrice}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/statsURL.md b/old_docs/API_docs_v109/constructors/statsURL.md new file mode 100644 index 00000000..51f29f3c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/statsURL.md @@ -0,0 +1,38 @@ +--- +title: statsURL +description: URL with chat statistics +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: statsURL +[Back to constructors index](index.md) + + + +URL with chat statistics + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Chat statistics| + + + +### Type: [StatsURL](../types/StatsURL.md) + + +### Example: + +```php +$statsURL = ['_' => 'statsURL', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +statsURL={_='statsURL', url='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/stickerPack.md b/old_docs/API_docs_v109/constructors/stickerPack.md new file mode 100644 index 00000000..77591a3e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/stickerPack.md @@ -0,0 +1,41 @@ +--- +title: stickerPack +description: A stickerpack is a group of stickers associated to the same emoji. +It is **not** a sticker pack the way it is usually intended, you may be looking for a [StickerSet](../types/StickerSet.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: stickerPack +[Back to constructors index](index.md) + + + +A stickerpack is a group of stickers associated to the same emoji. +It is **not** a sticker pack the way it is usually intended, you may be looking for a [StickerSet](../types/StickerSet.md). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[string](../types/string.md) | Yes|Emoji| +|documents|Array of [long](../types/long.md) | Yes|Documents| + + + +### Type: [StickerPack](../types/StickerPack.md) + + +### Example: + +```php +$stickerPack = ['_' => 'stickerPack', 'emoticon' => 'string', 'documents' => [long, long]]; +``` + + +Or, if you're into Lua: + +```lua +stickerPack={_='stickerPack', emoticon='string', documents={long}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/stickerSet.md b/old_docs/API_docs_v109/constructors/stickerSet.md new file mode 100644 index 00000000..cd8b11ef --- /dev/null +++ b/old_docs/API_docs_v109/constructors/stickerSet.md @@ -0,0 +1,50 @@ +--- +title: stickerSet +description: Represents a stickerset (stickerpack) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: stickerSet +[Back to constructors index](index.md) + + + +Represents a stickerset (stickerpack) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|archived|[Bool](../types/Bool.md) | Optional|Whether this stickerset was archived (due to too many saved stickers in the current account)| +|official|[Bool](../types/Bool.md) | Optional|Is this stickerset official| +|masks|[Bool](../types/Bool.md) | Optional|Is this a mask stickerset| +|animated|[Bool](../types/Bool.md) | Optional|Is this an animated stickerpack| +|installed\_date|[int](../types/int.md) | Optional|When was this stickerset installed| +|id|[long](../types/long.md) | Yes|ID of the stickerset| +|access\_hash|[long](../types/long.md) | Yes|Access hash of stickerset| +|title|[string](../types/string.md) | Yes|Title of stickerset| +|short\_name|[string](../types/string.md) | Yes|Short name of stickerset to use in `tg://addstickers?set=short_name`| +|thumb|[PhotoSize](../types/PhotoSize.md) | Optional|Thumbnail for stickerset| +|thumb\_dc\_id|[int](../types/int.md) | Optional|DC ID of thumbnail| +|count|[int](../types/int.md) | Yes|Number of stickers in pack| +|hash|[int](../types/int.md) | Yes|Hash| + + + +### Type: [StickerSet](../types/StickerSet.md) + + +### Example: + +```php +$stickerSet = ['_' => 'stickerSet', 'archived' => Bool, 'official' => Bool, 'masks' => Bool, 'animated' => Bool, 'installed_date' => int, 'id' => long, 'access_hash' => long, 'title' => 'string', 'short_name' => 'string', 'thumb' => PhotoSize, 'thumb_dc_id' => int, 'count' => int, 'hash' => int]; +``` + + +Or, if you're into Lua: + +```lua +stickerSet={_='stickerSet', archived=Bool, official=Bool, masks=Bool, animated=Bool, installed_date=int, id=long, access_hash=long, title='string', short_name='string', thumb=PhotoSize, thumb_dc_id=int, count=int, hash=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/stickerSetCovered.md b/old_docs/API_docs_v109/constructors/stickerSetCovered.md new file mode 100644 index 00000000..dc18cf12 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/stickerSetCovered.md @@ -0,0 +1,39 @@ +--- +title: stickerSetCovered +description: Stickerset, with a specific sticker as preview +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: stickerSetCovered +[Back to constructors index](index.md) + + + +Stickerset, with a specific sticker as preview + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|set|[StickerSet](../types/StickerSet.md) | Yes|Stickerset| +|cover|[Document](../types/Document.md) | Optional|Preview| + + + +### Type: [StickerSetCovered](../types/StickerSetCovered.md) + + +### Example: + +```php +$stickerSetCovered = ['_' => 'stickerSetCovered', 'set' => StickerSet, 'cover' => Document]; +``` + + +Or, if you're into Lua: + +```lua +stickerSetCovered={_='stickerSetCovered', set=StickerSet, cover=Document} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/stickerSetMultiCovered.md b/old_docs/API_docs_v109/constructors/stickerSetMultiCovered.md new file mode 100644 index 00000000..8c73a0c3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/stickerSetMultiCovered.md @@ -0,0 +1,39 @@ +--- +title: stickerSetMultiCovered +description: Stickerset, with a specific stickers as preview +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: stickerSetMultiCovered +[Back to constructors index](index.md) + + + +Stickerset, with a specific stickers as preview + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|set|[StickerSet](../types/StickerSet.md) | Yes|Stickerset| +|covers|Array of [Document](../types/Document.md) | Yes|Covers| + + + +### Type: [StickerSetCovered](../types/StickerSetCovered.md) + + +### Example: + +```php +$stickerSetMultiCovered = ['_' => 'stickerSetMultiCovered', 'set' => StickerSet, 'covers' => [Document, Document]]; +``` + + +Or, if you're into Lua: + +```lua +stickerSetMultiCovered={_='stickerSetMultiCovered', set=StickerSet, covers={Document}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/storage.fileGif.md b/old_docs/API_docs_v109/constructors/storage.fileGif.md new file mode 100644 index 00000000..eff8f692 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/storage.fileGif.md @@ -0,0 +1,34 @@ +--- +title: storage.fileGif +description: GIF image. MIME type: `image/gif`. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/storage_fileGif.html +--- +# Constructor: storage.fileGif +[Back to constructors index](index.md) + + + +GIF image. MIME type: `image/gif`. + + + + +### Type: [storage.FileType](../types/storage.FileType.md) + + +### Example: + +```php +$storage.fileGif = ['_' => 'storage.fileGif']; +``` + + +Or, if you're into Lua: + +```lua +storage.fileGif={_='storage.fileGif'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/storage.fileJpeg.md b/old_docs/API_docs_v109/constructors/storage.fileJpeg.md new file mode 100644 index 00000000..2ac6e613 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/storage.fileJpeg.md @@ -0,0 +1,34 @@ +--- +title: storage.fileJpeg +description: JPEG image. MIME type: `image/jpeg`. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/storage_fileJpeg.html +--- +# Constructor: storage.fileJpeg +[Back to constructors index](index.md) + + + +JPEG image. MIME type: `image/jpeg`. + + + + +### Type: [storage.FileType](../types/storage.FileType.md) + + +### Example: + +```php +$storage.fileJpeg = ['_' => 'storage.fileJpeg']; +``` + + +Or, if you're into Lua: + +```lua +storage.fileJpeg={_='storage.fileJpeg'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/storage.fileMov.md b/old_docs/API_docs_v109/constructors/storage.fileMov.md new file mode 100644 index 00000000..0dfeb1f8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/storage.fileMov.md @@ -0,0 +1,34 @@ +--- +title: storage.fileMov +description: Quicktime video. MIME type: `video/quicktime`. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/storage_fileMov.html +--- +# Constructor: storage.fileMov +[Back to constructors index](index.md) + + + +Quicktime video. MIME type: `video/quicktime`. + + + + +### Type: [storage.FileType](../types/storage.FileType.md) + + +### Example: + +```php +$storage.fileMov = ['_' => 'storage.fileMov']; +``` + + +Or, if you're into Lua: + +```lua +storage.fileMov={_='storage.fileMov'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/storage.fileMp3.md b/old_docs/API_docs_v109/constructors/storage.fileMp3.md new file mode 100644 index 00000000..3d5a13e3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/storage.fileMp3.md @@ -0,0 +1,34 @@ +--- +title: storage.fileMp3 +description: Mp3 audio. MIME type: `audio/mpeg`. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/storage_fileMp3.html +--- +# Constructor: storage.fileMp3 +[Back to constructors index](index.md) + + + +Mp3 audio. MIME type: `audio/mpeg`. + + + + +### Type: [storage.FileType](../types/storage.FileType.md) + + +### Example: + +```php +$storage.fileMp3 = ['_' => 'storage.fileMp3']; +``` + + +Or, if you're into Lua: + +```lua +storage.fileMp3={_='storage.fileMp3'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/storage.fileMp4.md b/old_docs/API_docs_v109/constructors/storage.fileMp4.md new file mode 100644 index 00000000..c1034fa3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/storage.fileMp4.md @@ -0,0 +1,34 @@ +--- +title: storage.fileMp4 +description: MPEG-4 video. MIME type: `video/mp4`. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/storage_fileMp4.html +--- +# Constructor: storage.fileMp4 +[Back to constructors index](index.md) + + + +MPEG-4 video. MIME type: `video/mp4`. + + + + +### Type: [storage.FileType](../types/storage.FileType.md) + + +### Example: + +```php +$storage.fileMp4 = ['_' => 'storage.fileMp4']; +``` + + +Or, if you're into Lua: + +```lua +storage.fileMp4={_='storage.fileMp4'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/storage.filePartial.md b/old_docs/API_docs_v109/constructors/storage.filePartial.md new file mode 100644 index 00000000..c9ffd17d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/storage.filePartial.md @@ -0,0 +1,34 @@ +--- +title: storage.filePartial +description: Part of a bigger file. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/storage_filePartial.html +--- +# Constructor: storage.filePartial +[Back to constructors index](index.md) + + + +Part of a bigger file. + + + + +### Type: [storage.FileType](../types/storage.FileType.md) + + +### Example: + +```php +$storage.filePartial = ['_' => 'storage.filePartial']; +``` + + +Or, if you're into Lua: + +```lua +storage.filePartial={_='storage.filePartial'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/storage.filePdf.md b/old_docs/API_docs_v109/constructors/storage.filePdf.md new file mode 100644 index 00000000..648972b6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/storage.filePdf.md @@ -0,0 +1,34 @@ +--- +title: storage.filePdf +description: PDF document image. MIME type: `application/pdf`. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/storage_filePdf.html +--- +# Constructor: storage.filePdf +[Back to constructors index](index.md) + + + +PDF document image. MIME type: `application/pdf`. + + + + +### Type: [storage.FileType](../types/storage.FileType.md) + + +### Example: + +```php +$storage.filePdf = ['_' => 'storage.filePdf']; +``` + + +Or, if you're into Lua: + +```lua +storage.filePdf={_='storage.filePdf'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/storage.filePng.md b/old_docs/API_docs_v109/constructors/storage.filePng.md new file mode 100644 index 00000000..d56c7c5f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/storage.filePng.md @@ -0,0 +1,34 @@ +--- +title: storage.filePng +description: PNG image. MIME type: `image/png`. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/storage_filePng.html +--- +# Constructor: storage.filePng +[Back to constructors index](index.md) + + + +PNG image. MIME type: `image/png`. + + + + +### Type: [storage.FileType](../types/storage.FileType.md) + + +### Example: + +```php +$storage.filePng = ['_' => 'storage.filePng']; +``` + + +Or, if you're into Lua: + +```lua +storage.filePng={_='storage.filePng'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/storage.fileUnknown.md b/old_docs/API_docs_v109/constructors/storage.fileUnknown.md new file mode 100644 index 00000000..344896de --- /dev/null +++ b/old_docs/API_docs_v109/constructors/storage.fileUnknown.md @@ -0,0 +1,34 @@ +--- +title: storage.fileUnknown +description: Unknown type. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/storage_fileUnknown.html +--- +# Constructor: storage.fileUnknown +[Back to constructors index](index.md) + + + +Unknown type. + + + + +### Type: [storage.FileType](../types/storage.FileType.md) + + +### Example: + +```php +$storage.fileUnknown = ['_' => 'storage.fileUnknown']; +``` + + +Or, if you're into Lua: + +```lua +storage.fileUnknown={_='storage.fileUnknown'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/storage.fileWebp.md b/old_docs/API_docs_v109/constructors/storage.fileWebp.md new file mode 100644 index 00000000..bf67f977 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/storage.fileWebp.md @@ -0,0 +1,34 @@ +--- +title: storage.fileWebp +description: WEBP image. MIME type: `image/webp`. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/storage_fileWebp.html +--- +# Constructor: storage.fileWebp +[Back to constructors index](index.md) + + + +WEBP image. MIME type: `image/webp`. + + + + +### Type: [storage.FileType](../types/storage.FileType.md) + + +### Example: + +```php +$storage.fileWebp = ['_' => 'storage.fileWebp']; +``` + + +Or, if you're into Lua: + +```lua +storage.fileWebp={_='storage.fileWebp'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textAnchor.md b/old_docs/API_docs_v109/constructors/textAnchor.md new file mode 100644 index 00000000..34d43623 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textAnchor.md @@ -0,0 +1,39 @@ +--- +title: textAnchor +description: Text linking to another section of the page +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textAnchor +[Back to constructors index](index.md) + + + +Text linking to another section of the page + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| +|name|[string](../types/string.md) | Yes|Section name| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textAnchor = ['_' => 'textAnchor', 'text' => RichText, 'name' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +textAnchor={_='textAnchor', text=RichText, name='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textBold.md b/old_docs/API_docs_v109/constructors/textBold.md new file mode 100644 index 00000000..765b606d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textBold.md @@ -0,0 +1,38 @@ +--- +title: textBold +description: **Bold** text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textBold +[Back to constructors index](index.md) + + + +**Bold** text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textBold = ['_' => 'textBold', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textBold={_='textBold', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textConcat.md b/old_docs/API_docs_v109/constructors/textConcat.md new file mode 100644 index 00000000..541d1d86 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textConcat.md @@ -0,0 +1,38 @@ +--- +title: textConcat +description: Concatenation of rich texts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textConcat +[Back to constructors index](index.md) + + + +Concatenation of rich texts + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|texts|Array of [RichText](../types/RichText.md) | Yes|Texts| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textConcat = ['_' => 'textConcat', 'texts' => [RichText, RichText]]; +``` + + +Or, if you're into Lua: + +```lua +textConcat={_='textConcat', texts={RichText}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textEmail.md b/old_docs/API_docs_v109/constructors/textEmail.md new file mode 100644 index 00000000..cb82af7c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textEmail.md @@ -0,0 +1,39 @@ +--- +title: textEmail +description: Rich text email link +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textEmail +[Back to constructors index](index.md) + + + +Rich text email link + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Link text| +|email|[string](../types/string.md) | Yes|Email address| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textEmail = ['_' => 'textEmail', 'text' => RichText, 'email' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +textEmail={_='textEmail', text=RichText, email='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textEmpty.md b/old_docs/API_docs_v109/constructors/textEmpty.md new file mode 100644 index 00000000..ff79509d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textEmpty.md @@ -0,0 +1,33 @@ +--- +title: textEmpty +description: Empty rich text element +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textEmpty +[Back to constructors index](index.md) + + + +Empty rich text element + + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textEmpty = ['_' => 'textEmpty']; +``` + + +Or, if you're into Lua: + +```lua +textEmpty={_='textEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textFixed.md b/old_docs/API_docs_v109/constructors/textFixed.md new file mode 100644 index 00000000..1b4dd5e2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textFixed.md @@ -0,0 +1,38 @@ +--- +title: textFixed +description: `fixed-width` rich text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textFixed +[Back to constructors index](index.md) + + + +`fixed-width` rich text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textFixed = ['_' => 'textFixed', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textFixed={_='textFixed', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textImage.md b/old_docs/API_docs_v109/constructors/textImage.md new file mode 100644 index 00000000..b913b2c4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textImage.md @@ -0,0 +1,40 @@ +--- +title: textImage +description: Inline image +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textImage +[Back to constructors index](index.md) + + + +Inline image + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|document\_id|[long](../types/long.md) | Yes|Document ID| +|w|[int](../types/int.md) | Yes|Width| +|h|[int](../types/int.md) | Yes|Height| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textImage = ['_' => 'textImage', 'document_id' => long, 'w' => int, 'h' => int]; +``` + + +Or, if you're into Lua: + +```lua +textImage={_='textImage', document_id=long, w=int, h=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textItalic.md b/old_docs/API_docs_v109/constructors/textItalic.md new file mode 100644 index 00000000..12f99413 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textItalic.md @@ -0,0 +1,38 @@ +--- +title: textItalic +description: *Italic* text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textItalic +[Back to constructors index](index.md) + + + +*Italic* text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textItalic = ['_' => 'textItalic', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textItalic={_='textItalic', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textMarked.md b/old_docs/API_docs_v109/constructors/textMarked.md new file mode 100644 index 00000000..eca55786 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textMarked.md @@ -0,0 +1,38 @@ +--- +title: textMarked +description: Highlighted text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textMarked +[Back to constructors index](index.md) + + + +Highlighted text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textMarked = ['_' => 'textMarked', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textMarked={_='textMarked', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textPhone.md b/old_docs/API_docs_v109/constructors/textPhone.md new file mode 100644 index 00000000..f934f7d2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textPhone.md @@ -0,0 +1,39 @@ +--- +title: textPhone +description: Rich text linked to a phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textPhone +[Back to constructors index](index.md) + + + +Rich text linked to a phone number + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| +|phone|[string](../types/string.md) | Yes|Phone number| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textPhone = ['_' => 'textPhone', 'text' => RichText, 'phone' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +textPhone={_='textPhone', text=RichText, phone='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textPlain.md b/old_docs/API_docs_v109/constructors/textPlain.md new file mode 100644 index 00000000..d94fea42 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textPlain.md @@ -0,0 +1,38 @@ +--- +title: textPlain +description: Plain text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textPlain +[Back to constructors index](index.md) + + + +Plain text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[string](../types/string.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textPlain = ['_' => 'textPlain', 'text' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +textPlain={_='textPlain', text='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textStrike.md b/old_docs/API_docs_v109/constructors/textStrike.md new file mode 100644 index 00000000..c797a27a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textStrike.md @@ -0,0 +1,38 @@ +--- +title: textStrike +description: Strikethrough text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textStrike +[Back to constructors index](index.md) + + + +Strikethrough text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textStrike = ['_' => 'textStrike', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textStrike={_='textStrike', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textSubscript.md b/old_docs/API_docs_v109/constructors/textSubscript.md new file mode 100644 index 00000000..501bc7b6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textSubscript.md @@ -0,0 +1,38 @@ +--- +title: textSubscript +description: Subscript text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textSubscript +[Back to constructors index](index.md) + + + +Subscript text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textSubscript = ['_' => 'textSubscript', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textSubscript={_='textSubscript', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textSuperscript.md b/old_docs/API_docs_v109/constructors/textSuperscript.md new file mode 100644 index 00000000..bc1a3636 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textSuperscript.md @@ -0,0 +1,38 @@ +--- +title: textSuperscript +description: Superscript text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textSuperscript +[Back to constructors index](index.md) + + + +Superscript text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textSuperscript = ['_' => 'textSuperscript', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textSuperscript={_='textSuperscript', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textUnderline.md b/old_docs/API_docs_v109/constructors/textUnderline.md new file mode 100644 index 00000000..624e12f6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textUnderline.md @@ -0,0 +1,38 @@ +--- +title: textUnderline +description: Underlined text +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textUnderline +[Back to constructors index](index.md) + + + +Underlined text + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textUnderline = ['_' => 'textUnderline', 'text' => RichText]; +``` + + +Or, if you're into Lua: + +```lua +textUnderline={_='textUnderline', text=RichText} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/textUrl.md b/old_docs/API_docs_v109/constructors/textUrl.md new file mode 100644 index 00000000..f5c05080 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/textUrl.md @@ -0,0 +1,40 @@ +--- +title: textUrl +description: Link +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: textUrl +[Back to constructors index](index.md) + + + +Link + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|text|[RichText](../types/RichText.md) | Yes|Text of link| +|url|[string](../types/string.md) | Yes|Webpage HTTP URL| +|webpage\_id|[long](../types/long.md) | Yes|If a preview was already generated for the page, the page ID| + + + +### Type: [RichText](../types/RichText.md) + + +### Example: + +```php +$textUrl = ['_' => 'textUrl', 'text' => RichText, 'url' => 'string', 'webpage_id' => long]; +``` + + +Or, if you're into Lua: + +```lua +textUrl={_='textUrl', text=RichText, url='string', webpage_id=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/theme.md b/old_docs/API_docs_v109/constructors/theme.md new file mode 100644 index 00000000..77539cf1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/theme.md @@ -0,0 +1,46 @@ +--- +title: theme +description: Theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: theme +[Back to constructors index](index.md) + + + +Theme + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|creator|[Bool](../types/Bool.md) | Optional|Whether the current user is the creator of this theme| +|default|[Bool](../types/Bool.md) | Optional|Whether this is the default theme| +|id|[long](../types/long.md) | Yes|Theme ID| +|access\_hash|[long](../types/long.md) | Yes|Theme access hash| +|slug|[string](../types/string.md) | Yes|Unique theme ID| +|title|[string](../types/string.md) | Yes|Theme name| +|document|[Document](../types/Document.md) | Optional|Theme| +|settings|[ThemeSettings](../types/ThemeSettings.md) | Optional|| +|installs\_count|[int](../types/int.md) | Yes|Installation count| + + + +### Type: [Theme](../types/Theme.md) + + +### Example: + +```php +$theme = ['_' => 'theme', 'creator' => Bool, 'default' => Bool, 'id' => long, 'access_hash' => long, 'slug' => 'string', 'title' => 'string', 'document' => Document, 'settings' => ThemeSettings, 'installs_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +theme={_='theme', creator=Bool, default=Bool, id=long, access_hash=long, slug='string', title='string', document=Document, settings=ThemeSettings, installs_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/themeSettings.md b/old_docs/API_docs_v109/constructors/themeSettings.md new file mode 100644 index 00000000..bbcb4618 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/themeSettings.md @@ -0,0 +1,40 @@ +--- +title: themeSettings +description: themeSettings attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: themeSettings +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|base\_theme|[BaseTheme](../types/BaseTheme.md) | Yes| +|accent\_color|[int](../types/int.md) | Yes| +|message\_top\_color|[int](../types/int.md) | Optional| +|message\_bottom\_color|[int](../types/int.md) | Optional| +|wallpaper|[WallPaper](../types/WallPaper.md) | Optional| + + + +### Type: [ThemeSettings](../types/ThemeSettings.md) + + +### Example: + +```php +$themeSettings = ['_' => 'themeSettings', 'base_theme' => BaseTheme, 'accent_color' => int, 'message_top_color' => int, 'message_bottom_color' => int, 'wallpaper' => WallPaper]; +``` + + +Or, if you're into Lua: + +```lua +themeSettings={_='themeSettings', base_theme=BaseTheme, accent_color=int, message_top_color=int, message_bottom_color=int, wallpaper=WallPaper} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/topPeer.md b/old_docs/API_docs_v109/constructors/topPeer.md new file mode 100644 index 00000000..bd5ed0d9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/topPeer.md @@ -0,0 +1,39 @@ +--- +title: topPeer +description: Top peer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeer +[Back to constructors index](index.md) + + + +Top peer + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|Peer| +|rating|[double](../types/double.md) | Yes|Rating as computer in [top peer rating »](https://core.telegram.org/api/top-rating)| + + + +### Type: [TopPeer](../types/TopPeer.md) + + +### Example: + +```php +$topPeer = ['_' => 'topPeer', 'peer' => Peer, 'rating' => double]; +``` + + +Or, if you're into Lua: + +```lua +topPeer={_='topPeer', peer=Peer, rating=double} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/topPeerCategoryBotsInline.md b/old_docs/API_docs_v109/constructors/topPeerCategoryBotsInline.md new file mode 100644 index 00000000..91ccb6c8 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/topPeerCategoryBotsInline.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryBotsInline +description: Most used inline bots +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryBotsInline +[Back to constructors index](index.md) + + + +Most used inline bots + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryBotsInline = ['_' => 'topPeerCategoryBotsInline']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryBotsInline={_='topPeerCategoryBotsInline'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/topPeerCategoryBotsPM.md b/old_docs/API_docs_v109/constructors/topPeerCategoryBotsPM.md new file mode 100644 index 00000000..ddea5ea1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/topPeerCategoryBotsPM.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryBotsPM +description: Most used bots +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryBotsPM +[Back to constructors index](index.md) + + + +Most used bots + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryBotsPM = ['_' => 'topPeerCategoryBotsPM']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryBotsPM={_='topPeerCategoryBotsPM'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/topPeerCategoryChannels.md b/old_docs/API_docs_v109/constructors/topPeerCategoryChannels.md new file mode 100644 index 00000000..05233319 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/topPeerCategoryChannels.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryChannels +description: Most frequently visited channels +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryChannels +[Back to constructors index](index.md) + + + +Most frequently visited channels + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryChannels = ['_' => 'topPeerCategoryChannels']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryChannels={_='topPeerCategoryChannels'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/topPeerCategoryCorrespondents.md b/old_docs/API_docs_v109/constructors/topPeerCategoryCorrespondents.md new file mode 100644 index 00000000..9f9fd2cd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/topPeerCategoryCorrespondents.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryCorrespondents +description: Users we've chatted most frequently with +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryCorrespondents +[Back to constructors index](index.md) + + + +Users we've chatted most frequently with + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryCorrespondents = ['_' => 'topPeerCategoryCorrespondents']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryCorrespondents={_='topPeerCategoryCorrespondents'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/topPeerCategoryForwardChats.md b/old_docs/API_docs_v109/constructors/topPeerCategoryForwardChats.md new file mode 100644 index 00000000..bb6ae873 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/topPeerCategoryForwardChats.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryForwardChats +description: Chats to which the users often forwards messages to +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryForwardChats +[Back to constructors index](index.md) + + + +Chats to which the users often forwards messages to + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryForwardChats = ['_' => 'topPeerCategoryForwardChats']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryForwardChats={_='topPeerCategoryForwardChats'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/topPeerCategoryForwardUsers.md b/old_docs/API_docs_v109/constructors/topPeerCategoryForwardUsers.md new file mode 100644 index 00000000..12fee8ad --- /dev/null +++ b/old_docs/API_docs_v109/constructors/topPeerCategoryForwardUsers.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryForwardUsers +description: Users to which the users often forwards messages to +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryForwardUsers +[Back to constructors index](index.md) + + + +Users to which the users often forwards messages to + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryForwardUsers = ['_' => 'topPeerCategoryForwardUsers']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryForwardUsers={_='topPeerCategoryForwardUsers'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/topPeerCategoryGroups.md b/old_docs/API_docs_v109/constructors/topPeerCategoryGroups.md new file mode 100644 index 00000000..48b57d8e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/topPeerCategoryGroups.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryGroups +description: Often-opened groups and supergroups +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryGroups +[Back to constructors index](index.md) + + + +Often-opened groups and supergroups + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryGroups = ['_' => 'topPeerCategoryGroups']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryGroups={_='topPeerCategoryGroups'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/topPeerCategoryPeers.md b/old_docs/API_docs_v109/constructors/topPeerCategoryPeers.md new file mode 100644 index 00000000..563329b4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/topPeerCategoryPeers.md @@ -0,0 +1,40 @@ +--- +title: topPeerCategoryPeers +description: Top peer category +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryPeers +[Back to constructors index](index.md) + + + +Top peer category + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|Top peer category of peers| +|count|[int](../types/int.md) | Yes|Count of peers| +|peers|Array of [TopPeer](../types/TopPeer.md) | Yes|Peers| + + + +### Type: [TopPeerCategoryPeers](../types/TopPeerCategoryPeers.md) + + +### Example: + +```php +$topPeerCategoryPeers = ['_' => 'topPeerCategoryPeers', 'category' => TopPeerCategory, 'count' => int, 'peers' => [TopPeer, TopPeer]]; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryPeers={_='topPeerCategoryPeers', category=TopPeerCategory, count=int, peers={TopPeer}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/topPeerCategoryPhoneCalls.md b/old_docs/API_docs_v109/constructors/topPeerCategoryPhoneCalls.md new file mode 100644 index 00000000..31550c88 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/topPeerCategoryPhoneCalls.md @@ -0,0 +1,33 @@ +--- +title: topPeerCategoryPhoneCalls +description: Most frequently called users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: topPeerCategoryPhoneCalls +[Back to constructors index](index.md) + + + +Most frequently called users + + + + +### Type: [TopPeerCategory](../types/TopPeerCategory.md) + + +### Example: + +```php +$topPeerCategoryPhoneCalls = ['_' => 'topPeerCategoryPhoneCalls']; +``` + + +Or, if you're into Lua: + +```lua +topPeerCategoryPhoneCalls={_='topPeerCategoryPhoneCalls'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/true.md b/old_docs/API_docs_v109/constructors/true.md new file mode 100644 index 00000000..d70fe1c5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/true.md @@ -0,0 +1,33 @@ +--- +title: true +description: See [predefined identifiers](https://core.telegram.org/mtproto/TL-formal#predefined-identifiers). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: true +[Back to constructors index](index.md) + + + +See [predefined identifiers](https://core.telegram.org/mtproto/TL-formal#predefined-identifiers). + + + + +### Type: [True](../types/True.md) + + +### Example: + +```php +$true = ['_' => 'true']; +``` + + +Or, if you're into Lua: + +```lua +true={_='true'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateBotCallbackQuery.md b/old_docs/API_docs_v109/constructors/updateBotCallbackQuery.md new file mode 100644 index 00000000..b04d5b78 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateBotCallbackQuery.md @@ -0,0 +1,44 @@ +--- +title: updateBotCallbackQuery +description: A callback button was pressed, and the button data was sent to the bot that created the button +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotCallbackQuery +[Back to constructors index](index.md) + + + +A callback button was pressed, and the button data was sent to the bot that created the button + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|user\_id|[int](../types/int.md) | Yes|ID of the user that pressed the button| +|peer|[Peer](../types/Peer.md) | Yes|Chat where the inline keyboard was sent| +|msg\_id|[int](../types/int.md) | Yes|Message ID| +|chat\_instance|[long](../types/long.md) | Yes|Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.| +|data|[bytes](../types/bytes.md) | Optional|Callback data| +|game\_short\_name|[string](../types/string.md) | Optional|Short name of a Game to be returned, serves as the unique identifier for the game| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotCallbackQuery = ['_' => 'updateBotCallbackQuery', 'query_id' => long, 'user_id' => int, 'peer' => Peer, 'msg_id' => int, 'chat_instance' => long, 'data' => 'bytes', 'game_short_name' => 'string']; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/updateBotInlineQuery.md b/old_docs/API_docs_v109/constructors/updateBotInlineQuery.md new file mode 100644 index 00000000..992d4ac2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateBotInlineQuery.md @@ -0,0 +1,42 @@ +--- +title: updateBotInlineQuery +description: An incoming inline query +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotInlineQuery +[Back to constructors index](index.md) + + + +An incoming inline query + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|user\_id|[int](../types/int.md) | Yes|User that sent the query| +|query|[string](../types/string.md) | Yes|Text of query| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Attached geolocation| +|offset|[string](../types/string.md) | Yes|Offset to navigate through results| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotInlineQuery = ['_' => 'updateBotInlineQuery', 'query_id' => long, 'user_id' => int, 'query' => 'string', 'geo' => GeoPoint, 'offset' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +updateBotInlineQuery={_='updateBotInlineQuery', query_id=long, user_id=int, query='string', geo=GeoPoint, offset='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateBotInlineSend.md b/old_docs/API_docs_v109/constructors/updateBotInlineSend.md new file mode 100644 index 00000000..7820faac --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateBotInlineSend.md @@ -0,0 +1,42 @@ +--- +title: updateBotInlineSend +description: The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the [feedback collecting](https://core.telegram.org/bots/inline#collecting-feedback) for details on how to enable these updates for your bot. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotInlineSend +[Back to constructors index](index.md) + + + +The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the [feedback collecting](https://core.telegram.org/bots/inline#collecting-feedback) for details on how to enable these updates for your bot. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|The user that chose the result| +|query|[string](../types/string.md) | Yes|The query that was used to obtain the result| +|geo|[GeoPoint](../types/GeoPoint.md) | Optional|Optional. Sender location, only for bots that require user location| +|id|[string](../types/string.md) | Yes|The unique identifier for the result that was chosen| +|msg\_id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Optional|Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotInlineSend = ['_' => 'updateBotInlineSend', 'user_id' => int, 'query' => 'string', 'geo' => GeoPoint, 'id' => 'string', 'msg_id' => InputBotInlineMessageID]; +``` + + +Or, if you're into Lua: + +```lua +updateBotInlineSend={_='updateBotInlineSend', user_id=int, query='string', geo=GeoPoint, id='string', msg_id=InputBotInlineMessageID} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateBotPrecheckoutQuery.md b/old_docs/API_docs_v109/constructors/updateBotPrecheckoutQuery.md new file mode 100644 index 00000000..b9383cfb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateBotPrecheckoutQuery.md @@ -0,0 +1,44 @@ +--- +title: updateBotPrecheckoutQuery +description: This object contains information about an incoming pre-checkout query. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotPrecheckoutQuery +[Back to constructors index](index.md) + + + +This object contains information about an incoming pre-checkout query. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Unique query identifier| +|user\_id|[int](../types/int.md) | Yes|User who sent the query| +|payload|[bytes](../types/bytes.md) | Yes|Bot specified invoice payload| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Optional|Order info provided by the user| +|shipping\_option\_id|[string](../types/string.md) | Optional|Identifier of the shipping option chosen by the user| +|currency|[string](../types/string.md) | Yes|Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code| +|total\_amount|[long](../types/long.md) | Yes|Total amount in the smallest units of the currency (integer, not float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the exp parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotPrecheckoutQuery = ['_' => 'updateBotPrecheckoutQuery', 'query_id' => long, 'user_id' => int, 'payload' => 'bytes', 'info' => PaymentRequestedInfo, 'shipping_option_id' => 'string', 'currency' => 'string', 'total_amount' => long]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/updateBotShippingQuery.md b/old_docs/API_docs_v109/constructors/updateBotShippingQuery.md new file mode 100644 index 00000000..0f0135cb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateBotShippingQuery.md @@ -0,0 +1,41 @@ +--- +title: updateBotShippingQuery +description: This object contains information about an incoming shipping query. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotShippingQuery +[Back to constructors index](index.md) + + + +This object contains information about an incoming shipping query. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Unique query identifier| +|user\_id|[int](../types/int.md) | Yes|User who sent the query| +|payload|[bytes](../types/bytes.md) | Yes|Bot specified invoice payload| +|shipping\_address|[PostAddress](../types/PostAddress.md) | Yes|User specified shipping address| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotShippingQuery = ['_' => 'updateBotShippingQuery', 'query_id' => long, 'user_id' => int, 'payload' => 'bytes', 'shipping_address' => PostAddress]; +``` + + +Or, if you're into Lua: + +```lua +updateBotShippingQuery={_='updateBotShippingQuery', query_id=long, user_id=int, payload='bytes', shipping_address=PostAddress} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateBotWebhookJSON.md b/old_docs/API_docs_v109/constructors/updateBotWebhookJSON.md new file mode 100644 index 00000000..c15930a4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateBotWebhookJSON.md @@ -0,0 +1,38 @@ +--- +title: updateBotWebhookJSON +description: A new incoming event; for bots only +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotWebhookJSON +[Back to constructors index](index.md) + + + +A new incoming event; for bots only + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|data|[DataJSON](../types/DataJSON.md) | Yes|The event| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotWebhookJSON = ['_' => 'updateBotWebhookJSON', 'data' => DataJSON]; +``` + + +Or, if you're into Lua: + +```lua +updateBotWebhookJSON={_='updateBotWebhookJSON', data=DataJSON} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateBotWebhookJSONQuery.md b/old_docs/API_docs_v109/constructors/updateBotWebhookJSONQuery.md new file mode 100644 index 00000000..21c527c1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateBotWebhookJSONQuery.md @@ -0,0 +1,40 @@ +--- +title: updateBotWebhookJSONQuery +description: A new incoming query; for bots only +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateBotWebhookJSONQuery +[Back to constructors index](index.md) + + + +A new incoming query; for bots only + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Query identifier| +|data|[DataJSON](../types/DataJSON.md) | Yes|Query data| +|timeout|[int](../types/int.md) | Yes|Query timeout| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateBotWebhookJSONQuery = ['_' => 'updateBotWebhookJSONQuery', 'query_id' => long, 'data' => DataJSON, 'timeout' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateBotWebhookJSONQuery={_='updateBotWebhookJSONQuery', query_id=long, data=DataJSON, timeout=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChannel.md b/old_docs/API_docs_v109/constructors/updateChannel.md new file mode 100644 index 00000000..e1760fa2 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChannel.md @@ -0,0 +1,38 @@ +--- +title: updateChannel +description: A new channel is available +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannel +[Back to constructors index](index.md) + + + +A new channel is available + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel ID| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannel = ['_' => 'updateChannel', 'channel_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChannel={_='updateChannel', channel_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChannelAvailableMessages.md b/old_docs/API_docs_v109/constructors/updateChannelAvailableMessages.md new file mode 100644 index 00000000..734afc76 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChannelAvailableMessages.md @@ -0,0 +1,39 @@ +--- +title: updateChannelAvailableMessages +description: The history of a [channel/supergroup](https://core.telegram.org/api/channel) was hidden. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelAvailableMessages +[Back to constructors index](index.md) + + + +The history of a [channel/supergroup](https://core.telegram.org/api/channel) was hidden. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel/supergroup ID| +|available\_min\_id|[int](../types/int.md) | Yes|Identifier of a maximum unavailable message in a channel due to hidden history.| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelAvailableMessages = ['_' => 'updateChannelAvailableMessages', 'channel_id' => int, 'available_min_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelAvailableMessages={_='updateChannelAvailableMessages', channel_id=int, available_min_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChannelMessageViews.md b/old_docs/API_docs_v109/constructors/updateChannelMessageViews.md new file mode 100644 index 00000000..2b3582b3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChannelMessageViews.md @@ -0,0 +1,40 @@ +--- +title: updateChannelMessageViews +description: The view counter of a message in a channel has changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelMessageViews +[Back to constructors index](index.md) + + + +The view counter of a message in a channel has changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel ID| +|id|[int](../types/int.md) | Yes|ID of the message| +|views|[int](../types/int.md) | Yes|New view counter| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelMessageViews = ['_' => 'updateChannelMessageViews', 'channel_id' => int, 'id' => int, 'views' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelMessageViews={_='updateChannelMessageViews', channel_id=int, id=int, views=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChannelPinnedMessage.md b/old_docs/API_docs_v109/constructors/updateChannelPinnedMessage.md new file mode 100644 index 00000000..51ec6752 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChannelPinnedMessage.md @@ -0,0 +1,39 @@ +--- +title: updateChannelPinnedMessage +description: A message was pinned in a [channel/supergroup](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelPinnedMessage +[Back to constructors index](index.md) + + + +A message was pinned in a [channel/supergroup](https://core.telegram.org/api/channel). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel/supergroup ID| +|id|[int](../types/int.md) | Yes|ID of pinned message| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelPinnedMessage = ['_' => 'updateChannelPinnedMessage', 'channel_id' => int, 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelPinnedMessage={_='updateChannelPinnedMessage', channel_id=int, id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChannelReadMessagesContents.md b/old_docs/API_docs_v109/constructors/updateChannelReadMessagesContents.md new file mode 100644 index 00000000..9140db08 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChannelReadMessagesContents.md @@ -0,0 +1,39 @@ +--- +title: updateChannelReadMessagesContents +description: The specified [channel/supergroup](https://core.telegram.org/api/channel) messages were read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelReadMessagesContents +[Back to constructors index](index.md) + + + +The specified [channel/supergroup](https://core.telegram.org/api/channel) messages were read + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|[Channel/supergroup](https://core.telegram.org/api/channel) ID| +|messages|Array of [int](../types/int.md) | Yes|Messages| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelReadMessagesContents = ['_' => 'updateChannelReadMessagesContents', 'channel_id' => int, 'messages' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelReadMessagesContents={_='updateChannelReadMessagesContents', channel_id=int, messages={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChannelTooLong.md b/old_docs/API_docs_v109/constructors/updateChannelTooLong.md new file mode 100644 index 00000000..97bd3ff5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChannelTooLong.md @@ -0,0 +1,39 @@ +--- +title: updateChannelTooLong +description: There are new updates in the specified channel, the client must fetch them, eventually starting the specified pts if the difference is too long or if the channel isn't currently in the states. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelTooLong +[Back to constructors index](index.md) + + + +There are new updates in the specified channel, the client must fetch them, eventually starting the specified pts if the difference is too long or if the channel isn't currently in the states. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|The channel| +|pts|[int](../types/int.md) | Optional|The [PTS](https://core.telegram.org/api/updates).| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelTooLong = ['_' => 'updateChannelTooLong', 'channel_id' => int, 'pts' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelTooLong={_='updateChannelTooLong', channel_id=int, pts=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChannelWebPage.md b/old_docs/API_docs_v109/constructors/updateChannelWebPage.md new file mode 100644 index 00000000..85c3e8a1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChannelWebPage.md @@ -0,0 +1,41 @@ +--- +title: updateChannelWebPage +description: A webpage preview of a link in a [channel/supergroup](https://core.telegram.org/api/channel) message was generated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChannelWebPage +[Back to constructors index](index.md) + + + +A webpage preview of a link in a [channel/supergroup](https://core.telegram.org/api/channel) message was generated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|[Channel/supergroup](https://core.telegram.org/api/channel) ID| +|webpage|[WebPage](../types/WebPage.md) | Optional|Generated webpage preview| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChannelWebPage = ['_' => 'updateChannelWebPage', 'channel_id' => int, 'webpage' => WebPage, 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChannelWebPage={_='updateChannelWebPage', channel_id=int, webpage=WebPage, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChatDefaultBannedRights.md b/old_docs/API_docs_v109/constructors/updateChatDefaultBannedRights.md new file mode 100644 index 00000000..8db59e41 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChatDefaultBannedRights.md @@ -0,0 +1,40 @@ +--- +title: updateChatDefaultBannedRights +description: Default banned rights in a [normal chat](https://core.telegram.org/api/channel) were updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatDefaultBannedRights +[Back to constructors index](index.md) + + + +Default banned rights in a [normal chat](https://core.telegram.org/api/channel) were updated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|The chat| +|default\_banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | Yes|New default banned rights| +|version|[int](../types/int.md) | Yes|Version| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChatDefaultBannedRights = ['_' => 'updateChatDefaultBannedRights', 'peer' => Peer, 'default_banned_rights' => ChatBannedRights, 'version' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChatDefaultBannedRights={_='updateChatDefaultBannedRights', peer=Peer, default_banned_rights=ChatBannedRights, version=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChatParticipantAdd.md b/old_docs/API_docs_v109/constructors/updateChatParticipantAdd.md new file mode 100644 index 00000000..baaef950 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChatParticipantAdd.md @@ -0,0 +1,42 @@ +--- +title: updateChatParticipantAdd +description: New group member. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatParticipantAdd +[Back to constructors index](index.md) + + + +New group member. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|Group ID| +|user\_id|[int](../types/int.md) | Yes|ID of the new member| +|inviter\_id|[int](../types/int.md) | Yes|ID of the user, who added member to the group| +|date|[int](../types/int.md) | Yes|When was the participant added| +|version|[int](../types/int.md) | Yes|Chat version number| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChatParticipantAdd = ['_' => 'updateChatParticipantAdd', 'chat_id' => int, 'user_id' => int, 'inviter_id' => int, 'date' => int, 'version' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChatParticipantAdd={_='updateChatParticipantAdd', chat_id=int, user_id=int, inviter_id=int, date=int, version=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChatParticipantAdmin.md b/old_docs/API_docs_v109/constructors/updateChatParticipantAdmin.md new file mode 100644 index 00000000..7cb7e703 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChatParticipantAdmin.md @@ -0,0 +1,41 @@ +--- +title: updateChatParticipantAdmin +description: Admin permissions of a user in a [legacy group](https://core.telegram.org/api/channel) were changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatParticipantAdmin +[Back to constructors index](index.md) + + + +Admin permissions of a user in a [legacy group](https://core.telegram.org/api/channel) were changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|Chat ID| +|user\_id|[int](../types/int.md) | Yes|ID of the (de)admined user| +|is\_admin|[Bool](../types/Bool.md) | Yes|Whether the user was rendered admin| +|version|[int](../types/int.md) | Yes|Used in basic groups to reorder updates and make sure that all of them was received.| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChatParticipantAdmin = ['_' => 'updateChatParticipantAdmin', 'chat_id' => int, 'user_id' => int, 'is_admin' => Bool, 'version' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChatParticipantAdmin={_='updateChatParticipantAdmin', chat_id=int, user_id=int, is_admin=Bool, version=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChatParticipantDelete.md b/old_docs/API_docs_v109/constructors/updateChatParticipantDelete.md new file mode 100644 index 00000000..31872336 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChatParticipantDelete.md @@ -0,0 +1,40 @@ +--- +title: updateChatParticipantDelete +description: A member has left the group. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatParticipantDelete +[Back to constructors index](index.md) + + + +A member has left the group. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|Group ID| +|user\_id|[int](../types/int.md) | Yes|ID of the user| +|version|[int](../types/int.md) | Yes|Used in basic groups to reorder updates and make sure that all of them was received.| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChatParticipantDelete = ['_' => 'updateChatParticipantDelete', 'chat_id' => int, 'user_id' => int, 'version' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChatParticipantDelete={_='updateChatParticipantDelete', chat_id=int, user_id=int, version=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChatParticipants.md b/old_docs/API_docs_v109/constructors/updateChatParticipants.md new file mode 100644 index 00000000..7a2b0bee --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChatParticipants.md @@ -0,0 +1,38 @@ +--- +title: updateChatParticipants +description: Composition of chat participants changed. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatParticipants +[Back to constructors index](index.md) + + + +Composition of chat participants changed. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|participants|[ChatParticipants](../types/ChatParticipants.md) | Yes|Updated chat participants| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChatParticipants = ['_' => 'updateChatParticipants', 'participants' => ChatParticipants]; +``` + + +Or, if you're into Lua: + +```lua +updateChatParticipants={_='updateChatParticipants', participants=ChatParticipants} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChatPinnedMessage.md b/old_docs/API_docs_v109/constructors/updateChatPinnedMessage.md new file mode 100644 index 00000000..1f3c75c5 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChatPinnedMessage.md @@ -0,0 +1,40 @@ +--- +title: updateChatPinnedMessage +description: A message was pinned in a [legacy group](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatPinnedMessage +[Back to constructors index](index.md) + + + +A message was pinned in a [legacy group](https://core.telegram.org/api/channel) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|[Legacy group](https://core.telegram.org/api/channel) ID| +|id|[int](../types/int.md) | Yes|ID of pinned message| +|version|[int](../types/int.md) | Yes|Used to reorder updates in legacy groups| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChatPinnedMessage = ['_' => 'updateChatPinnedMessage', 'chat_id' => int, 'id' => int, 'version' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateChatPinnedMessage={_='updateChatPinnedMessage', chat_id=int, id=int, version=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateChatUserTyping.md b/old_docs/API_docs_v109/constructors/updateChatUserTyping.md new file mode 100644 index 00000000..f9c02485 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateChatUserTyping.md @@ -0,0 +1,40 @@ +--- +title: updateChatUserTyping +description: The user is preparing a message in a group; typing, recording, uploading, etc. This update is valid for 6 seconds. If no repeated update received after 6 seconds, it should be considered that the user stopped doing whatever he's been doing. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateChatUserTyping +[Back to constructors index](index.md) + + + +The user is preparing a message in a group; typing, recording, uploading, etc. This update is valid for 6 seconds. If no repeated update received after 6 seconds, it should be considered that the user stopped doing whatever he's been doing. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|Group id| +|user\_id|[int](../types/int.md) | Yes|User id| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Type of action
Parameter added in [Layer 17](https://core.telegram.org/api/layers#layer-17).| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateChatUserTyping = ['_' => 'updateChatUserTyping', 'chat_id' => int, 'user_id' => int, 'action' => SendMessageAction]; +``` + + +Or, if you're into Lua: + +```lua +updateChatUserTyping={_='updateChatUserTyping', chat_id=int, user_id=int, action=SendMessageAction} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateConfig.md b/old_docs/API_docs_v109/constructors/updateConfig.md new file mode 100644 index 00000000..6eb898ce --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateConfig.md @@ -0,0 +1,33 @@ +--- +title: updateConfig +description: The server-side configuration has changed; the client should re-fetch the config using [help.getConfig](../methods/help.getConfig.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateConfig +[Back to constructors index](index.md) + + + +The server-side configuration has changed; the client should re-fetch the config using [help.getConfig](../methods/help.getConfig.md) + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateConfig = ['_' => 'updateConfig']; +``` + + +Or, if you're into Lua: + +```lua +updateConfig={_='updateConfig'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateContactsReset.md b/old_docs/API_docs_v109/constructors/updateContactsReset.md new file mode 100644 index 00000000..85725d76 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateContactsReset.md @@ -0,0 +1,33 @@ +--- +title: updateContactsReset +description: All contacts were deleted +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateContactsReset +[Back to constructors index](index.md) + + + +All contacts were deleted + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateContactsReset = ['_' => 'updateContactsReset']; +``` + + +Or, if you're into Lua: + +```lua +updateContactsReset={_='updateContactsReset'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateDcOptions.md b/old_docs/API_docs_v109/constructors/updateDcOptions.md new file mode 100644 index 00000000..9b674835 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateDcOptions.md @@ -0,0 +1,38 @@ +--- +title: updateDcOptions +description: Changes in the data center configuration options. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDcOptions +[Back to constructors index](index.md) + + + +Changes in the data center configuration options. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dc\_options|Array of [DcOption](../types/DcOption.md) | Yes|DC options| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDcOptions = ['_' => 'updateDcOptions', 'dc_options' => [DcOption, DcOption]]; +``` + + +Or, if you're into Lua: + +```lua +updateDcOptions={_='updateDcOptions', dc_options={DcOption}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateDeleteChannelMessages.md b/old_docs/API_docs_v109/constructors/updateDeleteChannelMessages.md new file mode 100644 index 00000000..67f6e710 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateDeleteChannelMessages.md @@ -0,0 +1,41 @@ +--- +title: updateDeleteChannelMessages +description: Some messages in a [supergroup/channel](https://core.telegram.org/api/channel) were deleted +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDeleteChannelMessages +[Back to constructors index](index.md) + + + +Some messages in a [supergroup/channel](https://core.telegram.org/api/channel) were deleted + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel ID| +|messages|Array of [int](../types/int.md) | Yes|Messages| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDeleteChannelMessages = ['_' => 'updateDeleteChannelMessages', 'channel_id' => int, 'messages' => [int, int], 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateDeleteChannelMessages={_='updateDeleteChannelMessages', channel_id=int, messages={int}, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateDeleteMessages.md b/old_docs/API_docs_v109/constructors/updateDeleteMessages.md new file mode 100644 index 00000000..85228d30 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateDeleteMessages.md @@ -0,0 +1,40 @@ +--- +title: updateDeleteMessages +description: Messages were deleted. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDeleteMessages +[Back to constructors index](index.md) + + + +Messages were deleted. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|messages|Array of [int](../types/int.md) | Yes|Messages| +|pts|[int](../types/int.md) | Yes|New quality of actions in a message box| +|pts\_count|[int](../types/int.md) | Yes|Number of generated [events](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDeleteMessages = ['_' => 'updateDeleteMessages', 'messages' => [int, int], 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateDeleteMessages={_='updateDeleteMessages', messages={int}, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateDeleteScheduledMessages.md b/old_docs/API_docs_v109/constructors/updateDeleteScheduledMessages.md new file mode 100644 index 00000000..e866cb33 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateDeleteScheduledMessages.md @@ -0,0 +1,39 @@ +--- +title: updateDeleteScheduledMessages +description: Some scheduled messages were deleted +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDeleteScheduledMessages +[Back to constructors index](index.md) + + + +Some scheduled messages were deleted + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|Peer| +|messages|Array of [int](../types/int.md) | Yes|Messages| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDeleteScheduledMessages = ['_' => 'updateDeleteScheduledMessages', 'peer' => Peer, 'messages' => [int, int]]; +``` + + +Or, if you're into Lua: + +```lua +updateDeleteScheduledMessages={_='updateDeleteScheduledMessages', peer=Peer, messages={int}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateDialogPinned.md b/old_docs/API_docs_v109/constructors/updateDialogPinned.md new file mode 100644 index 00000000..fe2d09ec --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateDialogPinned.md @@ -0,0 +1,40 @@ +--- +title: updateDialogPinned +description: A dialog was pinned/unpinned +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDialogPinned +[Back to constructors index](index.md) + + + +A dialog was pinned/unpinned + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[Bool](../types/Bool.md) | Optional|Whether the dialog was pinned| +|folder\_id|[int](../types/int.md) | Optional|If the dialog is in a folder, the folder ID| +|peer|[DialogPeer](../types/DialogPeer.md) | Yes|The dialog| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDialogPinned = ['_' => 'updateDialogPinned', 'pinned' => Bool, 'folder_id' => int, 'peer' => DialogPeer]; +``` + + +Or, if you're into Lua: + +```lua +updateDialogPinned={_='updateDialogPinned', pinned=Bool, folder_id=int, peer=DialogPeer} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateDialogUnreadMark.md b/old_docs/API_docs_v109/constructors/updateDialogUnreadMark.md new file mode 100644 index 00000000..49d853a9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateDialogUnreadMark.md @@ -0,0 +1,39 @@ +--- +title: updateDialogUnreadMark +description: The manual unread mark of a chat was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDialogUnreadMark +[Back to constructors index](index.md) + + + +The manual unread mark of a chat was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|unread|[Bool](../types/Bool.md) | Optional|Was the chat marked or unmarked as read| +|peer|[DialogPeer](../types/DialogPeer.md) | Yes|The dialog| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDialogUnreadMark = ['_' => 'updateDialogUnreadMark', 'unread' => Bool, 'peer' => DialogPeer]; +``` + + +Or, if you're into Lua: + +```lua +updateDialogUnreadMark={_='updateDialogUnreadMark', unread=Bool, peer=DialogPeer} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateDraftMessage.md b/old_docs/API_docs_v109/constructors/updateDraftMessage.md new file mode 100644 index 00000000..634308e0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateDraftMessage.md @@ -0,0 +1,39 @@ +--- +title: updateDraftMessage +description: Notifies a change of a message [draft](https://core.telegram.org/api/drafts). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateDraftMessage +[Back to constructors index](index.md) + + + +Notifies a change of a message [draft](https://core.telegram.org/api/drafts). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|The peer to which the draft is associated| +|draft|[DraftMessage](../types/DraftMessage.md) | Optional|The draft| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateDraftMessage = ['_' => 'updateDraftMessage', 'peer' => Peer, 'draft' => DraftMessage]; +``` + + +Or, if you're into Lua: + +```lua +updateDraftMessage={_='updateDraftMessage', peer=Peer, draft=DraftMessage} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateEditChannelMessage.md b/old_docs/API_docs_v109/constructors/updateEditChannelMessage.md new file mode 100644 index 00000000..7ac46407 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateEditChannelMessage.md @@ -0,0 +1,40 @@ +--- +title: updateEditChannelMessage +description: A message was edited in a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEditChannelMessage +[Back to constructors index](index.md) + + + +A message was edited in a [channel/supergroup](https://core.telegram.org/api/channel) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|The new message| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateEditChannelMessage = ['_' => 'updateEditChannelMessage', 'message' => Message, 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateEditChannelMessage={_='updateEditChannelMessage', message=Message, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateEditMessage.md b/old_docs/API_docs_v109/constructors/updateEditMessage.md new file mode 100644 index 00000000..927cb798 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateEditMessage.md @@ -0,0 +1,40 @@ +--- +title: updateEditMessage +description: A message was edited +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEditMessage +[Back to constructors index](index.md) + + + +A message was edited + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|The new edited message| +|pts|[int](../types/int.md) | Yes|[PTS](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[PTS count](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateEditMessage = ['_' => 'updateEditMessage', 'message' => Message, 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateEditMessage={_='updateEditMessage', message=Message, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateEncryptedChatTyping.md b/old_docs/API_docs_v109/constructors/updateEncryptedChatTyping.md new file mode 100644 index 00000000..9694504f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateEncryptedChatTyping.md @@ -0,0 +1,38 @@ +--- +title: updateEncryptedChatTyping +description: Interlocutor is typing a message in an encrypted chat. Update period is 6 second. If upon this time there is no repeated update, it shall be considered that the interlocutor stopped typing. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEncryptedChatTyping +[Back to constructors index](index.md) + + + +Interlocutor is typing a message in an encrypted chat. Update period is 6 second. If upon this time there is no repeated update, it shall be considered that the interlocutor stopped typing. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|Chat ID| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateEncryptedChatTyping = ['_' => 'updateEncryptedChatTyping', 'chat_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateEncryptedChatTyping={_='updateEncryptedChatTyping', chat_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateEncryptedMessagesRead.md b/old_docs/API_docs_v109/constructors/updateEncryptedMessagesRead.md new file mode 100644 index 00000000..097ab8fc --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateEncryptedMessagesRead.md @@ -0,0 +1,40 @@ +--- +title: updateEncryptedMessagesRead +description: Communication history in an encrypted chat was marked as read. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEncryptedMessagesRead +[Back to constructors index](index.md) + + + +Communication history in an encrypted chat was marked as read. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[int](../types/int.md) | Yes|Chat ID| +|max\_date|[int](../types/int.md) | Yes|Maximum value of data for read messages| +|date|[int](../types/int.md) | Yes|Time when messages were read| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateEncryptedMessagesRead = ['_' => 'updateEncryptedMessagesRead', 'chat_id' => int, 'max_date' => int, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateEncryptedMessagesRead={_='updateEncryptedMessagesRead', chat_id=int, max_date=int, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateEncryption.md b/old_docs/API_docs_v109/constructors/updateEncryption.md new file mode 100644 index 00000000..0c655854 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateEncryption.md @@ -0,0 +1,39 @@ +--- +title: updateEncryption +description: Change of state in an encrypted chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateEncryption +[Back to constructors index](index.md) + + + +Change of state in an encrypted chat. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat|[EncryptedChat](../types/EncryptedChat.md) | Optional|Encrypted chat| +|date|[int](../types/int.md) | Yes|Date of change| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateEncryption = ['_' => 'updateEncryption', 'chat' => EncryptedChat, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateEncryption={_='updateEncryption', chat=EncryptedChat, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateFavedStickers.md b/old_docs/API_docs_v109/constructors/updateFavedStickers.md new file mode 100644 index 00000000..27b1ca7e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateFavedStickers.md @@ -0,0 +1,33 @@ +--- +title: updateFavedStickers +description: The list of favorited stickers was changed, the client should call [messages.getFavedStickers](../methods/messages.getFavedStickers.md) to refetch the new list +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateFavedStickers +[Back to constructors index](index.md) + + + +The list of favorited stickers was changed, the client should call [messages.getFavedStickers](../methods/messages.getFavedStickers.md) to refetch the new list + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateFavedStickers = ['_' => 'updateFavedStickers']; +``` + + +Or, if you're into Lua: + +```lua +updateFavedStickers={_='updateFavedStickers'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateFolderPeers.md b/old_docs/API_docs_v109/constructors/updateFolderPeers.md new file mode 100644 index 00000000..204e32de --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateFolderPeers.md @@ -0,0 +1,40 @@ +--- +title: updateFolderPeers +description: The dialog list of a folder was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateFolderPeers +[Back to constructors index](index.md) + + + +The dialog list of a folder was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|folder\_peers|Array of [FolderPeer](../types/FolderPeer.md) | Yes|New folder peers| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateFolderPeers = ['_' => 'updateFolderPeers', 'folder_peers' => [FolderPeer, FolderPeer], 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateFolderPeers={_='updateFolderPeers', folder_peers={FolderPeer}, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateGeoLiveViewed.md b/old_docs/API_docs_v109/constructors/updateGeoLiveViewed.md new file mode 100644 index 00000000..8512ada0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateGeoLiveViewed.md @@ -0,0 +1,37 @@ +--- +title: updateGeoLiveViewed +description: updateGeoLiveViewed attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateGeoLiveViewed +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Peer](../types/Peer.md) | Yes| +|msg\_id|[int](../types/int.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateGeoLiveViewed = ['_' => 'updateGeoLiveViewed', 'peer' => Peer, 'msg_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateGeoLiveViewed={_='updateGeoLiveViewed', peer=Peer, msg_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateInlineBotCallbackQuery.md b/old_docs/API_docs_v109/constructors/updateInlineBotCallbackQuery.md new file mode 100644 index 00000000..29393715 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateInlineBotCallbackQuery.md @@ -0,0 +1,43 @@ +--- +title: updateInlineBotCallbackQuery +description: This notification is received by bots when a button is pressed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateInlineBotCallbackQuery +[Back to constructors index](index.md) + + + +This notification is received by bots when a button is pressed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[long](../types/long.md) | Yes|Query ID| +|user\_id|[int](../types/int.md) | Yes|ID of the user that pressed the button| +|msg\_id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|ID of the inline message with the button| +|chat\_instance|[long](../types/long.md) | Yes|Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.| +|data|[bytes](../types/bytes.md) | Optional|Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field.| +|game\_short\_name|[string](../types/string.md) | Optional|Short name of a Game to be returned, serves as the unique identifier for the game| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateInlineBotCallbackQuery = ['_' => 'updateInlineBotCallbackQuery', 'query_id' => long, 'user_id' => int, 'msg_id' => InputBotInlineMessageID, 'chat_instance' => long, 'data' => 'bytes', 'game_short_name' => 'string']; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/updateLangPack.md b/old_docs/API_docs_v109/constructors/updateLangPack.md new file mode 100644 index 00000000..7d49b1c7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateLangPack.md @@ -0,0 +1,38 @@ +--- +title: updateLangPack +description: Language pack updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateLangPack +[Back to constructors index](index.md) + + + +Language pack updated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|difference|[LangPackDifference](../types/LangPackDifference.md) | Yes|Changed strings| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateLangPack = ['_' => 'updateLangPack', 'difference' => LangPackDifference]; +``` + + +Or, if you're into Lua: + +```lua +updateLangPack={_='updateLangPack', difference=LangPackDifference} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateLangPackTooLong.md b/old_docs/API_docs_v109/constructors/updateLangPackTooLong.md new file mode 100644 index 00000000..89888256 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateLangPackTooLong.md @@ -0,0 +1,38 @@ +--- +title: updateLangPackTooLong +description: A language pack has changed, the client should manually fetch the changed strings using [langpack.getDifference](../methods/langpack.getDifference.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateLangPackTooLong +[Back to constructors index](index.md) + + + +A language pack has changed, the client should manually fetch the changed strings using [langpack.getDifference](../methods/langpack.getDifference.md) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[string](../types/string.md) | Yes|Language code| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateLangPackTooLong = ['_' => 'updateLangPackTooLong', 'lang_code' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +updateLangPackTooLong={_='updateLangPackTooLong', lang_code='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateLoginToken.md b/old_docs/API_docs_v109/constructors/updateLoginToken.md new file mode 100644 index 00000000..330ba09a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateLoginToken.md @@ -0,0 +1,31 @@ +--- +title: updateLoginToken +description: updateLoginToken attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateLoginToken +[Back to constructors index](index.md) + + + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateLoginToken = ['_' => 'updateLoginToken']; +``` + + +Or, if you're into Lua: + +```lua +updateLoginToken={_='updateLoginToken'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateMessageID.md b/old_docs/API_docs_v109/constructors/updateMessageID.md new file mode 100644 index 00000000..1215f4fe --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateMessageID.md @@ -0,0 +1,38 @@ +--- +title: updateMessageID +description: Sent message with **random\_id** client identifier was assigned an identifier. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateMessageID +[Back to constructors index](index.md) + + + +Sent message with **random\_id** client identifier was assigned an identifier. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|**id** identifier of a respective [Message](../types/Message.md)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateMessageID = ['_' => 'updateMessageID', 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateMessageID={_='updateMessageID', id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateMessagePoll.md b/old_docs/API_docs_v109/constructors/updateMessagePoll.md new file mode 100644 index 00000000..747ad548 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateMessagePoll.md @@ -0,0 +1,40 @@ +--- +title: updateMessagePoll +description: The results of a poll have changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateMessagePoll +[Back to constructors index](index.md) + + + +The results of a poll have changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|poll\_id|[long](../types/long.md) | Yes|Poll ID| +|poll|[Poll](../types/Poll.md) | Optional|If the server knows the client hasn't cached this poll yet, the poll itself| +|results|[PollResults](../types/PollResults.md) | Yes|New poll results| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateMessagePoll = ['_' => 'updateMessagePoll', 'poll_id' => long, 'poll' => Poll, 'results' => PollResults]; +``` + + +Or, if you're into Lua: + +```lua +updateMessagePoll={_='updateMessagePoll', poll_id=long, poll=Poll, results=PollResults} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateMessagePollVote.md b/old_docs/API_docs_v109/constructors/updateMessagePollVote.md new file mode 100644 index 00000000..da3e6d3b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateMessagePollVote.md @@ -0,0 +1,38 @@ +--- +title: updateMessagePollVote +description: updateMessagePollVote attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateMessagePollVote +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|poll\_id|[long](../types/long.md) | Yes| +|user\_id|[int](../types/int.md) | Yes| +|options|Array of [bytes](../types/bytes.md) | Yes| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateMessagePollVote = ['_' => 'updateMessagePollVote', 'poll_id' => long, 'user_id' => int, 'options' => ['bytes', 'bytes']]; +``` + + +Or, if you're into Lua: + +```lua +updateMessagePollVote={_='updateMessagePollVote', poll_id=long, user_id=int, options={'bytes'}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateNewChannelMessage.md b/old_docs/API_docs_v109/constructors/updateNewChannelMessage.md new file mode 100644 index 00000000..6c754142 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateNewChannelMessage.md @@ -0,0 +1,40 @@ +--- +title: updateNewChannelMessage +description: A new message was sent in a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNewChannelMessage +[Back to constructors index](index.md) + + + +A new message was sent in a [channel/supergroup](https://core.telegram.org/api/channel) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|New message| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateNewChannelMessage = ['_' => 'updateNewChannelMessage', 'message' => Message, 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateNewChannelMessage={_='updateNewChannelMessage', message=Message, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateNewEncryptedMessage.md b/old_docs/API_docs_v109/constructors/updateNewEncryptedMessage.md new file mode 100644 index 00000000..ab77ed94 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateNewEncryptedMessage.md @@ -0,0 +1,39 @@ +--- +title: updateNewEncryptedMessage +description: New encrypted message. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNewEncryptedMessage +[Back to constructors index](index.md) + + + +New encrypted message. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[EncryptedMessage](../types/EncryptedMessage.md) | Yes|Message| +|qts|[int](../types/int.md) | Yes|New **qts** value| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateNewEncryptedMessage = ['_' => 'updateNewEncryptedMessage', 'message' => EncryptedMessage, 'qts' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateNewEncryptedMessage={_='updateNewEncryptedMessage', message=EncryptedMessage, qts=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateNewMessage.md b/old_docs/API_docs_v109/constructors/updateNewMessage.md new file mode 100644 index 00000000..571e660a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateNewMessage.md @@ -0,0 +1,40 @@ +--- +title: updateNewMessage +description: New message. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNewMessage +[Back to constructors index](index.md) + + + +New message. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|Message| +|pts|[int](../types/int.md) | Yes|New quantity of actions in a message box| +|pts\_count|[int](../types/int.md) | Yes|Number of generated events| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateNewMessage = ['_' => 'updateNewMessage', 'message' => Message, 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateNewMessage={_='updateNewMessage', message=Message, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateNewScheduledMessage.md b/old_docs/API_docs_v109/constructors/updateNewScheduledMessage.md new file mode 100644 index 00000000..feecd600 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateNewScheduledMessage.md @@ -0,0 +1,38 @@ +--- +title: updateNewScheduledMessage +description: New incoming scheduled message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNewScheduledMessage +[Back to constructors index](index.md) + + + +New incoming scheduled message + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[Message](../types/Message.md) | Optional|Message| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateNewScheduledMessage = ['_' => 'updateNewScheduledMessage', 'message' => Message]; +``` + + +Or, if you're into Lua: + +```lua +updateNewScheduledMessage={_='updateNewScheduledMessage', message=Message} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateNewStickerSet.md b/old_docs/API_docs_v109/constructors/updateNewStickerSet.md new file mode 100644 index 00000000..c32c41ff --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateNewStickerSet.md @@ -0,0 +1,38 @@ +--- +title: updateNewStickerSet +description: A new stickerset was installed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNewStickerSet +[Back to constructors index](index.md) + + + +A new stickerset was installed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[messages.StickerSet](../constructors/messages.StickerSet.md) | Yes|The installed stickerset| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateNewStickerSet = ['_' => 'updateNewStickerSet', 'stickerset' => messages.StickerSet]; +``` + + +Or, if you're into Lua: + +```lua +updateNewStickerSet={_='updateNewStickerSet', stickerset=messages.StickerSet} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateNotifySettings.md b/old_docs/API_docs_v109/constructors/updateNotifySettings.md new file mode 100644 index 00000000..b28cc1c4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateNotifySettings.md @@ -0,0 +1,39 @@ +--- +title: updateNotifySettings +description: Changes in notification settings. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateNotifySettings +[Back to constructors index](index.md) + + + +Changes in notification settings. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[NotifyPeer](../types/NotifyPeer.md) | Yes|Nofication source| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|New notification settings| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateNotifySettings = ['_' => 'updateNotifySettings', 'peer' => NotifyPeer, 'notify_settings' => PeerNotifySettings]; +``` + + +Or, if you're into Lua: + +```lua +updateNotifySettings={_='updateNotifySettings', peer=NotifyPeer, notify_settings=PeerNotifySettings} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updatePeerLocated.md b/old_docs/API_docs_v109/constructors/updatePeerLocated.md new file mode 100644 index 00000000..1451eb55 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updatePeerLocated.md @@ -0,0 +1,38 @@ +--- +title: updatePeerLocated +description: List of peers near you was updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePeerLocated +[Back to constructors index](index.md) + + + +List of peers near you was updated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [PeerLocated](../types/PeerLocated.md) | Yes|Peers| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePeerLocated = ['_' => 'updatePeerLocated', 'peers' => [PeerLocated, PeerLocated]]; +``` + + +Or, if you're into Lua: + +```lua +updatePeerLocated={_='updatePeerLocated', peers={PeerLocated}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updatePeerSettings.md b/old_docs/API_docs_v109/constructors/updatePeerSettings.md new file mode 100644 index 00000000..ce0641f1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updatePeerSettings.md @@ -0,0 +1,39 @@ +--- +title: updatePeerSettings +description: Settings of a certain peer have changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePeerSettings +[Back to constructors index](index.md) + + + +Settings of a certain peer have changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|The peer| +|settings|[PeerSettings](../types/PeerSettings.md) | Yes|Associated peer settings| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePeerSettings = ['_' => 'updatePeerSettings', 'peer' => Peer, 'settings' => PeerSettings]; +``` + + +Or, if you're into Lua: + +```lua +updatePeerSettings={_='updatePeerSettings', peer=Peer, settings=PeerSettings} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updatePhoneCall.md b/old_docs/API_docs_v109/constructors/updatePhoneCall.md new file mode 100644 index 00000000..af896d0d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updatePhoneCall.md @@ -0,0 +1,38 @@ +--- +title: updatePhoneCall +description: An incoming phone call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePhoneCall +[Back to constructors index](index.md) + + + +An incoming phone call + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|phone\_call|[PhoneCall](../types/PhoneCall.md) | Optional|Phone call| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePhoneCall = ['_' => 'updatePhoneCall', 'phone_call' => PhoneCall]; +``` + + +Or, if you're into Lua: + +```lua +updatePhoneCall={_='updatePhoneCall', phone_call=PhoneCall} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updatePinnedDialogs.md b/old_docs/API_docs_v109/constructors/updatePinnedDialogs.md new file mode 100644 index 00000000..c3b35737 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updatePinnedDialogs.md @@ -0,0 +1,39 @@ +--- +title: updatePinnedDialogs +description: Pinned dialogs were updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePinnedDialogs +[Back to constructors index](index.md) + + + +Pinned dialogs were updated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|folder\_id|[int](../types/int.md) | Optional|If the dialogs are in a folder, the folder ID| +|order|Array of [DialogPeer](../types/DialogPeer.md) | Optional|Order| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePinnedDialogs = ['_' => 'updatePinnedDialogs', 'folder_id' => int, 'order' => [DialogPeer, DialogPeer]]; +``` + + +Or, if you're into Lua: + +```lua +updatePinnedDialogs={_='updatePinnedDialogs', folder_id=int, order={DialogPeer}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updatePrivacy.md b/old_docs/API_docs_v109/constructors/updatePrivacy.md new file mode 100644 index 00000000..521b9735 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updatePrivacy.md @@ -0,0 +1,39 @@ +--- +title: updatePrivacy +description: Privacy rules were changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePrivacy +[Back to constructors index](index.md) + + + +Privacy rules were changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|key|[PrivacyKey](../types/PrivacyKey.md) | Yes|Peers to which the privacy rules apply| +|rules|Array of [PrivacyRule](../types/PrivacyRule.md) | Yes|Rules| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePrivacy = ['_' => 'updatePrivacy', 'key' => PrivacyKey, 'rules' => [PrivacyRule, PrivacyRule]]; +``` + + +Or, if you're into Lua: + +```lua +updatePrivacy={_='updatePrivacy', key=PrivacyKey, rules={PrivacyRule}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updatePtsChanged.md b/old_docs/API_docs_v109/constructors/updatePtsChanged.md new file mode 100644 index 00000000..a240eb83 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updatePtsChanged.md @@ -0,0 +1,33 @@ +--- +title: updatePtsChanged +description: [Common message box sequence PTS](https://core.telegram.org/api/updates) has changed, [state has to be refetched using updates.getState](https://core.telegram.org/api/updates#fetching-state) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatePtsChanged +[Back to constructors index](index.md) + + + +[Common message box sequence PTS](https://core.telegram.org/api/updates) has changed, [state has to be refetched using updates.getState](https://core.telegram.org/api/updates#fetching-state) + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updatePtsChanged = ['_' => 'updatePtsChanged']; +``` + + +Or, if you're into Lua: + +```lua +updatePtsChanged={_='updatePtsChanged'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateReadChannelInbox.md b/old_docs/API_docs_v109/constructors/updateReadChannelInbox.md new file mode 100644 index 00000000..3ed7fe0c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateReadChannelInbox.md @@ -0,0 +1,42 @@ +--- +title: updateReadChannelInbox +description: Incoming messages in a [channel/supergroup](https://core.telegram.org/api/channel) were read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadChannelInbox +[Back to constructors index](index.md) + + + +Incoming messages in a [channel/supergroup](https://core.telegram.org/api/channel) were read + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|folder\_id|[int](../types/int.md) | Optional|ID of folder for peers in folders| +|channel\_id|[int](../types/int.md) | Yes|Channel/supergroup ID| +|max\_id|[int](../types/int.md) | Yes|Position up to which all incoming messages are read.| +|still\_unread\_count|[int](../types/int.md) | Yes|Count of messages weren't read yet| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateReadChannelInbox = ['_' => 'updateReadChannelInbox', 'folder_id' => int, 'channel_id' => int, 'max_id' => int, 'still_unread_count' => int, 'pts' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateReadChannelInbox={_='updateReadChannelInbox', folder_id=int, channel_id=int, max_id=int, still_unread_count=int, pts=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateReadChannelOutbox.md b/old_docs/API_docs_v109/constructors/updateReadChannelOutbox.md new file mode 100644 index 00000000..7272c0e4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateReadChannelOutbox.md @@ -0,0 +1,39 @@ +--- +title: updateReadChannelOutbox +description: Outgoing messages in a [channel/supergroup](https://core.telegram.org/api/channel) were read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadChannelOutbox +[Back to constructors index](index.md) + + + +Outgoing messages in a [channel/supergroup](https://core.telegram.org/api/channel) were read + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel\_id|[int](../types/int.md) | Yes|Channel/supergroup ID| +|max\_id|[int](../types/int.md) | Yes|Position up to which all outgoing messages are read.| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateReadChannelOutbox = ['_' => 'updateReadChannelOutbox', 'channel_id' => int, 'max_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateReadChannelOutbox={_='updateReadChannelOutbox', channel_id=int, max_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateReadFeaturedStickers.md b/old_docs/API_docs_v109/constructors/updateReadFeaturedStickers.md new file mode 100644 index 00000000..f95a3f8c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateReadFeaturedStickers.md @@ -0,0 +1,33 @@ +--- +title: updateReadFeaturedStickers +description: Some featured stickers were marked as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadFeaturedStickers +[Back to constructors index](index.md) + + + +Some featured stickers were marked as read + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateReadFeaturedStickers = ['_' => 'updateReadFeaturedStickers']; +``` + + +Or, if you're into Lua: + +```lua +updateReadFeaturedStickers={_='updateReadFeaturedStickers'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateReadHistoryInbox.md b/old_docs/API_docs_v109/constructors/updateReadHistoryInbox.md new file mode 100644 index 00000000..594e5563 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateReadHistoryInbox.md @@ -0,0 +1,43 @@ +--- +title: updateReadHistoryInbox +description: Incoming messages were read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadHistoryInbox +[Back to constructors index](index.md) + + + +Incoming messages were read + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|folder\_id|[int](../types/int.md) | Optional|Folder ID| +|peer|[Peer](../types/Peer.md) | Yes|Peer| +|max\_id|[int](../types/int.md) | Yes|Maximum ID of messages read| +|still\_unread\_count|[int](../types/int.md) | Yes|Number of messages that are still unread| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateReadHistoryInbox = ['_' => 'updateReadHistoryInbox', 'folder_id' => int, 'peer' => Peer, 'max_id' => int, 'still_unread_count' => int, 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateReadHistoryInbox={_='updateReadHistoryInbox', folder_id=int, peer=Peer, max_id=int, still_unread_count=int, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateReadHistoryOutbox.md b/old_docs/API_docs_v109/constructors/updateReadHistoryOutbox.md new file mode 100644 index 00000000..afd3e230 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateReadHistoryOutbox.md @@ -0,0 +1,41 @@ +--- +title: updateReadHistoryOutbox +description: Outgoing messages were read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadHistoryOutbox +[Back to constructors index](index.md) + + + +Outgoing messages were read + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Peer](../types/Peer.md) | Yes|Peer| +|max\_id|[int](../types/int.md) | Yes|Maximum ID of read outgoing messages| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateReadHistoryOutbox = ['_' => 'updateReadHistoryOutbox', 'peer' => Peer, 'max_id' => int, 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateReadHistoryOutbox={_='updateReadHistoryOutbox', peer=Peer, max_id=int, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateReadMessagesContents.md b/old_docs/API_docs_v109/constructors/updateReadMessagesContents.md new file mode 100644 index 00000000..42d2691d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateReadMessagesContents.md @@ -0,0 +1,40 @@ +--- +title: updateReadMessagesContents +description: Contents of messages in the common [message box](https://core.telegram.org/api/updates) were read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateReadMessagesContents +[Back to constructors index](index.md) + + + +Contents of messages in the common [message box](https://core.telegram.org/api/updates) were read + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|messages|Array of [int](../types/int.md) | Yes|Messages| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateReadMessagesContents = ['_' => 'updateReadMessagesContents', 'messages' => [int, int], 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateReadMessagesContents={_='updateReadMessagesContents', messages={int}, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateRecentStickers.md b/old_docs/API_docs_v109/constructors/updateRecentStickers.md new file mode 100644 index 00000000..d588d7e3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateRecentStickers.md @@ -0,0 +1,33 @@ +--- +title: updateRecentStickers +description: The recent sticker list was updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateRecentStickers +[Back to constructors index](index.md) + + + +The recent sticker list was updated + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateRecentStickers = ['_' => 'updateRecentStickers']; +``` + + +Or, if you're into Lua: + +```lua +updateRecentStickers={_='updateRecentStickers'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateSavedGifs.md b/old_docs/API_docs_v109/constructors/updateSavedGifs.md new file mode 100644 index 00000000..4187c414 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateSavedGifs.md @@ -0,0 +1,33 @@ +--- +title: updateSavedGifs +description: The saved gif list has changed, the client should refetch it using [messages.getSavedGifs](https://core.telegram.org/method/messages.getSavedGifs) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateSavedGifs +[Back to constructors index](index.md) + + + +The saved gif list has changed, the client should refetch it using [messages.getSavedGifs](https://core.telegram.org/method/messages.getSavedGifs) + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateSavedGifs = ['_' => 'updateSavedGifs']; +``` + + +Or, if you're into Lua: + +```lua +updateSavedGifs={_='updateSavedGifs'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateServiceNotification.md b/old_docs/API_docs_v109/constructors/updateServiceNotification.md new file mode 100644 index 00000000..1f7222ba --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateServiceNotification.md @@ -0,0 +1,47 @@ +--- +title: updateServiceNotification +description: A service message for the user. + +The app must show the message to the user upon receiving this update. In case the **popup** parameter was passed, the text message must be displayed in a popup alert immediately upon receipt. It is recommended to handle the text as you would an ordinary message in terms of highlighting links, etc. The message must also be stored locally as part of the message history with the user id `777000` (Telegram Notifications). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateServiceNotification +[Back to constructors index](index.md) + + + +A service message for the user. + +The app must show the message to the user upon receiving this update. In case the **popup** parameter was passed, the text message must be displayed in a popup alert immediately upon receipt. It is recommended to handle the text as you would an ordinary message in terms of highlighting links, etc. The message must also be stored locally as part of the message history with the user id `777000` (Telegram Notifications). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|popup|[Bool](../types/Bool.md) | Optional|(boolTrue) if the message must be displayed in a popup.| +|inbox\_date|[int](../types/int.md) | Optional|When was the notification received
The message must also be stored locally as part of the message history with the user id `777000` (Telegram Notifications).| +|type|[string](../types/string.md) | Yes|String, identical in format and contents to the [**type**](https://core.telegram.org/api/errors#error-type) field in API errors. Describes type of service message. It is acceptable to ignore repeated messages of the same **type** within a short period of time (15 minutes).| +|message|[string](../types/string.md) | Yes|Message text| +|media|[MessageMedia](../types/MessageMedia.md) | Optional|Media content (optional)| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Yes|Entities| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateServiceNotification = ['_' => 'updateServiceNotification', 'popup' => Bool, 'inbox_date' => int, 'type' => 'string', 'message' => 'string', 'media' => MessageMedia, 'entities' => [MessageEntity, MessageEntity]]; +``` + + +Or, if you're into Lua: + +```lua +updateServiceNotification={_='updateServiceNotification', popup=Bool, inbox_date=int, type='string', message='string', media=MessageMedia, entities={MessageEntity}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateShort.md b/old_docs/API_docs_v109/constructors/updateShort.md new file mode 100644 index 00000000..48e9cfc7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateShort.md @@ -0,0 +1,39 @@ +--- +title: updateShort +description: Shortened constructor containing info on one update not requiring auxiliary data +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateShort +[Back to constructors index](index.md) + + + +Shortened constructor containing info on one update not requiring auxiliary data + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|update|[Update](../types/Update.md) | Yes|Update| +|date|[int](../types/int.md) | Yes|Date of event| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +```php +$updateShort = ['_' => 'updateShort', 'update' => Update, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateShort={_='updateShort', update=Update, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateShortChatMessage.md b/old_docs/API_docs_v109/constructors/updateShortChatMessage.md new file mode 100644 index 00000000..88a70ecb --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateShortChatMessage.md @@ -0,0 +1,52 @@ +--- +title: updateShortChatMessage +description: Shortened constructor containing info on one new incoming text message from a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateShortChatMessage +[Back to constructors index](index.md) + + + +Shortened constructor containing info on one new incoming text message from a chat + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|out|[Bool](../types/Bool.md) | Optional|Whether the message is outgoing| +|mentioned|[Bool](../types/Bool.md) | Optional|Whether we were mentioned in this message| +|media\_unread|[Bool](../types/Bool.md) | Optional|Whether the message contains some **unread** mentions| +|silent|[Bool](../types/Bool.md) | Optional|If true, the message is a silent message, no notifications should be triggered| +|id|[int](../types/int.md) | Yes|ID of the message| +|from\_id|[int](../types/int.md) | Yes|ID of the sender of the message| +|chat\_id|[int](../types/int.md) | Yes|ID of the chat where the message was sent| +|message|[string](../types/string.md) | Yes|Message| +|pts|[int](../types/int.md) | Yes|[PTS](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[PTS count](https://core.telegram.org/api/updates)| +|date|[int](../types/int.md) | Yes|[date](https://core.telegram.org/api/updates)| +|fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional|Info about a forwarded message| +|via\_bot\_id|[int](../types/int.md) | Optional|Info about the inline bot used to generate this message| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +```php +$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]]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/updateShortMessage.md b/old_docs/API_docs_v109/constructors/updateShortMessage.md new file mode 100644 index 00000000..d8efa05a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateShortMessage.md @@ -0,0 +1,51 @@ +--- +title: updateShortMessage +description: Info about a message sent to (received from) another user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateShortMessage +[Back to constructors index](index.md) + + + +Info about a message sent to (received from) another user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|out|[Bool](../types/Bool.md) | Optional|Whether the message is outgoing| +|mentioned|[Bool](../types/Bool.md) | Optional|Whether we were mentioned in the message| +|media\_unread|[Bool](../types/Bool.md) | Optional|Whether there are some **unread** mentions in this message| +|silent|[Bool](../types/Bool.md) | Optional|If true, the message is a silent message, no notifications should be triggered| +|id|[int](../types/int.md) | Yes|The message ID| +|user\_id|[int](../types/int.md) | Yes|The ID of the sender (if `outgoing` will be the ID of the destination) of the message| +|message|[string](../types/string.md) | Yes|The message| +|pts|[int](../types/int.md) | Yes|[PTS](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[PTS count](https://core.telegram.org/api/updates)| +|date|[int](../types/int.md) | Yes|[date](https://core.telegram.org/api/updates)| +|fwd\_from|[MessageFwdHeader](../types/MessageFwdHeader.md) | Optional|Info about a forwarded message| +|via\_bot\_id|[int](../types/int.md) | Optional|Info about the inline bot used to generate this message| +|reply\_to\_msg\_id|[int](../types/int.md) | Optional|ID of the message this message replies to| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +```php +$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]]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/updateShortSentMessage.md b/old_docs/API_docs_v109/constructors/updateShortSentMessage.md new file mode 100644 index 00000000..2c969aaf --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateShortSentMessage.md @@ -0,0 +1,44 @@ +--- +title: updateShortSentMessage +description: Shortened constructor containing info on one outgoing message to a contact (the destination chat has to be extracted from the method call that returned this object). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateShortSentMessage +[Back to constructors index](index.md) + + + +Shortened constructor containing info on one outgoing message to a contact (the destination chat has to be extracted from the method call that returned this object). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|out|[Bool](../types/Bool.md) | Optional|Whether the message is outgoing| +|id|[int](../types/int.md) | Yes|ID of the sent message| +|pts|[int](../types/int.md) | Yes|[PTS](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[PTS count](https://core.telegram.org/api/updates)| +|date|[int](../types/int.md) | Yes|[date](https://core.telegram.org/api/updates)| +|media|[MessageMedia](../types/MessageMedia.md) | Optional|Attached media| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +```php +$updateShortSentMessage = ['_' => 'updateShortSentMessage', 'out' => Bool, 'id' => int, 'pts' => int, 'pts_count' => int, 'date' => int, 'media' => MessageMedia, 'entities' => [MessageEntity, MessageEntity]]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/updateStickerSets.md b/old_docs/API_docs_v109/constructors/updateStickerSets.md new file mode 100644 index 00000000..5dd59748 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateStickerSets.md @@ -0,0 +1,33 @@ +--- +title: updateStickerSets +description: Installed stickersets have changed, the client should refetch them using [messages.getAllStickers](https://core.telegram.org/method/messages.getAllStickers) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateStickerSets +[Back to constructors index](index.md) + + + +Installed stickersets have changed, the client should refetch them using [messages.getAllStickers](https://core.telegram.org/method/messages.getAllStickers) + + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateStickerSets = ['_' => 'updateStickerSets']; +``` + + +Or, if you're into Lua: + +```lua +updateStickerSets={_='updateStickerSets'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateStickerSetsOrder.md b/old_docs/API_docs_v109/constructors/updateStickerSetsOrder.md new file mode 100644 index 00000000..7e66b6a3 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateStickerSetsOrder.md @@ -0,0 +1,39 @@ +--- +title: updateStickerSetsOrder +description: The order of stickersets was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateStickerSetsOrder +[Back to constructors index](index.md) + + + +The order of stickersets was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[Bool](../types/Bool.md) | Optional|Whether the updated stickers are mask stickers| +|order|Array of [long](../types/long.md) | Yes|Order| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateStickerSetsOrder = ['_' => 'updateStickerSetsOrder', 'masks' => Bool, 'order' => [long, long]]; +``` + + +Or, if you're into Lua: + +```lua +updateStickerSetsOrder={_='updateStickerSetsOrder', masks=Bool, order={long}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateTheme.md b/old_docs/API_docs_v109/constructors/updateTheme.md new file mode 100644 index 00000000..c638e434 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateTheme.md @@ -0,0 +1,38 @@ +--- +title: updateTheme +description: A cloud theme was updated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateTheme +[Back to constructors index](index.md) + + + +A cloud theme was updated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|theme|[Theme](../types/Theme.md) | Yes|Theme| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateTheme = ['_' => 'updateTheme', 'theme' => Theme]; +``` + + +Or, if you're into Lua: + +```lua +updateTheme={_='updateTheme', theme=Theme} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateUserBlocked.md b/old_docs/API_docs_v109/constructors/updateUserBlocked.md new file mode 100644 index 00000000..7d4da3c6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateUserBlocked.md @@ -0,0 +1,39 @@ +--- +title: updateUserBlocked +description: User was added to the blacklist (method [contacts.block](../methods/contacts.block.md)) or removed from the blacklist (method [contacts.unblock](../methods/contacts.unblock.md)). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserBlocked +[Back to constructors index](index.md) + + + +User was added to the blacklist (method [contacts.block](../methods/contacts.block.md)) or removed from the blacklist (method [contacts.unblock](../methods/contacts.unblock.md)). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User id| +|blocked|[Bool](../types/Bool.md) | Yes|([boolTrue](../constructors/boolTrue.md)) if the the user is blocked| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateUserBlocked = ['_' => 'updateUserBlocked', 'user_id' => int, 'blocked' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +updateUserBlocked={_='updateUserBlocked', user_id=int, blocked=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateUserName.md b/old_docs/API_docs_v109/constructors/updateUserName.md new file mode 100644 index 00000000..5ae6de1d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateUserName.md @@ -0,0 +1,41 @@ +--- +title: updateUserName +description: Changes the user's first name, last name and username. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserName +[Back to constructors index](index.md) + + + +Changes the user's first name, last name and username. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|first\_name|[string](../types/string.md) | Yes|New first name. Corresponds to the new value of **real\_first\_name** field of the [userFull](../constructors/userFull.md) constructor.| +|last\_name|[string](../types/string.md) | Yes|New last name. Corresponds to the new value of **real\_last\_name** field of the [userFull](../constructors/userFull.md) constructor.| +|username|[string](../types/string.md) | Yes|New username.
Parameter added in [Layer 18](https://core.telegram.org/api/layers#layer-18).| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateUserName = ['_' => 'updateUserName', 'user_id' => int, 'first_name' => 'string', 'last_name' => 'string', 'username' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +updateUserName={_='updateUserName', user_id=int, first_name='string', last_name='string', username='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateUserPhone.md b/old_docs/API_docs_v109/constructors/updateUserPhone.md new file mode 100644 index 00000000..9b8e15d9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateUserPhone.md @@ -0,0 +1,39 @@ +--- +title: updateUserPhone +description: A user's phone number was changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserPhone +[Back to constructors index](index.md) + + + +A user's phone number was changed + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User ID| +|phone|[string](../types/string.md) | Yes|New phone number| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateUserPhone = ['_' => 'updateUserPhone', 'user_id' => int, 'phone' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +updateUserPhone={_='updateUserPhone', user_id=int, phone='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateUserPhoto.md b/old_docs/API_docs_v109/constructors/updateUserPhoto.md new file mode 100644 index 00000000..63a3cba6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateUserPhoto.md @@ -0,0 +1,41 @@ +--- +title: updateUserPhoto +description: Change of contact's profile photo. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserPhoto +[Back to constructors index](index.md) + + + +Change of contact's profile photo. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|date|[int](../types/int.md) | Yes|Date of photo update.
Parameter was added in [second layer](?layer=2).| +|photo|[UserProfilePhoto](../types/UserProfilePhoto.md) | Optional|New profile photo| +|previous|[Bool](../types/Bool.md) | Yes|([boolTrue](../constructors/boolTrue.md)), if one of the previously used photos is set a profile photo.
Parameter was added in [second layer](?layer=2).| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateUserPhoto = ['_' => 'updateUserPhoto', 'user_id' => int, 'date' => int, 'photo' => UserProfilePhoto, 'previous' => Bool]; +``` + + +Or, if you're into Lua: + +```lua +updateUserPhoto={_='updateUserPhoto', user_id=int, date=int, photo=UserProfilePhoto, previous=Bool} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateUserPinnedMessage.md b/old_docs/API_docs_v109/constructors/updateUserPinnedMessage.md new file mode 100644 index 00000000..2187c87a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateUserPinnedMessage.md @@ -0,0 +1,39 @@ +--- +title: updateUserPinnedMessage +description: A message was pinned in a private chat with a user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserPinnedMessage +[Back to constructors index](index.md) + + + +A message was pinned in a private chat with a user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User that pinned the message| +|id|[int](../types/int.md) | Yes|Message ID that was pinned| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateUserPinnedMessage = ['_' => 'updateUserPinnedMessage', 'user_id' => int, 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateUserPinnedMessage={_='updateUserPinnedMessage', user_id=int, id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateUserStatus.md b/old_docs/API_docs_v109/constructors/updateUserStatus.md new file mode 100644 index 00000000..719b2da4 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateUserStatus.md @@ -0,0 +1,39 @@ +--- +title: updateUserStatus +description: Contact status update. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserStatus +[Back to constructors index](index.md) + + + +Contact status update. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User identifier| +|status|[UserStatus](../types/UserStatus.md) | Optional|New status| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateUserStatus = ['_' => 'updateUserStatus', 'user_id' => int, 'status' => UserStatus]; +``` + + +Or, if you're into Lua: + +```lua +updateUserStatus={_='updateUserStatus', user_id=int, status=UserStatus} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateUserTyping.md b/old_docs/API_docs_v109/constructors/updateUserTyping.md new file mode 100644 index 00000000..2fb8c048 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateUserTyping.md @@ -0,0 +1,39 @@ +--- +title: updateUserTyping +description: The user is preparing a message; typing, recording, uploading, etc. This update is valid for 6 seconds. If no repeated update received after 6 seconds, it should be considered that the user stopped doing whatever he's been doing. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateUserTyping +[Back to constructors index](index.md) + + + +The user is preparing a message; typing, recording, uploading, etc. This update is valid for 6 seconds. If no repeated update received after 6 seconds, it should be considered that the user stopped doing whatever he's been doing. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[int](../types/int.md) | Yes|User id| +|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Action type
Param added in [Layer 17](https://core.telegram.org/api/layers#layer-17).| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateUserTyping = ['_' => 'updateUserTyping', 'user_id' => int, 'action' => SendMessageAction]; +``` + + +Or, if you're into Lua: + +```lua +updateUserTyping={_='updateUserTyping', user_id=int, action=SendMessageAction} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updateWebPage.md b/old_docs/API_docs_v109/constructors/updateWebPage.md new file mode 100644 index 00000000..9b9221c6 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updateWebPage.md @@ -0,0 +1,40 @@ +--- +title: updateWebPage +description: An [instant view](https://instantview.telegram.org) webpage preview was generated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updateWebPage +[Back to constructors index](index.md) + + + +An [instant view](https://instantview.telegram.org) webpage preview was generated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|webpage|[WebPage](../types/WebPage.md) | Optional|Webpage preview| +|pts|[int](../types/int.md) | Yes|[Event count after generation](https://core.telegram.org/api/updates)| +|pts\_count|[int](../types/int.md) | Yes|[Number of events that were generated](https://core.telegram.org/api/updates)| + + + +### Type: [Update](../types/Update.md) + + +### Example: + +```php +$updateWebPage = ['_' => 'updateWebPage', 'webpage' => WebPage, 'pts' => int, 'pts_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updateWebPage={_='updateWebPage', webpage=WebPage, pts=int, pts_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updates.channelDifference.md b/old_docs/API_docs_v109/constructors/updates.channelDifference.md new file mode 100644 index 00000000..c89bf2d0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updates.channelDifference.md @@ -0,0 +1,45 @@ +--- +title: updates.channelDifference +description: The new updates +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/updates_channelDifference.html +--- +# Constructor: updates.channelDifference +[Back to constructors index](index.md) + + + +The new updates + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|final|[Bool](../types/Bool.md) | Optional|Whether there are more updates to be fetched using getDifference, starting from the provided `pts`| +|pts|[int](../types/int.md) | Yes|The [PTS](https://core.telegram.org/api/updates) from which to start getting updates the next time| +|timeout|[int](../types/int.md) | Optional|Clients are supposed to refetch the channel difference after timeout seconds have elapsed| +|new\_messages|Array of [Message](../types/Message.md) | Yes|New messages| +|other\_updates|Array of [Update](../types/Update.md) | Yes|Other updates| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [updates.ChannelDifference](../types/updates.ChannelDifference.md) + + +### Example: + +```php +$updates.channelDifference = ['_' => 'updates.channelDifference', 'final' => Bool, 'pts' => int, 'timeout' => int, 'new_messages' => [Message, Message], 'other_updates' => [Update, Update], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/updates.channelDifferenceEmpty.md b/old_docs/API_docs_v109/constructors/updates.channelDifferenceEmpty.md new file mode 100644 index 00000000..09e117c1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updates.channelDifferenceEmpty.md @@ -0,0 +1,41 @@ +--- +title: updates.channelDifferenceEmpty +description: There are no new updates +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/updates_channelDifferenceEmpty.html +--- +# Constructor: updates.channelDifferenceEmpty +[Back to constructors index](index.md) + + + +There are no new updates + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|final|[Bool](../types/Bool.md) | Optional|Whether there are more updates that must be fetched (always false)| +|pts|[int](../types/int.md) | Yes|The latest [PTS](https://core.telegram.org/api/updates)| +|timeout|[int](../types/int.md) | Optional|Clients are supposed to refetch the channel difference after timeout seconds have elapsed| + + + +### Type: [updates.ChannelDifference](../types/updates.ChannelDifference.md) + + +### Example: + +```php +$updates.channelDifferenceEmpty = ['_' => 'updates.channelDifferenceEmpty', 'final' => Bool, 'pts' => int, 'timeout' => int]; +``` + + +Or, if you're into Lua: + +```lua +updates.channelDifferenceEmpty={_='updates.channelDifferenceEmpty', final=Bool, pts=int, timeout=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updates.channelDifferenceTooLong.md b/old_docs/API_docs_v109/constructors/updates.channelDifferenceTooLong.md new file mode 100644 index 00000000..25b0fa5d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updates.channelDifferenceTooLong.md @@ -0,0 +1,54 @@ +--- +title: updates.channelDifferenceTooLong +description: The provided `pts + limit < remote pts`. Simply, there are too many updates to be fetched (more than `limit`), the client has to resolve the update gap in one of the following ways: + +1. Delete all known messages in the chat, begin from scratch by refetching all messages manually with [getHistory](../methods/messages.getHistory.md). It is easy to implement, but suddenly disappearing messages looks awful for the user. +2. Save all messages loaded in the memory until application restart, but delete all messages from database. Messages left in the memory must be lazily updated using calls to [getHistory](../methods/messages.getHistory.md). It looks much smoothly for the user, he will need to redownload messages only after client restart. Unsynchronized messages left in the memory shouldn't be saved to database, results of [getHistory](../methods/messages.getHistory.md) and [getMessages](../methods/messages.getMessages.md) must be used to update state of deleted and edited messages left in the memory. +3. Save all messages loaded in the memory and stored in the database without saving that some messages form continuous ranges. Messages in the database will be excluded from results of getChatHistory and searchChatMessages after application restart and will be available only through getMessage. Every message should still be checked using getHistory. It has more disadvantages over 2) than advantages. +4. Save all messages with saving all data about continuous message ranges. Messages from the database may be used as results of getChatHistory and (if implemented continuous ranges support for searching shared media) searchChatMessages. The messages should still be lazily checked using getHistory, but they are still available offline. It is the best way for gaps support, but it is pretty hard to implement correctly. It should be also noted that some messages like live location messages shouldn't be deleted. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/updates_channelDifferenceTooLong.html +--- +# Constructor: updates.channelDifferenceTooLong +[Back to constructors index](index.md) + + + +The provided `pts + limit < remote pts`. Simply, there are too many updates to be fetched (more than `limit`), the client has to resolve the update gap in one of the following ways: + +1. Delete all known messages in the chat, begin from scratch by refetching all messages manually with [getHistory](../methods/messages.getHistory.md). It is easy to implement, but suddenly disappearing messages looks awful for the user. +2. Save all messages loaded in the memory until application restart, but delete all messages from database. Messages left in the memory must be lazily updated using calls to [getHistory](../methods/messages.getHistory.md). It looks much smoothly for the user, he will need to redownload messages only after client restart. Unsynchronized messages left in the memory shouldn't be saved to database, results of [getHistory](../methods/messages.getHistory.md) and [getMessages](../methods/messages.getMessages.md) must be used to update state of deleted and edited messages left in the memory. +3. Save all messages loaded in the memory and stored in the database without saving that some messages form continuous ranges. Messages in the database will be excluded from results of getChatHistory and searchChatMessages after application restart and will be available only through getMessage. Every message should still be checked using getHistory. It has more disadvantages over 2) than advantages. +4. Save all messages with saving all data about continuous message ranges. Messages from the database may be used as results of getChatHistory and (if implemented continuous ranges support for searching shared media) searchChatMessages. The messages should still be lazily checked using getHistory, but they are still available offline. It is the best way for gaps support, but it is pretty hard to implement correctly. It should be also noted that some messages like live location messages shouldn't be deleted. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|final|[Bool](../types/Bool.md) | Optional|Whether there are more updates that must be fetched (always false)| +|timeout|[int](../types/int.md) | Optional|Clients are supposed to refetch the channel difference after timeout seconds have elapsed| +|dialog|[Dialog](../types/Dialog.md) | Yes|Dialog containing the latest [PTS](https://core.telegram.org/api/updates) that can be used to reset the channel state| +|messages|Array of [Message](../types/Message.md) | Yes|Messages| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| + + + +### Type: [updates.ChannelDifference](../types/updates.ChannelDifference.md) + + +### Example: + +```php +$updates.channelDifferenceTooLong = ['_' => 'updates.channelDifferenceTooLong', 'final' => Bool, 'timeout' => int, 'dialog' => Dialog, 'messages' => [Message, Message], 'chats' => [Chat, Chat], 'users' => [User, User]]; +``` + + +Or, if you're into Lua: + +```lua +updates.channelDifferenceTooLong={_='updates.channelDifferenceTooLong', final=Bool, timeout=int, dialog=Dialog, messages={Message}, chats={Chat}, users={User}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updates.difference.md b/old_docs/API_docs_v109/constructors/updates.difference.md new file mode 100644 index 00000000..2533ef1c --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updates.difference.md @@ -0,0 +1,44 @@ +--- +title: updates.difference +description: Full list of occurred events. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/updates_difference.html +--- +# Constructor: updates.difference +[Back to constructors index](index.md) + + + +Full list of occurred events. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|new\_messages|Array of [Message](../types/Message.md) | Yes|New messages| +|new\_encrypted\_messages|Array of [EncryptedMessage](../types/EncryptedMessage.md) | Yes|New encrypted messages| +|other\_updates|Array of [Update](../types/Update.md) | Yes|Other updates| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| +|state|[updates.State](../constructors/updates.State.md) | Yes|Current state| + + + +### Type: [updates.Difference](../types/updates.Difference.md) + + +### Example: + +```php +$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]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/updates.differenceEmpty.md b/old_docs/API_docs_v109/constructors/updates.differenceEmpty.md new file mode 100644 index 00000000..a5dcd277 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updates.differenceEmpty.md @@ -0,0 +1,40 @@ +--- +title: updates.differenceEmpty +description: No events. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/updates_differenceEmpty.html +--- +# Constructor: updates.differenceEmpty +[Back to constructors index](index.md) + + + +No events. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|date|[int](../types/int.md) | Yes|Current date| +|seq|[int](../types/int.md) | Yes|Number of sent updates| + + + +### Type: [updates.Difference](../types/updates.Difference.md) + + +### Example: + +```php +$updates.differenceEmpty = ['_' => 'updates.differenceEmpty', 'date' => int, 'seq' => int]; +``` + + +Or, if you're into Lua: + +```lua +updates.differenceEmpty={_='updates.differenceEmpty', date=int, seq=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updates.differenceSlice.md b/old_docs/API_docs_v109/constructors/updates.differenceSlice.md new file mode 100644 index 00000000..22644341 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updates.differenceSlice.md @@ -0,0 +1,44 @@ +--- +title: updates.differenceSlice +description: Incomplete list of occurred events. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/updates_differenceSlice.html +--- +# Constructor: updates.differenceSlice +[Back to constructors index](index.md) + + + +Incomplete list of occurred events. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|new\_messages|Array of [Message](../types/Message.md) | Yes|New messages| +|new\_encrypted\_messages|Array of [EncryptedMessage](../types/EncryptedMessage.md) | Yes|New encrypted messages| +|other\_updates|Array of [Update](../types/Update.md) | Yes|Other updates| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|users|Array of [User](../types/User.md) | Yes|Users| +|intermediate\_state|[updates.State](../constructors/updates.State.md) | Yes|Intermediary state| + + + +### Type: [updates.Difference](../types/updates.Difference.md) + + +### Example: + +```php +$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]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/updates.differenceTooLong.md b/old_docs/API_docs_v109/constructors/updates.differenceTooLong.md new file mode 100644 index 00000000..5bb17a0e --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updates.differenceTooLong.md @@ -0,0 +1,39 @@ +--- +title: updates.differenceTooLong +description: The difference is [too long](https://core.telegram.org/api/updates#recovering-gaps), and the specified state must be used to refetch updates. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/updates_differenceTooLong.html +--- +# Constructor: updates.differenceTooLong +[Back to constructors index](index.md) + + + +The difference is [too long](https://core.telegram.org/api/updates#recovering-gaps), and the specified state must be used to refetch updates. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pts|[int](../types/int.md) | Yes|The new state to use.| + + + +### Type: [updates.Difference](../types/updates.Difference.md) + + +### Example: + +```php +$updates.differenceTooLong = ['_' => 'updates.differenceTooLong', 'pts' => int]; +``` + + +Or, if you're into Lua: + +```lua +updates.differenceTooLong={_='updates.differenceTooLong', pts=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updates.md b/old_docs/API_docs_v109/constructors/updates.md new file mode 100644 index 00000000..b09d8a07 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updates.md @@ -0,0 +1,42 @@ +--- +title: updates +description: Full constructor of updates +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updates +[Back to constructors index](index.md) + + + +Full constructor of updates + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|updates|Array of [Update](../types/Update.md) | Yes|Updates| +|users|Array of [User](../types/User.md) | Yes|Users| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|date|[int](../types/int.md) | Yes|Current date| +|seq|[int](../types/int.md) | Yes|Total number of sent updates| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +```php +$updates = ['_' => 'updates', 'updates' => [Update, Update], 'users' => [User, User], 'chats' => [Chat, Chat], 'date' => int, 'seq' => int]; +``` + + +Or, if you're into Lua: + +```lua +updates={_='updates', updates={Update}, users={User}, chats={Chat}, date=int, seq=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updates.state.md b/old_docs/API_docs_v109/constructors/updates.state.md new file mode 100644 index 00000000..f27fa210 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updates.state.md @@ -0,0 +1,43 @@ +--- +title: updates.state +description: Updates state. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/updates_state.html +--- +# Constructor: updates.state +[Back to constructors index](index.md) + + + +Updates state. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pts|[int](../types/int.md) | Yes|Number of events occured in a text box| +|qts|[int](../types/int.md) | Yes|Position in a sequence of updates in secret chats. For further detailes refer to article [secret chats](https://core.telegram.org/api/end-to-end)
Parameter was added in [eigth layer](https://core.telegram.org/api/layers#layer-8).| +|date|[int](../types/int.md) | Yes|Date of condition| +|seq|[int](../types/int.md) | Yes|Number of sent updates| +|unread\_count|[int](../types/int.md) | Yes|Number of unread messages| + + + +### Type: [updates.State](../types/updates.State.md) + + +### Example: + +```php +$updates.state = ['_' => 'updates.state', 'pts' => int, 'qts' => int, 'date' => int, 'seq' => int, 'unread_count' => int]; +``` + + +Or, if you're into Lua: + +```lua +updates.state={_='updates.state', pts=int, qts=int, date=int, seq=int, unread_count=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updatesCombined.md b/old_docs/API_docs_v109/constructors/updatesCombined.md new file mode 100644 index 00000000..b4056d77 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updatesCombined.md @@ -0,0 +1,43 @@ +--- +title: updatesCombined +description: Constructor for a group of updates. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatesCombined +[Back to constructors index](index.md) + + + +Constructor for a group of updates. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|updates|Array of [Update](../types/Update.md) | Yes|Updates| +|users|Array of [User](../types/User.md) | Yes|Users| +|chats|Array of [Chat](../types/Chat.md) | Yes|Chats| +|date|[int](../types/int.md) | Yes|Current date| +|seq\_start|[int](../types/int.md) | Yes|Value **seq** for the earliest update in a group| +|seq|[int](../types/int.md) | Yes|Value **seq** for the latest update in a group| + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +```php +$updatesCombined = ['_' => 'updatesCombined', 'updates' => [Update, Update], 'users' => [User, User], 'chats' => [Chat, Chat], 'date' => int, 'seq_start' => int, 'seq' => int]; +``` + + +Or, if you're into Lua: + +```lua +updatesCombined={_='updatesCombined', updates={Update}, users={User}, chats={Chat}, date=int, seq_start=int, seq=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/updatesTooLong.md b/old_docs/API_docs_v109/constructors/updatesTooLong.md new file mode 100644 index 00000000..dc991d65 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/updatesTooLong.md @@ -0,0 +1,33 @@ +--- +title: updatesTooLong +description: Too many updates, it is necessary to execute [updates.getDifference](../methods/updates.getDifference.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: updatesTooLong +[Back to constructors index](index.md) + + + +Too many updates, it is necessary to execute [updates.getDifference](../methods/updates.getDifference.md). + + + + +### Type: [Updates](../types/Updates.md) + + +### Example: + +```php +$updatesTooLong = ['_' => 'updatesTooLong']; +``` + + +Or, if you're into Lua: + +```lua +updatesTooLong={_='updatesTooLong'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/upload.cdnFile.md b/old_docs/API_docs_v109/constructors/upload.cdnFile.md new file mode 100644 index 00000000..e600415b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/upload.cdnFile.md @@ -0,0 +1,39 @@ +--- +title: upload.cdnFile +description: Represent a chunk of a [CDN](https://core.telegram.org/cdn) file. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/upload_cdnFile.html +--- +# Constructor: upload.cdnFile +[Back to constructors index](index.md) + + + +Represent a chunk of a [CDN](https://core.telegram.org/cdn) file. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bytes|[bytes](../types/bytes.md) | Yes|The data| + + + +### Type: [upload.CdnFile](../types/upload.CdnFile.md) + + +### Example: + +```php +$upload.cdnFile = ['_' => 'upload.cdnFile', 'bytes' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +upload.cdnFile={_='upload.cdnFile', bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/upload.cdnFileReuploadNeeded.md b/old_docs/API_docs_v109/constructors/upload.cdnFileReuploadNeeded.md new file mode 100644 index 00000000..a9fa41c9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/upload.cdnFileReuploadNeeded.md @@ -0,0 +1,39 @@ +--- +title: upload.cdnFileReuploadNeeded +description: The file was cleared from the temporary RAM cache of the [CDN](https://core.telegram.org/cdn) and has to be reuploaded. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/upload_cdnFileReuploadNeeded.html +--- +# Constructor: upload.cdnFileReuploadNeeded +[Back to constructors index](index.md) + + + +The file was cleared from the temporary RAM cache of the [CDN](https://core.telegram.org/cdn) and has to be reuploaded. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|request\_token|[bytes](../types/bytes.md) | Yes|Request token (see [CDN](https://core.telegram.org/cdn))| + + + +### Type: [upload.CdnFile](../types/upload.CdnFile.md) + + +### Example: + +```php +$upload.cdnFileReuploadNeeded = ['_' => 'upload.cdnFileReuploadNeeded', 'request_token' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +upload.cdnFileReuploadNeeded={_='upload.cdnFileReuploadNeeded', request_token='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/upload.file.md b/old_docs/API_docs_v109/constructors/upload.file.md new file mode 100644 index 00000000..1374f4b7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/upload.file.md @@ -0,0 +1,41 @@ +--- +title: upload.file +description: File content. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/upload_file.html +--- +# Constructor: upload.file +[Back to constructors index](index.md) + + + +File content. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|type|[storage.FileType](../constructors/storage.FileType.md) | Yes|File type| +|mtime|[int](../types/int.md) | Yes|Modification type| +|bytes|[bytes](../types/bytes.md) | Yes|Binary data, file content| + + + +### Type: [upload.File](../types/upload.File.md) + + +### Example: + +```php +$upload.file = ['_' => 'upload.file', 'type' => storage.FileType, 'mtime' => int, 'bytes' => 'bytes']; +``` + + +Or, if you're into Lua: + +```lua +upload.file={_='upload.file', type=storage.FileType, mtime=int, bytes='bytes'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/upload.fileCdnRedirect.md b/old_docs/API_docs_v109/constructors/upload.fileCdnRedirect.md new file mode 100644 index 00000000..c77649ea --- /dev/null +++ b/old_docs/API_docs_v109/constructors/upload.fileCdnRedirect.md @@ -0,0 +1,43 @@ +--- +title: upload.fileCdnRedirect +description: The file must be downloaded from a [CDN DC](https://core.telegram.org/cdn). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/upload_fileCdnRedirect.html +--- +# Constructor: upload.fileCdnRedirect +[Back to constructors index](index.md) + + + +The file must be downloaded from a [CDN DC](https://core.telegram.org/cdn). + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|dc\_id|[int](../types/int.md) | Yes|[CDN DC](https://core.telegram.org/cdn) ID| +|file\_token|[bytes](../types/bytes.md) | Yes|File token (see [CDN files](https://core.telegram.org/cdn)| +|encryption\_key|[bytes](../types/bytes.md) | Yes|Encryption key (see [CDN files](https://core.telegram.org/cdn)| +|encryption\_iv|[bytes](../types/bytes.md) | Yes|Encryption IV (see [CDN files](https://core.telegram.org/cdn)| +|file\_hashes|Array of [FileHash](../types/FileHash.md) | Yes|File hashes| + + + +### Type: [upload.File](../types/upload.File.md) + + +### Example: + +```php +$upload.fileCdnRedirect = ['_' => 'upload.fileCdnRedirect', 'dc_id' => int, 'file_token' => 'bytes', 'encryption_key' => 'bytes', 'encryption_iv' => 'bytes', 'file_hashes' => [FileHash, FileHash]]; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/upload.webFile.md b/old_docs/API_docs_v109/constructors/upload.webFile.md new file mode 100644 index 00000000..1b7f90ca --- /dev/null +++ b/old_docs/API_docs_v109/constructors/upload.webFile.md @@ -0,0 +1,43 @@ +--- +title: upload.webFile +description: Represents a chunk of an [HTTP webfile](https://core.telegram.org/api/files) downloaded through telegram's secure MTProto servers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/constructors/upload_webFile.html +--- +# Constructor: upload.webFile +[Back to constructors index](index.md) + + + +Represents a chunk of an [HTTP webfile](https://core.telegram.org/api/files) downloaded through telegram's secure MTProto servers + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|size|[int](../types/int.md) | Yes|File size| +|mime\_type|[string](../types/string.md) | Yes|Mime type| +|file\_type|[storage.FileType](../constructors/storage.FileType.md) | Yes|File type| +|mtime|[int](../types/int.md) | Yes|Modified time| +|bytes|[bytes](../types/bytes.md) | Yes|Data| + + + +### Type: [upload.WebFile](../types/upload.WebFile.md) + + +### Example: + +```php +$upload.webFile = ['_' => 'upload.webFile', 'size' => int, 'mime_type' => 'string', 'file_type' => storage.FileType, 'mtime' => int, 'bytes' => 'bytes']; +``` + + +Or, if you're into Lua: + +```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_v109/constructors/urlAuthResultAccepted.md b/old_docs/API_docs_v109/constructors/urlAuthResultAccepted.md new file mode 100644 index 00000000..a634343a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/urlAuthResultAccepted.md @@ -0,0 +1,38 @@ +--- +title: urlAuthResultAccepted +description: Details about an accepted authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: urlAuthResultAccepted +[Back to constructors index](index.md) + + + +Details about an accepted authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|The URL name of the website on which the user has logged in.| + + + +### Type: [UrlAuthResult](../types/UrlAuthResult.md) + + +### Example: + +```php +$urlAuthResultAccepted = ['_' => 'urlAuthResultAccepted', 'url' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +urlAuthResultAccepted={_='urlAuthResultAccepted', url='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/urlAuthResultDefault.md b/old_docs/API_docs_v109/constructors/urlAuthResultDefault.md new file mode 100644 index 00000000..976d2da0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/urlAuthResultDefault.md @@ -0,0 +1,33 @@ +--- +title: urlAuthResultDefault +description: Details about an accepted authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: urlAuthResultDefault +[Back to constructors index](index.md) + + + +Details about an accepted authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) + + + + +### Type: [UrlAuthResult](../types/UrlAuthResult.md) + + +### Example: + +```php +$urlAuthResultDefault = ['_' => 'urlAuthResultDefault']; +``` + + +Or, if you're into Lua: + +```lua +urlAuthResultDefault={_='urlAuthResultDefault'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/urlAuthResultRequest.md b/old_docs/API_docs_v109/constructors/urlAuthResultRequest.md new file mode 100644 index 00000000..b14730da --- /dev/null +++ b/old_docs/API_docs_v109/constructors/urlAuthResultRequest.md @@ -0,0 +1,40 @@ +--- +title: urlAuthResultRequest +description: Details about the authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: urlAuthResultRequest +[Back to constructors index](index.md) + + + +Details about the authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|request\_write\_access|[Bool](../types/Bool.md) | Optional|Whether the bot would like to send messages to the user| +|bot|[User](../types/User.md) | Optional|Username of a bot, which will be used for user authorization. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See [Linking your domain to the bot](https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot) for more details.| +|domain|[string](../types/string.md) | Yes|The domain name of the website on which the user will log in.| + + + +### Type: [UrlAuthResult](../types/UrlAuthResult.md) + + +### Example: + +```php +$urlAuthResultRequest = ['_' => 'urlAuthResultRequest', 'request_write_access' => Bool, 'bot' => User, 'domain' => 'string']; +``` + + +Or, if you're into Lua: + +```lua +urlAuthResultRequest={_='urlAuthResultRequest', request_write_access=Bool, bot=User, domain='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/user.md b/old_docs/API_docs_v109/constructors/user.md new file mode 100644 index 00000000..5ccdb1ec --- /dev/null +++ b/old_docs/API_docs_v109/constructors/user.md @@ -0,0 +1,62 @@ +--- +title: user +description: Indicates info about a certain user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: user +[Back to constructors index](index.md) + + + +Indicates info about a certain user + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|self|[Bool](../types/Bool.md) | Optional|Whether this user indicates the currently logged in user| +|contact|[Bool](../types/Bool.md) | Optional|Whether this user is a contact| +|mutual\_contact|[Bool](../types/Bool.md) | Optional|Whether this user is a mutual contact| +|deleted|[Bool](../types/Bool.md) | Optional|Whether the account of this user was deleted| +|bot|[Bool](../types/Bool.md) | Optional|Is this user a bot?| +|bot\_chat\_history|[Bool](../types/Bool.md) | Optional|Can the bot see all messages in groups?| +|bot\_nochats|[Bool](../types/Bool.md) | Optional|Can the bot be added to groups?| +|verified|[Bool](../types/Bool.md) | Optional|Whether this user is verified| +|restricted|[Bool](../types/Bool.md) | Optional|Access to this user must be restricted for the reason specified in `restriction_reason`| +|min|[Bool](../types/Bool.md) | Optional|See [min](https://core.telegram.org/api/min)| +|bot\_inline\_geo|[Bool](../types/Bool.md) | Optional|Whether the bot can request our geolocation in inline mode| +|support|[Bool](../types/Bool.md) | Optional|Whether this is an official support user| +|scam|[Bool](../types/Bool.md) | Optional|This may be a scam user| +|id|[int](../types/int.md) | Yes|ID of the user| +|access\_hash|[long](../types/long.md) | Optional|Access hash of the user| +|first\_name|[string](../types/string.md) | Optional|First name| +|last\_name|[string](../types/string.md) | Optional|Last name| +|username|[string](../types/string.md) | Optional|Username| +|phone|[string](../types/string.md) | Optional|Phone number| +|photo|[UserProfilePhoto](../types/UserProfilePhoto.md) | Optional|Profile picture of user| +|status|[UserStatus](../types/UserStatus.md) | Optional|Online status of user| +|bot\_info\_version|[int](../types/int.md) | Optional|Version of the [bot\_info field in userFull](../constructors/userFull.md), incremented every time it changes| +|restriction\_reason|Array of [RestrictionReason](../types/RestrictionReason.md) | Optional|Restriction reason| +|bot\_inline\_placeholder|[string](../types/string.md) | Optional|Inline placeholder for this inline bot| +|lang\_code|[string](../types/string.md) | Optional|Language code of the user| + + + +### Type: [User](../types/User.md) + + +### Example: + +```php +$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, 'support' => Bool, 'scam' => 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' => [RestrictionReason, RestrictionReason], 'bot_inline_placeholder' => 'string', 'lang_code' => 'string']; +``` + + +Or, if you're into Lua: + +```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, support=Bool, scam=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={RestrictionReason}, bot_inline_placeholder='string', lang_code='string'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/userEmpty.md b/old_docs/API_docs_v109/constructors/userEmpty.md new file mode 100644 index 00000000..7b4e9044 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/userEmpty.md @@ -0,0 +1,38 @@ +--- +title: userEmpty +description: Empty constructor, non-existent user. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userEmpty +[Back to constructors index](index.md) + + + +Empty constructor, non-existent user. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[int](../types/int.md) | Yes|User identifier or `0`| + + + +### Type: [User](../types/User.md) + + +### Example: + +```php +$userEmpty = ['_' => 'userEmpty', 'id' => int]; +``` + + +Or, if you're into Lua: + +```lua +userEmpty={_='userEmpty', id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/userFull.md b/old_docs/API_docs_v109/constructors/userFull.md new file mode 100644 index 00000000..382a4717 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/userFull.md @@ -0,0 +1,51 @@ +--- +title: userFull +description: Extended user info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userFull +[Back to constructors index](index.md) + + + +Extended user info + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|blocked|[Bool](../types/Bool.md) | Optional|Whether you have blocked this user| +|phone\_calls\_available|[Bool](../types/Bool.md) | Optional|Whether this user can make VoIP calls| +|phone\_calls\_private|[Bool](../types/Bool.md) | Optional|Whether this user's privacy settings allow you to call him| +|can\_pin\_message|[Bool](../types/Bool.md) | Optional|Whether you can pin messages in the chat with this user, you can do this only for a chat with yourself| +|has\_scheduled|[Bool](../types/Bool.md) | Optional|Whether scheduled messages are available| +|user|[User](../types/User.md) | Optional|Remaining user info| +|about|[string](../types/string.md) | Optional|Bio of the user| +|settings|[PeerSettings](../types/PeerSettings.md) | Yes|Peer settings| +|profile\_photo|[Photo](../types/Photo.md) | Optional|Profile photo| +|notify\_settings|[PeerNotifySettings](../types/PeerNotifySettings.md) | Yes|Notification settings| +|bot\_info|[BotInfo](../types/BotInfo.md) | Optional|For bots, info about the bot (bot commands, etc)| +|pinned\_msg\_id|[int](../types/int.md) | Optional|Pinned message ID, you can only pin messages in a chat with yourself| +|common\_chats\_count|[int](../types/int.md) | Yes|Chats in common with this user| +|folder\_id|[int](../types/int.md) | Optional|Folder ID| + + + +### Type: [UserFull](../types/UserFull.md) + + +### Example: + +```php +$userFull = ['_' => 'userFull', 'blocked' => Bool, 'phone_calls_available' => Bool, 'phone_calls_private' => Bool, 'can_pin_message' => Bool, 'has_scheduled' => Bool, 'user' => User, 'about' => 'string', 'settings' => PeerSettings, 'profile_photo' => Photo, 'notify_settings' => PeerNotifySettings, 'bot_info' => BotInfo, 'pinned_msg_id' => int, 'common_chats_count' => int, 'folder_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +userFull={_='userFull', blocked=Bool, phone_calls_available=Bool, phone_calls_private=Bool, can_pin_message=Bool, has_scheduled=Bool, user=User, about='string', settings=PeerSettings, profile_photo=Photo, notify_settings=PeerNotifySettings, bot_info=BotInfo, pinned_msg_id=int, common_chats_count=int, folder_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/userProfilePhoto.md b/old_docs/API_docs_v109/constructors/userProfilePhoto.md new file mode 100644 index 00000000..24ffd190 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/userProfilePhoto.md @@ -0,0 +1,41 @@ +--- +title: userProfilePhoto +description: User profile photo. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userProfilePhoto +[Back to constructors index](index.md) + + + +User profile photo. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|photo\_id|[long](../types/long.md) | Yes|Identifier of the respective photo
Parameter added in [Layer 2](https://core.telegram.org/api/layers#layer-2)| +|photo\_small|[FileLocation](../types/FileLocation.md) | Yes|Location of the file, corresponding to the small profile photo thumbnail| +|photo\_big|[FileLocation](../types/FileLocation.md) | Yes|Location of the file, corresponding to the big profile photo thumbnail| +|dc\_id|[int](../types/int.md) | Yes|DC ID where the photo is stored| + + + +### Type: [UserProfilePhoto](../types/UserProfilePhoto.md) + + +### Example: + +```php +$userProfilePhoto = ['_' => 'userProfilePhoto', 'photo_id' => long, 'photo_small' => FileLocation, 'photo_big' => FileLocation, 'dc_id' => int]; +``` + + +Or, if you're into Lua: + +```lua +userProfilePhoto={_='userProfilePhoto', photo_id=long, photo_small=FileLocation, photo_big=FileLocation, dc_id=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/userProfilePhotoEmpty.md b/old_docs/API_docs_v109/constructors/userProfilePhotoEmpty.md new file mode 100644 index 00000000..36b61b7b --- /dev/null +++ b/old_docs/API_docs_v109/constructors/userProfilePhotoEmpty.md @@ -0,0 +1,33 @@ +--- +title: userProfilePhotoEmpty +description: Profile photo has not been set, or was hidden. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userProfilePhotoEmpty +[Back to constructors index](index.md) + + + +Profile photo has not been set, or was hidden. + + + + +### Type: [UserProfilePhoto](../types/UserProfilePhoto.md) + + +### Example: + +```php +$userProfilePhotoEmpty = ['_' => 'userProfilePhotoEmpty']; +``` + + +Or, if you're into Lua: + +```lua +userProfilePhotoEmpty={_='userProfilePhotoEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/userStatusEmpty.md b/old_docs/API_docs_v109/constructors/userStatusEmpty.md new file mode 100644 index 00000000..5633eaf0 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/userStatusEmpty.md @@ -0,0 +1,33 @@ +--- +title: userStatusEmpty +description: User status has not been set yet. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusEmpty +[Back to constructors index](index.md) + + + +User status has not been set yet. + + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +```php +$userStatusEmpty = ['_' => 'userStatusEmpty']; +``` + + +Or, if you're into Lua: + +```lua +userStatusEmpty={_='userStatusEmpty'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/userStatusLastMonth.md b/old_docs/API_docs_v109/constructors/userStatusLastMonth.md new file mode 100644 index 00000000..50da248f --- /dev/null +++ b/old_docs/API_docs_v109/constructors/userStatusLastMonth.md @@ -0,0 +1,33 @@ +--- +title: userStatusLastMonth +description: Online status: last seen last month +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusLastMonth +[Back to constructors index](index.md) + + + +Online status: last seen last month + + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +```php +$userStatusLastMonth = ['_' => 'userStatusLastMonth']; +``` + + +Or, if you're into Lua: + +```lua +userStatusLastMonth={_='userStatusLastMonth'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/userStatusLastWeek.md b/old_docs/API_docs_v109/constructors/userStatusLastWeek.md new file mode 100644 index 00000000..b2de898d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/userStatusLastWeek.md @@ -0,0 +1,33 @@ +--- +title: userStatusLastWeek +description: Online status: last seen last week +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusLastWeek +[Back to constructors index](index.md) + + + +Online status: last seen last week + + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +```php +$userStatusLastWeek = ['_' => 'userStatusLastWeek']; +``` + + +Or, if you're into Lua: + +```lua +userStatusLastWeek={_='userStatusLastWeek'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/userStatusOffline.md b/old_docs/API_docs_v109/constructors/userStatusOffline.md new file mode 100644 index 00000000..d0de96c9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/userStatusOffline.md @@ -0,0 +1,38 @@ +--- +title: userStatusOffline +description: The user's offline status. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusOffline +[Back to constructors index](index.md) + + + +The user's offline status. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|was\_online|[int](../types/int.md) | Yes|Time the user was last seen online| + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +```php +$userStatusOffline = ['_' => 'userStatusOffline', 'was_online' => int]; +``` + + +Or, if you're into Lua: + +```lua +userStatusOffline={_='userStatusOffline', was_online=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/userStatusOnline.md b/old_docs/API_docs_v109/constructors/userStatusOnline.md new file mode 100644 index 00000000..361a0a5a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/userStatusOnline.md @@ -0,0 +1,38 @@ +--- +title: userStatusOnline +description: Online status of the user. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusOnline +[Back to constructors index](index.md) + + + +Online status of the user. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|expires|[int](../types/int.md) | Yes|Time to expiration of the current online status| + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +```php +$userStatusOnline = ['_' => 'userStatusOnline', 'expires' => int]; +``` + + +Or, if you're into Lua: + +```lua +userStatusOnline={_='userStatusOnline', expires=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/userStatusRecently.md b/old_docs/API_docs_v109/constructors/userStatusRecently.md new file mode 100644 index 00000000..d740bd77 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/userStatusRecently.md @@ -0,0 +1,33 @@ +--- +title: userStatusRecently +description: Online status: last seen recently +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: userStatusRecently +[Back to constructors index](index.md) + + + +Online status: last seen recently + + + + +### Type: [UserStatus](../types/UserStatus.md) + + +### Example: + +```php +$userStatusRecently = ['_' => 'userStatusRecently']; +``` + + +Or, if you're into Lua: + +```lua +userStatusRecently={_='userStatusRecently'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/wallPaper.md b/old_docs/API_docs_v109/constructors/wallPaper.md new file mode 100644 index 00000000..ae8adbb9 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/wallPaper.md @@ -0,0 +1,46 @@ +--- +title: wallPaper +description: Wallpaper settings. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: wallPaper +[Back to constructors index](index.md) + + + +Wallpaper settings. + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Identifier| +|creator|[Bool](../types/Bool.md) | Optional|Creator of the wallpaper| +|default|[Bool](../types/Bool.md) | Optional|Whether this is the default wallpaper| +|pattern|[Bool](../types/Bool.md) | Optional|Pattern| +|dark|[Bool](../types/Bool.md) | Optional|Dark mode| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|slug|[string](../types/string.md) | Yes|Unique wallpaper ID| +|document|[Document](../types/Document.md) | Optional|The actual wallpaper| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional|Wallpaper settings| + + + +### Type: [WallPaper](../types/WallPaper.md) + + +### Example: + +```php +$wallPaper = ['_' => 'wallPaper', 'id' => long, 'creator' => Bool, 'default' => Bool, 'pattern' => Bool, 'dark' => Bool, 'access_hash' => long, 'slug' => 'string', 'document' => Document, 'settings' => WallPaperSettings]; +``` + + +Or, if you're into Lua: + +```lua +wallPaper={_='wallPaper', id=long, creator=Bool, default=Bool, pattern=Bool, dark=Bool, access_hash=long, slug='string', document=Document, settings=WallPaperSettings} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/wallPaperNoFile.md b/old_docs/API_docs_v109/constructors/wallPaperNoFile.md new file mode 100644 index 00000000..8caaf1dd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/wallPaperNoFile.md @@ -0,0 +1,38 @@ +--- +title: wallPaperNoFile +description: wallPaperNoFile attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: wallPaperNoFile +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|default|[Bool](../types/Bool.md) | Optional| +|dark|[Bool](../types/Bool.md) | Optional| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Optional| + + + +### Type: [WallPaper](../types/WallPaper.md) + + +### Example: + +```php +$wallPaperNoFile = ['_' => 'wallPaperNoFile', 'default' => Bool, 'dark' => Bool, 'settings' => WallPaperSettings]; +``` + + +Or, if you're into Lua: + +```lua +wallPaperNoFile={_='wallPaperNoFile', default=Bool, dark=Bool, settings=WallPaperSettings} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/wallPaperSettings.md b/old_docs/API_docs_v109/constructors/wallPaperSettings.md new file mode 100644 index 00000000..0e4362f1 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/wallPaperSettings.md @@ -0,0 +1,43 @@ +--- +title: wallPaperSettings +description: Wallpaper settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: wallPaperSettings +[Back to constructors index](index.md) + + + +Wallpaper settings + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|blur|[Bool](../types/Bool.md) | Optional|If set, the wallpaper must be downscaled to fit in 450x450 square and then box-blurred with radius 12| +|motion|[Bool](../types/Bool.md) | Optional|If set, the background needs to be slightly moved when device is rotated| +|background\_color|[int](../types/int.md) | Optional|If set, a PNG pattern is to be combined with the `color` chosen by the user: the main color of the background in RGB24 format| +|second\_background\_color|[int](../types/int.md) | Optional|| +|intensity|[int](../types/int.md) | Optional|Intensity of the pattern when it is shown above the main background color, 0-100| +|rotation|[int](../types/int.md) | Optional|| + + + +### Type: [WallPaperSettings](../types/WallPaperSettings.md) + + +### Example: + +```php +$wallPaperSettings = ['_' => 'wallPaperSettings', 'blur' => Bool, 'motion' => Bool, 'background_color' => int, 'second_background_color' => int, 'intensity' => int, 'rotation' => int]; +``` + + +Or, if you're into Lua: + +```lua +wallPaperSettings={_='wallPaperSettings', blur=Bool, motion=Bool, background_color=int, second_background_color=int, intensity=int, rotation=int} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/webAuthorization.md b/old_docs/API_docs_v109/constructors/webAuthorization.md new file mode 100644 index 00000000..107b1fcd --- /dev/null +++ b/old_docs/API_docs_v109/constructors/webAuthorization.md @@ -0,0 +1,46 @@ +--- +title: webAuthorization +description: Represents a bot logged in using the [Telegram login widget](https://core.telegram.org/widgets/login) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webAuthorization +[Back to constructors index](index.md) + + + +Represents a bot logged in using the [Telegram login widget](https://core.telegram.org/widgets/login) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[long](../types/long.md) | Yes|Authorization hash| +|bot\_id|[int](../types/int.md) | Yes|Bot ID| +|domain|[string](../types/string.md) | Yes|The domain name of the website on which the user has logged in.| +|browser|[string](../types/string.md) | Yes|Browser user-agent| +|platform|[string](../types/string.md) | Yes|Platform| +|date\_created|[int](../types/int.md) | Yes|When was the web session created| +|date\_active|[int](../types/int.md) | Yes|When was the web session last active| +|ip|[string](../types/string.md) | Yes|IP address| +|region|[string](../types/string.md) | Yes|Region, determined from IP address| + + + +### Type: [WebAuthorization](../types/WebAuthorization.md) + + +### Example: + +```php +$webAuthorization = ['_' => '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: + +```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_v109/constructors/webDocument.md b/old_docs/API_docs_v109/constructors/webDocument.md new file mode 100644 index 00000000..b8c3ed19 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/webDocument.md @@ -0,0 +1,42 @@ +--- +title: webDocument +description: Remote document +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webDocument +[Back to constructors index](index.md) + + + +Remote document + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Document URL| +|access\_hash|[long](../types/long.md) | Yes|Access hash| +|size|[int](../types/int.md) | Yes|File size| +|mime\_type|[string](../types/string.md) | Yes|MIME type| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes| + + + +### Type: [WebDocument](../types/WebDocument.md) + + +### Example: + +```php +$webDocument = ['_' => 'webDocument', 'url' => 'string', 'access_hash' => long, 'size' => int, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute]]; +``` + + +Or, if you're into Lua: + +```lua +webDocument={_='webDocument', url='string', access_hash=long, size=int, mime_type='string', attributes={DocumentAttribute}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/webDocumentNoProxy.md b/old_docs/API_docs_v109/constructors/webDocumentNoProxy.md new file mode 100644 index 00000000..be071bc7 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/webDocumentNoProxy.md @@ -0,0 +1,41 @@ +--- +title: webDocumentNoProxy +description: Remote document that can be downloaded without [proxying through telegram](https://core.telegram.org/api/files) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webDocumentNoProxy +[Back to constructors index](index.md) + + + +Remote document that can be downloaded without [proxying through telegram](https://core.telegram.org/api/files) + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[string](../types/string.md) | Yes|Document URL| +|size|[int](../types/int.md) | Yes|File size| +|mime\_type|[string](../types/string.md) | Yes|MIME type| +|attributes|Array of [DocumentAttribute](../types/DocumentAttribute.md) | Yes|Attributes| + + + +### Type: [WebDocument](../types/WebDocument.md) + + +### Example: + +```php +$webDocumentNoProxy = ['_' => 'webDocumentNoProxy', 'url' => 'string', 'size' => int, 'mime_type' => 'string', 'attributes' => [DocumentAttribute, DocumentAttribute]]; +``` + + +Or, if you're into Lua: + +```lua +webDocumentNoProxy={_='webDocumentNoProxy', url='string', size=int, mime_type='string', attributes={DocumentAttribute}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/webPage.md b/old_docs/API_docs_v109/constructors/webPage.md new file mode 100644 index 00000000..5b68d56d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/webPage.md @@ -0,0 +1,55 @@ +--- +title: webPage +description: Webpage preview +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPage +[Back to constructors index](index.md) + + + +Webpage preview + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Preview ID| +|url|[string](../types/string.md) | Yes|URL of previewed webpage| +|display\_url|[string](../types/string.md) | Yes|Webpage URL to be displayed to the user| +|hash|[int](../types/int.md) | Yes|[Hash for pagination, for more info click here](https://core.telegram.org/api/offsets#hash-generation)| +|type|[string](../types/string.md) | Optional|Type of the web page. Can be: article, photo, audio, video, document, profile, app, or something else| +|site\_name|[string](../types/string.md) | Optional|Short name of the site (e.g., Google Docs, App Store)| +|title|[string](../types/string.md) | Optional|Title of the content| +|description|[string](../types/string.md) | Optional|Content description| +|photo|[Photo](../types/Photo.md) | Optional|Image representing the content| +|embed\_url|[string](../types/string.md) | Optional|URL to show in the embedded preview| +|embed\_type|[string](../types/string.md) | Optional|MIME type of the embedded preview, (e.g., text/html or video/mp4)| +|embed\_width|[int](../types/int.md) | Optional|Width of the embedded preview| +|embed\_height|[int](../types/int.md) | Optional|Height of the embedded preview| +|duration|[int](../types/int.md) | Optional|Duration of the content, in seconds| +|author|[string](../types/string.md) | Optional|Author of the content| +|document|[Document](../types/Document.md) | Optional|Preview of the content as a media file| +|cached\_page|[Page](../types/Page.md) | Optional|Page contents in [instant view](https://instantview.telegram.org) format| +|attributes|Array of [WebPageAttribute](../types/WebPageAttribute.md) | Optional|| + + + +### Type: [WebPage](../types/WebPage.md) + + +### Example: + +```php +$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, 'attributes' => [WebPageAttribute, WebPageAttribute]]; +``` + + +Or, if you're into Lua: + +```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, attributes={WebPageAttribute}} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/webPageAttributeTheme.md b/old_docs/API_docs_v109/constructors/webPageAttributeTheme.md new file mode 100644 index 00000000..60dc5361 --- /dev/null +++ b/old_docs/API_docs_v109/constructors/webPageAttributeTheme.md @@ -0,0 +1,37 @@ +--- +title: webPageAttributeTheme +description: webPageAttributeTheme attributes, type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPageAttributeTheme +[Back to constructors index](index.md) + + + +### Attributes: + +| Name | Type | Required | +|----------|---------------|----------| +|documents|Array of [Document](../types/Document.md) | Optional| +|settings|[ThemeSettings](../types/ThemeSettings.md) | Optional| + + + +### Type: [WebPageAttribute](../types/WebPageAttribute.md) + + +### Example: + +```php +$webPageAttributeTheme = ['_' => 'webPageAttributeTheme', 'documents' => [Document, Document], 'settings' => ThemeSettings]; +``` + + +Or, if you're into Lua: + +```lua +webPageAttributeTheme={_='webPageAttributeTheme', documents={Document}, settings=ThemeSettings} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/webPageEmpty.md b/old_docs/API_docs_v109/constructors/webPageEmpty.md new file mode 100644 index 00000000..fb1f370a --- /dev/null +++ b/old_docs/API_docs_v109/constructors/webPageEmpty.md @@ -0,0 +1,38 @@ +--- +title: webPageEmpty +description: No preview is available for the webpage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPageEmpty +[Back to constructors index](index.md) + + + +No preview is available for the webpage + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|Preview ID| + + + +### Type: [WebPage](../types/WebPage.md) + + +### Example: + +```php +$webPageEmpty = ['_' => 'webPageEmpty', 'id' => long]; +``` + + +Or, if you're into Lua: + +```lua +webPageEmpty={_='webPageEmpty', id=long} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/webPageNotModified.md b/old_docs/API_docs_v109/constructors/webPageNotModified.md new file mode 100644 index 00000000..1a6a7ebc --- /dev/null +++ b/old_docs/API_docs_v109/constructors/webPageNotModified.md @@ -0,0 +1,33 @@ +--- +title: webPageNotModified +description: The preview of the webpage hasn't changed +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPageNotModified +[Back to constructors index](index.md) + + + +The preview of the webpage hasn't changed + + + + +### Type: [WebPage](../types/WebPage.md) + + +### Example: + +```php +$webPageNotModified = ['_' => 'webPageNotModified']; +``` + + +Or, if you're into Lua: + +```lua +webPageNotModified={_='webPageNotModified'} + +``` + + diff --git a/old_docs/API_docs_v109/constructors/webPagePending.md b/old_docs/API_docs_v109/constructors/webPagePending.md new file mode 100644 index 00000000..b1fb171d --- /dev/null +++ b/old_docs/API_docs_v109/constructors/webPagePending.md @@ -0,0 +1,39 @@ +--- +title: webPagePending +description: A preview of the webpage is currently being generated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Constructor: webPagePending +[Back to constructors index](index.md) + + + +A preview of the webpage is currently being generated + +### Attributes: + +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[long](../types/long.md) | Yes|ID of preview| +|date|[int](../types/int.md) | Yes|When was the processing started| + + + +### Type: [WebPage](../types/WebPage.md) + + +### Example: + +```php +$webPagePending = ['_' => 'webPagePending', 'id' => long, 'date' => int]; +``` + + +Or, if you're into Lua: + +```lua +webPagePending={_='webPagePending', id=long, date=int} + +``` + + diff --git a/old_docs/API_docs_v109/methods/README.md b/old_docs/API_docs_v109/methods/README.md new file mode 100644 index 00000000..6a8ec62b --- /dev/null +++ b/old_docs/API_docs_v109/methods/README.md @@ -0,0 +1,668 @@ +--- +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) + +* [Change 2FA password](https://docs.madelineproto.xyz/update2fa.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/getPwrChat.html) + +* [Get full info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/getFullInfo.html) + +* [Get info about a user/chat/supergroup/channel](https://docs.madelineproto.xyz/getInfo.html) + +* [Get info about the currently logged-in user](https://docs.madelineproto.xyz/getSelf.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 the new terms of service: help.acceptTermsOfService + +* Add GIF to saved gifs list: messages.saveGif + +* Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot: stickers.addStickerToSet + +* Add an existing telegram user as contact: contacts.addContact + +* Add/remove sticker from recent stickers list: messages.saveRecentSticker + +* Adds a user to a chat and sends a service message on it: messages.addChatUser + +* Adds the user to the blacklist: contacts.block + +* Answer an inline query, for bots only: messages.setInlineBotResults + +* Answers a custom query; for bots only: bots.answerWebhookJSONQuery + +* Associate a group to a channel as discussion group for that channel: channels.setDiscussionGroup + +* Associate a stickerset to the supergroup: channels.setStickers + +* Ban/unban/kick a user in a supergroup/channel: channels.editBanned + +* Cancel the code that was sent to verify an email to use as 2FA recovery method: account.cancelPasswordEmail + +* Cancel the login verification code: auth.cancelCode + +* Chanages chat name and sends a service message on it: messages.editChatTitle + +* Change media autodownload settings: account.saveAutoDownloadSettings + +* Change privacy settings of current account: account.setPrivacy + +* Change the phone number of the current account: account.changePhone + +* Change the photo of a channel/supergroup: channels.editPhoto + +* Change the username of a supergroup/channel: channels.updateUsername + +* Changes chat photo and sends a service message on it: messages.editChatPhoto + +* Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot: stickers.changeStickerPosition + +* Changes username for the current user: account.updateUsername + +* Check if a username is free and can be assigned to a channel/supergroup: channels.checkUsername + +* Check the validity of a chat invite link and get basic info about it: messages.checkChatInvite + +* Clear all drafts: messages.clearAllDrafts + +* Clear recent stickers: messages.clearRecentStickers + +* Clear saved payment information: payments.clearSavedInfo + +* Confirm a phone number to cancel account deletion, for more info click here »: account.confirmPhone + +* Confirms receipt of messages by a client, cancels PUSH-notification sending: messages.receivedMessages + +* Create a supergroup/channel: channels.createChannel + +* Create a stickerset, bots only: stickers.createStickerSet + +* Create a theme: account.createTheme + +* Create and upload a new wallpaper: account.uploadWallPaper + +* Creates a new chat: messages.createChat + +* Delete a channel/supergroup: channels.deleteChannel + +* Delete a folder: folders.deleteFolder + +* Delete all messages sent by a certain user in a supergroup: channels.deleteUserHistory + +* Delete all temporary authorization keys except for the ones specified: auth.dropTempAuthKeys + +* Delete contacts by phone number: contacts.deleteByPhones + +* Delete installed wallpapers: account.resetWallPapers + +* Delete messages in a channel/supergroup: channels.deleteMessages + +* Delete saved contacts: contacts.resetSaved + +* Delete scheduled messages: messages.deleteScheduledMessages + +* Delete stored Telegram Passport documents, for more info see the passport docs »: account.deleteSecureValue + +* Delete the history of a supergroup: channels.deleteHistory + +* Delete the user's account from the telegram servers. Can be used, for example, to delete the account of a user that provided the login code, but forgot the 2FA password and no recovery method is configured: account.deleteAccount + +* Deletes a device by its token, stops sending PUSH-notifications to it: account.unregisterDevice + +* Deletes a user from a chat and sends a service message on it: messages.deleteChatUser + +* Deletes communication history: messages.deleteHistory + +* Deletes messages by their identifiers: messages.deleteMessages + +* Deletes profile photos: photos.deletePhotos + +* Deletes several contacts from the list: contacts.deleteContacts + +* Deletes the user from the blacklist: contacts.unblock + +* Edit an inline bot message: messages.editInlineBotMessage + +* Edit location of geogroup: channels.editLocation + +* Edit message: messages.editMessage + +* Edit peers in folder: folders.editPeerFolders + +* Edit the default banned rights of a channel/supergroup/group: messages.editChatDefaultBannedRights + +* Edit the description of a group/supergroup/channel: messages.editChatAbout + +* Edit the name of a channel/supergroup: channels.editTitle + +* Edits notification settings from a given user/group, from all users/all groups: account.updateNotifySettings + +* Enable/disable top peers: contacts.toggleTopPeers + +* Enable/disable message signatures in channels: channels.toggleSignatures + +* Export an invite link for a chat: messages.exportChatInvite + +* Find out if a media message's caption can be edited: messages.getMessageEditData + +* Finish account takeout session: account.finishTakeoutSession + +* Forwards messages by their IDs: messages.forwardMessages + +* Get channel/supergroup messages: channels.getMessages + +* Get channels/supergroups/geogroups we're admin in. Usually called when the user exceeds the limit for owned public channels/supergroups/geogroups, and the user is given the choice to remove one of his channels/supergroups/geogroups: channels.getAdminedPublicChannels + +* Get instant view page: messages.getWebPage + +* Get passport configuration: help.getPassportConfig + +* Get a document by its SHA256 hash, mainly used for gifs: messages.getDocumentByHash + +* Get a list of channels/supergroups we left: channels.getLeftChannels + +* Get a payment form: payments.getPaymentForm + +* Get all archived stickers: messages.getArchivedStickers + +* Get all chats, channels and supergroups: messages.getAllChats + +* Get all contacts: contacts.getSaved + +* Get all groups that can be used as discussion groups: channels.getGroupsForDiscussion + +* Get all installed stickers: messages.getAllStickers + +* Get all saved Telegram Passport documents, for more info see the passport docs »: account.getAllSecureValues + +* Get and increase the view counter of a message sent or forwarded from a channel: messages.getMessagesViews + +* Get app-specific configuration: help.getAppConfig + +* Get changed emoji keywords: messages.getEmojiKeywordsDifference + +* Get changelog of current app: help.getAppChangelog + +* Get chats in common with a user: messages.getCommonChats + +* Get configuration for CDN file downloads: help.getCdnConfig + +* Get contact by telegram IDs: contacts.getContactIDs + +* Get contacts near you: contacts.getLocated + +* Get count of online users in a chat: messages.getOnlines + +* Get days to live of account: account.getAccountTTL + +* Get dialog info of specified peers: messages.getPeerDialogs + +* Get dialogs manually marked as unread: messages.getDialogUnreadMarks + +* Get faved stickers: messages.getFavedStickers + +* Get featured stickers: messages.getFeaturedStickers + +* Get highscores of a game sent using an inline bot: messages.getInlineGameHighScores + +* Get highscores of a game: messages.getGameHighScores + +* Get info about channels/supergroups: channels.getChannels + +* Get info about a channel/supergroup participant: channels.getParticipant + +* Get info about a t.me link: help.getDeepLinkInfo + +* Get info about a certain wallpaper: account.getWallPaper + +* Get info about a stickerset: messages.getStickerSet + +* Get info about an emoji keyword localization: messages.getEmojiKeywordsLanguages + +* Get information about a language in a localization pack: langpack.getLanguage + +* Get information about all languages in a localization pack: langpack.getLanguages + +* Get installed mask stickers: messages.getMaskStickers + +* Get installed themes: account.getThemes + +* Get link and embed info of a message in a channel/supergroup: channels.exportMessageLink + +* Get live location history of a certain user: messages.getRecentLocations + +* Get localization pack strings: langpack.getLangPack + +* Get localized emoji keywords: messages.getEmojiKeywords + +* Get localized name of the telegram support user: help.getSupportName + +* Get logged-in sessions: account.getAuthorizations + +* Get media autodownload settings: account.getAutoDownloadSettings + +* Get message ranges for saving the user's chat history: messages.getSplitRanges + +* Get more info about a Seamless Telegram Login authorization request, for more info click here »: messages.requestUrlAuth + +* Get most used peers: contacts.getTopPeers + +* Get new strings in languagepack: langpack.getDifference + +* Get payment receipt: payments.getPaymentReceipt + +* Get peer settings: messages.getPeerSettings + +* Get phone call configuration to be passed to libtgvoip's shared config: phone.getCallConfig + +* Get pinned dialogs: messages.getPinnedDialogs + +* Get poll results: messages.getPollResults + +* Get preview of webpage: messages.getWebPagePreview + +* Get privacy settings of current account: account.getPrivacy + +* Get promotion info of the currently-used MTProxy: help.getProxyData + +* Get recent stickers: messages.getRecentStickers + +* Get recently used t.me links: help.getRecentMeUrls + +* Get saved GIFs: messages.getSavedGifs + +* Get saved Telegram Passport document, for more info see the passport docs »: account.getSecureValue + +* Get saved payment information: payments.getSavedInfo + +* Get scheduled messages: messages.getScheduledHistory + +* Get scheduled messages: messages.getScheduledMessages + +* Get stickers attached to a photo or video: messages.getAttachedStickers + +* Get stickers by emoji: messages.getStickers + +* Get strings from a language pack: langpack.getStrings + +* Get temporary payment password: account.getTmpPassword + +* Get the admin log of a channel/supergroup: channels.getAdminLog + +* Get the number of results that would be found by a messages.search call with the same parameters: messages.getSearchCounters + +* Get the participants of a channel: channels.getParticipants + +* Get theme information: account.getTheme + +* Get unread messages where we were mentioned: messages.getUnreadMentions + +* Get web login widget authorizations: account.getWebAuthorizations + +* Gets back found messages: messages.search + +* Gets back the conversation history with one interlocutor / within a chat: messages.getHistory + +* Gets current notification settings for a given user/group, from all users/all groups: account.getNotifySettings + +* Hide/unhide message history for new channel/supergroup users: channels.togglePreHistoryHidden + +* If the peer settings of a new user allow us to add him as contact, add that user as contact: contacts.acceptContact + +* If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the bot will receive an updateBotShippingQuery update. Use this method to reply to shipping queries: messages.setBotShippingResults + +* Import a chat invite and join a private chat/supergroup/channel: messages.importChatInvite + +* Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info: contacts.importContacts + +* Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only: help.setBotUpdatesStatus + +* Initialize connection: initConnection + +* Install a stickerset: messages.installStickerSet + +* Install a theme: account.installTheme + +* Install wallpaper: account.installWallPaper + +* Install/uninstall wallpaper: account.saveWallPaper + +* Installs a previously uploaded photo as a profile photo: photos.updateProfilePhoto + +* Internal use: help.editUserInfo + +* Internal use: help.getUserInfo + +* Intialize account takeout session: account.initTakeoutSession + +* Invite users to a channel/supergroup: channels.inviteToChannel + +* Invoke a method within a takeout session: invokeWithTakeout + +* Invoke a request without subscribing the used connection for updates (this is enabled by default for file queries): invokeWithoutUpdates + +* Invoke the specified query using the specified API layer: invokeWithLayer + +* Invoke with the given message range: invokeWithMessagesRange + +* Invokes a query after a successfull completion of previous queries: invokeAfterMsgs + +* Invokes a query after successfull completion of one of the previous queries: invokeAfterMsg + +* Join a channel/supergroup: channels.joinChannel + +* Leave a channel/supergroup: channels.leaveChannel + +* Log out an active authorized session by its hash: account.resetAuthorization + +* Log out an active web telegram login session: account.resetWebAuthorization + +* Look for updates of telegram's terms of service: help.getTermsOfServiceUpdate + +* Make a user admin in a legacy group: messages.editChatAdmin + +* Manually mark dialog as unread: messages.markDialogUnread + +* Mark channel/supergroup history as read: channels.readHistory + +* Mark channel/supergroup message contents as read: channels.readMessageContents + +* Mark a sticker as favorite: messages.faveSticker + +* Mark mentions as read: messages.readMentions + +* Mark new featured stickers as read: messages.readFeaturedStickers + +* Marks message history as read: messages.readHistory + +* Marks message history within a secret chat as read: messages.readEncryptedHistory + +* Modify the admin rights of a user in a supergroup/channel: channels.editAdmin + +* Notifies the sender about the recipient having listened a voice message or watched a video: messages.readMessageContents + +* Notify the other user in a private chat that a screenshot of the chat was taken: messages.sendScreenshotNotification + +* Notify the user that the sent passport data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change): users.setSecureValueErrors + +* Obtain configuration for two-factor authorization with password: account.getPassword + +* Once the user has confirmed their payment and shipping details, the bot receives an updateBotPrecheckoutQuery update. : messages.setBotPrecheckoutResults + +* Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended: phone.receivedCall + +* Pin a message: messages.updatePinnedMessage + +* Pin/unpin a dialog: messages.toggleDialogPin + +* Press an inline callback button and get a callback answer from the bot: messages.getBotCallbackAnswer + +* Query an inline bot: messages.getInlineBotResults + +* Rate a call: phone.setCallRating + +* Register device to receive PUSH notifications: account.registerDevice + +* Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot: stickers.removeStickerFromSet + +* Reorder installed stickersets: messages.reorderStickerSets + +* Reorder pinned dialogs: messages.reorderPinnedDialogs + +* Report a message in a chat for violation of telegram's Terms of Service: messages.report + +* Report a new incoming chat for spam, if the peer settings of the chat allow us to do that: messages.reportSpam + +* Report a peer for violation of telegram's Terms of Service: account.reportPeer + +* Report a secret chat for spam: messages.reportEncryptedSpam + +* Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup: channels.reportSpam + +* Request recovery code of a 2FA password, only for accounts with a recovery email configured: auth.requestPasswordRecovery + +* Resend the code to verify an email to use as 2FA recovery method: account.resendPasswordEmail + +* Resend the login code via another medium, the phone code type is determined by the return value of the previous auth.sendCode/auth.resendCode: see login for more info: auth.resendCode + +* Reset rating of top peer: contacts.resetTopPeerRating + +* Reset all active web telegram login sessions: account.resetWebAuthorizations + +* Reset the 2FA password using the recovery code sent using auth.requestPasswordRecovery: auth.recoverPassword + +* Resets all notification settings from users and groups: account.resetNotifySettings + +* Returns URL with the chat statistics. Currently this method can be used only for channels: messages.getStatsURL + +* Returns a Telegram Passport authorization form for sharing data with a service: account.getAuthorizationForm + +* Returns a list of available wallpapers: account.getWallPapers + +* Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation: messages.getEmojiURL + +* Returns basic user info according to their identifiers: users.getUsers + +* Returns chat basic info on their IDs: messages.getChats + +* Returns content of an HTTP file or a part, by proxying the request through telegram: upload.getWebFile + +* Returns current configuration, icluding data center configuration: help.getConfig + +* Returns info on data centre nearest to the user: help.getNearestDc + +* Returns information on update availability for the current application: help.getAppUpdate + +* Returns list of chats with non-default notification settings: account.getNotifyExceptions + +* Returns text of a text message with an invitation: help.getInviteText + +* Returns the current user dialog list: messages.getDialogs + +* Returns the current user's contact list: contacts.getContacts + +* Returns the list of blocked users: contacts.getBlocked + +* Returns the list of contact statuses: contacts.getStatuses + +* Returns the list of messages by their IDs: messages.getMessages + +* Returns the list of user photos: photos.getUserPhotos + +* Returns the support user for the 'ask a question' feature: help.getSupport + +* Returns users found by username substring: contacts.search + +* Save a message draft associated to a chat: messages.saveDraft + +* Save a theme: account.saveTheme + +* Save get all message drafts: messages.getAllDrafts + +* Saves logs of application on the server: help.saveAppLog + +* Search for GIFs: messages.searchGifs + +* Search for messages and peers globally: messages.searchGlobal + +* Search for stickersets: messages.searchStickerSets + +* Securely save Telegram Passport document, for more info see the passport docs »: account.saveSecureValue + +* Send a media: messages.sendMedia + +* Send a result obtained using messages.getInlineBotResults: messages.sendInlineBotResult + +* Send an album of media: messages.sendMultiMedia + +* Send compiled payment form: payments.sendPaymentForm + +* Send confirmation code to cancel account deletion, for more info click here »: account.sendConfirmPhoneCode + +* Send phone call debug data to server: phone.saveCallDebug + +* Send scheduled messages right away: messages.sendScheduledMessages + +* Send the verification email code for telegram passport: account.sendVerifyEmailCode + +* Send the verification phone code for telegram passport: account.sendVerifyPhoneCode + +* Send typing event by the current user to a secret chat: messages.setEncryptedTyping + +* Sends a Telegram Passport authorization form, effectively sharing data with the service: account.acceptAuthorization + +* Sends a current user typing event (see SendMessageAction for all event types) to a conversation partner or group: messages.setTyping + +* Sends a custom request; for bots only: bots.sendCustomRequest + +* Sends a message to a chat: messages.sendMessage + +* Sends a message with a file attachment to a secret chat: messages.sendEncryptedFile + +* Sends a service message to a secret chat: messages.sendEncryptedService + +* Sends a text message to a secret chat: messages.sendEncrypted + +* Set account self-destruction period: account.setAccountTTL + +* Set the callback answer to a user button press (bots only): messages.setBotCallbackAnswer + +* Should be called after the user hides the report spam/add as contact bar of a new chat, effectively prevents the user from executing the actions specified in the peer's settings: messages.hidePeerSettingsBar + +* Start a conversation with a bot using a deep linking parameter: messages.startBot + +* Submit requested order information for validation: payments.validateRequestedInfo + +* Terminates all user's authorized sessions except for the current one: auth.resetAuthorizations + +* Toggle contact sign up notifications: account.setContactSignUpNotification + +* Toggle supergroup slow mode: if enabled, users will only be able to send one message every seconds seconds: channels.toggleSlowMode + +* Transfer channel ownership: channels.editCreator + +* Turn a legacy group into a supergroup: messages.migrateChat + +* Uninstall a stickerset: messages.uninstallStickerSet + +* Update theme: account.updateTheme + +* Updates current user profile photo: photos.uploadProfilePhoto + +* Updates online user status: account.updateStatus + +* Updates user profile: account.updateProfile + +* Upload a file and associate it to a chat (without actually sending it to the chat): messages.uploadMedia + +* Upload encrypted file and associate it to a secret chat: messages.uploadEncryptedFile + +* Upload theme: account.uploadTheme + +* Use this method to set the score of the specified user in a game sent as a normal message (bots only): messages.setGameScore + +* Use this method to set the score of the specified user in a game sent as an inline message (bots only): messages.setInlineGameScore + +* Use this to accept a Seamless Telegram Login authorization request, for more info click here »: messages.acceptUrlAuth + +* Validates a username and checks availability: account.checkUsername + +* Verify a new phone number to associate to the current account: account.sendChangePhoneCode + +* Verify a phone number for telegram passport: account.verifyPhone + +* Verify an email address for telegram passport: account.verifyEmail + +* Verify an email to use as 2FA recovery method: account.confirmPasswordEmail + +* Vote in a poll: messages.sendVote + +* When client-side passcode lock feature is enabled, will not show message texts in incoming PUSH notifications: account.updateDeviceLocked + +* Whether the user will receive notifications when contacts sign up: account.getContactSignUpNotification + +* 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: auth.bindTempAuthKey + +* You cannot use this method directly, instead use $MadelineProto->getDhConfig();: messages.getDhConfig + +* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats: messages.acceptEncryption + +* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats: messages.discardEncryption + +* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats: messages.requestEncryption + +* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates: updates.getChannelDifference + +* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates: updates.getDifference + +* You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates: updates.getState + +* You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls: phone.acceptCall + +* You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls: phone.confirmCall + +* You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls: phone.discardCall + +* You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls: phone.requestCall + +* You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html: auth.exportAuthorization + +* You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html: auth.importAuthorization + +* You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info): auth.importBotAuthorization + +* You cannot use this method directly, use the complete2falogin method instead (see https://docs.madelineproto.xyz for more info): auth.checkPassword + +* You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info): auth.signIn + +* You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info): auth.signUp + +* You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info): channels.getFullChannel + +* You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info): messages.getFullChat + +* You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info): users.getFullUser + +* You cannot use this method directly, use the logout method instead (see https://docs.madelineproto.xyz for more info): auth.logOut + +* You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info): auth.sendCode + +* You cannot use this method directly, use the resolveUsername, getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info): contacts.resolveUsername + +* You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.getCdnFile + +* You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.getCdnFileHashes + +* You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.getFile + +* You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.getFileHashes + +* You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.reuploadCdnFile + +* You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.saveBigFilePart + +* You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info: upload.saveFilePart + +* You cannot use this method directly: messages.receivedQueue + +* You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info): account.getPasswordSettings + +* You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info): account.updatePasswordSettings + diff --git a/old_docs/API_docs_v109/methods/account.acceptAuthorization.md b/old_docs/API_docs_v109/methods/account.acceptAuthorization.md new file mode 100644 index 00000000..dbfd7c99 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.acceptAuthorization.md @@ -0,0 +1,49 @@ +--- +title: account.acceptAuthorization +description: Sends a Telegram Passport authorization form, effectively sharing data with the service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_acceptAuthorization.html +--- +# Method: account.acceptAuthorization +[Back to methods index](index.md) + + +Sends a Telegram Passport authorization form, effectively sharing data with the service + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot\_id|[int](../types/int.md) | Bot ID | Yes| +|scope|[string](../types/string.md) | Telegram Passport element types requested by the service | Yes| +|public\_key|[string](../types/string.md) | Service's public key | Yes| +|value\_hashes|Array of [SecureValueHash](../types/SecureValueHash.md) | Hashes of the encrypted credentials | Yes| +|credentials|[SecureCredentialsEncrypted](../types/SecureCredentialsEncrypted.md) | Encrypted values | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.acceptAuthorization({bot_id=int, scope='string', public_key='string', value_hashes={SecureValueHash}, credentials=SecureCredentialsEncrypted, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.cancelPasswordEmail.md b/old_docs/API_docs_v109/methods/account.cancelPasswordEmail.md new file mode 100644 index 00000000..d3f4ee9b --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.cancelPasswordEmail.md @@ -0,0 +1,40 @@ +--- +title: account.cancelPasswordEmail +description: Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_cancelPasswordEmail.html +--- +# Method: account.cancelPasswordEmail +[Back to methods index](index.md) + + +Cancel the code that was sent to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->cancelPasswordEmail(); +``` + +Or, if you're into Lua: + +```lua +Bool = account.cancelPasswordEmail({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.changePhone.md b/old_docs/API_docs_v109/methods/account.changePhone.md new file mode 100644 index 00000000..873af1aa --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.changePhone.md @@ -0,0 +1,55 @@ +--- +title: account.changePhone +description: Change the phone number of the current account +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_changePhone.html +--- +# Method: account.changePhone +[Back to methods index](index.md) + + +Change the phone number of the current account + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code hash received when calling [account.sendChangePhoneCode](../methods/account.sendChangePhoneCode.md) | Yes| +|phone\_code|[string](../types/string.md) | Phone code received when calling [account.sendChangePhoneCode](../methods/account.sendChangePhoneCode.md) | Yes| + + +### Return type: [User](../types/User.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +User = account.changePhone({phone_number='string', phone_code_hash='string', phone_code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PHONE_CODE_EMPTY|phone_code is missing| +|400|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v109/methods/account.checkUsername.md b/old_docs/API_docs_v109/methods/account.checkUsername.md new file mode 100644 index 00000000..47f949af --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.checkUsername.md @@ -0,0 +1,53 @@ +--- +title: account.checkUsername +description: Validates a username and checks availability. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_checkUsername.html +--- +# Method: account.checkUsername +[Back to methods index](index.md) + + +Validates a username and checks availability. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|username|[string](../types/string.md) | Username
Accepted characters: A-z (case-insensitive), 0-9 and underscores.
Length: 5-32 characters. | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.checkUsername({username='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|USERNAME_INVALID|The provided username is not valid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| + + diff --git a/old_docs/API_docs_v109/methods/account.confirmPasswordEmail.md b/old_docs/API_docs_v109/methods/account.confirmPasswordEmail.md new file mode 100644 index 00000000..71997a6c --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.confirmPasswordEmail.md @@ -0,0 +1,53 @@ +--- +title: account.confirmPasswordEmail +description: Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_confirmPasswordEmail.html +--- +# Method: account.confirmPasswordEmail +[Back to methods index](index.md) + + +Verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|code|[string](../types/string.md) | The phone code that was received after [setting a recovery email](https://core.telegram.org/api/srp#email-verification) | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->confirmPasswordEmail(['code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.confirmPasswordEmail({code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CODE_INVALID|Code invalid| +|400|EMAIL_HASH_EXPIRED|Email hash expired| + + diff --git a/old_docs/API_docs_v109/methods/account.confirmPhone.md b/old_docs/API_docs_v109/methods/account.confirmPhone.md new file mode 100644 index 00000000..5ddf96ff --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.confirmPhone.md @@ -0,0 +1,54 @@ +--- +title: account.confirmPhone +description: Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_confirmPhone.html +--- +# Method: account.confirmPhone +[Back to methods index](index.md) + + +Confirm a phone number to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_code\_hash|[string](../types/string.md) | Phone code hash, for more info [click here »](https://core.telegram.org/api/account-deletion) | Yes| +|phone\_code|[string](../types/string.md) | SMS code, for more info [click here »](https://core.telegram.org/api/account-deletion) | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.confirmPhone({phone_code_hash='string', phone_code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CODE_HASH_INVALID|Code hash invalid| +|400|PHONE_CODE_EMPTY|phone_code is missing| + + diff --git a/old_docs/API_docs_v109/methods/account.createTheme.md b/old_docs/API_docs_v109/methods/account.createTheme.md new file mode 100644 index 00000000..e11ff1b4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.createTheme.md @@ -0,0 +1,48 @@ +--- +title: account.createTheme +description: Create a theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_createTheme.html +--- +# Method: account.createTheme +[Back to methods index](index.md) + + +Create a theme + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|slug|[string](../types/string.md) | Unique theme ID | Yes| +|title|[string](../types/string.md) | Theme name | Yes| +|document|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Theme file | Optional| +|settings|[InputThemeSettings](../types/InputThemeSettings.md) | | Optional| + + +### Return type: [Theme](../types/Theme.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$Theme = $MadelineProto->account->createTheme(['slug' => 'string', 'title' => 'string', 'document' => InputDocument, 'settings' => InputThemeSettings, ]); +``` + +Or, if you're into Lua: + +```lua +Theme = account.createTheme({slug='string', title='string', document=InputDocument, settings=InputThemeSettings, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.deleteAccount.md b/old_docs/API_docs_v109/methods/account.deleteAccount.md new file mode 100644 index 00000000..b432ea75 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.deleteAccount.md @@ -0,0 +1,45 @@ +--- +title: account.deleteAccount +description: Delete the user's account from the telegram servers. Can be used, for example, to delete the account of a user that provided the login code, but forgot the [2FA password and no recovery method is configured](https://core.telegram.org/api/srp). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_deleteAccount.html +--- +# Method: account.deleteAccount +[Back to methods index](index.md) + + +Delete the user's account from the telegram servers. Can be used, for example, to delete the account of a user that provided the login code, but forgot the [2FA password and no recovery method is configured](https://core.telegram.org/api/srp). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|reason|[string](../types/string.md) | Why is the account being deleted, can be empty | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.deleteAccount({reason='string', }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.deleteSecureValue.md b/old_docs/API_docs_v109/methods/account.deleteSecureValue.md new file mode 100644 index 00000000..d226d141 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.deleteSecureValue.md @@ -0,0 +1,45 @@ +--- +title: account.deleteSecureValue +description: Delete stored [Telegram Passport](https://core.telegram.org/passport) documents, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_deleteSecureValue.html +--- +# Method: account.deleteSecureValue +[Back to methods index](index.md) + + +Delete stored [Telegram Passport](https://core.telegram.org/passport) documents, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|types|Array of [SecureValueType](../types/SecureValueType.md) | The values to delete | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.deleteSecureValue({types={SecureValueType}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.finishTakeoutSession.md b/old_docs/API_docs_v109/methods/account.finishTakeoutSession.md new file mode 100644 index 00000000..781b6e85 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.finishTakeoutSession.md @@ -0,0 +1,52 @@ +--- +title: account.finishTakeoutSession +description: Finish account takeout session +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_finishTakeoutSession.html +--- +# Method: account.finishTakeoutSession +[Back to methods index](index.md) + + +Finish account takeout session + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Data exported successfully | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.finishTakeoutSession({success=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|403|TAKEOUT_REQUIRED|A takeout session has to be initialized, first| + + diff --git a/old_docs/API_docs_v109/methods/account.getAccountTTL.md b/old_docs/API_docs_v109/methods/account.getAccountTTL.md new file mode 100644 index 00000000..17d9a386 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getAccountTTL.md @@ -0,0 +1,40 @@ +--- +title: account.getAccountTTL +description: Get days to live of account +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getAccountTTL.html +--- +# Method: account.getAccountTTL +[Back to methods index](index.md) + + +Get days to live of account + + + +### Return type: [AccountDaysTTL](../types/AccountDaysTTL.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +AccountDaysTTL = account.getAccountTTL({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getAllSecureValues.md b/old_docs/API_docs_v109/methods/account.getAllSecureValues.md new file mode 100644 index 00000000..0857826a --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getAllSecureValues.md @@ -0,0 +1,40 @@ +--- +title: account.getAllSecureValues +description: Get all saved [Telegram Passport](https://core.telegram.org/passport) documents, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getAllSecureValues.html +--- +# Method: account.getAllSecureValues +[Back to methods index](index.md) + + +Get all saved [Telegram Passport](https://core.telegram.org/passport) documents, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) + + + +### Return type: [Vector\_of\_SecureValue](../types/SecureValue.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +Vector_of_SecureValue = account.getAllSecureValues({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getAuthorizationForm.md b/old_docs/API_docs_v109/methods/account.getAuthorizationForm.md new file mode 100644 index 00000000..89b8c9a2 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getAuthorizationForm.md @@ -0,0 +1,47 @@ +--- +title: account.getAuthorizationForm +description: Returns a Telegram Passport authorization form for sharing data with a service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getAuthorizationForm.html +--- +# Method: account.getAuthorizationForm +[Back to methods index](index.md) + + +Returns a Telegram Passport authorization form for sharing data with a service + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot\_id|[int](../types/int.md) | User identifier of the service's bot | Yes| +|scope|[string](../types/string.md) | Telegram Passport element types requested by the service | Yes| +|public\_key|[string](../types/string.md) | Service's public key | Yes| + + +### Return type: [account.AuthorizationForm](../types/account.AuthorizationForm.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +account.AuthorizationForm = account.getAuthorizationForm({bot_id=int, scope='string', public_key='string', }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getAuthorizations.md b/old_docs/API_docs_v109/methods/account.getAuthorizations.md new file mode 100644 index 00000000..e54e2f6b --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getAuthorizations.md @@ -0,0 +1,47 @@ +--- +title: account.getAuthorizations +description: Get logged-in sessions +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getAuthorizations.html +--- +# Method: account.getAuthorizations +[Back to methods index](index.md) + + +Get logged-in sessions + + + +### Return type: [account.Authorizations](../types/account.Authorizations.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +account.Authorizations = account.getAuthorizations({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v109/methods/account.getAutoDownloadSettings.md b/old_docs/API_docs_v109/methods/account.getAutoDownloadSettings.md new file mode 100644 index 00000000..ff4d3a6f --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getAutoDownloadSettings.md @@ -0,0 +1,40 @@ +--- +title: account.getAutoDownloadSettings +description: Get media autodownload settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getAutoDownloadSettings.html +--- +# Method: account.getAutoDownloadSettings +[Back to methods index](index.md) + + +Get media autodownload settings + + + +### Return type: [account.AutoDownloadSettings](../types/account.AutoDownloadSettings.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.AutoDownloadSettings = $MadelineProto->account->getAutoDownloadSettings(); +``` + +Or, if you're into Lua: + +```lua +account.AutoDownloadSettings = account.getAutoDownloadSettings({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getContactSignUpNotification.md b/old_docs/API_docs_v109/methods/account.getContactSignUpNotification.md new file mode 100644 index 00000000..900898a1 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getContactSignUpNotification.md @@ -0,0 +1,40 @@ +--- +title: account.getContactSignUpNotification +description: Whether the user will receive notifications when contacts sign up +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getContactSignUpNotification.html +--- +# Method: account.getContactSignUpNotification +[Back to methods index](index.md) + + +Whether the user will receive notifications when contacts sign up + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->getContactSignUpNotification(); +``` + +Or, if you're into Lua: + +```lua +Bool = account.getContactSignUpNotification({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getContentSettings.md b/old_docs/API_docs_v109/methods/account.getContentSettings.md new file mode 100644 index 00000000..d4d99ea9 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getContentSettings.md @@ -0,0 +1,38 @@ +--- +title: account.getContentSettings +description: account.getContentSettings parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getContentSettings.html +--- +# Method: account.getContentSettings +[Back to methods index](index.md) + + + + +### Return type: [account.ContentSettings](../types/account.ContentSettings.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.ContentSettings = $MadelineProto->account->getContentSettings(); +``` + +Or, if you're into Lua: + +```lua +account.ContentSettings = account.getContentSettings({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getMultiWallPapers.md b/old_docs/API_docs_v109/methods/account.getMultiWallPapers.md new file mode 100644 index 00000000..aa7388a4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getMultiWallPapers.md @@ -0,0 +1,43 @@ +--- +title: account.getMultiWallPapers +description: account.getMultiWallPapers parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getMultiWallPapers.html +--- +# Method: account.getMultiWallPapers +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|wallpapers|Array of [InputWallPaper](../types/InputWallPaper.md) | Yes| + + +### Return type: [Vector\_of\_WallPaper](../types/WallPaper.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->getMultiWallPapers(['wallpapers' => [InputWallPaper, InputWallPaper], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_WallPaper = account.getMultiWallPapers({wallpapers={InputWallPaper}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getNotifyExceptions.md b/old_docs/API_docs_v109/methods/account.getNotifyExceptions.md new file mode 100644 index 00000000..f1fd0517 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getNotifyExceptions.md @@ -0,0 +1,46 @@ +--- +title: account.getNotifyExceptions +description: Returns list of chats with non-default notification settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getNotifyExceptions.html +--- +# Method: account.getNotifyExceptions +[Back to methods index](index.md) + + +Returns list of chats with non-default notification settings + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|compare\_sound|[Bool](../types/Bool.md) | If true, chats with non-default sound will also be returned | Optional| +|peer|[Username, chat ID, Update, Message or InputNotifyPeer](../types/InputNotifyPeer.md) | If specified, only chats of the specified category will be returned | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->account->getNotifyExceptions(['compare_sound' => Bool, 'peer' => InputNotifyPeer, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = account.getNotifyExceptions({compare_sound=Bool, peer=InputNotifyPeer, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getNotifySettings.md b/old_docs/API_docs_v109/methods/account.getNotifySettings.md new file mode 100644 index 00000000..ea9b4b26 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getNotifySettings.md @@ -0,0 +1,52 @@ +--- +title: account.getNotifySettings +description: Gets current notification settings for a given user/group, from all users/all groups. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getNotifySettings.html +--- +# Method: account.getNotifySettings +[Back to methods index](index.md) + + +Gets current notification settings for a given user/group, from all users/all groups. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputNotifyPeer](../types/InputNotifyPeer.md) | Notification source | Yes| + + +### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +PeerNotifySettings = account.getNotifySettings({peer=InputNotifyPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/account.getPassword.md b/old_docs/API_docs_v109/methods/account.getPassword.md new file mode 100644 index 00000000..15624078 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getPassword.md @@ -0,0 +1,40 @@ +--- +title: account.getPassword +description: Obtain configuration for two-factor authorization with password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getPassword.html +--- +# Method: account.getPassword +[Back to methods index](index.md) + + +Obtain configuration for two-factor authorization with password + + + +### Return type: [account.Password](../types/account.Password.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +account.Password = account.getPassword({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getPasswordSettings.md b/old_docs/API_docs_v109/methods/account.getPasswordSettings.md new file mode 100644 index 00000000..9b2dbc63 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getPasswordSettings.md @@ -0,0 +1,52 @@ +--- +title: account.getPasswordSettings +description: You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getPasswordSettings.html +--- +# Method: account.getPasswordSettings +[Back to methods index](index.md) + + +You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) | Yes| + + +### Return type: [account.PasswordSettings](../types/account.PasswordSettings.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['password' => InputCheckPasswordSRP, ]); +``` + +Or, if you're into Lua: + +```lua +account.PasswordSettings = account.getPasswordSettings({password=InputCheckPasswordSRP, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PASSWORD_HASH_INVALID|The provided password hash is invalid| + + diff --git a/old_docs/API_docs_v109/methods/account.getPrivacy.md b/old_docs/API_docs_v109/methods/account.getPrivacy.md new file mode 100644 index 00000000..dad3bf20 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getPrivacy.md @@ -0,0 +1,52 @@ +--- +title: account.getPrivacy +description: Get privacy settings of current account +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getPrivacy.html +--- +# Method: account.getPrivacy +[Back to methods index](index.md) + + +Get privacy settings of current account + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Peer category whose privacy settings should be fetched | Yes| + + +### Return type: [account.PrivacyRules](../types/account.PrivacyRules.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +account.PrivacyRules = account.getPrivacy({key=InputPrivacyKey, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v109/methods/account.getSecureValue.md b/old_docs/API_docs_v109/methods/account.getSecureValue.md new file mode 100644 index 00000000..60f88ca9 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getSecureValue.md @@ -0,0 +1,45 @@ +--- +title: account.getSecureValue +description: Get saved [Telegram Passport](https://core.telegram.org/passport) document, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getSecureValue.html +--- +# Method: account.getSecureValue +[Back to methods index](index.md) + + +Get saved [Telegram Passport](https://core.telegram.org/passport) document, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|types|Array of [SecureValueType](../types/SecureValueType.md) | Get telegram passport secure parameters | Yes| + + +### Return type: [Vector\_of\_SecureValue](../types/SecureValue.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_SecureValue = account.getSecureValue({types={SecureValueType}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getTheme.md b/old_docs/API_docs_v109/methods/account.getTheme.md new file mode 100644 index 00000000..ec995d86 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getTheme.md @@ -0,0 +1,47 @@ +--- +title: account.getTheme +description: Get theme information +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getTheme.html +--- +# Method: account.getTheme +[Back to methods index](index.md) + + +Get theme information + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|format|[string](../types/string.md) | Theme format, a string that identifies the theming engines supported by the client | Yes| +|theme|[InputTheme](../types/InputTheme.md) | Theme | Yes| +|document\_id|[long](../types/long.md) | Document ID | Yes| + + +### Return type: [Theme](../types/Theme.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$Theme = $MadelineProto->account->getTheme(['format' => 'string', 'theme' => InputTheme, 'document_id' => long, ]); +``` + +Or, if you're into Lua: + +```lua +Theme = account.getTheme({format='string', theme=InputTheme, document_id=long, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getThemes.md b/old_docs/API_docs_v109/methods/account.getThemes.md new file mode 100644 index 00000000..dc24be8c --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getThemes.md @@ -0,0 +1,46 @@ +--- +title: account.getThemes +description: Get installed themes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getThemes.html +--- +# Method: account.getThemes +[Back to methods index](index.md) + + +Get installed themes + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|format|[string](../types/string.md) | Theme format, a string that identifies the theming engines supported by the client | Yes| +|hash|Array of [int](../types/int.md) | Hash for pagination | Optional| + + +### Return type: [account.Themes](../types/account.Themes.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.Themes = $MadelineProto->account->getThemes(['format' => 'string', 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +account.Themes = account.getThemes({format='string', hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getTmpPassword.md b/old_docs/API_docs_v109/methods/account.getTmpPassword.md new file mode 100644 index 00000000..5dd8fc8f --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getTmpPassword.md @@ -0,0 +1,54 @@ +--- +title: account.getTmpPassword +description: Get temporary payment password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getTmpPassword.html +--- +# Method: account.getTmpPassword +[Back to methods index](index.md) + + +Get temporary payment password + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | SRP password parameters | Yes| +|period|[int](../types/int.md) | Time during which the temporary password will be valid, in seconds; should be between 60 and 86400 | Yes| + + +### Return type: [account.TmpPassword](../types/account.TmpPassword.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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' => InputCheckPasswordSRP, 'period' => int, ]); +``` + +Or, if you're into Lua: + +```lua +account.TmpPassword = account.getTmpPassword({password=InputCheckPasswordSRP, period=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|400|TMP_PASSWORD_DISABLED|The temporary password is disabled| + + diff --git a/old_docs/API_docs_v109/methods/account.getWallPaper.md b/old_docs/API_docs_v109/methods/account.getWallPaper.md new file mode 100644 index 00000000..44030983 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getWallPaper.md @@ -0,0 +1,45 @@ +--- +title: account.getWallPaper +description: Get info about a certain wallpaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getWallPaper.html +--- +# Method: account.getWallPaper +[Back to methods index](index.md) + + +Get info about a certain wallpaper + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | The wallpaper to get info about | Yes| + + +### Return type: [WallPaper](../types/WallPaper.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$WallPaper = $MadelineProto->account->getWallPaper(['wallpaper' => InputWallPaper, ]); +``` + +Or, if you're into Lua: + +```lua +WallPaper = account.getWallPaper({wallpaper=InputWallPaper, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getWallPapers.md b/old_docs/API_docs_v109/methods/account.getWallPapers.md new file mode 100644 index 00000000..3e79c46b --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getWallPapers.md @@ -0,0 +1,45 @@ +--- +title: account.getWallPapers +description: Returns a list of available wallpapers. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getWallPapers.html +--- +# Method: account.getWallPapers +[Back to methods index](index.md) + + +Returns a list of available wallpapers. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | IDs of previously fetched wallpapers | Optional| + + +### Return type: [account.WallPapers](../types/account.WallPapers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.WallPapers = $MadelineProto->account->getWallPapers(['hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +account.WallPapers = account.getWallPapers({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.getWebAuthorizations.md b/old_docs/API_docs_v109/methods/account.getWebAuthorizations.md new file mode 100644 index 00000000..678f2b62 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.getWebAuthorizations.md @@ -0,0 +1,40 @@ +--- +title: account.getWebAuthorizations +description: Get web [login widget](https://core.telegram.org/widgets/login) authorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_getWebAuthorizations.html +--- +# Method: account.getWebAuthorizations +[Back to methods index](index.md) + + +Get web [login widget](https://core.telegram.org/widgets/login) authorizations + + + +### Return type: [account.WebAuthorizations](../types/account.WebAuthorizations.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +account.WebAuthorizations = account.getWebAuthorizations({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.initTakeoutSession.md b/old_docs/API_docs_v109/methods/account.initTakeoutSession.md new file mode 100644 index 00000000..f2319113 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.initTakeoutSession.md @@ -0,0 +1,58 @@ +--- +title: account.initTakeoutSession +description: Intialize account takeout session +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_initTakeoutSession.html +--- +# Method: account.initTakeoutSession +[Back to methods index](index.md) + + +Intialize account takeout session + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|[Bool](../types/Bool.md) | Whether to export contacts | Optional| +|message\_users|[Bool](../types/Bool.md) | Whether to export messages in private chats | Optional| +|message\_chats|[Bool](../types/Bool.md) | Whether to export messages in [legacy groups](https://core.telegram.org/api/channel) | Optional| +|message\_megagroups|[Bool](../types/Bool.md) | Whether to export messages in [supergroups](https://core.telegram.org/api/channel) | Optional| +|message\_channels|[Bool](../types/Bool.md) | Whether to export messages in [channels](https://core.telegram.org/api/channel) | Optional| +|files|[Bool](../types/Bool.md) | Whether to export files | Optional| +|file\_max\_size|[int](../types/int.md) | Maximum size of files to export | Optional| + + +### Return type: [account.Takeout](../types/account.Takeout.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```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, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|420|TAKEOUT_INIT_DELAY_X|Wait X seconds before initing takeout| + + diff --git a/old_docs/API_docs_v109/methods/account.installTheme.md b/old_docs/API_docs_v109/methods/account.installTheme.md new file mode 100644 index 00000000..999e6dce --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.installTheme.md @@ -0,0 +1,47 @@ +--- +title: account.installTheme +description: Install a theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_installTheme.html +--- +# Method: account.installTheme +[Back to methods index](index.md) + + +Install a theme + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|dark|[Bool](../types/Bool.md) | Whether to install the dark version | Optional| +|format|[string](../types/string.md) | Theme format, a string that identifies the theming engines supported by the client | Optional| +|theme|[InputTheme](../types/InputTheme.md) | Theme to install | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->installTheme(['dark' => Bool, 'format' => 'string', 'theme' => InputTheme, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.installTheme({dark=Bool, format='string', theme=InputTheme, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.installWallPaper.md b/old_docs/API_docs_v109/methods/account.installWallPaper.md new file mode 100644 index 00000000..79474326 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.installWallPaper.md @@ -0,0 +1,46 @@ +--- +title: account.installWallPaper +description: Install wallpaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_installWallPaper.html +--- +# Method: account.installWallPaper +[Back to methods index](index.md) + + +Install wallpaper + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Wallpaper to install | Yes| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Wallpaper settings | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->installWallPaper(['wallpaper' => InputWallPaper, 'settings' => WallPaperSettings, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.installWallPaper({wallpaper=InputWallPaper, settings=WallPaperSettings, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.registerDevice.md b/old_docs/API_docs_v109/methods/account.registerDevice.md new file mode 100644 index 00000000..38c23d5a --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.registerDevice.md @@ -0,0 +1,57 @@ +--- +title: account.registerDevice +description: Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_registerDevice.html +--- +# Method: account.registerDevice +[Back to methods index](index.md) + + +Register device to receive [PUSH notifications](https://core.telegram.org/api/push-updates) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_muted|[Bool](../types/Bool.md) | Avoid receiving (silent and invisible background) notifications. Useful to save battery. | Optional| +|token\_type|[int](../types/int.md) | Device token type.
**Possible values**:
`1` \- APNS (device token for apple push)
`2` \- FCM (firebase token for google firebase)
`3` \- MPNS (channel URI for microsoft push)
`4` \- Simple push (endpoint for firefox's simple push API)
`5` \- Ubuntu phone (token for ubuntu push)
`6` \- Blackberry (token for blackberry push)
`7` \- Unused
`8` \- WNS (windows push)
`9` \- APNS VoIP (token for apple push VoIP)
`10` \- Web push (web push, see below)
`11` \- MPNS VoIP (token for microsoft push VoIP)
`12` \- Tizen (token for tizen push)

For `10` web push, the token must be a JSON-encoded object containing the keys described in [PUSH updates](https://core.telegram.org/api/push-updates) | Yes| +|token|[string](../types/string.md) | Device token | Yes| +|app\_sandbox|[Bool](../types/Bool.md) | If [(boolTrue)](../constructors/boolTrue.md) is transmitted, a sandbox-certificate will be used during transmission. | Yes| +|secret|[bytes](../types/bytes.md) | For FCM and APNS VoIP, optional encryption key used to encrypt push notifications | Yes| +|other\_uids|Array of [int](../types/int.md) | Other UIDs | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['no_muted' => Bool, 'token_type' => int, 'token' => 'string', 'app_sandbox' => Bool, 'secret' => 'bytes', 'other_uids' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.registerDevice({no_muted=Bool, token_type=int, token='string', app_sandbox=Bool, secret='bytes', other_uids={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v109/methods/account.reportPeer.md b/old_docs/API_docs_v109/methods/account.reportPeer.md new file mode 100644 index 00000000..20218120 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.reportPeer.md @@ -0,0 +1,53 @@ +--- +title: account.reportPeer +description: Report a peer for violation of telegram's Terms of Service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_reportPeer.html +--- +# Method: account.reportPeer +[Back to methods index](index.md) + + +Report a peer for violation of telegram's Terms of Service + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| +|reason|[ReportReason](../types/ReportReason.md) | The reason why this peer is being reported | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.reportPeer({peer=InputPeer, reason=ReportReason, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/account.resendPasswordEmail.md b/old_docs/API_docs_v109/methods/account.resendPasswordEmail.md new file mode 100644 index 00000000..a7bcdce3 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.resendPasswordEmail.md @@ -0,0 +1,40 @@ +--- +title: account.resendPasswordEmail +description: Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_resendPasswordEmail.html +--- +# Method: account.resendPasswordEmail +[Back to methods index](index.md) + + +Resend the code to verify an email to use as [2FA recovery method](https://core.telegram.org/api/srp). + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->resendPasswordEmail(); +``` + +Or, if you're into Lua: + +```lua +Bool = account.resendPasswordEmail({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.resetAuthorization.md b/old_docs/API_docs_v109/methods/account.resetAuthorization.md new file mode 100644 index 00000000..a036e867 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.resetAuthorization.md @@ -0,0 +1,53 @@ +--- +title: account.resetAuthorization +description: Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_resetAuthorization.html +--- +# Method: account.resetAuthorization +[Back to methods index](index.md) + + +Log out an active [authorized session](https://core.telegram.org/api/auth) by its hash + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[long](../types/long.md) | Session hash | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.resetAuthorization({hash=long, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|HASH_INVALID|The provided hash is invalid| +|406|FRESH_RESET_AUTHORISATION_FORBIDDEN|You can't logout other sessions if less than 24 hours have passed since you logged on the current session| + + diff --git a/old_docs/API_docs_v109/methods/account.resetNotifySettings.md b/old_docs/API_docs_v109/methods/account.resetNotifySettings.md new file mode 100644 index 00000000..c1988409 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.resetNotifySettings.md @@ -0,0 +1,40 @@ +--- +title: account.resetNotifySettings +description: Resets all notification settings from users and groups. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_resetNotifySettings.html +--- +# Method: account.resetNotifySettings +[Back to methods index](index.md) + + +Resets all notification settings from users and groups. + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +Bool = account.resetNotifySettings({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.resetWallPapers.md b/old_docs/API_docs_v109/methods/account.resetWallPapers.md new file mode 100644 index 00000000..00f10670 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.resetWallPapers.md @@ -0,0 +1,40 @@ +--- +title: account.resetWallPapers +description: Delete installed wallpapers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_resetWallPapers.html +--- +# Method: account.resetWallPapers +[Back to methods index](index.md) + + +Delete installed wallpapers + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->resetWallPapers(); +``` + +Or, if you're into Lua: + +```lua +Bool = account.resetWallPapers({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.resetWebAuthorization.md b/old_docs/API_docs_v109/methods/account.resetWebAuthorization.md new file mode 100644 index 00000000..d8088f89 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.resetWebAuthorization.md @@ -0,0 +1,45 @@ +--- +title: account.resetWebAuthorization +description: Log out an active web [telegram login](https://core.telegram.org/widgets/login) session +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_resetWebAuthorization.html +--- +# Method: account.resetWebAuthorization +[Back to methods index](index.md) + + +Log out an active web [telegram login](https://core.telegram.org/widgets/login) session + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[long](../types/long.md) | [Session](../constructors/webAuthorization.md) hash | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.resetWebAuthorization({hash=long, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.resetWebAuthorizations.md b/old_docs/API_docs_v109/methods/account.resetWebAuthorizations.md new file mode 100644 index 00000000..4e456bcb --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.resetWebAuthorizations.md @@ -0,0 +1,40 @@ +--- +title: account.resetWebAuthorizations +description: Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_resetWebAuthorizations.html +--- +# Method: account.resetWebAuthorizations +[Back to methods index](index.md) + + +Reset all active web [telegram login](https://core.telegram.org/widgets/login) sessions + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +Bool = account.resetWebAuthorizations({}) +``` + diff --git a/old_docs/API_docs_v109/methods/account.saveAutoDownloadSettings.md b/old_docs/API_docs_v109/methods/account.saveAutoDownloadSettings.md new file mode 100644 index 00000000..a2c42e84 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.saveAutoDownloadSettings.md @@ -0,0 +1,47 @@ +--- +title: account.saveAutoDownloadSettings +description: Change media autodownload settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_saveAutoDownloadSettings.html +--- +# Method: account.saveAutoDownloadSettings +[Back to methods index](index.md) + + +Change media autodownload settings + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|low|[Bool](../types/Bool.md) | Whether to save settings in the low data usage preset | Optional| +|high|[Bool](../types/Bool.md) | Whether to save settings in the high data usage preset | Optional| +|settings|[AutoDownloadSettings](../types/AutoDownloadSettings.md) | Media autodownload settings | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->saveAutoDownloadSettings(['low' => Bool, 'high' => Bool, 'settings' => AutoDownloadSettings, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.saveAutoDownloadSettings({low=Bool, high=Bool, settings=AutoDownloadSettings, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.saveSecureValue.md b/old_docs/API_docs_v109/methods/account.saveSecureValue.md new file mode 100644 index 00000000..8c8c4684 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.saveSecureValue.md @@ -0,0 +1,46 @@ +--- +title: account.saveSecureValue +description: Securely save [Telegram Passport](https://core.telegram.org/passport) document, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_saveSecureValue.html +--- +# Method: account.saveSecureValue +[Back to methods index](index.md) + + +Securely save [Telegram Passport](https://core.telegram.org/passport) document, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|value|[InputSecureValue](../types/InputSecureValue.md) | Secure value, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) | Yes| +|secure\_secret\_id|[long](../types/long.md) | Passport secret hash, [for more info see the passport docs »](https://core.telegram.org/passport/encryption#encryption) | Yes| + + +### Return type: [SecureValue](../types/SecureValue.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +SecureValue = account.saveSecureValue({value=InputSecureValue, secure_secret_id=long, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.saveTheme.md b/old_docs/API_docs_v109/methods/account.saveTheme.md new file mode 100644 index 00000000..daf2cbbe --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.saveTheme.md @@ -0,0 +1,46 @@ +--- +title: account.saveTheme +description: Save a theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_saveTheme.html +--- +# Method: account.saveTheme +[Back to methods index](index.md) + + +Save a theme + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|theme|[InputTheme](../types/InputTheme.md) | Theme to save | Yes| +|unsave|[Bool](../types/Bool.md) | Unsave | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->saveTheme(['theme' => InputTheme, 'unsave' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.saveTheme({theme=InputTheme, unsave=Bool, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.saveWallPaper.md b/old_docs/API_docs_v109/methods/account.saveWallPaper.md new file mode 100644 index 00000000..4957bf08 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.saveWallPaper.md @@ -0,0 +1,47 @@ +--- +title: account.saveWallPaper +description: Install/uninstall wallpaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_saveWallPaper.html +--- +# Method: account.saveWallPaper +[Back to methods index](index.md) + + +Install/uninstall wallpaper + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|wallpaper|[InputWallPaper](../types/InputWallPaper.md) | Wallpaper to save | Yes| +|unsave|[Bool](../types/Bool.md) | Uninstall wallpaper? | Yes| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Wallpaper settings | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->saveWallPaper(['wallpaper' => InputWallPaper, 'unsave' => Bool, 'settings' => WallPaperSettings, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.saveWallPaper({wallpaper=InputWallPaper, unsave=Bool, settings=WallPaperSettings, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.sendChangePhoneCode.md b/old_docs/API_docs_v109/methods/account.sendChangePhoneCode.md new file mode 100644 index 00000000..0fd0b5c0 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.sendChangePhoneCode.md @@ -0,0 +1,53 @@ +--- +title: account.sendChangePhoneCode +description: Verify a new phone number to associate to the current account +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_sendChangePhoneCode.html +--- +# Method: account.sendChangePhoneCode +[Back to methods index](index.md) + + +Verify a new phone number to associate to the current account + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| +|settings|[CodeSettings](../types/CodeSettings.md) | Phone code settings | Yes| + + +### Return type: [auth.SentCode](../types/auth.SentCode.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['phone_number' => 'string', 'settings' => CodeSettings, ]); +``` + +Or, if you're into Lua: + +```lua +auth.SentCode = account.sendChangePhoneCode({phone_number='string', settings=CodeSettings, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v109/methods/account.sendConfirmPhoneCode.md b/old_docs/API_docs_v109/methods/account.sendConfirmPhoneCode.md new file mode 100644 index 00000000..4129e2a4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.sendConfirmPhoneCode.md @@ -0,0 +1,53 @@ +--- +title: account.sendConfirmPhoneCode +description: Send confirmation code to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_sendConfirmPhoneCode.html +--- +# Method: account.sendConfirmPhoneCode +[Back to methods index](index.md) + + +Send confirmation code to cancel account deletion, for more info [click here »](https://core.telegram.org/api/account-deletion) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The hash from the service notification, for more info [click here »](https://core.telegram.org/api/account-deletion) | Yes| +|settings|[CodeSettings](../types/CodeSettings.md) | Phone code settings | Yes| + + +### Return type: [auth.SentCode](../types/auth.SentCode.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['hash' => 'string', 'settings' => CodeSettings, ]); +``` + +Or, if you're into Lua: + +```lua +auth.SentCode = account.sendConfirmPhoneCode({hash='string', settings=CodeSettings, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|HASH_INVALID|The provided hash is invalid| + + diff --git a/old_docs/API_docs_v109/methods/account.sendVerifyEmailCode.md b/old_docs/API_docs_v109/methods/account.sendVerifyEmailCode.md new file mode 100644 index 00000000..7663dfca --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.sendVerifyEmailCode.md @@ -0,0 +1,45 @@ +--- +title: account.sendVerifyEmailCode +description: Send the verification email code for telegram [passport](https://core.telegram.org/passport). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_sendVerifyEmailCode.html +--- +# Method: account.sendVerifyEmailCode +[Back to methods index](index.md) + + +Send the verification email code for telegram [passport](https://core.telegram.org/passport). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|email|[string](../types/string.md) | The email where to send the code | Yes| + + +### Return type: [account.SentEmailCode](../types/account.SentEmailCode.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +account.SentEmailCode = account.sendVerifyEmailCode({email='string', }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.sendVerifyPhoneCode.md b/old_docs/API_docs_v109/methods/account.sendVerifyPhoneCode.md new file mode 100644 index 00000000..0b562022 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.sendVerifyPhoneCode.md @@ -0,0 +1,46 @@ +--- +title: account.sendVerifyPhoneCode +description: Send the verification phone code for telegram [passport](https://core.telegram.org/passport). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_sendVerifyPhoneCode.html +--- +# Method: account.sendVerifyPhoneCode +[Back to methods index](index.md) + + +Send the verification phone code for telegram [passport](https://core.telegram.org/passport). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to verify | Yes| +|settings|[CodeSettings](../types/CodeSettings.md) | Phone code settings | Yes| + + +### Return type: [auth.SentCode](../types/auth.SentCode.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['phone_number' => 'string', 'settings' => CodeSettings, ]); +``` + +Or, if you're into Lua: + +```lua +auth.SentCode = account.sendVerifyPhoneCode({phone_number='string', settings=CodeSettings, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.setAccountTTL.md b/old_docs/API_docs_v109/methods/account.setAccountTTL.md new file mode 100644 index 00000000..de4221a5 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.setAccountTTL.md @@ -0,0 +1,52 @@ +--- +title: account.setAccountTTL +description: Set account self-destruction period +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_setAccountTTL.html +--- +# Method: account.setAccountTTL +[Back to methods index](index.md) + + +Set account self-destruction period + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ttl|[AccountDaysTTL](../types/AccountDaysTTL.md) | Time to live in days | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.setAccountTTL({ttl=AccountDaysTTL, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|TTL_DAYS_INVALID|The provided TTL is invalid| + + diff --git a/old_docs/API_docs_v109/methods/account.setContactSignUpNotification.md b/old_docs/API_docs_v109/methods/account.setContactSignUpNotification.md new file mode 100644 index 00000000..15ffbebd --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.setContactSignUpNotification.md @@ -0,0 +1,45 @@ +--- +title: account.setContactSignUpNotification +description: Toggle contact sign up notifications +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_setContactSignUpNotification.html +--- +# Method: account.setContactSignUpNotification +[Back to methods index](index.md) + + +Toggle contact sign up notifications + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Whether to disable contact sign up notifications | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->setContactSignUpNotification(['silent' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.setContactSignUpNotification({silent=Bool, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.setContentSettings.md b/old_docs/API_docs_v109/methods/account.setContentSettings.md new file mode 100644 index 00000000..ba6337d4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.setContentSettings.md @@ -0,0 +1,43 @@ +--- +title: account.setContentSettings +description: account.setContentSettings parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_setContentSettings.html +--- +# Method: account.setContentSettings +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|sensitive\_enabled|[Bool](../types/Bool.md) | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->setContentSettings(['sensitive_enabled' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.setContentSettings({sensitive_enabled=Bool, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.setPrivacy.md b/old_docs/API_docs_v109/methods/account.setPrivacy.md new file mode 100644 index 00000000..b53cc7c6 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.setPrivacy.md @@ -0,0 +1,53 @@ +--- +title: account.setPrivacy +description: Change privacy settings of current account +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_setPrivacy.html +--- +# Method: account.setPrivacy +[Back to methods index](index.md) + + +Change privacy settings of current account + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|key|[InputPrivacyKey](../types/InputPrivacyKey.md) | Peers to which the privacy rules apply | Yes| +|rules|Array of [InputPrivacyRule](../types/InputPrivacyRule.md) | Privacy settings | Yes| + + +### Return type: [account.PrivacyRules](../types/account.PrivacyRules.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +account.PrivacyRules = account.setPrivacy({key=InputPrivacyKey, rules={InputPrivacyRule}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PRIVACY_KEY_INVALID|The privacy key is invalid| + + diff --git a/old_docs/API_docs_v109/methods/account.unregisterDevice.md b/old_docs/API_docs_v109/methods/account.unregisterDevice.md new file mode 100644 index 00000000..0fda44dc --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.unregisterDevice.md @@ -0,0 +1,54 @@ +--- +title: account.unregisterDevice +description: Deletes a device by its token, stops sending PUSH-notifications to it. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_unregisterDevice.html +--- +# Method: account.unregisterDevice +[Back to methods index](index.md) + + +Deletes a device by its token, stops sending PUSH-notifications to it. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|token\_type|[int](../types/int.md) | Device token type.
**Possible values**:
`1` \- APNS (device token for apple push)
`2` \- FCM (firebase token for google firebase)
`3` \- MPNS (channel URI for microsoft push)
`4` \- Simple push (endpoint for firefox's simple push API)
`5` \- Ubuntu phone (token for ubuntu push)
`6` \- Blackberry (token for blackberry push)
`7` \- Unused
`8` \- WNS (windows push)
`9` \- APNS VoIP (token for apple push VoIP)
`10` \- Web push (web push, see below)
`11` \- MPNS VoIP (token for microsoft push VoIP)
`12` \- Tizen (token for tizen push)

For `10` web push, the token must be a JSON-encoded object containing the keys described in [PUSH updates](https://core.telegram.org/api/push-updates) | Yes| +|token|[string](../types/string.md) | Device token | Yes| +|other\_uids|Array of [int](../types/int.md) | Other UIDs | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.unregisterDevice({token_type=int, token='string', other_uids={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|TOKEN_INVALID|The provided token is invalid| + + diff --git a/old_docs/API_docs_v109/methods/account.updateDeviceLocked.md b/old_docs/API_docs_v109/methods/account.updateDeviceLocked.md new file mode 100644 index 00000000..944e62db --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.updateDeviceLocked.md @@ -0,0 +1,45 @@ +--- +title: account.updateDeviceLocked +description: When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_updateDeviceLocked.html +--- +# Method: account.updateDeviceLocked +[Back to methods index](index.md) + + +When client-side passcode lock feature is enabled, will not show message texts in incoming [PUSH notifications](https://core.telegram.org/api/push-updates). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|period|[int](../types/int.md) | Inactivity period after which to start hiding message texts in [PUSH notifications](https://core.telegram.org/api/push-updates). | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.updateDeviceLocked({period=int, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.updateNotifySettings.md b/old_docs/API_docs_v109/methods/account.updateNotifySettings.md new file mode 100644 index 00000000..9e22703e --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.updateNotifySettings.md @@ -0,0 +1,55 @@ +--- +title: account.updateNotifySettings +description: Edits notification settings from a given user/group, from all users/all groups. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_updateNotifySettings.html +--- +# Method: account.updateNotifySettings +[Back to methods index](index.md) + + +Edits notification settings from a given user/group, from all users/all groups. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputNotifyPeer](../types/InputNotifyPeer.md) | Notification source | Yes| +|settings|[InputPeerNotifySettings](../types/InputPeerNotifySettings.md) | Notification settings | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.updateNotifySettings({peer=InputNotifyPeer, settings=InputPeerNotifySettings, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|SETTINGS_INVALID|Invalid settings were provided| + + diff --git a/old_docs/API_docs_v109/methods/account.updatePasswordSettings.md b/old_docs/API_docs_v109/methods/account.updatePasswordSettings.md new file mode 100644 index 00000000..c7cd20f0 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.updatePasswordSettings.md @@ -0,0 +1,58 @@ +--- +title: account.updatePasswordSettings +description: You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_updatePasswordSettings.html +--- +# Method: account.updatePasswordSettings +[Back to methods index](index.md) + + +You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) | Yes| +|new\_settings|[account.PasswordInputSettings](../types/account.PasswordInputSettings.md) | You cannot use this method directly; use $MadelineProto->update2fa($params), instead (see https://docs.madelineproto.xyz for more info) | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['password' => InputCheckPasswordSRP, 'new_settings' => account.PasswordInputSettings, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.updatePasswordSettings({password=InputCheckPasswordSRP, new_settings=account.PasswordInputSettings, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|EMAIL_UNCONFIRMED|Email unconfirmed| +|400|EMAIL_UNCONFIRMED_X|The provided email isn't confirmed, X is the length of the verification code that was just sent to the email.| +|400|NEW_SALT_INVALID|The new salt is invalid| +|400|NEW_SETTINGS_INVALID|The new settings are invalid| +|400|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|400|SRP_ID_INVALID|Invalid SRP ID provided| + + diff --git a/old_docs/API_docs_v109/methods/account.updateProfile.md b/old_docs/API_docs_v109/methods/account.updateProfile.md new file mode 100644 index 00000000..ddfa391c --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.updateProfile.md @@ -0,0 +1,57 @@ +--- +title: account.updateProfile +description: Updates user profile. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_updateProfile.html +--- +# Method: account.updateProfile +[Back to methods index](index.md) + + +Updates user profile. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | New user first name | Optional| +|last\_name|[string](../types/string.md) | New user last name | Optional| +|about|[string](../types/string.md) | New bio | Optional| + + +### Return type: [User](../types/User.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +User = account.updateProfile({first_name='string', last_name='string', about='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|ABOUT_TOO_LONG|About string too long| +|400|FIRSTNAME_INVALID|The first name is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/account.updateStatus.md b/old_docs/API_docs_v109/methods/account.updateStatus.md new file mode 100644 index 00000000..7c090256 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.updateStatus.md @@ -0,0 +1,54 @@ +--- +title: account.updateStatus +description: Updates online user status. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_updateStatus.html +--- +# Method: account.updateStatus +[Back to methods index](index.md) + + +Updates online user status. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offline|[Bool](../types/Bool.md) | If [(boolTrue)](../constructors/boolTrue.md) is transmitted, user status will change to [(userStatusOffline)](../constructors/userStatusOffline.md). | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.updateStatus({offline=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/account.updateTheme.md b/old_docs/API_docs_v109/methods/account.updateTheme.md new file mode 100644 index 00000000..8de4d845 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.updateTheme.md @@ -0,0 +1,50 @@ +--- +title: account.updateTheme +description: Update theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_updateTheme.html +--- +# Method: account.updateTheme +[Back to methods index](index.md) + + +Update theme + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|format|[string](../types/string.md) | Theme format, a string that identifies the theming engines supported by the client | Yes| +|theme|[InputTheme](../types/InputTheme.md) | Theme to update | Yes| +|slug|[string](../types/string.md) | Unique theme ID | Optional| +|title|[string](../types/string.md) | Theme name | Optional| +|document|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Theme file | Optional| +|settings|[InputThemeSettings](../types/InputThemeSettings.md) | | Optional| + + +### Return type: [Theme](../types/Theme.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$Theme = $MadelineProto->account->updateTheme(['format' => 'string', 'theme' => InputTheme, 'slug' => 'string', 'title' => 'string', 'document' => InputDocument, 'settings' => InputThemeSettings, ]); +``` + +Or, if you're into Lua: + +```lua +Theme = account.updateTheme({format='string', theme=InputTheme, slug='string', title='string', document=InputDocument, settings=InputThemeSettings, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.updateUsername.md b/old_docs/API_docs_v109/methods/account.updateUsername.md new file mode 100644 index 00000000..198cf4da --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.updateUsername.md @@ -0,0 +1,56 @@ +--- +title: account.updateUsername +description: Changes username for the current user. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_updateUsername.html +--- +# Method: account.updateUsername +[Back to methods index](index.md) + + +Changes username for the current user. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|username|[string](../types/string.md) | Username or empty string if username is to be removed
Accepted characters: a-z (case-insensitive), 0-9 and underscores.
Length: 5-32 characters. | Yes| + + +### Return type: [User](../types/User.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +User = account.updateUsername({username='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|USERNAME_INVALID|The provided username is not valid| +|400|USERNAME_NOT_MODIFIED|The username was not modified| +|400|USERNAME_OCCUPIED|The provided username is already occupied| +|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v109/methods/account.uploadTheme.md b/old_docs/API_docs_v109/methods/account.uploadTheme.md new file mode 100644 index 00000000..b41189fc --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.uploadTheme.md @@ -0,0 +1,55 @@ +--- +title: account.uploadTheme +description: Upload theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_uploadTheme.html +--- +# Method: account.uploadTheme +[Back to methods index](index.md) + + +Upload theme + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | Theme file uploaded as described in [files »](https://core.telegram.org/api/files) | Yes| +|thumb|[File path or InputFile](../types/InputFile.md) | Thumbnail | Optional| +|file\_name|[string](../types/string.md) | File name | Yes| +|mime\_type|[string](../types/string.md) | MIME type, must be `application/x-tgtheme-{format}`, where `format` depends on the client | Yes| + + +### Return type: [Document](../types/Document.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->account->uploadTheme(['file' => InputFile, 'thumb' => InputFile, 'file_name' => 'string', 'mime_type' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Document = account.uploadTheme({file=InputFile, thumb=InputFile, file_name='string', mime_type='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|THEME_FILE_INVALID|Invalid theme file provided| + + diff --git a/old_docs/API_docs_v109/methods/account.uploadWallPaper.md b/old_docs/API_docs_v109/methods/account.uploadWallPaper.md new file mode 100644 index 00000000..fa870b95 --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.uploadWallPaper.md @@ -0,0 +1,47 @@ +--- +title: account.uploadWallPaper +description: Create and upload a new wallpaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_uploadWallPaper.html +--- +# Method: account.uploadWallPaper +[Back to methods index](index.md) + + +Create and upload a new wallpaper + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The JPG/PNG wallpaper | Yes| +|mime\_type|[string](../types/string.md) | MIME type of uploaded wallpaper | Yes| +|settings|[WallPaperSettings](../types/WallPaperSettings.md) | Wallpaper settings | Yes| + + +### Return type: [WallPaper](../types/WallPaper.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$WallPaper = $MadelineProto->account->uploadWallPaper(['file' => InputFile, 'mime_type' => 'string', 'settings' => WallPaperSettings, ]); +``` + +Or, if you're into Lua: + +```lua +WallPaper = account.uploadWallPaper({file=InputFile, mime_type='string', settings=WallPaperSettings, }) +``` + diff --git a/old_docs/API_docs_v109/methods/account.verifyEmail.md b/old_docs/API_docs_v109/methods/account.verifyEmail.md new file mode 100644 index 00000000..ca67ce6a --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.verifyEmail.md @@ -0,0 +1,53 @@ +--- +title: account.verifyEmail +description: Verify an email address for telegram [passport](https://core.telegram.org/passport). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_verifyEmail.html +--- +# Method: account.verifyEmail +[Back to methods index](index.md) + + +Verify an email address for telegram [passport](https://core.telegram.org/passport). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|email|[string](../types/string.md) | The email to verify | Yes| +|code|[string](../types/string.md) | The verification code that was received | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.verifyEmail({email='string', code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|EMAIL_VERIFY_EXPIRED|The verification email has expired| + + diff --git a/old_docs/API_docs_v109/methods/account.verifyPhone.md b/old_docs/API_docs_v109/methods/account.verifyPhone.md new file mode 100644 index 00000000..ec7c510b --- /dev/null +++ b/old_docs/API_docs_v109/methods/account.verifyPhone.md @@ -0,0 +1,54 @@ +--- +title: account.verifyPhone +description: Verify a phone number for telegram [passport](https://core.telegram.org/passport). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/account_verifyPhone.html +--- +# Method: account.verifyPhone +[Back to methods index](index.md) + + +Verify a phone number for telegram [passport](https://core.telegram.org/passport). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code hash received from the call to [account.sendVerifyPhoneCode](../methods/account.sendVerifyPhoneCode.md) | Yes| +|phone\_code|[string](../types/string.md) | Code received after the call to [account.sendVerifyPhoneCode](../methods/account.sendVerifyPhoneCode.md) | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = account.verifyPhone({phone_number='string', phone_code_hash='string', phone_code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PHONE_CODE_EXPIRED|The phone code you provided has expired, this may happen if it was sent to any chat on telegram (if the code is sent through a telegram chat (not the official account) to avoid it append or prepend to the code some chars)| + + diff --git a/old_docs/API_docs_v109/methods/api_README.md b/old_docs/API_docs_v109/methods/api_README.md new file mode 100644 index 00000000..c48fb95f --- /dev/null +++ b/old_docs/API_docs_v109/methods/api_README.md @@ -0,0 +1,1340 @@ +--- +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->[phoneLogin](https://docs.madelineproto.xyz/phoneLogin.html)($number); + +$MadelineProto->[completePhoneLogin](https://docs.madelineproto.xyz/completePhoneLogin.html)($code); + +$MadelineProto->[complete2FALogin](https://docs.madelineproto.xyz/complete2FAlogin.html)($password); + +$MadelineProto->[botLogin](https://docs.madelineproto.xyz/botLogin.html)($token); + + +$MadelineProto->[getDialogs](https://docs.madelineproto.xyz/getDialogs.html)(); + +$MadelineProto->[getPwrChat](https://docs.madelineproto.xyz/getPwrChat.html)($id); + +$MadelineProto->[getInfo](https://docs.madelineproto.xyz/getInfo.html)($id); + +$MadelineProto->[getFullInfo](https://docs.madelineproto.xyz/getFullInfo.html)($id); + +$MadelineProto->[getSelf](https://docs.madelineproto.xyz/getSelf.html)(); + + +$MadelineProto->[requestCall](https://docs.madelineproto.xyz/requestCall.html)($id); + +$MadelineProto->[requestSecretChat](https://docs.madelineproto.xyz/requestSecretChat.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->cancelPasswordEmail](account.cancelPasswordEmail.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->confirmPasswordEmail](account.confirmPasswordEmail.md)(\['code' => [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->createTheme](account.createTheme.md)(\['slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [InputDocument](../types/InputDocument.md), 'settings' => [InputThemeSettings](../types/InputThemeSettings.md), \]) === [$Theme](../types/Theme.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->getAutoDownloadSettings](account.getAutoDownloadSettings.md)(\[\]) === [$account.AutoDownloadSettings](../types/account.AutoDownloadSettings.md) + +*** +

+$MadelineProto->[account->getContactSignUpNotification](account.getContactSignUpNotification.md)(\[\]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[account->getContentSettings](account.getContentSettings.md)(\[\]) === [$account.ContentSettings](../types/account.ContentSettings.md) + +*** +

+$MadelineProto->[account->getMultiWallPapers](account.getMultiWallPapers.md)(\['wallpapers' => \[[InputWallPaper](../types/InputWallPaper.md)\], \]) === [$Vector\_of\_WallPaper](../types/WallPaper.md) + +*** +

+$MadelineProto->[account->getNotifyExceptions](account.getNotifyExceptions.md)(\['compare_sound' => [Bool](../types/Bool.md), 'peer' => [InputNotifyPeer](../types/InputNotifyPeer.md), \]) === [$Updates](../types/Updates.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)(\['password' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.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->getTheme](account.getTheme.md)(\['format' => [string](../types/string.md), 'theme' => [InputTheme](../types/InputTheme.md), 'document_id' => [long](../types/long.md), \]) === [$Theme](../types/Theme.md) + +*** +

+$MadelineProto->[account->getThemes](account.getThemes.md)(\['format' => [string](../types/string.md), 'hash' => [int](../types/int.md), \]) === [$account.Themes](../types/account.Themes.md) + +*** +

+$MadelineProto->[account->getTmpPassword](account.getTmpPassword.md)(\['password' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md), 'period' => [int](../types/int.md), \]) === [$account.TmpPassword](../types/account.TmpPassword.md) + +*** +

+$MadelineProto->[account->getWallPaper](account.getWallPaper.md)(\['wallpaper' => [InputWallPaper](../types/InputWallPaper.md), \]) === [$WallPaper](../types/WallPaper.md) + +*** +

+$MadelineProto->[account->getWallPapers](account.getWallPapers.md)(\['hash' => [int](../types/int.md), \]) === [$account.WallPapers](../types/account.WallPapers.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->installTheme](account.installTheme.md)(\['dark' => [Bool](../types/Bool.md), 'format' => [string](../types/string.md), 'theme' => [InputTheme](../types/InputTheme.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[account->installWallPaper](account.installWallPaper.md)(\['wallpaper' => [InputWallPaper](../types/InputWallPaper.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[account->registerDevice](account.registerDevice.md)(\['no_muted' => [Bool](../types/Bool.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->resendPasswordEmail](account.resendPasswordEmail.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->resetWallPapers](account.resetWallPapers.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->saveAutoDownloadSettings](account.saveAutoDownloadSettings.md)(\['low' => [Bool](../types/Bool.md), 'high' => [Bool](../types/Bool.md), 'settings' => [AutoDownloadSettings](../types/AutoDownloadSettings.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->saveTheme](account.saveTheme.md)(\['theme' => [InputTheme](../types/InputTheme.md), 'unsave' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[account->saveWallPaper](account.saveWallPaper.md)(\['wallpaper' => [InputWallPaper](../types/InputWallPaper.md), 'unsave' => [Bool](../types/Bool.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[account->sendChangePhoneCode](account.sendChangePhoneCode.md)(\['phone_number' => [string](../types/string.md), 'settings' => [CodeSettings](../types/CodeSettings.md), \]) === [$auth.SentCode](../types/auth.SentCode.md) + +*** +

+$MadelineProto->[account->sendConfirmPhoneCode](account.sendConfirmPhoneCode.md)(\['hash' => [string](../types/string.md), 'settings' => [CodeSettings](../types/CodeSettings.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)(\['phone_number' => [string](../types/string.md), 'settings' => [CodeSettings](../types/CodeSettings.md), \]) === [$auth.SentCode](../types/auth.SentCode.md) + +*** +

+$MadelineProto->[account->setAccountTTL](account.setAccountTTL.md)(\['ttl' => [AccountDaysTTL](../types/AccountDaysTTL.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[account->setContactSignUpNotification](account.setContactSignUpNotification.md)(\['silent' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[account->setContentSettings](account.setContentSettings.md)(\['sensitive_enabled' => [Bool](../types/Bool.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)(\['password' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.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->updateTheme](account.updateTheme.md)(\['format' => [string](../types/string.md), 'theme' => [InputTheme](../types/InputTheme.md), 'slug' => [string](../types/string.md), 'title' => [string](../types/string.md), 'document' => [InputDocument](../types/InputDocument.md), 'settings' => [InputThemeSettings](../types/InputThemeSettings.md), \]) === [$Theme](../types/Theme.md) + +*** +

+$MadelineProto->[account->updateUsername](account.updateUsername.md)(\['username' => [string](../types/string.md), \]) === [$User](../types/User.md) + +*** +

+$MadelineProto->[account->uploadTheme](account.uploadTheme.md)(\['file' => [InputFile](../types/InputFile.md), 'thumb' => [InputFile](../types/InputFile.md), 'file_name' => [string](../types/string.md), 'mime_type' => [string](../types/string.md), \]) === [$Document](../types/Document.md) + +*** +

+$MadelineProto->[account->uploadWallPaper](account.uploadWallPaper.md)(\['file' => [InputFile](../types/InputFile.md), 'mime_type' => [string](../types/string.md), 'settings' => [WallPaperSettings](../types/WallPaperSettings.md), \]) === [$WallPaper](../types/WallPaper.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->acceptLoginToken](auth.acceptLoginToken.md)(\['token' => [bytes](../types/bytes.md), \]) === [$Authorization](../types/Authorization.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' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.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->exportLoginToken](auth.exportLoginToken.md)(\['api_id' => [int](../types/int.md), 'api_hash' => [string](../types/string.md), 'except_ids' => \[[int](../types/int.md)\], \]) === [$auth.LoginToken](../types/auth.LoginToken.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->importLoginToken](auth.importLoginToken.md)(\['token' => [bytes](../types/bytes.md), \]) === [$auth.LoginToken](../types/auth.LoginToken.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)(\['phone_number' => [string](../types/string.md), 'api_id' => [int](../types/int.md), 'api_hash' => [string](../types/string.md), 'settings' => [CodeSettings](../types/CodeSettings.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), '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), 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'address' => [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->editAdmin](channels.editAdmin.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'admin_rights' => [ChatAdminRights](../types/ChatAdminRights.md), 'rank' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[channels->editBanned](channels.editBanned.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[channels->editCreator](channels.editCreator.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'user_id' => [InputUser](../types/InputUser.md), 'password' => [InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md), \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[channels->editLocation](channels.editLocation.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), 'address' => [string](../types/string.md), \]) === [$Bool](../types/Bool.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->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)(\['by_location' => [Bool](../types/Bool.md), 'check_limit' => [Bool](../types/Bool.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->getGroupsForDiscussion](channels.getGroupsForDiscussion.md)(\[\]) === [$messages.Chats](../types/messages.Chats.md) + +*** +

+$MadelineProto->[channels->getInactiveChannels](channels.getInactiveChannels.md)(\[\]) === [$messages.InactiveChats](../types/messages.InactiveChats.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->setDiscussionGroup](channels.setDiscussionGroup.md)(\['broadcast' => [InputChannel](../types/InputChannel.md), 'group' => [InputChannel](../types/InputChannel.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->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->toggleSlowMode](channels.toggleSlowMode.md)(\['channel' => [InputChannel](../types/InputChannel.md), 'seconds' => [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->acceptContact](contacts.acceptContact.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[contacts->addContact](contacts.addContact.md)(\['add_phone_privacy_exception' => [Bool](../types/Bool.md), 'id' => [InputUser](../types/InputUser.md), 'first_name' => [string](../types/string.md), 'last_name' => [string](../types/string.md), 'phone' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[contacts->block](contacts.block.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[contacts->deleteByPhones](contacts.deleteByPhones.md)(\['phones' => \[[string](../types/string.md)\], \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[contacts->deleteContacts](contacts.deleteContacts.md)(\['id' => \[[InputUser](../types/InputUser.md)\], \]) === [$Updates](../types/Updates.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->getContactIDs](contacts.getContactIDs.md)(\['hash' => [int](../types/int.md), \]) === [$Vector\_of\_int](../types/int.md) + +*** +

+$MadelineProto->[contacts->getContacts](contacts.getContacts.md)(\['hash' => [int](../types/int.md), \]) === [$contacts.Contacts](../types/contacts.Contacts.md) + +*** +

+$MadelineProto->[contacts->getLocated](contacts.getLocated.md)(\['geo_point' => [InputGeoPoint](../types/InputGeoPoint.md), \]) === [$Updates](../types/Updates.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), 'forward_users' => [Bool](../types/Bool.md), 'forward_chats' => [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->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->toggleTopPeers](contacts.toggleTopPeers.md)(\['enabled' => [Bool](../types/Bool.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[contacts->unblock](contacts.unblock.md)(\['id' => [InputUser](../types/InputUser.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[folders->deleteFolder](folders.deleteFolder.md)(\['folder_id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[folders->editPeerFolders](folders.editPeerFolders.md)(\['folder_peers' => \[[InputFolderPeer](../types/InputFolderPeer.md)\], \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[help->acceptTermsOfService](help.acceptTermsOfService.md)(\['id' => [DataJSON](../types/DataJSON.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[help->editUserInfo](help.editUserInfo.md)(\['user_id' => [InputUser](../types/InputUser.md), 'message' => [string](../types/string.md), 'entities' => \[[MessageEntity](../types/MessageEntity.md)\], \]) === [$help.UserInfo](../types/help.UserInfo.md) + +*** +

+$MadelineProto->[help->getAppChangelog](help.getAppChangelog.md)(\['prev_app_version' => [string](../types/string.md), \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[help->getAppConfig](help.getAppConfig.md)(\[\]) === [$JSONValue](../types/JSONValue.md) + +*** +

+$MadelineProto->[help->getAppUpdate](help.getAppUpdate.md)(\['source' => [string](../types/string.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->getPassportConfig](help.getPassportConfig.md)(\['hash' => [int](../types/int.md), \]) === [$help.PassportConfig](../types/help.PassportConfig.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->getSupportName](help.getSupportName.md)(\[\]) === [$help.SupportName](../types/help.SupportName.md) + +*** +

+$MadelineProto->[help->getTermsOfServiceUpdate](help.getTermsOfServiceUpdate.md)(\[\]) === [$help.TermsOfServiceUpdate](../types/help.TermsOfServiceUpdate.md) + +*** +

+$MadelineProto->[help->getUserInfo](help.getUserInfo.md)(\['user_id' => [InputUser](../types/InputUser.md), \]) === [$help.UserInfo](../types/help.UserInfo.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)(\['lang_pack' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), 'from_version' => [int](../types/int.md), \]) === [$LangPackDifference](../types/LangPackDifference.md) + +*** +

+$MadelineProto->[langpack->getLangPack](langpack.getLangPack.md)(\['lang_pack' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), \]) === [$LangPackDifference](../types/LangPackDifference.md) + +*** +

+$MadelineProto->[langpack->getLanguage](langpack.getLanguage.md)(\['lang_pack' => [string](../types/string.md), 'lang_code' => [string](../types/string.md), \]) === [$LangPackLanguage](../types/LangPackLanguage.md) + +*** +

+$MadelineProto->[langpack->getLanguages](langpack.getLanguages.md)(\['lang_pack' => [string](../types/string.md), \]) === [$Vector\_of\_LangPackLanguage](../types/LangPackLanguage.md) + +*** +

+$MadelineProto->[langpack->getStrings](langpack.getStrings.md)(\['lang_pack' => [string](../types/string.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->acceptUrlAuth](messages.acceptUrlAuth.md)(\['write_allowed' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'button_id' => [int](../types/int.md), \]) === [$UrlAuthResult](../types/UrlAuthResult.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->clearAllDrafts](messages.clearAllDrafts.md)(\[\]) === [$Bool](../types/Bool.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), 'revoke' => [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->deleteScheduledMessages](messages.deleteScheduledMessages.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[messages->discardEncryption](messages.discardEncryption.md)(\['chat_id' => [int](../types/int.md), \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[messages->editChatAbout](messages.editChatAbout.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'about' => [string](../types/string.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->editChatDefaultBannedRights](messages.editChatDefaultBannedRights.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'banned_rights' => [ChatBannedRights](../types/ChatBannedRights.md), \]) === [$Updates](../types/Updates.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), '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)\], \]) === [$Bool](../types/Bool.md) + +*** +

+$MadelineProto->[messages->editMessage](messages.editMessage.md)(\['no_webpage' => [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)\], 'schedule_date' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[messages->exportChatInvite](messages.exportChatInvite.md)(\['peer' => [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), 'schedule_date' => [int](../types/int.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->getDialogUnreadMarks](messages.getDialogUnreadMarks.md)(\[\]) === [$Vector\_of\_DialogPeer](../types/DialogPeer.md) + +*** +

+$MadelineProto->[messages->getDialogs](messages.getDialogs.md)(\['exclude_pinned' => [Bool](../types/Bool.md), 'folder_id' => [int](../types/int.md), 'offset_date' => [int](../types/int.md), 'offset_id' => [int](../types/int.md), 'offset_peer' => [InputPeer](../types/InputPeer.md), 'limit' => [int](../types/int.md), 'hash' => [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->getEmojiKeywords](messages.getEmojiKeywords.md)(\['lang_code' => [string](../types/string.md), \]) === [$EmojiKeywordsDifference](../types/EmojiKeywordsDifference.md) + +*** +

+$MadelineProto->[messages->getEmojiKeywordsDifference](messages.getEmojiKeywordsDifference.md)(\['lang_code' => [string](../types/string.md), 'from_version' => [int](../types/int.md), \]) === [$EmojiKeywordsDifference](../types/EmojiKeywordsDifference.md) + +*** +

+$MadelineProto->[messages->getEmojiKeywordsLanguages](messages.getEmojiKeywordsLanguages.md)(\['lang_codes' => \[[string](../types/string.md)\], \]) === [$Vector\_of\_EmojiLanguage](../types/EmojiLanguage.md) + +*** +

+$MadelineProto->[messages->getEmojiURL](messages.getEmojiURL.md)(\['lang_code' => [string](../types/string.md), \]) === [$EmojiURL](../types/EmojiURL.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->getOnlines](messages.getOnlines.md)(\['peer' => [InputPeer](../types/InputPeer.md), \]) === [$ChatOnlines](../types/ChatOnlines.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)(\['folder_id' => [int](../types/int.md), \]) === [$messages.PeerDialogs](../types/messages.PeerDialogs.md) + +*** +

+$MadelineProto->[messages->getPollResults](messages.getPollResults.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[messages->getPollVotes](messages.getPollVotes.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), 'option' => [bytes](../types/bytes.md), 'offset' => [string](../types/string.md), 'limit' => [int](../types/int.md), \]) === [$messages.VotesList](../types/messages.VotesList.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->getScheduledHistory](messages.getScheduledHistory.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'hash' => [int](../types/int.md), \]) === [$messages.Messages](../types/messages.Messages.md) + +*** +

+$MadelineProto->[messages->getScheduledMessages](messages.getScheduledMessages.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.md)\], \]) === [$messages.Messages](../types/messages.Messages.md) + +*** +

+$MadelineProto->[messages->getSearchCounters](messages.getSearchCounters.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'filters' => \[[MessagesFilter](../types/MessagesFilter.md)\], \]) === [$Vector\_of\_messages.SearchCounter](../types/messages.SearchCounter.md) + +*** +

+$MadelineProto->[messages->getSplitRanges](messages.getSplitRanges.md)(\[\]) === [$Vector\_of\_MessageRange](../types/MessageRange.md) + +*** +

+$MadelineProto->[messages->getStatsURL](messages.getStatsURL.md)(\['dark' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'params' => [string](../types/string.md), \]) === [$StatsURL](../types/StatsURL.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->hidePeerSettingsBar](messages.hidePeerSettingsBar.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->markDialogUnread](messages.markDialogUnread.md)(\['unread' => [Bool](../types/Bool.md), 'peer' => [InputDialogPeer](../types/InputDialogPeer.md), \]) === [$Bool](../types/Bool.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), 'folder_id' => [int](../types/int.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->requestUrlAuth](messages.requestUrlAuth.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'button_id' => [int](../types/int.md), \]) === [$UrlAuthResult](../types/UrlAuthResult.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)(\['folder_id' => [int](../types/int.md), 'q' => [string](../types/string.md), 'offset_rate' => [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), 'data' => [bytes](../types/bytes.md), \]) === [$messages.SentEncryptedMessage](../types/messages.SentEncryptedMessage.md) + +*** +

+$MadelineProto->[messages->sendEncryptedFile](messages.sendEncryptedFile.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'data' => [bytes](../types/bytes.md), 'file' => [InputEncryptedFile](../types/InputEncryptedFile.md), \]) === [$messages.SentEncryptedMessage](../types/messages.SentEncryptedMessage.md) + +*** +

+$MadelineProto->[messages->sendEncryptedService](messages.sendEncryptedService.md)(\['peer' => [InputEncryptedChat](../types/InputEncryptedChat.md), 'data' => [bytes](../types/bytes.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), 'hide_via' => [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), 'schedule_date' => [int](../types/int.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)\], 'schedule_date' => [int](../types/int.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)\], 'schedule_date' => [int](../types/int.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)\], 'schedule_date' => [int](../types/int.md), \]) === [$Updates](../types/Updates.md) + +*** +

+$MadelineProto->[messages->sendScheduledMessages](messages.sendScheduledMessages.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'id' => \[[int](../types/int.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->sendVote](messages.sendVote.md)(\['peer' => [InputPeer](../types/InputPeer.md), 'msg_id' => [int](../types/int.md), 'options' => \[[bytes](../types/bytes.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->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->updatePinnedMessage](messages.updatePinnedMessage.md)(\['silent' => [Bool](../types/Bool.md), 'peer' => [InputPeer](../types/InputPeer.md), 'id' => [int](../types/int.md), \]) === [$Updates](../types/Updates.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)(\['video' => [Bool](../types/Bool.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)(\['video' => [Bool](../types/Bool.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)(\['user_initiative' => [Bool](../types/Bool.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)(\['precise' => [Bool](../types/Bool.md), 'cdn_supported' => [Bool](../types/Bool.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_v109/methods/auth.acceptLoginToken.md b/old_docs/API_docs_v109/methods/auth.acceptLoginToken.md new file mode 100644 index 00000000..142ec8f0 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.acceptLoginToken.md @@ -0,0 +1,43 @@ +--- +title: auth.acceptLoginToken +description: auth.acceptLoginToken parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_acceptLoginToken.html +--- +# Method: auth.acceptLoginToken +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|token|[bytes](../types/bytes.md) | Yes| + + +### Return type: [Authorization](../types/Authorization.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$Authorization = $MadelineProto->auth->acceptLoginToken(['token' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +Authorization = auth.acceptLoginToken({token='bytes', }) +``` + diff --git a/old_docs/API_docs_v109/methods/auth.bindTempAuthKey.md b/old_docs/API_docs_v109/methods/auth.bindTempAuthKey.md new file mode 100644 index 00000000..b72ae700 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.bindTempAuthKey.md @@ -0,0 +1,58 @@ +--- +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 +redirect_from: /API_docs/methods/auth_bindTempAuthKey.html +--- +# 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 + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|perm\_auth\_key\_id|[long](../types/long.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 | Yes| +|nonce|[long](../types/long.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 | Yes| +|expires\_at|[int](../types/int.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 | Yes| +|encrypted\_message|[bytes](../types/bytes.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 | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->bindTempAuthKey(['perm_auth_key_id' => long, 'nonce' => long, 'expires_at' => int, 'encrypted_message' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = auth.bindTempAuthKey({perm_auth_key_id=long, nonce=long, expires_at=int, encrypted_message='bytes', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|ENCRYPTED_MESSAGE_INVALID|Encrypted message invalid| +|400|INPUT_REQUEST_TOO_LONG|The request is too big| +|400|TEMP_AUTH_KEY_EMPTY|No temporary auth key provided| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/auth.cancelCode.md b/old_docs/API_docs_v109/methods/auth.cancelCode.md new file mode 100644 index 00000000..501b9545 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.cancelCode.md @@ -0,0 +1,54 @@ +--- +title: auth.cancelCode +description: Cancel the login verification code +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_cancelCode.html +--- +# Method: auth.cancelCode +[Back to methods index](index.md) + + +Cancel the login verification code + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code hash from [auth.sendCode](../methods/auth.sendCode.md) | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PHONE_CODE_EXPIRED|The phone code you provided has expired, this may happen if it was sent to any chat on telegram (if the code is sent through a telegram chat (not the official account) to avoid it append or prepend to the code some chars)| +|400|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v109/methods/auth.checkPassword.md b/old_docs/API_docs_v109/methods/auth.checkPassword.md new file mode 100644 index 00000000..1355b082 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.checkPassword.md @@ -0,0 +1,54 @@ +--- +title: auth.checkPassword +description: You cannot use this method directly, use the complete2falogin method instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_checkPassword.html +--- +# Method: auth.checkPassword +[Back to methods index](index.md) + + +You cannot use this method directly, use the complete2falogin method instead (see https://docs.madelineproto.xyz for more info) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | You cannot use this method directly, use the complete2falogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| + + +### Return type: [auth.Authorization](../types/auth.Authorization.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->checkPassword(['password' => InputCheckPasswordSRP, ]); +``` + +Or, if you're into Lua: + +```lua +auth.Authorization = auth.checkPassword({password=InputCheckPasswordSRP, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|400|SRP_ID_INVALID|Invalid SRP ID provided| +|400|SRP_PASSWORD_CHANGED|Password has changed| + + diff --git a/old_docs/API_docs_v109/methods/auth.dropTempAuthKeys.md b/old_docs/API_docs_v109/methods/auth.dropTempAuthKeys.md new file mode 100644 index 00000000..31aeaf26 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.dropTempAuthKeys.md @@ -0,0 +1,45 @@ +--- +title: auth.dropTempAuthKeys +description: Delete all temporary authorization keys **except for** the ones specified +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_dropTempAuthKeys.html +--- +# Method: auth.dropTempAuthKeys +[Back to methods index](index.md) + + +Delete all temporary authorization keys **except for** the ones specified + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_auth\_keys|Array of [long](../types/long.md) | The temporary authorization keys to keep | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = auth.dropTempAuthKeys({except_auth_keys={long}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/auth.exportAuthorization.md b/old_docs/API_docs_v109/methods/auth.exportAuthorization.md new file mode 100644 index 00000000..b0362fbb --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.exportAuthorization.md @@ -0,0 +1,52 @@ +--- +title: auth.exportAuthorization +description: You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_exportAuthorization.html +--- +# Method: auth.exportAuthorization +[Back to methods index](index.md) + + +You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|dc\_id|[int](../types/int.md) | You cannot use this method directly, use $MadelineProto->exportAuthorization() instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes| + + +### Return type: [auth.ExportedAuthorization](../types/auth.ExportedAuthorization.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.ExportedAuthorization = $MadelineProto->auth->exportAuthorization(['dc_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +auth.ExportedAuthorization = auth.exportAuthorization({dc_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|DC_ID_INVALID|The provided DC ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/auth.exportLoginToken.md b/old_docs/API_docs_v109/methods/auth.exportLoginToken.md new file mode 100644 index 00000000..a6587cbc --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.exportLoginToken.md @@ -0,0 +1,45 @@ +--- +title: auth.exportLoginToken +description: auth.exportLoginToken parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_exportLoginToken.html +--- +# Method: auth.exportLoginToken +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|api\_id|[int](../types/int.md) | Yes| +|api\_hash|[string](../types/string.md) | Yes| +|except\_ids|Array of [int](../types/int.md) | Yes| + + +### Return type: [auth.LoginToken](../types/auth.LoginToken.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.LoginToken = $MadelineProto->auth->exportLoginToken(['api_id' => int, 'api_hash' => 'string', 'except_ids' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +auth.LoginToken = auth.exportLoginToken({api_id=int, api_hash='string', except_ids={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/auth.importAuthorization.md b/old_docs/API_docs_v109/methods/auth.importAuthorization.md new file mode 100644 index 00000000..3ebbe66e --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.importAuthorization.md @@ -0,0 +1,54 @@ +--- +title: auth.importAuthorization +description: You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_importAuthorization.html +--- +# Method: auth.importAuthorization +[Back to methods index](index.md) + + +You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[int](../types/int.md) | You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes| +|bytes|[bytes](../types/bytes.md) | You cannot use this method directly, use $MadelineProto->importAuthorization($authorization) instead, see https://docs.madelineproto.xyz/docs/LOGIN.html | Yes| + + +### Return type: [auth.Authorization](../types/auth.Authorization.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->importAuthorization(['id' => int, 'bytes' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +auth.Authorization = auth.importAuthorization({id=int, bytes='bytes', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|AUTH_BYTES_INVALID|The provided authorization is invalid| +|400|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/auth.importBotAuthorization.md b/old_docs/API_docs_v109/methods/auth.importBotAuthorization.md new file mode 100644 index 00000000..fc42caec --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.importBotAuthorization.md @@ -0,0 +1,57 @@ +--- +title: auth.importBotAuthorization +description: You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_importBotAuthorization.html +--- +# Method: auth.importBotAuthorization +[Back to methods index](index.md) + + +You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|api\_id|[int](../types/int.md) | You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|api\_hash|[string](../types/string.md) | You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|bot\_auth\_token|[string](../types/string.md) | You cannot use this method directly, use the botLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| + + +### Return type: [auth.Authorization](../types/auth.Authorization.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->importBotAuthorization(['api_id' => int, 'api_hash' => 'string', 'bot_auth_token' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +auth.Authorization = auth.importBotAuthorization({api_id=int, api_hash='string', bot_auth_token='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|ACCESS_TOKEN_EXPIRED|Access token expired| +|400|ACCESS_TOKEN_INVALID|Access token invalid| +|400|API_ID_INVALID|API ID invalid| +|401|AUTH_KEY_INVALID|Auth key invalid| + + diff --git a/old_docs/API_docs_v109/methods/auth.importLoginToken.md b/old_docs/API_docs_v109/methods/auth.importLoginToken.md new file mode 100644 index 00000000..38bb68e0 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.importLoginToken.md @@ -0,0 +1,43 @@ +--- +title: auth.importLoginToken +description: auth.importLoginToken parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_importLoginToken.html +--- +# Method: auth.importLoginToken +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|token|[bytes](../types/bytes.md) | Yes| + + +### Return type: [auth.LoginToken](../types/auth.LoginToken.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.LoginToken = $MadelineProto->auth->importLoginToken(['token' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +auth.LoginToken = auth.importLoginToken({token='bytes', }) +``` + diff --git a/old_docs/API_docs_v109/methods/auth.logOut.md b/old_docs/API_docs_v109/methods/auth.logOut.md new file mode 100644 index 00000000..e3aac602 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.logOut.md @@ -0,0 +1,40 @@ +--- +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 +redirect_from: /API_docs/methods/auth_logOut.html +--- +# 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) + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->logOut(); +``` + +Or, if you're into Lua: + +```lua +Bool = auth.logOut({}) +``` + diff --git a/old_docs/API_docs_v109/methods/auth.recoverPassword.md b/old_docs/API_docs_v109/methods/auth.recoverPassword.md new file mode 100644 index 00000000..9d0183b9 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.recoverPassword.md @@ -0,0 +1,52 @@ +--- +title: auth.recoverPassword +description: Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_recoverPassword.html +--- +# Method: auth.recoverPassword +[Back to methods index](index.md) + + +Reset the [2FA password](https://core.telegram.org/api/srp) using the recovery code sent using [auth.requestPasswordRecovery](../methods/auth.requestPasswordRecovery.md). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|code|[string](../types/string.md) | Code received via email | Yes| + + +### Return type: [auth.Authorization](../types/auth.Authorization.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +auth.Authorization = auth.recoverPassword({code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CODE_EMPTY|The provided code is empty| + + diff --git a/old_docs/API_docs_v109/methods/auth.requestPasswordRecovery.md b/old_docs/API_docs_v109/methods/auth.requestPasswordRecovery.md new file mode 100644 index 00000000..a7ee1a9e --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.requestPasswordRecovery.md @@ -0,0 +1,47 @@ +--- +title: auth.requestPasswordRecovery +description: Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_requestPasswordRecovery.html +--- +# Method: auth.requestPasswordRecovery +[Back to methods index](index.md) + + +Request recovery code of a [2FA password](https://core.telegram.org/api/srp), only for accounts with a [recovery email configured](https://core.telegram.org/api/srp#email-verification). + + + +### Return type: [auth.PasswordRecovery](../types/auth.PasswordRecovery.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +auth.PasswordRecovery = auth.requestPasswordRecovery({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PASSWORD_EMPTY|The provided password is empty| + + diff --git a/old_docs/API_docs_v109/methods/auth.resendCode.md b/old_docs/API_docs_v109/methods/auth.resendCode.md new file mode 100644 index 00000000..2969dd42 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.resendCode.md @@ -0,0 +1,55 @@ +--- +title: auth.resendCode +description: Resend the login code via another medium, the phone code type is determined by the return value of the previous auth.sendCode/auth.resendCode: see [login](https://core.telegram.org/api/auth) for more info. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_resendCode.html +--- +# Method: auth.resendCode +[Back to methods index](index.md) + + +Resend the login code via another medium, the phone code type is determined by the return value of the previous auth.sendCode/auth.resendCode: see [login](https://core.telegram.org/api/auth) for more info. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | The phone code hash obtained from [auth.sendCode](../methods/auth.sendCode.md) | Yes| + + +### Return type: [auth.SentCode](../types/auth.SentCode.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +auth.SentCode = auth.resendCode({phone_number='string', phone_code_hash='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PHONE_CODE_EXPIRED|The phone code you provided has expired, this may happen if it was sent to any chat on telegram (if the code is sent through a telegram chat (not the official account) to avoid it append or prepend to the code some chars)| +|400|PHONE_CODE_HASH_EMPTY|phone_code_hash is missing| +|400|PHONE_NUMBER_INVALID|The phone number is invalid| + + diff --git a/old_docs/API_docs_v109/methods/auth.resetAuthorizations.md b/old_docs/API_docs_v109/methods/auth.resetAuthorizations.md new file mode 100644 index 00000000..c98b3099 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.resetAuthorizations.md @@ -0,0 +1,52 @@ +--- +title: auth.resetAuthorizations +description: Terminates all user's authorized sessions except for the current one. + +After calling this method it is necessary to reregister the current device using the method [account.registerDevice](../methods/account.registerDevice.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_resetAuthorizations.html +--- +# Method: auth.resetAuthorizations +[Back to methods index](index.md) + + +Terminates all user's authorized sessions except for the current one. + +After calling this method it is necessary to reregister the current device using the method [account.registerDevice](../methods/account.registerDevice.md) + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +Bool = auth.resetAuthorizations({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|406|FRESH_RESET_AUTHORISATION_FORBIDDEN|You can't logout other sessions if less than 24 hours have passed since you logged on the current session| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/auth.sendCode.md b/old_docs/API_docs_v109/methods/auth.sendCode.md new file mode 100644 index 00000000..e987f59f --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.sendCode.md @@ -0,0 +1,65 @@ +--- +title: auth.sendCode +description: You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_sendCode.html +--- +# Method: auth.sendCode +[Back to methods index](index.md) + + +You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|api\_id|[int](../types/int.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|api\_hash|[string](../types/string.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|settings|[CodeSettings](../types/CodeSettings.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| + + +### Return type: [auth.SentCode](../types/auth.SentCode.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->sendCode(['phone_number' => 'string', 'api_id' => int, 'api_hash' => 'string', 'settings' => CodeSettings, ]); +``` + +Or, if you're into Lua: + +```lua +auth.SentCode = auth.sendCode({phone_number='string', api_id=int, api_hash='string', settings=CodeSettings, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|API_ID_INVALID|API ID invalid| +|400|API_ID_PUBLISHED_FLOOD|This API id was published somewhere, you can't use it now| +|400|INPUT_REQUEST_TOO_LONG|The request is too big| +|400|PHONE_NUMBER_APP_SIGNUP_FORBIDDEN|You can't sign up using this app| +|400|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram| +|400|PHONE_NUMBER_FLOOD|You asked for the code too many times.| +|400|PHONE_NUMBER_INVALID|The phone number is invalid| +|400|PHONE_PASSWORD_PROTECTED|This phone is password protected| +|400|SMS_CODE_CREATE_FAILED|An error occurred while creating the SMS code| +|406|PHONE_NUMBER_INVALID|The phone number is invalid| +|406|PHONE_PASSWORD_FLOOD|You have tried logging in too many times| + + diff --git a/old_docs/API_docs_v109/methods/auth.signIn.md b/old_docs/API_docs_v109/methods/auth.signIn.md new file mode 100644 index 00000000..575f3268 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.signIn.md @@ -0,0 +1,59 @@ +--- +title: auth.signIn +description: You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_signIn.html +--- +# Method: auth.signIn +[Back to methods index](index.md) + + +You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|phone\_code\_hash|[string](../types/string.md) | You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|phone\_code|[string](../types/string.md) | You cannot use this method directly, use the completePhoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes| + + +### Return type: [auth.Authorization](../types/auth.Authorization.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->signIn(['phone_number' => 'string', 'phone_code_hash' => 'string', 'phone_code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +auth.Authorization = auth.signIn({phone_number='string', phone_code_hash='string', phone_code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PHONE_CODE_EMPTY|phone_code is missing| +|400|PHONE_CODE_EXPIRED|The phone code you provided has expired, this may happen if it was sent to any chat on telegram (if the code is sent through a telegram chat (not the official account) to avoid it append or prepend to the code some chars)| +|400|PHONE_CODE_INVALID|The provided phone code is invalid| +|400|PHONE_NUMBER_INVALID|The phone number is invalid| +|400|PHONE_NUMBER_UNOCCUPIED|The phone number is not yet being used| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v109/methods/auth.signUp.md b/old_docs/API_docs_v109/methods/auth.signUp.md new file mode 100644 index 00000000..e1969399 --- /dev/null +++ b/old_docs/API_docs_v109/methods/auth.signUp.md @@ -0,0 +1,61 @@ +--- +title: auth.signUp +description: You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/auth_signUp.html +--- +# Method: auth.signUp +[Back to methods index](index.md) + + +You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|phone\_code\_hash|[string](../types/string.md) | You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|first\_name|[string](../types/string.md) | You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) | Yes| +|last\_name|[string](../types/string.md) | You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) | Yes| + + +### Return type: [auth.Authorization](../types/auth.Authorization.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->signUp(['phone_number' => 'string', 'phone_code_hash' => 'string', 'first_name' => 'string', 'last_name' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +auth.Authorization = auth.signUp({phone_number='string', phone_code_hash='string', first_name='string', last_name='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|FIRSTNAME_INVALID|The first name is invalid| +|400|PHONE_CODE_EMPTY|phone_code is missing| +|400|PHONE_CODE_EXPIRED|The phone code you provided has expired, this may happen if it was sent to any chat on telegram (if the code is sent through a telegram chat (not the official account) to avoid it append or prepend to the code some chars)| +|400|PHONE_CODE_INVALID|The provided phone code is invalid| +|400|PHONE_NUMBER_FLOOD|You asked for the code too many times.| +|400|PHONE_NUMBER_INVALID|The phone number is invalid| +|400|PHONE_NUMBER_OCCUPIED|The phone number is already in use| + + diff --git a/old_docs/API_docs_v109/methods/bots.answerWebhookJSONQuery.md b/old_docs/API_docs_v109/methods/bots.answerWebhookJSONQuery.md new file mode 100644 index 00000000..9437621c --- /dev/null +++ b/old_docs/API_docs_v109/methods/bots.answerWebhookJSONQuery.md @@ -0,0 +1,54 @@ +--- +title: bots.answerWebhookJSONQuery +description: Answers a custom query; for bots only +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/bots_answerWebhookJSONQuery.html +--- +# Method: bots.answerWebhookJSONQuery +[Back to methods index](index.md) + + +Answers a custom query; for bots only + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Identifier of a custom query | Yes| +|data|[DataJSON](../types/DataJSON.md) | JSON-serialized answer to the query | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = bots.answerWebhookJSONQuery({query_id=long, data=DataJSON, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|QUERY_ID_INVALID|The query ID is invalid| +|400|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v109/methods/bots.sendCustomRequest.md b/old_docs/API_docs_v109/methods/bots.sendCustomRequest.md new file mode 100644 index 00000000..a71cb7b2 --- /dev/null +++ b/old_docs/API_docs_v109/methods/bots.sendCustomRequest.md @@ -0,0 +1,53 @@ +--- +title: bots.sendCustomRequest +description: Sends a custom request; for bots only +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/bots_sendCustomRequest.html +--- +# Method: bots.sendCustomRequest +[Back to methods index](index.md) + + +Sends a custom request; for bots only + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|custom\_method|[string](../types/string.md) | The method name | Yes| +|params|[DataJSON](../types/DataJSON.md) | JSON-serialized method parameters | Yes| + + +### Return type: [DataJSON](../types/DataJSON.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +DataJSON = bots.sendCustomRequest({custom_method='string', params=DataJSON, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v109/methods/channels.checkUsername.md b/old_docs/API_docs_v109/methods/channels.checkUsername.md new file mode 100644 index 00000000..32ffa7e0 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.checkUsername.md @@ -0,0 +1,55 @@ +--- +title: channels.checkUsername +description: Check if a username is free and can be assigned to a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_checkUsername.html +--- +# Method: channels.checkUsername +[Back to methods index](index.md) + + +Check if a username is free and can be assigned to a channel/supergroup + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The [channel/supergroup](https://core.telegram.org/api/channel) that will assigned the specified username | Optional| +|username|[string](../types/string.md) | The username to check | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.checkUsername({channel=InputChannel, username='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|USERNAME_INVALID|The provided username is not valid| + + diff --git a/old_docs/API_docs_v109/methods/channels.createChannel.md b/old_docs/API_docs_v109/methods/channels.createChannel.md new file mode 100644 index 00000000..fdfccdc3 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.createChannel.md @@ -0,0 +1,61 @@ +--- +title: channels.createChannel +description: Create a [supergroup/channel](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_createChannel.html +--- +# Method: channels.createChannel +[Back to methods index](index.md) + + +Create a [supergroup/channel](https://core.telegram.org/api/channel). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Whether to create a [channel](https://core.telegram.org/api/channel) | Optional| +|megagroup|[Bool](../types/Bool.md) | Whether to create a [supergroup](https://core.telegram.org/api/channel) | Optional| +|title|[string](../types/string.md) | Channel title | Yes| +|about|[string](../types/string.md) | Channel description | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Geogroup location | Optional| +|address|[string](../types/string.md) | Geogroup address | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', 'geo_point' => InputGeoPoint, 'address' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.createChannel({broadcast=Bool, megagroup=Bool, title='string', about='string', geo_point=InputGeoPoint, address='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|400|CHAT_ABOUT_TOO_LONG|Chat about too long| +|400|CHAT_TITLE_EMPTY|No chat title provided| +|406|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| +|403|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v109/methods/channels.deleteChannel.md b/old_docs/API_docs_v109/methods/channels.deleteChannel.md new file mode 100644 index 00000000..a5ca2dfb --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.deleteChannel.md @@ -0,0 +1,55 @@ +--- +title: channels.deleteChannel +description: Delete a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_deleteChannel.html +--- +# Method: channels.deleteChannel +[Back to methods index](index.md) + + +Delete a [channel/supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Channel/supergroup](https://core.telegram.org/api/channel) to delete | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.deleteChannel({channel=InputChannel, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/channels.deleteHistory.md b/old_docs/API_docs_v109/methods/channels.deleteHistory.md new file mode 100644 index 00000000..eac231f1 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.deleteHistory.md @@ -0,0 +1,53 @@ +--- +title: channels.deleteHistory +description: Delete the history of a [supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_deleteHistory.html +--- +# Method: channels.deleteHistory +[Back to methods index](index.md) + + +Delete the history of a [supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Supergroup](https://core.telegram.org/api/channel) whose history must be deleted | Optional| +|max\_id|[int](../types/int.md) | ID of message **up to which** the history must be deleted | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.deleteHistory({channel=InputChannel, max_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| + + diff --git a/old_docs/API_docs_v109/methods/channels.deleteMessages.md b/old_docs/API_docs_v109/methods/channels.deleteMessages.md new file mode 100644 index 00000000..4d81e81e --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.deleteMessages.md @@ -0,0 +1,56 @@ +--- +title: channels.deleteMessages +description: Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_deleteMessages.html +--- +# Method: channels.deleteMessages +[Back to methods index](index.md) + + +Delete messages in a [channel/supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Channel/supergroup](https://core.telegram.org/api/channel) | Optional| +|id|Array of [int](../types/int.md) | The IDs of messages to delete | Yes| + + +### Return type: [messages.AffectedMessages](../types/messages.AffectedMessages.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +messages.AffectedMessages = channels.deleteMessages({channel=InputChannel, id={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|MSG_ID_INVALID|Invalid message ID provided| +|403|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_v109/methods/channels.deleteUserHistory.md b/old_docs/API_docs_v109/methods/channels.deleteUserHistory.md new file mode 100644 index 00000000..2acb5717 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.deleteUserHistory.md @@ -0,0 +1,58 @@ +--- +title: channels.deleteUserHistory +description: Delete all messages sent by a certain user in a [supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_deleteUserHistory.html +--- +# Method: channels.deleteUserHistory +[Back to methods index](index.md) + + +Delete all messages sent by a certain user in a [supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Supergroup](https://core.telegram.org/api/channel) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User whose messages should be deleted | Optional| + + +### Return type: [messages.AffectedHistory](../types/messages.AffectedHistory.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.AffectedHistory = channels.deleteUserHistory({channel=InputChannel, user_id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|USER_ID_INVALID|The provided user ID is invalid| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/channels.editAdmin.md b/old_docs/API_docs_v109/methods/channels.editAdmin.md new file mode 100644 index 00000000..41926192 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.editAdmin.md @@ -0,0 +1,68 @@ +--- +title: channels.editAdmin +description: Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_editAdmin.html +--- +# Method: channels.editAdmin +[Back to methods index](index.md) + + +Modify the admin rights of a user in a [supergroup/channel](https://core.telegram.org/api/channel). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The [supergroup/channel](https://core.telegram.org/api/channel). | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ID of the user whose admin rights should be modified | Optional| +|admin\_rights|[ChatAdminRights](../types/ChatAdminRights.md) | The admin rights | Yes| +|rank|[string](../types/string.md) | Indicates the role (rank) of the admin in the group: just an arbitrary string | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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' => ChatAdminRights, 'rank' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.editAdmin({channel=InputChannel, user_id=InputUser, admin_rights=ChatAdminRights, rank='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|ADMINS_TOO_MUCH|There are too many admins| +|400|BOT_CHANNELS_NA|Bots can't edit admin privileges| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|USER_CREATOR|You can't leave this channel, because you're its creator| +|400|USER_ID_INVALID|The provided user ID is invalid| +|400|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|403|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|403|RIGHT_FORBIDDEN|Your admin rights do not allow you to do this| +|403|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| +|403|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v109/methods/channels.editBanned.md b/old_docs/API_docs_v109/methods/channels.editBanned.md new file mode 100644 index 00000000..0b19f935 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.editBanned.md @@ -0,0 +1,61 @@ +--- +title: channels.editBanned +description: Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_editBanned.html +--- +# Method: channels.editBanned +[Back to methods index](index.md) + + +Ban/unban/kick a user in a [supergroup/channel](https://core.telegram.org/api/channel). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The [supergroup/channel](https://core.telegram.org/api/channel). | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ID of the user whose banned rights should be modified | Optional| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | The banned rights | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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' => ChatBannedRights, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.editBanned({channel=InputChannel, user_id=InputUser, banned_rights=ChatBannedRights, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PINNED_DIALOGS_TOO_MUCH|Too many pinned dialogs| +|400|USER_ADMIN_INVALID|You're not an admin| +|400|USER_ID_INVALID|The provided user ID is invalid| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/channels.editCreator.md b/old_docs/API_docs_v109/methods/channels.editCreator.md new file mode 100644 index 00000000..3149f157 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.editCreator.md @@ -0,0 +1,57 @@ +--- +title: channels.editCreator +description: Transfer channel ownership +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_editCreator.html +--- +# Method: channels.editCreator +[Back to methods index](index.md) + + +Transfer channel ownership + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | New channel owner | Optional| +|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | [2FA password](https://core.telegram.org/api/srp) of account | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->editCreator(['channel' => InputChannel, 'user_id' => InputUser, 'password' => InputCheckPasswordSRP, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.editCreator({channel=InputChannel, user_id=InputUser, password=InputCheckPasswordSRP, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|PASSWORD_HASH_INVALID|The provided password hash is invalid| +|400|PASSWORD_TOO_FRESH_X|The password was modified less than 24 hours ago, try again in X seconds| +|400|SESSION_TOO_FRESH_X|This session was created less than 24 hours ago, try again in X seconds| + + diff --git a/old_docs/API_docs_v109/methods/channels.editLocation.md b/old_docs/API_docs_v109/methods/channels.editLocation.md new file mode 100644 index 00000000..deab3b55 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.editLocation.md @@ -0,0 +1,47 @@ +--- +title: channels.editLocation +description: Edit location of geogroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_editLocation.html +--- +# Method: channels.editLocation +[Back to methods index](index.md) + + +Edit location of geogroup + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Geogroup](https://core.telegram.org/api/channel) | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | New geolocation | Optional| +|address|[string](../types/string.md) | Address string | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->editLocation(['channel' => InputChannel, 'geo_point' => InputGeoPoint, 'address' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.editLocation({channel=InputChannel, geo_point=InputGeoPoint, address='string', }) +``` + diff --git a/old_docs/API_docs_v109/methods/channels.editPhoto.md b/old_docs/API_docs_v109/methods/channels.editPhoto.md new file mode 100644 index 00000000..1ed27382 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.editPhoto.md @@ -0,0 +1,59 @@ +--- +title: channels.editPhoto +description: Change the photo of a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_editPhoto.html +--- +# Method: channels.editPhoto +[Back to methods index](index.md) + + +Change the photo of a [channel/supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel/supergroup whose photo should be edited | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | New photo | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.editPhoto({channel=InputChannel, photo=InputChatPhoto, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified| +|400|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|400|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|400|PHOTO_INVALID|Photo invalid| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/channels.editTitle.md b/old_docs/API_docs_v109/methods/channels.editTitle.md new file mode 100644 index 00000000..293902d5 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.editTitle.md @@ -0,0 +1,57 @@ +--- +title: channels.editTitle +description: Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_editTitle.html +--- +# Method: channels.editTitle +[Back to methods index](index.md) + + +Edit the name of a [channel/supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel/supergroup | Optional| +|title|[string](../types/string.md) | New name | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.editTitle({channel=InputChannel, title='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified| +|400|CHAT_TITLE_EMPTY|No chat title provided| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/channels.exportMessageLink.md b/old_docs/API_docs_v109/methods/channels.exportMessageLink.md new file mode 100644 index 00000000..f20b70cc --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.exportMessageLink.md @@ -0,0 +1,56 @@ +--- +title: channels.exportMessageLink +description: Get link and embed info of a message in a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_exportMessageLink.html +--- +# Method: channels.exportMessageLink +[Back to methods index](index.md) + + +Get link and embed info of a message in a [channel/supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|id|[int](../types/int.md) | Message ID | Yes| +|grouped|[Bool](../types/Bool.md) | Whether to include other grouped media (for albums) | Yes| + + +### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +ExportedMessageLink = channels.exportMessageLink({channel=InputChannel, id=int, grouped=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/channels.getAdminLog.md b/old_docs/API_docs_v109/methods/channels.getAdminLog.md new file mode 100644 index 00000000..39c1cfe7 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.getAdminLog.md @@ -0,0 +1,61 @@ +--- +title: channels.getAdminLog +description: Get the admin log of a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getAdminLog.html +--- +# Method: channels.getAdminLog +[Back to methods index](index.md) + + +Get the admin log of a [channel/supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|q|[string](../types/string.md) | Search query, can be empty | Yes| +|events\_filter|[ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Event filter | Optional| +|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Fetch only actions from these admins | Optional| +|max\_id|[long](../types/long.md) | Maximum ID of message to return (see [pagination](https://core.telegram.org/api/offsets)) | Yes| +|min\_id|[long](../types/long.md) | Minimum ID of message to return (see [pagination](https://core.telegram.org/api/offsets)) | Yes| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [channels.AdminLogResults](../types/channels.AdminLogResults.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +channels.AdminLogResults = channels.getAdminLog({channel=InputChannel, q='string', events_filter=ChannelAdminLogEventsFilter, admins={InputUser}, max_id=long, min_id=long, limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/channels.getAdminedPublicChannels.md b/old_docs/API_docs_v109/methods/channels.getAdminedPublicChannels.md new file mode 100644 index 00000000..1ceb124d --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.getAdminedPublicChannels.md @@ -0,0 +1,46 @@ +--- +title: channels.getAdminedPublicChannels +description: Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getAdminedPublicChannels.html +--- +# Method: channels.getAdminedPublicChannels +[Back to methods index](index.md) + + +Get [channels/supergroups/geogroups](https://core.telegram.org/api/channel) we're admin in. Usually called when the user exceeds the [limit](../constructors/config.md) for owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), and the user is given the choice to remove one of his channels/supergroups/geogroups. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|by\_location|[Bool](../types/Bool.md) | Get geogroups | Optional| +|check\_limit|[Bool](../types/Bool.md) | If set and the user has reached the limit of owned public [channels/supergroups/geogroups](https://core.telegram.org/api/channel), instead of returning the channel list one of the specified [errors](#possible-errors) will be returned.
Useful to check if a new public channel can indeed be created, even before asking the user to enter a channel username to use in [channels.checkUsername](../methods/channels.checkUsername.md)/[channels.updateUsername](../methods/channels.updateUsername.md). | Optional| + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['by_location' => Bool, 'check_limit' => Bool, ]); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = channels.getAdminedPublicChannels({by_location=Bool, check_limit=Bool, }) +``` + diff --git a/old_docs/API_docs_v109/methods/channels.getChannels.md b/old_docs/API_docs_v109/methods/channels.getChannels.md new file mode 100644 index 00000000..218b620b --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.getChannels.md @@ -0,0 +1,56 @@ +--- +title: channels.getChannels +description: Get info about [channels/supergroups](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getChannels.html +--- +# Method: channels.getChannels +[Back to methods index](index.md) + + +Get info about [channels/supergroups](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup MTProto IDs | Yes| + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = channels.getChannels({id={InputChannel}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|MSG_ID_INVALID|Invalid message ID provided| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v109/methods/channels.getFullChannel.md b/old_docs/API_docs_v109/methods/channels.getFullChannel.md new file mode 100644 index 00000000..a71e0380 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.getFullChannel.md @@ -0,0 +1,57 @@ +--- +title: channels.getFullChannel +description: You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getFullChannel.html +--- +# Method: channels.getFullChannel +[Back to methods index](index.md) + + +You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) | Optional| + + +### Return type: [messages.ChatFull](../types/messages.ChatFull.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.ChatFull = $MadelineProto->channels->getFullChannel(['channel' => InputChannel, ]); +``` + +Or, if you're into Lua: + +```lua +messages.ChatFull = channels.getFullChannel({channel=InputChannel, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|MSG_ID_INVALID|Invalid message ID provided| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|403|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/channels.getGroupsForDiscussion.md b/old_docs/API_docs_v109/methods/channels.getGroupsForDiscussion.md new file mode 100644 index 00000000..a94ce324 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.getGroupsForDiscussion.md @@ -0,0 +1,40 @@ +--- +title: channels.getGroupsForDiscussion +description: Get all groups that can be used as [discussion groups](https://telegram.org/blog/privacy-discussions-web-bots) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getGroupsForDiscussion.html +--- +# Method: channels.getGroupsForDiscussion +[Back to methods index](index.md) + + +Get all groups that can be used as [discussion groups](https://telegram.org/blog/privacy-discussions-web-bots) + + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->getGroupsForDiscussion(); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = channels.getGroupsForDiscussion({}) +``` + diff --git a/old_docs/API_docs_v109/methods/channels.getInactiveChannels.md b/old_docs/API_docs_v109/methods/channels.getInactiveChannels.md new file mode 100644 index 00000000..68ab7dd7 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.getInactiveChannels.md @@ -0,0 +1,38 @@ +--- +title: channels.getInactiveChannels +description: channels.getInactiveChannels parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getInactiveChannels.html +--- +# Method: channels.getInactiveChannels +[Back to methods index](index.md) + + + + +### Return type: [messages.InactiveChats](../types/messages.InactiveChats.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.InactiveChats = $MadelineProto->channels->getInactiveChannels(); +``` + +Or, if you're into Lua: + +```lua +messages.InactiveChats = channels.getInactiveChannels({}) +``` + diff --git a/old_docs/API_docs_v109/methods/channels.getLeftChannels.md b/old_docs/API_docs_v109/methods/channels.getLeftChannels.md new file mode 100644 index 00000000..feafc0d3 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.getLeftChannels.md @@ -0,0 +1,52 @@ +--- +title: channels.getLeftChannels +description: Get a list of [channels/supergroups](https://core.telegram.org/api/channel) we left +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getLeftChannels.html +--- +# Method: channels.getLeftChannels +[Back to methods index](index.md) + + +Get a list of [channels/supergroups](https://core.telegram.org/api/channel) we left + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset for [pagination](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = channels.getLeftChannels({offset=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|403|TAKEOUT_REQUIRED|A takeout session has to be initialized, first| + + diff --git a/old_docs/API_docs_v109/methods/channels.getMessages.md b/old_docs/API_docs_v109/methods/channels.getMessages.md new file mode 100644 index 00000000..29208311 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.getMessages.md @@ -0,0 +1,57 @@ +--- +title: channels.getMessages +description: Get [channel/supergroup](https://core.telegram.org/api/channel) messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getMessages.html +--- +# Method: channels.getMessages +[Back to methods index](index.md) + + +Get [channel/supergroup](https://core.telegram.org/api/channel) messages + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel/supergroup | Optional| +|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | The message IDs | Yes| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = channels.getMessages({channel=InputChannel, id={InputMessage}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|MESSAGE_IDS_EMPTY|No message ids were provided| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/channels.getParticipant.md b/old_docs/API_docs_v109/methods/channels.getParticipant.md new file mode 100644 index 00000000..02440ea4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.getParticipant.md @@ -0,0 +1,58 @@ +--- +title: channels.getParticipant +description: Get info about a [channel/supergroup](https://core.telegram.org/api/channel) participant +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getParticipant.html +--- +# Method: channels.getParticipant +[Back to methods index](index.md) + + +Get info about a [channel/supergroup](https://core.telegram.org/api/channel) participant + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel/supergroup | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | ID of participant to get info about | Optional| + + +### Return type: [channels.ChannelParticipant](../types/channels.ChannelParticipant.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +channels.ChannelParticipant = channels.getParticipant({channel=InputChannel, user_id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|USER_ID_INVALID|The provided user ID is invalid| +|400|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v109/methods/channels.getParticipants.md b/old_docs/API_docs_v109/methods/channels.getParticipants.md new file mode 100644 index 00000000..bdad3801 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.getParticipants.md @@ -0,0 +1,61 @@ +--- +title: channels.getParticipants +description: Get the participants of a channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_getParticipants.html +--- +# Method: channels.getParticipants +[Back to methods index](index.md) + + +Get the participants of a channel + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|filter|[ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Which participant types to fetch | Yes| +|offset|[int](../types/int.md) | [Offset](https://core.telegram.org/api/offsets) | Yes| +|limit|[int](../types/int.md) | [Limit](https://core.telegram.org/api/offsets) | Yes| +|hash|Array of [int](../types/int.md) | IDs of previously fetched participants | Optional| + + +### Return type: [channels.ChannelParticipants](../types/channels.ChannelParticipants.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +channels.ChannelParticipants = channels.getParticipants({channel=InputChannel, filter=ChannelParticipantsFilter, offset=int, limit=int, hash={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/channels.inviteToChannel.md b/old_docs/API_docs_v109/methods/channels.inviteToChannel.md new file mode 100644 index 00000000..1719f83e --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.inviteToChannel.md @@ -0,0 +1,71 @@ +--- +title: channels.inviteToChannel +description: Invite users to a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_inviteToChannel.html +--- +# Method: channels.inviteToChannel +[Back to methods index](index.md) + + +Invite users to a channel/supergroup + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel/supergroup | Optional| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.inviteToChannel({channel=InputChannel, users={InputUser}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_GROUPS_BLOCKED|This bot can't be added to groups| +|400|BOTS_TOO_MUCH|There are too many bots in this chat/channel| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_INVALID|Invalid chat| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|400|USER_BLOCKED|User blocked| +|400|USER_BOT|Bots can only be admins in channels.| +|400|USER_ID_INVALID|The provided user ID is invalid| +|400|USER_KICKED|This user was kicked from this supergroup/channel| +|400|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|400|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|403|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|403|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/channels.joinChannel.md b/old_docs/API_docs_v109/methods/channels.joinChannel.md new file mode 100644 index 00000000..de94774e --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.joinChannel.md @@ -0,0 +1,64 @@ +--- +title: channels.joinChannel +description: Join a channel/supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_joinChannel.html +--- +# Method: channels.joinChannel +[Back to methods index](index.md) + + +Join a channel/supergroup + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel/supergroup to join | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.joinChannel({channel=InputChannel, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|400|INVITE_HASH_EMPTY|The invite hash is empty| +|400|INVITE_HASH_EXPIRED|The invite link has expired| +|400|INVITE_HASH_INVALID|The invite hash is invalid| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|USER_ALREADY_PARTICIPANT|The user is already in the group| +|400|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/channels.leaveChannel.md b/old_docs/API_docs_v109/methods/channels.leaveChannel.md new file mode 100644 index 00000000..b4cb4fce --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.leaveChannel.md @@ -0,0 +1,57 @@ +--- +title: channels.leaveChannel +description: Leave a [channel/supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_leaveChannel.html +--- +# Method: channels.leaveChannel +[Back to methods index](index.md) + + +Leave a [channel/supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Channel/supergroup](https://core.telegram.org/api/channel) to leave | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.leaveChannel({channel=InputChannel, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|USER_CREATOR|You can't leave this channel, because you're its creator| +|400|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| +|403|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| + + diff --git a/old_docs/API_docs_v109/methods/channels.readHistory.md b/old_docs/API_docs_v109/methods/channels.readHistory.md new file mode 100644 index 00000000..16ae166c --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.readHistory.md @@ -0,0 +1,56 @@ +--- +title: channels.readHistory +description: Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_readHistory.html +--- +# Method: channels.readHistory +[Back to methods index](index.md) + + +Mark [channel/supergroup](https://core.telegram.org/api/channel) history as read + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Channel/supergroup](https://core.telegram.org/api/channel) | Optional| +|max\_id|[int](../types/int.md) | ID of message up to which messages should be marked as read | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.readHistory({channel=InputChannel, max_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|MSG_ID_INVALID|Invalid message ID provided| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| + + diff --git a/old_docs/API_docs_v109/methods/channels.readMessageContents.md b/old_docs/API_docs_v109/methods/channels.readMessageContents.md new file mode 100644 index 00000000..fc51afca --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.readMessageContents.md @@ -0,0 +1,54 @@ +--- +title: channels.readMessageContents +description: Mark [channel/supergroup](https://core.telegram.org/api/channel) message contents as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_readMessageContents.html +--- +# Method: channels.readMessageContents +[Back to methods index](index.md) + + +Mark [channel/supergroup](https://core.telegram.org/api/channel) message contents as read + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | [Channel/supergroup](https://core.telegram.org/api/channel) | Optional| +|id|Array of [int](../types/int.md) | List of message IDs | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.readMessageContents({channel=InputChannel, id={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| + + diff --git a/old_docs/API_docs_v109/methods/channels.reportSpam.md b/old_docs/API_docs_v109/methods/channels.reportSpam.md new file mode 100644 index 00000000..9866a14c --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.reportSpam.md @@ -0,0 +1,57 @@ +--- +title: channels.reportSpam +description: Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_reportSpam.html +--- +# Method: channels.reportSpam +[Back to methods index](index.md) + + +Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Supergroup | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | ID of the user that sent the spam messages | Optional| +|id|Array of [int](../types/int.md) | The IDs of messages to report | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.reportSpam({channel=InputChannel, user_id=InputUser, id={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/channels.setDiscussionGroup.md b/old_docs/API_docs_v109/methods/channels.setDiscussionGroup.md new file mode 100644 index 00000000..bd70ae8b --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.setDiscussionGroup.md @@ -0,0 +1,55 @@ +--- +title: channels.setDiscussionGroup +description: Associate a group to a channel as [discussion group](https://telegram.org/blog/privacy-discussions-web-bots) for that channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_setDiscussionGroup.html +--- +# Method: channels.setDiscussionGroup +[Back to methods index](index.md) + + +Associate a group to a channel as [discussion group](https://telegram.org/blog/privacy-discussions-web-bots) for that channel + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|group|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Discussion group to associate to the channel | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->setDiscussionGroup(['broadcast' => InputChannel, 'group' => InputChannel, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.setDiscussionGroup({broadcast=InputChannel, group=InputChannel, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BROADCAST_ID_INVALID|Broadcast ID invalid| +|400|LINK_NOT_MODIFIED|Discussion link not modified| +|400|MEGAGROUP_ID_INVALID|Invalid supergroup ID| + + diff --git a/old_docs/API_docs_v109/methods/channels.setStickers.md b/old_docs/API_docs_v109/methods/channels.setStickers.md new file mode 100644 index 00000000..0803a181 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.setStickers.md @@ -0,0 +1,54 @@ +--- +title: channels.setStickers +description: Associate a stickerset to the supergroup +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_setStickers.html +--- +# Method: channels.setStickers +[Back to methods index](index.md) + + +Associate a stickerset to the supergroup + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Supergroup | Optional| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to associate | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.setStickers({channel=InputChannel, stickerset=InputStickerSet, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|PARTICIPANTS_TOO_FEW|Not enough participants| + + diff --git a/old_docs/API_docs_v109/methods/channels.togglePreHistoryHidden.md b/old_docs/API_docs_v109/methods/channels.togglePreHistoryHidden.md new file mode 100644 index 00000000..d27ec356 --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.togglePreHistoryHidden.md @@ -0,0 +1,53 @@ +--- +title: channels.togglePreHistoryHidden +description: Hide/unhide message history for new channel/supergroup users +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_togglePreHistoryHidden.html +--- +# Method: channels.togglePreHistoryHidden +[Back to methods index](index.md) + + +Hide/unhide message history for new channel/supergroup users + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel/supergroup | Optional| +|enabled|[Bool](../types/Bool.md) | Hide/unhide | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.togglePreHistoryHidden({channel=InputChannel, enabled=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified| + + diff --git a/old_docs/API_docs_v109/methods/channels.toggleSignatures.md b/old_docs/API_docs_v109/methods/channels.toggleSignatures.md new file mode 100644 index 00000000..bc0371dc --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.toggleSignatures.md @@ -0,0 +1,54 @@ +--- +title: channels.toggleSignatures +description: Enable/disable message signatures in channels +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_toggleSignatures.html +--- +# Method: channels.toggleSignatures +[Back to methods index](index.md) + + +Enable/disable message signatures in channels + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|enabled|[Bool](../types/Bool.md) | Value | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.toggleSignatures({channel=InputChannel, enabled=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/channels.toggleSlowMode.md b/old_docs/API_docs_v109/methods/channels.toggleSlowMode.md new file mode 100644 index 00000000..1f0ec92a --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.toggleSlowMode.md @@ -0,0 +1,56 @@ +--- +title: channels.toggleSlowMode +description: Toggle supergroup slow mode: if enabled, users will only be able to send one message every `seconds` seconds +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_toggleSlowMode.html +--- +# Method: channels.toggleSlowMode +[Back to methods index](index.md) + + +Toggle supergroup slow mode: if enabled, users will only be able to send one message every `seconds` seconds + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The [supergroup](https://core.telegram.org/api/channel) | Optional| +|seconds|[int](../types/int.md) | Users will only be able to send one message every `seconds` seconds, `0` to disable the limitation | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->toggleSlowMode(['channel' => InputChannel, 'seconds' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = channels.toggleSlowMode({channel=InputChannel, seconds=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified| +|400|INPUT_METHOD_INVALID_1192227_X|Invalid method| +|400|INPUT_METHOD_INVALID_1604042050_X|Invalid method| +|400|SECONDS_INVALID|Invalid duration provided| + + diff --git a/old_docs/API_docs_v109/methods/channels.updateUsername.md b/old_docs/API_docs_v109/methods/channels.updateUsername.md new file mode 100644 index 00000000..4afcb6fb --- /dev/null +++ b/old_docs/API_docs_v109/methods/channels.updateUsername.md @@ -0,0 +1,60 @@ +--- +title: channels.updateUsername +description: Change the username of a supergroup/channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/channels_updateUsername.html +--- +# Method: channels.updateUsername +[Back to methods index](index.md) + + +Change the username of a supergroup/channel + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Channel | Optional| +|username|[string](../types/string.md) | New username | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = channels.updateUsername({channel=InputChannel, username='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|USERNAME_INVALID|The provided username is not valid| +|400|USERNAME_NOT_MODIFIED|The username was not modified| +|400|USERNAME_OCCUPIED|The provided username is already occupied| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/contacts.acceptContact.md b/old_docs/API_docs_v109/methods/contacts.acceptContact.md new file mode 100644 index 00000000..48b406eb --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.acceptContact.md @@ -0,0 +1,52 @@ +--- +title: contacts.acceptContact +description: If the [peer settings](../constructors/peerSettings.md) of a new user allow us to add him as contact, add that user as contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_acceptContact.html +--- +# Method: contacts.acceptContact +[Back to methods index](index.md) + + +If the [peer settings](../constructors/peerSettings.md) of a new user allow us to add him as contact, add that user as contact + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to add as contact | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->contacts->acceptContact(['id' => InputUser, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = contacts.acceptContact({id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CONTACT_REQ_MISSING|Missing contact request| + + diff --git a/old_docs/API_docs_v109/methods/contacts.addContact.md b/old_docs/API_docs_v109/methods/contacts.addContact.md new file mode 100644 index 00000000..44e2bbae --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.addContact.md @@ -0,0 +1,57 @@ +--- +title: contacts.addContact +description: Add an existing telegram user as contact +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_addContact.html +--- +# Method: contacts.addContact +[Back to methods index](index.md) + + +Add an existing telegram user as contact + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|add\_phone\_privacy\_exception|[Bool](../types/Bool.md) | Allow the other user to see our phone number? | Optional| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Telegram ID of the other user | Optional| +|first\_name|[string](../types/string.md) | First name | Yes| +|last\_name|[string](../types/string.md) | Last name | Yes| +|phone|[string](../types/string.md) | User's phone number | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->contacts->addContact(['add_phone_privacy_exception' => Bool, 'id' => InputUser, 'first_name' => 'string', 'last_name' => 'string', 'phone' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = contacts.addContact({add_phone_privacy_exception=Bool, id=InputUser, first_name='string', last_name='string', phone='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CONTACT_ID_INVALID|The provided contact ID is invalid| +|400|CONTACT_NAME_EMPTY|Contact name empty| + + diff --git a/old_docs/API_docs_v109/methods/contacts.block.md b/old_docs/API_docs_v109/methods/contacts.block.md new file mode 100644 index 00000000..6e17aa42 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.block.md @@ -0,0 +1,53 @@ +--- +title: contacts.block +description: Adds the user to the blacklist. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_block.html +--- +# Method: contacts.block +[Back to methods index](index.md) + + +Adds the user to the blacklist. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = contacts.block({id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CONTACT_ID_INVALID|The provided contact ID is invalid| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| + + diff --git a/old_docs/API_docs_v109/methods/contacts.deleteByPhones.md b/old_docs/API_docs_v109/methods/contacts.deleteByPhones.md new file mode 100644 index 00000000..c83d5777 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.deleteByPhones.md @@ -0,0 +1,45 @@ +--- +title: contacts.deleteByPhones +description: Delete contacts by phone number +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_deleteByPhones.html +--- +# Method: contacts.deleteByPhones +[Back to methods index](index.md) + + +Delete contacts by phone number + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phones|Array of [string](../types/string.md) | Phones | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->deleteByPhones(['phones' => ['string', 'string'], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = contacts.deleteByPhones({phones={'string'}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/contacts.deleteContacts.md b/old_docs/API_docs_v109/methods/contacts.deleteContacts.md new file mode 100644 index 00000000..a09d137a --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.deleteContacts.md @@ -0,0 +1,52 @@ +--- +title: contacts.deleteContacts +description: Deletes several contacts from the list. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_deleteContacts.html +--- +# Method: contacts.deleteContacts +[Back to methods index](index.md) + + +Deletes several contacts from the list. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The contacts to delete | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->contacts->deleteContacts(['id' => [InputUser, InputUser], ]); +``` + +Or, if you're into Lua: + +```lua +Updates = contacts.deleteContacts({id={InputUser}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/contacts.getBlocked.md b/old_docs/API_docs_v109/methods/contacts.getBlocked.md new file mode 100644 index 00000000..8ed43319 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.getBlocked.md @@ -0,0 +1,46 @@ +--- +title: contacts.getBlocked +description: Returns the list of blocked users. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_getBlocked.html +--- +# Method: contacts.getBlocked +[Back to methods index](index.md) + + +Returns the list of blocked users. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | The number of list elements to be skipped | Yes| +|limit|[int](../types/int.md) | The number of list elements to be returned | Yes| + + +### Return type: [contacts.Blocked](../types/contacts.Blocked.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +contacts.Blocked = contacts.getBlocked({offset=int, limit=int, }) +``` + diff --git a/old_docs/API_docs_v109/methods/contacts.getContactIDs.md b/old_docs/API_docs_v109/methods/contacts.getContactIDs.md new file mode 100644 index 00000000..54943bda --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.getContactIDs.md @@ -0,0 +1,45 @@ +--- +title: contacts.getContactIDs +description: Get contact by telegram IDs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_getContactIDs.html +--- +# Method: contacts.getContactIDs +[Back to methods index](index.md) + + +Get contact by telegram IDs + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | Previously fetched IDs | Optional| + + +### Return type: [Vector\_of\_int](../types/int.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->getContactIDs(['hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_int = contacts.getContactIDs({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/contacts.getContacts.md b/old_docs/API_docs_v109/methods/contacts.getContacts.md new file mode 100644 index 00000000..05b42aaa --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.getContacts.md @@ -0,0 +1,45 @@ +--- +title: contacts.getContacts +description: Returns the current user's contact list. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_getContacts.html +--- +# Method: contacts.getContacts +[Back to methods index](index.md) + + +Returns the current user's contact list. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | User IDs of previously cached contacts | Optional| + + +### Return type: [contacts.Contacts](../types/contacts.Contacts.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +contacts.Contacts = contacts.getContacts({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/contacts.getLocated.md b/old_docs/API_docs_v109/methods/contacts.getLocated.md new file mode 100644 index 00000000..8a951b96 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.getLocated.md @@ -0,0 +1,45 @@ +--- +title: contacts.getLocated +description: Get contacts near you +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_getLocated.html +--- +# Method: contacts.getLocated +[Back to methods index](index.md) + + +Get contacts near you + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Geolocation | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->contacts->getLocated(['geo_point' => InputGeoPoint, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = contacts.getLocated({geo_point=InputGeoPoint, }) +``` + diff --git a/old_docs/API_docs_v109/methods/contacts.getSaved.md b/old_docs/API_docs_v109/methods/contacts.getSaved.md new file mode 100644 index 00000000..f74b18c5 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.getSaved.md @@ -0,0 +1,47 @@ +--- +title: contacts.getSaved +description: Get all contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_getSaved.html +--- +# Method: contacts.getSaved +[Back to methods index](index.md) + + +Get all contacts + + + +### Return type: [Vector\_of\_SavedContact](../types/SavedContact.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +Vector_of_SavedContact = contacts.getSaved({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|403|TAKEOUT_REQUIRED|A takeout session has to be initialized, first| + + diff --git a/old_docs/API_docs_v109/methods/contacts.getStatuses.md b/old_docs/API_docs_v109/methods/contacts.getStatuses.md new file mode 100644 index 00000000..f0ebcd1b --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.getStatuses.md @@ -0,0 +1,47 @@ +--- +title: contacts.getStatuses +description: Returns the list of contact statuses. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_getStatuses.html +--- +# Method: contacts.getStatuses +[Back to methods index](index.md) + + +Returns the list of contact statuses. + + + +### Return type: [Vector\_of\_ContactStatus](../types/ContactStatus.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +Vector_of_ContactStatus = contacts.getStatuses({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v109/methods/contacts.getTopPeers.md b/old_docs/API_docs_v109/methods/contacts.getTopPeers.md new file mode 100644 index 00000000..11b133d1 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.getTopPeers.md @@ -0,0 +1,62 @@ +--- +title: contacts.getTopPeers +description: Get most used peers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_getTopPeers.html +--- +# Method: contacts.getTopPeers +[Back to methods index](index.md) + + +Get most used peers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|correspondents|[Bool](../types/Bool.md) | Users we've chatted most frequently with | Optional| +|bots\_pm|[Bool](../types/Bool.md) | Most used bots | Optional| +|bots\_inline|[Bool](../types/Bool.md) | Most used inline bots | Optional| +|phone\_calls|[Bool](../types/Bool.md) | Most frequently called users | Optional| +|forward\_users|[Bool](../types/Bool.md) | Users to which the users often forwards messages to | Optional| +|forward\_chats|[Bool](../types/Bool.md) | Chats to which the users often forwards messages to | Optional| +|groups|[Bool](../types/Bool.md) | Often-opened groups and supergroups | Optional| +|channels|[Bool](../types/Bool.md) | Most frequently visited channels | Optional| +|offset|[int](../types/int.md) | Offset for [pagination](https://core.telegram.org/api/offsets) | Yes| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| +|hash|Array of [int](../types/int.md) | Peer IDs of previously cached peers | Optional| + + +### Return type: [contacts.TopPeers](../types/contacts.TopPeers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, 'forward_users' => Bool, 'forward_chats' => Bool, 'groups' => Bool, 'channels' => Bool, 'offset' => int, 'limit' => int, 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +contacts.TopPeers = contacts.getTopPeers({correspondents=Bool, bots_pm=Bool, bots_inline=Bool, phone_calls=Bool, forward_users=Bool, forward_chats=Bool, groups=Bool, channels=Bool, offset=int, limit=int, hash={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|TYPES_EMPTY|No top peer type was provided| + + diff --git a/old_docs/API_docs_v109/methods/contacts.importContacts.md b/old_docs/API_docs_v109/methods/contacts.importContacts.md new file mode 100644 index 00000000..d68a3c17 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.importContacts.md @@ -0,0 +1,45 @@ +--- +title: contacts.importContacts +description: Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_importContacts.html +--- +# Method: contacts.importContacts +[Back to methods index](index.md) + + +Imports contacts: saves a full list on the server, adds already registered contacts to the contact list, returns added contacts and their info. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| + + +### Return type: [contacts.ImportedContacts](../types/contacts.ImportedContacts.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +contacts.ImportedContacts = contacts.importContacts({contacts={InputContact}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/contacts.resetSaved.md b/old_docs/API_docs_v109/methods/contacts.resetSaved.md new file mode 100644 index 00000000..2882a886 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.resetSaved.md @@ -0,0 +1,40 @@ +--- +title: contacts.resetSaved +description: Delete saved contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_resetSaved.html +--- +# Method: contacts.resetSaved +[Back to methods index](index.md) + + +Delete saved contacts + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +Bool = contacts.resetSaved({}) +``` + diff --git a/old_docs/API_docs_v109/methods/contacts.resetTopPeerRating.md b/old_docs/API_docs_v109/methods/contacts.resetTopPeerRating.md new file mode 100644 index 00000000..3221b747 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.resetTopPeerRating.md @@ -0,0 +1,53 @@ +--- +title: contacts.resetTopPeerRating +description: Reset [rating](https://core.telegram.org/api/top-rating) of top peer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_resetTopPeerRating.html +--- +# Method: contacts.resetTopPeerRating +[Back to methods index](index.md) + + +Reset [rating](https://core.telegram.org/api/top-rating) of top peer + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|category|[TopPeerCategory](../types/TopPeerCategory.md) | Top peer category | Yes| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer whose rating should be reset | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/contacts.resolveUsername.md b/old_docs/API_docs_v109/methods/contacts.resolveUsername.md new file mode 100644 index 00000000..a4dbcab1 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.resolveUsername.md @@ -0,0 +1,56 @@ +--- +title: contacts.resolveUsername +description: You cannot use this method directly, use the resolveUsername, getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_resolveUsername.html +--- +# Method: contacts.resolveUsername +[Back to methods index](index.md) + + +You cannot use this method directly, use the resolveUsername, getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|username|[string](../types/string.md) | You cannot use this method directly, use the resolveUsername, getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) | Yes| + + +### Return type: [contacts.ResolvedPeer](../types/contacts.ResolvedPeer.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.ResolvedPeer = $MadelineProto->contacts->resolveUsername(['username' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +contacts.ResolvedPeer = contacts.resolveUsername({username='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|USERNAME_INVALID|The provided username is not valid| +|400|USERNAME_NOT_OCCUPIED|The provided username is not occupied| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v109/methods/contacts.search.md b/old_docs/API_docs_v109/methods/contacts.search.md new file mode 100644 index 00000000..54c55c48 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.search.md @@ -0,0 +1,55 @@ +--- +title: contacts.search +description: Returns users found by username substring. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_search.html +--- +# Method: contacts.search +[Back to methods index](index.md) + + +Returns users found by username substring. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | Target substring | Yes| +|limit|[int](../types/int.md) | Maximum number of users to be returned | Yes| + + +### Return type: [contacts.Found](../types/contacts.Found.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +contacts.Found = contacts.search({q='string', limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|QUERY_TOO_SHORT|The query string is too short| +|400|SEARCH_QUERY_EMPTY|The search query is empty| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/contacts.toggleTopPeers.md b/old_docs/API_docs_v109/methods/contacts.toggleTopPeers.md new file mode 100644 index 00000000..aa7b3cc2 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.toggleTopPeers.md @@ -0,0 +1,45 @@ +--- +title: contacts.toggleTopPeers +description: Enable/disable [top peers](https://core.telegram.org/api/top-rating) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_toggleTopPeers.html +--- +# Method: contacts.toggleTopPeers +[Back to methods index](index.md) + + +Enable/disable [top peers](https://core.telegram.org/api/top-rating) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|enabled|[Bool](../types/Bool.md) | Enable/disable | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = contacts.toggleTopPeers({enabled=Bool, }) +``` + diff --git a/old_docs/API_docs_v109/methods/contacts.unblock.md b/old_docs/API_docs_v109/methods/contacts.unblock.md new file mode 100644 index 00000000..97a5f1a2 --- /dev/null +++ b/old_docs/API_docs_v109/methods/contacts.unblock.md @@ -0,0 +1,52 @@ +--- +title: contacts.unblock +description: Deletes the user from the blacklist. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/contacts_unblock.html +--- +# Method: contacts.unblock +[Back to methods index](index.md) + + +Deletes the user from the blacklist. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = contacts.unblock({id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CONTACT_ID_INVALID|The provided contact ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/folders.deleteFolder.md b/old_docs/API_docs_v109/methods/folders.deleteFolder.md new file mode 100644 index 00000000..fcf601ec --- /dev/null +++ b/old_docs/API_docs_v109/methods/folders.deleteFolder.md @@ -0,0 +1,45 @@ +--- +title: folders.deleteFolder +description: Delete a folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/folders_deleteFolder.html +--- +# Method: folders.deleteFolder +[Back to methods index](index.md) + + +Delete a folder + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|folder\_id|[int](../types/int.md) | Folder to delete | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->folders->deleteFolder(['folder_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = folders.deleteFolder({folder_id=int, }) +``` + diff --git a/old_docs/API_docs_v109/methods/folders.editPeerFolders.md b/old_docs/API_docs_v109/methods/folders.editPeerFolders.md new file mode 100644 index 00000000..d228d56e --- /dev/null +++ b/old_docs/API_docs_v109/methods/folders.editPeerFolders.md @@ -0,0 +1,52 @@ +--- +title: folders.editPeerFolders +description: Edit peers in folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/folders_editPeerFolders.html +--- +# Method: folders.editPeerFolders +[Back to methods index](index.md) + + +Edit peers in folder + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|folder\_peers|Array of [InputFolderPeer](../types/InputFolderPeer.md) | New folder peers | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->folders->editPeerFolders(['folder_peers' => [InputFolderPeer, InputFolderPeer], ]); +``` + +Or, if you're into Lua: + +```lua +Updates = folders.editPeerFolders({folder_peers={InputFolderPeer}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|FOLDER_ID_INVALID|Invalid folder ID| + + diff --git a/old_docs/API_docs_v109/methods/help.acceptTermsOfService.md b/old_docs/API_docs_v109/methods/help.acceptTermsOfService.md new file mode 100644 index 00000000..6cae052f --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.acceptTermsOfService.md @@ -0,0 +1,45 @@ +--- +title: help.acceptTermsOfService +description: Accept the new terms of service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_acceptTermsOfService.html +--- +# Method: help.acceptTermsOfService +[Back to methods index](index.md) + + +Accept the new terms of service + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[DataJSON](../types/DataJSON.md) | ID of terms of service | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = help.acceptTermsOfService({id=DataJSON, }) +``` + diff --git a/old_docs/API_docs_v109/methods/help.editUserInfo.md b/old_docs/API_docs_v109/methods/help.editUserInfo.md new file mode 100644 index 00000000..2b44e55f --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.editUserInfo.md @@ -0,0 +1,90 @@ +--- +title: help.editUserInfo +description: Internal use +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_editUserInfo.html +--- +# Method: help.editUserInfo +[Back to methods index](index.md) + + +Internal use + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User | Optional| +|message|[string](../types/string.md) | Message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities | Yes| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | + + +### Return type: [help.UserInfo](../types/help.UserInfo.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.UserInfo = $MadelineProto->help->editUserInfo(['user_id' => InputUser, 'message' => 'string', 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +help.UserInfo = help.editUserInfo({user_id=InputUser, message='string', entities={MessageEntity}, parseMode='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 [help.UserInfo](../types/help.UserInfo.md) will be returned instead. + + + +## Usage of parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough +strikethrough +strikethrough +inline fixed-width code +
pre-formatted fixed-width code block
+
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: + +```markdown +[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_v109/methods/help.getAppChangelog.md b/old_docs/API_docs_v109/methods/help.getAppChangelog.md new file mode 100644 index 00000000..9d52098f --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getAppChangelog.md @@ -0,0 +1,45 @@ +--- +title: help.getAppChangelog +description: Get changelog of current app +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getAppChangelog.html +--- +# Method: help.getAppChangelog +[Back to methods index](index.md) + + +Get changelog of current app + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|prev\_app\_version|[string](../types/string.md) | Previous app version | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = help.getAppChangelog({prev_app_version='string', }) +``` + diff --git a/old_docs/API_docs_v109/methods/help.getAppConfig.md b/old_docs/API_docs_v109/methods/help.getAppConfig.md new file mode 100644 index 00000000..76e1db2e --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getAppConfig.md @@ -0,0 +1,40 @@ +--- +title: help.getAppConfig +description: Get app-specific configuration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getAppConfig.html +--- +# Method: help.getAppConfig +[Back to methods index](index.md) + + +Get app-specific configuration + + + +### Return type: [JSONValue](../types/JSONValue.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$JSONValue = $MadelineProto->help->getAppConfig(); +``` + +Or, if you're into Lua: + +```lua +JSONValue = help.getAppConfig({}) +``` + diff --git a/old_docs/API_docs_v109/methods/help.getAppUpdate.md b/old_docs/API_docs_v109/methods/help.getAppUpdate.md new file mode 100644 index 00000000..55438370 --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getAppUpdate.md @@ -0,0 +1,45 @@ +--- +title: help.getAppUpdate +description: Returns information on update availability for the current application. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getAppUpdate.html +--- +# Method: help.getAppUpdate +[Back to methods index](index.md) + + +Returns information on update availability for the current application. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|source|[string](../types/string.md) | Source | Yes| + + +### Return type: [help.AppUpdate](../types/help.AppUpdate.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['source' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +help.AppUpdate = help.getAppUpdate({source='string', }) +``` + diff --git a/old_docs/API_docs_v109/methods/help.getCdnConfig.md b/old_docs/API_docs_v109/methods/help.getCdnConfig.md new file mode 100644 index 00000000..fb4c9a78 --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getCdnConfig.md @@ -0,0 +1,50 @@ +--- +title: help.getCdnConfig +description: Get configuration for [CDN](https://core.telegram.org/cdn) file downloads. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getCdnConfig.html +--- +# Method: help.getCdnConfig +[Back to methods index](index.md) + + +Get configuration for [CDN](https://core.telegram.org/cdn) file downloads. + + + +### Return type: [CdnConfig](../types/CdnConfig.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +CdnConfig = help.getCdnConfig({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/help.getConfig.md b/old_docs/API_docs_v109/methods/help.getConfig.md new file mode 100644 index 00000000..398f819b --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getConfig.md @@ -0,0 +1,52 @@ +--- +title: help.getConfig +description: Returns current configuration, icluding data center configuration. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getConfig.html +--- +# Method: help.getConfig +[Back to methods index](index.md) + + +Returns current configuration, icluding data center configuration. + + + +### Return type: [Config](../types/Config.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +Config = help.getConfig({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|400|CONNECTION_NOT_INITED|Connection not initialized| +|400|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|400|INPUT_LAYER_INVALID|The provided layer is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/help.getDeepLinkInfo.md b/old_docs/API_docs_v109/methods/help.getDeepLinkInfo.md new file mode 100644 index 00000000..e7ef261d --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getDeepLinkInfo.md @@ -0,0 +1,45 @@ +--- +title: help.getDeepLinkInfo +description: Get info about a `t.me` link +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getDeepLinkInfo.html +--- +# Method: help.getDeepLinkInfo +[Back to methods index](index.md) + + +Get info about a `t.me` link + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|path|[string](../types/string.md) | Path in `t.me/path` | Yes| + + +### Return type: [help.DeepLinkInfo](../types/help.DeepLinkInfo.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +help.DeepLinkInfo = help.getDeepLinkInfo({path='string', }) +``` + diff --git a/old_docs/API_docs_v109/methods/help.getInviteText.md b/old_docs/API_docs_v109/methods/help.getInviteText.md new file mode 100644 index 00000000..d59433df --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getInviteText.md @@ -0,0 +1,40 @@ +--- +title: help.getInviteText +description: Returns text of a text message with an invitation. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getInviteText.html +--- +# Method: help.getInviteText +[Back to methods index](index.md) + + +Returns text of a text message with an invitation. + + + +### Return type: [help.InviteText](../types/help.InviteText.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +help.InviteText = help.getInviteText({}) +``` + diff --git a/old_docs/API_docs_v109/methods/help.getNearestDc.md b/old_docs/API_docs_v109/methods/help.getNearestDc.md new file mode 100644 index 00000000..805b9ef7 --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getNearestDc.md @@ -0,0 +1,47 @@ +--- +title: help.getNearestDc +description: Returns info on data centre nearest to the user. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getNearestDc.html +--- +# Method: help.getNearestDc +[Back to methods index](index.md) + + +Returns info on data centre nearest to the user. + + + +### Return type: [NearestDc](../types/NearestDc.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +NearestDc = help.getNearestDc({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| + + diff --git a/old_docs/API_docs_v109/methods/help.getPassportConfig.md b/old_docs/API_docs_v109/methods/help.getPassportConfig.md new file mode 100644 index 00000000..783a44ba --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getPassportConfig.md @@ -0,0 +1,45 @@ +--- +title: help.getPassportConfig +description: Get [passport](https://core.telegram.org/passport) configuration +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getPassportConfig.html +--- +# Method: help.getPassportConfig +[Back to methods index](index.md) + + +Get [passport](https://core.telegram.org/passport) configuration + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | Hash | Optional| + + +### Return type: [help.PassportConfig](../types/help.PassportConfig.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.PassportConfig = $MadelineProto->help->getPassportConfig(['hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +help.PassportConfig = help.getPassportConfig({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/help.getProxyData.md b/old_docs/API_docs_v109/methods/help.getProxyData.md new file mode 100644 index 00000000..e27b1fa8 --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getProxyData.md @@ -0,0 +1,40 @@ +--- +title: help.getProxyData +description: Get promotion info of the currently-used MTProxy +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getProxyData.html +--- +# Method: help.getProxyData +[Back to methods index](index.md) + + +Get promotion info of the currently-used MTProxy + + + +### Return type: [help.ProxyData](../types/help.ProxyData.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +help.ProxyData = help.getProxyData({}) +``` + diff --git a/old_docs/API_docs_v109/methods/help.getRecentMeUrls.md b/old_docs/API_docs_v109/methods/help.getRecentMeUrls.md new file mode 100644 index 00000000..7d67ec75 --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getRecentMeUrls.md @@ -0,0 +1,45 @@ +--- +title: help.getRecentMeUrls +description: Get recently used `t.me` links +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getRecentMeUrls.html +--- +# Method: help.getRecentMeUrls +[Back to methods index](index.md) + + +Get recently used `t.me` links + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|referer|[string](../types/string.md) | Referer | Yes| + + +### Return type: [help.RecentMeUrls](../types/help.RecentMeUrls.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +help.RecentMeUrls = help.getRecentMeUrls({referer='string', }) +``` + diff --git a/old_docs/API_docs_v109/methods/help.getSupport.md b/old_docs/API_docs_v109/methods/help.getSupport.md new file mode 100644 index 00000000..f9440dbe --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getSupport.md @@ -0,0 +1,40 @@ +--- +title: help.getSupport +description: Returns the support user for the 'ask a question' feature. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getSupport.html +--- +# Method: help.getSupport +[Back to methods index](index.md) + + +Returns the support user for the 'ask a question' feature. + + + +### Return type: [help.Support](../types/help.Support.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +help.Support = help.getSupport({}) +``` + diff --git a/old_docs/API_docs_v109/methods/help.getSupportName.md b/old_docs/API_docs_v109/methods/help.getSupportName.md new file mode 100644 index 00000000..d9befd14 --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getSupportName.md @@ -0,0 +1,47 @@ +--- +title: help.getSupportName +description: Get localized name of the telegram support user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getSupportName.html +--- +# Method: help.getSupportName +[Back to methods index](index.md) + + +Get localized name of the telegram support user + + + +### Return type: [help.SupportName](../types/help.SupportName.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.SupportName = $MadelineProto->help->getSupportName(); +``` + +Or, if you're into Lua: + +```lua +help.SupportName = help.getSupportName({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|403|USER_INVALID|Invalid user provided| + + diff --git a/old_docs/API_docs_v109/methods/help.getTermsOfServiceUpdate.md b/old_docs/API_docs_v109/methods/help.getTermsOfServiceUpdate.md new file mode 100644 index 00000000..3c77d44b --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getTermsOfServiceUpdate.md @@ -0,0 +1,47 @@ +--- +title: help.getTermsOfServiceUpdate +description: Look for updates of telegram's terms of service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getTermsOfServiceUpdate.html +--- +# Method: help.getTermsOfServiceUpdate +[Back to methods index](index.md) + + +Look for updates of telegram's terms of service + + + +### Return type: [help.TermsOfServiceUpdate](../types/help.TermsOfServiceUpdate.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +help.TermsOfServiceUpdate = help.getTermsOfServiceUpdate({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| + + diff --git a/old_docs/API_docs_v109/methods/help.getUserInfo.md b/old_docs/API_docs_v109/methods/help.getUserInfo.md new file mode 100644 index 00000000..5e8d40ea --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.getUserInfo.md @@ -0,0 +1,52 @@ +--- +title: help.getUserInfo +description: Internal use +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_getUserInfo.html +--- +# Method: help.getUserInfo +[Back to methods index](index.md) + + +Internal use + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional| + + +### Return type: [help.UserInfo](../types/help.UserInfo.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.UserInfo = $MadelineProto->help->getUserInfo(['user_id' => InputUser, ]); +``` + +Or, if you're into Lua: + +```lua +help.UserInfo = help.getUserInfo({user_id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|403|USER_INVALID|Invalid user provided| + + diff --git a/old_docs/API_docs_v109/methods/help.saveAppLog.md b/old_docs/API_docs_v109/methods/help.saveAppLog.md new file mode 100644 index 00000000..b04b139a --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.saveAppLog.md @@ -0,0 +1,45 @@ +--- +title: help.saveAppLog +description: Saves logs of application on the server. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_saveAppLog.html +--- +# Method: help.saveAppLog +[Back to methods index](index.md) + + +Saves logs of application on the server. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|events|Array of [InputAppEvent](../types/InputAppEvent.md) | Event list | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = help.saveAppLog({events={InputAppEvent}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/help.setBotUpdatesStatus.md b/old_docs/API_docs_v109/methods/help.setBotUpdatesStatus.md new file mode 100644 index 00000000..dd508097 --- /dev/null +++ b/old_docs/API_docs_v109/methods/help.setBotUpdatesStatus.md @@ -0,0 +1,52 @@ +--- +title: help.setBotUpdatesStatus +description: Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/help_setBotUpdatesStatus.html +--- +# Method: help.setBotUpdatesStatus +[Back to methods index](index.md) + + +Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pending\_updates\_count|[int](../types/int.md) | Number of pending updates | Yes| +|message|[string](../types/string.md) | Error message, if present | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```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_v109/methods/initConnection.md b/old_docs/API_docs_v109/methods/initConnection.md new file mode 100644 index 00000000..9e5561d6 --- /dev/null +++ b/old_docs/API_docs_v109/methods/initConnection.md @@ -0,0 +1,60 @@ +--- +title: initConnection +description: Initialize connection +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: initConnection +[Back to methods index](index.md) + + +Initialize connection + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|api\_id|[int](../types/int.md) | Application identifier (see. [App configuration](https://core.telegram.org/myapp)) | Yes| +|device\_model|[string](../types/string.md) | Device model | Yes| +|system\_version|[string](../types/string.md) | Operation system version | Yes| +|app\_version|[string](../types/string.md) | Application version | Yes| +|system\_lang\_code|[string](../types/string.md) | Code for the language used on the device's OS, ISO 639-1 standard | Yes| +|lang\_pack|[string](../types/string.md) | Language pack to use | Yes| +|lang\_code|[string](../types/string.md) | Code for the language used on the client, ISO 639-1 standard | Yes| +|proxy|[InputClientProxy](../types/InputClientProxy.md) | Info about an MTProto proxy | Optional| +|query|[!X](../types/!X.md) | The query itself | Yes| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```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 + +| Code | Type | Description | +|------|----------|---------------| +|400|CONNECTION_LAYER_INVALID|Layer invalid| +|400|INPUT_FETCH_FAIL|Failed deserializing TL payload| + + diff --git a/old_docs/API_docs_v109/methods/invokeAfterMsg.md b/old_docs/API_docs_v109/methods/invokeAfterMsg.md new file mode 100644 index 00000000..490feafa --- /dev/null +++ b/old_docs/API_docs_v109/methods/invokeAfterMsg.md @@ -0,0 +1,45 @@ +--- +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 | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[long](../types/long.md) | Message identifier on which a current query depends | Yes| +|query|[!X](../types/!X.md) | The query itself | Yes| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +X = invokeAfterMsg({msg_id=long, query=!X, }) +``` + diff --git a/old_docs/API_docs_v109/methods/invokeAfterMsgs.md b/old_docs/API_docs_v109/methods/invokeAfterMsgs.md new file mode 100644 index 00000000..8ad0d8d6 --- /dev/null +++ b/old_docs/API_docs_v109/methods/invokeAfterMsgs.md @@ -0,0 +1,45 @@ +--- +title: invokeAfterMsgs +description: Invokes a query after a successfull completion of previous queries +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: invokeAfterMsgs +[Back to methods index](index.md) + + +Invokes a query after a successfull completion of previous queries + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_ids|Array of [long](../types/long.md) | List of messages on which a current query depends | Yes| +|query|[!X](../types/!X.md) | The query itself | Yes| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +X = invokeAfterMsgs({msg_ids={long}, query=!X, }) +``` + diff --git a/old_docs/API_docs_v109/methods/invokeWithLayer.md b/old_docs/API_docs_v109/methods/invokeWithLayer.md new file mode 100644 index 00000000..4cfa6e84 --- /dev/null +++ b/old_docs/API_docs_v109/methods/invokeWithLayer.md @@ -0,0 +1,63 @@ +--- +title: invokeWithLayer +description: Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: invokeWithLayer +[Back to methods index](index.md) + + +Invoke the specified query using the specified API [layer](https://core.telegram.org/api/invoking#layers) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|layer|[int](../types/int.md) | The layer to use | Yes| +|query|[!X](../types/!X.md) | The query | Yes| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +X = invokeWithLayer({layer=int, query=!X, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|AUTH_BYTES_INVALID|The provided authorization is invalid| +|400|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|400|CONNECTION_API_ID_INVALID|The provided API id is invalid| +|400|CONNECTION_DEVICE_MODEL_EMPTY|Device model empty| +|400|CONNECTION_LANG_PACK_INVALID|Language pack invalid| +|400|CONNECTION_NOT_INITED|Connection not initialized| +|400|CONNECTION_SYSTEM_EMPTY|Connection system empty| +|400|INPUT_LAYER_INVALID|The provided layer is invalid| +|400|INVITE_HASH_EXPIRED|The invite link has expired| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/invokeWithMessagesRange.md b/old_docs/API_docs_v109/methods/invokeWithMessagesRange.md new file mode 100644 index 00000000..18408f82 --- /dev/null +++ b/old_docs/API_docs_v109/methods/invokeWithMessagesRange.md @@ -0,0 +1,45 @@ +--- +title: invokeWithMessagesRange +description: Invoke with the given message range +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: invokeWithMessagesRange +[Back to methods index](index.md) + + +Invoke with the given message range + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|range|[MessageRange](../types/MessageRange.md) | Message range | Yes| +|query|[!X](../types/!X.md) | Query | Yes| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +X = invokeWithMessagesRange({range=MessageRange, query=!X, }) +``` + diff --git a/old_docs/API_docs_v109/methods/invokeWithTakeout.md b/old_docs/API_docs_v109/methods/invokeWithTakeout.md new file mode 100644 index 00000000..547292e4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/invokeWithTakeout.md @@ -0,0 +1,45 @@ +--- +title: invokeWithTakeout +description: Invoke a method within a takeout session +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: invokeWithTakeout +[Back to methods index](index.md) + + +Invoke a method within a takeout session + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|takeout\_id|[long](../types/long.md) | Takeout session ID | Yes| +|query|[!X](../types/!X.md) | Query | Yes| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +X = invokeWithTakeout({takeout_id=long, query=!X, }) +``` + diff --git a/old_docs/API_docs_v109/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v109/methods/invokeWithoutUpdates.md new file mode 100644 index 00000000..48ae4806 --- /dev/null +++ b/old_docs/API_docs_v109/methods/invokeWithoutUpdates.md @@ -0,0 +1,44 @@ +--- +title: invokeWithoutUpdates +description: Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Method: invokeWithoutUpdates +[Back to methods index](index.md) + + +Invoke a request without subscribing the used connection for [updates](https://core.telegram.org/api/updates) (this is enabled by default for [file queries](https://core.telegram.org/api/files)). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query|[!X](../types/!X.md) | The query | Yes| + + +### Return type: [X](../types/X.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +X = invokeWithoutUpdates({query=!X, }) +``` + diff --git a/old_docs/API_docs_v109/methods/langpack.getDifference.md b/old_docs/API_docs_v109/methods/langpack.getDifference.md new file mode 100644 index 00000000..5cddec7c --- /dev/null +++ b/old_docs/API_docs_v109/methods/langpack.getDifference.md @@ -0,0 +1,54 @@ +--- +title: langpack.getDifference +description: Get new strings in languagepack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/langpack_getDifference.html +--- +# Method: langpack.getDifference +[Back to methods index](index.md) + + +Get new strings in languagepack + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_pack|[string](../types/string.md) | Language pack | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| +|from\_version|[int](../types/int.md) | Previous localization pack version | Yes| + + +### Return type: [LangPackDifference](../types/LangPackDifference.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['lang_pack' => 'string', 'lang_code' => 'string', 'from_version' => int, ]); +``` + +Or, if you're into Lua: + +```lua +LangPackDifference = langpack.getDifference({lang_pack='string', lang_code='string', from_version=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v109/methods/langpack.getLangPack.md b/old_docs/API_docs_v109/methods/langpack.getLangPack.md new file mode 100644 index 00000000..c7891e5a --- /dev/null +++ b/old_docs/API_docs_v109/methods/langpack.getLangPack.md @@ -0,0 +1,53 @@ +--- +title: langpack.getLangPack +description: Get localization pack strings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/langpack_getLangPack.html +--- +# Method: langpack.getLangPack +[Back to methods index](index.md) + + +Get localization pack strings + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_pack|[string](../types/string.md) | Language pack name | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| + + +### Return type: [LangPackDifference](../types/LangPackDifference.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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_pack' => 'string', 'lang_code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +LangPackDifference = langpack.getLangPack({lang_pack='string', lang_code='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v109/methods/langpack.getLanguage.md b/old_docs/API_docs_v109/methods/langpack.getLanguage.md new file mode 100644 index 00000000..a6e2c7ce --- /dev/null +++ b/old_docs/API_docs_v109/methods/langpack.getLanguage.md @@ -0,0 +1,46 @@ +--- +title: langpack.getLanguage +description: Get information about a language in a localization pack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/langpack_getLanguage.html +--- +# Method: langpack.getLanguage +[Back to methods index](index.md) + + +Get information about a language in a localization pack + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_pack|[string](../types/string.md) | Language pack name | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| + + +### Return type: [LangPackLanguage](../types/LangPackLanguage.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$LangPackLanguage = $MadelineProto->langpack->getLanguage(['lang_pack' => 'string', 'lang_code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +LangPackLanguage = langpack.getLanguage({lang_pack='string', lang_code='string', }) +``` + diff --git a/old_docs/API_docs_v109/methods/langpack.getLanguages.md b/old_docs/API_docs_v109/methods/langpack.getLanguages.md new file mode 100644 index 00000000..7f5514cc --- /dev/null +++ b/old_docs/API_docs_v109/methods/langpack.getLanguages.md @@ -0,0 +1,52 @@ +--- +title: langpack.getLanguages +description: Get information about all languages in a localization pack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/langpack_getLanguages.html +--- +# Method: langpack.getLanguages +[Back to methods index](index.md) + + +Get information about all languages in a localization pack + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_pack|[string](../types/string.md) | Language pack | Yes| + + +### Return type: [Vector\_of\_LangPackLanguage](../types/LangPackLanguage.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['lang_pack' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_LangPackLanguage = langpack.getLanguages({lang_pack='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v109/methods/langpack.getStrings.md b/old_docs/API_docs_v109/methods/langpack.getStrings.md new file mode 100644 index 00000000..5c937e7c --- /dev/null +++ b/old_docs/API_docs_v109/methods/langpack.getStrings.md @@ -0,0 +1,54 @@ +--- +title: langpack.getStrings +description: Get strings from a language pack +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/langpack_getStrings.html +--- +# Method: langpack.getStrings +[Back to methods index](index.md) + + +Get strings from a language pack + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_pack|[string](../types/string.md) | Language pack name | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| +|keys|Array of [string](../types/string.md) | Keys | Yes| + + +### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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_pack' => 'string', 'lang_code' => 'string', 'keys' => ['string', 'string'], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_LangPackString = langpack.getStrings({lang_pack='string', lang_code='string', keys={'string'}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LANG_PACK_INVALID|The provided language pack is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.acceptEncryption.md b/old_docs/API_docs_v109/methods/messages.acceptEncryption.md new file mode 100644 index 00000000..8d9ed8c4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.acceptEncryption.md @@ -0,0 +1,56 @@ +--- +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 +redirect_from: /API_docs/methods/messages_acceptEncryption.html +--- +# 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 + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Yes| +|g\_b|[bytes](../types/bytes.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Yes| +|key\_fingerprint|[long](../types/long.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Yes| + + +### Return type: [EncryptedChat](../types/EncryptedChat.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$EncryptedChat = $MadelineProto->messages->acceptEncryption(['peer' => InputEncryptedChat, 'g_b' => 'bytes', 'key_fingerprint' => long, ]); +``` + +Or, if you're into Lua: + +```lua +EncryptedChat = messages.acceptEncryption({peer=InputEncryptedChat, g_b='bytes', key_fingerprint=long, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|ENCRYPTION_ALREADY_ACCEPTED|Secret chat already accepted| +|400|ENCRYPTION_ALREADY_DECLINED|The secret chat was already declined| + + diff --git a/old_docs/API_docs_v109/methods/messages.acceptUrlAuth.md b/old_docs/API_docs_v109/methods/messages.acceptUrlAuth.md new file mode 100644 index 00000000..6c9e69e0 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.acceptUrlAuth.md @@ -0,0 +1,48 @@ +--- +title: messages.acceptUrlAuth +description: Use this to accept a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_acceptUrlAuth.html +--- +# Method: messages.acceptUrlAuth +[Back to methods index](index.md) + + +Use this to accept a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|write\_allowed|[Bool](../types/Bool.md) | Set this flag to allow the bot to send messages to you (if requested) | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The location of the message | Optional| +|msg\_id|[int](../types/int.md) | Message ID of the message with the login button | Yes| +|button\_id|[int](../types/int.md) | ID of the login button | Yes| + + +### Return type: [UrlAuthResult](../types/UrlAuthResult.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$UrlAuthResult = $MadelineProto->messages->acceptUrlAuth(['write_allowed' => Bool, 'peer' => InputPeer, 'msg_id' => int, 'button_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +UrlAuthResult = messages.acceptUrlAuth({write_allowed=Bool, peer=InputPeer, msg_id=int, button_id=int, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.addChatUser.md b/old_docs/API_docs_v109/methods/messages.addChatUser.md new file mode 100644 index 00000000..6eb571fc --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.addChatUser.md @@ -0,0 +1,62 @@ +--- +title: messages.addChatUser +description: Adds a user to a chat and sends a service message on it. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_addChatUser.html +--- +# Method: messages.addChatUser +[Back to methods index](index.md) + + +Adds a user to a chat and sends a service message on it. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to invite users | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID to be added | Optional| +|fwd\_limit|[int](../types/int.md) | Number of last messages to be forwarded | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|USER_ALREADY_PARTICIPANT|The user is already in the group| +|400|USER_ID_INVALID|The provided user ID is invalid| +|400|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|403|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact| +|403|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v109/methods/messages.checkChatInvite.md b/old_docs/API_docs_v109/methods/messages.checkChatInvite.md new file mode 100644 index 00000000..4f0877fe --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.checkChatInvite.md @@ -0,0 +1,55 @@ +--- +title: messages.checkChatInvite +description: Check the validity of a chat invite link and get basic info about it +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_checkChatInvite.html +--- +# Method: messages.checkChatInvite +[Back to methods index](index.md) + + +Check the validity of a chat invite link and get basic info about it + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | Invite hash in `t.me/joinchat/hash` | Yes| + + +### Return type: [ChatInvite](../types/ChatInvite.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +ChatInvite = messages.checkChatInvite({hash='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|INVITE_HASH_EMPTY|The invite hash is empty| +|400|INVITE_HASH_EXPIRED|The invite link has expired| +|400|INVITE_HASH_INVALID|The invite hash is invalid| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v109/methods/messages.clearAllDrafts.md b/old_docs/API_docs_v109/methods/messages.clearAllDrafts.md new file mode 100644 index 00000000..1726f192 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.clearAllDrafts.md @@ -0,0 +1,40 @@ +--- +title: messages.clearAllDrafts +description: Clear all [drafts](https://core.telegram.org/api/drafts). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_clearAllDrafts.html +--- +# Method: messages.clearAllDrafts +[Back to methods index](index.md) + + +Clear all [drafts](https://core.telegram.org/api/drafts). + + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->clearAllDrafts(); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.clearAllDrafts({}) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.clearRecentStickers.md b/old_docs/API_docs_v109/methods/messages.clearRecentStickers.md new file mode 100644 index 00000000..71cdc3dd --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.clearRecentStickers.md @@ -0,0 +1,45 @@ +--- +title: messages.clearRecentStickers +description: Clear recent stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_clearRecentStickers.html +--- +# Method: messages.clearRecentStickers +[Back to methods index](index.md) + + +Clear recent stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Set this flag to clear the list of stickers recently attached to photo or video files | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.clearRecentStickers({attached=Bool, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.createChat.md b/old_docs/API_docs_v109/methods/messages.createChat.md new file mode 100644 index 00000000..14c522d5 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.createChat.md @@ -0,0 +1,57 @@ +--- +title: messages.createChat +description: Creates a new chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_createChat.html +--- +# Method: messages.createChat +[Back to methods index](index.md) + + +Creates a new chat. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | Chat name | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.createChat({users={InputUser}, title='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_INVALID|Invalid chat| +|400|CHAT_TITLE_EMPTY|No chat title provided| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|USERS_TOO_FEW|Not enough users (to create a chat, for example)| +|403|USER_RESTRICTED|You're spamreported, you can't create channels or chats.| + + diff --git a/old_docs/API_docs_v109/methods/messages.deleteChatUser.md b/old_docs/API_docs_v109/methods/messages.deleteChatUser.md new file mode 100644 index 00000000..60274efe --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.deleteChatUser.md @@ -0,0 +1,56 @@ +--- +title: messages.deleteChatUser +description: Deletes a user from a chat and sends a service message on it. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_deleteChatUser.html +--- +# Method: messages.deleteChatUser +[Back to methods index](index.md) + + +Deletes a user from a chat and sends a service message on it. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID to be deleted | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.deleteChatUser({chat_id=InputPeer, user_id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v109/methods/messages.deleteHistory.md b/old_docs/API_docs_v109/methods/messages.deleteHistory.md new file mode 100644 index 00000000..909831be --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.deleteHistory.md @@ -0,0 +1,56 @@ +--- +title: messages.deleteHistory +description: Deletes communication history. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_deleteHistory.html +--- +# Method: messages.deleteHistory +[Back to methods index](index.md) + + +Deletes communication history. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Just clear history for the current user, without actually removing messages for every chat user | Optional| +|revoke|[Bool](../types/Bool.md) | Whether to delete the message history for all chat participants | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | User or chat, communication history of which will be deleted | Optional| +|max\_id|[int](../types/int.md) | Maximum ID of message to delete | Yes| + + +### Return type: [messages.AffectedHistory](../types/messages.AffectedHistory.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, 'revoke' => Bool, 'peer' => InputPeer, 'max_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.AffectedHistory = messages.deleteHistory({just_clear=Bool, revoke=Bool, peer=InputPeer, max_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.deleteMessages.md b/old_docs/API_docs_v109/methods/messages.deleteMessages.md new file mode 100644 index 00000000..a90d7991 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.deleteMessages.md @@ -0,0 +1,53 @@ +--- +title: messages.deleteMessages +description: Deletes messages by their identifiers. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_deleteMessages.html +--- +# Method: messages.deleteMessages +[Back to methods index](index.md) + + +Deletes messages by their identifiers. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Whether to delete messages for all participants of the chat | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| + + +### Return type: [messages.AffectedMessages](../types/messages.AffectedMessages.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +messages.AffectedMessages = messages.deleteMessages({revoke=Bool, id={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|403|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_v109/methods/messages.deleteScheduledMessages.md b/old_docs/API_docs_v109/methods/messages.deleteScheduledMessages.md new file mode 100644 index 00000000..37bbb90a --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.deleteScheduledMessages.md @@ -0,0 +1,46 @@ +--- +title: messages.deleteScheduledMessages +description: Delete scheduled messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_deleteScheduledMessages.html +--- +# Method: messages.deleteScheduledMessages +[Back to methods index](index.md) + + +Delete scheduled messages + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | ID | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->deleteScheduledMessages(['peer' => InputPeer, 'id' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.deleteScheduledMessages({peer=InputPeer, id={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.discardEncryption.md b/old_docs/API_docs_v109/methods/messages.discardEncryption.md new file mode 100644 index 00000000..e7684cbf --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.discardEncryption.md @@ -0,0 +1,54 @@ +--- +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 +redirect_from: /API_docs/methods/messages_discardEncryption.html +--- +# 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 + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->discardEncryption(['chat_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.discardEncryption({chat_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_EMPTY|The provided chat ID is empty| +|400|ENCRYPTION_ALREADY_DECLINED|The secret chat was already declined| +|400|ENCRYPTION_ID_INVALID|The provided secret chat ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.editChatAbout.md b/old_docs/API_docs_v109/methods/messages.editChatAbout.md new file mode 100644 index 00000000..dbe28e12 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.editChatAbout.md @@ -0,0 +1,58 @@ +--- +title: messages.editChatAbout +description: Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_editChatAbout.html +--- +# Method: messages.editChatAbout +[Back to methods index](index.md) + + +Edit the description of a [group/supergroup/channel](https://core.telegram.org/api/channel). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The [group/supergroup/channel](https://core.telegram.org/api/channel). | Optional| +|about|[string](../types/string.md) | The new description | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->editChatAbout(['peer' => InputPeer, 'about' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.editChatAbout({peer=InputPeer, about='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ABOUT_NOT_MODIFIED|About text has not changed| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/messages.editChatAdmin.md b/old_docs/API_docs_v109/methods/messages.editChatAdmin.md new file mode 100644 index 00000000..fa94a5c4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.editChatAdmin.md @@ -0,0 +1,55 @@ +--- +title: messages.editChatAdmin +description: Make a user admin in a [legacy group](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_editChatAdmin.html +--- +# Method: messages.editChatAdmin +[Back to methods index](index.md) + + +Make a user admin in a [legacy group](https://core.telegram.org/api/channel). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to make admin | Optional| +|is\_admin|[Bool](../types/Bool.md) | Whether to make him admin | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.editChatAdmin({chat_id=InputPeer, user_id=InputUser, is_admin=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel| + + diff --git a/old_docs/API_docs_v109/methods/messages.editChatDefaultBannedRights.md b/old_docs/API_docs_v109/methods/messages.editChatDefaultBannedRights.md new file mode 100644 index 00000000..5b17a2b9 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.editChatDefaultBannedRights.md @@ -0,0 +1,56 @@ +--- +title: messages.editChatDefaultBannedRights +description: Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_editChatDefaultBannedRights.html +--- +# Method: messages.editChatDefaultBannedRights +[Back to methods index](index.md) + + +Edit the default banned rights of a [channel/supergroup/group](https://core.telegram.org/api/channel). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| +|banned\_rights|[ChatBannedRights](../types/ChatBannedRights.md) | The new global rights | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->editChatDefaultBannedRights(['peer' => InputPeer, 'banned_rights' => ChatBannedRights, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.editChatDefaultBannedRights({peer=InputPeer, banned_rights=ChatBannedRights, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BANNED_RIGHTS_INVALID|You provided some invalid flags in the banned rights| +|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|UNTIL_DATE_INVALID|Invalid until date provided| + + diff --git a/old_docs/API_docs_v109/methods/messages.editChatPhoto.md b/old_docs/API_docs_v109/methods/messages.editChatPhoto.md new file mode 100644 index 00000000..addf9c4f --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.editChatPhoto.md @@ -0,0 +1,58 @@ +--- +title: messages.editChatPhoto +description: Changes chat photo and sends a service message on it +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_editChatPhoto.html +--- +# Method: messages.editChatPhoto +[Back to methods index](index.md) + + +Changes chat photo and sends a service message on it + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Photo to be set | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.editChatPhoto({chat_id=InputPeer, photo=InputChatPhoto, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|400|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|400|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.editChatTitle.md b/old_docs/API_docs_v109/methods/messages.editChatTitle.md new file mode 100644 index 00000000..96010ee9 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.editChatTitle.md @@ -0,0 +1,56 @@ +--- +title: messages.editChatTitle +description: Chanages chat name and sends a service message on it. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_editChatTitle.html +--- +# Method: messages.editChatTitle +[Back to methods index](index.md) + + +Chanages chat name and sends a service message on it. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | New chat name, different from the old one | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.editChatTitle({chat_id=InputPeer, title='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified| +|400|CHAT_TITLE_EMPTY|No chat title provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.editInlineBotMessage.md b/old_docs/API_docs_v109/methods/messages.editInlineBotMessage.md new file mode 100644 index 00000000..0303c74a --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.editInlineBotMessage.md @@ -0,0 +1,107 @@ +--- +title: messages.editInlineBotMessage +description: Edit an inline bot message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_editInlineBotMessage.html +--- +# Method: messages.editInlineBotMessage +[Back to methods index](index.md) + + +Edit an inline bot message + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Sent inline message ID | Yes| +|message|[string](../types/string.md) | Message | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Media | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Reply markup for inline keyboards | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, 'id' => InputBotInlineMessageID, 'message' => 'string', 'media' => InputMedia, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.editInlineBotMessage({no_webpage=Bool, id=InputBotInlineMessageID, message='string', media=InputMedia, reply_markup=ReplyMarkup, entities={MessageEntity}, parseMode='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 [Bool](../types/Bool.md) will be returned instead. + + + +## Usage of parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough +strikethrough +strikethrough +inline fixed-width code +
pre-formatted fixed-width code block
+
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: + +```markdown +[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 + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|MESSAGE_NOT_MODIFIED|The message text has not changed| + + diff --git a/old_docs/API_docs_v109/methods/messages.editMessage.md b/old_docs/API_docs_v109/methods/messages.editMessage.md new file mode 100644 index 00000000..cafc5bef --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.editMessage.md @@ -0,0 +1,127 @@ +--- +title: messages.editMessage +description: Edit message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_editMessage.html +--- +# Method: messages.editMessage +[Back to methods index](index.md) + + +Edit message + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where was the message sent | Optional| +|id|[int](../types/int.md) | ID of the message to edit | Yes| +|message|[string](../types/string.md) | New message | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | New attached media | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Reply markup for inline keyboards | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, 'peer' => InputPeer, 'id' => int, 'message' => 'string', 'media' => InputMedia, 'reply_markup' => ReplyMarkup, 'entities' => [MessageEntity, MessageEntity], 'parse_mode' => 'string', 'schedule_date' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.editMessage({no_webpage=Bool, peer=InputPeer, id=int, message='string', media=InputMedia, reply_markup=ReplyMarkup, entities={MessageEntity}, parseMode='string', schedule_date=int, }) +``` + + +## 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 parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough +strikethrough +strikethrough +inline fixed-width code +
pre-formatted fixed-width code block
+
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: + +```markdown +[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 + +| Code | Type | Description | +|------|----------|---------------| +|400|BUTTON_DATA_INVALID|The data of one or more of the buttons you provided is invalid| +|400|BUTTON_TYPE_INVALID|The type of one or more of the buttons you provided is invalid| +|400|BUTTON_URL_INVALID|Button URL invalid| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|MEDIA_PREV_INVALID|Previous media invalid| +|400|MESSAGE_EDIT_TIME_EXPIRED|You can't edit this message anymore, too much time has passed since its creation.| +|400|MESSAGE_EMPTY|The provided message is empty| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|MESSAGE_NOT_MODIFIED|The message text has not changed| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|400|SCHEDULE_DATE_INVALID|Invalid schedule date provided| +|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|403|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|403|INLINE_BOT_REQUIRED|Only the inline bot can edit message| +|403|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v109/methods/messages.exportChatInvite.md b/old_docs/API_docs_v109/methods/messages.exportChatInvite.md new file mode 100644 index 00000000..0295197f --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.exportChatInvite.md @@ -0,0 +1,56 @@ +--- +title: messages.exportChatInvite +description: Export an invite link for a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_exportChatInvite.html +--- +# Method: messages.exportChatInvite +[Back to methods index](index.md) + + +Export an invite link for a chat + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Chat | Optional| + + +### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['peer' => InputPeer, ]); +``` + +Or, if you're into Lua: + +```lua +ExportedChatInvite = messages.exportChatInvite({peer=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/messages.faveSticker.md b/old_docs/API_docs_v109/methods/messages.faveSticker.md new file mode 100644 index 00000000..9d058e98 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.faveSticker.md @@ -0,0 +1,53 @@ +--- +title: messages.faveSticker +description: Mark a sticker as favorite +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_faveSticker.html +--- +# Method: messages.faveSticker +[Back to methods index](index.md) + + +Mark a sticker as favorite + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Sticker to mark as favorite | Optional| +|unfave|[Bool](../types/Bool.md) | Unfavorite | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.faveSticker({id=InputDocument, unfave=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.forwardMessages.md b/old_docs/API_docs_v109/methods/messages.forwardMessages.md new file mode 100644 index 00000000..2b874f1a --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.forwardMessages.md @@ -0,0 +1,82 @@ +--- +title: messages.forwardMessages +description: Forwards messages by their IDs. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_forwardMessages.html +--- +# Method: messages.forwardMessages +[Back to methods index](index.md) + + +Forwards messages by their IDs. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Whether to send messages silently (no notification will be triggered on the destination clients) | Optional| +|background|[Bool](../types/Bool.md) | Whether to send the message in background | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | When forwarding games, whether to include your score in the game | Optional| +|grouped|[Bool](../types/Bool.md) | Whether the specified messages represent an album (grouped media) | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Source of messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Destination peer | Optional| +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, 'schedule_date' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.forwardMessages({silent=Bool, background=Bool, with_my_score=Bool, grouped=Bool, from_peer=InputPeer, id={int}, to_peer=InputPeer, schedule_date=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|CHAT_RESTRICTED|You can't send messages in this chat, you were restricted| +|400|GROUPED_MEDIA_INVALID|Invalid grouped media| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|MEDIA_EMPTY|The provided media object is invalid| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|MESSAGE_IDS_EMPTY|No message ids were provided| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|RANDOM_ID_INVALID|A provided random ID is invalid| +|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|400|USER_IS_BLOCKED|You were blocked by this user| +|400|USER_IS_BOT|Bots can't send messages to other bots| +|400|YOU_BLOCKED_USER|You blocked this user| +|403|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|403|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|403|CHAT_SEND_POLL_FORBIDDEN|You can't send polls in this chat| +|403|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: you must wait for the specified number of seconds before sending another message to the chat.| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/messages.getAllChats.md b/old_docs/API_docs_v109/methods/messages.getAllChats.md new file mode 100644 index 00000000..ad71d301 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getAllChats.md @@ -0,0 +1,52 @@ +--- +title: messages.getAllChats +description: Get all chats, channels and supergroups +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getAllChats.html +--- +# Method: messages.getAllChats +[Back to methods index](index.md) + + +Get all chats, channels and supergroups + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = messages.getAllChats({except_ids={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v109/methods/messages.getAllDrafts.md b/old_docs/API_docs_v109/methods/messages.getAllDrafts.md new file mode 100644 index 00000000..f6c67b16 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getAllDrafts.md @@ -0,0 +1,40 @@ +--- +title: messages.getAllDrafts +description: Save get all message [drafts](https://core.telegram.org/api/drafts). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getAllDrafts.html +--- +# Method: messages.getAllDrafts +[Back to methods index](index.md) + + +Save get all message [drafts](https://core.telegram.org/api/drafts). + + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.getAllDrafts({}) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getAllStickers.md b/old_docs/API_docs_v109/methods/messages.getAllStickers.md new file mode 100644 index 00000000..2f0cd4cf --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getAllStickers.md @@ -0,0 +1,45 @@ +--- +title: messages.getAllStickers +description: Get all installed stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getAllStickers.html +--- +# Method: messages.getAllStickers +[Back to methods index](index.md) + + +Get all installed stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | The hash parameter of the previous result of this method | Optional| + + +### Return type: [messages.AllStickers](../types/messages.AllStickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.AllStickers = messages.getAllStickers({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getArchivedStickers.md b/old_docs/API_docs_v109/methods/messages.getArchivedStickers.md new file mode 100644 index 00000000..3085e73f --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getArchivedStickers.md @@ -0,0 +1,47 @@ +--- +title: messages.getArchivedStickers +description: Get all archived stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getArchivedStickers.html +--- +# Method: messages.getArchivedStickers +[Back to methods index](index.md) + + +Get all archived stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get mask stickers | Optional| +|offset\_id|[long](../types/long.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [messages.ArchivedStickers](../types/messages.ArchivedStickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.ArchivedStickers = messages.getArchivedStickers({masks=Bool, offset_id=long, limit=int, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getAttachedStickers.md b/old_docs/API_docs_v109/methods/messages.getAttachedStickers.md new file mode 100644 index 00000000..fac5085e --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getAttachedStickers.md @@ -0,0 +1,45 @@ +--- +title: messages.getAttachedStickers +description: Get stickers attached to a photo or video +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getAttachedStickers.html +--- +# Method: messages.getAttachedStickers +[Back to methods index](index.md) + + +Get stickers attached to a photo or video + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Stickered media | Yes| + + +### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_StickerSetCovered = messages.getAttachedStickers({media=InputStickeredMedia, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getBotCallbackAnswer.md b/old_docs/API_docs_v109/methods/messages.getBotCallbackAnswer.md new file mode 100644 index 00000000..b168a978 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getBotCallbackAnswer.md @@ -0,0 +1,61 @@ +--- +title: messages.getBotCallbackAnswer +description: Press an inline callback button and get a callback answer from the bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getBotCallbackAnswer.html +--- +# Method: messages.getBotCallbackAnswer +[Back to methods index](index.md) + + +Press an inline callback button and get a callback answer from the bot + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Whether this is a "play game" button | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where was the inline keyboard sent | Optional| +|msg\_id|[int](../types/int.md) | ID of the Message with the inline keyboard | Yes| +|data|[bytes](../types/bytes.md) | Callback data | Optional| + + +### Return type: [messages.BotCallbackAnswer](../types/messages.BotCallbackAnswer.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +messages.BotCallbackAnswer = messages.getBotCallbackAnswer({game=Bool, peer=InputPeer, msg_id=int, data='bytes', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|DATA_INVALID|Encrypted data invalid| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/messages.getChats.md b/old_docs/API_docs_v109/methods/messages.getChats.md new file mode 100644 index 00000000..496e0f7c --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getChats.md @@ -0,0 +1,53 @@ +--- +title: messages.getChats +description: Returns chat basic info on their IDs. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getChats.html +--- +# Method: messages.getChats +[Back to methods index](index.md) + + +Returns chat basic info on their IDs. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = messages.getChats({id={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getCommonChats.md b/old_docs/API_docs_v109/methods/messages.getCommonChats.md new file mode 100644 index 00000000..331b6912 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getCommonChats.md @@ -0,0 +1,55 @@ +--- +title: messages.getCommonChats +description: Get chats in common with a user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getCommonChats.html +--- +# Method: messages.getCommonChats +[Back to methods index](index.md) + + +Get chats in common with a user + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional| +|max\_id|[int](../types/int.md) | Maximum ID of chat to return (see [pagination](https://core.telegram.org/api/offsets)) | Yes| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [messages.Chats](../types/messages.Chats.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.Chats = messages.getCommonChats({user_id=InputUser, max_id=int, limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getDhConfig.md b/old_docs/API_docs_v109/methods/messages.getDhConfig.md new file mode 100644 index 00000000..a23ce8ec --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getDhConfig.md @@ -0,0 +1,53 @@ +--- +title: messages.getDhConfig +description: You cannot use this method directly, instead use $MadelineProto->getDhConfig(); +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getDhConfig.html +--- +# Method: messages.getDhConfig +[Back to methods index](index.md) + + +You cannot use this method directly, instead use $MadelineProto->getDhConfig(); + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|version|[int](../types/int.md) | You cannot use this method directly, instead use $MadelineProto->getDhConfig(); | Yes| +|random\_length|[int](../types/int.md) | You cannot use this method directly, instead use $MadelineProto->getDhConfig(); | Yes| + + +### Return type: [messages.DhConfig](../types/messages.DhConfig.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.DhConfig = $MadelineProto->messages->getDhConfig(['version' => int, 'random_length' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.DhConfig = messages.getDhConfig({version=int, random_length=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|RANDOM_LENGTH_INVALID|Random length invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getDialogUnreadMarks.md b/old_docs/API_docs_v109/methods/messages.getDialogUnreadMarks.md new file mode 100644 index 00000000..fe6bf206 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getDialogUnreadMarks.md @@ -0,0 +1,40 @@ +--- +title: messages.getDialogUnreadMarks +description: Get dialogs manually marked as unread +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getDialogUnreadMarks.html +--- +# Method: messages.getDialogUnreadMarks +[Back to methods index](index.md) + + +Get dialogs manually marked as unread + + + +### Return type: [Vector\_of\_DialogPeer](../types/DialogPeer.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +Vector_of_DialogPeer = messages.getDialogUnreadMarks({}) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getDialogs.md b/old_docs/API_docs_v109/methods/messages.getDialogs.md new file mode 100644 index 00000000..d73dfe2a --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getDialogs.md @@ -0,0 +1,62 @@ +--- +title: messages.getDialogs +description: Returns the current user dialog list. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getDialogs.html +--- +# Method: messages.getDialogs +[Back to methods index](index.md) + + +Returns the current user dialog list. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Exclude pinned dialogs | Optional| +|folder\_id|[int](../types/int.md) | Folder ID | Optional| +|offset\_date|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| +|offset\_id|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | [Offset peer for pagination](https://core.telegram.org/api/offsets) | Optional| +|limit|[int](../types/int.md) | Number of list elements to be returned | Yes| +|hash|Array of [int](../types/int.md) | IDs of previously fetched dialogs | Optional| + + +### Return type: [messages.Dialogs](../types/messages.Dialogs.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, 'folder_id' => int, 'offset_date' => int, 'offset_id' => int, 'offset_peer' => InputPeer, 'limit' => int, 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Dialogs = messages.getDialogs({exclude_pinned=Bool, folder_id=int, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, hash={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|400|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/messages.getDocumentByHash.md b/old_docs/API_docs_v109/methods/messages.getDocumentByHash.md new file mode 100644 index 00000000..4b665301 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getDocumentByHash.md @@ -0,0 +1,54 @@ +--- +title: messages.getDocumentByHash +description: Get a document by its SHA256 hash, mainly used for gifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getDocumentByHash.html +--- +# Method: messages.getDocumentByHash +[Back to methods index](index.md) + + +Get a document by its SHA256 hash, mainly used for gifs + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | SHA256 of file | Yes| +|size|[int](../types/int.md) | Size of the file in bytes | Yes| +|mime\_type|[string](../types/string.md) | Mime type | Yes| + + +### Return type: [Document](../types/Document.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Document = messages.getDocumentByHash({sha256='bytes', size=int, mime_type='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getEmojiKeywords.md b/old_docs/API_docs_v109/methods/messages.getEmojiKeywords.md new file mode 100644 index 00000000..b61fedb5 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getEmojiKeywords.md @@ -0,0 +1,45 @@ +--- +title: messages.getEmojiKeywords +description: Get localized emoji keywords +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getEmojiKeywords.html +--- +# Method: messages.getEmojiKeywords +[Back to methods index](index.md) + + +Get localized emoji keywords + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language code | Yes| + + +### Return type: [EmojiKeywordsDifference](../types/EmojiKeywordsDifference.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$EmojiKeywordsDifference = $MadelineProto->messages->getEmojiKeywords(['lang_code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +EmojiKeywordsDifference = messages.getEmojiKeywords({lang_code='string', }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getEmojiKeywordsDifference.md b/old_docs/API_docs_v109/methods/messages.getEmojiKeywordsDifference.md new file mode 100644 index 00000000..de578761 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getEmojiKeywordsDifference.md @@ -0,0 +1,46 @@ +--- +title: messages.getEmojiKeywordsDifference +description: Get changed emoji keywords +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getEmojiKeywordsDifference.html +--- +# Method: messages.getEmojiKeywordsDifference +[Back to methods index](index.md) + + +Get changed emoji keywords + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language code | Yes| +|from\_version|[int](../types/int.md) | Previous emoji keyword localization version | Yes| + + +### Return type: [EmojiKeywordsDifference](../types/EmojiKeywordsDifference.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$EmojiKeywordsDifference = $MadelineProto->messages->getEmojiKeywordsDifference(['lang_code' => 'string', 'from_version' => int, ]); +``` + +Or, if you're into Lua: + +```lua +EmojiKeywordsDifference = messages.getEmojiKeywordsDifference({lang_code='string', from_version=int, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getEmojiKeywordsLanguages.md b/old_docs/API_docs_v109/methods/messages.getEmojiKeywordsLanguages.md new file mode 100644 index 00000000..7d5890e4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getEmojiKeywordsLanguages.md @@ -0,0 +1,45 @@ +--- +title: messages.getEmojiKeywordsLanguages +description: Get info about an emoji keyword localization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getEmojiKeywordsLanguages.html +--- +# Method: messages.getEmojiKeywordsLanguages +[Back to methods index](index.md) + + +Get info about an emoji keyword localization + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_codes|Array of [string](../types/string.md) | Language codes | Yes| + + +### Return type: [Vector\_of\_EmojiLanguage](../types/EmojiLanguage.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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_EmojiLanguage = $MadelineProto->messages->getEmojiKeywordsLanguages(['lang_codes' => ['string', 'string'], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_EmojiLanguage = messages.getEmojiKeywordsLanguages({lang_codes={'string'}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getEmojiURL.md b/old_docs/API_docs_v109/methods/messages.getEmojiURL.md new file mode 100644 index 00000000..a391a384 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getEmojiURL.md @@ -0,0 +1,45 @@ +--- +title: messages.getEmojiURL +description: Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getEmojiURL.html +--- +# Method: messages.getEmojiURL +[Back to methods index](index.md) + + +Returns an HTTP URL which can be used to automatically log in into translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language code for which the emoji replacements will be suggested | Yes| + + +### Return type: [EmojiURL](../types/EmojiURL.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$EmojiURL = $MadelineProto->messages->getEmojiURL(['lang_code' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +EmojiURL = messages.getEmojiURL({lang_code='string', }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getFavedStickers.md b/old_docs/API_docs_v109/methods/messages.getFavedStickers.md new file mode 100644 index 00000000..485118ab --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getFavedStickers.md @@ -0,0 +1,45 @@ +--- +title: messages.getFavedStickers +description: Get faved stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getFavedStickers.html +--- +# Method: messages.getFavedStickers +[Back to methods index](index.md) + + +Get faved stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | the hash parameter of the previous result of this method | Optional| + + +### Return type: [messages.FavedStickers](../types/messages.FavedStickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.FavedStickers = messages.getFavedStickers({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getFeaturedStickers.md b/old_docs/API_docs_v109/methods/messages.getFeaturedStickers.md new file mode 100644 index 00000000..2ce134d2 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getFeaturedStickers.md @@ -0,0 +1,45 @@ +--- +title: messages.getFeaturedStickers +description: Get featured stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getFeaturedStickers.html +--- +# Method: messages.getFeaturedStickers +[Back to methods index](index.md) + + +Get featured stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | the hash parameter of the previous result of this method | Optional| + + +### Return type: [messages.FeaturedStickers](../types/messages.FeaturedStickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.FeaturedStickers = messages.getFeaturedStickers({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getFullChat.md b/old_docs/API_docs_v109/methods/messages.getFullChat.md new file mode 100644 index 00000000..4be62e50 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getFullChat.md @@ -0,0 +1,53 @@ +--- +title: messages.getFullChat +description: You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getFullChat.html +--- +# Method: messages.getFullChat +[Back to methods index](index.md) + + +You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) | Optional| + + +### Return type: [messages.ChatFull](../types/messages.ChatFull.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.ChatFull = $MadelineProto->messages->getFullChat(['chat_id' => InputPeer, ]); +``` + +Or, if you're into Lua: + +```lua +messages.ChatFull = messages.getFullChat({chat_id=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getGameHighScores.md b/old_docs/API_docs_v109/methods/messages.getGameHighScores.md new file mode 100644 index 00000000..c47b13d3 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getGameHighScores.md @@ -0,0 +1,56 @@ +--- +title: messages.getGameHighScores +description: Get highscores of a game +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getGameHighScores.html +--- +# Method: messages.getGameHighScores +[Back to methods index](index.md) + + +Get highscores of a game + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where was the game sent | Optional| +|id|[int](../types/int.md) | ID of message with game media attachment | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Get high scores made by a certain user | Optional| + + +### Return type: [messages.HighScores](../types/messages.HighScores.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v109/methods/messages.getHistory.md b/old_docs/API_docs_v109/methods/messages.getHistory.md new file mode 100644 index 00000000..e1939946 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getHistory.md @@ -0,0 +1,66 @@ +--- +title: messages.getHistory +description: Gets back the conversation history with one interlocutor / within a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getHistory.html +--- +# Method: messages.getHistory +[Back to methods index](index.md) + + +Gets back the conversation history with one interlocutor / within a chat + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Target peer | Optional| +|offset\_id|[int](../types/int.md) | Only return messages starting from the specified message ID | Yes| +|offset\_date|[int](../types/int.md) | Only return messages sent after the specified date | Yes| +|add\_offset|[int](../types/int.md) | Number of list elements to be skipped, negative values are also accepted. | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | If a positive value was transferred, the method will return only messages with IDs less than **max\_id** | Yes| +|min\_id|[int](../types/int.md) | If a positive value was transferred, the method will return only messages with IDs more than **min\_id** | Yes| +|hash|Array of [int](../types/int.md) | IDs of messages you already fetched | Optional| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```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 + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/messages.getInlineBotResults.md b/old_docs/API_docs_v109/methods/messages.getInlineBotResults.md new file mode 100644 index 00000000..4a7bb685 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getInlineBotResults.md @@ -0,0 +1,59 @@ +--- +title: messages.getInlineBotResults +description: Query an inline bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getInlineBotResults.html +--- +# Method: messages.getInlineBotResults +[Back to methods index](index.md) + + +Query an inline bot + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to query | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The currently opened chat | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The geolocation, if requested | Optional| +|query|[string](../types/string.md) | The query | Yes| +|offset|[string](../types/string.md) | The offset within the results, will be passed directly as-is to the bot. | Yes| + + +### Return type: [messages.BotResults](../types/messages.BotResults.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +messages.BotResults = messages.getInlineBotResults({bot=InputUser, peer=InputPeer, geo_point=InputGeoPoint, query='string', offset='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_INLINE_DISABLED|This bot can't be used in inline mode| +|400|BOT_INVALID|This is not a valid bot| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/messages.getInlineGameHighScores.md b/old_docs/API_docs_v109/methods/messages.getInlineGameHighScores.md new file mode 100644 index 00000000..88e2a02c --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getInlineGameHighScores.md @@ -0,0 +1,54 @@ +--- +title: messages.getInlineGameHighScores +description: Get highscores of a game sent using an inline bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getInlineGameHighScores.html +--- +# Method: messages.getInlineGameHighScores +[Back to methods index](index.md) + + +Get highscores of a game sent using an inline bot + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | ID of inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Get high scores of a certain user | Optional| + + +### Return type: [messages.HighScores](../types/messages.HighScores.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v109/methods/messages.getMaskStickers.md b/old_docs/API_docs_v109/methods/messages.getMaskStickers.md new file mode 100644 index 00000000..2a760f21 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getMaskStickers.md @@ -0,0 +1,45 @@ +--- +title: messages.getMaskStickers +description: Get installed mask stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getMaskStickers.html +--- +# Method: messages.getMaskStickers +[Back to methods index](index.md) + + +Get installed mask stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | the hash parameter of the previous result of this method | Optional| + + +### Return type: [messages.AllStickers](../types/messages.AllStickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.AllStickers = messages.getMaskStickers({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getMessageEditData.md b/old_docs/API_docs_v109/methods/messages.getMessageEditData.md new file mode 100644 index 00000000..c1eaa05d --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getMessageEditData.md @@ -0,0 +1,55 @@ +--- +title: messages.getMessageEditData +description: Find out if a media message's caption can be edited +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getMessageEditData.html +--- +# Method: messages.getMessageEditData +[Back to methods index](index.md) + + +Find out if a media message's caption can be edited + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where the media was sent | Optional| +|id|[int](../types/int.md) | ID of message | Yes| + + +### Return type: [messages.MessageEditData](../types/messages.MessageEditData.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.MessageEditData = messages.getMessageEditData({peer=InputPeer, id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|403|MESSAGE_AUTHOR_REQUIRED|Message author required| + + diff --git a/old_docs/API_docs_v109/methods/messages.getMessages.md b/old_docs/API_docs_v109/methods/messages.getMessages.md new file mode 100644 index 00000000..d44e0b80 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getMessages.md @@ -0,0 +1,45 @@ +--- +title: messages.getMessages +description: Returns the list of messages by their IDs. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getMessages.html +--- +# Method: messages.getMessages +[Back to methods index](index.md) + + +Returns the list of messages by their IDs. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = messages.getMessages({id={InputMessage}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getMessagesViews.md b/old_docs/API_docs_v109/methods/messages.getMessagesViews.md new file mode 100644 index 00000000..2b808720 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getMessagesViews.md @@ -0,0 +1,60 @@ +--- +title: messages.getMessagesViews +description: Get and increase the view counter of a message sent or forwarded from a [channel](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getMessagesViews.html +--- +# Method: messages.getMessagesViews +[Back to methods index](index.md) + + +Get and increase the view counter of a message sent or forwarded from a [channel](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where the message was found | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Whether to mark the message as viewed and increment the view counter | Yes| + + +### Return type: [Vector\_of\_int](../types/int.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_int = messages.getMessagesViews({peer=InputPeer, id={int}, increment=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/messages.getOnlines.md b/old_docs/API_docs_v109/methods/messages.getOnlines.md new file mode 100644 index 00000000..3fe81022 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getOnlines.md @@ -0,0 +1,52 @@ +--- +title: messages.getOnlines +description: Get count of online users in a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getOnlines.html +--- +# Method: messages.getOnlines +[Back to methods index](index.md) + + +Get count of online users in a chat + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| + + +### Return type: [ChatOnlines](../types/ChatOnlines.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$ChatOnlines = $MadelineProto->messages->getOnlines(['peer' => InputPeer, ]); +``` + +Or, if you're into Lua: + +```lua +ChatOnlines = messages.getOnlines({peer=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getPeerDialogs.md b/old_docs/API_docs_v109/methods/messages.getPeerDialogs.md new file mode 100644 index 00000000..15e97487 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getPeerDialogs.md @@ -0,0 +1,55 @@ +--- +title: messages.getPeerDialogs +description: Get dialog info of specified peers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getPeerDialogs.html +--- +# Method: messages.getPeerDialogs +[Back to methods index](index.md) + + +Get dialog info of specified peers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputDialogPeer](../types/InputDialogPeer.md) | The peers | Yes| + + +### Return type: [messages.PeerDialogs](../types/messages.PeerDialogs.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +messages.PeerDialogs = messages.getPeerDialogs({peers={InputDialogPeer}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/messages.getPeerSettings.md b/old_docs/API_docs_v109/methods/messages.getPeerSettings.md new file mode 100644 index 00000000..8c6ed7ac --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getPeerSettings.md @@ -0,0 +1,53 @@ +--- +title: messages.getPeerSettings +description: Get peer settings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getPeerSettings.html +--- +# Method: messages.getPeerSettings +[Back to methods index](index.md) + + +Get peer settings + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| + + +### Return type: [PeerSettings](../types/PeerSettings.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +PeerSettings = messages.getPeerSettings({peer=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getPinnedDialogs.md b/old_docs/API_docs_v109/methods/messages.getPinnedDialogs.md new file mode 100644 index 00000000..a1bac4c4 --- /dev/null +++ b/old_docs/API_docs_v109/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 +redirect_from: /API_docs/methods/messages_getPinnedDialogs.html +--- +# Method: messages.getPinnedDialogs +[Back to methods index](index.md) + + +Get pinned dialogs + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|folder\_id|[int](../types/int.md) | Folder ID | Yes| + + +### Return type: [messages.PeerDialogs](../types/messages.PeerDialogs.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['folder_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.PeerDialogs = messages.getPinnedDialogs({folder_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|FOLDER_ID_INVALID|Invalid folder ID| + + diff --git a/old_docs/API_docs_v109/methods/messages.getPollResults.md b/old_docs/API_docs_v109/methods/messages.getPollResults.md new file mode 100644 index 00000000..93b638da --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getPollResults.md @@ -0,0 +1,53 @@ +--- +title: messages.getPollResults +description: Get poll results +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getPollResults.html +--- +# Method: messages.getPollResults +[Back to methods index](index.md) + + +Get poll results + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where the poll was found | Optional| +|msg\_id|[int](../types/int.md) | Message ID of poll message | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->getPollResults(['peer' => InputPeer, 'msg_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.getPollResults({peer=InputPeer, msg_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getPollVotes.md b/old_docs/API_docs_v109/methods/messages.getPollVotes.md new file mode 100644 index 00000000..d8021eb9 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getPollVotes.md @@ -0,0 +1,47 @@ +--- +title: messages.getPollVotes +description: messages.getPollVotes parameters, return type and example +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getPollVotes.html +--- +# Method: messages.getPollVotes +[Back to methods index](index.md) + + +### Parameters: + +| Name | Type | Required | +|----------|---------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +|id|[int](../types/int.md) | Yes| +|option|[bytes](../types/bytes.md) | Optional| +|offset|[string](../types/string.md) | Optional| +|limit|[int](../types/int.md) | Yes| + + +### Return type: [messages.VotesList](../types/messages.VotesList.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.VotesList = $MadelineProto->messages->getPollVotes(['peer' => InputPeer, 'id' => int, 'option' => 'bytes', 'offset' => 'string', 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.VotesList = messages.getPollVotes({peer=InputPeer, id=int, option='bytes', offset='string', limit=int, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getRecentLocations.md b/old_docs/API_docs_v109/methods/messages.getRecentLocations.md new file mode 100644 index 00000000..fa28cf37 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getRecentLocations.md @@ -0,0 +1,47 @@ +--- +title: messages.getRecentLocations +description: Get live location history of a certain user +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getRecentLocations.html +--- +# Method: messages.getRecentLocations +[Back to methods index](index.md) + + +Get live location history of a certain user + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | User | Optional| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| +|hash|Array of [int](../types/int.md) | IDs of locations you already fetched | Optional| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = messages.getRecentLocations({peer=InputPeer, limit=int, hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getRecentStickers.md b/old_docs/API_docs_v109/methods/messages.getRecentStickers.md new file mode 100644 index 00000000..2fc9b151 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getRecentStickers.md @@ -0,0 +1,46 @@ +--- +title: messages.getRecentStickers +description: Get recent stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getRecentStickers.html +--- +# Method: messages.getRecentStickers +[Back to methods index](index.md) + + +Get recent stickers + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers recently attached to photo or video files | Optional| +|hash|Array of [int](../types/int.md) | IDs the hash parameter of the previous result of this method | Optional| + + +### Return type: [messages.RecentStickers](../types/messages.RecentStickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.RecentStickers = messages.getRecentStickers({attached=Bool, hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getSavedGifs.md b/old_docs/API_docs_v109/methods/messages.getSavedGifs.md new file mode 100644 index 00000000..79bcd57a --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getSavedGifs.md @@ -0,0 +1,45 @@ +--- +title: messages.getSavedGifs +description: Get saved GIFs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getSavedGifs.html +--- +# Method: messages.getSavedGifs +[Back to methods index](index.md) + + +Get saved GIFs + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|Array of [int](../types/int.md) | the hash parameter of the previous result of this method | Optional| + + +### Return type: [messages.SavedGifs](../types/messages.SavedGifs.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.SavedGifs = messages.getSavedGifs({hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getScheduledHistory.md b/old_docs/API_docs_v109/methods/messages.getScheduledHistory.md new file mode 100644 index 00000000..8231b3e4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getScheduledHistory.md @@ -0,0 +1,53 @@ +--- +title: messages.getScheduledHistory +description: Get scheduled messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getScheduledHistory.html +--- +# Method: messages.getScheduledHistory +[Back to methods index](index.md) + + +Get scheduled messages + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|hash|Array of [int](../types/int.md) | Hash | Optional| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->getScheduledHistory(['peer' => InputPeer, 'hash' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = messages.getScheduledHistory({peer=InputPeer, hash={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getScheduledMessages.md b/old_docs/API_docs_v109/methods/messages.getScheduledMessages.md new file mode 100644 index 00000000..81f187bd --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getScheduledMessages.md @@ -0,0 +1,46 @@ +--- +title: messages.getScheduledMessages +description: Get scheduled messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getScheduledMessages.html +--- +# Method: messages.getScheduledMessages +[Back to methods index](index.md) + + +Get scheduled messages + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | ID | Yes| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->getScheduledMessages(['peer' => InputPeer, 'id' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = messages.getScheduledMessages({peer=InputPeer, id={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getSearchCounters.md b/old_docs/API_docs_v109/methods/messages.getSearchCounters.md new file mode 100644 index 00000000..bdeda086 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getSearchCounters.md @@ -0,0 +1,46 @@ +--- +title: messages.getSearchCounters +description: Get the number of results that would be found by a [messages.search](../methods/messages.search.md) call with the same parameters +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getSearchCounters.html +--- +# Method: messages.getSearchCounters +[Back to methods index](index.md) + + +Get the number of results that would be found by a [messages.search](../methods/messages.search.md) call with the same parameters + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where to search | Optional| +|filters|Array of [MessagesFilter](../types/MessagesFilter.md) | Filters | Yes| + + +### Return type: [Vector\_of\_messages.SearchCounter](../types/messages.SearchCounter.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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_messages.SearchCounter = $MadelineProto->messages->getSearchCounters(['peer' => InputPeer, 'filters' => [MessagesFilter, MessagesFilter], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_messages.SearchCounter = messages.getSearchCounters({peer=InputPeer, filters={MessagesFilter}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getSplitRanges.md b/old_docs/API_docs_v109/methods/messages.getSplitRanges.md new file mode 100644 index 00000000..b6eddcc9 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getSplitRanges.md @@ -0,0 +1,40 @@ +--- +title: messages.getSplitRanges +description: Get message ranges for saving the user's chat history +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getSplitRanges.html +--- +# Method: messages.getSplitRanges +[Back to methods index](index.md) + + +Get message ranges for saving the user's chat history + + + +### Return type: [Vector\_of\_MessageRange](../types/MessageRange.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +Vector_of_MessageRange = messages.getSplitRanges({}) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getStatsURL.md b/old_docs/API_docs_v109/methods/messages.getStatsURL.md new file mode 100644 index 00000000..02f6ed6f --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getStatsURL.md @@ -0,0 +1,54 @@ +--- +title: messages.getStatsURL +description: Returns URL with the chat statistics. Currently this method can be used only for channels +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getStatsURL.html +--- +# Method: messages.getStatsURL +[Back to methods index](index.md) + + +Returns URL with the chat statistics. Currently this method can be used only for channels + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|dark|[Bool](../types/Bool.md) | Pass true if a URL with the dark theme must be returned | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Chat identifier | Optional| +|params|[string](../types/string.md) | Parameters from `tg://statsrefresh?params=******` link | Yes| + + +### Return type: [StatsURL](../types/StatsURL.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$StatsURL = $MadelineProto->messages->getStatsURL(['dark' => Bool, 'peer' => InputPeer, 'params' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +StatsURL = messages.getStatsURL({dark=Bool, peer=InputPeer, params='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getStickerSet.md b/old_docs/API_docs_v109/methods/messages.getStickerSet.md new file mode 100644 index 00000000..00a600b6 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getStickerSet.md @@ -0,0 +1,52 @@ +--- +title: messages.getStickerSet +description: Get info about a stickerset +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getStickerSet.html +--- +# Method: messages.getStickerSet +[Back to methods index](index.md) + + +Get info about a stickerset + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Stickerset | Optional| + + +### Return type: [messages.StickerSet](../types/messages.StickerSet.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.StickerSet = messages.getStickerSet({stickerset=InputStickerSet, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getStickers.md b/old_docs/API_docs_v109/methods/messages.getStickers.md new file mode 100644 index 00000000..1798ca5f --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getStickers.md @@ -0,0 +1,46 @@ +--- +title: messages.getStickers +description: Get stickers by emoji +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getStickers.html +--- +# Method: messages.getStickers +[Back to methods index](index.md) + + +Get stickers by emoji + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | The emoji | Yes| +|hash|Array of [int](../types/int.md) | the hash parameter of the previous result of this method | Optional| + + +### Return type: [messages.Stickers](../types/messages.Stickers.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.Stickers = messages.getStickers({emoticon='string', hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.getUnreadMentions.md b/old_docs/API_docs_v109/methods/messages.getUnreadMentions.md new file mode 100644 index 00000000..e6c986c3 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getUnreadMentions.md @@ -0,0 +1,57 @@ +--- +title: messages.getUnreadMentions +description: Get unread messages where we were mentioned +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getUnreadMentions.html +--- +# Method: messages.getUnreadMentions +[Back to methods index](index.md) + + +Get unread messages where we were mentioned + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where to look for mentions | Optional| +|offset\_id|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| +|add\_offset|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| +|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| +|min\_id|[int](../types/int.md) | Minimum message ID to return, [see pagination](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = messages.getUnreadMentions({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getWebPage.md b/old_docs/API_docs_v109/methods/messages.getWebPage.md new file mode 100644 index 00000000..536f157c --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getWebPage.md @@ -0,0 +1,53 @@ +--- +title: messages.getWebPage +description: Get [instant view](https://instantview.telegram.org) page +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getWebPage.html +--- +# Method: messages.getWebPage +[Back to methods index](index.md) + + +Get [instant view](https://instantview.telegram.org) page + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL of IV page to fetch | Yes| +|hash|Array of [int](../types/int.md) | the hash parameter of the previous result of this method | Optional| + + +### Return type: [WebPage](../types/WebPage.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +WebPage = messages.getWebPage({url='string', hash={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|WC_CONVERT_URL_INVALID|WC convert URL invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.getWebPagePreview.md b/old_docs/API_docs_v109/methods/messages.getWebPagePreview.md new file mode 100644 index 00000000..8ffcf58c --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.getWebPagePreview.md @@ -0,0 +1,96 @@ +--- +title: messages.getWebPagePreview +description: Get preview of webpage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_getWebPagePreview.html +--- +# Method: messages.getWebPagePreview +[Back to methods index](index.md) + + +Get preview of webpage + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Message from which to extract the preview | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities for styled text | Optional| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | + + +### Return type: [MessageMedia](../types/MessageMedia.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +MessageMedia = messages.getWebPagePreview({message='string', entities={MessageEntity}, parseMode='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 parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough +strikethrough +strikethrough +inline fixed-width code +
pre-formatted fixed-width code block
+
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: + +```markdown +[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 + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_EMPTY|The provided message is empty| + + diff --git a/old_docs/API_docs_v109/methods/messages.hidePeerSettingsBar.md b/old_docs/API_docs_v109/methods/messages.hidePeerSettingsBar.md new file mode 100644 index 00000000..91ce3cef --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.hidePeerSettingsBar.md @@ -0,0 +1,45 @@ +--- +title: messages.hidePeerSettingsBar +description: Should be called after the user hides the report spam/add as contact bar of a new chat, effectively prevents the user from executing the actions specified in the [peer's settings](../constructors/peerSettings.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_hidePeerSettingsBar.html +--- +# Method: messages.hidePeerSettingsBar +[Back to methods index](index.md) + + +Should be called after the user hides the report spam/add as contact bar of a new chat, effectively prevents the user from executing the actions specified in the [peer's settings](../constructors/peerSettings.md). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->hidePeerSettingsBar(['peer' => InputPeer, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.hidePeerSettingsBar({peer=InputPeer, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.importChatInvite.md b/old_docs/API_docs_v109/methods/messages.importChatInvite.md new file mode 100644 index 00000000..4ba80715 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.importChatInvite.md @@ -0,0 +1,63 @@ +--- +title: messages.importChatInvite +description: Import a chat invite and join a private chat/supergroup/channel +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_importChatInvite.html +--- +# Method: messages.importChatInvite +[Back to methods index](index.md) + + +Import a chat invite and join a private chat/supergroup/channel + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | `hash` from `t.me/joinchat/hash` | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.importChatInvite({hash='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHANNELS_TOO_MUCH|You have joined too many channels/supergroups| +|400|INVITE_HASH_EMPTY|The invite hash is empty| +|400|INVITE_HASH_EXPIRED|The invite link has expired| +|400|INVITE_HASH_INVALID|The invite hash is invalid| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|USER_ALREADY_PARTICIPANT|The user is already in the group| +|400|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v109/methods/messages.installStickerSet.md b/old_docs/API_docs_v109/methods/messages.installStickerSet.md new file mode 100644 index 00000000..6c194fda --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.installStickerSet.md @@ -0,0 +1,53 @@ +--- +title: messages.installStickerSet +description: Install a stickerset +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_installStickerSet.html +--- +# Method: messages.installStickerSet +[Back to methods index](index.md) + + +Install a stickerset + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Stickerset to install | Optional| +|archived|[Bool](../types/Bool.md) | Whether to archive stickerset | Yes| + + +### Return type: [messages.StickerSetInstallResult](../types/messages.StickerSetInstallResult.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.StickerSetInstallResult = messages.installStickerSet({stickerset=InputStickerSet, archived=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.markDialogUnread.md b/old_docs/API_docs_v109/methods/messages.markDialogUnread.md new file mode 100644 index 00000000..54069318 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.markDialogUnread.md @@ -0,0 +1,46 @@ +--- +title: messages.markDialogUnread +description: Manually mark dialog as unread +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_markDialogUnread.html +--- +# Method: messages.markDialogUnread +[Back to methods index](index.md) + + +Manually mark dialog as unread + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|unread|[Bool](../types/Bool.md) | Mark as unread/read | Optional| +|peer|[Username, chat ID, Update, Message or InputDialogPeer](../types/InputDialogPeer.md) | Dialog | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.markDialogUnread({unread=Bool, peer=InputDialogPeer, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.migrateChat.md b/old_docs/API_docs_v109/methods/messages.migrateChat.md new file mode 100644 index 00000000..1bb62e02 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.migrateChat.md @@ -0,0 +1,54 @@ +--- +title: messages.migrateChat +description: Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_migrateChat.html +--- +# Method: messages.migrateChat +[Back to methods index](index.md) + + +Turn a [legacy group into a supergroup](https://core.telegram.org/api/channel) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.migrateChat({chat_id=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|403|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| + + diff --git a/old_docs/API_docs_v109/methods/messages.readEncryptedHistory.md b/old_docs/API_docs_v109/methods/messages.readEncryptedHistory.md new file mode 100644 index 00000000..118316d0 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.readEncryptedHistory.md @@ -0,0 +1,53 @@ +--- +title: messages.readEncryptedHistory +description: Marks message history within a secret chat as read. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_readEncryptedHistory.html +--- +# Method: messages.readEncryptedHistory +[Back to methods index](index.md) + + +Marks message history within a secret chat as read. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Secret chat ID | Yes| +|max\_date|[int](../types/int.md) | Maximum date value for received messages in history | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.readEncryptedHistory({peer=InputEncryptedChat, max_date=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v109/methods/messages.readFeaturedStickers.md b/old_docs/API_docs_v109/methods/messages.readFeaturedStickers.md new file mode 100644 index 00000000..171106de --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.readFeaturedStickers.md @@ -0,0 +1,45 @@ +--- +title: messages.readFeaturedStickers +description: Mark new featured stickers as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_readFeaturedStickers.html +--- +# Method: messages.readFeaturedStickers +[Back to methods index](index.md) + + +Mark new featured stickers as read + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.readFeaturedStickers({id={long}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.readHistory.md b/old_docs/API_docs_v109/methods/messages.readHistory.md new file mode 100644 index 00000000..665a8b74 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.readHistory.md @@ -0,0 +1,55 @@ +--- +title: messages.readHistory +description: Marks message history as read. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_readHistory.html +--- +# Method: messages.readHistory +[Back to methods index](index.md) + + +Marks message history as read. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Target user or group | Optional| +|max\_id|[int](../types/int.md) | If a positive value is passed, only messages with identifiers less or equal than the given one will be read | Yes| + + +### Return type: [messages.AffectedMessages](../types/messages.AffectedMessages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.AffectedMessages = messages.readHistory({peer=InputPeer, max_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/messages.readMentions.md b/old_docs/API_docs_v109/methods/messages.readMentions.md new file mode 100644 index 00000000..4caeb464 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.readMentions.md @@ -0,0 +1,55 @@ +--- +title: messages.readMentions +description: Mark mentions as read +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_readMentions.html +--- +# Method: messages.readMentions +[Back to methods index](index.md) + + +Mark mentions as read + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Dialog | Optional| + + +### Return type: [messages.AffectedHistory](../types/messages.AffectedHistory.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.AffectedHistory = messages.readMentions({peer=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| + + diff --git a/old_docs/API_docs_v109/methods/messages.readMessageContents.md b/old_docs/API_docs_v109/methods/messages.readMessageContents.md new file mode 100644 index 00000000..5a4009b0 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.readMessageContents.md @@ -0,0 +1,45 @@ +--- +title: messages.readMessageContents +description: Notifies the sender about the recipient having listened a voice message or watched a video. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_readMessageContents.html +--- +# Method: messages.readMessageContents +[Back to methods index](index.md) + + +Notifies the sender about the recipient having listened a voice message or watched a video. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| + + +### Return type: [messages.AffectedMessages](../types/messages.AffectedMessages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +messages.AffectedMessages = messages.readMessageContents({id={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.receivedMessages.md b/old_docs/API_docs_v109/methods/messages.receivedMessages.md new file mode 100644 index 00000000..62016b0f --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.receivedMessages.md @@ -0,0 +1,45 @@ +--- +title: messages.receivedMessages +description: Confirms receipt of messages by a client, cancels PUSH-notification sending. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_receivedMessages.html +--- +# Method: messages.receivedMessages +[Back to methods index](index.md) + + +Confirms receipt of messages by a client, cancels PUSH-notification sending. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message ID available in a client. | Yes| + + +### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_ReceivedNotifyMessage = messages.receivedMessages({max_id=int, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.receivedQueue.md b/old_docs/API_docs_v109/methods/messages.receivedQueue.md new file mode 100644 index 00000000..728f43be --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.receivedQueue.md @@ -0,0 +1,52 @@ +--- +title: messages.receivedQueue +description: You cannot use this method directly +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_receivedQueue.html +--- +# Method: messages.receivedQueue +[Back to methods index](index.md) + + +You cannot use this method directly + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_qts|[int](../types/int.md) | You cannot use this method directly | Yes| + + +### Return type: [Vector\_of\_long](../types/long.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->messages->receivedQueue(['max_qts' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_long = messages.receivedQueue({max_qts=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v109/methods/messages.reorderPinnedDialogs.md b/old_docs/API_docs_v109/methods/messages.reorderPinnedDialogs.md new file mode 100644 index 00000000..c480e629 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.reorderPinnedDialogs.md @@ -0,0 +1,54 @@ +--- +title: messages.reorderPinnedDialogs +description: Reorder pinned dialogs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_reorderPinnedDialogs.html +--- +# Method: messages.reorderPinnedDialogs +[Back to methods index](index.md) + + +Reorder pinned dialogs + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | If set, dialogs pinned server-side but not present in the `order` field will be unpinned. | Optional| +|folder\_id|[int](../types/int.md) | Folder ID | Yes| +|order|Array of [Username, chat ID, Update, Message or InputDialogPeer](../types/InputDialogPeer.md) | New order | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, 'folder_id' => int, 'order' => [InputDialogPeer, InputDialogPeer], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.reorderPinnedDialogs({force=Bool, folder_id=int, order={InputDialogPeer}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.reorderStickerSets.md b/old_docs/API_docs_v109/methods/messages.reorderStickerSets.md new file mode 100644 index 00000000..886faf51 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.reorderStickerSets.md @@ -0,0 +1,46 @@ +--- +title: messages.reorderStickerSets +description: Reorder installed stickersets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_reorderStickerSets.html +--- +# Method: messages.reorderStickerSets +[Back to methods index](index.md) + + +Reorder installed stickersets + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder mask stickersets | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.reorderStickerSets({masks=Bool, order={long}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.report.md b/old_docs/API_docs_v109/methods/messages.report.md new file mode 100644 index 00000000..1f1c51f8 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.report.md @@ -0,0 +1,47 @@ +--- +title: messages.report +description: Report a message in a chat for violation of telegram's Terms of Service +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_report.html +--- +# Method: messages.report +[Back to methods index](index.md) + + +Report a message in a chat for violation of telegram's Terms of Service + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | The messages to report | Yes| +|reason|[ReportReason](../types/ReportReason.md) | Why are these messages being reported | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.report({peer=InputPeer, id={int}, reason=ReportReason, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.reportEncryptedSpam.md b/old_docs/API_docs_v109/methods/messages.reportEncryptedSpam.md new file mode 100644 index 00000000..f7573680 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.reportEncryptedSpam.md @@ -0,0 +1,52 @@ +--- +title: messages.reportEncryptedSpam +description: Report a secret chat for spam +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_reportEncryptedSpam.html +--- +# Method: messages.reportEncryptedSpam +[Back to methods index](index.md) + + +Report a secret chat for spam + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat to report | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.reportEncryptedSpam({peer=InputEncryptedChat, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.reportSpam.md b/old_docs/API_docs_v109/methods/messages.reportSpam.md new file mode 100644 index 00000000..f3a508ff --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.reportSpam.md @@ -0,0 +1,52 @@ +--- +title: messages.reportSpam +description: Report a new incoming chat for spam, if the [peer settings](../constructors/peerSettings.md) of the chat allow us to do that +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_reportSpam.html +--- +# Method: messages.reportSpam +[Back to methods index](index.md) + + +Report a new incoming chat for spam, if the [peer settings](../constructors/peerSettings.md) of the chat allow us to do that + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer to report | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.reportSpam({peer=InputPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.requestEncryption.md b/old_docs/API_docs_v109/methods/messages.requestEncryption.md new file mode 100644 index 00000000..bd78eb67 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.requestEncryption.md @@ -0,0 +1,54 @@ +--- +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 +redirect_from: /API_docs/methods/messages_requestEncryption.html +--- +# 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 + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Optional| +|g\_a|[bytes](../types/bytes.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats | Yes| + + +### Return type: [EncryptedChat](../types/EncryptedChat.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$EncryptedChat = $MadelineProto->messages->requestEncryption(['user_id' => InputUser, 'g_a' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +EncryptedChat = messages.requestEncryption({user_id=InputUser, g_a='bytes', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|DH_G_A_INVALID|g_a invalid| +|400|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.requestUrlAuth.md b/old_docs/API_docs_v109/methods/messages.requestUrlAuth.md new file mode 100644 index 00000000..5760ece5 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.requestUrlAuth.md @@ -0,0 +1,47 @@ +--- +title: messages.requestUrlAuth +description: Get more info about a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_requestUrlAuth.html +--- +# Method: messages.requestUrlAuth +[Back to methods index](index.md) + + +Get more info about a Seamless Telegram Login authorization request, for more info [click here »](https://core.telegram.org/api/url-authorization) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where the message is located | Optional| +|msg\_id|[int](../types/int.md) | The message | Yes| +|button\_id|[int](../types/int.md) | The ID of the button with the authorization request | Yes| + + +### Return type: [UrlAuthResult](../types/UrlAuthResult.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$UrlAuthResult = $MadelineProto->messages->requestUrlAuth(['peer' => InputPeer, 'msg_id' => int, 'button_id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +UrlAuthResult = messages.requestUrlAuth({peer=InputPeer, msg_id=int, button_id=int, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.saveDraft.md b/old_docs/API_docs_v109/methods/messages.saveDraft.md new file mode 100644 index 00000000..e17a6fbd --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.saveDraft.md @@ -0,0 +1,99 @@ +--- +title: messages.saveDraft +description: Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_saveDraft.html +--- +# Method: messages.saveDraft +[Back to methods index](index.md) + + +Save a message [draft](https://core.telegram.org/api/drafts) associated to a chat. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable generation of the webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Message ID the message should reply to | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Destination of the message that should be sent | Optional| +|message|[string](../types/string.md) | The draft | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.saveDraft({no_webpage=Bool, reply_to_msg_id=int, peer=InputPeer, message='string', entities={MessageEntity}, parseMode='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 parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough +strikethrough +strikethrough +inline fixed-width code +
pre-formatted fixed-width code block
+
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: + +```markdown +[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 + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.saveGif.md b/old_docs/API_docs_v109/methods/messages.saveGif.md new file mode 100644 index 00000000..9b8690db --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.saveGif.md @@ -0,0 +1,53 @@ +--- +title: messages.saveGif +description: Add GIF to saved gifs list +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_saveGif.html +--- +# Method: messages.saveGif +[Back to methods index](index.md) + + +Add GIF to saved gifs list + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Whether to remove GIF from saved gifs list | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.saveGif({id=InputDocument, unsave=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|GIF_ID_INVALID|The provided GIF ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.saveRecentSticker.md b/old_docs/API_docs_v109/methods/messages.saveRecentSticker.md new file mode 100644 index 00000000..221e26e5 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.saveRecentSticker.md @@ -0,0 +1,54 @@ +--- +title: messages.saveRecentSticker +description: Add/remove sticker from recent stickers list +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_saveRecentSticker.html +--- +# Method: messages.saveRecentSticker +[Back to methods index](index.md) + + +Add/remove sticker from recent stickers list + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Whether to add/remove stickers recently attached to photo or video files | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Whether to save or unsave the sticker | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.saveRecentSticker({attached=Bool, id=InputDocument, unsave=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|STICKER_ID_INVALID|The provided sticker ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.search.md b/old_docs/API_docs_v109/methods/messages.search.md new file mode 100644 index 00000000..39269dd5 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.search.md @@ -0,0 +1,71 @@ +--- +title: messages.search +description: Gets back found messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_search.html +--- +# Method: messages.search +[Back to methods index](index.md) + + +Gets back found messages + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | User or chat, histories with which are searched, or [(inputPeerEmpty)](../constructors/inputPeerEmpty.md) constructor for global search | Optional| +|q|[string](../types/string.md) | Text search request | Yes| +|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Only return messages sent by the specified user ID | Optional| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Filter to return only specified message types | Optional| +|min\_date|[int](../types/int.md) | If a positive value was transferred, only messages with a sending date bigger than the transferred one will be returned | Yes| +|max\_date|[int](../types/int.md) | If a positive value was transferred, only messages with a sending date smaller than the transferred one will be returned | Yes| +|offset\_id|[int](../types/int.md) | Only return messages starting from the specified message ID | Yes| +|add\_offset|[int](../types/int.md) | [Additional offset](https://core.telegram.org/api/offsets) | Yes| +|limit|[int](../types/int.md) | [Number of results to return](https://core.telegram.org/api/offsets) | Yes| +|max\_id|[int](../types/int.md) | [Maximum message ID to return](https://core.telegram.org/api/offsets) | Yes| +|min\_id|[int](../types/int.md) | [Minimum message ID to return](https://core.telegram.org/api/offsets) | Yes| +|hash|Array of [int](../types/int.md) | The IDs of messages you already fetched | Optional| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```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 + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported| +|400|SEARCH_QUERY_EMPTY|The search query is empty| +|400|USER_ID_INVALID|The provided user ID is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| + + diff --git a/old_docs/API_docs_v109/methods/messages.searchGifs.md b/old_docs/API_docs_v109/methods/messages.searchGifs.md new file mode 100644 index 00000000..28798dfe --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.searchGifs.md @@ -0,0 +1,53 @@ +--- +title: messages.searchGifs +description: Search for GIFs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_searchGifs.html +--- +# Method: messages.searchGifs +[Back to methods index](index.md) + + +Search for GIFs + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | Text query | Yes| +|offset|[int](../types/int.md) | Offset for [pagination »](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [messages.FoundGifs](../types/messages.FoundGifs.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.FoundGifs = messages.searchGifs({q='string', offset=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v109/methods/messages.searchGlobal.md b/old_docs/API_docs_v109/methods/messages.searchGlobal.md new file mode 100644 index 00000000..cc3c0977 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.searchGlobal.md @@ -0,0 +1,57 @@ +--- +title: messages.searchGlobal +description: Search for messages and peers globally +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_searchGlobal.html +--- +# Method: messages.searchGlobal +[Back to methods index](index.md) + + +Search for messages and peers globally + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|folder\_id|[int](../types/int.md) | Folder where to search | Optional| +|q|[string](../types/string.md) | Query | Yes| +|offset\_rate|[int](../types/int.md) | Initially 0, then set to the [`next_rate` parameter of messages.messagesSlice](../constructors/messages.messagesSlice.md) | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Optional| +|offset\_id|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| +|limit|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes| + + +### Return type: [messages.Messages](../types/messages.Messages.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['folder_id' => int, 'q' => 'string', 'offset_rate' => int, 'offset_peer' => InputPeer, 'offset_id' => int, 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +messages.Messages = messages.searchGlobal({folder_id=int, q='string', offset_rate=int, offset_peer=InputPeer, offset_id=int, limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|SEARCH_QUERY_EMPTY|The search query is empty| + + diff --git a/old_docs/API_docs_v109/methods/messages.searchStickerSets.md b/old_docs/API_docs_v109/methods/messages.searchStickerSets.md new file mode 100644 index 00000000..ce54cc8e --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.searchStickerSets.md @@ -0,0 +1,47 @@ +--- +title: messages.searchStickerSets +description: Search for stickersets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_searchStickerSets.html +--- +# Method: messages.searchStickerSets +[Back to methods index](index.md) + + +Search for stickersets + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_featured|[Bool](../types/Bool.md) | Exclude featured stickersets from results | Optional| +|q|[string](../types/string.md) | Query string | Yes| +|hash|Array of [int](../types/int.md) | The IDs of stickersets you already fetched | Optional| + + +### Return type: [messages.FoundStickerSets](../types/messages.FoundStickerSets.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, int], ]); +``` + +Or, if you're into Lua: + +```lua +messages.FoundStickerSets = messages.searchStickerSets({exclude_featured=Bool, q='string', hash={int}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.sendEncrypted.md b/old_docs/API_docs_v109/methods/messages.sendEncrypted.md new file mode 100644 index 00000000..2db0059e --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.sendEncrypted.md @@ -0,0 +1,56 @@ +--- +title: messages.sendEncrypted +description: Sends a text message to a secret chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendEncrypted.html +--- +# Method: messages.sendEncrypted +[Back to methods index](index.md) + + +Sends a text message to a secret chat. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Secret chat ID | Yes| +|data|[bytes](../types/bytes.md) | TL-serialization of [DecryptedMessage](../types/DecryptedMessage.md) type, encrypted with a key that was created during chat initialization | Yes| + + +### Return type: [messages.SentEncryptedMessage](../types/messages.SentEncryptedMessage.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, 'data' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +messages.SentEncryptedMessage = messages.sendEncrypted({peer=InputEncryptedChat, data='bytes', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|DATA_INVALID|Encrypted data invalid| +|400|ENCRYPTION_DECLINED|The secret chat was declined| +|400|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v109/methods/messages.sendEncryptedFile.md b/old_docs/API_docs_v109/methods/messages.sendEncryptedFile.md new file mode 100644 index 00000000..b0324e42 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.sendEncryptedFile.md @@ -0,0 +1,56 @@ +--- +title: messages.sendEncryptedFile +description: Sends a message with a file attachment to a secret chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendEncryptedFile.html +--- +# Method: messages.sendEncryptedFile +[Back to methods index](index.md) + + +Sends a message with a file attachment to a secret chat + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Secret chat ID | Yes| +|data|[bytes](../types/bytes.md) | TL-serialization of [DecryptedMessage](../types/DecryptedMessage.md) type, encrypted with a key generated during chat initialization | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | File attachment for the secret chat | Optional| + + +### Return type: [messages.SentEncryptedMessage](../types/messages.SentEncryptedMessage.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, 'data' => 'bytes', 'file' => InputEncryptedFile, ]); +``` + +Or, if you're into Lua: + +```lua +messages.SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedChat, data='bytes', file=InputEncryptedFile, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|DATA_TOO_LONG|Data too long| +|400|MD5_CHECKSUM_INVALID|The MD5 checksums do not match| +|400|MSG_WAIT_FAILED|A waiting call returned an error| + + diff --git a/old_docs/API_docs_v109/methods/messages.sendEncryptedService.md b/old_docs/API_docs_v109/methods/messages.sendEncryptedService.md new file mode 100644 index 00000000..e775822a --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.sendEncryptedService.md @@ -0,0 +1,57 @@ +--- +title: messages.sendEncryptedService +description: Sends a service message to a secret chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendEncryptedService.html +--- +# Method: messages.sendEncryptedService +[Back to methods index](index.md) + + +Sends a service message to a secret chat. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Secret chat ID | Yes| +|data|[bytes](../types/bytes.md) | TL-serialization of [DecryptedMessage](../types/DecryptedMessage.md) type, encrypted with a key generated during chat initialization | Yes| + + +### Return type: [messages.SentEncryptedMessage](../types/messages.SentEncryptedMessage.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, 'data' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +messages.SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncryptedChat, data='bytes', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|DATA_INVALID|Encrypted data invalid| +|400|ENCRYPTION_DECLINED|The secret chat was declined| +|400|ENCRYPTION_ID_INVALID|The provided secret chat ID is invalid| +|400|MSG_WAIT_FAILED|A waiting call returned an error| +|403|USER_IS_BLOCKED|You were blocked by this user| + + diff --git a/old_docs/API_docs_v109/methods/messages.sendInlineBotResult.md b/old_docs/API_docs_v109/methods/messages.sendInlineBotResult.md new file mode 100644 index 00000000..f05204b7 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.sendInlineBotResult.md @@ -0,0 +1,77 @@ +--- +title: messages.sendInlineBotResult +description: Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendInlineBotResult.html +--- +# Method: messages.sendInlineBotResult +[Back to methods index](index.md) + + +Send a result obtained using [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Whether to send the message silently (no notification will be triggered on the other client) | Optional| +|background|[Bool](../types/Bool.md) | Whether to send the message in background | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Whether to clear the [draft](https://core.telegram.org/api/drafts) | Optional| +|hide\_via|[Bool](../types/Bool.md) | Whether to hide the `via @botname` in the resulting message (only for bot usernames encountered in the [config](../constructors/config.md)) | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Destination | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | ID of the message this message should reply to | Optional| +|query\_id|[long](../types/long.md) | Query ID from [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md) | Yes| +|id|[string](../types/string.md) | Result ID from [messages.getInlineBotResults](../methods/messages.getInlineBotResults.md) | Yes| +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, 'hide_via' => Bool, 'peer' => InputPeer, 'reply_to_msg_id' => int, 'query_id' => long, 'id' => 'string', 'schedule_date' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.sendInlineBotResult({silent=Bool, background=Bool, clear_draft=Bool, hide_via=Bool, peer=InputPeer, reply_to_msg_id=int, query_id=long, id='string', schedule_date=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_RESTRICTED|You can't send messages in this chat, you were restricted| +|400|INLINE_RESULT_EXPIRED|The inline query expired| +|400|MEDIA_EMPTY|The provided media object is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|QUERY_ID_EMPTY|The query ID is empty| +|400|RESULT_ID_EMPTY|Result ID empty| +|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|400|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|400|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|400|YOU_BLOCKED_USER|You blocked this user| +|403|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|403|CHAT_SEND_INLINE_FORBIDDEN|You can't send inline messages in this group| +|403|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: you must wait for the specified number of seconds before sending another message to the chat.| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/messages.sendMedia.md b/old_docs/API_docs_v109/methods/messages.sendMedia.md new file mode 100644 index 00000000..c05a2257 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.sendMedia.md @@ -0,0 +1,149 @@ +--- +title: messages.sendMedia +description: Send a media +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendMedia.html +--- +# Method: messages.sendMedia +[Back to methods index](index.md) + + +Send a media + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Send message silently (no notification should be triggered) | Optional| +|background|[Bool](../types/Bool.md) | Send message in background | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the draft | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Destination | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Message ID to which this message should reply to | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Attached media | Optional| +|message|[string](../types/string.md) | Caption | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Reply markup for bot keyboards | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities for styled text | Optional| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', 'schedule_date' => int, ]); +``` + +Or, if you're into Lua: + +```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}, parseMode='string', schedule_date=int, }) +``` + + +## 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 parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough +strikethrough +strikethrough +inline fixed-width code +
pre-formatted fixed-width code block
+
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: + +```markdown +[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 + +| Code | Type | Description | +|------|----------|---------------| +|400|BUTTON_DATA_INVALID|The data of one or more of the buttons you provided is invalid| +|400|BUTTON_TYPE_INVALID|The type of one or more of the buttons you provided is invalid| +|400|BUTTON_URL_INVALID|Button URL invalid| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_RESTRICTED|You can't send messages in this chat, you were restricted| +|400|EXTERNAL_URL_INVALID|External URL invalid| +|400|FILE_PART_LENGTH_INVALID|The length of a file part is invalid| +|400|FILE_PARTS_INVALID|The number of file parts is invalid| +|400|IMAGE_PROCESS_FAILED|Failure while processing image| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|MD5_CHECKSUM_INVALID|The MD5 checksums do not match| +|400|MEDIA_CAPTION_TOO_LONG|The caption is too long| +|400|MEDIA_EMPTY|The provided media object is invalid| +|400|MEDIA_INVALID|Media invalid| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|400|PHOTO_INVALID_DIMENSIONS|The photo dimensions are invalid| +|400|PHOTO_SAVE_FILE_INVALID|Internal issues, try again later| +|400|POLL_ANSWERS_INVALID|Invalid poll answers were provided| +|400|POLL_OPTION_DUPLICATE|Duplicate poll options provided| +|400|QUIZ_CORRECT_ANSWERS_EMPTY|No correct quiz answer was specified| +|400|REPLY_MARKUP_BUY_EMPTY|Reply markup for buy button empty| +|400|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|400|TTL_MEDIA_INVALID|Invalid media Time To Live was provided| +|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|400|USER_IS_BLOCKED|You were blocked by this user| +|400|USER_IS_BOT|Bots can't send messages to other bots| +|400|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|400|WEBPAGE_MEDIA_EMPTY|Webpage media empty| +|400|YOU_BLOCKED_USER|You blocked this user| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|403|CHAT_SEND_GIFS_FORBIDDEN|You can't send gifs in this chat| +|403|CHAT_SEND_MEDIA_FORBIDDEN|You can't send media in this chat| +|403|CHAT_SEND_STICKERS_FORBIDDEN|You can't send stickers in this chat.| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: you must wait for the specified number of seconds before sending another message to the chat.| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/messages.sendMessage.md b/old_docs/API_docs_v109/methods/messages.sendMessage.md new file mode 100644 index 00000000..6275a4b4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.sendMessage.md @@ -0,0 +1,140 @@ +--- +title: messages.sendMessage +description: Sends a message to a chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendMessage.html +--- +# Method: messages.sendMessage +[Back to methods index](index.md) + + +Sends a message to a chat + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Set this flag to disable generation of the webpage preview | Optional| +|silent|[Bool](../types/Bool.md) | Send this message silently (no notifications for the receivers) | Optional| +|background|[Bool](../types/Bool.md) | Send this message as background message | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the draft field | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The destination where the message will be sent | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | The message ID to which this message will reply to | Optional| +|message|[string](../types/string.md) | The message | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Reply markup for sending bot buttons | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| +|parse\_mode| [string](../types/string.md) | Whether to parse HTML or Markdown markup in the message| Optional | +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', 'schedule_date' => int, ]); +``` + +Or, if you're into Lua: + +```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}, parseMode='string', schedule_date=int, }) +``` + + +## 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 parseMode: + +Set parseMode to html to enable HTML parsing of the message. + +Set parseMode to Markdown to enable markown AND html parsing of the message. + +The following tags are currently supported: + +```html +
a newline +bold works ok, internal tags are stripped +bold +italic +italic +underline +strikethrough +strikethrough +strikethrough +inline fixed-width code +
pre-formatted fixed-width code block
+
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: + +```markdown +[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 + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_DOMAIN_INVALID|Bot domain invalid| +|400|BOT_INVALID|This is not a valid bot| +|400|BUTTON_DATA_INVALID|The data of one or more of the buttons you provided is invalid| +|400|BUTTON_TYPE_INVALID|The type of one or more of the buttons you provided is invalid| +|400|BUTTON_URL_INVALID|Button URL invalid| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|CHAT_RESTRICTED|You can't send messages in this chat, you were restricted| +|400|ENCRYPTION_DECLINED|The secret chat was declined| +|400|ENTITY_MENTION_USER_INVALID|You mentioned an invalid user| +|400|FROM_MESSAGE_BOT_DISABLED|Bots can't use fromMessage min constructors| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|MESSAGE_EMPTY|The provided message is empty| +|400|MESSAGE_TOO_LONG|The provided message is too long| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|PINNED_DIALOGS_TOO_MUCH|Too many pinned dialogs| +|400|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|400|SCHEDULE_BOT_NOT_ALLOWED|Bots cannot schedule messages| +|400|SCHEDULE_TOO_MUCH|There are too many scheduled messages| +|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|400|USER_IS_BLOCKED|You were blocked by this user| +|400|USER_IS_BOT|Bots can't send messages to other bots| +|400|YOU_BLOCKED_USER|You blocked this user| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| +|420|SLOWMODE_WAIT_X|Slowmode is enabled in this chat: you must wait for the specified number of seconds before sending another message to the chat.| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/messages.sendMultiMedia.md b/old_docs/API_docs_v109/methods/messages.sendMultiMedia.md new file mode 100644 index 00000000..46a8dac4 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.sendMultiMedia.md @@ -0,0 +1,62 @@ +--- +title: messages.sendMultiMedia +description: Send an album of media +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendMultiMedia.html +--- +# Method: messages.sendMultiMedia +[Back to methods index](index.md) + + +Send an album of media + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Whether to send the album silently (no notification triggered) | Optional| +|background|[Bool](../types/Bool.md) | Send in background? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Whether to clear [drafts](https://core.telegram.org/api/drafts) | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The destination chat | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | The message to reply to | Optional| +|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | The album | Yes| +|schedule\_date|[int](../types/int.md) | Scheduled message date for scheduled messages | Optional| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], 'schedule_date' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.sendMultiMedia({silent=Bool, background=Bool, clear_draft=Bool, peer=InputPeer, reply_to_msg_id=int, multi_media={InputSingleMedia}, schedule_date=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MEDIA_EMPTY|The provided media object is invalid| +|400|MEDIA_INVALID|Media invalid| +|400|MULTI_MEDIA_TOO_LONG|Too many media files for album| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|RANDOM_ID_EMPTY|Random ID empty| + + diff --git a/old_docs/API_docs_v109/methods/messages.sendScheduledMessages.md b/old_docs/API_docs_v109/methods/messages.sendScheduledMessages.md new file mode 100644 index 00000000..a761c083 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.sendScheduledMessages.md @@ -0,0 +1,53 @@ +--- +title: messages.sendScheduledMessages +description: Send scheduled messages right away +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendScheduledMessages.html +--- +# Method: messages.sendScheduledMessages +[Back to methods index](index.md) + + +Send scheduled messages right away + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | ID | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->sendScheduledMessages(['peer' => InputPeer, 'id' => [int, int], ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.sendScheduledMessages({peer=InputPeer, id={int}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.sendScreenshotNotification.md b/old_docs/API_docs_v109/methods/messages.sendScreenshotNotification.md new file mode 100644 index 00000000..37e75e72 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.sendScreenshotNotification.md @@ -0,0 +1,53 @@ +--- +title: messages.sendScreenshotNotification +description: Notify the other user in a private chat that a screenshot of the chat was taken +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendScreenshotNotification.html +--- +# Method: messages.sendScreenshotNotification +[Back to methods index](index.md) + + +Notify the other user in a private chat that a screenshot of the chat was taken + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Other user | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | ID of message that was screenshotted, can be 0 | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.sendScreenshotNotification({peer=InputPeer, reply_to_msg_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.sendVote.md b/old_docs/API_docs_v109/methods/messages.sendVote.md new file mode 100644 index 00000000..911b1137 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.sendVote.md @@ -0,0 +1,56 @@ +--- +title: messages.sendVote +description: Vote in a [poll](../constructors/poll.md) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_sendVote.html +--- +# Method: messages.sendVote +[Back to methods index](index.md) + + +Vote in a [poll](../constructors/poll.md) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the poll was sent | Optional| +|msg\_id|[int](../types/int.md) | The message ID of the poll | Yes| +|options|Array of [bytes](../types/bytes.md) | Options | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->sendVote(['peer' => InputPeer, 'msg_id' => int, 'options' => ['bytes', 'bytes'], ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.sendVote({peer=InputPeer, msg_id=int, options={'bytes'}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|MESSAGE_POLL_CLOSED|Poll closed| +|400|OPTION_INVALID|Invalid option selected| + + diff --git a/old_docs/API_docs_v109/methods/messages.setBotCallbackAnswer.md b/old_docs/API_docs_v109/methods/messages.setBotCallbackAnswer.md new file mode 100644 index 00000000..b18b13af --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.setBotCallbackAnswer.md @@ -0,0 +1,63 @@ +--- +title: messages.setBotCallbackAnswer +description: Set the callback answer to a user button press (bots only) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setBotCallbackAnswer.html +--- +# Method: messages.setBotCallbackAnswer +[Back to methods index](index.md) + + +Set the callback answer to a user button press (bots only) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Whether to show the message as a popup instead of a toast notification | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|message|[string](../types/string.md) | Popup to show | Optional| +|url|[string](../types/string.md) | URL to open | Optional| +|cache\_time|[int](../types/int.md) | Cache validity | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```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 + +| Code | Type | Description | +|------|----------|---------------| +|400|QUERY_ID_INVALID|The query ID is invalid| +|400|URL_INVALID|Invalid URL provided| + + diff --git a/old_docs/API_docs_v109/methods/messages.setBotPrecheckoutResults.md b/old_docs/API_docs_v109/methods/messages.setBotPrecheckoutResults.md new file mode 100644 index 00000000..2614491a --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.setBotPrecheckoutResults.md @@ -0,0 +1,58 @@ +--- +title: messages.setBotPrecheckoutResults +description: Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. +Use this method to respond to such pre-checkout queries. +**Note**: Telegram must receive an answer within 10 seconds after the pre-checkout query was sent. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setBotPrecheckoutResults.html +--- +# Method: messages.setBotPrecheckoutResults +[Back to methods index](index.md) + + +Once the user has confirmed their payment and shipping details, the bot receives an [updateBotPrecheckoutQuery](../constructors/updateBotPrecheckoutQuery.md) update. +Use this method to respond to such pre-checkout queries. +**Note**: Telegram must receive an answer within 10 seconds after the pre-checkout query was sent. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Set this flag if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order, otherwise do not set it, and set the `error` field, instead | Optional| +|query\_id|[long](../types/long.md) | Unique identifier for the query to be answered | Yes| +|error|[string](../types/string.md) | Required if the `success` isn't set. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.setBotPrecheckoutResults({success=Bool, query_id=long, error='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|ERROR_TEXT_EMPTY|The provided error message is empty| + + diff --git a/old_docs/API_docs_v109/methods/messages.setBotShippingResults.md b/old_docs/API_docs_v109/methods/messages.setBotShippingResults.md new file mode 100644 index 00000000..1f18fa31 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.setBotShippingResults.md @@ -0,0 +1,54 @@ +--- +title: messages.setBotShippingResults +description: If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setBotShippingResults.html +--- +# Method: messages.setBotShippingResults +[Back to methods index](index.md) + + +If you sent an invoice requesting a shipping address and the parameter is\_flexible was specified, the bot will receive an [updateBotShippingQuery](../constructors/updateBotShippingQuery.md) update. Use this method to reply to shipping queries. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Unique identifier for the query to be answered | Yes| +|error|[string](../types/string.md) | Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.setBotShippingResults({query_id=long, error='string', shipping_options={ShippingOption}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|QUERY_ID_INVALID|The query ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.setEncryptedTyping.md b/old_docs/API_docs_v109/methods/messages.setEncryptedTyping.md new file mode 100644 index 00000000..5478ed8e --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.setEncryptedTyping.md @@ -0,0 +1,53 @@ +--- +title: messages.setEncryptedTyping +description: Send typing event by the current user to a secret chat. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setEncryptedTyping.html +--- +# Method: messages.setEncryptedTyping +[Back to methods index](index.md) + + +Send typing event by the current user to a secret chat. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Secret chat ID | Yes| +|typing|[Bool](../types/Bool.md) | Typing.
**Possible values**:
[(boolTrue)](../constructors/boolTrue.md), if the user started typing and more than **5 seconds** have passed since the last request
[(boolFalse)](../constructors/boolFalse.md), if the user stopped typing | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.setEncryptedTyping({peer=InputEncryptedChat, typing=Bool, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ID_INVALID|The provided chat id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.setGameScore.md b/old_docs/API_docs_v109/methods/messages.setGameScore.md new file mode 100644 index 00000000..7feda145 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.setGameScore.md @@ -0,0 +1,59 @@ +--- +title: messages.setGameScore +description: Use this method to set the score of the specified user in a game sent as a normal message (bots only). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setGameScore.html +--- +# Method: messages.setGameScore +[Back to methods index](index.md) + + +Use this method to set the score of the specified user in a game sent as a normal message (bots only). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Set this flag if the game message should be automatically edited to include the current scoreboard | Optional| +|force|[Bool](../types/Bool.md) | Set this flag if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Unique identifier of target chat | Optional| +|id|[int](../types/int.md) | Identifier of the sent message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User identifier | Optional| +|score|[int](../types/int.md) | New score | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.setGameScore({edit_message=Bool, force=Bool, peer=InputPeer, id=int, user_id=InputUser, score=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v109/methods/messages.setInlineBotResults.md b/old_docs/API_docs_v109/methods/messages.setInlineBotResults.md new file mode 100644 index 00000000..5f01e56a --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.setInlineBotResults.md @@ -0,0 +1,74 @@ +--- +title: messages.setInlineBotResults +description: Answer an inline query, for bots only +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setInlineBotResults.html +--- +# Method: messages.setInlineBotResults +[Back to methods index](index.md) + + +Answer an inline query, for bots only + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Set this flag if the results are composed of media files | Optional| +|private|[Bool](../types/Bool.md) | Set this flag if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query | Optional| +|query\_id|[long](../types/long.md) | Unique identifier for the answered query | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. | Yes| +|next\_offset|[string](../types/string.md) | Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes. | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with a certain parameter. | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.setInlineBotResults({gallery=Bool, private=Bool, query_id=long, results={InputBotInlineResult}, cache_time=int, next_offset='string', switch_pm=InlineBotSwitchPM, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|ARTICLE_TITLE_EMPTY|The title of the article is empty| +|400|BUTTON_DATA_INVALID|The data of one or more of the buttons you provided is invalid| +|400|BUTTON_TYPE_INVALID|The type of one or more of the buttons you provided is invalid| +|400|BUTTON_URL_INVALID|Button URL invalid| +|400|GIF_CONTENT_TYPE_INVALID|GIF content-type invalid| +|400|MESSAGE_EMPTY|The provided message is empty| +|400|MESSAGE_TOO_LONG|The provided message is too long| +|400|PHOTO_INVALID|Photo invalid| +|400|PHOTO_THUMB_URL_EMPTY|Photo thumbnail URL is empty| +|400|QUERY_ID_INVALID|The query ID is invalid| +|400|REPLY_MARKUP_INVALID|The provided reply markup is invalid| +|400|RESULT_TYPE_INVALID|Result type invalid| +|400|RESULTS_TOO_MUCH|Too many results were provided| +|400|SEND_MESSAGE_TYPE_INVALID|The message type is invalid| +|400|START_PARAM_INVALID|Start parameter invalid| +|400|WEBDOCUMENT_SIZE_TOO_BIG|Webdocument is too big!| +|403|USER_BOT_INVALID|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v109/methods/messages.setInlineGameScore.md b/old_docs/API_docs_v109/methods/messages.setInlineGameScore.md new file mode 100644 index 00000000..24559a52 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.setInlineGameScore.md @@ -0,0 +1,57 @@ +--- +title: messages.setInlineGameScore +description: Use this method to set the score of the specified user in a game sent as an inline message (bots only). +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setInlineGameScore.html +--- +# Method: messages.setInlineGameScore +[Back to methods index](index.md) + + +Use this method to set the score of the specified user in a game sent as an inline message (bots only). + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Set this flag if the game message should be automatically edited to include the current scoreboard | Optional| +|force|[Bool](../types/Bool.md) | Set this flag if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User identifier | Optional| +|score|[int](../types/int.md) | New score | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.setInlineGameScore({edit_message=Bool, force=Bool, id=InputBotInlineMessageID, user_id=InputUser, score=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|400|USER_BOT_REQUIRED|This method can only be called by a bot| + + diff --git a/old_docs/API_docs_v109/methods/messages.setTyping.md b/old_docs/API_docs_v109/methods/messages.setTyping.md new file mode 100644 index 00000000..d49a87d5 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.setTyping.md @@ -0,0 +1,64 @@ +--- +title: messages.setTyping +description: Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_setTyping.html +--- +# Method: messages.setTyping +[Back to methods index](index.md) + + +Sends a current user typing event (see [SendMessageAction](../types/SendMessageAction.md) for all event types) to a conversation partner or group. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Target user or group | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Type of action
Parameter added in [Layer 17](https://core.telegram.org/api/layers#layer-17). | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.setTyping({peer=InputPeer, action=SendMessageAction, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_ID_INVALID|The provided chat id is invalid| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels| +|400|USER_IS_BLOCKED|You were blocked by this user| +|400|USER_IS_BOT|Bots can't send messages to other bots| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/messages.startBot.md b/old_docs/API_docs_v109/methods/messages.startBot.md new file mode 100644 index 00000000..9e584cd7 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.startBot.md @@ -0,0 +1,60 @@ +--- +title: messages.startBot +description: Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_startBot.html +--- +# Method: messages.startBot +[Back to methods index](index.md) + + +Start a conversation with a bot using a [deep linking parameter](https://core.telegram.org/bots#deep-linking) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to start the bot, can be the bot's private chat or a group | Optional| +|start\_param|[string](../types/string.md) | [Deep linking parameter](https://core.telegram.org/bots#deep-linking) | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.startBot({bot=InputUser, peer=InputPeer, start_param='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_INVALID|This is not a valid bot| +|400|INPUT_USER_DEACTIVATED|The specified user was deleted| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|START_PARAM_EMPTY|The start parameter is empty| +|400|START_PARAM_INVALID|Start parameter invalid| +|400|START_PARAM_TOO_LONG|Start parameter is too long| + + diff --git a/old_docs/API_docs_v109/methods/messages.toggleDialogPin.md b/old_docs/API_docs_v109/methods/messages.toggleDialogPin.md new file mode 100644 index 00000000..78ec1695 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.toggleDialogPin.md @@ -0,0 +1,53 @@ +--- +title: messages.toggleDialogPin +description: Pin/unpin a dialog +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_toggleDialogPin.html +--- +# Method: messages.toggleDialogPin +[Back to methods index](index.md) + + +Pin/unpin a dialog + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Whether to pin or unpin the dialog | Optional| +|peer|[Username, chat ID, Update, Message or InputDialogPeer](../types/InputDialogPeer.md) | The dialog to pin | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.toggleDialogPin({pinned=Bool, peer=InputDialogPeer, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|PEER_ID_INVALID|The provided peer id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.uninstallStickerSet.md b/old_docs/API_docs_v109/methods/messages.uninstallStickerSet.md new file mode 100644 index 00000000..6eeb9ecb --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.uninstallStickerSet.md @@ -0,0 +1,52 @@ +--- +title: messages.uninstallStickerSet +description: Uninstall a stickerset +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_uninstallStickerSet.html +--- +# Method: messages.uninstallStickerSet +[Back to methods index](index.md) + + +Uninstall a stickerset + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to uninstall | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = messages.uninstallStickerSet({stickerset=InputStickerSet, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v109/methods/messages.updatePinnedMessage.md b/old_docs/API_docs_v109/methods/messages.updatePinnedMessage.md new file mode 100644 index 00000000..31df88a2 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.updatePinnedMessage.md @@ -0,0 +1,57 @@ +--- +title: messages.updatePinnedMessage +description: Pin a message +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_updatePinnedMessage.html +--- +# Method: messages.updatePinnedMessage +[Back to methods index](index.md) + + +Pin a message + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Pin the message silently, without triggering a notification | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer where to pin the message | Optional| +|id|[int](../types/int.md) | The message to pin, can be 0 to unpin any currently pinned messages | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->updatePinnedMessage(['silent' => Bool, 'peer' => InputPeer, 'id' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = messages.updatePinnedMessage({silent=Bool, peer=InputPeer, id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this| +|400|CHAT_NOT_MODIFIED|The pinned message wasn't modified| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/messages.uploadEncryptedFile.md b/old_docs/API_docs_v109/methods/messages.uploadEncryptedFile.md new file mode 100644 index 00000000..ee56ce91 --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.uploadEncryptedFile.md @@ -0,0 +1,46 @@ +--- +title: messages.uploadEncryptedFile +description: Upload encrypted file and associate it to a secret chat +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_uploadEncryptedFile.html +--- +# Method: messages.uploadEncryptedFile +[Back to methods index](index.md) + + +Upload encrypted file and associate it to a secret chat + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat to associate the file to | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file | Optional| + + +### Return type: [EncryptedFile](../types/EncryptedFile.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +EncryptedFile = messages.uploadEncryptedFile({peer=InputEncryptedChat, file=InputEncryptedFile, }) +``` + diff --git a/old_docs/API_docs_v109/methods/messages.uploadMedia.md b/old_docs/API_docs_v109/methods/messages.uploadMedia.md new file mode 100644 index 00000000..ed2e774a --- /dev/null +++ b/old_docs/API_docs_v109/methods/messages.uploadMedia.md @@ -0,0 +1,60 @@ +--- +title: messages.uploadMedia +description: Upload a file and associate it to a chat (without actually sending it to the chat) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/messages_uploadMedia.html +--- +# Method: messages.uploadMedia +[Back to methods index](index.md) + + +Upload a file and associate it to a chat (without actually sending it to the chat) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat, can be an [inputPeerEmpty](../constructors/inputPeerEmpty.md) for bots | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | File uploaded in chunks as described in [files »](https://core.telegram.org/api/files) | Optional| + + +### Return type: [MessageMedia](../types/MessageMedia.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +MessageMedia = messages.uploadMedia({peer=InputPeer, media=InputMedia, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_MISSING|This method can only be run by a bot| +|400|FILE_PARTS_INVALID|The number of file parts is invalid| +|400|IMAGE_PROCESS_FAILED|Failure while processing image| +|400|MEDIA_INVALID|Media invalid| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|PHOTO_EXT_INVALID|The extension of the photo is invalid| +|400|WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| +|403|CHAT_WRITE_FORBIDDEN|You can't write in this chat| + + diff --git a/old_docs/API_docs_v109/methods/payments.clearSavedInfo.md b/old_docs/API_docs_v109/methods/payments.clearSavedInfo.md new file mode 100644 index 00000000..d76d5ef5 --- /dev/null +++ b/old_docs/API_docs_v109/methods/payments.clearSavedInfo.md @@ -0,0 +1,46 @@ +--- +title: payments.clearSavedInfo +description: Clear saved payment information +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_clearSavedInfo.html +--- +# Method: payments.clearSavedInfo +[Back to methods index](index.md) + + +Clear saved payment information + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Remove saved payment credentials | Optional| +|info|[Bool](../types/Bool.md) | Clear the last order settings saved by the user | Optional| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = payments.clearSavedInfo({credentials=Bool, info=Bool, }) +``` + diff --git a/old_docs/API_docs_v109/methods/payments.getPaymentForm.md b/old_docs/API_docs_v109/methods/payments.getPaymentForm.md new file mode 100644 index 00000000..2102fd18 --- /dev/null +++ b/old_docs/API_docs_v109/methods/payments.getPaymentForm.md @@ -0,0 +1,52 @@ +--- +title: payments.getPaymentForm +description: Get a payment form +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_getPaymentForm.html +--- +# Method: payments.getPaymentForm +[Back to methods index](index.md) + + +Get a payment form + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID of payment form | Yes| + + +### Return type: [payments.PaymentForm](../types/payments.PaymentForm.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +payments.PaymentForm = payments.getPaymentForm({msg_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/payments.getPaymentReceipt.md b/old_docs/API_docs_v109/methods/payments.getPaymentReceipt.md new file mode 100644 index 00000000..b2a26984 --- /dev/null +++ b/old_docs/API_docs_v109/methods/payments.getPaymentReceipt.md @@ -0,0 +1,52 @@ +--- +title: payments.getPaymentReceipt +description: Get payment receipt +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_getPaymentReceipt.html +--- +# Method: payments.getPaymentReceipt +[Back to methods index](index.md) + + +Get payment receipt + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID of receipt | Yes| + + +### Return type: [payments.PaymentReceipt](../types/payments.PaymentReceipt.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +payments.PaymentReceipt = payments.getPaymentReceipt({msg_id=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/payments.getSavedInfo.md b/old_docs/API_docs_v109/methods/payments.getSavedInfo.md new file mode 100644 index 00000000..a6185fb6 --- /dev/null +++ b/old_docs/API_docs_v109/methods/payments.getSavedInfo.md @@ -0,0 +1,40 @@ +--- +title: payments.getSavedInfo +description: Get saved payment information +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_getSavedInfo.html +--- +# Method: payments.getSavedInfo +[Back to methods index](index.md) + + +Get saved payment information + + + +### Return type: [payments.SavedInfo](../types/payments.SavedInfo.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +payments.SavedInfo = payments.getSavedInfo({}) +``` + diff --git a/old_docs/API_docs_v109/methods/payments.sendPaymentForm.md b/old_docs/API_docs_v109/methods/payments.sendPaymentForm.md new file mode 100644 index 00000000..8e7263b8 --- /dev/null +++ b/old_docs/API_docs_v109/methods/payments.sendPaymentForm.md @@ -0,0 +1,55 @@ +--- +title: payments.sendPaymentForm +description: Send compiled payment form +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_sendPaymentForm.html +--- +# Method: payments.sendPaymentForm +[Back to methods index](index.md) + + +Send compiled payment form + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID of form | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of saved and validated [order info](../constructors/payments.validatedRequestedInfo.md) | Optional| +|shipping\_option\_id|[string](../types/string.md) | Chosen shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| + + +### Return type: [payments.PaymentResult](../types/payments.PaymentResult.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +payments.PaymentResult = payments.sendPaymentForm({msg_id=int, requested_info_id='string', shipping_option_id='string', credentials=InputPaymentCredentials, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/payments.validateRequestedInfo.md b/old_docs/API_docs_v109/methods/payments.validateRequestedInfo.md new file mode 100644 index 00000000..d2de3e78 --- /dev/null +++ b/old_docs/API_docs_v109/methods/payments.validateRequestedInfo.md @@ -0,0 +1,54 @@ +--- +title: payments.validateRequestedInfo +description: Submit requested order information for validation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/payments_validateRequestedInfo.html +--- +# Method: payments.validateRequestedInfo +[Back to methods index](index.md) + + +Submit requested order information for validation + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save order information to re-use it for future orders | Optional| +|msg\_id|[int](../types/int.md) | Message ID of payment form | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Requested order information | Yes| + + +### Return type: [payments.ValidatedRequestedInfo](../types/payments.ValidatedRequestedInfo.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +payments.ValidatedRequestedInfo = payments.validateRequestedInfo({save=Bool, msg_id=int, info=PaymentRequestedInfo, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MESSAGE_ID_INVALID|The provided message id is invalid| + + diff --git a/old_docs/API_docs_v109/methods/phone.acceptCall.md b/old_docs/API_docs_v109/methods/phone.acceptCall.md new file mode 100644 index 00000000..efc3523b --- /dev/null +++ b/old_docs/API_docs_v109/methods/phone.acceptCall.md @@ -0,0 +1,57 @@ +--- +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 +redirect_from: /API_docs/methods/phone_acceptCall.html +--- +# 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 + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| +|g\_b|[bytes](../types/bytes.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| + + +### Return type: [phone.PhoneCall](../types/phone.PhoneCall.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$phone.PhoneCall = $MadelineProto->phone->acceptCall(['peer' => InputPhoneCall, 'g_b' => 'bytes', 'protocol' => PhoneCallProtocol, ]); +``` + +Or, if you're into Lua: + +```lua +phone.PhoneCall = phone.acceptCall({peer=InputPhoneCall, g_b='bytes', protocol=PhoneCallProtocol, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_ALREADY_ACCEPTED|The call was already accepted| +|400|CALL_ALREADY_DECLINED|The call was already declined| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| +|400|CALL_PROTOCOL_FLAGS_INVALID|Call protocol flags invalid| + + diff --git a/old_docs/API_docs_v109/methods/phone.confirmCall.md b/old_docs/API_docs_v109/methods/phone.confirmCall.md new file mode 100644 index 00000000..94c485a9 --- /dev/null +++ b/old_docs/API_docs_v109/methods/phone.confirmCall.md @@ -0,0 +1,56 @@ +--- +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 +redirect_from: /API_docs/methods/phone_confirmCall.html +--- +# 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 + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| +|g\_a|[bytes](../types/bytes.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| +|key\_fingerprint|[long](../types/long.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| + + +### Return type: [phone.PhoneCall](../types/phone.PhoneCall.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$phone.PhoneCall = $MadelineProto->phone->confirmCall(['peer' => InputPhoneCall, 'g_a' => 'bytes', 'key_fingerprint' => long, 'protocol' => PhoneCallProtocol, ]); +``` + +Or, if you're into Lua: + +```lua +phone.PhoneCall = phone.confirmCall({peer=InputPhoneCall, g_a='bytes', key_fingerprint=long, protocol=PhoneCallProtocol, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_ALREADY_DECLINED|The call was already declined| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v109/methods/phone.discardCall.md b/old_docs/API_docs_v109/methods/phone.discardCall.md new file mode 100644 index 00000000..01086b8d --- /dev/null +++ b/old_docs/API_docs_v109/methods/phone.discardCall.md @@ -0,0 +1,57 @@ +--- +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 +redirect_from: /API_docs/methods/phone_discardCall.html +--- +# 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 + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|video|[Bool](../types/Bool.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Optional| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| +|duration|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| +|reason|[PhoneCallDiscardReason](../types/PhoneCallDiscardReason.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| +|connection\_id|[long](../types/long.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->discardCall(['video' => Bool, 'peer' => InputPhoneCall, 'duration' => int, 'reason' => PhoneCallDiscardReason, 'connection_id' => long, ]); +``` + +Or, if you're into Lua: + +```lua +Updates = phone.discardCall({video=Bool, peer=InputPhoneCall, duration=int, reason=PhoneCallDiscardReason, connection_id=long, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_ALREADY_ACCEPTED|The call was already accepted| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v109/methods/phone.getCallConfig.md b/old_docs/API_docs_v109/methods/phone.getCallConfig.md new file mode 100644 index 00000000..2eafd630 --- /dev/null +++ b/old_docs/API_docs_v109/methods/phone.getCallConfig.md @@ -0,0 +1,47 @@ +--- +title: phone.getCallConfig +description: Get phone call configuration to be passed to libtgvoip's shared config +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_getCallConfig.html +--- +# Method: phone.getCallConfig +[Back to methods index](index.md) + + +Get phone call configuration to be passed to libtgvoip's shared config + + + +### Return type: [DataJSON](../types/DataJSON.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); +``` + +Or, if you're into Lua: + +```lua +DataJSON = phone.getCallConfig({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| + + diff --git a/old_docs/API_docs_v109/methods/phone.receivedCall.md b/old_docs/API_docs_v109/methods/phone.receivedCall.md new file mode 100644 index 00000000..31e34607 --- /dev/null +++ b/old_docs/API_docs_v109/methods/phone.receivedCall.md @@ -0,0 +1,53 @@ +--- +title: phone.receivedCall +description: Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_receivedCall.html +--- +# Method: phone.receivedCall +[Back to methods index](index.md) + + +Optional: notify the server that the user is currently busy in a call: this will automatically refuse all incoming phone calls until the current phone call is ended. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call we're currently in | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = phone.receivedCall({peer=InputPhoneCall, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_ALREADY_DECLINED|The call was already declined| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v109/methods/phone.requestCall.md b/old_docs/API_docs_v109/methods/phone.requestCall.md new file mode 100644 index 00000000..f10e369c --- /dev/null +++ b/old_docs/API_docs_v109/methods/phone.requestCall.md @@ -0,0 +1,59 @@ +--- +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 +redirect_from: /API_docs/methods/phone_requestCall.html +--- +# 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 + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|video|[Bool](../types/Bool.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Optional| +|g\_a\_hash|[bytes](../types/bytes.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| +|protocol|[PhoneCallProtocol](../types/PhoneCallProtocol.md) | You cannot use this method directly, see https://docs.madelineproto.xyz#calls for more info on handling calls | Yes| + + +### Return type: [phone.PhoneCall](../types/phone.PhoneCall.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$phone.PhoneCall = $MadelineProto->phone->requestCall(['video' => Bool, 'user_id' => InputUser, 'g_a_hash' => 'bytes', 'protocol' => PhoneCallProtocol, ]); +``` + +Or, if you're into Lua: + +```lua +phone.PhoneCall = phone.requestCall({video=Bool, user_id=InputUser, g_a_hash='bytes', protocol=PhoneCallProtocol, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_PROTOCOL_FLAGS_INVALID|Call protocol flags invalid| +|400|PARTICIPANT_VERSION_OUTDATED|The other participant does not use an up to date telegram client with support for calls| +|400|USER_ID_INVALID|The provided user ID is invalid| +|403|USER_IS_BLOCKED|You were blocked by this user| +|403|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this| + + diff --git a/old_docs/API_docs_v109/methods/phone.saveCallDebug.md b/old_docs/API_docs_v109/methods/phone.saveCallDebug.md new file mode 100644 index 00000000..79077c91 --- /dev/null +++ b/old_docs/API_docs_v109/methods/phone.saveCallDebug.md @@ -0,0 +1,54 @@ +--- +title: phone.saveCallDebug +description: Send phone call debug data to server +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_saveCallDebug.html +--- +# Method: phone.saveCallDebug +[Back to methods index](index.md) + + +Send phone call debug data to server + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Phone call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debug statistics obtained from libtgvoip | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +Bool = phone.saveCallDebug({peer=InputPhoneCall, debug=DataJSON, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| +|400|DATA_JSON_INVALID|The provided JSON data is invalid| + + diff --git a/old_docs/API_docs_v109/methods/phone.setCallRating.md b/old_docs/API_docs_v109/methods/phone.setCallRating.md new file mode 100644 index 00000000..e8429bae --- /dev/null +++ b/old_docs/API_docs_v109/methods/phone.setCallRating.md @@ -0,0 +1,55 @@ +--- +title: phone.setCallRating +description: Rate a call +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/phone_setCallRating.html +--- +# Method: phone.setCallRating +[Back to methods index](index.md) + + +Rate a call + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_initiative|[Bool](../types/Bool.md) | Whether the user decided on their own initiative to rate the call | Optional| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call to rate | Yes| +|rating|[int](../types/int.md) | Rating in `1-5` stars | Yes| +|comment|[string](../types/string.md) | An additional comment | Yes| + + +### Return type: [Updates](../types/Updates.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(['user_initiative' => Bool, 'peer' => InputPhoneCall, 'rating' => int, 'comment' => 'string', ]); +``` + +Or, if you're into Lua: + +```lua +Updates = phone.setCallRating({user_initiative=Bool, peer=InputPhoneCall, rating=int, comment='string', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CALL_PEER_INVALID|The provided call peer object is invalid| + + diff --git a/old_docs/API_docs_v109/methods/photos.deletePhotos.md b/old_docs/API_docs_v109/methods/photos.deletePhotos.md new file mode 100644 index 00000000..2aa773cd --- /dev/null +++ b/old_docs/API_docs_v109/methods/photos.deletePhotos.md @@ -0,0 +1,45 @@ +--- +title: photos.deletePhotos +description: Deletes profile photos. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/photos_deletePhotos.html +--- +# Method: photos.deletePhotos +[Back to methods index](index.md) + + +Deletes profile photos. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| + + +### Return type: [Vector\_of\_long](../types/long.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_long = photos.deletePhotos({id={InputPhoto}, }) +``` + diff --git a/old_docs/API_docs_v109/methods/photos.getUserPhotos.md b/old_docs/API_docs_v109/methods/photos.getUserPhotos.md new file mode 100644 index 00000000..6c6a56a3 --- /dev/null +++ b/old_docs/API_docs_v109/methods/photos.getUserPhotos.md @@ -0,0 +1,56 @@ +--- +title: photos.getUserPhotos +description: Returns the list of user photos. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/photos_getUserPhotos.html +--- +# Method: photos.getUserPhotos +[Back to methods index](index.md) + + +Returns the list of user photos. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional| +|offset|[int](../types/int.md) | Number of list elements to be skipped | Yes| +|max\_id|[long](../types/long.md) | If a positive value was transferred, the method will return only photos with IDs less than the set one | Yes| +|limit|[int](../types/int.md) | Number of list elements to be returned | Yes| + + +### Return type: [photos.Photos](../types/photos.Photos.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +photos.Photos = photos.getUserPhotos({user_id=InputUser, offset=int, max_id=long, limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MAX_ID_INVALID|The provided max ID is invalid| +|400|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/photos.updateProfilePhoto.md b/old_docs/API_docs_v109/methods/photos.updateProfilePhoto.md new file mode 100644 index 00000000..38201fff --- /dev/null +++ b/old_docs/API_docs_v109/methods/photos.updateProfilePhoto.md @@ -0,0 +1,56 @@ +--- +title: photos.updateProfilePhoto +description: Installs a previously uploaded photo as a profile photo. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/photos_updateProfilePhoto.html +--- +# Method: photos.updateProfilePhoto +[Back to methods index](index.md) + + +Installs a previously uploaded photo as a profile photo. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Input photo | Optional| + + +### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +UserProfilePhoto = photos.updateProfilePhoto({id=InputPhoto, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|FILE_PARTS_INVALID|The number of file parts is invalid| +|400|IMAGE_PROCESS_FAILED|Failure while processing image| +|400|LOCATION_INVALID|The provided location is invalid| +|400|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|400|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v109/methods/photos.uploadProfilePhoto.md b/old_docs/API_docs_v109/methods/photos.uploadProfilePhoto.md new file mode 100644 index 00000000..43cace4c --- /dev/null +++ b/old_docs/API_docs_v109/methods/photos.uploadProfilePhoto.md @@ -0,0 +1,56 @@ +--- +title: photos.uploadProfilePhoto +description: Updates current user profile photo. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/photos_uploadProfilePhoto.html +--- +# Method: photos.uploadProfilePhoto +[Back to methods index](index.md) + + +Updates current user profile photo. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | File saved in parts by means of [upload.saveFilePart](../methods/upload.saveFilePart.md) method | Yes| + + +### Return type: [photos.Photo](../types/photos.Photo.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +photos.Photo = photos.uploadProfilePhoto({file=InputFile, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|FILE_PARTS_INVALID|The number of file parts is invalid| +|400|IMAGE_PROCESS_FAILED|Failure while processing image| +|400|PHOTO_CROP_FILE_MISSING|Photo crop file missing| +|400|PHOTO_CROP_SIZE_SMALL|Photo is too small| +|400|PHOTO_EXT_INVALID|The extension of the photo is invalid| + + diff --git a/old_docs/API_docs_v109/methods/stickers.addStickerToSet.md b/old_docs/API_docs_v109/methods/stickers.addStickerToSet.md new file mode 100644 index 00000000..f5420f5f --- /dev/null +++ b/old_docs/API_docs_v109/methods/stickers.addStickerToSet.md @@ -0,0 +1,54 @@ +--- +title: stickers.addStickerToSet +description: Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stickers_addStickerToSet.html +--- +# Method: stickers.addStickerToSet +[Back to methods index](index.md) + + +Add a sticker to a stickerset, bots only. The sticker set must have been created by the bot. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset | Optional| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | The sticker | Yes| + + +### Return type: [messages.StickerSet](../types/messages.StickerSet.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.StickerSet = stickers.addStickerToSet({stickerset=InputStickerSet, sticker=InputStickerSetItem, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_MISSING|This method can only be run by a bot| +|400|STICKERSET_INVALID|The provided sticker set is invalid| + + diff --git a/old_docs/API_docs_v109/methods/stickers.changeStickerPosition.md b/old_docs/API_docs_v109/methods/stickers.changeStickerPosition.md new file mode 100644 index 00000000..9b99e6fb --- /dev/null +++ b/old_docs/API_docs_v109/methods/stickers.changeStickerPosition.md @@ -0,0 +1,54 @@ +--- +title: stickers.changeStickerPosition +description: Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stickers_changeStickerPosition.html +--- +# Method: stickers.changeStickerPosition +[Back to methods index](index.md) + + +Changes the absolute position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|position|[int](../types/int.md) | The new position of the sticker, zero-based | Yes| + + +### Return type: [messages.StickerSet](../types/messages.StickerSet.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.StickerSet = stickers.changeStickerPosition({sticker=InputDocument, position=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_MISSING|This method can only be run by a bot| +|400|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v109/methods/stickers.createStickerSet.md b/old_docs/API_docs_v109/methods/stickers.createStickerSet.md new file mode 100644 index 00000000..4da4e412 --- /dev/null +++ b/old_docs/API_docs_v109/methods/stickers.createStickerSet.md @@ -0,0 +1,64 @@ +--- +title: stickers.createStickerSet +description: Create a stickerset, bots only. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stickers_createStickerSet.html +--- +# Method: stickers.createStickerSet +[Back to methods index](index.md) + + +Create a stickerset, bots only. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Whether this is a mask stickerset | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Stickerset owner | Optional| +|title|[string](../types/string.md) | Stickerset name, `1-64` chars | Yes| +|short\_name|[string](../types/string.md) | Sticker set name. Can contain only English letters, digits and underscores. Must end with *"*by*"* (** is case insensitive); 1-64 characters | Yes| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | The stickers to add | Yes| + + +### Return type: [messages.StickerSet](../types/messages.StickerSet.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +messages.StickerSet = stickers.createStickerSet({masks=Bool, user_id=InputUser, title='string', short_name='string', stickers={InputStickerSetItem}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_MISSING|This method can only be run by a bot| +|400|PACK_SHORT_NAME_INVALID|Short pack name invalid| +|400|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists| +|400|PEER_ID_INVALID|The provided peer id is invalid| +|400|STICKER_EMOJI_INVALID|Sticker emoji invalid| +|400|STICKER_FILE_INVALID|Sticker file invalid| +|400|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid| +|400|STICKERS_EMPTY|No sticker provided| +|400|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v109/methods/stickers.removeStickerFromSet.md b/old_docs/API_docs_v109/methods/stickers.removeStickerFromSet.md new file mode 100644 index 00000000..ac1840c8 --- /dev/null +++ b/old_docs/API_docs_v109/methods/stickers.removeStickerFromSet.md @@ -0,0 +1,53 @@ +--- +title: stickers.removeStickerFromSet +description: Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/stickers_removeStickerFromSet.html +--- +# Method: stickers.removeStickerFromSet +[Back to methods index](index.md) + + +Remove a sticker from the set where it belongs, bots only. The sticker set must have been created by the bot. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to remove | Optional| + + +### Return type: [messages.StickerSet](../types/messages.StickerSet.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +messages.StickerSet = stickers.removeStickerFromSet({sticker=InputDocument, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|BOT_MISSING|This method can only be run by a bot| +|400|STICKER_INVALID|The provided sticker is invalid| + + diff --git a/old_docs/API_docs_v109/methods/updates.getChannelDifference.md b/old_docs/API_docs_v109/methods/updates.getChannelDifference.md new file mode 100644 index 00000000..d25a29e9 --- /dev/null +++ b/old_docs/API_docs_v109/methods/updates.getChannelDifference.md @@ -0,0 +1,66 @@ +--- +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 +redirect_from: /API_docs/methods/updates_getChannelDifference.html +--- +# 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 + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Optional| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Optional| +|filter|[ChannelMessagesFilter](../types/ChannelMessagesFilter.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Optional| +|pts|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Yes| +|limit|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Yes| + + +### Return type: [updates.ChannelDifference](../types/updates.ChannelDifference.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.ChannelDifference = $MadelineProto->updates->getChannelDifference(['force' => Bool, 'channel' => InputChannel, 'filter' => ChannelMessagesFilter, 'pts' => int, 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +updates.ChannelDifference = updates.getChannelDifference({force=Bool, channel=InputChannel, filter=ChannelMessagesFilter, pts=int, limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CHANNEL_INVALID|The provided channel is invalid| +|400|CHANNEL_PRIVATE|You haven't joined this channel/supergroup| +|400|FROM_MESSAGE_BOT_DISABLED|Bots can't use fromMessage min constructors| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|PERSISTENT_TIMESTAMP_EMPTY|Persistent timestamp empty| +|400|PERSISTENT_TIMESTAMP_INVALID|Persistent timestamp invalid| +|400|PINNED_DIALOGS_TOO_MUCH|Too many pinned dialogs| +|400|RANGES_INVALID|Invalid range provided| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|403|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/updates.getDifference.md b/old_docs/API_docs_v109/methods/updates.getDifference.md new file mode 100644 index 00000000..56e15b25 --- /dev/null +++ b/old_docs/API_docs_v109/methods/updates.getDifference.md @@ -0,0 +1,62 @@ +--- +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 +redirect_from: /API_docs/methods/updates_getDifference.html +--- +# 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 + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pts|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Yes| +|pts\_total\_limit|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Optional| +|date|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Yes| +|qts|[int](../types/int.md) | You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling updates | Yes| + + +### Return type: [updates.Difference](../types/updates.Difference.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.Difference = $MadelineProto->updates->getDifference(['pts' => int, 'pts_total_limit' => int, 'date' => int, 'qts' => int, ]); +``` + +Or, if you're into Lua: + +```lua +updates.Difference = updates.getDifference({pts=int, pts_total_limit=int, date=int, qts=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|400|DATE_EMPTY|Date empty| +|400|PERSISTENT_TIMESTAMP_EMPTY|Persistent timestamp empty| +|400|PERSISTENT_TIMESTAMP_INVALID|Persistent timestamp invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/updates.getState.md b/old_docs/API_docs_v109/methods/updates.getState.md new file mode 100644 index 00000000..b187e258 --- /dev/null +++ b/old_docs/API_docs_v109/methods/updates.getState.md @@ -0,0 +1,49 @@ +--- +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 +redirect_from: /API_docs/methods/updates_getState.html +--- +# 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 + + + +### Return type: [updates.State](../types/updates.State.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.State = $MadelineProto->updates->getState(); +``` + +Or, if you're into Lua: + +```lua +updates.State = updates.getState({}) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/upload.getCdnFile.md b/old_docs/API_docs_v109/methods/upload.getCdnFile.md new file mode 100644 index 00000000..a956e8f3 --- /dev/null +++ b/old_docs/API_docs_v109/methods/upload.getCdnFile.md @@ -0,0 +1,47 @@ +--- +title: upload.getCdnFile +description: You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_getCdnFile.html +--- +# Method: upload.getCdnFile +[Back to methods index](index.md) + + +You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_token|[bytes](../types/bytes.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|offset|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|limit|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| + + +### Return type: [upload.CdnFile](../types/upload.CdnFile.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.CdnFile = $MadelineProto->upload->getCdnFile(['file_token' => 'bytes', 'offset' => int, 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +upload.CdnFile = upload.getCdnFile({file_token='bytes', offset=int, limit=int, }) +``` + diff --git a/old_docs/API_docs_v109/methods/upload.getCdnFileHashes.md b/old_docs/API_docs_v109/methods/upload.getCdnFileHashes.md new file mode 100644 index 00000000..340a3cc9 --- /dev/null +++ b/old_docs/API_docs_v109/methods/upload.getCdnFileHashes.md @@ -0,0 +1,54 @@ +--- +title: upload.getCdnFileHashes +description: You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_getCdnFileHashes.html +--- +# Method: upload.getCdnFileHashes +[Back to methods index](index.md) + + +You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_token|[bytes](../types/bytes.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|offset|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| + + +### Return type: [Vector\_of\_FileHash](../types/FileHash.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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_FileHash = $MadelineProto->upload->getCdnFileHashes(['file_token' => 'bytes', 'offset' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_FileHash = upload.getCdnFileHashes({file_token='bytes', offset=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|CDN_METHOD_INVALID|You can't call this method in a CDN DC| +|400|RSA_DECRYPT_FAILED|Internal RSA decryption failed| + + diff --git a/old_docs/API_docs_v109/methods/upload.getFile.md b/old_docs/API_docs_v109/methods/upload.getFile.md new file mode 100644 index 00000000..dc283623 --- /dev/null +++ b/old_docs/API_docs_v109/methods/upload.getFile.md @@ -0,0 +1,65 @@ +--- +title: upload.getFile +description: You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_getFile.html +--- +# Method: upload.getFile +[Back to methods index](index.md) + + +You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|precise|[Bool](../types/Bool.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Optional| +|cdn\_supported|[Bool](../types/Bool.md) | | Optional| +|location|[InputFileLocation](../types/InputFileLocation.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|offset|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|limit|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| + + +### Return type: [upload.File](../types/upload.File.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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.File = $MadelineProto->upload->getFile(['precise' => Bool, 'cdn_supported' => Bool, 'location' => InputFileLocation, 'offset' => int, 'limit' => int, ]); +``` + +Or, if you're into Lua: + +```lua +upload.File = upload.getFile({precise=Bool, cdn_supported=Bool, location=InputFileLocation, offset=int, limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|FILE_ID_INVALID|The provided file id is invalid| +|400|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|400|LIMIT_INVALID|The provided limit is invalid| +|400|LOCATION_INVALID|The provided location is invalid| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|OFFSET_INVALID|The provided offset is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|406|FILEREF_UPGRADE_NEEDED|The client has to be updated in order to support [file references](https://core.telegram.org/api/file_reference)| +|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/upload.getFileHashes.md b/old_docs/API_docs_v109/methods/upload.getFileHashes.md new file mode 100644 index 00000000..7442534d --- /dev/null +++ b/old_docs/API_docs_v109/methods/upload.getFileHashes.md @@ -0,0 +1,53 @@ +--- +title: upload.getFileHashes +description: You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_getFileHashes.html +--- +# Method: upload.getFileHashes +[Back to methods index](index.md) + + +You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputFileLocation](../types/InputFileLocation.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|offset|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| + + +### Return type: [Vector\_of\_FileHash](../types/FileHash.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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_FileHash = $MadelineProto->upload->getFileHashes(['location' => InputFileLocation, 'offset' => int, ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_FileHash = upload.getFileHashes({location=InputFileLocation, offset=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v109/methods/upload.getWebFile.md b/old_docs/API_docs_v109/methods/upload.getWebFile.md new file mode 100644 index 00000000..e1d17165 --- /dev/null +++ b/old_docs/API_docs_v109/methods/upload.getWebFile.md @@ -0,0 +1,54 @@ +--- +title: upload.getWebFile +description: Returns content of an HTTP file or a part, by proxying the request through telegram. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_getWebFile.html +--- +# Method: upload.getWebFile +[Back to methods index](index.md) + + +Returns content of an HTTP file or a part, by proxying the request through telegram. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file to download | Yes| +|offset|[int](../types/int.md) | Number of bytes to be skipped | Yes| +|limit|[int](../types/int.md) | Number of bytes to be returned | Yes| + + +### Return type: [upload.WebFile](../types/upload.WebFile.md) + +### Can bots use this method: **NO** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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, ]); +``` + +Or, if you're into Lua: + +```lua +upload.WebFile = upload.getWebFile({location=InputWebFileLocation, offset=int, limit=int, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|LOCATION_INVALID|The provided location is invalid| + + diff --git a/old_docs/API_docs_v109/methods/upload.reuploadCdnFile.md b/old_docs/API_docs_v109/methods/upload.reuploadCdnFile.md new file mode 100644 index 00000000..adb90a3c --- /dev/null +++ b/old_docs/API_docs_v109/methods/upload.reuploadCdnFile.md @@ -0,0 +1,53 @@ +--- +title: upload.reuploadCdnFile +description: You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_reuploadCdnFile.html +--- +# Method: upload.reuploadCdnFile +[Back to methods index](index.md) + + +You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_token|[bytes](../types/bytes.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|request\_token|[bytes](../types/bytes.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| + + +### Return type: [Vector\_of\_FileHash](../types/FileHash.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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_FileHash = $MadelineProto->upload->reuploadCdnFile(['file_token' => 'bytes', 'request_token' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_FileHash = upload.reuploadCdnFile({file_token='bytes', request_token='bytes', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|RSA_DECRYPT_FAILED|Internal RSA decryption failed| + + diff --git a/old_docs/API_docs_v109/methods/upload.saveBigFilePart.md b/old_docs/API_docs_v109/methods/upload.saveBigFilePart.md new file mode 100644 index 00000000..eddb9552 --- /dev/null +++ b/old_docs/API_docs_v109/methods/upload.saveBigFilePart.md @@ -0,0 +1,61 @@ +--- +title: upload.saveBigFilePart +description: You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_saveBigFilePart.html +--- +# Method: upload.saveBigFilePart +[Back to methods index](index.md) + + +You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_id|[long](../types/long.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|file\_part|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|file\_total\_parts|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|bytes|[bytes](../types/bytes.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->upload->saveBigFilePart(['file_id' => long, 'file_part' => int, 'file_total_parts' => int, 'bytes' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = upload.saveBigFilePart({file_id=long, file_part=int, file_total_parts=int, bytes='bytes', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|FILE_PART_EMPTY|The provided file part is empty| +|400|FILE_PART_INVALID|The file part number is invalid| +|400|FILE_PART_SIZE_CHANGED|Provided file part size has changed| +|400|FILE_PART_SIZE_INVALID|The provided file part size is invalid| +|400|FILE_PARTS_INVALID|The number of file parts is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/upload.saveFilePart.md b/old_docs/API_docs_v109/methods/upload.saveFilePart.md new file mode 100644 index 00000000..4f486043 --- /dev/null +++ b/old_docs/API_docs_v109/methods/upload.saveFilePart.md @@ -0,0 +1,58 @@ +--- +title: upload.saveFilePart +description: You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/upload_saveFilePart.html +--- +# Method: upload.saveFilePart +[Back to methods index](index.md) + + +You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_id|[long](../types/long.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|file\_part|[int](../types/int.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| +|bytes|[bytes](../types/bytes.md) | You cannot use this method directly, use the upload, downloadToStream, downloadToFile, downloadToDir methods instead; see https://docs.madelineproto.xyz for more info | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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->upload->saveFilePart(['file_id' => long, 'file_part' => int, 'bytes' => 'bytes', ]); +``` + +Or, if you're into Lua: + +```lua +Bool = upload.saveFilePart({file_id=long, file_part=int, bytes='bytes', }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|FILE_PART_EMPTY|The provided file part is empty| +|400|FILE_PART_INVALID|The file part number is invalid| +|400|INPUT_FETCH_FAIL|Failed deserializing TL payload| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + + diff --git a/old_docs/API_docs_v109/methods/users.getFullUser.md b/old_docs/API_docs_v109/methods/users.getFullUser.md new file mode 100644 index 00000000..a18fa9bc --- /dev/null +++ b/old_docs/API_docs_v109/methods/users.getFullUser.md @@ -0,0 +1,55 @@ +--- +title: users.getFullUser +description: You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/users_getFullUser.html +--- +# Method: users.getFullUser +[Back to methods index](index.md) + + +You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | You cannot use this method directly, use the getPwrChat, getInfo, getFullInfo methods instead (see https://docs.madelineproto.xyz for more info) | Optional| + + +### Return type: [UserFull](../types/UserFull.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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(); + +$UserFull = $MadelineProto->users->getFullUser(['id' => InputUser, ]); +``` + +Or, if you're into Lua: + +```lua +UserFull = users.getFullUser({id=InputUser, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|MSG_ID_INVALID|Invalid message ID provided| +|400|USER_ID_INVALID|The provided user ID is invalid| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/users.getUsers.md b/old_docs/API_docs_v109/methods/users.getUsers.md new file mode 100644 index 00000000..7e0957e7 --- /dev/null +++ b/old_docs/API_docs_v109/methods/users.getUsers.md @@ -0,0 +1,57 @@ +--- +title: users.getUsers +description: Returns basic user info according to their identifiers. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/users_getUsers.html +--- +# Method: users.getUsers +[Back to methods index](index.md) + + +Returns basic user info according to their identifiers. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| + + +### Return type: [Vector\_of\_User](../types/User.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Vector_of_User = users.getUsers({id={InputUser}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|INPUT_LAYER_INVALID|The provided layer is invalid| +|400|MSG_ID_INVALID|Invalid message ID provided| +|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated| +|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.| +|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| +|-503|Timeout|Timeout while fetching data| + + diff --git a/old_docs/API_docs_v109/methods/users.setSecureValueErrors.md b/old_docs/API_docs_v109/methods/users.setSecureValueErrors.md new file mode 100644 index 00000000..665d23ec --- /dev/null +++ b/old_docs/API_docs_v109/methods/users.setSecureValueErrors.md @@ -0,0 +1,57 @@ +--- +title: users.setSecureValueErrors +description: Notify the user that the sent [passport](https://core.telegram.org/passport) data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change). + +Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/methods/users_setSecureValueErrors.html +--- +# Method: users.setSecureValueErrors +[Back to methods index](index.md) + + +Notify the user that the sent [passport](https://core.telegram.org/passport) data contains some errors The user will not be able to re-submit their Passport data to you until the errors are fixed (the contents of the field for which you returned the error must change). + +Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. + +### Parameters: + +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|errors|Array of [SecureValueError](../types/SecureValueError.md) | The errors | Yes| + + +### Return type: [Bool](../types/Bool.md) + +### Can bots use this method: **YES** + + +### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)): + + +```php +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], ]); +``` + +Or, if you're into Lua: + +```lua +Bool = users.setSecureValueErrors({id=InputUser, errors={SecureValueError}, }) +``` + +### Errors + +| Code | Type | Description | +|------|----------|---------------| +|400|USER_ID_INVALID|The provided user ID is invalid| + + diff --git a/old_docs/API_docs_v109/types/!X.md b/old_docs/API_docs_v109/types/!X.md new file mode 100644 index 00000000..dc27d5cd --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/AccountDaysTTL.md b/old_docs/API_docs_v109/types/AccountDaysTTL.md new file mode 100644 index 00000000..f3494aac --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/Authorization.md b/old_docs/API_docs_v109/types/Authorization.md new file mode 100644 index 00000000..147bc9e4 --- /dev/null +++ b/old_docs/API_docs_v109/types/Authorization.md @@ -0,0 +1,22 @@ +--- +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): + +[$MadelineProto->auth->acceptLoginToken](../methods/auth.acceptLoginToken.md) + + + diff --git a/old_docs/API_docs_v109/types/AutoDownloadSettings.md b/old_docs/API_docs_v109/types/AutoDownloadSettings.md new file mode 100644 index 00000000..559e2132 --- /dev/null +++ b/old_docs/API_docs_v109/types/AutoDownloadSettings.md @@ -0,0 +1,20 @@ +--- +title: AutoDownloadSettings +description: constructors and methods of type AutoDownloadSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: AutoDownloadSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[autoDownloadSettings](../constructors/autoDownloadSettings.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/BaseTheme.md b/old_docs/API_docs_v109/types/BaseTheme.md new file mode 100644 index 00000000..428b09c3 --- /dev/null +++ b/old_docs/API_docs_v109/types/BaseTheme.md @@ -0,0 +1,28 @@ +--- +title: BaseTheme +description: constructors and methods of type BaseTheme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: BaseTheme +[Back to types index](index.md) + + + +### Possible values (constructors): + +[baseThemeClassic](../constructors/baseThemeClassic.md) + +[baseThemeDay](../constructors/baseThemeDay.md) + +[baseThemeNight](../constructors/baseThemeNight.md) + +[baseThemeTinted](../constructors/baseThemeTinted.md) + +[baseThemeArctic](../constructors/baseThemeArctic.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/Bool.md b/old_docs/API_docs_v109/types/Bool.md new file mode 100644 index 00000000..7a1d95ff --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/BotCommand.md b/old_docs/API_docs_v109/types/BotCommand.md new file mode 100644 index 00000000..759f2b8b --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/BotInfo.md b/old_docs/API_docs_v109/types/BotInfo.md new file mode 100644 index 00000000..dc876cb5 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/BotInlineMessage.md b/old_docs/API_docs_v109/types/BotInlineMessage.md new file mode 100644 index 00000000..bd0da30e --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/BotInlineResult.md b/old_docs/API_docs_v109/types/BotInlineResult.md new file mode 100644 index 00000000..3d10e416 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/CdnConfig.md b/old_docs/API_docs_v109/types/CdnConfig.md new file mode 100644 index 00000000..0b0fb5be --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/CdnPublicKey.md b/old_docs/API_docs_v109/types/CdnPublicKey.md new file mode 100644 index 00000000..14df6975 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ChannelAdminLogEvent.md b/old_docs/API_docs_v109/types/ChannelAdminLogEvent.md new file mode 100644 index 00000000..5cd8d2fd --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ChannelAdminLogEventAction.md b/old_docs/API_docs_v109/types/ChannelAdminLogEventAction.md new file mode 100644 index 00000000..6707b267 --- /dev/null +++ b/old_docs/API_docs_v109/types/ChannelAdminLogEventAction.md @@ -0,0 +1,60 @@ +--- +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) + +[channelAdminLogEventActionDefaultBannedRights](../constructors/channelAdminLogEventActionDefaultBannedRights.md) + +[channelAdminLogEventActionStopPoll](../constructors/channelAdminLogEventActionStopPoll.md) + +[channelAdminLogEventActionChangeLinkedChat](../constructors/channelAdminLogEventActionChangeLinkedChat.md) + +[channelAdminLogEventActionChangeLocation](../constructors/channelAdminLogEventActionChangeLocation.md) + +[channelAdminLogEventActionToggleSlowMode](../constructors/channelAdminLogEventActionToggleSlowMode.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/ChannelAdminLogEventsFilter.md b/old_docs/API_docs_v109/types/ChannelAdminLogEventsFilter.md new file mode 100644 index 00000000..1199a100 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ChannelLocation.md b/old_docs/API_docs_v109/types/ChannelLocation.md new file mode 100644 index 00000000..d3bc2e85 --- /dev/null +++ b/old_docs/API_docs_v109/types/ChannelLocation.md @@ -0,0 +1,22 @@ +--- +title: ChannelLocation +description: constructors and methods of type ChannelLocation +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChannelLocation +[Back to types index](index.md) + + + +### Possible values (constructors): + +[channelLocationEmpty](../constructors/channelLocationEmpty.md) + +[channelLocation](../constructors/channelLocation.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/ChannelMessagesFilter.md b/old_docs/API_docs_v109/types/ChannelMessagesFilter.md new file mode 100644 index 00000000..e3052b30 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ChannelParticipant.md b/old_docs/API_docs_v109/types/ChannelParticipant.md new file mode 100644 index 00000000..0658f4e9 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ChannelParticipantsFilter.md b/old_docs/API_docs_v109/types/ChannelParticipantsFilter.md new file mode 100644 index 00000000..70cfa41c --- /dev/null +++ b/old_docs/API_docs_v109/types/ChannelParticipantsFilter.md @@ -0,0 +1,32 @@ +--- +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) + +[channelParticipantsContacts](../constructors/channelParticipantsContacts.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/Chat.md b/old_docs/API_docs_v109/types/Chat.md new file mode 100644 index 00000000..cd83aacb --- /dev/null +++ b/old_docs/API_docs_v109/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 [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.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_v109/types/ChatAdminRights.md b/old_docs/API_docs_v109/types/ChatAdminRights.md new file mode 100644 index 00000000..2d0b53db --- /dev/null +++ b/old_docs/API_docs_v109/types/ChatAdminRights.md @@ -0,0 +1,20 @@ +--- +title: ChatAdminRights +description: constructors and methods of type ChatAdminRights +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChatAdminRights +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatAdminRights](../constructors/chatAdminRights.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/ChatBannedRights.md b/old_docs/API_docs_v109/types/ChatBannedRights.md new file mode 100644 index 00000000..6eec3d79 --- /dev/null +++ b/old_docs/API_docs_v109/types/ChatBannedRights.md @@ -0,0 +1,20 @@ +--- +title: ChatBannedRights +description: constructors and methods of type ChatBannedRights +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChatBannedRights +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatBannedRights](../constructors/chatBannedRights.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/ChatFull.md b/old_docs/API_docs_v109/types/ChatFull.md new file mode 100644 index 00000000..615843bc --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ChatInvite.md b/old_docs/API_docs_v109/types/ChatInvite.md new file mode 100644 index 00000000..9fafabb4 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ChatOnlines.md b/old_docs/API_docs_v109/types/ChatOnlines.md new file mode 100644 index 00000000..e5646dd6 --- /dev/null +++ b/old_docs/API_docs_v109/types/ChatOnlines.md @@ -0,0 +1,22 @@ +--- +title: ChatOnlines +description: constructors and methods of type ChatOnlines +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ChatOnlines +[Back to types index](index.md) + + + +### Possible values (constructors): + +[chatOnlines](../constructors/chatOnlines.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getOnlines](../methods/messages.getOnlines.md) + + + diff --git a/old_docs/API_docs_v109/types/ChatParticipant.md b/old_docs/API_docs_v109/types/ChatParticipant.md new file mode 100644 index 00000000..30bad422 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ChatParticipants.md b/old_docs/API_docs_v109/types/ChatParticipants.md new file mode 100644 index 00000000..ab60023d --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ChatPhoto.md b/old_docs/API_docs_v109/types/ChatPhoto.md new file mode 100644 index 00000000..066b2a14 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/CodeSettings.md b/old_docs/API_docs_v109/types/CodeSettings.md new file mode 100644 index 00000000..d6c0934a --- /dev/null +++ b/old_docs/API_docs_v109/types/CodeSettings.md @@ -0,0 +1,20 @@ +--- +title: CodeSettings +description: constructors and methods of type CodeSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: CodeSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[codeSettings](../constructors/codeSettings.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/Config.md b/old_docs/API_docs_v109/types/Config.md new file mode 100644 index 00000000..3a23b7b7 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/Contact.md b/old_docs/API_docs_v109/types/Contact.md new file mode 100644 index 00000000..b8c9db1a --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ContactBlocked.md b/old_docs/API_docs_v109/types/ContactBlocked.md new file mode 100644 index 00000000..a3384d9a --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ContactStatus.md b/old_docs/API_docs_v109/types/ContactStatus.md new file mode 100644 index 00000000..30aee6e2 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/DataJSON.md b/old_docs/API_docs_v109/types/DataJSON.md new file mode 100644 index 00000000..ad772790 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/DcOption.md b/old_docs/API_docs_v109/types/DcOption.md new file mode 100644 index 00000000..c621fa1d --- /dev/null +++ b/old_docs/API_docs_v109/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/docs/API_docs/types/IpPort.md b/old_docs/API_docs_v109/types/Dialog.md similarity index 56% rename from docs/API_docs/types/IpPort.md rename to old_docs/API_docs_v109/types/Dialog.md index 91e0cb84..31dc6481 100644 --- a/docs/API_docs/types/IpPort.md +++ b/old_docs/API_docs_v109/types/Dialog.md @@ -1,18 +1,18 @@ --- -title: IpPort -description: constructors and methods of type IpPort +title: Dialog +description: constructors and methods of type Dialog image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png --- -# Type: IpPort +# Type: Dialog [Back to types index](index.md) ### Possible values (constructors): -[ipPort](../constructors/ipPort.md) +[dialog](../constructors/dialog.md) -[ipPortSecret](../constructors/ipPortSecret.md) +[dialogFolder](../constructors/dialogFolder.md) diff --git a/old_docs/API_docs_v109/types/DialogPeer.md b/old_docs/API_docs_v109/types/DialogPeer.md new file mode 100644 index 00000000..18b145b0 --- /dev/null +++ b/old_docs/API_docs_v109/types/DialogPeer.md @@ -0,0 +1,48 @@ +--- +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) + + + +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: + +``` +$DialogPeer = '@username'; // Username + +$DialogPeer = 'me'; // The currently logged-in user + +$DialogPeer = 44700; // bot API id (users) +$DialogPeer = -492772765; // bot API id (chats) +$DialogPeer = -10038575794; // bot API id (channels) + +$DialogPeer = 'https://t.me/danogentili'; // t.me URLs +$DialogPeer = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$DialogPeer = 'user#44700'; // tg-cli style id (users) +$DialogPeer = 'chat#492772765'; // tg-cli style id (chats) +$DialogPeer = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + +### Possible values (constructors): + +[dialogPeer](../constructors/dialogPeer.md) + +[dialogPeerFolder](../constructors/dialogPeerFolder.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getDialogUnreadMarks](../methods/messages.getDialogUnreadMarks.md) + + + diff --git a/old_docs/API_docs_v109/types/Document.md b/old_docs/API_docs_v109/types/Document.md new file mode 100644 index 00000000..8f0843ad --- /dev/null +++ b/old_docs/API_docs_v109/types/Document.md @@ -0,0 +1,26 @@ +--- +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->account->uploadTheme](../methods/account.uploadTheme.md) + +[$MadelineProto->messages->getDocumentByHash](../methods/messages.getDocumentByHash.md) + + + diff --git a/old_docs/API_docs_v109/types/DocumentAttribute.md b/old_docs/API_docs_v109/types/DocumentAttribute.md new file mode 100644 index 00000000..8a1060c8 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/DraftMessage.md b/old_docs/API_docs_v109/types/DraftMessage.md new file mode 100644 index 00000000..63dd107a --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/EmojiKeyword.md b/old_docs/API_docs_v109/types/EmojiKeyword.md new file mode 100644 index 00000000..7c061ffe --- /dev/null +++ b/old_docs/API_docs_v109/types/EmojiKeyword.md @@ -0,0 +1,22 @@ +--- +title: EmojiKeyword +description: constructors and methods of type EmojiKeyword +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: EmojiKeyword +[Back to types index](index.md) + + + +### Possible values (constructors): + +[emojiKeyword](../constructors/emojiKeyword.md) + +[emojiKeywordDeleted](../constructors/emojiKeywordDeleted.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/EmojiKeywordsDifference.md b/old_docs/API_docs_v109/types/EmojiKeywordsDifference.md new file mode 100644 index 00000000..1282c000 --- /dev/null +++ b/old_docs/API_docs_v109/types/EmojiKeywordsDifference.md @@ -0,0 +1,24 @@ +--- +title: EmojiKeywordsDifference +description: constructors and methods of type EmojiKeywordsDifference +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: EmojiKeywordsDifference +[Back to types index](index.md) + + + +### Possible values (constructors): + +[emojiKeywordsDifference](../constructors/emojiKeywordsDifference.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getEmojiKeywords](../methods/messages.getEmojiKeywords.md) + +[$MadelineProto->messages->getEmojiKeywordsDifference](../methods/messages.getEmojiKeywordsDifference.md) + + + diff --git a/old_docs/API_docs_v109/types/EmojiLanguage.md b/old_docs/API_docs_v109/types/EmojiLanguage.md new file mode 100644 index 00000000..5ff98ac3 --- /dev/null +++ b/old_docs/API_docs_v109/types/EmojiLanguage.md @@ -0,0 +1,22 @@ +--- +title: EmojiLanguage +description: constructors and methods of type EmojiLanguage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: EmojiLanguage +[Back to types index](index.md) + + + +### Possible values (constructors): + +[emojiLanguage](../constructors/emojiLanguage.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getEmojiKeywordsLanguages](../methods/messages.getEmojiKeywordsLanguages.md) + + + diff --git a/old_docs/API_docs_v109/types/EmojiURL.md b/old_docs/API_docs_v109/types/EmojiURL.md new file mode 100644 index 00000000..c2fc469d --- /dev/null +++ b/old_docs/API_docs_v109/types/EmojiURL.md @@ -0,0 +1,22 @@ +--- +title: EmojiURL +description: constructors and methods of type EmojiURL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: EmojiURL +[Back to types index](index.md) + + + +### Possible values (constructors): + +[emojiURL](../constructors/emojiURL.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getEmojiURL](../methods/messages.getEmojiURL.md) + + + diff --git a/old_docs/API_docs_v109/types/EncryptedChat.md b/old_docs/API_docs_v109/types/EncryptedChat.md new file mode 100644 index 00000000..19cf52b0 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/EncryptedFile.md b/old_docs/API_docs_v109/types/EncryptedFile.md new file mode 100644 index 00000000..8ecf8e9d --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/EncryptedMessage.md b/old_docs/API_docs_v109/types/EncryptedMessage.md new file mode 100644 index 00000000..f0b54b7e --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/Error.md b/old_docs/API_docs_v109/types/Error.md new file mode 100644 index 00000000..245a4f03 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ExportedChatInvite.md b/old_docs/API_docs_v109/types/ExportedChatInvite.md new file mode 100644 index 00000000..f5a43739 --- /dev/null +++ b/old_docs/API_docs_v109/types/ExportedChatInvite.md @@ -0,0 +1,24 @@ +--- +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) + + + diff --git a/old_docs/API_docs_v109/types/ExportedMessageLink.md b/old_docs/API_docs_v109/types/ExportedMessageLink.md new file mode 100644 index 00000000..948e9c90 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/FileHash.md b/old_docs/API_docs_v109/types/FileHash.md new file mode 100644 index 00000000..a908fb9b --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/FileLocation.md b/old_docs/API_docs_v109/types/FileLocation.md new file mode 100644 index 00000000..f29f88e6 --- /dev/null +++ b/old_docs/API_docs_v109/types/FileLocation.md @@ -0,0 +1,20 @@ +--- +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): + +[fileLocationToBeDeprecated](../constructors/fileLocationToBeDeprecated.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/Folder.md b/old_docs/API_docs_v109/types/Folder.md new file mode 100644 index 00000000..f9fb1ac7 --- /dev/null +++ b/old_docs/API_docs_v109/types/Folder.md @@ -0,0 +1,20 @@ +--- +title: Folder +description: constructors and methods of type Folder +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Folder +[Back to types index](index.md) + + + +### Possible values (constructors): + +[folder](../constructors/folder.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/FolderPeer.md b/old_docs/API_docs_v109/types/FolderPeer.md new file mode 100644 index 00000000..cbf40eed --- /dev/null +++ b/old_docs/API_docs_v109/types/FolderPeer.md @@ -0,0 +1,20 @@ +--- +title: FolderPeer +description: constructors and methods of type FolderPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: FolderPeer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[folderPeer](../constructors/folderPeer.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/FoundGif.md b/old_docs/API_docs_v109/types/FoundGif.md new file mode 100644 index 00000000..6085f2a0 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/Game.md b/old_docs/API_docs_v109/types/Game.md new file mode 100644 index 00000000..77493a4b --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/GeoPoint.md b/old_docs/API_docs_v109/types/GeoPoint.md new file mode 100644 index 00000000..13ac6ebb --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/HighScore.md b/old_docs/API_docs_v109/types/HighScore.md new file mode 100644 index 00000000..41e02ee4 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ImportedContact.md b/old_docs/API_docs_v109/types/ImportedContact.md new file mode 100644 index 00000000..35654f72 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InlineBotSwitchPM.md b/old_docs/API_docs_v109/types/InlineBotSwitchPM.md new file mode 100644 index 00000000..68c1be35 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputAppEvent.md b/old_docs/API_docs_v109/types/InputAppEvent.md new file mode 100644 index 00000000..64a2d296 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputBotInlineMessage.md b/old_docs/API_docs_v109/types/InputBotInlineMessage.md new file mode 100644 index 00000000..d622b55f --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputBotInlineMessageID.md b/old_docs/API_docs_v109/types/InputBotInlineMessageID.md new file mode 100644 index 00000000..cb1c6783 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputBotInlineResult.md b/old_docs/API_docs_v109/types/InputBotInlineResult.md new file mode 100644 index 00000000..0c8d79bc --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputChannel.md b/old_docs/API_docs_v109/types/InputChannel.md new file mode 100644 index 00000000..afa6f530 --- /dev/null +++ b/old_docs/API_docs_v109/types/InputChannel.md @@ -0,0 +1,48 @@ +--- +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 [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + +### Possible values (constructors): + +[inputChannelEmpty](../constructors/inputChannelEmpty.md) + +[inputChannel](../constructors/inputChannel.md) + +[inputChannelFromMessage](../constructors/inputChannelFromMessage.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputChatPhoto.md b/old_docs/API_docs_v109/types/InputChatPhoto.md new file mode 100644 index 00000000..4be81e67 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputCheckPasswordSRP.md b/old_docs/API_docs_v109/types/InputCheckPasswordSRP.md new file mode 100644 index 00000000..6e6db00e --- /dev/null +++ b/old_docs/API_docs_v109/types/InputCheckPasswordSRP.md @@ -0,0 +1,22 @@ +--- +title: InputCheckPasswordSRP +description: constructors and methods of type InputCheckPasswordSRP +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputCheckPasswordSRP +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputCheckPasswordEmpty](../constructors/inputCheckPasswordEmpty.md) + +[inputCheckPasswordSRP](../constructors/inputCheckPasswordSRP.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputClientProxy.md b/old_docs/API_docs_v109/types/InputClientProxy.md new file mode 100644 index 00000000..7897a91f --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputContact.md b/old_docs/API_docs_v109/types/InputContact.md new file mode 100644 index 00000000..10026e98 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputDialogPeer.md b/old_docs/API_docs_v109/types/InputDialogPeer.md new file mode 100644 index 00000000..e12a9144 --- /dev/null +++ b/old_docs/API_docs_v109/types/InputDialogPeer.md @@ -0,0 +1,46 @@ +--- +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) + + + +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: + +``` +$InputDialogPeer = '@username'; // Username + +$InputDialogPeer = 'me'; // The currently logged-in user + +$InputDialogPeer = 44700; // bot API id (users) +$InputDialogPeer = -492772765; // bot API id (chats) +$InputDialogPeer = -10038575794; // bot API id (channels) + +$InputDialogPeer = 'https://t.me/danogentili'; // t.me URLs +$InputDialogPeer = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$InputDialogPeer = 'user#44700'; // tg-cli style id (users) +$InputDialogPeer = 'chat#492772765'; // tg-cli style id (chats) +$InputDialogPeer = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + +### Possible values (constructors): + +[inputDialogPeer](../constructors/inputDialogPeer.md) + +[inputDialogPeerFolder](../constructors/inputDialogPeerFolder.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputDocument.md b/old_docs/API_docs_v109/types/InputDocument.md new file mode 100644 index 00000000..1227cd74 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputEncryptedChat.md b/old_docs/API_docs_v109/types/InputEncryptedChat.md new file mode 100644 index 00000000..14a4526e --- /dev/null +++ b/old_docs/API_docs_v109/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 requestSecretChat, 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_v109/types/InputEncryptedFile.md b/old_docs/API_docs_v109/types/InputEncryptedFile.md new file mode 100644 index 00000000..cd7f365f --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputFile.md b/old_docs/API_docs_v109/types/InputFile.md new file mode 100644 index 00000000..f76612de --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputFileLocation.md b/old_docs/API_docs_v109/types/InputFileLocation.md new file mode 100644 index 00000000..c855a312 --- /dev/null +++ b/old_docs/API_docs_v109/types/InputFileLocation.md @@ -0,0 +1,36 @@ +--- +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) + +[inputPhotoFileLocation](../constructors/inputPhotoFileLocation.md) + +[inputPhotoLegacyFileLocation](../constructors/inputPhotoLegacyFileLocation.md) + +[inputPeerPhotoFileLocation](../constructors/inputPeerPhotoFileLocation.md) + +[inputStickerSetThumb](../constructors/inputStickerSetThumb.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputFolderPeer.md b/old_docs/API_docs_v109/types/InputFolderPeer.md new file mode 100644 index 00000000..d974e496 --- /dev/null +++ b/old_docs/API_docs_v109/types/InputFolderPeer.md @@ -0,0 +1,20 @@ +--- +title: InputFolderPeer +description: constructors and methods of type InputFolderPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputFolderPeer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputFolderPeer](../constructors/inputFolderPeer.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputGame.md b/old_docs/API_docs_v109/types/InputGame.md new file mode 100644 index 00000000..604d23fc --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputGeoPoint.md b/old_docs/API_docs_v109/types/InputGeoPoint.md new file mode 100644 index 00000000..87ea6c09 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputMedia.md b/old_docs/API_docs_v109/types/InputMedia.md new file mode 100644 index 00000000..71104682 --- /dev/null +++ b/old_docs/API_docs_v109/types/InputMedia.md @@ -0,0 +1,50 @@ +--- +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) + +[inputMediaPoll](../constructors/inputMediaPoll.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputMessage.md b/old_docs/API_docs_v109/types/InputMessage.md new file mode 100644 index 00000000..075b4f04 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputNotifyPeer.md b/old_docs/API_docs_v109/types/InputNotifyPeer.md new file mode 100644 index 00000000..82042c5c --- /dev/null +++ b/old_docs/API_docs_v109/types/InputNotifyPeer.md @@ -0,0 +1,50 @@ +--- +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) + + + +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: + +``` +$InputNotifyPeer = '@username'; // Username + +$InputNotifyPeer = 'me'; // The currently logged-in user + +$InputNotifyPeer = 44700; // bot API id (users) +$InputNotifyPeer = -492772765; // bot API id (chats) +$InputNotifyPeer = -10038575794; // bot API id (channels) + +$InputNotifyPeer = 'https://t.me/danogentili'; // t.me URLs +$InputNotifyPeer = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$InputNotifyPeer = 'user#44700'; // tg-cli style id (users) +$InputNotifyPeer = 'chat#492772765'; // tg-cli style id (chats) +$InputNotifyPeer = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + +### Possible values (constructors): + +[inputNotifyPeer](../constructors/inputNotifyPeer.md) + +[inputNotifyUsers](../constructors/inputNotifyUsers.md) + +[inputNotifyChats](../constructors/inputNotifyChats.md) + +[inputNotifyBroadcasts](../constructors/inputNotifyBroadcasts.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputPaymentCredentials.md b/old_docs/API_docs_v109/types/InputPaymentCredentials.md new file mode 100644 index 00000000..78374c45 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputPeer.md b/old_docs/API_docs_v109/types/InputPeer.md new file mode 100644 index 00000000..6bcf3aa5 --- /dev/null +++ b/old_docs/API_docs_v109/types/InputPeer.md @@ -0,0 +1,56 @@ +--- +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 [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.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) + +[inputPeerUserFromMessage](../constructors/inputPeerUserFromMessage.md) + +[inputPeerChannelFromMessage](../constructors/inputPeerChannelFromMessage.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputPeerNotifySettings.md b/old_docs/API_docs_v109/types/InputPeerNotifySettings.md new file mode 100644 index 00000000..47645252 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputPhoneCall.md b/old_docs/API_docs_v109/types/InputPhoneCall.md new file mode 100644 index 00000000..3203aff9 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputPhoto.md b/old_docs/API_docs_v109/types/InputPhoto.md new file mode 100644 index 00000000..fbad241d --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputPrivacyKey.md b/old_docs/API_docs_v109/types/InputPrivacyKey.md new file mode 100644 index 00000000..4ac91cae --- /dev/null +++ b/old_docs/API_docs_v109/types/InputPrivacyKey.md @@ -0,0 +1,34 @@ +--- +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) + +[inputPrivacyKeyPhoneP2P](../constructors/inputPrivacyKeyPhoneP2P.md) + +[inputPrivacyKeyForwards](../constructors/inputPrivacyKeyForwards.md) + +[inputPrivacyKeyProfilePhoto](../constructors/inputPrivacyKeyProfilePhoto.md) + +[inputPrivacyKeyPhoneNumber](../constructors/inputPrivacyKeyPhoneNumber.md) + +[inputPrivacyKeyAddedByPhone](../constructors/inputPrivacyKeyAddedByPhone.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputPrivacyRule.md b/old_docs/API_docs_v109/types/InputPrivacyRule.md new file mode 100644 index 00000000..9788efba --- /dev/null +++ b/old_docs/API_docs_v109/types/InputPrivacyRule.md @@ -0,0 +1,34 @@ +--- +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) + +[inputPrivacyValueAllowChatParticipants](../constructors/inputPrivacyValueAllowChatParticipants.md) + +[inputPrivacyValueDisallowChatParticipants](../constructors/inputPrivacyValueDisallowChatParticipants.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputSecureFile.md b/old_docs/API_docs_v109/types/InputSecureFile.md new file mode 100644 index 00000000..1ee36428 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputSecureValue.md b/old_docs/API_docs_v109/types/InputSecureValue.md new file mode 100644 index 00000000..c99a7ab4 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputSingleMedia.md b/old_docs/API_docs_v109/types/InputSingleMedia.md new file mode 100644 index 00000000..db24c669 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputStickerSet.md b/old_docs/API_docs_v109/types/InputStickerSet.md new file mode 100644 index 00000000..48ca6f05 --- /dev/null +++ b/old_docs/API_docs_v109/types/InputStickerSet.md @@ -0,0 +1,26 @@ +--- +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) + +[inputStickerSetAnimatedEmoji](../constructors/inputStickerSetAnimatedEmoji.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputStickerSetItem.md b/old_docs/API_docs_v109/types/InputStickerSetItem.md new file mode 100644 index 00000000..da3e5a74 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputStickeredMedia.md b/old_docs/API_docs_v109/types/InputStickeredMedia.md new file mode 100644 index 00000000..a93a406a --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputTheme.md b/old_docs/API_docs_v109/types/InputTheme.md new file mode 100644 index 00000000..2e57bfc3 --- /dev/null +++ b/old_docs/API_docs_v109/types/InputTheme.md @@ -0,0 +1,22 @@ +--- +title: InputTheme +description: constructors and methods of type InputTheme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputTheme +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputTheme](../constructors/inputTheme.md) + +[inputThemeSlug](../constructors/inputThemeSlug.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputThemeSettings.md b/old_docs/API_docs_v109/types/InputThemeSettings.md new file mode 100644 index 00000000..2249b3e3 --- /dev/null +++ b/old_docs/API_docs_v109/types/InputThemeSettings.md @@ -0,0 +1,20 @@ +--- +title: InputThemeSettings +description: constructors and methods of type InputThemeSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputThemeSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputThemeSettings](../constructors/inputThemeSettings.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputUser.md b/old_docs/API_docs_v109/types/InputUser.md new file mode 100644 index 00000000..fb51b5d9 --- /dev/null +++ b/old_docs/API_docs_v109/types/InputUser.md @@ -0,0 +1,50 @@ +--- +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 [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.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) + +[inputUserFromMessage](../constructors/inputUserFromMessage.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputWallPaper.md b/old_docs/API_docs_v109/types/InputWallPaper.md new file mode 100644 index 00000000..fab6fbfe --- /dev/null +++ b/old_docs/API_docs_v109/types/InputWallPaper.md @@ -0,0 +1,24 @@ +--- +title: InputWallPaper +description: constructors and methods of type InputWallPaper +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: InputWallPaper +[Back to types index](index.md) + + + +### Possible values (constructors): + +[inputWallPaper](../constructors/inputWallPaper.md) + +[inputWallPaperSlug](../constructors/inputWallPaperSlug.md) + +[inputWallPaperNoFile](../constructors/inputWallPaperNoFile.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/InputWebDocument.md b/old_docs/API_docs_v109/types/InputWebDocument.md new file mode 100644 index 00000000..f6a5f1b2 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/InputWebFileLocation.md b/old_docs/API_docs_v109/types/InputWebFileLocation.md new file mode 100644 index 00000000..c5f2f476 --- /dev/null +++ b/old_docs/API_docs_v109/types/InputWebFileLocation.md @@ -0,0 +1,22 @@ +--- +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) + +[inputWebFileGeoPointLocation](../constructors/inputWebFileGeoPointLocation.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/Invoice.md b/old_docs/API_docs_v109/types/Invoice.md new file mode 100644 index 00000000..34f688e5 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/JSONObjectValue.md b/old_docs/API_docs_v109/types/JSONObjectValue.md new file mode 100644 index 00000000..408c4aaa --- /dev/null +++ b/old_docs/API_docs_v109/types/JSONObjectValue.md @@ -0,0 +1,20 @@ +--- +title: JSONObjectValue +description: constructors and methods of type JSONObjectValue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: JSONObjectValue +[Back to types index](index.md) + + + +### Possible values (constructors): + +[jsonObjectValue](../constructors/jsonObjectValue.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/JSONValue.md b/old_docs/API_docs_v109/types/JSONValue.md new file mode 100644 index 00000000..83527ab0 --- /dev/null +++ b/old_docs/API_docs_v109/types/JSONValue.md @@ -0,0 +1,32 @@ +--- +title: JSONValue +description: constructors and methods of type JSONValue +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: JSONValue +[Back to types index](index.md) + + + +### Possible values (constructors): + +[jsonNull](../constructors/jsonNull.md) + +[jsonBool](../constructors/jsonBool.md) + +[jsonNumber](../constructors/jsonNumber.md) + +[jsonString](../constructors/jsonString.md) + +[jsonArray](../constructors/jsonArray.md) + +[jsonObject](../constructors/jsonObject.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getAppConfig](../methods/help.getAppConfig.md) + + + diff --git a/old_docs/API_docs_v109/types/KeyboardButton.md b/old_docs/API_docs_v109/types/KeyboardButton.md new file mode 100644 index 00000000..1c29eca6 --- /dev/null +++ b/old_docs/API_docs_v109/types/KeyboardButton.md @@ -0,0 +1,61 @@ +--- +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) + +[keyboardButtonUrlAuth](../constructors/keyboardButtonUrlAuth.md) + +[inputKeyboardButtonUrlAuth](../constructors/inputKeyboardButtonUrlAuth.md) + +[keyboardButtonRequestPoll](../constructors/keyboardButtonRequestPoll.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/KeyboardButtonRow.md b/old_docs/API_docs_v109/types/KeyboardButtonRow.md new file mode 100644 index 00000000..03bf724e --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/LabeledPrice.md b/old_docs/API_docs_v109/types/LabeledPrice.md new file mode 100644 index 00000000..c2c91c3a --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/LangPackDifference.md b/old_docs/API_docs_v109/types/LangPackDifference.md new file mode 100644 index 00000000..e04125b8 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/LangPackLanguage.md b/old_docs/API_docs_v109/types/LangPackLanguage.md new file mode 100644 index 00000000..74c7172d --- /dev/null +++ b/old_docs/API_docs_v109/types/LangPackLanguage.md @@ -0,0 +1,24 @@ +--- +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) + +[$MadelineProto->langpack->getLanguage](../methods/langpack.getLanguage.md) + + + diff --git a/old_docs/API_docs_v109/types/LangPackString.md b/old_docs/API_docs_v109/types/LangPackString.md new file mode 100644 index 00000000..15f9dc3d --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/MaskCoords.md b/old_docs/API_docs_v109/types/MaskCoords.md new file mode 100644 index 00000000..23d9fa75 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/Message.md b/old_docs/API_docs_v109/types/Message.md new file mode 100644 index 00000000..b306c73c --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/MessageAction.md b/old_docs/API_docs_v109/types/MessageAction.md new file mode 100644 index 00000000..979938c8 --- /dev/null +++ b/old_docs/API_docs_v109/types/MessageAction.md @@ -0,0 +1,64 @@ +--- +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) + +[messageActionContactSignUp](../constructors/messageActionContactSignUp.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/MessageEntity.md b/old_docs/API_docs_v109/types/MessageEntity.md new file mode 100644 index 00000000..71757338 --- /dev/null +++ b/old_docs/API_docs_v109/types/MessageEntity.md @@ -0,0 +1,54 @@ +--- +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) + +[messageEntityUnderline](../constructors/messageEntityUnderline.md) + +[messageEntityStrike](../constructors/messageEntityStrike.md) + +[messageEntityBlockquote](../constructors/messageEntityBlockquote.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/MessageFwdHeader.md b/old_docs/API_docs_v109/types/MessageFwdHeader.md new file mode 100644 index 00000000..aa92c6a5 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/MessageMedia.md b/old_docs/API_docs_v109/types/MessageMedia.md new file mode 100644 index 00000000..36602552 --- /dev/null +++ b/old_docs/API_docs_v109/types/MessageMedia.md @@ -0,0 +1,46 @@ +--- +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) + +[messageMediaPoll](../constructors/messageMediaPoll.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_v109/types/MessageRange.md b/old_docs/API_docs_v109/types/MessageRange.md new file mode 100644 index 00000000..ffd65e90 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/MessageUserVote.md b/old_docs/API_docs_v109/types/MessageUserVote.md new file mode 100644 index 00000000..5d17cedc --- /dev/null +++ b/old_docs/API_docs_v109/types/MessageUserVote.md @@ -0,0 +1,24 @@ +--- +title: MessageUserVote +description: constructors and methods of type MessageUserVote +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: MessageUserVote +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messageUserVote](../constructors/messageUserVote.md) + +[messageUserVoteInputOption](../constructors/messageUserVoteInputOption.md) + +[messageUserVoteMultiple](../constructors/messageUserVoteMultiple.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/MessagesFilter.md b/old_docs/API_docs_v109/types/MessagesFilter.md new file mode 100644 index 00000000..117fbfe3 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/NearestDc.md b/old_docs/API_docs_v109/types/NearestDc.md new file mode 100644 index 00000000..296a4dff --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/NotifyPeer.md b/old_docs/API_docs_v109/types/NotifyPeer.md new file mode 100644 index 00000000..5af09840 --- /dev/null +++ b/old_docs/API_docs_v109/types/NotifyPeer.md @@ -0,0 +1,50 @@ +--- +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) + + + +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: + +``` +$NotifyPeer = '@username'; // Username + +$NotifyPeer = 'me'; // The currently logged-in user + +$NotifyPeer = 44700; // bot API id (users) +$NotifyPeer = -492772765; // bot API id (chats) +$NotifyPeer = -10038575794; // bot API id (channels) + +$NotifyPeer = 'https://t.me/danogentili'; // t.me URLs +$NotifyPeer = 'https://t.me/joinchat/asfln1-21fa_'; // t.me invite links + +$NotifyPeer = 'user#44700'; // tg-cli style id (users) +$NotifyPeer = 'chat#492772765'; // tg-cli style id (chats) +$NotifyPeer = 'channel#38575794'; // tg-cli style id (channels) +``` + +A [Chat](Chat.md), a [User](User.md), an [InputPeer](InputPeer.md), an [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.md), or a [Chat](Chat.md) object can also be used. + + +### Possible values (constructors): + +[notifyPeer](../constructors/notifyPeer.md) + +[notifyUsers](../constructors/notifyUsers.md) + +[notifyChats](../constructors/notifyChats.md) + +[notifyBroadcasts](../constructors/notifyBroadcasts.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/Null.md b/old_docs/API_docs_v109/types/Null.md new file mode 100644 index 00000000..58d38809 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/Page.md b/old_docs/API_docs_v109/types/Page.md new file mode 100644 index 00000000..cb473261 --- /dev/null +++ b/old_docs/API_docs_v109/types/Page.md @@ -0,0 +1,20 @@ +--- +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): + +[page](../constructors/page.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PageBlock.md b/old_docs/API_docs_v109/types/PageBlock.md new file mode 100644 index 00000000..769c5a9e --- /dev/null +++ b/old_docs/API_docs_v109/types/PageBlock.md @@ -0,0 +1,76 @@ +--- +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) + +[pageBlockKicker](../constructors/pageBlockKicker.md) + +[pageBlockTable](../constructors/pageBlockTable.md) + +[pageBlockOrderedList](../constructors/pageBlockOrderedList.md) + +[pageBlockDetails](../constructors/pageBlockDetails.md) + +[pageBlockRelatedArticles](../constructors/pageBlockRelatedArticles.md) + +[pageBlockMap](../constructors/pageBlockMap.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PageCaption.md b/old_docs/API_docs_v109/types/PageCaption.md new file mode 100644 index 00000000..e70c51f4 --- /dev/null +++ b/old_docs/API_docs_v109/types/PageCaption.md @@ -0,0 +1,20 @@ +--- +title: PageCaption +description: constructors and methods of type PageCaption +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageCaption +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageCaption](../constructors/pageCaption.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PageListItem.md b/old_docs/API_docs_v109/types/PageListItem.md new file mode 100644 index 00000000..f7f3294e --- /dev/null +++ b/old_docs/API_docs_v109/types/PageListItem.md @@ -0,0 +1,22 @@ +--- +title: PageListItem +description: constructors and methods of type PageListItem +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageListItem +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageListItemText](../constructors/pageListItemText.md) + +[pageListItemBlocks](../constructors/pageListItemBlocks.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PageListOrderedItem.md b/old_docs/API_docs_v109/types/PageListOrderedItem.md new file mode 100644 index 00000000..559ae9cb --- /dev/null +++ b/old_docs/API_docs_v109/types/PageListOrderedItem.md @@ -0,0 +1,22 @@ +--- +title: PageListOrderedItem +description: constructors and methods of type PageListOrderedItem +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageListOrderedItem +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageListOrderedItemText](../constructors/pageListOrderedItemText.md) + +[pageListOrderedItemBlocks](../constructors/pageListOrderedItemBlocks.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PageRelatedArticle.md b/old_docs/API_docs_v109/types/PageRelatedArticle.md new file mode 100644 index 00000000..c7baf985 --- /dev/null +++ b/old_docs/API_docs_v109/types/PageRelatedArticle.md @@ -0,0 +1,20 @@ +--- +title: PageRelatedArticle +description: constructors and methods of type PageRelatedArticle +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageRelatedArticle +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageRelatedArticle](../constructors/pageRelatedArticle.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PageTableCell.md b/old_docs/API_docs_v109/types/PageTableCell.md new file mode 100644 index 00000000..59e930df --- /dev/null +++ b/old_docs/API_docs_v109/types/PageTableCell.md @@ -0,0 +1,20 @@ +--- +title: PageTableCell +description: constructors and methods of type PageTableCell +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageTableCell +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageTableCell](../constructors/pageTableCell.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PageTableRow.md b/old_docs/API_docs_v109/types/PageTableRow.md new file mode 100644 index 00000000..c0f21686 --- /dev/null +++ b/old_docs/API_docs_v109/types/PageTableRow.md @@ -0,0 +1,20 @@ +--- +title: PageTableRow +description: constructors and methods of type PageTableRow +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PageTableRow +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pageTableRow](../constructors/pageTableRow.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PasswordKdfAlgo.md b/old_docs/API_docs_v109/types/PasswordKdfAlgo.md new file mode 100644 index 00000000..b74719fb --- /dev/null +++ b/old_docs/API_docs_v109/types/PasswordKdfAlgo.md @@ -0,0 +1,22 @@ +--- +title: PasswordKdfAlgo +description: constructors and methods of type PasswordKdfAlgo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PasswordKdfAlgo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[passwordKdfAlgoUnknown](../constructors/passwordKdfAlgoUnknown.md) + +[passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow](../constructors/passwordKdfAlgoSHA256SHA256PBKDF2HMACSHA512iter100000SHA256ModPow.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PaymentCharge.md b/old_docs/API_docs_v109/types/PaymentCharge.md new file mode 100644 index 00000000..9cb17085 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/PaymentRequestedInfo.md b/old_docs/API_docs_v109/types/PaymentRequestedInfo.md new file mode 100644 index 00000000..2f119ef3 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/PaymentSavedCredentials.md b/old_docs/API_docs_v109/types/PaymentSavedCredentials.md new file mode 100644 index 00000000..8a2ae849 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/Peer.md b/old_docs/API_docs_v109/types/Peer.md new file mode 100644 index 00000000..ebb98e91 --- /dev/null +++ b/old_docs/API_docs_v109/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 [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.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_v109/types/PeerLocated.md b/old_docs/API_docs_v109/types/PeerLocated.md new file mode 100644 index 00000000..0163a506 --- /dev/null +++ b/old_docs/API_docs_v109/types/PeerLocated.md @@ -0,0 +1,20 @@ +--- +title: PeerLocated +description: constructors and methods of type PeerLocated +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PeerLocated +[Back to types index](index.md) + + + +### Possible values (constructors): + +[peerLocated](../constructors/peerLocated.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PeerNotifySettings.md b/old_docs/API_docs_v109/types/PeerNotifySettings.md new file mode 100644 index 00000000..d3b4833c --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/PeerSettings.md b/old_docs/API_docs_v109/types/PeerSettings.md new file mode 100644 index 00000000..31ef7e38 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/PhoneCall.md b/old_docs/API_docs_v109/types/PhoneCall.md new file mode 100644 index 00000000..64d95972 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/PhoneCallDiscardReason.md b/old_docs/API_docs_v109/types/PhoneCallDiscardReason.md new file mode 100644 index 00000000..cbf9ff9c --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/PhoneCallProtocol.md b/old_docs/API_docs_v109/types/PhoneCallProtocol.md new file mode 100644 index 00000000..eb9cbd49 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/PhoneConnection.md b/old_docs/API_docs_v109/types/PhoneConnection.md new file mode 100644 index 00000000..a62f147f --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/Photo.md b/old_docs/API_docs_v109/types/Photo.md new file mode 100644 index 00000000..7cd6e713 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/PhotoSize.md b/old_docs/API_docs_v109/types/PhotoSize.md new file mode 100644 index 00000000..503db932 --- /dev/null +++ b/old_docs/API_docs_v109/types/PhotoSize.md @@ -0,0 +1,26 @@ +--- +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) + +[photoStrippedSize](../constructors/photoStrippedSize.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/Poll.md b/old_docs/API_docs_v109/types/Poll.md new file mode 100644 index 00000000..71131ae6 --- /dev/null +++ b/old_docs/API_docs_v109/types/Poll.md @@ -0,0 +1,20 @@ +--- +title: Poll +description: constructors and methods of type Poll +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Poll +[Back to types index](index.md) + + + +### Possible values (constructors): + +[poll](../constructors/poll.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PollAnswer.md b/old_docs/API_docs_v109/types/PollAnswer.md new file mode 100644 index 00000000..d7778119 --- /dev/null +++ b/old_docs/API_docs_v109/types/PollAnswer.md @@ -0,0 +1,20 @@ +--- +title: PollAnswer +description: constructors and methods of type PollAnswer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PollAnswer +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pollAnswer](../constructors/pollAnswer.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PollAnswerVoters.md b/old_docs/API_docs_v109/types/PollAnswerVoters.md new file mode 100644 index 00000000..78a14260 --- /dev/null +++ b/old_docs/API_docs_v109/types/PollAnswerVoters.md @@ -0,0 +1,20 @@ +--- +title: PollAnswerVoters +description: constructors and methods of type PollAnswerVoters +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PollAnswerVoters +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pollAnswerVoters](../constructors/pollAnswerVoters.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PollResults.md b/old_docs/API_docs_v109/types/PollResults.md new file mode 100644 index 00000000..68d2a9dd --- /dev/null +++ b/old_docs/API_docs_v109/types/PollResults.md @@ -0,0 +1,20 @@ +--- +title: PollResults +description: constructors and methods of type PollResults +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: PollResults +[Back to types index](index.md) + + + +### Possible values (constructors): + +[pollResults](../constructors/pollResults.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PopularContact.md b/old_docs/API_docs_v109/types/PopularContact.md new file mode 100644 index 00000000..5d61b85d --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/PostAddress.md b/old_docs/API_docs_v109/types/PostAddress.md new file mode 100644 index 00000000..1715112d --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/PrivacyKey.md b/old_docs/API_docs_v109/types/PrivacyKey.md new file mode 100644 index 00000000..2e170a8b --- /dev/null +++ b/old_docs/API_docs_v109/types/PrivacyKey.md @@ -0,0 +1,34 @@ +--- +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) + +[privacyKeyPhoneP2P](../constructors/privacyKeyPhoneP2P.md) + +[privacyKeyForwards](../constructors/privacyKeyForwards.md) + +[privacyKeyProfilePhoto](../constructors/privacyKeyProfilePhoto.md) + +[privacyKeyPhoneNumber](../constructors/privacyKeyPhoneNumber.md) + +[privacyKeyAddedByPhone](../constructors/privacyKeyAddedByPhone.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/PrivacyRule.md b/old_docs/API_docs_v109/types/PrivacyRule.md new file mode 100644 index 00000000..f8dc1cc7 --- /dev/null +++ b/old_docs/API_docs_v109/types/PrivacyRule.md @@ -0,0 +1,34 @@ +--- +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) + +[privacyValueAllowChatParticipants](../constructors/privacyValueAllowChatParticipants.md) + +[privacyValueDisallowChatParticipants](../constructors/privacyValueDisallowChatParticipants.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/README.md b/old_docs/API_docs_v109/types/README.md new file mode 100644 index 00000000..8973d287 --- /dev/null +++ b/old_docs/API_docs_v109/types/README.md @@ -0,0 +1,567 @@ +--- +title: Types +description: List of types +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Types +[Back to API documentation index](..) + + +[AccountDaysTTL](AccountDaysTTL.md) + +[Authorization](Authorization.md) + +[AutoDownloadSettings](AutoDownloadSettings.md) + +[BaseTheme](BaseTheme.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) + +[ChannelLocation](ChannelLocation.md) + +[ChannelMessagesFilter](ChannelMessagesFilter.md) + +[ChannelParticipant](ChannelParticipant.md) + +[ChannelParticipantsFilter](ChannelParticipantsFilter.md) + +[Chat](Chat.md) + +[ChatAdminRights](ChatAdminRights.md) + +[ChatBannedRights](ChatBannedRights.md) + +[ChatFull](ChatFull.md) + +[ChatInvite](ChatInvite.md) + +[ChatOnlines](ChatOnlines.md) + +[ChatParticipant](ChatParticipant.md) + +[ChatParticipants](ChatParticipants.md) + +[ChatPhoto](ChatPhoto.md) + +[CodeSettings](CodeSettings.md) + +[Config](Config.md) + +[Contact](Contact.md) + +[ContactBlocked](ContactBlocked.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) + +[EmojiKeyword](EmojiKeyword.md) + +[EmojiKeywordsDifference](EmojiKeywordsDifference.md) + +[EmojiLanguage](EmojiLanguage.md) + +[EmojiURL](EmojiURL.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) + +[Folder](Folder.md) + +[FolderPeer](FolderPeer.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) + +[InputCheckPasswordSRP](InputCheckPasswordSRP.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) + +[InputFolderPeer](InputFolderPeer.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) + +[InputTheme](InputTheme.md) + +[InputThemeSettings](InputThemeSettings.md) + +[InputUser](InputUser.md) + +[InputWallPaper](InputWallPaper.md) + +[InputWebDocument](InputWebDocument.md) + +[InputWebFileLocation](InputWebFileLocation.md) + +[Invoice](Invoice.md) + +[JSONObjectValue](JSONObjectValue.md) + +[JSONValue](JSONValue.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) + +[MessageUserVote](MessageUserVote.md) + +[MessagesFilter](MessagesFilter.md) + +[NearestDc](NearestDc.md) + +[NotifyPeer](NotifyPeer.md) + +[Null](Null.md) + +[Page](Page.md) + +[PageBlock](PageBlock.md) + +[PageCaption](PageCaption.md) + +[PageListItem](PageListItem.md) + +[PageListOrderedItem](PageListOrderedItem.md) + +[PageRelatedArticle](PageRelatedArticle.md) + +[PageTableCell](PageTableCell.md) + +[PageTableRow](PageTableRow.md) + +[PasswordKdfAlgo](PasswordKdfAlgo.md) + +[PaymentCharge](PaymentCharge.md) + +[PaymentRequestedInfo](PaymentRequestedInfo.md) + +[PaymentSavedCredentials](PaymentSavedCredentials.md) + +[Peer](Peer.md) + +[PeerLocated](PeerLocated.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) + +[Poll](Poll.md) + +[PollAnswer](PollAnswer.md) + +[PollAnswerVoters](PollAnswerVoters.md) + +[PollResults](PollResults.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) + +[RestrictionReason](RestrictionReason.md) + +[RichText](RichText.md) + +[SavedContact](SavedContact.md) + +[SecureCredentialsEncrypted](SecureCredentialsEncrypted.md) + +[SecureData](SecureData.md) + +[SecureFile](SecureFile.md) + +[SecurePasswordKdfAlgo](SecurePasswordKdfAlgo.md) + +[SecurePlainData](SecurePlainData.md) + +[SecureRequiredType](SecureRequiredType.md) + +[SecureSecretSettings](SecureSecretSettings.md) + +[SecureValue](SecureValue.md) + +[SecureValueError](SecureValueError.md) + +[SecureValueHash](SecureValueHash.md) + +[SecureValueType](SecureValueType.md) + +[SendMessageAction](SendMessageAction.md) + +[ShippingOption](ShippingOption.md) + +[StatsURL](StatsURL.md) + +[StickerPack](StickerPack.md) + +[StickerSet](StickerSet.md) + +[StickerSetCovered](StickerSetCovered.md) + +[Theme](Theme.md) + +[ThemeSettings](ThemeSettings.md) + +[TopPeer](TopPeer.md) + +[TopPeerCategory](TopPeerCategory.md) + +[TopPeerCategoryPeers](TopPeerCategoryPeers.md) + +[True](True.md) + +[Update](Update.md) + +[Updates](Updates.md) + +[UrlAuthResult](UrlAuthResult.md) + +[User](User.md) + +[UserFull](UserFull.md) + +[UserProfilePhoto](UserProfilePhoto.md) + +[UserStatus](UserStatus.md) + +[WallPaper](WallPaper.md) + +[WallPaperSettings](WallPaperSettings.md) + +[WebAuthorization](WebAuthorization.md) + +[WebDocument](WebDocument.md) + +[WebPage](WebPage.md) + +[WebPageAttribute](WebPageAttribute.md) + +[X](X.md) + +[account.AuthorizationForm](account.AuthorizationForm.md) + +[account.Authorizations](account.Authorizations.md) + +[account.AutoDownloadSettings](account.AutoDownloadSettings.md) + +[account.ContentSettings](account.ContentSettings.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.Themes](account.Themes.md) + +[account.TmpPassword](account.TmpPassword.md) + +[account.WallPapers](account.WallPapers.md) + +[account.WebAuthorizations](account.WebAuthorizations.md) + +[auth.Authorization](auth.Authorization.md) + +[auth.CodeType](auth.CodeType.md) + +[auth.ExportedAuthorization](auth.ExportedAuthorization.md) + +[auth.LoginToken](auth.LoginToken.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.ResolvedPeer](contacts.ResolvedPeer.md) + +[contacts.TopPeers](contacts.TopPeers.md) + +[help.AppUpdate](help.AppUpdate.md) + +[help.DeepLinkInfo](help.DeepLinkInfo.md) + +[help.InviteText](help.InviteText.md) + +[help.PassportConfig](help.PassportConfig.md) + +[help.ProxyData](help.ProxyData.md) + +[help.RecentMeUrls](help.RecentMeUrls.md) + +[help.Support](help.Support.md) + +[help.SupportName](help.SupportName.md) + +[help.TermsOfService](help.TermsOfService.md) + +[help.TermsOfServiceUpdate](help.TermsOfServiceUpdate.md) + +[help.UserInfo](help.UserInfo.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.InactiveChats](messages.InactiveChats.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.SearchCounter](messages.SearchCounter.md) + +[messages.SentEncryptedMessage](messages.SentEncryptedMessage.md) + +[messages.StickerSet](messages.StickerSet.md) + +[messages.StickerSetInstallResult](messages.StickerSetInstallResult.md) + +[messages.Stickers](messages.Stickers.md) + +[messages.VotesList](messages.VotesList.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_v109/types/ReceivedNotifyMessage.md b/old_docs/API_docs_v109/types/ReceivedNotifyMessage.md new file mode 100644 index 00000000..416aa275 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/RecentMeUrl.md b/old_docs/API_docs_v109/types/RecentMeUrl.md new file mode 100644 index 00000000..4fd43199 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ReplyMarkup.md b/old_docs/API_docs_v109/types/ReplyMarkup.md new file mode 100644 index 00000000..a1f5f21d --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ReportReason.md b/old_docs/API_docs_v109/types/ReportReason.md new file mode 100644 index 00000000..bee56f54 --- /dev/null +++ b/old_docs/API_docs_v109/types/ReportReason.md @@ -0,0 +1,32 @@ +--- +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) + +[inputReportReasonChildAbuse](../constructors/inputReportReasonChildAbuse.md) + +[inputReportReasonOther](../constructors/inputReportReasonOther.md) + +[inputReportReasonCopyright](../constructors/inputReportReasonCopyright.md) + +[inputReportReasonGeoIrrelevant](../constructors/inputReportReasonGeoIrrelevant.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/RestrictionReason.md b/old_docs/API_docs_v109/types/RestrictionReason.md new file mode 100644 index 00000000..bcb18c14 --- /dev/null +++ b/old_docs/API_docs_v109/types/RestrictionReason.md @@ -0,0 +1,20 @@ +--- +title: RestrictionReason +description: constructors and methods of type RestrictionReason +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: RestrictionReason +[Back to types index](index.md) + + + +### Possible values (constructors): + +[restrictionReason](../constructors/restrictionReason.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/RichText.md b/old_docs/API_docs_v109/types/RichText.md new file mode 100644 index 00000000..26a73266 --- /dev/null +++ b/old_docs/API_docs_v109/types/RichText.md @@ -0,0 +1,50 @@ +--- +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) + +[textSubscript](../constructors/textSubscript.md) + +[textSuperscript](../constructors/textSuperscript.md) + +[textMarked](../constructors/textMarked.md) + +[textPhone](../constructors/textPhone.md) + +[textImage](../constructors/textImage.md) + +[textAnchor](../constructors/textAnchor.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/SavedContact.md b/old_docs/API_docs_v109/types/SavedContact.md new file mode 100644 index 00000000..73a91ba6 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/SecureCredentialsEncrypted.md b/old_docs/API_docs_v109/types/SecureCredentialsEncrypted.md new file mode 100644 index 00000000..b3f45428 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/SecureData.md b/old_docs/API_docs_v109/types/SecureData.md new file mode 100644 index 00000000..54ebc5fd --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/SecureFile.md b/old_docs/API_docs_v109/types/SecureFile.md new file mode 100644 index 00000000..989d8522 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/SecurePasswordKdfAlgo.md b/old_docs/API_docs_v109/types/SecurePasswordKdfAlgo.md new file mode 100644 index 00000000..785646bc --- /dev/null +++ b/old_docs/API_docs_v109/types/SecurePasswordKdfAlgo.md @@ -0,0 +1,24 @@ +--- +title: SecurePasswordKdfAlgo +description: constructors and methods of type SecurePasswordKdfAlgo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecurePasswordKdfAlgo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[securePasswordKdfAlgoUnknown](../constructors/securePasswordKdfAlgoUnknown.md) + +[securePasswordKdfAlgoPBKDF2HMACSHA512iter100000](../constructors/securePasswordKdfAlgoPBKDF2HMACSHA512iter100000.md) + +[securePasswordKdfAlgoSHA512](../constructors/securePasswordKdfAlgoSHA512.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/SecurePlainData.md b/old_docs/API_docs_v109/types/SecurePlainData.md new file mode 100644 index 00000000..7fe1c49c --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/SecureRequiredType.md b/old_docs/API_docs_v109/types/SecureRequiredType.md new file mode 100644 index 00000000..d313489f --- /dev/null +++ b/old_docs/API_docs_v109/types/SecureRequiredType.md @@ -0,0 +1,22 @@ +--- +title: SecureRequiredType +description: constructors and methods of type SecureRequiredType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureRequiredType +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureRequiredType](../constructors/secureRequiredType.md) + +[secureRequiredTypeOneOf](../constructors/secureRequiredTypeOneOf.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/SecureSecretSettings.md b/old_docs/API_docs_v109/types/SecureSecretSettings.md new file mode 100644 index 00000000..011c1a6f --- /dev/null +++ b/old_docs/API_docs_v109/types/SecureSecretSettings.md @@ -0,0 +1,20 @@ +--- +title: SecureSecretSettings +description: constructors and methods of type SecureSecretSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: SecureSecretSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[secureSecretSettings](../constructors/secureSecretSettings.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/SecureValue.md b/old_docs/API_docs_v109/types/SecureValue.md new file mode 100644 index 00000000..2ab18f68 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/SecureValueError.md b/old_docs/API_docs_v109/types/SecureValueError.md new file mode 100644 index 00000000..d9f9d3cd --- /dev/null +++ b/old_docs/API_docs_v109/types/SecureValueError.md @@ -0,0 +1,36 @@ +--- +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) + +[secureValueError](../constructors/secureValueError.md) + +[secureValueErrorTranslationFile](../constructors/secureValueErrorTranslationFile.md) + +[secureValueErrorTranslationFiles](../constructors/secureValueErrorTranslationFiles.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/SecureValueHash.md b/old_docs/API_docs_v109/types/SecureValueHash.md new file mode 100644 index 00000000..4857148c --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/SecureValueType.md b/old_docs/API_docs_v109/types/SecureValueType.md new file mode 100644 index 00000000..740cbf51 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/SendMessageAction.md b/old_docs/API_docs_v109/types/SendMessageAction.md new file mode 100644 index 00000000..8826af78 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/ShippingOption.md b/old_docs/API_docs_v109/types/ShippingOption.md new file mode 100644 index 00000000..57847fe1 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/StatsURL.md b/old_docs/API_docs_v109/types/StatsURL.md new file mode 100644 index 00000000..8704eed7 --- /dev/null +++ b/old_docs/API_docs_v109/types/StatsURL.md @@ -0,0 +1,22 @@ +--- +title: StatsURL +description: constructors and methods of type StatsURL +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: StatsURL +[Back to types index](index.md) + + + +### Possible values (constructors): + +[statsURL](../constructors/statsURL.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getStatsURL](../methods/messages.getStatsURL.md) + + + diff --git a/old_docs/API_docs_v109/types/StickerPack.md b/old_docs/API_docs_v109/types/StickerPack.md new file mode 100644 index 00000000..ffb83b15 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/StickerSet.md b/old_docs/API_docs_v109/types/StickerSet.md new file mode 100644 index 00000000..70aa63dc --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/StickerSetCovered.md b/old_docs/API_docs_v109/types/StickerSetCovered.md new file mode 100644 index 00000000..f57cd117 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/Theme.md b/old_docs/API_docs_v109/types/Theme.md new file mode 100644 index 00000000..59cc3bc7 --- /dev/null +++ b/old_docs/API_docs_v109/types/Theme.md @@ -0,0 +1,26 @@ +--- +title: Theme +description: constructors and methods of type Theme +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: Theme +[Back to types index](index.md) + + + +### Possible values (constructors): + +[theme](../constructors/theme.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->createTheme](../methods/account.createTheme.md) + +[$MadelineProto->account->updateTheme](../methods/account.updateTheme.md) + +[$MadelineProto->account->getTheme](../methods/account.getTheme.md) + + + diff --git a/old_docs/API_docs_v109/types/ThemeSettings.md b/old_docs/API_docs_v109/types/ThemeSettings.md new file mode 100644 index 00000000..accdb223 --- /dev/null +++ b/old_docs/API_docs_v109/types/ThemeSettings.md @@ -0,0 +1,20 @@ +--- +title: ThemeSettings +description: constructors and methods of type ThemeSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: ThemeSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[themeSettings](../constructors/themeSettings.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/TopPeer.md b/old_docs/API_docs_v109/types/TopPeer.md new file mode 100644 index 00000000..ff51630a --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/TopPeerCategory.md b/old_docs/API_docs_v109/types/TopPeerCategory.md new file mode 100644 index 00000000..835a4338 --- /dev/null +++ b/old_docs/API_docs_v109/types/TopPeerCategory.md @@ -0,0 +1,34 @@ +--- +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) + +[topPeerCategoryForwardUsers](../constructors/topPeerCategoryForwardUsers.md) + +[topPeerCategoryForwardChats](../constructors/topPeerCategoryForwardChats.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/TopPeerCategoryPeers.md b/old_docs/API_docs_v109/types/TopPeerCategoryPeers.md new file mode 100644 index 00000000..9fe37e57 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/True.md b/old_docs/API_docs_v109/types/True.md new file mode 100644 index 00000000..ea96d248 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/Update.md b/old_docs/API_docs_v109/types/Update.md new file mode 100644 index 00000000..71810ae9 --- /dev/null +++ b/old_docs/API_docs_v109/types/Update.md @@ -0,0 +1,172 @@ +--- +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) + +[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) + +[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) + +[updateDialogUnreadMark](../constructors/updateDialogUnreadMark.md) + +[updateUserPinnedMessage](../constructors/updateUserPinnedMessage.md) + +[updateChatPinnedMessage](../constructors/updateChatPinnedMessage.md) + +[updateMessagePoll](../constructors/updateMessagePoll.md) + +[updateChatDefaultBannedRights](../constructors/updateChatDefaultBannedRights.md) + +[updateFolderPeers](../constructors/updateFolderPeers.md) + +[updatePeerSettings](../constructors/updatePeerSettings.md) + +[updatePeerLocated](../constructors/updatePeerLocated.md) + +[updateNewScheduledMessage](../constructors/updateNewScheduledMessage.md) + +[updateDeleteScheduledMessages](../constructors/updateDeleteScheduledMessages.md) + +[updateTheme](../constructors/updateTheme.md) + +[updateGeoLiveViewed](../constructors/updateGeoLiveViewed.md) + +[updateLoginToken](../constructors/updateLoginToken.md) + +[updateMessagePollVote](../constructors/updateMessagePollVote.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/Updates.md b/old_docs/API_docs_v109/types/Updates.md new file mode 100644 index 00000000..b856ba58 --- /dev/null +++ b/old_docs/API_docs_v109/types/Updates.md @@ -0,0 +1,124 @@ +--- +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->account->getNotifyExceptions](../methods/account.getNotifyExceptions.md) + +[$MadelineProto->contacts->deleteContacts](../methods/contacts.deleteContacts.md) + +[$MadelineProto->contacts->addContact](../methods/contacts.addContact.md) + +[$MadelineProto->contacts->acceptContact](../methods/contacts.acceptContact.md) + +[$MadelineProto->contacts->getLocated](../methods/contacts.getLocated.md) + +[$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->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->messages->updatePinnedMessage](../methods/messages.updatePinnedMessage.md) + +[$MadelineProto->messages->sendVote](../methods/messages.sendVote.md) + +[$MadelineProto->messages->getPollResults](../methods/messages.getPollResults.md) + +[$MadelineProto->messages->editChatDefaultBannedRights](../methods/messages.editChatDefaultBannedRights.md) + +[$MadelineProto->messages->sendScheduledMessages](../methods/messages.sendScheduledMessages.md) + +[$MadelineProto->messages->deleteScheduledMessages](../methods/messages.deleteScheduledMessages.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->toggleSignatures](../methods/channels.toggleSignatures.md) + +[$MadelineProto->channels->editBanned](../methods/channels.editBanned.md) + +[$MadelineProto->channels->togglePreHistoryHidden](../methods/channels.togglePreHistoryHidden.md) + +[$MadelineProto->channels->editCreator](../methods/channels.editCreator.md) + +[$MadelineProto->channels->toggleSlowMode](../methods/channels.toggleSlowMode.md) + +[$MadelineProto->phone->discardCall](../methods/phone.discardCall.md) + +[$MadelineProto->phone->setCallRating](../methods/phone.setCallRating.md) + +[$MadelineProto->folders->editPeerFolders](../methods/folders.editPeerFolders.md) + +[$MadelineProto->folders->deleteFolder](../methods/folders.deleteFolder.md) + + + diff --git a/old_docs/API_docs_v109/types/UrlAuthResult.md b/old_docs/API_docs_v109/types/UrlAuthResult.md new file mode 100644 index 00000000..9533c912 --- /dev/null +++ b/old_docs/API_docs_v109/types/UrlAuthResult.md @@ -0,0 +1,28 @@ +--- +title: UrlAuthResult +description: constructors and methods of type UrlAuthResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: UrlAuthResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[urlAuthResultRequest](../constructors/urlAuthResultRequest.md) + +[urlAuthResultAccepted](../constructors/urlAuthResultAccepted.md) + +[urlAuthResultDefault](../constructors/urlAuthResultDefault.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->requestUrlAuth](../methods/messages.requestUrlAuth.md) + +[$MadelineProto->messages->acceptUrlAuth](../methods/messages.acceptUrlAuth.md) + + + diff --git a/old_docs/API_docs_v109/types/User.md b/old_docs/API_docs_v109/types/User.md new file mode 100644 index 00000000..0d20e320 --- /dev/null +++ b/old_docs/API_docs_v109/types/User.md @@ -0,0 +1,54 @@ +--- +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 [InputDialogPeer](InputDialogPeer.md), an [InputNotifyPeer](InputNotifyPeer.md), an [InputUser](InputUser.md), an [InputChannel](InputChannel.md), a [Peer](Peer.md), an [DialogPeer](DialogPeer.md), [NotifyPeer](NotifyPeer.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) + + + diff --git a/old_docs/API_docs_v109/types/UserFull.md b/old_docs/API_docs_v109/types/UserFull.md new file mode 100644 index 00000000..ac50052f --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/UserProfilePhoto.md b/old_docs/API_docs_v109/types/UserProfilePhoto.md new file mode 100644 index 00000000..e81e92fd --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/UserStatus.md b/old_docs/API_docs_v109/types/UserStatus.md new file mode 100644 index 00000000..a5f9ec16 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/WallPaper.md b/old_docs/API_docs_v109/types/WallPaper.md new file mode 100644 index 00000000..bdf06088 --- /dev/null +++ b/old_docs/API_docs_v109/types/WallPaper.md @@ -0,0 +1,28 @@ +--- +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) + +[wallPaperNoFile](../constructors/wallPaperNoFile.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getWallPaper](../methods/account.getWallPaper.md) + +[$MadelineProto->account->uploadWallPaper](../methods/account.uploadWallPaper.md) + +[$MadelineProto->account->getMultiWallPapers](../methods/account.getMultiWallPapers.md) + + + diff --git a/old_docs/API_docs_v109/types/WallPaperSettings.md b/old_docs/API_docs_v109/types/WallPaperSettings.md new file mode 100644 index 00000000..a174a48a --- /dev/null +++ b/old_docs/API_docs_v109/types/WallPaperSettings.md @@ -0,0 +1,20 @@ +--- +title: WallPaperSettings +description: constructors and methods of type WallPaperSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: WallPaperSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[wallPaperSettings](../constructors/wallPaperSettings.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/WebAuthorization.md b/old_docs/API_docs_v109/types/WebAuthorization.md new file mode 100644 index 00000000..54c02f7d --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/WebDocument.md b/old_docs/API_docs_v109/types/WebDocument.md new file mode 100644 index 00000000..8727b6b4 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/WebPage.md b/old_docs/API_docs_v109/types/WebPage.md new file mode 100644 index 00000000..f6b61c5e --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/WebPageAttribute.md b/old_docs/API_docs_v109/types/WebPageAttribute.md new file mode 100644 index 00000000..a14c3bd3 --- /dev/null +++ b/old_docs/API_docs_v109/types/WebPageAttribute.md @@ -0,0 +1,20 @@ +--- +title: WebPageAttribute +description: constructors and methods of type WebPageAttribute +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +--- +# Type: WebPageAttribute +[Back to types index](index.md) + + + +### Possible values (constructors): + +[webPageAttributeTheme](../constructors/webPageAttributeTheme.md) + + + +### Methods that return an object of this type (methods): + + + diff --git a/old_docs/API_docs_v109/types/X.md b/old_docs/API_docs_v109/types/X.md new file mode 100644 index 00000000..3b234633 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/account.AuthorizationForm.md b/old_docs/API_docs_v109/types/account.AuthorizationForm.md new file mode 100644 index 00000000..f00ce392 --- /dev/null +++ b/old_docs/API_docs_v109/types/account.AuthorizationForm.md @@ -0,0 +1,23 @@ +--- +title: account.AuthorizationForm +description: constructors and methods of type account.AuthorizationForm +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_AuthorizationForm.html +--- +# 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_v109/types/account.Authorizations.md b/old_docs/API_docs_v109/types/account.Authorizations.md new file mode 100644 index 00000000..b5503589 --- /dev/null +++ b/old_docs/API_docs_v109/types/account.Authorizations.md @@ -0,0 +1,23 @@ +--- +title: account.Authorizations +description: constructors and methods of type account.Authorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_Authorizations.html +--- +# 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_v109/types/account.AutoDownloadSettings.md b/old_docs/API_docs_v109/types/account.AutoDownloadSettings.md new file mode 100644 index 00000000..be6bcad3 --- /dev/null +++ b/old_docs/API_docs_v109/types/account.AutoDownloadSettings.md @@ -0,0 +1,23 @@ +--- +title: account.AutoDownloadSettings +description: constructors and methods of type account.AutoDownloadSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_AutoDownloadSettings.html +--- +# Type: account.AutoDownloadSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.autoDownloadSettings](../constructors/account.autoDownloadSettings.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getAutoDownloadSettings](../methods/account.getAutoDownloadSettings.md) + + + diff --git a/old_docs/API_docs_v109/types/account.ContentSettings.md b/old_docs/API_docs_v109/types/account.ContentSettings.md new file mode 100644 index 00000000..17e9b51a --- /dev/null +++ b/old_docs/API_docs_v109/types/account.ContentSettings.md @@ -0,0 +1,23 @@ +--- +title: account.ContentSettings +description: constructors and methods of type account.ContentSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_ContentSettings.html +--- +# Type: account.ContentSettings +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.contentSettings](../constructors/account.contentSettings.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getContentSettings](../methods/account.getContentSettings.md) + + + diff --git a/old_docs/API_docs_v109/types/account.Password.md b/old_docs/API_docs_v109/types/account.Password.md new file mode 100644 index 00000000..5013ee08 --- /dev/null +++ b/old_docs/API_docs_v109/types/account.Password.md @@ -0,0 +1,23 @@ +--- +title: account.Password +description: constructors and methods of type account.Password +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_Password.html +--- +# Type: account.Password +[Back to types index](index.md) + + + +### Possible values (constructors): + +[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_v109/types/account.PasswordInputSettings.md b/old_docs/API_docs_v109/types/account.PasswordInputSettings.md new file mode 100644 index 00000000..0f2b52a8 --- /dev/null +++ b/old_docs/API_docs_v109/types/account.PasswordInputSettings.md @@ -0,0 +1,21 @@ +--- +title: account.PasswordInputSettings +description: constructors and methods of type account.PasswordInputSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_PasswordInputSettings.html +--- +# 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_v109/types/account.PasswordSettings.md b/old_docs/API_docs_v109/types/account.PasswordSettings.md new file mode 100644 index 00000000..5526eee0 --- /dev/null +++ b/old_docs/API_docs_v109/types/account.PasswordSettings.md @@ -0,0 +1,23 @@ +--- +title: account.PasswordSettings +description: constructors and methods of type account.PasswordSettings +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_PasswordSettings.html +--- +# 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_v109/types/account.PrivacyRules.md b/old_docs/API_docs_v109/types/account.PrivacyRules.md new file mode 100644 index 00000000..0aedaf63 --- /dev/null +++ b/old_docs/API_docs_v109/types/account.PrivacyRules.md @@ -0,0 +1,25 @@ +--- +title: account.PrivacyRules +description: constructors and methods of type account.PrivacyRules +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_PrivacyRules.html +--- +# 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_v109/types/account.SentEmailCode.md b/old_docs/API_docs_v109/types/account.SentEmailCode.md new file mode 100644 index 00000000..51f4f56c --- /dev/null +++ b/old_docs/API_docs_v109/types/account.SentEmailCode.md @@ -0,0 +1,23 @@ +--- +title: account.SentEmailCode +description: constructors and methods of type account.SentEmailCode +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_SentEmailCode.html +--- +# 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_v109/types/account.Takeout.md b/old_docs/API_docs_v109/types/account.Takeout.md new file mode 100644 index 00000000..ad301130 --- /dev/null +++ b/old_docs/API_docs_v109/types/account.Takeout.md @@ -0,0 +1,23 @@ +--- +title: account.Takeout +description: constructors and methods of type account.Takeout +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_Takeout.html +--- +# 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_v109/types/account.Themes.md b/old_docs/API_docs_v109/types/account.Themes.md new file mode 100644 index 00000000..fa526de4 --- /dev/null +++ b/old_docs/API_docs_v109/types/account.Themes.md @@ -0,0 +1,25 @@ +--- +title: account.Themes +description: constructors and methods of type account.Themes +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_Themes.html +--- +# Type: account.Themes +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.themesNotModified](../constructors/account.themesNotModified.md) + +[account.themes](../constructors/account.themes.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getThemes](../methods/account.getThemes.md) + + + diff --git a/old_docs/API_docs_v109/types/account.TmpPassword.md b/old_docs/API_docs_v109/types/account.TmpPassword.md new file mode 100644 index 00000000..9e97e924 --- /dev/null +++ b/old_docs/API_docs_v109/types/account.TmpPassword.md @@ -0,0 +1,23 @@ +--- +title: account.TmpPassword +description: constructors and methods of type account.TmpPassword +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_TmpPassword.html +--- +# 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_v109/types/account.WallPapers.md b/old_docs/API_docs_v109/types/account.WallPapers.md new file mode 100644 index 00000000..f8603f4d --- /dev/null +++ b/old_docs/API_docs_v109/types/account.WallPapers.md @@ -0,0 +1,25 @@ +--- +title: account.WallPapers +description: constructors and methods of type account.WallPapers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_WallPapers.html +--- +# Type: account.WallPapers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[account.wallPapersNotModified](../constructors/account.wallPapersNotModified.md) + +[account.wallPapers](../constructors/account.wallPapers.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->account->getWallPapers](../methods/account.getWallPapers.md) + + + diff --git a/old_docs/API_docs_v109/types/account.WebAuthorizations.md b/old_docs/API_docs_v109/types/account.WebAuthorizations.md new file mode 100644 index 00000000..1bbf2668 --- /dev/null +++ b/old_docs/API_docs_v109/types/account.WebAuthorizations.md @@ -0,0 +1,23 @@ +--- +title: account.WebAuthorizations +description: constructors and methods of type account.WebAuthorizations +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/account_WebAuthorizations.html +--- +# 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_v109/types/auth.Authorization.md b/old_docs/API_docs_v109/types/auth.Authorization.md new file mode 100644 index 00000000..eb88ac91 --- /dev/null +++ b/old_docs/API_docs_v109/types/auth.Authorization.md @@ -0,0 +1,35 @@ +--- +title: auth.Authorization +description: constructors and methods of type auth.Authorization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/auth_Authorization.html +--- +# Type: auth.Authorization +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth.authorization](../constructors/auth.authorization.md) + +[auth.authorizationSignUpRequired](../constructors/auth.authorizationSignUpRequired.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_v109/types/auth.CodeType.md b/old_docs/API_docs_v109/types/auth.CodeType.md new file mode 100644 index 00000000..cd7bdaf9 --- /dev/null +++ b/old_docs/API_docs_v109/types/auth.CodeType.md @@ -0,0 +1,25 @@ +--- +title: auth.CodeType +description: constructors and methods of type auth.CodeType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/auth_CodeType.html +--- +# 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_v109/types/auth.ExportedAuthorization.md b/old_docs/API_docs_v109/types/auth.ExportedAuthorization.md new file mode 100644 index 00000000..cf2a2607 --- /dev/null +++ b/old_docs/API_docs_v109/types/auth.ExportedAuthorization.md @@ -0,0 +1,23 @@ +--- +title: auth.ExportedAuthorization +description: constructors and methods of type auth.ExportedAuthorization +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/auth_ExportedAuthorization.html +--- +# 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_v109/types/auth.LoginToken.md b/old_docs/API_docs_v109/types/auth.LoginToken.md new file mode 100644 index 00000000..81360897 --- /dev/null +++ b/old_docs/API_docs_v109/types/auth.LoginToken.md @@ -0,0 +1,29 @@ +--- +title: auth.LoginToken +description: constructors and methods of type auth.LoginToken +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/auth_LoginToken.html +--- +# Type: auth.LoginToken +[Back to types index](index.md) + + + +### Possible values (constructors): + +[auth.loginToken](../constructors/auth.loginToken.md) + +[auth.loginTokenMigrateTo](../constructors/auth.loginTokenMigrateTo.md) + +[auth.loginTokenSuccess](../constructors/auth.loginTokenSuccess.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->auth->exportLoginToken](../methods/auth.exportLoginToken.md) + +[$MadelineProto->auth->importLoginToken](../methods/auth.importLoginToken.md) + + + diff --git a/old_docs/API_docs_v109/types/auth.PasswordRecovery.md b/old_docs/API_docs_v109/types/auth.PasswordRecovery.md new file mode 100644 index 00000000..7d89cc2d --- /dev/null +++ b/old_docs/API_docs_v109/types/auth.PasswordRecovery.md @@ -0,0 +1,23 @@ +--- +title: auth.PasswordRecovery +description: constructors and methods of type auth.PasswordRecovery +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/auth_PasswordRecovery.html +--- +# 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_v109/types/auth.SentCode.md b/old_docs/API_docs_v109/types/auth.SentCode.md new file mode 100644 index 00000000..0ca0a0f5 --- /dev/null +++ b/old_docs/API_docs_v109/types/auth.SentCode.md @@ -0,0 +1,31 @@ +--- +title: auth.SentCode +description: constructors and methods of type auth.SentCode +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/auth_SentCode.html +--- +# 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_v109/types/auth.SentCodeType.md b/old_docs/API_docs_v109/types/auth.SentCodeType.md new file mode 100644 index 00000000..f2a4ce7f --- /dev/null +++ b/old_docs/API_docs_v109/types/auth.SentCodeType.md @@ -0,0 +1,27 @@ +--- +title: auth.SentCodeType +description: constructors and methods of type auth.SentCodeType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/auth_SentCodeType.html +--- +# 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_v109/types/bytes.md b/old_docs/API_docs_v109/types/bytes.md new file mode 100644 index 00000000..15ea3a1a --- /dev/null +++ b/old_docs/API_docs_v109/types/bytes.md @@ -0,0 +1,21 @@ +--- +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) + +```php +$bytes = "simple string of bytes"; +``` + +Internally, 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_v109/types/channels.AdminLogResults.md b/old_docs/API_docs_v109/types/channels.AdminLogResults.md new file mode 100644 index 00000000..4a5ab632 --- /dev/null +++ b/old_docs/API_docs_v109/types/channels.AdminLogResults.md @@ -0,0 +1,23 @@ +--- +title: channels.AdminLogResults +description: constructors and methods of type channels.AdminLogResults +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/channels_AdminLogResults.html +--- +# 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_v109/types/channels.ChannelParticipant.md b/old_docs/API_docs_v109/types/channels.ChannelParticipant.md new file mode 100644 index 00000000..47ff36b7 --- /dev/null +++ b/old_docs/API_docs_v109/types/channels.ChannelParticipant.md @@ -0,0 +1,23 @@ +--- +title: channels.ChannelParticipant +description: constructors and methods of type channels.ChannelParticipant +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/channels_ChannelParticipant.html +--- +# 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_v109/types/channels.ChannelParticipants.md b/old_docs/API_docs_v109/types/channels.ChannelParticipants.md new file mode 100644 index 00000000..ef889205 --- /dev/null +++ b/old_docs/API_docs_v109/types/channels.ChannelParticipants.md @@ -0,0 +1,25 @@ +--- +title: channels.ChannelParticipants +description: constructors and methods of type channels.ChannelParticipants +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/channels_ChannelParticipants.html +--- +# 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_v109/types/contacts.Blocked.md b/old_docs/API_docs_v109/types/contacts.Blocked.md new file mode 100644 index 00000000..7c3a96a9 --- /dev/null +++ b/old_docs/API_docs_v109/types/contacts.Blocked.md @@ -0,0 +1,25 @@ +--- +title: contacts.Blocked +description: constructors and methods of type contacts.Blocked +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/contacts_Blocked.html +--- +# 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_v109/types/contacts.Contacts.md b/old_docs/API_docs_v109/types/contacts.Contacts.md new file mode 100644 index 00000000..c47102bc --- /dev/null +++ b/old_docs/API_docs_v109/types/contacts.Contacts.md @@ -0,0 +1,25 @@ +--- +title: contacts.Contacts +description: constructors and methods of type contacts.Contacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/contacts_Contacts.html +--- +# 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_v109/types/contacts.Found.md b/old_docs/API_docs_v109/types/contacts.Found.md new file mode 100644 index 00000000..35516be1 --- /dev/null +++ b/old_docs/API_docs_v109/types/contacts.Found.md @@ -0,0 +1,23 @@ +--- +title: contacts.Found +description: constructors and methods of type contacts.Found +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/contacts_Found.html +--- +# 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_v109/types/contacts.ImportedContacts.md b/old_docs/API_docs_v109/types/contacts.ImportedContacts.md new file mode 100644 index 00000000..d812db9a --- /dev/null +++ b/old_docs/API_docs_v109/types/contacts.ImportedContacts.md @@ -0,0 +1,23 @@ +--- +title: contacts.ImportedContacts +description: constructors and methods of type contacts.ImportedContacts +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/contacts_ImportedContacts.html +--- +# 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_v109/types/contacts.ResolvedPeer.md b/old_docs/API_docs_v109/types/contacts.ResolvedPeer.md new file mode 100644 index 00000000..a24b919f --- /dev/null +++ b/old_docs/API_docs_v109/types/contacts.ResolvedPeer.md @@ -0,0 +1,23 @@ +--- +title: contacts.ResolvedPeer +description: constructors and methods of type contacts.ResolvedPeer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/contacts_ResolvedPeer.html +--- +# 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_v109/types/contacts.TopPeers.md b/old_docs/API_docs_v109/types/contacts.TopPeers.md new file mode 100644 index 00000000..debcd3e5 --- /dev/null +++ b/old_docs/API_docs_v109/types/contacts.TopPeers.md @@ -0,0 +1,27 @@ +--- +title: contacts.TopPeers +description: constructors and methods of type contacts.TopPeers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/contacts_TopPeers.html +--- +# Type: contacts.TopPeers +[Back to types index](index.md) + + + +### Possible values (constructors): + +[contacts.topPeersNotModified](../constructors/contacts.topPeersNotModified.md) + +[contacts.topPeers](../constructors/contacts.topPeers.md) + +[contacts.topPeersDisabled](../constructors/contacts.topPeersDisabled.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->contacts->getTopPeers](../methods/contacts.getTopPeers.md) + + + diff --git a/old_docs/API_docs_v109/types/double.md b/old_docs/API_docs_v109/types/double.md new file mode 100644 index 00000000..a6d2ee55 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/help.AppUpdate.md b/old_docs/API_docs_v109/types/help.AppUpdate.md new file mode 100644 index 00000000..ed36f644 --- /dev/null +++ b/old_docs/API_docs_v109/types/help.AppUpdate.md @@ -0,0 +1,25 @@ +--- +title: help.AppUpdate +description: constructors and methods of type help.AppUpdate +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_AppUpdate.html +--- +# 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_v109/types/help.DeepLinkInfo.md b/old_docs/API_docs_v109/types/help.DeepLinkInfo.md new file mode 100644 index 00000000..81025289 --- /dev/null +++ b/old_docs/API_docs_v109/types/help.DeepLinkInfo.md @@ -0,0 +1,25 @@ +--- +title: help.DeepLinkInfo +description: constructors and methods of type help.DeepLinkInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_DeepLinkInfo.html +--- +# 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_v109/types/help.InviteText.md b/old_docs/API_docs_v109/types/help.InviteText.md new file mode 100644 index 00000000..cd945b6f --- /dev/null +++ b/old_docs/API_docs_v109/types/help.InviteText.md @@ -0,0 +1,23 @@ +--- +title: help.InviteText +description: constructors and methods of type help.InviteText +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_InviteText.html +--- +# 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_v109/types/help.PassportConfig.md b/old_docs/API_docs_v109/types/help.PassportConfig.md new file mode 100644 index 00000000..2c3ed6d0 --- /dev/null +++ b/old_docs/API_docs_v109/types/help.PassportConfig.md @@ -0,0 +1,25 @@ +--- +title: help.PassportConfig +description: constructors and methods of type help.PassportConfig +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_PassportConfig.html +--- +# Type: help.PassportConfig +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.passportConfigNotModified](../constructors/help.passportConfigNotModified.md) + +[help.passportConfig](../constructors/help.passportConfig.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getPassportConfig](../methods/help.getPassportConfig.md) + + + diff --git a/old_docs/API_docs_v109/types/help.ProxyData.md b/old_docs/API_docs_v109/types/help.ProxyData.md new file mode 100644 index 00000000..902c852b --- /dev/null +++ b/old_docs/API_docs_v109/types/help.ProxyData.md @@ -0,0 +1,25 @@ +--- +title: help.ProxyData +description: constructors and methods of type help.ProxyData +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_ProxyData.html +--- +# 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_v109/types/help.RecentMeUrls.md b/old_docs/API_docs_v109/types/help.RecentMeUrls.md new file mode 100644 index 00000000..c1bf8924 --- /dev/null +++ b/old_docs/API_docs_v109/types/help.RecentMeUrls.md @@ -0,0 +1,23 @@ +--- +title: help.RecentMeUrls +description: constructors and methods of type help.RecentMeUrls +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_RecentMeUrls.html +--- +# 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_v109/types/help.Support.md b/old_docs/API_docs_v109/types/help.Support.md new file mode 100644 index 00000000..3e44b909 --- /dev/null +++ b/old_docs/API_docs_v109/types/help.Support.md @@ -0,0 +1,23 @@ +--- +title: help.Support +description: constructors and methods of type help.Support +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_Support.html +--- +# 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_v109/types/help.SupportName.md b/old_docs/API_docs_v109/types/help.SupportName.md new file mode 100644 index 00000000..b8e70834 --- /dev/null +++ b/old_docs/API_docs_v109/types/help.SupportName.md @@ -0,0 +1,23 @@ +--- +title: help.SupportName +description: constructors and methods of type help.SupportName +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_SupportName.html +--- +# Type: help.SupportName +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.supportName](../constructors/help.supportName.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getSupportName](../methods/help.getSupportName.md) + + + diff --git a/old_docs/API_docs_v109/types/help.TermsOfService.md b/old_docs/API_docs_v109/types/help.TermsOfService.md new file mode 100644 index 00000000..3e158779 --- /dev/null +++ b/old_docs/API_docs_v109/types/help.TermsOfService.md @@ -0,0 +1,21 @@ +--- +title: help.TermsOfService +description: constructors and methods of type help.TermsOfService +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_TermsOfService.html +--- +# Type: help.TermsOfService +[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_v109/types/help.TermsOfServiceUpdate.md b/old_docs/API_docs_v109/types/help.TermsOfServiceUpdate.md new file mode 100644 index 00000000..48fe9b8f --- /dev/null +++ b/old_docs/API_docs_v109/types/help.TermsOfServiceUpdate.md @@ -0,0 +1,25 @@ +--- +title: help.TermsOfServiceUpdate +description: constructors and methods of type help.TermsOfServiceUpdate +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_TermsOfServiceUpdate.html +--- +# 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_v109/types/help.UserInfo.md b/old_docs/API_docs_v109/types/help.UserInfo.md new file mode 100644 index 00000000..d4e12c71 --- /dev/null +++ b/old_docs/API_docs_v109/types/help.UserInfo.md @@ -0,0 +1,27 @@ +--- +title: help.UserInfo +description: constructors and methods of type help.UserInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/help_UserInfo.html +--- +# Type: help.UserInfo +[Back to types index](index.md) + + + +### Possible values (constructors): + +[help.userInfoEmpty](../constructors/help.userInfoEmpty.md) + +[help.userInfo](../constructors/help.userInfo.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->help->getUserInfo](../methods/help.getUserInfo.md) + +[$MadelineProto->help->editUserInfo](../methods/help.editUserInfo.md) + + + diff --git a/old_docs/API_docs_v109/types/int.md b/old_docs/API_docs_v109/types/int.md new file mode 100644 index 00000000..73dd1c64 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/int128.md b/old_docs/API_docs_v109/types/int128.md new file mode 100644 index 00000000..042ef75b --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/int256.md b/old_docs/API_docs_v109/types/int256.md new file mode 100644 index 00000000..6b19844d --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/int512.md b/old_docs/API_docs_v109/types/int512.md new file mode 100644 index 00000000..eec6ec00 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/int53.md b/old_docs/API_docs_v109/types/int53.md new file mode 100644 index 00000000..820b48f8 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/long.md b/old_docs/API_docs_v109/types/long.md new file mode 100644 index 00000000..e60a8f75 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/messages.AffectedHistory.md b/old_docs/API_docs_v109/types/messages.AffectedHistory.md new file mode 100644 index 00000000..a57ca860 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.AffectedHistory.md @@ -0,0 +1,27 @@ +--- +title: messages.AffectedHistory +description: constructors and methods of type messages.AffectedHistory +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_AffectedHistory.html +--- +# 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_v109/types/messages.AffectedMessages.md b/old_docs/API_docs_v109/types/messages.AffectedMessages.md new file mode 100644 index 00000000..b5235fc1 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.AffectedMessages.md @@ -0,0 +1,29 @@ +--- +title: messages.AffectedMessages +description: constructors and methods of type messages.AffectedMessages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_AffectedMessages.html +--- +# 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_v109/types/messages.AllStickers.md b/old_docs/API_docs_v109/types/messages.AllStickers.md new file mode 100644 index 00000000..e0c7e704 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.AllStickers.md @@ -0,0 +1,27 @@ +--- +title: messages.AllStickers +description: constructors and methods of type messages.AllStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_AllStickers.html +--- +# 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_v109/types/messages.ArchivedStickers.md b/old_docs/API_docs_v109/types/messages.ArchivedStickers.md new file mode 100644 index 00000000..4934b3a0 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.ArchivedStickers.md @@ -0,0 +1,23 @@ +--- +title: messages.ArchivedStickers +description: constructors and methods of type messages.ArchivedStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_ArchivedStickers.html +--- +# 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_v109/types/messages.BotCallbackAnswer.md b/old_docs/API_docs_v109/types/messages.BotCallbackAnswer.md new file mode 100644 index 00000000..1ce19bd5 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.BotCallbackAnswer.md @@ -0,0 +1,23 @@ +--- +title: messages.BotCallbackAnswer +description: constructors and methods of type messages.BotCallbackAnswer +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_BotCallbackAnswer.html +--- +# 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_v109/types/messages.BotResults.md b/old_docs/API_docs_v109/types/messages.BotResults.md new file mode 100644 index 00000000..c6900080 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.BotResults.md @@ -0,0 +1,23 @@ +--- +title: messages.BotResults +description: constructors and methods of type messages.BotResults +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_BotResults.html +--- +# 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_v109/types/messages.ChatFull.md b/old_docs/API_docs_v109/types/messages.ChatFull.md new file mode 100644 index 00000000..7cf57376 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.ChatFull.md @@ -0,0 +1,25 @@ +--- +title: messages.ChatFull +description: constructors and methods of type messages.ChatFull +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_ChatFull.html +--- +# 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_v109/types/messages.Chats.md b/old_docs/API_docs_v109/types/messages.Chats.md new file mode 100644 index 00000000..64b73fd0 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.Chats.md @@ -0,0 +1,37 @@ +--- +title: messages.Chats +description: constructors and methods of type messages.Chats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_Chats.html +--- +# 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) + +[$MadelineProto->channels->getGroupsForDiscussion](../methods/channels.getGroupsForDiscussion.md) + + + diff --git a/old_docs/API_docs_v109/types/messages.DhConfig.md b/old_docs/API_docs_v109/types/messages.DhConfig.md new file mode 100644 index 00000000..a2531ae8 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.DhConfig.md @@ -0,0 +1,25 @@ +--- +title: messages.DhConfig +description: constructors and methods of type messages.DhConfig +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_DhConfig.html +--- +# 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_v109/types/messages.Dialogs.md b/old_docs/API_docs_v109/types/messages.Dialogs.md new file mode 100644 index 00000000..dd39bf35 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.Dialogs.md @@ -0,0 +1,27 @@ +--- +title: messages.Dialogs +description: constructors and methods of type messages.Dialogs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_Dialogs.html +--- +# Type: messages.Dialogs +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.dialogs](../constructors/messages.dialogs.md) + +[messages.dialogsSlice](../constructors/messages.dialogsSlice.md) + +[messages.dialogsNotModified](../constructors/messages.dialogsNotModified.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getDialogs](../methods/messages.getDialogs.md) + + + diff --git a/old_docs/API_docs_v109/types/messages.FavedStickers.md b/old_docs/API_docs_v109/types/messages.FavedStickers.md new file mode 100644 index 00000000..23ec65c8 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.FavedStickers.md @@ -0,0 +1,25 @@ +--- +title: messages.FavedStickers +description: constructors and methods of type messages.FavedStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_FavedStickers.html +--- +# 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_v109/types/messages.FeaturedStickers.md b/old_docs/API_docs_v109/types/messages.FeaturedStickers.md new file mode 100644 index 00000000..17075447 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.FeaturedStickers.md @@ -0,0 +1,25 @@ +--- +title: messages.FeaturedStickers +description: constructors and methods of type messages.FeaturedStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_FeaturedStickers.html +--- +# 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_v109/types/messages.FoundGifs.md b/old_docs/API_docs_v109/types/messages.FoundGifs.md new file mode 100644 index 00000000..f9f15856 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.FoundGifs.md @@ -0,0 +1,23 @@ +--- +title: messages.FoundGifs +description: constructors and methods of type messages.FoundGifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_FoundGifs.html +--- +# 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_v109/types/messages.FoundStickerSets.md b/old_docs/API_docs_v109/types/messages.FoundStickerSets.md new file mode 100644 index 00000000..d6331ba2 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.FoundStickerSets.md @@ -0,0 +1,25 @@ +--- +title: messages.FoundStickerSets +description: constructors and methods of type messages.FoundStickerSets +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_FoundStickerSets.html +--- +# 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_v109/types/messages.HighScores.md b/old_docs/API_docs_v109/types/messages.HighScores.md new file mode 100644 index 00000000..e5d461f1 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.HighScores.md @@ -0,0 +1,25 @@ +--- +title: messages.HighScores +description: constructors and methods of type messages.HighScores +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_HighScores.html +--- +# 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_v109/types/messages.InactiveChats.md b/old_docs/API_docs_v109/types/messages.InactiveChats.md new file mode 100644 index 00000000..cb9cd54e --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.InactiveChats.md @@ -0,0 +1,23 @@ +--- +title: messages.InactiveChats +description: constructors and methods of type messages.InactiveChats +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_InactiveChats.html +--- +# Type: messages.InactiveChats +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.inactiveChats](../constructors/messages.inactiveChats.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->channels->getInactiveChannels](../methods/channels.getInactiveChannels.md) + + + diff --git a/old_docs/API_docs_v109/types/messages.MessageEditData.md b/old_docs/API_docs_v109/types/messages.MessageEditData.md new file mode 100644 index 00000000..55888883 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.MessageEditData.md @@ -0,0 +1,23 @@ +--- +title: messages.MessageEditData +description: constructors and methods of type messages.MessageEditData +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_MessageEditData.html +--- +# 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_v109/types/messages.Messages.md b/old_docs/API_docs_v109/types/messages.Messages.md new file mode 100644 index 00000000..05ed903b --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.Messages.md @@ -0,0 +1,45 @@ +--- +title: messages.Messages +description: constructors and methods of type messages.Messages +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_Messages.html +--- +# 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->messages->getScheduledHistory](../methods/messages.getScheduledHistory.md) + +[$MadelineProto->messages->getScheduledMessages](../methods/messages.getScheduledMessages.md) + +[$MadelineProto->channels->getMessages](../methods/channels.getMessages.md) + + + diff --git a/old_docs/API_docs_v109/types/messages.PeerDialogs.md b/old_docs/API_docs_v109/types/messages.PeerDialogs.md new file mode 100644 index 00000000..baab9b4c --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.PeerDialogs.md @@ -0,0 +1,25 @@ +--- +title: messages.PeerDialogs +description: constructors and methods of type messages.PeerDialogs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_PeerDialogs.html +--- +# 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_v109/types/messages.RecentStickers.md b/old_docs/API_docs_v109/types/messages.RecentStickers.md new file mode 100644 index 00000000..0cb2e998 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.RecentStickers.md @@ -0,0 +1,25 @@ +--- +title: messages.RecentStickers +description: constructors and methods of type messages.RecentStickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_RecentStickers.html +--- +# 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_v109/types/messages.SavedGifs.md b/old_docs/API_docs_v109/types/messages.SavedGifs.md new file mode 100644 index 00000000..2eac7a9c --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.SavedGifs.md @@ -0,0 +1,25 @@ +--- +title: messages.SavedGifs +description: constructors and methods of type messages.SavedGifs +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_SavedGifs.html +--- +# 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_v109/types/messages.SearchCounter.md b/old_docs/API_docs_v109/types/messages.SearchCounter.md new file mode 100644 index 00000000..8ba9df06 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.SearchCounter.md @@ -0,0 +1,23 @@ +--- +title: messages.SearchCounter +description: constructors and methods of type messages.SearchCounter +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_SearchCounter.html +--- +# Type: messages.SearchCounter +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.searchCounter](../constructors/messages.searchCounter.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getSearchCounters](../methods/messages.getSearchCounters.md) + + + diff --git a/old_docs/API_docs_v109/types/messages.SentEncryptedMessage.md b/old_docs/API_docs_v109/types/messages.SentEncryptedMessage.md new file mode 100644 index 00000000..2a460974 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.SentEncryptedMessage.md @@ -0,0 +1,29 @@ +--- +title: messages.SentEncryptedMessage +description: constructors and methods of type messages.SentEncryptedMessage +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_SentEncryptedMessage.html +--- +# 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_v109/types/messages.StickerSet.md b/old_docs/API_docs_v109/types/messages.StickerSet.md new file mode 100644 index 00000000..58ba176b --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.StickerSet.md @@ -0,0 +1,31 @@ +--- +title: messages.StickerSet +description: constructors and methods of type messages.StickerSet +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_StickerSet.html +--- +# 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_v109/types/messages.StickerSetInstallResult.md b/old_docs/API_docs_v109/types/messages.StickerSetInstallResult.md new file mode 100644 index 00000000..8346bb71 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.StickerSetInstallResult.md @@ -0,0 +1,25 @@ +--- +title: messages.StickerSetInstallResult +description: constructors and methods of type messages.StickerSetInstallResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_StickerSetInstallResult.html +--- +# 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_v109/types/messages.Stickers.md b/old_docs/API_docs_v109/types/messages.Stickers.md new file mode 100644 index 00000000..0b830b2c --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.Stickers.md @@ -0,0 +1,25 @@ +--- +title: messages.Stickers +description: constructors and methods of type messages.Stickers +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_Stickers.html +--- +# 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_v109/types/messages.VotesList.md b/old_docs/API_docs_v109/types/messages.VotesList.md new file mode 100644 index 00000000..3daf9081 --- /dev/null +++ b/old_docs/API_docs_v109/types/messages.VotesList.md @@ -0,0 +1,23 @@ +--- +title: messages.VotesList +description: constructors and methods of type messages.VotesList +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/messages_VotesList.html +--- +# Type: messages.VotesList +[Back to types index](index.md) + + + +### Possible values (constructors): + +[messages.votesList](../constructors/messages.votesList.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->messages->getPollVotes](../methods/messages.getPollVotes.md) + + + diff --git a/old_docs/API_docs_v109/types/payments.PaymentForm.md b/old_docs/API_docs_v109/types/payments.PaymentForm.md new file mode 100644 index 00000000..e7fb8e91 --- /dev/null +++ b/old_docs/API_docs_v109/types/payments.PaymentForm.md @@ -0,0 +1,23 @@ +--- +title: payments.PaymentForm +description: constructors and methods of type payments.PaymentForm +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/payments_PaymentForm.html +--- +# 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_v109/types/payments.PaymentReceipt.md b/old_docs/API_docs_v109/types/payments.PaymentReceipt.md new file mode 100644 index 00000000..12247678 --- /dev/null +++ b/old_docs/API_docs_v109/types/payments.PaymentReceipt.md @@ -0,0 +1,23 @@ +--- +title: payments.PaymentReceipt +description: constructors and methods of type payments.PaymentReceipt +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/payments_PaymentReceipt.html +--- +# 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_v109/types/payments.PaymentResult.md b/old_docs/API_docs_v109/types/payments.PaymentResult.md new file mode 100644 index 00000000..e1ffcee2 --- /dev/null +++ b/old_docs/API_docs_v109/types/payments.PaymentResult.md @@ -0,0 +1,25 @@ +--- +title: payments.PaymentResult +description: constructors and methods of type payments.PaymentResult +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/payments_PaymentResult.html +--- +# Type: payments.PaymentResult +[Back to types index](index.md) + + + +### Possible values (constructors): + +[payments.paymentResult](../constructors/payments.paymentResult.md) + +[payments.paymentVerificationNeeded](../constructors/payments.paymentVerificationNeeded.md) + + + +### Methods that return an object of this type (methods): + +[$MadelineProto->payments->sendPaymentForm](../methods/payments.sendPaymentForm.md) + + + diff --git a/old_docs/API_docs_v109/types/payments.SavedInfo.md b/old_docs/API_docs_v109/types/payments.SavedInfo.md new file mode 100644 index 00000000..5adc1af4 --- /dev/null +++ b/old_docs/API_docs_v109/types/payments.SavedInfo.md @@ -0,0 +1,23 @@ +--- +title: payments.SavedInfo +description: constructors and methods of type payments.SavedInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/payments_SavedInfo.html +--- +# 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_v109/types/payments.ValidatedRequestedInfo.md b/old_docs/API_docs_v109/types/payments.ValidatedRequestedInfo.md new file mode 100644 index 00000000..2d3d435d --- /dev/null +++ b/old_docs/API_docs_v109/types/payments.ValidatedRequestedInfo.md @@ -0,0 +1,23 @@ +--- +title: payments.ValidatedRequestedInfo +description: constructors and methods of type payments.ValidatedRequestedInfo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/payments_ValidatedRequestedInfo.html +--- +# 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_v109/types/phone.PhoneCall.md b/old_docs/API_docs_v109/types/phone.PhoneCall.md new file mode 100644 index 00000000..b869d028 --- /dev/null +++ b/old_docs/API_docs_v109/types/phone.PhoneCall.md @@ -0,0 +1,27 @@ +--- +title: phone.PhoneCall +description: constructors and methods of type phone.PhoneCall +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/phone_PhoneCall.html +--- +# 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_v109/types/photos.Photo.md b/old_docs/API_docs_v109/types/photos.Photo.md new file mode 100644 index 00000000..1abc47e5 --- /dev/null +++ b/old_docs/API_docs_v109/types/photos.Photo.md @@ -0,0 +1,23 @@ +--- +title: photos.Photo +description: constructors and methods of type photos.Photo +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/photos_Photo.html +--- +# 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_v109/types/photos.Photos.md b/old_docs/API_docs_v109/types/photos.Photos.md new file mode 100644 index 00000000..04600167 --- /dev/null +++ b/old_docs/API_docs_v109/types/photos.Photos.md @@ -0,0 +1,25 @@ +--- +title: photos.Photos +description: constructors and methods of type photos.Photos +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/photos_Photos.html +--- +# 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_v109/types/storage.FileType.md b/old_docs/API_docs_v109/types/storage.FileType.md new file mode 100644 index 00000000..2688f91e --- /dev/null +++ b/old_docs/API_docs_v109/types/storage.FileType.md @@ -0,0 +1,39 @@ +--- +title: storage.FileType +description: constructors and methods of type storage.FileType +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/storage_FileType.html +--- +# 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_v109/types/string.md b/old_docs/API_docs_v109/types/string.md new file mode 100644 index 00000000..b4658c95 --- /dev/null +++ b/old_docs/API_docs_v109/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_v109/types/updates.ChannelDifference.md b/old_docs/API_docs_v109/types/updates.ChannelDifference.md new file mode 100644 index 00000000..1cfd0396 --- /dev/null +++ b/old_docs/API_docs_v109/types/updates.ChannelDifference.md @@ -0,0 +1,27 @@ +--- +title: updates.ChannelDifference +description: constructors and methods of type updates.ChannelDifference +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/updates_ChannelDifference.html +--- +# 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_v109/types/updates.Difference.md b/old_docs/API_docs_v109/types/updates.Difference.md new file mode 100644 index 00000000..7f24ed3b --- /dev/null +++ b/old_docs/API_docs_v109/types/updates.Difference.md @@ -0,0 +1,29 @@ +--- +title: updates.Difference +description: constructors and methods of type updates.Difference +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/updates_Difference.html +--- +# 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_v109/types/updates.State.md b/old_docs/API_docs_v109/types/updates.State.md new file mode 100644 index 00000000..61999d5f --- /dev/null +++ b/old_docs/API_docs_v109/types/updates.State.md @@ -0,0 +1,23 @@ +--- +title: updates.State +description: constructors and methods of type updates.State +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/updates_State.html +--- +# 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_v109/types/upload.CdnFile.md b/old_docs/API_docs_v109/types/upload.CdnFile.md new file mode 100644 index 00000000..d8ac3251 --- /dev/null +++ b/old_docs/API_docs_v109/types/upload.CdnFile.md @@ -0,0 +1,25 @@ +--- +title: upload.CdnFile +description: constructors and methods of type upload.CdnFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/upload_CdnFile.html +--- +# 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_v109/types/upload.File.md b/old_docs/API_docs_v109/types/upload.File.md new file mode 100644 index 00000000..38657b8d --- /dev/null +++ b/old_docs/API_docs_v109/types/upload.File.md @@ -0,0 +1,25 @@ +--- +title: upload.File +description: constructors and methods of type upload.File +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/upload_File.html +--- +# 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_v109/types/upload.WebFile.md b/old_docs/API_docs_v109/types/upload.WebFile.md new file mode 100644 index 00000000..ba840e02 --- /dev/null +++ b/old_docs/API_docs_v109/types/upload.WebFile.md @@ -0,0 +1,23 @@ +--- +title: upload.WebFile +description: constructors and methods of type upload.WebFile +image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png +redirect_from: /API_docs/types/upload_WebFile.html +--- +# 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) + + + diff --git a/old_docs/README.md b/old_docs/README.md index 183a6b51..4d4adcab 100644 --- a/old_docs/README.md +++ b/old_docs/README.md @@ -4,4 +4,41 @@ description: Documentation of old mtproto layers --- # Documentation of old mtproto layers -[Layer v97](API_docs_v97/) +[Layer v0](API_docs_v0/) +[Layer v1](API_docs_v1/) +[Layer v2](API_docs_v2/) +[Layer v3](API_docs_v3/) +[Layer v4](API_docs_v4/) +[Layer v5](API_docs_v5/) +[Layer v6](API_docs_v6/) +[Layer v7](API_docs_v7/) +[Layer v8](API_docs_v8/) +[Layer v9](API_docs_v9/) +[Layer v10](API_docs_v10/) +[Layer v11](API_docs_v11/) +[Layer v12](API_docs_v12/) +[Layer v13](API_docs_v13/) +[Layer v14](API_docs_v14/) +[Layer v15](API_docs_v15/) +[Layer v16](API_docs_v16/) +[Layer v17](API_docs_v17/) +[Layer v18](API_docs_v18/) +[Layer v19](API_docs_v19/) +[Layer v20](API_docs_v20/) +[Layer v21](API_docs_v21/) +[Layer v22](API_docs_v22/) +[Layer v23](API_docs_v23/) +[Layer v24](API_docs_v24/) +[Layer v25](API_docs_v25/) +[Layer v26](API_docs_v26/) +[Layer v27](API_docs_v27/) +[Layer v28](API_docs_v28/) +[Layer v29](API_docs_v29/) +[Layer v30](API_docs_v30/) +[Layer v31](API_docs_v31/) +[Layer v32](API_docs_v32/) +[Layer v33](API_docs_v33/) +[Layer v34](API_docs_v34/) +[Layer v35](API_docs_v35/) +[Layer v36](API_docs_v36/) +[Layer v37](API_docs_v37/)