Package org.teleight.teleightbots.api.methods

Record Class GetUpdates

java.lang.Object

java.lang.Record

org.teleight.teleightbots.api.methods.GetUpdates

All Implemented Interfaces:

ApiMethod<Update[]>

public record GetUpdates(int offset, int limit, int timeout, @Nullable List<String> allowedUpdates)
extends Record
implements ApiMethod<Update[]>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetUpdates.Builder

Field Summary

Fields inherited from interface org.teleight.teleightbots.api.ApiMethod

OBJECT_MAPPER

Constructor Summary

Constructors

Constructor	Description
GetUpdates(int offset, int limit, int timeout, @Nullable List<String> allowedUpdates)	Creates an instance of a GetUpdates record class.

Method Summary

Modifier and Type	Method	Description
@Nullable List<String>	allowedUpdates()	Returns the value of the allowedUpdates record component.
Update @NotNull []	deserializeResponse(@NotNull String answer)	Deserializes the response from the Telegram Bot API.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull String	getEndpointURL()	Returns the endpoint URL for the Telegram Bot API method.
final int	hashCode()	Returns a hash code value for this object.
int	limit()	Returns the value of the limit record component.
int	offset()	Returns the value of the offset record component.
int	timeout()	Returns the value of the timeout record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.teleight.teleightbots.api.ApiMethod

deserializeResponse, deserializeResponseArray, deserializeResponseSerializable

Constructor Details

GetUpdates

public GetUpdates(int offset,
 int limit,
 int timeout,
 @Nullable
 @Nullable List<String> allowedUpdates)

Creates an instance of a GetUpdates record class.

Parameters:

offset - the value for the offset record component

limit - the value for the limit record component

timeout - the value for the timeout record component

allowedUpdates - the value for the allowedUpdates record component

Method Details

deserializeResponse

public Update @NotNull [] deserializeResponse(@NotNull
 @NotNull String answer)
                                       throws TelegramRequestException

Description copied from interface: ApiMethod

Deserializes the response from the Telegram Bot API.

Specified by:

deserializeResponse in interface ApiMethod<Update[]>

Parameters:

answer - the response from the Telegram Bot API

Returns:

the deserialized response

Throws:

TelegramRequestException - if an error occurs while deserializing the response

getEndpointURL

@NotNull
public @NotNull String getEndpointURL()

Description copied from interface: ApiMethod

Returns the endpoint URL for the Telegram Bot API method.

Specified by:

getEndpointURL in interface ApiMethod<Update[]>

Returns:

the endpoint URL

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

offset

public int offset()

Returns the value of the offset record component.

Returns:

the value of the offset record component

limit

public int limit()

Returns the value of the limit record component.

Returns:

the value of the limit record component

timeout

public int timeout()

Returns the value of the timeout record component.

Returns:

the value of the timeout record component

allowedUpdates

@Nullable
public @Nullable List<String> allowedUpdates()

Returns the value of the allowedUpdates record component.

Returns:

the value of the allowedUpdates record component