Documentation ¶
Index ¶
- Constants
- Variables
- type AtLink
- type AtLinkMeta
- type AtLinks
- type AtLinksFilter
- type Auth
- type Auth2faForm
- type Auth2faMailRecovery
- type Auth2faSettingsMailValidation
- type Auth2faSettingsResponse
- type AuthCheckCode2faForm
- type AuthPasswordRecovery2faForm
- type AuthToken2faForm
- type BackgroundAction
- type BotCommand
- type BotCommands
- type ChatFilter
- type ClientCallLeave
- type ClientCallMuteAll
- type ClientCallRecord
- type ClientCallReject
- type ClientCallSound
- type ClientCallTrickle
- type ColorRule
- type ConfirmMail2faForm
- type Contact
- type ContactFilter
- type Create2faPasswordForm
- type DevicePing
- type Draft
- type EasyApiMessage
- type EmojiResp
- type Err
- type Group
- type GroupMembers
- type Hotmessages
- type Integration
- type Internal2faPasswordForm
- type Message
- type MessageFilter
- type MessageMarkup
- type MessageUpdate
- type MyReactions
- type Paginator
- type PathSpec
- type Payment
- type ReleasesResp
- type Resp
- type SendMail2faConfirmForm
- type SharpLink
- type SharpLinkMeta
- type SharpLinks
- type SharpLinksFilter
- type SmsCode
- type Task
- type TaskColors
- type TaskFilter
- type Team
- type TeamConfirmation
- type TeamPrejoinInfo
- type TimezonesResp
- type Update2faPasswordForm
- type UploadFilter
- type UserParams
Constants ¶
const ( Unknown2fa = "unknown" Unconfirmed2fa = "unconfirmed" Confirmed2fa = "confirmed" Declined2fa = "declined" )
RecoveryStatus:
const ( Ok = Err("OK") EmptyToken = Err("EMPTY_TOKEN") EmptySession = Err("EMPTY_SESSION") InvalidToken = Err("INVALID_TOKEN") AccessDenied = Err("ACCESS_DENIED") NotFound = Err("NOT_FOUND") NotModified = Err("NOT_MODIFIED") RateLimit = Err("RATE_LIMIT") InternalServerError = Err("INTERNAL_SERVER_ERROR") InvalidMethod = Err("INVALID_METHOD") InvalidData = Err("INVALID_DATA") )
Variables ¶
var Paths = make(map[string]PathSpec)
Functions ¶
This section is empty.
Types ¶
type AtLink ¶ added in v1.45.1
type AtLink struct { // What should be inserted to the chat Key string `json:"key"` // What should be visible by user Title string `json:"title"` // Hint for user, if any Help string `json:"help,omitempty"` // Icon data, if any Icons *tdproto.IconData `json:"icons,omitempty"` // Internal details, if any Meta *AtLinkMeta `json:"meta,omitempty"` }
@-link autocomplete information
type AtLinkMeta ¶ added in v1.45.1
type AtLinkMeta struct { // Contact or section jid Jid tdproto.JID `json:"jid"` // Section uid (for contact sections only) Section string `json:"section,omitempty"` }
@-link autocomplete details
type AtLinksFilter ¶ added in v1.45.1
type AtLinksFilter struct { // Enable markdown Markdown bool `schema:"markdown"` }
@-links filter
type Auth2faForm ¶ added in v1.21.7
type Auth2faForm struct {
// contains filtered or unexported fields
}
type Auth2faMailRecovery ¶ added in v1.23.3
type Auth2faMailRecovery struct { CodeValidUntil tdproto.ISODateTimeString `json:"code_valid_until"` NextCodeAt tdproto.ISODateTimeString `json:"next_code_at"` CodeLength int `json:"code_length"` Email string `json:"email"` }
type Auth2faSettingsMailValidation ¶ added in v1.23.3
type Auth2faSettingsResponse ¶ added in v1.21.7
type AuthCheckCode2faForm ¶ added in v1.23.3
type AuthCheckCode2faForm struct {
// contains filtered or unexported fields
}
type AuthPasswordRecovery2faForm ¶ added in v1.23.3
type AuthPasswordRecovery2faForm struct {
// contains filtered or unexported fields
}
type AuthToken2faForm ¶ added in v1.23.3
type AuthToken2faForm struct {
// contains filtered or unexported fields
}
type BackgroundAction ¶ added in v1.34.1
type BackgroundAction struct { // Action uid Action string `json:"action"` }
Background action (for example: Excel import) information
type BotCommand ¶ added in v1.45.1
type BotCommand struct { // What should be inserted to the chat Key string `json:"key"` // What should be visible by user Title string `json:"title"` // Command options, if any Args []string `json:"args"` }
Bot commands information
type ChatFilter ¶ added in v1.12.1
type ChatFilter struct { UserParams Paginator // ?unread_first=true|false (default: false) UnreadFirst string `schema:"unread_first"` // ?unread_only=true|false (default: false) UnreadOnly string `schema:"unread_only"` // ?hidden=true|false|any (default: false) Hidden string `schema:"hidden"` // ?feed=true|false|any (default: any) Feed string `schema:"feed"` // ?has_activity=true|false|any (default: any) HasActivity string `schema:"has_activity"` // ?chat_type=task,group,direct|any (default: any) ChatType string `schema:"chat_type"` // ?mix_contacts=true|false (default: false) MixContacts string `schema:"mix_contacts"` // ?sort = [ "group_chat_display_name" | "-group_chat_display_name" | "last_message" | "-last_message" ] Sort string `schema:"sort"` // ?q=search-text Q string `schema:"q"` // gentime great than GentimeGT int64 `schema:"gentime_gt"` // deprecated HiddenOnly string `schema:"hidden_only"` // deprecated: use ?has_activity= HasMessages string `schema:"has_messages"` }
type ClientCallLeave ¶ added in v1.4.0
type ClientCallMuteAll ¶ added in v1.4.0
type ClientCallRecord ¶ added in v1.4.0
type ClientCallReject ¶ added in v1.4.0
type ClientCallSound ¶ added in v1.4.0
type ClientCallTrickle ¶ added in v1.4.0
type ColorRule ¶ added in v1.34.1
type ColorRule struct { // Rule priority Priority *int `json:"priority,omitempty"` // Color index ColorIndex *uint16 `json:"color_index,omitempty"` // Rule description Description string `json:"description"` // Task status TaskStatus *string `json:"task_status,omitempty"` // Project filter enabled ProjectEnabled bool `json:"section_enabled,omitempty"` // TODO: rename to "project_enabled" // Project id if project filter enabled Project *string `json:"section,omitempty"` // TODO: rename to "project" // Task importance filter enabled TaskImportanceEnabled bool `json:"task_importance_enabled,omitempty"` // Task importance if task importance filter enabled TaskImportance *int `json:"task_importance,omitempty"` // Task urgency filter enabled TaskUrgencyEnabled bool `json:"task_urgency_enabled,omitempty"` // Task urgency if task urgency filter enabled TaskUrgency *int `json:"task_urgency,omitempty"` // Tags filter enabled TagsEnabled bool `json:"tags_enabled,omitempty"` // Tag ids if tags filter enabled Tags *[]string `json:"tags,omitempty"` }
Task color rule form
type ConfirmMail2faForm ¶ added in v1.23.3
type ConfirmMail2faForm struct {
// contains filtered or unexported fields
}
type Contact ¶ added in v1.33.5
type Contact struct { // User uid (for invitation from other team) UserUid string `json:"user_uid,omitempty"` // Phone number (for invitation by phone) Phone string `json:"phone"` // Contact phone number (part of contact information in team, visible by all) ContactPhone string `json:"contact_phone"` // Contact email (part of contact information in team, visible by all) ContactEmail string `json:"contact_email"` // Family name FamilyName string `json:"family_name"` // Given name GivenName string `json:"given_name"` // Patronymic Patronymic string `json:"patronymic"` // Role in team Role string `json:"role"` // Mood in team Mood string `json:"mood"` // Enable debug messages in UI DebugShowActivity bool `json:"debug_show_activity"` // Status in team Status tdproto.TeamStatus `json:"status"` // ContactSection uids, if any Sections []string `json:"sections"` // Use Ctrl/Cmd + Enter instead Enter AltSend bool `json:"alt_send"` // Focus mode enabled until FocusUntil tdproto.ISODateTimeString `json:"focus_until"` // Use * as @ for mentions AsteriskMention bool `json:"asterisk_mention"` // Send push notifications even contact is online AlwaysSendPushes bool `json:"always_send_pushes"` // Hide pushes body HidePushesContent bool `json:"hide_pushes_content"` // Show unread chats first (web/desktop) UnreadFirst bool `json:"unread_first"` // Show unread chats first (mobile app) MunreadFirst bool `json:"munread_first"` // Default language code DefaultLang string `json:"default_lang"` // Timezone, if any Timezone string `json:"timezone"` // Start silently time (no pushes, no sounds) QuietTimeStart string `json:"quiet_time_start"` // Quiet time finish QuietTimeFinish string `json:"quiet_time_finish"` // Push notifications for group chats GroupNotificationsEnabled bool `json:"group_notifications_enabled"` // Push notifications for task chats TaskNotificationsEnabled bool `json:"task_notifications_enabled"` // Short view in contact list ContactShortView bool `json:"contact_short_view"` // Short view in group list GroupShortView bool `json:"group_short_view"` // Short view in task list TaskShortView bool `json:"task_short_view"` // Short view in contact list in mobile app ContactMshortView bool `json:"contact_mshort_view"` // Show archived contacts in contact list ContactShowArchived bool `json:"contact_show_archived"` // Short view in group list in mobile app GroupMshortView bool `json:"group_mshort_view"` // Short view in task list in mobile app TaskMshortView bool `json:"task_mshort_view"` }
Contact invite/edit form
type ContactFilter ¶ added in v1.36.1
type Create2faPasswordForm ¶ added in v1.23.3
type Create2faPasswordForm struct {
// contains filtered or unexported fields
}
type DevicePing ¶ added in v1.34.1
type DevicePing struct { // Unique value sent to device PingId string `json:"ping_id"` }
Device ping response
type Draft ¶ added in v1.33.1
type Draft struct { // Draft content Draft string `json:"draft"` // Draft version DraftGentime int64 `json:"draft_gentime,omitempty" tdproto:"readonly"` // TdMarkup found in content (links included) Markup []tdproto.MarkupEntity `json:"markup,omitempty" tdproto:"readonly"` // Deprecated: use Markup instead Links tdproto.MessageLinks `json:"links,omitempty" tdproto:"readonly"` }
Draft form and response
type EasyApiMessage ¶ added in v1.45.1
type EasyApiMessage struct { // Comma separated api keys (for /api/message calls only) Key string `json:"key"` // Message text. Required. Text string `json:"message"` // Message uuid. Optional MessageUid string `json:"message_id"` // Disable links preview Nopreview bool `json:"nopreview"` // Mark message as important Important bool `json:"important"` // Disable counters and push notifications Silently bool `json:"silently"` // Convert "\\n" to "\n" ConvertLinebreaks bool `json:"convert_linebreaks"` }
Simple api for integrations /api/message or /tasks/[team]/[num]/message
type Group ¶ added in v1.11.1
type Group struct { // Group title DisplayName string `json:"display_name"` // Group description, optional Description string `json:"description"` // Readonly for non-admins group chat (Like Channels in Telegram bug switchable) ReadonlyForMembers bool `json:"readonly_for_members"` // Is task or group public for non-guests Public bool `json:"public"` // Any new team member will be added to this group chat DefaultForAll bool `json:"default_for_all"` // Delete messages in this chat in seconds. Experimental function AutocleanupAge *int `json:"autocleanup_age"` // Pinned message for this group PinnedMessage string `json:"pinned_message"` // Group members list Members []tdproto.GroupMembership `json:"members"` // Deprecated Section string `json:"section"` }
Group form
type GroupMembers ¶ added in v1.34.1
type GroupMembers struct { // Group members lust Members []tdproto.GroupMembership `json:"members"` }
Group members
type Hotmessages ¶ added in v1.34.1
type Hotmessages struct { // chat information Chat tdproto.Chat `json:"chat"` // Messages list Messages []tdproto.Message `json:"messages"` // Contacts list Contacts []tdproto.Contact `json:"contacts"` }
All-in-one response with all messages info for fast chat rendering
type Integration ¶ added in v1.33.5
type Integration struct { // Enabled Enabled bool `json:"enabled"` // Optional commend Comment string `json:"comment"` // Plugin name Kind string `json:"kind"` // Group chat jid GroupJid tdproto.JID `json:"group"` // WebhookUrl, if any WebhookUrl string `json:"webhook_url"` // Integration form IntegrationForm *tdproto.IntegrationForm `json:"form"` }
type Internal2faPasswordForm ¶ added in v1.23.3
type Internal2faPasswordForm struct {
// contains filtered or unexported fields
}
type Message ¶ added in v1.2.8
type Message struct { // Message type Type tdproto.Mediatype `json:"type"` // Message text Text string `json:"text"` // Message id MessageUid string `json:"message_id,omitempty"` // Message attachments Uploads []string `json:"uploads,omitempty"` // Backward compatibility mode OldStyleAttachment bool `json:"old_style_attachment,omitempty"` MessageUpdate }
type MessageFilter ¶ added in v1.12.0
type MessageFilter struct { UserParams Paginator // ?chat=jid,jid Chat string `schema:"chat"` // ?chat_type=task,group,direct|any (default: any) ChatType string `schema:"chat_type"` // ?sender=jid,jid Sender string `schema:"sender"` // ?has_upload=true|false|any (default: any) HasUpload string `schema:"has_upload"` // ?text=substr Text string `schema:"text"` // ?type=image,video,plain,file Type tdproto.Mediatype `schema:"type"` // ?important=true|any Important string `schema:"important"` // ?date_from=dt (include) DateFrom string `schema:"date_from"` // ?date_to=dt DateTo string `schema:"date_to"` // ?include_deleted=true|false (default: false) IncludeDeleted string `schema:"include_deleted"` // ?gentime_from= GentimeFrom string `schema:"gentime_from"` // ?exact=msgId Exact string `schema:"exact"` // ?unread=(true|false) Unread string `schema:"unread"` // ?old_from=msgId (exclude msgId) OldFrom string `schema:"old_from"` // ?new_from=msgId (exclude msgId) NewFrom string `schema:"new_from"` // ?old_from_inc=msgId (include msgId) OldFromInc string `schema:"old_from_inc"` // ?new_from_inc=msgId (include msgId) NewFromInc string `schema:"new_from_inc"` // ?around=msgId (include msgId) Around string `schema:"around"` }
type MessageMarkup ¶ added in v1.34.1
type MessageMarkup struct { // Message markup Markup []tdproto.MarkupEntity `json:"markup"` // Deprecated: use markup instead Links tdproto.MessageLinks `json:"links"` }
Message markup with checked links
type MessageUpdate ¶ added in v1.2.8
type MessageUpdate struct { // Important flag. Not required. Default: false Important bool `json:"important,omitempty"` // Disable links preview generation. Not required. Default: false Nopreview bool `json:"nopreview,omitempty"` // Draft message, send later SendAt string `json:"send_at,omitempty"` }
type MyReactions ¶ added in v1.34.1
type MyReactions struct { // My frequently used reactions Top []tdproto.Reaction `json:"top"` // All available reactions All []tdproto.Reaction `json:"all"` }
Reactions to messages: frequently used and all available
type Payment ¶ added in v1.46.7
type Payment struct { TariffUid string `json:"tariff_uid"` TeamUid string `json:"team_uid"` ReturnUrl string `json:"return_url,omitempty"` }
Form for create payment
type ReleasesResp ¶ added in v1.29.5
type Resp ¶
type Resp struct { // Server side work time DebugTime string `json:"_time,omitempty"` // Request status Ok bool `json:"ok"` // Result only if ok is true) Result interface{} `json:"result,omitempty"` // Error (only if ok is false) Error Err `json:"error,omitempty"` // Error (only if ok is false and Error is 'InvalidData') Details map[string]string `json:"details,omitempty"` // Reason (only if ok is false and Error is `AccessDenied`) Reason string `json:"reason,omitempty"` // Reason markup (only if ok is false and Error is `AccessDenied`) Markup []tdproto.MarkupEntity `json:"markup,omitempty"` }
Server response
type SendMail2faConfirmForm ¶ added in v1.23.3
type SendMail2faConfirmForm struct {
// contains filtered or unexported fields
}
type SharpLink ¶ added in v1.45.1
type SharpLink struct { // What should be inserted to the chat Key string `json:"key"` // What should be visible by user Title string `json:"title"` // Icon data, if any Icons *tdproto.IconData `json:"icons,omitempty"` // Internal details Meta SharpLinkMeta `json:"meta"` }
#-link autocomplete information
type SharpLinkMeta ¶ added in v1.45.1
type SharpLinkMeta struct { // Chat id Jid tdproto.JID `json:"jid"` // Chat type ChatType tdproto.ChatType `json:"chat_type"` // Is task or group public for non-guests Public bool `json:"public,omitempty"` // Task status (for tasks) TaskStatus string `json:"task_status,omitempty"` // Task number (for tasks) Num uint `json:"num,omitempty"` // Deprecated: use `TaskStatus == "done"` comparsion Done bool `json:"done,omitempty"` }
#-link autocomplete details
type SharpLinksFilter ¶ added in v1.45.1
type SharpLinksFilter struct { // Enable markdown Markdown bool `schema:"markdown"` }
#-links filter
type SmsCode ¶
type SmsCode struct { // Normalized mobile phone number Phone string `json:"phone"` // Code expiration time CodeValidUntil tdproto.ISODateTimeString `json:"code_valid_until"` // Next code sending available time NextCodeAt tdproto.ISODateTimeString `json:"next_code_at"` // SMS code length CodeLength int `json:"code_length"` }
SMS code response
type Task ¶ added in v1.3.1
type Task struct { // Custom task color CustomColorIndex *uint16 `json:"custom_color_index,omitempty"` // Task description Description string `json:"description,omitempty"` // Task tags Tags []string `json:"tags,omitempty"` // Task section UID SectionUid string `json:"section,omitempty"` // User who follow the task Observers []tdproto.JID `json:"observers,omitempty"` // TODO: rename to "followers" // Items of the task Items []string `json:"items,omitempty"` // User who was assigned the task Assignee tdproto.JID `json:"assignee,omitempty"` // Deadline time, if any Deadline tdproto.ISODateTimeString `json:"deadline,omitempty"` // Is task or group public for non-guests Public bool `json:"public,omitempty"` // Fire a reminder at this time RemindAt tdproto.ISODateTimeString `json:"remind_at,omitempty"` // Task status TaskStatus string `json:"task_status,omitempty"` // Task importance Importance *int `json:"importance,omitempty"` // Task urgency Urgency *int `json:"urgency,omitempty"` // Task complexity Complexity *int `json:"complexity,omitempty"` // Time spent SpentTime *int `json:"spent_time,omitempty"` // Linked messages LinkedMessages []string `json:"linked_messages,omitempty"` // TODO: Message object // Task uploads Uploads []string `json:"uploads,omitempty"` }
Task
type TaskColors ¶ added in v1.34.1
Task cards colors
type TaskFilter ¶ added in v1.13.3
type TaskFilter struct { UserParams Paginator //* ?sort = [ "created" | "-created" | "last_message" | "-last_message" | "deadline" | "-deadline" ] Sort string `schema:"sort"` //* ?task_status = new,done | new | any TaskStatus string `schema:"task_status"` //* ?exclude_task_status = new,done | new | any ExcludeTaskStatus string `schema:"exclude_task_status"` //* ?num=num1,num2,num3... Num string `schema:"num"` //* ?observer=jid,jid // TODO: rename to ?follower= Observer string `schema:"observer"` //* ?member=jid,jid Member string `schema:"member"` //* ?assignee=jid,jid Assignee string `schema:"assignee"` //* ?owner=jid,jid Owner string `schema:"owner"` //* ?section=[ uid,uid... | "-" ] Section string `schema:"section"` // TODO: rename to ?project= //* ?contact_section=[ uid,uid... | "-" ] ContactSection string `schema:"contact_section"` // TODO: rename to ?section= //* ?tag=[ tag,tag,tag... | "-" ] Tag string `schema:"tag"` //* ?q= Q string `schema:"q"` //* ?public=true|false Public string `schema:"public"` //* ?deadline_gte=<isodate> DeadlineGTE string `schema:"deadline_gte"` //* ?deadline_lte=<isodate> DeadlineLTE string `schema:"deadline_lte"` //* ?done_gte=<isodate> DoneGTE string `schema:"done_gte"` //* ?done_lte=<isodate> DoneLTE string `schema:"done_lte"` //* ?created_gte=<isodate> CreatedGTE string `schema:"created_gte"` //* ?created_lte=<isodate> CreatedLTE string `schema:"created_lte"` //* ?short=true|false Short string `schema:"short"` // gentime great than group/chat GentimeGT int64 `schema:"gentime_gt"` }
Query parameters for listing messages
type Team ¶ added in v1.33.5
type Team struct { // Team name Name string `json:"name"` // Default task deadline DefaultTaskDeadline string `json:"default_task_deadline"` // Max message update/deletion age, in seconds MaxMessageUpdateAge interface{} `json:"max_message_update_age"` // Patronymic in usernames for this team UsePatronymic bool `json:"use_patronymic"` // Family name should be first in display name DisplayFamilyNameFirst bool `json:"display_family_name_first"` // Use importance field in task UseTaskImportance bool `json:"use_task_importance"` // Reverse importance TaskImportanceRev bool `json:"task_importance_rev"` // Use urgency field in task UseTaskUrgency bool `json:"use_task_urgency"` // Use complexity field in task UseTaskComplexity bool `json:"use_task_complexity"` // Use spent time field in task UseTaskSpentTime bool `json:"use_task_spent_time"` // Is singlegroup (for creation only) SingleGroup bool `json:"single_group"` // Team pinned Pinned bool `json:"pinned,omitempty"` // Contacts (for creation only) Contacts []Contact `json:"contacts"` }
type TeamConfirmation ¶ added in v1.48.0
type TeamConfirmation struct { // Need confirmation after invite to this team NeedConfirmation bool `json:"need_confirmation" tdproto:"readonly"` }
Team confirmation
type TeamPrejoinInfo ¶ added in v1.34.1
Invitation information
type TimezonesResp ¶ added in v1.29.5
type TimezonesResp struct { // List of timezones Timezones []string `json:"timezones"` }
type Update2faPasswordForm ¶ added in v1.23.3
type Update2faPasswordForm struct {
// contains filtered or unexported fields
}
type UploadFilter ¶ added in v1.34.0
type UploadFilter struct { Paginator // ?chat=jid,jid Chat string `schema:"chat"` // ?sender=jid,jid Sender string `schema:"sender"` // ?content_type=image/jpeg ContentType string `schema:"content_type"` // ?type=file,image,audio,video Type tdproto.Mediatype `schema:"type"` // ?text=substr Text string `schema:"text"` }
type UserParams ¶ added in v1.12.3
Source Files ¶
- atlinks.go
- auth.go
- background_action.go
- botcommands.go
- calls.go
- chats.go
- color_rule.go
- contact.go
- device.go
- draft.go
- easy_api.go
- emoji.go
- err.go
- group.go
- hotmessages.go
- integration.go
- main.go
- message.go
- mixins.go
- my_reactions.go
- payment.go
- releases.go
- resp.go
- sharplinks.go
- sms_code.go
- task.go
- team.go
- timezones.go
- upload.go