Class GiftPremiumSubscription

java.lang.Object

io.github.natanimn.telebof.requests.AbstractBaseRequest<GiftPremiumSubscription, Boolean>

io.github.natanimn.telebof.requests.service.GiftPremiumSubscription

public class GiftPremiumSubscription
extends AbstractBaseRequest<GiftPremiumSubscription, Boolean>

GiftPremiumSubscription class. Returns True on success.

Since:

19 August 2025

See Also:

• BotContext.giftPremiumSubscription(long, java.lang.Integer, java.lang.Integer)

Constructor Summary

Constructors

Constructor	Description
GiftPremiumSubscription(long user_id, Integer month_count, Integer star_count, Api api)	Required

Method Summary

Modifier and Type	Method	Description
GiftPremiumSubscription	text(String text)	Optional
GiftPremiumSubscription	textEntities(MessageEntity[] text_entities)	Optional
GiftPremiumSubscription	textParseMode(ParseMode text_parse_mode)	Optional

Methods inherited from class io.github.natanimn.telebof.requests.AbstractBaseRequest

exec

Methods inherited from class java.lang.Object

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

Constructor Details

GiftPremiumSubscription

public GiftPremiumSubscription(long user_id,
 Integer month_count,
 Integer star_count,
 Api api)

Required

Parameters:

user_id - Unique identifier of the target user who will receive a Telegram Premium subscription

month_count - Number of months the Telegram Premium subscription will be active for the user

star_count - Number of Telegram Stars to pay for the Telegram Premium subscription

api - api

Method Details

text

public GiftPremiumSubscription text(String text)

Optional

Parameters:

text - Text that will be shown along with the service message about the subscription; 0-128 characters

Returns:

GiftPremiumSubscription

textParseMode

public GiftPremiumSubscription textParseMode(ParseMode text_parse_mode)

Optional

Parameters:

text_parse_mode - Mode for parsing entities in the text. Entities other than EntityType.BOLD, EntityType.ITALIC, EntityType.UNDERLINE, EntityType.STRIKETHROUGH, EntityType.SPOILER, and EntityType.CUSTOM_EMOJI are ignored.

Returns:

GiftPremiumSubscription

textEntities

public GiftPremiumSubscription textEntities(MessageEntity[] text_entities)

Optional

Parameters:

text_entities - A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of textParseMode(ParseMode). Entities other than EntityType.BOLD, EntityType.ITALIC, EntityType.UNDERLINE, EntityType.STRIKETHROUGH, EntityType.SPOILER, and EntityType.CUSTOM_EMOJI are ignored.

Returns:

GiftPremiumSubscription