Package org.telegram.telegrambots.meta.api.methods.updates

Class SetWebhook

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.botapimethods.BotApiMethodBoolean

org.telegram.telegrambots.meta.api.methods.updates.SetWebhook

All Implemented Interfaces:

Validable

public class SetWebhook
extends BotApiMethodBoolean

Version:

6.1 Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success. If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.

Author:

Ruben Bermudez

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOWEDUPDATES_FIELD
static final String	CERTIFICATE_FIELD
static final String	DROPPENDINGUPDATES_FIELD
static final String	IPADDRESS_FIELD
static final String	MAXCONNECTIONS_FIELD
static final String	PATH
static final String	SECRETTOKEN_FIELD
static final String	URL_FIELD

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	Description
SetWebhook()

Method Summary

Modifier and Type	Method	Description
String	getMethod()	Getter for method path (that is the same as method name)
void	validate()	Validates that mandatory fields are filled and optional objects

Methods inherited from class org.telegram.telegrambots.meta.api.methods.botapimethods.BotApiMethodBoolean

deserializeResponse

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

deserializeResponse, deserializeResponseArray, deserializeResponseSerializable

Methods inherited from class java.lang.Object

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

Field Details

PATH

public static final String PATH

See Also:

• Constant Field Values

URL_FIELD

public static final String URL_FIELD

See Also:

• Constant Field Values

CERTIFICATE_FIELD

public static final String CERTIFICATE_FIELD

See Also:

• Constant Field Values

MAXCONNECTIONS_FIELD

public static final String MAXCONNECTIONS_FIELD

See Also:

• Constant Field Values

ALLOWEDUPDATES_FIELD

public static final String ALLOWEDUPDATES_FIELD

See Also:

• Constant Field Values

IPADDRESS_FIELD

public static final String IPADDRESS_FIELD

See Also:

• Constant Field Values

DROPPENDINGUPDATES_FIELD

public static final String DROPPENDINGUPDATES_FIELD

See Also:

• Constant Field Values

SECRETTOKEN_FIELD

public static final String SECRETTOKEN_FIELD

See Also:

• Constant Field Values

Constructor Details

SetWebhook

public SetWebhook()

Method Details

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

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