Skip to content

Commit b4d9865

Browse files
Add chat type documentation
1 parent e6fdc8e commit b4d9865

File tree

1 file changed

+32
-11
lines changed

1 file changed

+32
-11
lines changed

types.go

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -104,17 +104,38 @@ type ChatPhoto struct {
104104

105105
// Chat contains information about the place a message was sent.
106106
type Chat struct {
107-
ID int64 `json:"id"`
108-
Type string `json:"type"`
109-
Title string `json:"title"` // optional
110-
UserName string `json:"username"` // optional
111-
FirstName string `json:"first_name"` // optional
112-
LastName string `json:"last_name"` // optional
113-
AllMembersAreAdmins bool `json:"all_members_are_administrators"` // optional
114-
Photo *ChatPhoto `json:"photo"`
115-
Description string `json:"description,omitempty"` // optional
116-
InviteLink string `json:"invite_link,omitempty"` // optional
117-
PinnedMessage *Message `json:"pinned_message"` // optional
107+
// ID is a unique identifier for this chat
108+
ID int64 `json:"id"`
109+
// Type of chat, can be either “private”, “group”, “supergroup” or “channel”
110+
Type string `json:"type"`
111+
// Title for supergroups, channels and group chats
112+
// optional
113+
Title string `json:"title"`
114+
// UserName for private chats, supergroups and channels if available
115+
// optional
116+
UserName string `json:"username"`
117+
// FirstName of the other party in a private chat
118+
// optional
119+
FirstName string `json:"first_name"`
120+
// LastName of the other party in a private chat
121+
// optional
122+
LastName string `json:"last_name"`
123+
// AllMembersAreAdmins
124+
// optional
125+
AllMembersAreAdmins bool `json:"all_members_are_administrators"`
126+
// Photo is a chat photo
127+
Photo *ChatPhoto `json:"photo"`
128+
// Description for groups, supergroups and channel chats
129+
// optional
130+
Description string `json:"description,omitempty"`
131+
// InviteLink is a chat invite link, for groups, supergroups and channel chats.
132+
// Each administrator in a chat generates their own invite links,
133+
// so the bot must first generate the link using exportChatInviteLink
134+
// optional
135+
InviteLink string `json:"invite_link,omitempty"`
136+
// PinnedMessage Pinned message, for groups, supergroups and channels
137+
// optional
138+
PinnedMessage *Message `json:"pinned_message"`
118139
}
119140

120141
// IsPrivate returns if the Chat is a private conversation.

0 commit comments

Comments
 (0)