Record Class SendGift

java.lang.Object

java.lang.Record

org.teleight.teleightbots.api.methods.SendGift

All Implemented Interfaces:

ApiMethod<Boolean>, ApiMethodBoolean

public record SendGift(int userId, @Nullable String chatId, @NotNull String giftId, boolean payForUpgrade, @Nullable String text, @Nullable ParseMode textParseMode, @Nullable MessageEntity[] textEntities)
extends Record
implements ApiMethodBoolean

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SendGift.Builder

Field Summary

Fields inherited from interface ApiMethod

OBJECT_MAPPER

Constructor Summary

Constructors

Constructor	Description
SendGift(int userId, @Nullable String chatId, @NotNull String giftId, boolean payForUpgrade, @Nullable String text, @Nullable ParseMode textParseMode, @Nullable MessageEntity[] textEntities)	Creates an instance of a SendGift record class.

Method Summary

Modifier and Type	Method	Description
@Nullable String	chatId()	Returns the value of the chatId record component.
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.
@NotNull String	giftId()	Returns the value of the giftId record component.
final int	hashCode()	Returns a hash code value for this object.
static @NotNull SendGift.Builder	ofBuilder(int userId, String giftId)
boolean	payForUpgrade()	Returns the value of the payForUpgrade record component.
@Nullable String	text()	Returns the value of the text record component.
@Nullable MessageEntity[]	textEntities()	Returns the value of the textEntities record component.
@Nullable ParseMode	textParseMode()	Returns the value of the textParseMode record component.
SendGift.Builder	toBuilder()
final String	toString()	Returns a string representation of this record class.
int	userId()	Returns the value of the userId record component.

Methods inherited from class Object

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

Methods inherited from interface ApiMethod

deserializeResponse, deserializeResponseArray, deserializeResponseSerializable

Methods inherited from interface ApiMethodBoolean

deserializeResponse

Constructor Details

SendGift

public SendGift(int userId,
 @Nullable
 @Nullable String chatId,
 @NotNull
 @NotNull String giftId,
 boolean payForUpgrade,
 @Nullable
 @Nullable String text,
 @Nullable
 @Nullable ParseMode textParseMode,
 @Nullable
 @Nullable MessageEntity[] textEntities)

Creates an instance of a SendGift record class.

Parameters:

userId - the value for the userId record component

chatId - the value for the chatId record component

giftId - the value for the giftId record component

payForUpgrade - the value for the payForUpgrade record component

text - the value for the text record component

textParseMode - the value for the textParseMode record component

textEntities - the value for the textEntities record component

Method Details

ofBuilder

@NotNull
public static @NotNull SendGift.Builder ofBuilder(int userId,
 String giftId)

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<Boolean>

Returns:

the endpoint URL

toBuilder

public SendGift.Builder toBuilder()

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 the compare method from their corresponding wrapper classes.

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.

userId

public int userId()

Returns the value of the userId record component.

Returns:

the value of the userId record component

chatId

@Nullable
public @Nullable String chatId()

Returns the value of the chatId record component.

Returns:

the value of the chatId record component

giftId

@NotNull
public @NotNull String giftId()

Returns the value of the giftId record component.

Returns:

the value of the giftId record component

payForUpgrade

public boolean payForUpgrade()

Returns the value of the payForUpgrade record component.

Returns:

the value of the payForUpgrade record component

text

@Nullable
public @Nullable String text()

Returns the value of the text record component.

Returns:

the value of the text record component

textParseMode

@Nullable
public @Nullable ParseMode textParseMode()

Returns the value of the textParseMode record component.

Returns:

the value of the textParseMode record component

textEntities

@Nullable
public @Nullable MessageEntity[] textEntities()

Returns the value of the textEntities record component.

Returns:

the value of the textEntities record component