Skip to content

Commit ea8eadd

Browse files
Add inline query result document types documentation
1 parent 5150022 commit ea8eadd

File tree

1 file changed

+86
-21
lines changed

1 file changed

+86
-21
lines changed

types.go

Lines changed: 86 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1342,31 +1342,96 @@ type InlineQueryResultCachedVoice struct {
13421342

13431343
// InlineQueryResultDocument is an inline query response document.
13441344
type InlineQueryResultDocument struct {
1345-
Type string `json:"type"` // required
1346-
ID string `json:"id"` // required
1347-
Title string `json:"title"` // required
1348-
Caption string `json:"caption"`
1349-
URL string `json:"document_url"` // required
1350-
MimeType string `json:"mime_type"` // required
1351-
Description string `json:"description"`
1352-
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
1353-
InputMessageContent interface{} `json:"input_message_content,omitempty"`
1354-
ThumbURL string `json:"thumb_url"`
1355-
ThumbWidth int `json:"thumb_width"`
1356-
ThumbHeight int `json:"thumb_height"`
1345+
// Type of the result, must be document
1346+
//
1347+
// required
1348+
Type string `json:"type"`
1349+
// ID unique identifier for this result, 1-64 bytes
1350+
//
1351+
// required
1352+
ID string `json:"id"`
1353+
// Title for the result
1354+
//
1355+
// required
1356+
Title string `json:"title"`
1357+
// Caption of the document to be sent, 0-1024 characters after entities parsing
1358+
//
1359+
// optional
1360+
Caption string `json:"caption"`
1361+
// URL a valid url for the file
1362+
//
1363+
// required
1364+
URL string `json:"document_url"`
1365+
// MimeType of the content of the file, either “application/pdf” or “application/zip”
1366+
//
1367+
// required
1368+
MimeType string `json:"mime_type"`
1369+
// Description short description of the result
1370+
//
1371+
// optional
1372+
Description string `json:"description"`
1373+
// ReplyMarkup nline keyboard attached to the message
1374+
//
1375+
// optional
1376+
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
1377+
// InputMessageContent content of the message to be sent instead of the file
1378+
//
1379+
// optional
1380+
InputMessageContent interface{} `json:"input_message_content,omitempty"`
1381+
// ThumbURL url of the thumbnail (jpeg only) for the file
1382+
//
1383+
// optional
1384+
ThumbURL string `json:"thumb_url"`
1385+
// ThumbWidth thumbnail width
1386+
//
1387+
// optional
1388+
ThumbWidth int `json:"thumb_width"`
1389+
// ThumbHeight thumbnail height
1390+
//
1391+
// optional
1392+
ThumbHeight int `json:"thumb_height"`
13571393
}
13581394

13591395
// InlineQueryResultCachedDocument is an inline query response with cached document.
13601396
type InlineQueryResultCachedDocument struct {
1361-
Type string `json:"type"` // required
1362-
ID string `json:"id"` // required
1363-
DocumentID string `json:"document_file_id"` // required
1364-
Title string `json:"title"` // required
1365-
Caption string `json:"caption"`
1366-
Description string `json:"description"`
1367-
ParseMode string `json:"parse_mode"`
1368-
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
1369-
InputMessageContent interface{} `json:"input_message_content,omitempty"`
1397+
// Type of the result, must be document
1398+
//
1399+
// required
1400+
Type string `json:"type"`
1401+
// ID unique identifier for this result, 1-64 bytes
1402+
//
1403+
// required
1404+
ID string `json:"id"`
1405+
// DocumentID a valid file identifier for the file
1406+
//
1407+
// required
1408+
DocumentID string `json:"document_file_id"`
1409+
// Title for the result
1410+
//
1411+
// optional
1412+
Title string `json:"title"` // required
1413+
// Caption of the document to be sent, 0-1024 characters after entities parsing
1414+
//
1415+
// optional
1416+
Caption string `json:"caption"`
1417+
// Description short description of the result
1418+
//
1419+
// optional
1420+
Description string `json:"description"`
1421+
// ParseMode mode for parsing entities in the video caption.
1422+
// // See formatting options for more details
1423+
// // (https://core.telegram.org/bots/api#formatting-options).
1424+
//
1425+
// optional
1426+
ParseMode string `json:"parse_mode"`
1427+
// ReplyMarkup inline keyboard attached to the message
1428+
//
1429+
// optional
1430+
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
1431+
// InputMessageContent content of the message to be sent instead of the file
1432+
//
1433+
// optional
1434+
InputMessageContent interface{} `json:"input_message_content,omitempty"`
13701435
}
13711436

13721437
// InlineQueryResultLocation is an inline query response location.

0 commit comments

Comments
 (0)