pro.zackpollard.telegrambot.api.chat.inline.send.results

Class InlineQueryResultDocument.InlineQueryResultDocumentBuilder

java.lang.Object

pro.zackpollard.telegrambot.api.chat.inline.send.results.InlineQueryResultDocument.InlineQueryResultDocumentBuilder

Enclosing class:

InlineQueryResultDocument

public static class InlineQueryResultDocument.InlineQueryResultDocumentBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
InlineQueryResultDocument	build() Builds the InlineQueryResultDocument object
InlineQueryResultDocument.InlineQueryResultDocumentBuilder	caption(String caption) *Optional* Sets the caption to the provided value.
InlineQueryResultDocument.InlineQueryResultDocumentBuilder	description(String description) *Optional* Sets a short description of the result to be shown in the inline result selection pane
InlineQueryResultDocument.InlineQueryResultDocumentBuilder	documentUrl(URL documentUrl) *Required* Sets the URL of the document for the result
InlineQueryResultDocument.InlineQueryResultDocumentBuilder	id(String id) *Optional* Sets the ID to the provided value.
InlineQueryResultDocument.InlineQueryResultDocumentBuilder	inputMessageContent(InputMessageContent inputMessageContent) *Optional* Sets the content you want to be sent with this result to the provided InputMessageContent object
InlineQueryResultDocument.InlineQueryResultDocumentBuilder	mimeType(String mimeType) *Required* Sets the mime type of the document file.
InlineQueryResultDocument.InlineQueryResultDocumentBuilder	replyMarkup(InlineReplyMarkup replyMarkup) *Optional* Sets the inline keyboard attached to this message to the InlineReplyMarkup provided
InlineQueryResultDocument.InlineQueryResultDocumentBuilder	thumbHeight(int thumbHeight) *Optional* Sets the height of the thumbnail at the previously provided URL through thumbUrl(URL)
InlineQueryResultDocument.InlineQueryResultDocumentBuilder	thumbUrl(URL thumbUrl) *Optional* Sets the URL of the thumbnail that should show next to the result in the inline result selection pane
InlineQueryResultDocument.InlineQueryResultDocumentBuilder	thumbWidth(int thumbWidth) *Optional* Sets the width of the thumbnail at the previously provided URL through thumbUrl(URL)
InlineQueryResultDocument.InlineQueryResultDocumentBuilder	title(String title) *Required* Sets the title to the provided value

Methods inherited from class java.lang.Object

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

Method Detail

id

public InlineQueryResultDocument.InlineQueryResultDocumentBuilder id(String id)

*Optional* Sets the ID to the provided value. If none is set a random 32 char long ID will be generated.

Parameters:

id - The ID you want the result to have

Returns:

The builder object

title

public InlineQueryResultDocument.InlineQueryResultDocumentBuilder title(String title)

*Required* Sets the title to the provided value

Parameters:

title - The title you want the result to have

Returns:

The builder object

caption

public InlineQueryResultDocument.InlineQueryResultDocumentBuilder caption(String caption)

*Optional* Sets the caption to the provided value. This can be 0-200 characters in length

Parameters:

caption - The caption you want the result to have

Returns:

The builder object

documentUrl

public InlineQueryResultDocument.InlineQueryResultDocumentBuilder documentUrl(URL documentUrl)

*Required* Sets the URL of the document for the result

Parameters:

documentUrl - The URL of the document for the result

Returns:

The builder object

mimeType

public InlineQueryResultDocument.InlineQueryResultDocumentBuilder mimeType(String mimeType)

*Required* Sets the mime type of the document file. E.g. application/pdf or application/msword

Parameters:

mimeType - The mimetype of the document being sent for this result

Returns:

The builder object

See Also:

You can find a complete list of mimetypes here

description

public InlineQueryResultDocument.InlineQueryResultDocumentBuilder description(String description)

*Optional* Sets a short description of the result to be shown in the inline result selection pane

Parameters:

description - The description you want to be shown in the result selection pane

Returns:

The builder object

replyMarkup

public InlineQueryResultDocument.InlineQueryResultDocumentBuilder replyMarkup(InlineReplyMarkup replyMarkup)

*Optional* Sets the inline keyboard attached to this message to the InlineReplyMarkup provided

Parameters:

replyMarkup - The inline keyboard you want to attach to the message

Returns:

The builder object

inputMessageContent

public InlineQueryResultDocument.InlineQueryResultDocumentBuilder inputMessageContent(InputMessageContent inputMessageContent)

*Optional* Sets the content you want to be sent with this result to the provided InputMessageContent object

Parameters:

inputMessageContent - The content you want to be sent with the result

Returns:

The builder object

thumbUrl

public InlineQueryResultDocument.InlineQueryResultDocumentBuilder thumbUrl(URL thumbUrl)

*Optional* Sets the URL of the thumbnail that should show next to the result in the inline result selection pane

Parameters:

thumbUrl - The URL of the thumbnail you want to be shown next to the result in the result selection pane

Returns:

The builder object

thumbWidth

public InlineQueryResultDocument.InlineQueryResultDocumentBuilder thumbWidth(int thumbWidth)

*Optional* Sets the width of the thumbnail at the previously provided URL through thumbUrl(URL)

Parameters:

thumbWidth - The width of the thumbnail

Returns:

The builder object

thumbHeight

public InlineQueryResultDocument.InlineQueryResultDocumentBuilder thumbHeight(int thumbHeight)

*Optional* Sets the height of the thumbnail at the previously provided URL through thumbUrl(URL)

Parameters:

thumbHeight - The height of the thumbnail

Returns:

The builder object

build

public InlineQueryResultDocument build()

Builds the InlineQueryResultDocument object

Returns:

An InlineQueryResultDocument object based on the previously provided values