org.telegram.telegrambots.meta.api.methods

Class SetPassportDataErrors

java.lang.Object

org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod<T>

org.telegram.telegrambots.meta.api.methods.BotApiMethod<Boolean>

org.telegram.telegrambots.meta.api.methods.SetPassportDataErrors

All Implemented Interfaces:

Validable

public class SetPassportDataErrors
extends BotApiMethod<Boolean>

Version:

4.0.0 Informs a user that some Telegram Passport data contains errors. The user will not be able to resend data, until the errors are fixed

Author:

Ruben Bermudez

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Fields inherited from class org.telegram.telegrambots.meta.api.methods.BotApiMethod

METHOD_FIELD

Fields inherited from class org.telegram.telegrambots.meta.api.methods.PartialBotApiMethod

OBJECT_MAPPER

Constructor Summary

Constructors

Constructor and Description
SetPassportDataErrors()
SetPassportDataErrors(Integer userId, List<PassportElementError> errors)

Method Summary

Modifier and Type	Method and Description
SetPassportDataErrors	addError(PassportElementError error)
Boolean	deserializeResponse(String answer) Deserialize a json answer to the response type to a method
List<PassportElementError>	getErrors()
String	getMethod() Getter for method path (that is the same as method name)
Integer	getUserId()
SetPassportDataErrors	setErrors(List<PassportElementError> errors)
SetPassportDataErrors	setUserId(Integer userId)
void	validate() Validates that mandatory fields are filled and optional objects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PATH

public static final String PATH

See Also:

Constant Field Values

Constructor Detail

SetPassportDataErrors

public SetPassportDataErrors(Integer userId,
                             List<PassportElementError> errors)

SetPassportDataErrors

public SetPassportDataErrors()

Method Detail

getUserId

public Integer getUserId()

setUserId

public SetPassportDataErrors setUserId(Integer userId)

getErrors

public List<PassportElementError> getErrors()

setErrors

public SetPassportDataErrors setErrors(List<PassportElementError> errors)

addError

public SetPassportDataErrors addError(PassportElementError error)

getMethod

public String getMethod()

Description copied from class: BotApiMethod

Getter for method path (that is the same as method name)

Specified by:

getMethod in class BotApiMethod<Boolean>

Returns:

Method path

deserializeResponse

public Boolean deserializeResponse(String answer)
                            throws TelegramApiRequestException

Description copied from class: PartialBotApiMethod

Deserialize a json answer to the response type to a method

Specified by:

deserializeResponse in class PartialBotApiMethod<Boolean>

Parameters:

answer - Json answer received

Returns:

Answer for the method

Throws:

TelegramApiRequestException

validate

public void validate()
              throws TelegramApiValidationException

Description copied from interface: Validable

Validates that mandatory fields are filled and optional objects

Throws:

TelegramApiValidationException - If any mandatory field is empty