org.drinkless.tdlib

Class TdApi.SendGift

java.lang.Object

org.drinkless.tdlib.TdApi.Object

org.drinkless.tdlib.TdApi.Function<TdApi.Ok>

org.drinkless.tdlib.TdApi.SendGift

Enclosing class:

TdApi

public static class TdApi.SendGift
extends TdApi.Function<TdApi.Ok>

Sends a gift to another user. May return an error with a message "STARGIFT_USAGE_LIMITED" if the gift was sold out.

Returns Ok

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONSTRUCTOR Identifier uniquely determining type of the object.
long	giftId Identifier of the gift to send.
boolean	isPrivate Pass true to show the current user as sender and gift text only to the gift receiver; otherwise, everyone will be able to see them.
TdApi.FormattedText	text Text to show along with the gift; 0-getOption("gift_text_length_max") characters.
long	userId Identifier of the user that will receive the gift.

Constructor Summary

Constructors

Constructor and Description
SendGift() Default constructor for a function, which sends a gift to another user.
SendGift(long giftId, long userId, TdApi.FormattedText text, boolean isPrivate) Creates a function, which sends a gift to another user.

Method Summary

Modifier and Type	Method and Description
int	getConstructor() Returns an identifier uniquely determining type of the object.

Methods inherited from class org.drinkless.tdlib.TdApi.Function

toString

Methods inherited from class java.lang.Object

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

Field Detail

giftId

public long giftId

Identifier of the gift to send.

userId

public long userId

Identifier of the user that will receive the gift.

text

public TdApi.FormattedText text

Text to show along with the gift; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed.

isPrivate

public boolean isPrivate

Pass true to show the current user as sender and gift text only to the gift receiver; otherwise, everyone will be able to see them.

CONSTRUCTOR

public static final int CONSTRUCTOR

Identifier uniquely determining type of the object.

See Also:

Constant Field Values

Constructor Detail

SendGift

public SendGift()

Default constructor for a function, which sends a gift to another user. May return an error with a message "STARGIFT_USAGE_LIMITED" if the gift was sold out.

Returns Ok

SendGift

public SendGift(long giftId,
                long userId,
                TdApi.FormattedText text,
                boolean isPrivate)

Creates a function, which sends a gift to another user. May return an error with a message "STARGIFT_USAGE_LIMITED" if the gift was sold out.

Returns Ok

Parameters:

giftId - Identifier of the gift to send.

userId - Identifier of the user that will receive the gift.

text - Text to show along with the gift; 0-getOption("gift_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, and CustomEmoji entities are allowed.

isPrivate - Pass true to show the current user as sender and gift text only to the gift receiver; otherwise, everyone will be able to see them.

Method Detail

getConstructor

public int getConstructor()

Description copied from class: TdApi.Object

Returns an identifier uniquely determining type of the object.

Specified by:

getConstructor in class TdApi.Object

Returns:

this.CONSTRUCTOR