Skip to content

Commit d885b2a

Browse files
Add animation, game score and webhook types documentation
1 parent 5875a46 commit d885b2a

File tree

1 file changed

+45
-14
lines changed

1 file changed

+45
-14
lines changed

types.go

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1044,31 +1044,62 @@ type Game struct {
10441044

10451045
// Animation is a GIF animation demonstrating the game.
10461046
type Animation struct {
1047-
FileID string `json:"file_id"`
1048-
Thumb PhotoSize `json:"thumb"`
1049-
FileName string `json:"file_name"`
1050-
MimeType string `json:"mime_type"`
1051-
FileSize int `json:"file_size"`
1047+
// FileID identifier for this file, which can be used to download or reuse the file.
1048+
FileID string `json:"file_id"`
1049+
// Thumb animation thumbnail as defined by sender.
1050+
//
1051+
// optional
1052+
Thumb PhotoSize `json:"thumb"`
1053+
// FileName original animation filename as defined by sender.
1054+
//
1055+
// optional
1056+
FileName string `json:"file_name"`
1057+
// MimeType of the file as defined by sender.
1058+
//
1059+
// optional
1060+
MimeType string `json:"mime_type"`
1061+
// FileSize ile size
1062+
//
1063+
// optional
1064+
FileSize int `json:"file_size"`
10521065
}
10531066

10541067
// GameHighScore is a user's score and position on the leaderboard.
10551068
type GameHighScore struct {
1056-
Position int `json:"position"`
1057-
User User `json:"user"`
1058-
Score int `json:"score"`
1069+
// Position in high score table for the game
1070+
Position int `json:"position"`
1071+
// User user
1072+
User User `json:"user"`
1073+
// Score score
1074+
Score int `json:"score"`
10591075
}
10601076

10611077
// CallbackGame is for starting a game in an inline keyboard button.
10621078
type CallbackGame struct{}
10631079

10641080
// WebhookInfo is information about a currently set webhook.
10651081
type WebhookInfo struct {
1066-
URL string `json:"url"`
1067-
HasCustomCertificate bool `json:"has_custom_certificate"`
1068-
PendingUpdateCount int `json:"pending_update_count"`
1069-
LastErrorDate int `json:"last_error_date"` // optional
1070-
LastErrorMessage string `json:"last_error_message"` // optional
1071-
MaxConnections int `json:"max_connections"` // optional
1082+
// URL webhook URL, may be empty if webhook is not set up.
1083+
URL string `json:"url"`
1084+
// HasCustomCertificate true, if a custom certificate was provided for webhook certificate checks.
1085+
HasCustomCertificate bool `json:"has_custom_certificate"`
1086+
// PendingUpdateCount number of updates awaiting delivery.
1087+
PendingUpdateCount int `json:"pending_update_count"`
1088+
// LastErrorDate unix time for the most recent error
1089+
// that happened when trying to deliver an update via webhook.
1090+
//
1091+
// optional
1092+
LastErrorDate int `json:"last_error_date"`
1093+
// LastErrorMessage error message in human-readable format for the most recent error
1094+
// that happened when trying to deliver an update via webhook.
1095+
//
1096+
// optional
1097+
LastErrorMessage string `json:"last_error_message"`
1098+
// MaxConnections maximum allowed number of simultaneous
1099+
// HTTPS connections to the webhook for update delivery.
1100+
//
1101+
// optional
1102+
MaxConnections int `json:"max_connections"`
10721103
}
10731104

10741105
// IsSet returns true if a webhook is currently set.

0 commit comments

Comments
 (0)