docs/dev.inmo.tgbotapi.types.passport.encrypted/Passport

Passport

@Serializable(with = EncryptedElementSerializer::class)

sealed class Passport : EncryptedPassportElementWithData, EncryptedPassportElementWithFrontSide, EncryptedPassportElementWithSelfie, EncryptedPassportElementTranslatable

Inheritors

CommonPassport

InternalPassport

Functions

asBankStatement

inline fun EncryptedPassportElement.asBankStatement(): BankStatement?

asCommonPassport

inline fun EncryptedPassportElement.asCommonPassport(): CommonPassport?

asDriverLicense

inline fun EncryptedPassportElement.asDriverLicense(): DriverLicense?

asEmail

inline fun EncryptedPassportElement.asEmail(): Email?

asEncryptedAddress

inline fun EncryptedPassportElement.asEncryptedAddress(): EncryptedAddress?

asEncryptedPassportElementTranslatable

inline fun EncryptedPassportElement.asEncryptedPassportElementTranslatable(): EncryptedPassportElementTranslatable?

asEncryptedPassportElementWithData

inline fun EncryptedPassportElement.asEncryptedPassportElementWithData(): EncryptedPassportElementWithData?

asEncryptedPassportElementWithEmail

inline fun EncryptedPassportElement.asEncryptedPassportElementWithEmail(): EncryptedPassportElementWithEmail?

asEncryptedPassportElementWithFilesCollection

inline fun EncryptedPassportElement.asEncryptedPassportElementWithFilesCollection(): EncryptedPassportElementWithFilesCollection?

asEncryptedPassportElementWithFrontSide

inline fun EncryptedPassportElement.asEncryptedPassportElementWithFrontSide(): EncryptedPassportElementWithFrontSide?

asEncryptedPassportElementWithPhoneNumber

inline fun EncryptedPassportElement.asEncryptedPassportElementWithPhoneNumber(): EncryptedPassportElementWithPhoneNumber?

asEncryptedPassportElementWithReverseSide

inline fun EncryptedPassportElement.asEncryptedPassportElementWithReverseSide(): EncryptedPassportElementWithReverseSide?

asEncryptedPassportElementWithSelfie

inline fun EncryptedPassportElement.asEncryptedPassportElementWithSelfie(): EncryptedPassportElementWithSelfie?

asEncryptedPassportElementWithTranslatableFilesCollection

inline fun EncryptedPassportElement.asEncryptedPassportElementWithTranslatableFilesCollection(): EncryptedPassportElementWithTranslatableFilesCollection?

asEncryptedPassportElementWithTranslatableIDDocument

inline fun EncryptedPassportElement.asEncryptedPassportElementWithTranslatableIDDocument(): EncryptedPassportElementWithTranslatableIDDocument?

asEncryptedPersonalDetails

inline fun EncryptedPassportElement.asEncryptedPersonalDetails(): EncryptedPersonalDetails?

asIdentityCard

inline fun EncryptedPassportElement.asIdentityCard(): IdentityCard?

asInternalPassport

inline fun EncryptedPassportElement.asInternalPassport(): InternalPassport?

asPassport

inline fun EncryptedPassportElement.asPassport(): Passport?

asPassportRegistration

inline fun EncryptedPassportElement.asPassportRegistration(): PassportRegistration?

asPhoneNumber

inline fun EncryptedPassportElement.asPhoneNumber(): PhoneNumber?

asRentalAgreement

inline fun EncryptedPassportElement.asRentalAgreement(): RentalAgreement?

asTemporaryRegistration

inline fun EncryptedPassportElement.asTemporaryRegistration(): TemporaryRegistration?

asUnknownEncryptedPassportElement

inline fun EncryptedPassportElement.asUnknownEncryptedPassportElement(): UnknownEncryptedPassportElement?

asUtilityBill

inline fun EncryptedPassportElement.asUtilityBill(): UtilityBill?

bankStatementOrNull

inline fun EncryptedPassportElement.bankStatementOrNull(): BankStatement?

bankStatementOrThrow

inline fun EncryptedPassportElement.bankStatementOrThrow(): BankStatement

commonPassportOrNull

inline fun EncryptedPassportElement.commonPassportOrNull(): CommonPassport?

commonPassportOrThrow

inline fun EncryptedPassportElement.commonPassportOrThrow(): CommonPassport

createDataError

fun EncryptedPassportElementWithData.createDataError(field: String, message: String): PassportElementErrorDataField

createFileError

fun EncryptedPassportElementTranslatable.createFileError(message: String, unencryptedFileHash: PassportElementHash): PassportElementErrorTranslationFile

createFilesError

fun EncryptedPassportElementTranslatable.createFilesError(message: String, unencryptedFileHashes: List<PassportElementHash>): PassportElementErrorTranslationFiles

createFrontSideError

fun EncryptedPassportElementWithFrontSide.createFrontSideError(message: String, unencryptedFileHash: PassportElementHash): PassportElementErrorFrontSide

createSelfieError

fun EncryptedPassportElementWithSelfie.createSelfieError(message: String, unencryptedFileHash: PassportElementHash): PassportElementErrorSelfie

createUnspecifiedError

fun EncryptedPassportElement.createUnspecifiedError(message: String, elementHash: PassportElementHash): PassportElementErrorUnspecified

driverLicenseOrNull

inline fun EncryptedPassportElement.driverLicenseOrNull(): DriverLicense?

driverLicenseOrThrow

inline fun EncryptedPassportElement.driverLicenseOrThrow(): DriverLicense

emailOrNull

inline fun EncryptedPassportElement.emailOrNull(): Email?

emailOrThrow

inline fun EncryptedPassportElement.emailOrThrow(): Email

encryptedAddressOrNull

inline fun EncryptedPassportElement.encryptedAddressOrNull(): EncryptedAddress?

encryptedAddressOrThrow

inline fun EncryptedPassportElement.encryptedAddressOrThrow(): EncryptedAddress

encryptedPassportElementTranslatableOrNull

inline fun EncryptedPassportElement.encryptedPassportElementTranslatableOrNull(): EncryptedPassportElementTranslatable?

encryptedPassportElementTranslatableOrThrow

inline fun EncryptedPassportElement.encryptedPassportElementTranslatableOrThrow(): EncryptedPassportElementTranslatable

encryptedPassportElementWithDataOrNull

inline fun EncryptedPassportElement.encryptedPassportElementWithDataOrNull(): EncryptedPassportElementWithData?

encryptedPassportElementWithDataOrThrow

inline fun EncryptedPassportElement.encryptedPassportElementWithDataOrThrow(): EncryptedPassportElementWithData

encryptedPassportElementWithEmailOrNull

inline fun EncryptedPassportElement.encryptedPassportElementWithEmailOrNull(): EncryptedPassportElementWithEmail?

encryptedPassportElementWithEmailOrThrow

inline fun EncryptedPassportElement.encryptedPassportElementWithEmailOrThrow(): EncryptedPassportElementWithEmail

encryptedPassportElementWithFilesCollectionOrNull

inline fun EncryptedPassportElement.encryptedPassportElementWithFilesCollectionOrNull(): EncryptedPassportElementWithFilesCollection?

encryptedPassportElementWithFilesCollectionOrThrow

inline fun EncryptedPassportElement.encryptedPassportElementWithFilesCollectionOrThrow(): EncryptedPassportElementWithFilesCollection

encryptedPassportElementWithFrontSideOrNull

inline fun EncryptedPassportElement.encryptedPassportElementWithFrontSideOrNull(): EncryptedPassportElementWithFrontSide?

encryptedPassportElementWithFrontSideOrThrow

inline fun EncryptedPassportElement.encryptedPassportElementWithFrontSideOrThrow(): EncryptedPassportElementWithFrontSide

encryptedPassportElementWithPhoneNumberOrNull

inline fun EncryptedPassportElement.encryptedPassportElementWithPhoneNumberOrNull(): EncryptedPassportElementWithPhoneNumber?

encryptedPassportElementWithPhoneNumberOrThrow

inline fun EncryptedPassportElement.encryptedPassportElementWithPhoneNumberOrThrow(): EncryptedPassportElementWithPhoneNumber

encryptedPassportElementWithReverseSideOrNull

inline fun EncryptedPassportElement.encryptedPassportElementWithReverseSideOrNull(): EncryptedPassportElementWithReverseSide?

encryptedPassportElementWithReverseSideOrThrow

inline fun EncryptedPassportElement.encryptedPassportElementWithReverseSideOrThrow(): EncryptedPassportElementWithReverseSide

encryptedPassportElementWithSelfieOrNull

inline fun EncryptedPassportElement.encryptedPassportElementWithSelfieOrNull(): EncryptedPassportElementWithSelfie?

encryptedPassportElementWithSelfieOrThrow

inline fun EncryptedPassportElement.encryptedPassportElementWithSelfieOrThrow(): EncryptedPassportElementWithSelfie

encryptedPassportElementWithTranslatableFilesCollectionOrNull

inline fun EncryptedPassportElement.encryptedPassportElementWithTranslatableFilesCollectionOrNull(): EncryptedPassportElementWithTranslatableFilesCollection?

encryptedPassportElementWithTranslatableFilesCollectionOrThrow

inline fun EncryptedPassportElement.encryptedPassportElementWithTranslatableFilesCollectionOrThrow(): EncryptedPassportElementWithTranslatableFilesCollection

encryptedPassportElementWithTranslatableIDDocumentOrNull

inline fun EncryptedPassportElement.encryptedPassportElementWithTranslatableIDDocumentOrNull(): EncryptedPassportElementWithTranslatableIDDocument?

encryptedPassportElementWithTranslatableIDDocumentOrThrow

inline fun EncryptedPassportElement.encryptedPassportElementWithTranslatableIDDocumentOrThrow(): EncryptedPassportElementWithTranslatableIDDocument

encryptedPersonalDetailsOrNull

inline fun EncryptedPassportElement.encryptedPersonalDetailsOrNull(): EncryptedPersonalDetails?

encryptedPersonalDetailsOrThrow

inline fun EncryptedPassportElement.encryptedPersonalDetailsOrThrow(): EncryptedPersonalDetails

identityCardOrNull

inline fun EncryptedPassportElement.identityCardOrNull(): IdentityCard?

identityCardOrThrow

inline fun EncryptedPassportElement.identityCardOrThrow(): IdentityCard

ifBankStatement

inline fun <T> EncryptedPassportElement.ifBankStatement(block: (BankStatement) -> T): T?

ifCommonPassport

inline fun <T> EncryptedPassportElement.ifCommonPassport(block: (CommonPassport) -> T): T?

ifDriverLicense

inline fun <T> EncryptedPassportElement.ifDriverLicense(block: (DriverLicense) -> T): T?

ifEmail

inline fun <T> EncryptedPassportElement.ifEmail(block: (Email) -> T): T?

ifEncryptedAddress

inline fun <T> EncryptedPassportElement.ifEncryptedAddress(block: (EncryptedAddress) -> T): T?

ifEncryptedPassportElementTranslatable

inline fun <T> EncryptedPassportElement.ifEncryptedPassportElementTranslatable(block: (EncryptedPassportElementTranslatable) -> T): T?

ifEncryptedPassportElementWithData

inline fun <T> EncryptedPassportElement.ifEncryptedPassportElementWithData(block: (EncryptedPassportElementWithData) -> T): T?

ifEncryptedPassportElementWithEmail

inline fun <T> EncryptedPassportElement.ifEncryptedPassportElementWithEmail(block: (EncryptedPassportElementWithEmail) -> T): T?

ifEncryptedPassportElementWithFilesCollection

inline fun <T> EncryptedPassportElement.ifEncryptedPassportElementWithFilesCollection(block: (EncryptedPassportElementWithFilesCollection) -> T): T?

ifEncryptedPassportElementWithFrontSide

inline fun <T> EncryptedPassportElement.ifEncryptedPassportElementWithFrontSide(block: (EncryptedPassportElementWithFrontSide) -> T): T?

ifEncryptedPassportElementWithPhoneNumber

inline fun <T> EncryptedPassportElement.ifEncryptedPassportElementWithPhoneNumber(block: (EncryptedPassportElementWithPhoneNumber) -> T): T?

ifEncryptedPassportElementWithReverseSide

inline fun <T> EncryptedPassportElement.ifEncryptedPassportElementWithReverseSide(block: (EncryptedPassportElementWithReverseSide) -> T): T?

ifEncryptedPassportElementWithSelfie

inline fun <T> EncryptedPassportElement.ifEncryptedPassportElementWithSelfie(block: (EncryptedPassportElementWithSelfie) -> T): T?

ifEncryptedPassportElementWithTranslatableFilesCollection

inline fun <T> EncryptedPassportElement.ifEncryptedPassportElementWithTranslatableFilesCollection(block: (EncryptedPassportElementWithTranslatableFilesCollection) -> T): T?

ifEncryptedPassportElementWithTranslatableIDDocument

inline fun <T> EncryptedPassportElement.ifEncryptedPassportElementWithTranslatableIDDocument(block: (EncryptedPassportElementWithTranslatableIDDocument) -> T): T?

ifEncryptedPersonalDetails

inline fun <T> EncryptedPassportElement.ifEncryptedPersonalDetails(block: (EncryptedPersonalDetails) -> T): T?

ifIdentityCard

inline fun <T> EncryptedPassportElement.ifIdentityCard(block: (IdentityCard) -> T): T?

ifInternalPassport

inline fun <T> EncryptedPassportElement.ifInternalPassport(block: (InternalPassport) -> T): T?

ifPassport

inline fun <T> EncryptedPassportElement.ifPassport(block: (Passport) -> T): T?

ifPassportRegistration

inline fun <T> EncryptedPassportElement.ifPassportRegistration(block: (PassportRegistration) -> T): T?

ifPhoneNumber

inline fun <T> EncryptedPassportElement.ifPhoneNumber(block: (PhoneNumber) -> T): T?

ifRentalAgreement

inline fun <T> EncryptedPassportElement.ifRentalAgreement(block: (RentalAgreement) -> T): T?

ifTemporaryRegistration

inline fun <T> EncryptedPassportElement.ifTemporaryRegistration(block: (TemporaryRegistration) -> T): T?

ifUnknownEncryptedPassportElement

inline fun <T> EncryptedPassportElement.ifUnknownEncryptedPassportElement(block: (UnknownEncryptedPassportElement) -> T): T?

ifUtilityBill

inline fun <T> EncryptedPassportElement.ifUtilityBill(block: (UtilityBill) -> T): T?

internalPassportOrNull

inline fun EncryptedPassportElement.internalPassportOrNull(): InternalPassport?

internalPassportOrThrow

inline fun EncryptedPassportElement.internalPassportOrThrow(): InternalPassport

passportOrNull

inline fun EncryptedPassportElement.passportOrNull(): Passport?

passportOrThrow

inline fun EncryptedPassportElement.passportOrThrow(): Passport

passportRegistrationOrNull

inline fun EncryptedPassportElement.passportRegistrationOrNull(): PassportRegistration?

passportRegistrationOrThrow

inline fun EncryptedPassportElement.passportRegistrationOrThrow(): PassportRegistration

phoneNumberOrNull

inline fun EncryptedPassportElement.phoneNumberOrNull(): PhoneNumber?

phoneNumberOrThrow

inline fun EncryptedPassportElement.phoneNumberOrThrow(): PhoneNumber

rentalAgreementOrNull

inline fun EncryptedPassportElement.rentalAgreementOrNull(): RentalAgreement?

rentalAgreementOrThrow

inline fun EncryptedPassportElement.rentalAgreementOrThrow(): RentalAgreement

requireBankStatement

inline fun EncryptedPassportElement.requireBankStatement(): BankStatement

requireCommonPassport

inline fun EncryptedPassportElement.requireCommonPassport(): CommonPassport

requireDriverLicense

inline fun EncryptedPassportElement.requireDriverLicense(): DriverLicense

requireEmail

inline fun EncryptedPassportElement.requireEmail(): Email

requireEncryptedAddress

inline fun EncryptedPassportElement.requireEncryptedAddress(): EncryptedAddress

requireEncryptedPassportElementTranslatable

inline fun EncryptedPassportElement.requireEncryptedPassportElementTranslatable(): EncryptedPassportElementTranslatable

requireEncryptedPassportElementWithData

inline fun EncryptedPassportElement.requireEncryptedPassportElementWithData(): EncryptedPassportElementWithData

requireEncryptedPassportElementWithEmail

inline fun EncryptedPassportElement.requireEncryptedPassportElementWithEmail(): EncryptedPassportElementWithEmail

requireEncryptedPassportElementWithFilesCollection

inline fun EncryptedPassportElement.requireEncryptedPassportElementWithFilesCollection(): EncryptedPassportElementWithFilesCollection

requireEncryptedPassportElementWithFrontSide

inline fun EncryptedPassportElement.requireEncryptedPassportElementWithFrontSide(): EncryptedPassportElementWithFrontSide

requireEncryptedPassportElementWithPhoneNumber

inline fun EncryptedPassportElement.requireEncryptedPassportElementWithPhoneNumber(): EncryptedPassportElementWithPhoneNumber

requireEncryptedPassportElementWithReverseSide

inline fun EncryptedPassportElement.requireEncryptedPassportElementWithReverseSide(): EncryptedPassportElementWithReverseSide

requireEncryptedPassportElementWithSelfie

inline fun EncryptedPassportElement.requireEncryptedPassportElementWithSelfie(): EncryptedPassportElementWithSelfie

requireEncryptedPassportElementWithTranslatableFilesCollection

inline fun EncryptedPassportElement.requireEncryptedPassportElementWithTranslatableFilesCollection(): EncryptedPassportElementWithTranslatableFilesCollection

requireEncryptedPassportElementWithTranslatableIDDocument

inline fun EncryptedPassportElement.requireEncryptedPassportElementWithTranslatableIDDocument(): EncryptedPassportElementWithTranslatableIDDocument

requireEncryptedPersonalDetails

inline fun EncryptedPassportElement.requireEncryptedPersonalDetails(): EncryptedPersonalDetails

requireIdentityCard

inline fun EncryptedPassportElement.requireIdentityCard(): IdentityCard

requireInternalPassport

inline fun EncryptedPassportElement.requireInternalPassport(): InternalPassport

requirePassport

inline fun EncryptedPassportElement.requirePassport(): Passport

requirePassportRegistration

inline fun EncryptedPassportElement.requirePassportRegistration(): PassportRegistration

requirePhoneNumber

inline fun EncryptedPassportElement.requirePhoneNumber(): PhoneNumber

requireRentalAgreement

inline fun EncryptedPassportElement.requireRentalAgreement(): RentalAgreement

requireTemporaryRegistration

inline fun EncryptedPassportElement.requireTemporaryRegistration(): TemporaryRegistration

requireUnknownEncryptedPassportElement

inline fun EncryptedPassportElement.requireUnknownEncryptedPassportElement(): UnknownEncryptedPassportElement

requireUtilityBill

inline fun EncryptedPassportElement.requireUtilityBill(): UtilityBill

temporaryRegistrationOrNull

inline fun EncryptedPassportElement.temporaryRegistrationOrNull(): TemporaryRegistration?

temporaryRegistrationOrThrow

inline fun EncryptedPassportElement.temporaryRegistrationOrThrow(): TemporaryRegistration

unknownEncryptedPassportElementOrNull

inline fun EncryptedPassportElement.unknownEncryptedPassportElementOrNull(): UnknownEncryptedPassportElement?

unknownEncryptedPassportElementOrThrow

inline fun EncryptedPassportElement.unknownEncryptedPassportElementOrThrow(): UnknownEncryptedPassportElement

utilityBillOrNull

inline fun EncryptedPassportElement.utilityBillOrNull(): UtilityBill?

utilityBillOrThrow

inline fun EncryptedPassportElement.utilityBillOrThrow(): UtilityBill

whenBankStatement

inline fun <T> EncryptedPassportElement.whenBankStatement(block: (BankStatement) -> T): T?

whenCommonPassport

inline fun <T> EncryptedPassportElement.whenCommonPassport(block: (CommonPassport) -> T): T?

whenDriverLicense

inline fun <T> EncryptedPassportElement.whenDriverLicense(block: (DriverLicense) -> T): T?

whenEmail

inline fun <T> EncryptedPassportElement.whenEmail(block: (Email) -> T): T?

whenEncryptedAddress

inline fun <T> EncryptedPassportElement.whenEncryptedAddress(block: (EncryptedAddress) -> T): T?

whenEncryptedPassportElementTranslatable

inline fun <T> EncryptedPassportElement.whenEncryptedPassportElementTranslatable(block: (EncryptedPassportElementTranslatable) -> T): T?

whenEncryptedPassportElementWithData

inline fun <T> EncryptedPassportElement.whenEncryptedPassportElementWithData(block: (EncryptedPassportElementWithData) -> T): T?

whenEncryptedPassportElementWithEmail

inline fun <T> EncryptedPassportElement.whenEncryptedPassportElementWithEmail(block: (EncryptedPassportElementWithEmail) -> T): T?

whenEncryptedPassportElementWithFilesCollection

inline fun <T> EncryptedPassportElement.whenEncryptedPassportElementWithFilesCollection(block: (EncryptedPassportElementWithFilesCollection) -> T): T?

whenEncryptedPassportElementWithFrontSide

inline fun <T> EncryptedPassportElement.whenEncryptedPassportElementWithFrontSide(block: (EncryptedPassportElementWithFrontSide) -> T): T?

whenEncryptedPassportElementWithPhoneNumber

inline fun <T> EncryptedPassportElement.whenEncryptedPassportElementWithPhoneNumber(block: (EncryptedPassportElementWithPhoneNumber) -> T): T?

whenEncryptedPassportElementWithReverseSide

inline fun <T> EncryptedPassportElement.whenEncryptedPassportElementWithReverseSide(block: (EncryptedPassportElementWithReverseSide) -> T): T?

whenEncryptedPassportElementWithSelfie

inline fun <T> EncryptedPassportElement.whenEncryptedPassportElementWithSelfie(block: (EncryptedPassportElementWithSelfie) -> T): T?

whenEncryptedPassportElementWithTranslatableFilesCollection

inline fun <T> EncryptedPassportElement.whenEncryptedPassportElementWithTranslatableFilesCollection(block: (EncryptedPassportElementWithTranslatableFilesCollection) -> T): T?

whenEncryptedPassportElementWithTranslatableIDDocument

inline fun <T> EncryptedPassportElement.whenEncryptedPassportElementWithTranslatableIDDocument(block: (EncryptedPassportElementWithTranslatableIDDocument) -> T): T?

whenEncryptedPersonalDetails

inline fun <T> EncryptedPassportElement.whenEncryptedPersonalDetails(block: (EncryptedPersonalDetails) -> T): T?

whenIdentityCard

inline fun <T> EncryptedPassportElement.whenIdentityCard(block: (IdentityCard) -> T): T?

whenInternalPassport

inline fun <T> EncryptedPassportElement.whenInternalPassport(block: (InternalPassport) -> T): T?

whenPassport

inline fun <T> EncryptedPassportElement.whenPassport(block: (Passport) -> T): T?

whenPassportRegistration

inline fun <T> EncryptedPassportElement.whenPassportRegistration(block: (PassportRegistration) -> T): T?

whenPhoneNumber

inline fun <T> EncryptedPassportElement.whenPhoneNumber(block: (PhoneNumber) -> T): T?

whenRentalAgreement

inline fun <T> EncryptedPassportElement.whenRentalAgreement(block: (RentalAgreement) -> T): T?

whenTemporaryRegistration

inline fun <T> EncryptedPassportElement.whenTemporaryRegistration(block: (TemporaryRegistration) -> T): T?

whenUnknownEncryptedPassportElement

inline fun <T> EncryptedPassportElement.whenUnknownEncryptedPassportElement(block: (UnknownEncryptedPassportElement) -> T): T?

whenUtilityBill

inline fun <T> EncryptedPassportElement.whenUtilityBill(block: (UtilityBill) -> T): T?

Properties

data

abstract val data: EncryptedData

frontSide

abstract val frontSide: PassportFile?

hash

abstract val hash: PassportElementHash

selfie

abstract val selfie: PassportFile?

translations

abstract val translations: List<PassportFile>

type

val EncryptedPassportElement.type: String