org.telegram.telegrambots.api.methods.send

Class SendChatAction

java.lang.Object

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

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

org.telegram.telegrambots.api.methods.send.SendChatAction

All Implemented Interfaces:

Validable

public class SendChatAction
extends BotApiMethod<Boolean>

Version:

1.0 Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).

Author:

Ruben Bermudez

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_FIELD
static String	CHATID_FIELD
static String	PATH

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

METHOD_FIELD

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

OBJECT_MAPPER

Constructor Summary

Constructors

Constructor and Description
SendChatAction()
SendChatAction(Long chatId, String action)
SendChatAction(String chatId, String action)

Method Summary

Modifier and Type	Method and Description
Boolean	deserializeResponse(String answer) Deserialize a json answer to the response type to a method
ActionType	getAction()
String	getChatId()
String	getMethod() Getter for method path (that is the same as method name)
SendChatAction	setAction(ActionType action)
SendChatAction	setChatId(Long chatId)
SendChatAction	setChatId(String chatId)
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

CHATID_FIELD

public static final String CHATID_FIELD

See Also:

Constant Field Values

ACTION_FIELD

public static final String ACTION_FIELD

See Also:

Constant Field Values

Constructor Detail

SendChatAction

public SendChatAction()

SendChatAction

public SendChatAction(String chatId,
                      String action)

SendChatAction

public SendChatAction(Long chatId,
                      String action)

Method Detail

getChatId

public String getChatId()

getAction

public ActionType getAction()

setChatId

public SendChatAction setChatId(String chatId)

setChatId

public SendChatAction setChatId(Long chatId)

setAction

public SendChatAction setAction(ActionType action)

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

toString

public String toString()

Overrides:

toString in class Object