Documentation
¶
Index ¶
- type ActionLinks
- type AddUserToRole
- type Agent
- type AgentDepartment
- type AgentInfoRequest
- type Appearance
- type Asset
- type AssetUnSetRequest
- type Attachment
- type AttachmentAction
- type AttachmentActionButtonsAlignment
- type AttachmentActionType
- type AttachmentField
- type AuthData
- type CHATMessage
- type CHATU
- type Channel
- type ChannelAddAllRequest
- type ChannelAddLeaderRequest
- type ChannelAddModeratorRequest
- type ChannelAddOwnerRequest
- type ChannelAnnouncementRequest
- type ChannelArchiveRequest
- type ChannelCloseRequest
- type ChannelCreateRequest
- type ChannelCustomFieldsRequest
- type ChannelDefaultRequest
- type ChannelDeleteRequest
- type ChannelDescriptionRequest
- type ChannelInviteRequest
- type ChannelJoinCodeRequest
- type ChannelJoinRequest
- type ChannelKickRequest
- type ChannelOpenRequest
- type ChannelReadOnlyRequest
- type ChannelRemoveLeaderRequest
- type ChannelRemoveModeratorRequest
- type ChannelRemoveOwnerRequest
- type ChannelRenameRequest
- type ChannelSubscription
- type ChannelTopicRequest
- type ChannelTypeRequest
- type ChannelUnArchiveRequest
- type ChatDeleteRequest
- type ChatFollowRequest
- type ChatIgnoreRequest
- type ChatPinRequest
- type ChatReactRequest
- type ChatReportRequest
- type ChatSendMessageRequest
- type ChatStarRequest
- type ChatUnFollowRequest
- type ChatUnPinRequest
- type ChatUnStarRequest
- type ChatUpdateRequest
- type CloseIMRequest
- type Command
- type CountersIMMessage
- type CreateGroupRequest
- type CreateIMRequest
- type CreateIntegration
- type CreateInviteRequest
- type CreateUserRequest
- type CreatedBy
- type CustomUserStatus
- type Department
- type Directory
- type EmojiDeleteRequest
- type EveryoneListIM
- type ExportOperation
- type FileIM
- type ForgotPassword
- type GeneratePersonalAccessToken
- type GroupAddAllRequest
- type GroupAddLeaderRequest
- type GroupAddModeratorRequest
- type GroupAddOwnerRequest
- type GroupAnnouncementRequest
- type GroupArchiveRequest
- type GroupCloseRequest
- type GroupCustomFieldsRequest
- type GroupDeleteRequest
- type GroupDescriptionRequest
- type GroupInviteRequest
- type GroupKickRequest
- type GroupLeaveRequest
- type GroupList
- type GroupOpenRequest
- type GroupReadOnlyRequest
- type GroupRemoveLeaderRequest
- type GroupRemoveModeratorRequest
- type GroupRemoveOwnerRequest
- type GroupRenameRequest
- type GroupTopicRequest
- type GroupTypeRequest
- type GroupUnArchiveRequest
- type Guest
- type Info
- type Inquiry
- type Integration
- type IntegrationData
- type IntegrationHistory
- type IntegrationRoom
- type IntegrationSetting
- type Invite
- type ListIM
- type LiveChatConfig
- type LiveChatHistory
- type LiveChatMessage
- type LiveChatOfficeHour
- type LiveChatPage
- type LiveChatRoom
- type LiveChatRoomTransfer
- type LiveChatTrigger
- type LiveChatUser
- type LiveChatUsers
- type LiveChatVisitor
- type Me
- type MemberIM
- type Message
- type MessageProcessingType
- type Notifications
- type OauthApp
- type OnlineChannel
- type Pagination
- type PartIntegrationHistory
- type Permission
- type PostMessage
- type Preferences
- type Read
- type RegisterUserRequest
- type Role
- type Roles
- type Room
- type RoomCleanHistoryRequest
- type SetActiveStatus
- type SetPreferrences
- type SetStatus
- type Setting
- type Settings
- type SettingsMessage
- type SettingsOauth
- type SettingsPrivate
- type SettingsUpdate
- type Sound
- type Spotlight
- type Statistics
- type StatisticsInfo
- type StatisticsList
- type Status
- type Survey
- type Theme
- type UnRead
- type Update
- type UpdateOwnBasicInfo
- type UpdateUserRequest
- type Upload
- type User
- type UserCredentials
- type UserDeactivateIdleRequest
- type UserDeleteOwnRequest
- type UserDeleteRequest
- type UserInfo
- type UserResetAvatarRequest
- type UsersList
- type VedieUpdateTimeoutRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActionLinks ¶
type AddUserToRole ¶
type AgentDepartment ¶
type AgentInfoRequest ¶
type Appearance ¶
type Appearance struct { ID string `json:"_id"` UpdatedAt time.Time `json:"_updatedAt"` Autocomplete bool `json:"autocomplete"` Blocked bool `json:"blocked"` CreatedAt time.Time `json:"createdAt"` Enterprise bool `json:"enterprise"` Group string `json:"group"` Hidden bool `json:"hidden"` I18NDescription string `json:"i18nDescription"` I18NLabel string `json:"i18nLabel"` PackageValue string `json:"packageValue"` Public bool `json:"public,omitempty"` Secret bool `json:"secret"` Section string `json:"section"` Sorter int `json:"sorter"` Ts time.Time `json:"ts"` Type string `json:"type"` Value string `json:"value"` ValueSource string `json:"valueSource"` Multiline bool `json:"multiline,omitempty"` AllowedTypes []string `json:"allowedTypes,omitempty"` Editor string `json:"editor,omitempty"` PackageEditor string `json:"packageEditor,omitempty"` EnableQuery string `json:"enableQuery,omitempty"` }
type AssetUnSetRequest ¶
type Attachment ¶
type Attachment struct { Color string `json:"color,omitempty"` Text string `json:"text,omitempty"` Timestamp string `json:"ts,omitempty"` ThumbURL string `json:"thumb_url,omitempty"` MessageLink string `json:"message_link,omitempty"` Collapsed bool `json:"collapsed"` AuthorName string `json:"author_name,omitempty"` AuthorLink string `json:"author_link,omitempty"` AuthorIcon string `json:"author_icon,omitempty"` Title string `json:"title,omitempty"` TitleLink string `json:"title_link,omitempty"` TitleLinkDownload string `json:"title_link_download,omitempty"` ImageURL string `json:"image_url,omitempty"` AudioURL string `json:"audio_url,omitempty"` VideoURL string `json:"video_url,omitempty"` Actions []AttachmentAction `json:"actions,omitempty"` ActionButtonsAlignment AttachmentActionButtonsAlignment `json:"button_alignment,omitempty"` Fields []AttachmentField `json:"fields,omitempty"` }
Attachment Payload for postmessage rest API
https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage/
type AttachmentAction ¶
type AttachmentAction struct { Type AttachmentActionType `json:"type,omitempty"` Text string `json:"text,omitempty"` Url string `json:"url,omitempty"` ImageURL string `json:"image_url,omitempty"` IsWebView bool `json:"is_webview"` WebviewHeightRatio string `json:"webview_height_ratio,omitempty"` Msg string `json:"msg,omitempty"` MsgInChatWindow bool `json:"msg_in_chat_window"` MsgProcessingType MessageProcessingType `json:"msg_processing_type,omitempty"` }
AttachmentAction are action buttons on message attachments
type AttachmentActionButtonsAlignment ¶
type AttachmentActionButtonsAlignment string
AttachmentActionButtonAlignment configures how the actions buttons will be aligned
const ( ActionButtonAlignVertical AttachmentActionButtonsAlignment = "vertical" ActionButtonAlignHorizontal AttachmentActionButtonsAlignment = "horizontal" )
type AttachmentActionType ¶
type AttachmentActionType string
const (
AttachmentActionTypeButton AttachmentActionType = "button"
)
type AttachmentField ¶
type AttachmentField struct { Short bool `json:"short"` Title string `json:"title,omitempty"` Value string `json:"value,omitempty"` }
AttachmentField Payload for postmessage rest API
https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage/
type CHATMessage ¶
type CHATMessage struct { ID string `json:"_id"` Alias string `json:"alias"` Msg string `json:"msg"` Attachments []interface{} `json:"attachments"` ParseUrls bool `json:"parseUrls"` Groupable bool `json:"groupable"` Ts time.Time `json:"ts"` U CHATU `json:"u"` Rid string `json:"rid"` UpdatedAt time.Time `json:"_updatedAt"` Mentions []interface{} `json:"mentions"` Channels []interface{} `json:"channels"` }
type Channel ¶
type Channel struct { ID string `json:"_id"` Name string `json:"name"` Fname string `json:"fname,omitempty"` Type string `json:"t"` Msgs int `json:"msgs"` ReadOnly bool `json:"ro,omitempty"` SysMes bool `json:"sysMes,omitempty"` Default bool `json:"default"` Broadcast bool `json:"broadcast,omitempty"` Timestamp *time.Time `json:"ts,omitempty"` UpdatedAt *time.Time `json:"_updatedAt,omitempty"` User *User `json:"u,omitempty"` LastMessage *Message `json:"lastMessage,omitempty"` }
type ChannelAddAllRequest ¶
type ChannelAddLeaderRequest ¶
type ChannelAddOwnerRequest ¶
type ChannelArchiveRequest ¶
type ChannelArchiveRequest struct {
RoomID string `json:"roomId"`
}
type ChannelCloseRequest ¶
type ChannelCloseRequest struct {
RoomID string `json:"roomId"`
}
type ChannelCreateRequest ¶
type ChannelDefaultRequest ¶
type ChannelDeleteRequest ¶
type ChannelInviteRequest ¶
type ChannelJoinCodeRequest ¶
type ChannelJoinRequest ¶
type ChannelKickRequest ¶
type ChannelOpenRequest ¶
type ChannelOpenRequest struct {
RoomID string `json:"roomId"`
}
type ChannelReadOnlyRequest ¶
type ChannelRenameRequest ¶
type ChannelSubscription ¶
type ChannelSubscription struct { ID string `json:"_id"` Alert bool `json:"alert"` Name string `json:"name"` DisplayName string `json:"fname"` Open bool `json:"open"` RoomId string `json:"rid"` Type string `json:"c"` User User `json:"u"` Roles []string `json:"roles"` Unread float64 `json:"unread"` }
type ChannelTopicRequest ¶
type ChannelTypeRequest ¶
type ChannelUnArchiveRequest ¶
type ChannelUnArchiveRequest struct {
RoomID string `json:"roomId"`
}
type ChatDeleteRequest ¶
type ChatFollowRequest ¶
type ChatFollowRequest struct {
MessageId string `json:"mid"`
}
type ChatIgnoreRequest ¶
type ChatPinRequest ¶
type ChatPinRequest struct {
MessageId string `json:"messageId"`
}
type ChatReactRequest ¶
type ChatReportRequest ¶
type ChatSendMessageRequest ¶
type ChatSendMessageRequest struct { Message struct { Rid string `json:"rid"` Msg string `json:"msg"` // Alias string `json:"alias"` Emoji string `json:"emoji"` // Avatar string `json:"avatar"` Attachments []struct { Color string `json:"color"` Text string `json:"text"` Ts time.Time `json:"ts"` ThumbURL string `json:"thumb_url"` MessageLink string `json:"message_link"` Collapsed bool `json:"collapsed"` AuthorName string `json:"author_name"` AuthorLink string `json:"author_link"` AuthorIcon string `json:"author_icon"` Title string `json:"title"` TitleLink string `json:"title_link"` TitleLinkDownload bool `json:"title_link_download"` ImageURL string `json:"image_url"` AudioURL string `json:"audio_url"` VideoURL string `json:"video_url"` Fields []struct { Short bool `json:"short"` Title string `json:"title"` Value string `json:"value"` } `json:"fields"` } `json:"attachments"` } `json:"message"` }
type ChatStarRequest ¶
type ChatStarRequest struct {
MessageId string `json:"messageId"`
}
type ChatUnFollowRequest ¶
type ChatUnFollowRequest struct {
MessageId string `json:"mid"`
}
type ChatUnPinRequest ¶
type ChatUnPinRequest struct {
MessageId string `json:"messageId"`
}
type ChatUnStarRequest ¶
type ChatUnStarRequest struct {
MessageId string `json:"messageId"`
}
type ChatUpdateRequest ¶
type CloseIMRequest ¶
type CloseIMRequest struct {
RoomId string `json:"roomId"`
}
type CountersIMMessage ¶
type CreateGroupRequest ¶
type CreateIMRequest ¶
type CreateIntegration ¶
type CreateIntegration struct { Type string `json:"type"` Name string `json:"name"` Event string `json:"event"` Enabled bool `json:"enabled"` Username string `json:"username"` Urls []string `json:"urls"` ScriptEnabled bool `json:"scriptEnabled"` Channel string `json:"channel"` TriggerWords []string `json:"triggerWords"` Alias string `json:"alias"` Avater string `json:"avater"` Emoji string `json:"emoji"` Token string `json:"token"` Script string `json:"script"` }
type CreateInviteRequest ¶
type CreateUserRequest ¶
type CreateUserRequest struct { Name string `json:"name"` Email string `json:"email"` Password string `json:"password"` Username string `json:"username"` Roles []string `json:"roles,omitempty"` Active bool `json:"active,default:true"` JoinDefaultChannels bool `json:"joinDefaultChannels,default:true"` RequirePasswordChange bool `json:"requirePasswordChange,default:false"` SendWelcomeEmail bool `json:"sendWelcomeEmail,default:false"` Verified bool `json:"verified,default:false"` CustomFields map[string]string `json:"customFields,omitempty"` }
type CustomUserStatus ¶
type Department ¶
type Department struct { ID string `json:"id"` Enabled bool `json:"enabled"` ShowOnRegistration bool `json:"showOnRegistration"` Email string `json:"email"` ShowOnOfflineForm bool `json:"showOnOfflineForm"` Name string `json:"name"` UpdatedAt time.Time `json:"_updatedAt"` D string `json:"_id,omitempty"` Description string `json:"description,omitempty"` }
type EmojiDeleteRequest ¶
type EmojiDeleteRequest struct {
EmojiID string `json:"emojiId"`
}
type EveryoneListIM ¶
type ExportOperation ¶
type ExportOperation struct { UserID string `json:"userId"` RoomList interface{} `json:"roomList"` Status string `json:"status"` FileList []interface{} `json:"fileList"` GeneratedFile interface{} `json:"generatedFile"` FullExport bool `json:"fullExport"` UserData struct { ID string `json:"_id"` CreatedAt time.Time `json:"createdAt"` Services struct { Password struct { Bcrypt string `json:"bcrypt"` Reset struct { Token string `json:"token"` Email string `json:"email"` When time.Time `json:"when"` Reason string `json:"reason"` } `json:"reset"` } `json:"password"` Email2Fa struct { Enabled bool `json:"enabled"` ChangedAt time.Time `json:"changedAt"` } `json:"email2fa"` Email struct { VerificationTokens []struct { Token string `json:"token"` Address string `json:"address"` When time.Time `json:"when"` } `json:"verificationTokens"` } `json:"email"` Resume struct { LoginTokens []struct { When time.Time `json:"when,omitempty"` HashedToken string `json:"hashedToken"` Type string `json:"type,omitempty"` CreatedAt time.Time `json:"createdAt,omitempty"` LastTokenPart string `json:"lastTokenPart,omitempty"` Name string `json:"name,omitempty"` } `json:"loginTokens"` } `json:"resume"` } `json:"services"` Emails []struct { Address string `json:"address"` Verified bool `json:"verified"` } `json:"emails"` Type string `json:"type"` Status string `json:"status"` Active bool `json:"active"` UpdatedAt time.Time `json:"_updatedAt"` Roles []string `json:"roles"` Name string `json:"name"` LastLogin time.Time `json:"lastLogin"` StatusConnection string `json:"statusConnection"` UtcOffset int `json:"utcOffset"` Username string `json:"username"` Settings struct { Preferences struct { AutoImageLoad bool `json:"autoImageLoad"` CollapseMediaByDefault bool `json:"collapseMediaByDefault"` ConvertASCIIEmoji bool `json:"convertAsciiEmoji"` DesktopNotificationDuration int `json:"desktopNotificationDuration"` DesktopNotificationRequireInteraction bool `json:"desktopNotificationRequireInteraction"` DesktopNotifications string `json:"desktopNotifications"` DontAskAgainList []interface{} `json:"dontAskAgainList"` EmailNotificationMode string `json:"emailNotificationMode"` EnableAutoAway bool `json:"enableAutoAway"` HideAvatars bool `json:"hideAvatars"` HideFlexTab bool `json:"hideFlexTab"` HideRoles bool `json:"hideRoles"` HideUsernames bool `json:"hideUsernames"` Highlights []interface{} `json:"highlights"` IdleTimeLimit int `json:"idleTimeLimit"` Language string `json:"language"` MessageViewMode int `json:"messageViewMode"` MobileNotifications string `json:"mobileNotifications"` MuteFocusedConversations bool `json:"muteFocusedConversations"` NewMessageNotification string `json:"newMessageNotification"` NewRoomNotification string `json:"newRoomNotification"` NotificationsSoundVolume int `json:"notificationsSoundVolume"` SaveMobileBandwidth bool `json:"saveMobileBandwidth"` SendOnEnter string `json:"sendOnEnter"` SidebarHideAvatar bool `json:"sidebarHideAvatar"` SidebarShowDiscussion bool `json:"sidebarShowDiscussion"` UnreadAlert bool `json:"unreadAlert"` UseEmojis bool `json:"useEmojis"` } `json:"preferences"` } `json:"settings"` Language string `json:"language"` StatusText string `json:"statusText"` StatusDefault string `json:"statusDefault"` } `json:"userData"` ID string `json:"_id"` ExportPath string `json:"exportPath"` AssetsPath string `json:"assetsPath"` }
type FileIM ¶
type FileIM struct { ID string `json:"_id"` Name string `json:"name"` Size int `json:"size"` Type string `json:"type"` RoomId string `json:"rid"` Description string `json:"description"` Store string `json:"store"` Complete bool `json:"complete"` Uploading bool `json:"uploading"` Extension string `json:"extension"` Progress int `json:"progress"` User User `json:"user"` UpdatedAt time.Time `json:"_updatedAt"` InstanceID string `json:"instanceId"` Etag string `json:"etag"` Path string `json:"path"` Token string `json:"token"` UploadedAt time.Time `json:"uploadedAt"` URL string `json:"url"` }
type ForgotPassword ¶
type ForgotPassword struct {
Email string `json:"email"`
}
type GroupAddAllRequest ¶
type GroupAddLeaderRequest ¶
type GroupAddOwnerRequest ¶
type GroupArchiveRequest ¶
type GroupArchiveRequest struct {
RoomID string `json:"roomId"`
}
type GroupCloseRequest ¶
type GroupCloseRequest struct {
RoomID string `json:"roomId"`
}
type GroupDeleteRequest ¶
type GroupDescriptionRequest ¶
type GroupInviteRequest ¶
type GroupKickRequest ¶
type GroupLeaveRequest ¶
type GroupLeaveRequest struct {
RoomID string `json:"roomId"`
}
type GroupList ¶
type GroupList struct { Groups []struct { ID string `json:"_id"` Name string `json:"name"` Fname string `json:"fname"` T string `json:"t"` Msgs int `json:"msgs"` UsersCount int `json:"usersCount"` U struct { ID string `json:"_id"` Username string `json:"username"` } `json:"u"` CustomFields struct { } `json:"customFields"` Ts time.Time `json:"ts"` Ro bool `json:"ro"` Default bool `json:"default"` SysMes bool `json:"sysMes"` UpdatedAt time.Time `json:"_updatedAt"` } `json:"groups"` }
type GroupOpenRequest ¶
type GroupOpenRequest struct {
RoomID string `json:"roomId"`
}
type GroupReadOnlyRequest ¶
type GroupRemoveOwnerRequest ¶
type GroupRenameRequest ¶
type GroupTopicRequest ¶
type GroupTypeRequest ¶
type GroupUnArchiveRequest ¶
type GroupUnArchiveRequest struct {
RoomID string `json:"roomId"`
}
type Info ¶
type Info struct { Version string `json:"version"` Build struct { NodeVersion string `json:"nodeVersion"` Arch string `json:"arch"` Platform string `json:"platform"` Cpus int `json:"cpus"` } `json:"build"` Commit struct { Hash string `json:"hash"` Date string `json:"date"` Author string `json:"author"` Subject string `json:"subject"` Tag string `json:"tag"` Branch string `json:"branch"` } `json:"commit"` }
type Inquiry ¶
type Inquiry struct { ID string `json:"_id"` Rid string `json:"rid"` Message string `json:"message"` Name string `json:"name"` Ts time.Time `json:"ts"` Agents []string `json:"agents"` Status string `json:"status"` V struct { ID string `json:"_id"` Username string `json:"username"` Token string `json:"token"` Status string `json:"status"` } `json:"v"` T string `json:"t"` UpdatedAt time.Time `json:"_updatedAt"` }
type Integration ¶
type Integration struct { ID string `json:"_id"` CreatedAt time.Time `json:"_createdAt"` CreatedBy CreatedBy `json:"_createdBy"` UpdatedAt time.Time `json:"_updatedAt"` CreateIntegration ImpersonateUser bool `json:"impersonateUser"` ScriptCompiled string `json:"scriptCompiled"` ScriptError interface{} `json:"scriptError"` UserId string `json:"userId"` }
type IntegrationData ¶
type IntegrationHistory ¶
type IntegrationHistory struct { PartIntegrationHistory Event string `json:"event"` CreateAt time.Time `json:"_createdAt"` UpdateAt time.Time `json:"_updatedAt"` IntegrationData `json:"data"` IntegrationRoom `json:"room"` Url string `json:"url"` }
type IntegrationRoom ¶
type IntegrationRoom struct { ID string `json:"_id"` TimeStamp time.Time `json:"ts"` T string `json:"t"` Name string `json:"name"` Usernames []interface{} `json:"usernames"` Msgs int `json:"msgs"` UsersCount int `json:"usersCount"` Default bool `json:"default"` UpdatedAt time.Time `json:"_updatedAt"` LastMessage struct { ID string `json:"_id"` Alias string `json:"alias"` Msg string `json:"msg"` Attachments []interface{} `json:"attachments"` ParseUrls bool `json:"parseUrls"` Groupable bool `json:"groupable"` Ts time.Time `json:"ts"` U struct { ID string `json:"_id"` Username string `json:"username"` Name string `json:"name"` } `json:"u"` Rid string `json:"rid"` UpdatedAt time.Time `json:"_updatedAt"` Mentions []interface{} `json:"mentions"` Channels []interface{} `json:"channels"` } `json:"lastMessage"` Lm time.Time `json:"lm"` JitsiTimeout time.Time `json:"jitsiTimeout"` }
type IntegrationSetting ¶
type IntegrationSetting struct { ID string `json:"_id"` UpdatedAt time.Time `json:"_updatedAt"` Autocomplete bool `json:"autocomplete"` Blocked bool `json:"blocked"` CreatedAt time.Time `json:"createdAt"` Group string `json:"group"` Hidden bool `json:"hidden"` I18NDescription string `json:"i18nDescription"` I18NLabel string `json:"i18nLabel"` PackageValue string `json:"packageValue"` Secret bool `json:"secret"` Section string `json:"section"` Sorter int `json:"sorter"` Ts time.Time `json:"ts"` Type string `json:"type"` Value string `json:"value"` ValueSource string `json:"valueSource"` MeteorSettingsValue string `json:"meteorSettingsValue"` }
type Invite ¶
type Invite struct { ID string `json:"_id"` Days int `json:"days"` MaxUses int `json:"maxUses"` Rid string `json:"rid"` UserID string `json:"userId"` CreatedAt time.Time `json:"createdAt"` Expires time.Time `json:"expires"` UpdatedAt time.Time `json:"_updatedAt"` Uses int `json:"uses"` URL string `json:"url"` }
type LiveChatConfig ¶
type LiveChatConfig struct { Enabled bool `json:"enabled"` Settings struct { RegistrationForm bool `json:"registrationForm"` AllowSwitchingDepartments bool `json:"allowSwitchingDepartments"` NameFieldRegistrationForm bool `json:"nameFieldRegistrationForm"` EmailFieldRegistrationForm bool `json:"emailFieldRegistrationForm"` DisplayOfflineForm bool `json:"displayOfflineForm"` VideoCall bool `json:"videoCall"` FileUpload bool `json:"fileUpload"` Language string `json:"language"` Transcript bool `json:"transcript"` HistoryMonitorType string `json:"historyMonitorType"` ForceAcceptDataProcessingConsent bool `json:"forceAcceptDataProcessingConsent"` ShowConnecting bool `json:"showConnecting"` AgentHiddenInfo bool `json:"agentHiddenInfo"` } `json:"settings"` Theme struct { Title string `json:"title"` Color string `json:"color"` OfflineTitle string `json:"offlineTitle"` OfflineColor string `json:"offlineColor"` ActionLinks []struct { Icon string `json:"icon"` I18NLabel string `json:"i18nLabel"` MethodID string `json:"method_id"` Params string `json:"params"` } `json:"actionLinks"` } `json:"theme"` Messages struct { OfflineMessage string `json:"offlineMessage"` OfflineSuccessMessage string `json:"offlineSuccessMessage"` OfflineUnavailableMessage string `json:"offlineUnavailableMessage"` ConversationFinishedMessage string `json:"conversationFinishedMessage"` ConversationFinishedText string `json:"conversationFinishedText"` TranscriptMessage string `json:"transcriptMessage"` RegistrationFormMessage string `json:"registrationFormMessage"` DataProcessingConsentText string `json:"dataProcessingConsentText"` } `json:"messages"` Survey struct { Items []string `json:"items"` Values []string `json:"values"` } `json:"survey"` Triggers []struct { ID string `json:"_id"` Actions []struct { Name string `json:"name"` Params struct { Sender string `json:"sender"` Msg string `json:"msg"` } `json:"params"` } `json:"actions"` Conditions []struct { Name string `json:"name"` Value string `json:"value"` } `json:"conditions"` RunOnce bool `json:"runOnce"` } `json:"triggers"` Departments []struct { ID string `json:"_id"` Name string `json:"name"` ShowOnRegistration bool `json:"showOnRegistration"` ShowOnOfflineForm bool `json:"showOnOfflineForm"` } `json:"departments"` Resources struct { Sound string `json:"sound"` Emojis []interface{} `json:"emojis"` } `json:"resources"` Online bool `json:"online"` Guest struct { ID string `json:"_id"` Username string `json:"username"` Name string `json:"name"` Token string `json:"token"` VisitorEmails []struct { Address string `json:"address"` } `json:"visitorEmails"` } `json:"guest"` Room struct { ID string `json:"_id"` Open bool `json:"open"` ServedBy struct { ID string `json:"_id"` Username string `json:"username"` Ts time.Time `json:"ts"` } `json:"servedBy"` } `json:"room"` Agent struct { ID string `json:"_id"` Name string `json:"name"` Username string `json:"username"` Status string `json:"status"` } `json:"agent"` CustomFields []interface{} `json:"customFields"` }
type LiveChatHistory ¶
type LiveChatHistory struct { ID string `json:"_id"` Msgs int `json:"msgs"` UsersCount int `json:"usersCount"` Lm time.Time `json:"lm"` Fname string `json:"fname"` T string `json:"t"` Ts time.Time `json:"ts"` V struct { ID string `json:"_id"` Username string `json:"username"` Token string `json:"token"` Status string `json:"status"` } `json:"v"` Cl bool `json:"cl"` Open bool `json:"open"` WaitingResponse bool `json:"waitingResponse"` UpdatedAt time.Time `json:"_updatedAt"` ServedBy struct { ID string `json:"_id"` Username string `json:"username"` Ts time.Time `json:"ts"` } `json:"servedBy"` }
type LiveChatMessage ¶
type LiveChatOfficeHour ¶
type LiveChatPage ¶
type LiveChatPage struct { ID string `json:"_id"` T string `json:"t"` Rid string `json:"rid"` Ts time.Time `json:"ts"` Msg string `json:"msg"` U struct { ID string `json:"_id"` Username string `json:"username"` } `json:"u"` Groupable bool `json:"groupable"` Page struct { Change string `json:"change"` Title string `json:"title"` Location struct { Href string `json:"href"` } `json:"location"` } `json:"page"` Token string `json:"token"` } `json:"navigation"` Hidden bool `json:"_hidden"` UpdatedAt time.Time `json:"_updatedAt"` }
type LiveChatRoom ¶
type LiveChatRoom struct { ID string `json:"_id"` Msgs int `json:"msgs"` UsersCount int `json:"usersCount"` Lm time.Time `json:"lm"` Fname string `json:"fname"` T string `json:"t"` Ts time.Time `json:"ts"` V struct { ID string `json:"_id"` Username string `json:"username"` Token string `json:"token"` Status string `json:"status"` } `json:"v"` Cl bool `json:"cl"` Open bool `json:"open"` WaitingResponse bool `json:"waitingResponse"` UpdatedAt time.Time `json:"_updatedAt"` ServedBy struct { ID string `json:"_id"` Username string `json:"username"` Ts time.Time `json:"ts"` } }
type LiveChatRoomTransfer ¶
type LiveChatTrigger ¶
type LiveChatTrigger struct { ID string `json:"_id"` Name string `json:"name"` Description string `json:"description"` Enabled bool `json:"enabled"` RunOnce bool `json:"runOnce"` Conditions []struct { Name string `json:"name"` Value string `json:"value"` } `json:"conditions"` Actions []struct { Name string `json:"name"` Params struct { Sender string `json:"sender"` Msg string `json:"msg"` } `json:"params"` } `json:"actions"` UpdatedAt time.Time `json:"_updatedAt"` }
type LiveChatUser ¶
type LiveChatUsers ¶
type LiveChatVisitor ¶
type LiveChatVisitor struct { ID string `json:"_id"` Username string `json:"username"` UpdatedAt time.Time `json:"_updatedAt"` Token string `json:"token"` Phone []struct { PhoneNumber string `json:"phoneNumber"` } `json:"phone"` VisitorEmails []struct { Address string `json:"address"` } `json:"visitorEmails"` Name string `json:"name"` LivechatData struct { Address string `json:"address"` } `json:"livechatData"` }
type Me ¶
type Me struct { ID string `json:"_id"` Name string `json:"name"` Emails []struct { Address string `json:"address"` Verified bool `json:"verified"` } `json:"emails"` Status string `json:"status"` StatusConnection string `json:"statusConnection"` Username string `json:"username"` UtcOffset int `json:"utcOffset"` Active bool `json:"active"` Roles []string `json:"roles"` Settings struct { Preferences struct { EnableAutoAway bool `json:"enableAutoAway"` IdleTimeoutLimit int `json:"idleTimeoutLimit"` DesktopNotificationDuration int `json:"desktopNotificationDuration"` AudioNotifications string `json:"audioNotifications"` DesktopNotifications string `json:"desktopNotifications"` MobileNotifications string `json:"mobileNotifications"` UnreadAlert bool `json:"unreadAlert"` UseEmojis bool `json:"useEmojis"` ConvertASCIIEmoji bool `json:"convertAsciiEmoji"` AutoImageLoad bool `json:"autoImageLoad"` SaveMobileBandwidth bool `json:"saveMobileBandwidth"` CollapseMediaByDefault bool `json:"collapseMediaByDefault"` HideUsernames bool `json:"hideUsernames"` HideRoles bool `json:"hideRoles"` HideFlexTab bool `json:"hideFlexTab"` HideAvatars bool `json:"hideAvatars"` RoomsListExhibitionMode string `json:"roomsListExhibitionMode"` SidebarViewMode string `json:"sidebarViewMode"` SidebarHideAvatar bool `json:"sidebarHideAvatar"` SidebarShowUnread bool `json:"sidebarShowUnread"` SidebarShowFavorites bool `json:"sidebarShowFavorites"` SendOnEnter string `json:"sendOnEnter"` MessageViewMode int `json:"messageViewMode"` EmailNotificationMode string `json:"emailNotificationMode"` RoomCounterSidebar bool `json:"roomCounterSidebar"` NewRoomNotification string `json:"newRoomNotification"` NewMessageNotification string `json:"newMessageNotification"` MuteFocusedConversations bool `json:"muteFocusedConversations"` NotificationsSoundVolume int `json:"notificationsSoundVolume"` } `json:"preferences"` } `json:"settings"` CustomFields struct { Twitter string `json:"twitter"` Google string `json:"google"` Facebook string `json:"facebook"` } `json:"customFields" omitempty` AvatarURL string `json:"avatarUrl"` }
type Message ¶
type Message struct { ID string `json:"_id"` RoomID string `json:"rid"` Msg string `json:"msg"` EditedBy string `json:"editedBy,omitempty"` Groupable bool `json:"groupable,omitempty"` EditedAt *time.Time `json:"editedAt,omitempty"` Timestamp *time.Time `json:"ts,omitempty"` UpdatedAt *time.Time `json:"_updatedAt,omitempty"` Mentions []User `json:"mentions,omitempty"` User *User `json:"u,omitempty"` PostMessage }
type MessageProcessingType ¶
type MessageProcessingType string
const ( ProcessingTypeSendMessage MessageProcessingType = "sendMessage" ProcessingTypeRespondWithMessage MessageProcessingType = "respondWithMessage" )
type Notifications ¶
type Notifications struct { DesktopNotifications string `json:"desktopNotifications,omitempty"` DisableNotifications string `json:"disableNotifications,omitempty"` EmailNotifications string `json:"emailNotifications,omitempty"` AudioNotificationValue string `json:"audioNotificationValue,omitempty"` DesktopNotificationDuration string `json:"desktopNotificationDuration,omitempty"` AudioNotifications string `json:"audioNotifications,omitempty"` UnreadAlert string `json:"unreadAlert,omitempty"` HideUnreadStatus string `json:"hideUnreadStatus,omitempty"` MobilePushNotifications string `json:"mobilePushNotifications,omitempty"` }
type OauthApp ¶
type OauthApp struct { ID string `json:"_id"` Name string `json:"name"` Active bool `json:"active"` ClientID string `json:"clientId"` ClientSecret string `json:"clientSecret"` RedirectURI string `json:"redirectUri"` CreatedAt time.Time `json:"_createdAt"` CreatedBy struct { ID string `json:"_id"` Username string `json:"username"` } `json:"_createdBy"` UpdatedAt time.Time `json:"_updatedAt"` }
type OnlineChannel ¶
type Pagination ¶
type PartIntegrationHistory ¶
type PartIntegrationHistory struct { ID string `json:"_id"` Type string `json:"type"` Step string `json:"step"` Integration }
type Permission ¶
type PostMessage ¶
type PostMessage struct { RoomID string `json:"roomId,omitempty"` Channel string `json:"channel,omitempty"` Text string `json:"text,omitempty"` ParseUrls bool `json:"parseUrls,omitempty"` Alias string `json:"alias,omitempty"` Emoji string `json:"emoji,omitempty"` Avatar string `json:"avatar,omitempty"` Attachments []Attachment `json:"attachments,omitempty"` }
PostMessage Payload for postmessage rest API
https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage/
type Preferences ¶
type Preferences struct { AutoImageLoad bool `json:"autoImageLoad"` CollapseMediaByDefault bool `json:"collapseMediaByDefault"` ConvertASCIIEmoji bool `json:"convertAsciiEmoji"` DesktopNotificationDuration int `json:"desktopNotificationDuration"` DesktopNotificationRequireInteraction bool `json:"desktopNotificationRequireInteraction"` DesktopNotifications string `json:"desktopNotifications"` DontAskAgainList []interface{} `json:"dontAskAgainList"` EmailNotificationMode string `json:"emailNotificationMode"` EnableAutoAway bool `json:"enableAutoAway"` HideAvatars bool `json:"hideAvatars"` HideFlexTab bool `json:"hideFlexTab"` HideRoles bool `json:"hideRoles"` HideUsernames bool `json:"hideUsernames"` Highlights []interface{} `json:"highlights"` IdleTimeLimit int `json:"idleTimeLimit"` Language string `json:"language"` MessageViewMode int `json:"messageViewMode"` MobileNotifications string `json:"mobileNotifications"` MuteFocusedConversations bool `json:"muteFocusedConversations"` NewMessageNotification string `json:"newMessageNotification"` NewRoomNotification string `json:"newRoomNotification"` NotificationsSoundVolume int `json:"notificationsSoundVolume"` SaveMobileBandwidth bool `json:"saveMobileBandwidth"` SendOnEnter string `json:"sendOnEnter"` SidebarHideAvatar bool `json:"sidebarHideAvatar"` SidebarShowDiscussion bool `json:"sidebarShowDiscussion"` UnreadAlert bool `json:"unreadAlert"` UseEmojis bool `json:"useEmojis"` }
type RegisterUserRequest ¶
type Room ¶
type Room struct { ID string `json:"_id"` Ts time.Time `json:"ts"` T string `json:"t"` Name string `json:"name"` Usernames []interface{} `json:"usernames"` Msgs int `json:"msgs"` UsersCount int `json:"usersCount"` Default bool `json:"default"` Favorite bool `json:"favorite"` UpdatedAt time.Time `json:"_updatedAt"` Lm time.Time `json:"lm"` }
type RoomCleanHistoryRequest ¶
type SetActiveStatus ¶
type SetPreferrences ¶
type SetPreferrences struct { UserID string `json:"userId"` Data struct { AutoImageLoad bool `json:"autoImageLoad"` CollapseMediaByDefault bool `json:"collapseMediaByDefault"` ConvertASCIIEmoji bool `json:"convertAsciiEmoji"` DesktopNotificationDuration int `json:"desktopNotificationDuration"` DesktopNotificationRequireInteraction bool `json:"desktopNotificationRequireInteraction"` DesktopNotifications string `json:"desktopNotifications"` EmailNotificationMode string `json:"emailNotificationMode"` EnableAutoAway bool `json:"enableAutoAway"` GroupByType bool `json:"groupByType"` HideAvatars bool `json:"hideAvatars"` HideRoles bool `json:"hideRoles"` HideUsernames bool `json:"hideUsernames"` Highlights []interface{} `json:"highlights,omitempty"` Language string `json:"language"` MobileNotifications string `json:"mobileNotifications"` MuteFocusedConversations bool `json:"muteFocusedConversations"` NewMessageNotification string `json:"newMessageNotification"` NewRoomNotification string `json:"newRoomNotification"` NotificationsSoundVolume int `json:"notificationsSoundVolume"` RoomsListExhibitionMode string `json:"roomsListExhibitionMode"` SaveMobileBandwidth bool `json:"saveMobileBandwidth"` RoomCounterSidebar bool `json:"roomCounterSidebar"` SendOnEnter string `json:"sendOnEnter"` SidebarHideAvatar bool `json:"sidebarHideAvatar"` SidebarShowDiscussion bool `json:"sidebarShowDiscussion"` SidebarSortby string `json:"sidebarSortby"` SidebarViewMode string `json:"sidebarViewMode"` SidebarShowFavorites bool `json:"sidebarShowFavorites"` UnreadAlert bool `json:"unreadAlert"` ViewMode int `json:"viewMode"` UseEmojis bool `json:"useEmojis"` } `json:"data,omitempty"` }
type Setting ¶
type Setting struct { ID string `json:"_id"` Blocked bool `json:"blocked"` Group string `json:"group"` Hidden bool `json:"hidden"` Public bool `json:"public"` Type string `json:"type"` PackageValue string `json:"packageValue"` Sorter int `json:"sorter"` Value string `json:"value"` ValueBool bool `json:"valueBool"` ValueInt float64 `json:"valueInt"` ValueSource string `json:"valueSource"` ValueAsset Asset `json:"asset"` }
type Settings ¶
type Settings struct { RegistrationForm bool `json:"registrationForm"` AllowSwitchingDepartments bool `json:"allowSwitchingDepartments"` NameFieldRegistrationForm bool `json:"nameFieldRegistrationForm"` EmailFieldRegistrationForm bool `json:"emailFieldRegistrationForm"` DisplayOfflineForm bool `json:"displayOfflineForm"` VideoCall bool `json:"videoCall"` FileUpload bool `json:"fileUpload"` Language string `json:"language"` Transcript bool `json:"transcript"` HistoryMonitorType string `json:"historyMonitorType"` }
type SettingsMessage ¶
type SettingsOauth ¶
type SettingsOauth struct { ID string `json:"_id"` Name string `json:"name"` Service string `json:"service"` ClientID string `json:"clientId"` Custom bool `json:"custom"` ServerURL string `json:"serverURL"` TokenPath string `json:"tokenPath"` IdentityPath string `json:"identityPath"` AuthorizePath string `json:"authorizePath"` Scope string `json:"scope"` ButtonLabelText string `json:"buttonLabelText"` ButtonLabelColor string `json:"buttonLabelColor"` LoginStyle string `json:"loginStyle"` ButtonColor string `json:"buttonColor"` TokenSentVia string `json:"tokenSentVia"` IdentityTokenSentVia string `json:"identityTokenSentVia"` UsernameField string `json:"usernameField"` MergeUsers bool `json:"mergeUsers"` }
type SettingsPrivate ¶
type SettingsUpdate ¶
type Statistics ¶
type Statistics struct { ID string `json:"_id"` UniqueID string `json:"uniqueId"` Version string `json:"version"` ActiveUsers int `json:"activeUsers"` NonActiveUsers int `json:"nonActiveUsers"` OnlineUsers int `json:"onlineUsers"` AwayUsers int `json:"awayUsers"` OfflineUsers int `json:"offlineUsers"` TotalUsers int `json:"totalUsers"` TotalRooms int `json:"totalRooms"` TotalChannels int `json:"totalChannels"` TotalPrivateGroups int `json:"totalPrivateGroups"` TotalDirect int `json:"totalDirect"` TotlalLivechat int `json:"totlalLivechat"` TotalMessages int `json:"totalMessages"` TotalChannelMessages int `json:"totalChannelMessages"` TotalPrivateGroupMessages int `json:"totalPrivateGroupMessages"` TotalDirectMessages int `json:"totalDirectMessages"` TotalLivechatMessages int `json:"totalLivechatMessages"` InstalledAt time.Time `json:"installedAt"` LastLogin time.Time `json:"lastLogin"` LastMessageSentAt time.Time `json:"lastMessageSentAt"` LastSeenSubscription time.Time `json:"lastSeenSubscription"` Os struct { Type string `json:"type"` Platform string `json:"platform"` Arch string `json:"arch"` Release string `json:"release"` Uptime int `json:"uptime"` Loadavg []float64 `json:"loadavg"` Totalmem int64 `json:"totalmem"` Freemem int `json:"freemem"` Cpus []struct { Model string `json:"model"` Speed int `json:"speed"` Times struct { User int `json:"user"` Nice int `json:"nice"` Sys int `json:"sys"` Idle int `json:"idle"` Irq int `json:"irq"` } `json:"times"` } `json:"cpus"` } `json:"os"` Process struct { NodeVersion string `json:"nodeVersion"` Pid int `json:"pid"` Uptime float64 `json:"uptime"` } `json:"process"` Deploy struct { Method string `json:"method"` Platform string `json:"platform"` } `json:"deploy"` Migration struct { ID string `json:"_id"` Version int `json:"version"` Locked bool `json:"locked"` LockedAt time.Time `json:"lockedAt"` BuildAt time.Time `json:"buildAt"` } `json:"migration"` InstanceCount int `json:"instanceCount"` CreatedAt time.Time `json:"createdAt"` UpdatedAt time.Time `json:"_updatedAt"` }
type StatisticsInfo ¶
type StatisticsInfo struct {
Statistics Statistics `json:"statistics"`
}
type StatisticsList ¶
type StatisticsList struct { Statistics []Statistics `json:"statistics"` Pagination }
type Theme ¶
type Theme struct { Title string `json:"title"` Color string `json:"color"` OfflineTitle string `json:"offlineTitle"` OfflineColor string `json:"offlineColor"` ActionLinks []ActionLinks `json:"actionLinks"` }
type Update ¶
type Update struct { ID string `json:"_id"` UpdatedAt time.Time `json:"_updatedAt,omitempty"` Group string `json:"group,omitempty"` GroupPermissionID string `json:"groupPermissionId,omitempty"` Level string `json:"level,omitempty"` Roles []interface{} `json:"roles,omitempty"` Section string `json:"section,omitempty"` SectionPermissionID string `json:"sectionPermissionId,omitempty"` SettingID string `json:"settingId,omitempty"` Sorter int `json:"sorter,omitempty"` }
type UpdateOwnBasicInfo ¶
type UpdateUserRequest ¶
type UserCredentials ¶
type UserDeleteOwnRequest ¶
type UserDeleteOwnRequest struct {
PassWord string `json:"password"`
}
type UserDeleteRequest ¶
type UserResetAvatarRequest ¶
type VedieUpdateTimeoutRequest ¶
type VedieUpdateTimeoutRequest struct {
RoomID string `json:"roomId"`
}
Source Files
¶
Click to show internal directories.
Click to hide internal directories.