org.telegram.telegrambots.meta.api.methods

Class AnswerShippingQuery

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.AnswerShippingQuery

All Implemented Interfaces:

Validable

public class AnswerShippingQuery
extends BotApiMethod<Boolean>

Version:

1.0 If you sent an invoice requesting a shipping address and the parameter flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned

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
AnswerShippingQuery() Creates an empty answer shipping query
AnswerShippingQuery(String shippingQueryId, Boolean ok) Creates an answer shipping query with mandatory parameters

Method Summary

Modifier and Type	Method and Description
Boolean	deserializeResponse(String answer) Deserialize a json answer to the response type to a method
String	getErrorMessage()
String	getMethod() Getter for method path (that is the same as method name)
Boolean	getOk()
List<ShippingOption>	getShippingOptions()
String	getShippingQueryId()
AnswerShippingQuery	setErrorMessage(String errorMessage)
AnswerShippingQuery	setOk(Boolean ok)
AnswerShippingQuery	setShippingOptions(List<ShippingOption> shippingOptions)
AnswerShippingQuery	setShippingQueryId(String shippingQueryId)
String	toString()
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, wait, wait, wait

Field Detail

PATH

public static final String PATH

See Also:

Constant Field Values

Constructor Detail

AnswerShippingQuery

public AnswerShippingQuery()

Creates an empty answer shipping query

AnswerShippingQuery

public AnswerShippingQuery(String shippingQueryId,
                           Boolean ok)

Creates an answer shipping query with mandatory parameters

Parameters:

shippingQueryId - Unique identifier for the query to be answered

ok - Specify True if delivery to the specified address is possible and False if there are any problems

Method Detail

getShippingQueryId

public String getShippingQueryId()

setShippingQueryId

public AnswerShippingQuery setShippingQueryId(String shippingQueryId)

getOk

public Boolean getOk()

setOk

public AnswerShippingQuery setOk(Boolean ok)

getShippingOptions

public List<ShippingOption> getShippingOptions()

setShippingOptions

public AnswerShippingQuery setShippingOptions(List<ShippingOption> shippingOptions)

getErrorMessage

public String getErrorMessage()

setErrorMessage

public AnswerShippingQuery setErrorMessage(String errorMessage)

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

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

toString

public String toString()

Overrides:

toString in class Object