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

Class SendDocument

Object

PartialBotApiMethod<T>

SendMediaBotMethod<Message>

SendDocument

All Implemented Interfaces:

Validable

public class SendDocument
extends SendMediaBotMethod<Message>

Version:

1.0 Use this method to send general files. On success, the sent Message is returned.

Author:

Ruben Bermudez

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SendDocument.SendDocumentBuilder<C extends SendDocument,B extends SendDocument.SendDocumentBuilder<C,B>>

Nested classes/interfaces inherited from class SendMediaBotMethod

SendMediaBotMethod.SendMediaBotMethodBuilder<T extends Serializable,C extends SendMediaBotMethod<T>,B extends SendMediaBotMethod.SendMediaBotMethodBuilder<T,C,B>>

Nested classes/interfaces inherited from class PartialBotApiMethod

PartialBotApiMethod.PartialBotApiMethodBuilder<T extends Serializable,C extends PartialBotApiMethod<T>,B extends PartialBotApiMethod.PartialBotApiMethodBuilder<T,C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUSINESS_CONNECTION_ID_FIELD
static final String	CAPTION_ENTITIES_FIELD
static final String	CAPTION_FIELD
static final String	DISABLECONTENTTYPEDETECTION_FIELD
static final String	DOCUMENT_FIELD
static final String	PARSEMODE_FIELD
static final String	PATH
static final String	THUMBNAIL_FIELD

Fields inherited from class SendMediaBotMethod

ALLOW_PAID_BROADCAST_FIELD, ALLOW_SENDING_WITHOUT_REPLY_FIELD, CHAT_ID_FIELD, DISABLE_NOTIFICATION_FIELD, MESSAGE_EFFECT_ID_FIELD, MESSAGE_THREAD_ID_FIELD, PROTECT_CONTENT_FIELD, REPLY_MARKUP_FIELD, REPLY_PARAMETERS_FIELD, REPLY_TO_MESSAGE_ID_FIELD

Fields inherited from class PartialBotApiMethod

OBJECT_MAPPER

Constructor Summary

Constructors

Constructor	Description
SendDocument()

Method Summary

Modifier and Type	Method	Description
Message	deserializeResponse(String answer)	Deserialize a json answer to the response type to a method
void	disableNotification()
void	enableNotification()
InputFile	getFile()
String	getFileField()
String	getMethod()	Getter for method path (that is the same as method name)
void	setChatId(@NonNull Long chatId)
void	validate()	Validates that mandatory fields are filled and optional objects

Methods inherited from class SendMediaBotMethod

getAllowPaidBroadcast, getAllowSendingWithoutReply, getChatId, getDisableNotification, getMessageEffectId, getMessageThreadId, getProtectContent, getReplyMarkup, getReplyParameters, getReplyToMessageId

Methods inherited from class PartialBotApiMethod

deserializeResponse, deserializeResponseArray, deserializeResponseSerializable

Methods inherited from class 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

DOCUMENT_FIELD

public static final String DOCUMENT_FIELD

See Also:

• Constant Field Values

CAPTION_FIELD

public static final String CAPTION_FIELD

See Also:

• Constant Field Values

PARSEMODE_FIELD

public static final String PARSEMODE_FIELD

See Also:

• Constant Field Values

THUMBNAIL_FIELD

public static final String THUMBNAIL_FIELD

See Also:

• Constant Field Values

CAPTION_ENTITIES_FIELD

public static final String CAPTION_ENTITIES_FIELD

See Also:

• Constant Field Values

DISABLECONTENTTYPEDETECTION_FIELD

public static final String DISABLECONTENTTYPEDETECTION_FIELD

See Also:

• Constant Field Values

BUSINESS_CONNECTION_ID_FIELD

public static final String BUSINESS_CONNECTION_ID_FIELD

See Also:

• Constant Field Values

Constructor Details

SendDocument

public SendDocument()

Method Details

setChatId

public void setChatId(@NonNull
 @NonNull Long chatId)

enableNotification

public void enableNotification()

disableNotification

public void disableNotification()

deserializeResponse

public Message deserializeResponse(String answer)
                            throws TelegramApiRequestException

Description copied from class: PartialBotApiMethod

Deserialize a json answer to the response type to a method

Specified by:

deserializeResponse in class PartialBotApiMethod<Message>

Parameters:

answer - Json answer received

Returns:

Answer for the method

Throws:

TelegramApiRequestException

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

getFile

public InputFile getFile()

Specified by:

getFile in class SendMediaBotMethod<Message>

getFileField

public String getFileField()

Specified by:

getFileField in class SendMediaBotMethod<Message>

getMethod

public String getMethod()

Description copied from class: PartialBotApiMethod

Getter for method path (that is the same as method name)

Specified by:

getMethod in class PartialBotApiMethod<Message>

Returns:

Method path