model

package
v3.7.5-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 26, 2017 License: AGPL-3.0, Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ACCESS_TOKEN_GRANT_TYPE  = "authorization_code"
	ACCESS_TOKEN_TYPE        = "bearer"
	REFRESH_TOKEN_GRANT_TYPE = "refresh_token"
)
View Source 
const (
	AUTHCODE_EXPIRE_TIME   = 60 * 10 // 10 minutes
	AUTHCODE_RESPONSE_TYPE = "code"
	DEFAULT_SCOPE          = "user"
)
View Source 
const (
	CHANNEL_OPEN                   = "O"
	CHANNEL_PRIVATE                = "P"
	CHANNEL_DIRECT                 = "D"
	CHANNEL_GROUP                  = "G"
	CHANNEL_GROUP_MAX_USERS        = 8
	CHANNEL_GROUP_MIN_USERS        = 3
	DEFAULT_CHANNEL                = "town-square"
	CHANNEL_DISPLAY_NAME_MAX_RUNES = 64
	CHANNEL_NAME_MIN_LENGTH        = 2
	CHANNEL_NAME_MAX_LENGTH        = 64
	CHANNEL_HEADER_MAX_RUNES       = 1024
	CHANNEL_PURPOSE_MAX_RUNES      = 250
	CHANNEL_CACHE_SIZE             = 25000
)
View Source 
const (
	CHANNEL_NOTIFY_DEFAULT      = "default"
	CHANNEL_NOTIFY_ALL          = "all"
	CHANNEL_NOTIFY_MENTION      = "mention"
	CHANNEL_NOTIFY_NONE         = "none"
	CHANNEL_MARK_UNREAD_ALL     = "all"
	CHANNEL_MARK_UNREAD_MENTION = "mention"
)
View Source 
const (
	HEADER_REQUEST_ID         = "X-Request-ID"
	HEADER_VERSION_ID         = "X-Version-ID"
	HEADER_CLUSTER_ID         = "X-Cluster-ID"
	HEADER_ETAG_SERVER        = "ETag"
	HEADER_ETAG_CLIENT        = "If-None-Match"
	HEADER_FORWARDED          = "X-Forwarded-For"
	HEADER_REAL_IP            = "X-Real-IP"
	HEADER_FORWARDED_PROTO    = "X-Forwarded-Proto"
	HEADER_TOKEN              = "token"
	HEADER_BEARER             = "BEARER"
	HEADER_AUTH               = "Authorization"
	HEADER_REQUESTED_WITH     = "X-Requested-With"
	HEADER_REQUESTED_WITH_XML = "XMLHttpRequest"
	STATUS                    = "status"
	STATUS_OK                 = "OK"
	STATUS_FAIL               = "FAIL"
	STATUS_REMOVE             = "REMOVE"

	CLIENT_DIR = "webapp/dist"

	API_URL_SUFFIX_V1 = "/api/v1"
	API_URL_SUFFIX_V3 = "/api/v3"
	API_URL_SUFFIX_V4 = "/api/v4"
	API_URL_SUFFIX    = API_URL_SUFFIX_V4
)
View Source 
const (
	COMMAND_METHOD_POST = "P"
	COMMAND_METHOD_GET  = "G"
	MIN_TRIGGER_LENGTH  = 1
	MAX_TRIGGER_LENGTH  = 128
)
View Source 
const (
	COMMAND_RESPONSE_TYPE_IN_CHANNEL = "in_channel"
	COMMAND_RESPONSE_TYPE_EPHEMERAL  = "ephemeral"
)
View Source 
const (
	COMPLIANCE_STATUS_CREATED  = "created"
	COMPLIANCE_STATUS_RUNNING  = "running"
	COMPLIANCE_STATUS_FINISHED = "finished"
	COMPLIANCE_STATUS_FAILED   = "failed"
	COMPLIANCE_STATUS_REMOVED  = "removed"

	COMPLIANCE_TYPE_DAILY = "daily"
	COMPLIANCE_TYPE_ADHOC = "adhoc"
)
View Source 
const (
	CONN_SECURITY_NONE     = ""
	CONN_SECURITY_PLAIN    = "PLAIN"
	CONN_SECURITY_TLS      = "TLS"
	CONN_SECURITY_STARTTLS = "STARTTLS"

	IMAGE_DRIVER_LOCAL = "local"
	IMAGE_DRIVER_S3    = "amazons3"

	DATABASE_DRIVER_MYSQL    = "mysql"
	DATABASE_DRIVER_POSTGRES = "postgres"

	PASSWORD_MAXIMUM_LENGTH = 64
	PASSWORD_MINIMUM_LENGTH = 5

	SERVICE_GITLAB    = "gitlab"
	SERVICE_GOOGLE    = "google"
	SERVICE_OFFICE365 = "office365"

	WEBSERVER_MODE_REGULAR  = "regular"
	WEBSERVER_MODE_GZIP     = "gzip"
	WEBSERVER_MODE_DISABLED = "disabled"

	GENERIC_NOTIFICATION = "generic"
	FULL_NOTIFICATION    = "full"

	DIRECT_MESSAGE_ANY  = "any"
	DIRECT_MESSAGE_TEAM = "team"

	PERMISSIONS_ALL           = "all"
	PERMISSIONS_CHANNEL_ADMIN = "channel_admin"
	PERMISSIONS_TEAM_ADMIN    = "team_admin"
	PERMISSIONS_SYSTEM_ADMIN  = "system_admin"

	FAKE_SETTING = "********************************"

	RESTRICT_EMOJI_CREATION_ALL          = "all"
	RESTRICT_EMOJI_CREATION_ADMIN        = "admin"
	RESTRICT_EMOJI_CREATION_SYSTEM_ADMIN = "system_admin"

	PERMISSIONS_DELETE_POST_ALL          = "all"
	PERMISSIONS_DELETE_POST_TEAM_ADMIN   = "team_admin"
	PERMISSIONS_DELETE_POST_SYSTEM_ADMIN = "system_admin"

	ALLOW_EDIT_POST_ALWAYS     = "always"
	ALLOW_EDIT_POST_NEVER      = "never"
	ALLOW_EDIT_POST_TIME_LIMIT = "time_limit"

	EMAIL_BATCHING_BUFFER_SIZE = 256
	EMAIL_BATCHING_INTERVAL    = 30

	SITENAME_MAX_LENGTH = 30

	SERVICE_SETTINGS_DEFAULT_SITE_URL        = ""
	SERVICE_SETTINGS_DEFAULT_TLS_CERT_FILE   = ""
	SERVICE_SETTINGS_DEFAULT_TLS_KEY_FILE    = ""
	SERVICE_SETTINGS_DEFAULT_READ_TIMEOUT    = 300
	SERVICE_SETTINGS_DEFAULT_WRITE_TIMEOUT   = 300
	SERVICE_SETTINGS_DEFAULT_ALLOW_CORS_FROM = ""

	TEAM_SETTINGS_DEFAULT_CUSTOM_BRAND_TEXT        = ""
	TEAM_SETTINGS_DEFAULT_CUSTOM_DESCRIPTION_TEXT  = ""
	TEAM_SETTINGS_DEFAULT_USER_STATUS_AWAY_TIMEOUT = 300

	EMAIL_SETTINGS_DEFAULT_FEEDBACK_ORGANIZATION = ""

	SUPPORT_SETTINGS_DEFAULT_TERMS_OF_SERVICE_LINK = "https://about.mattermost.com/default-terms/"
	SUPPORT_SETTINGS_DEFAULT_PRIVACY_POLICY_LINK   = "https://about.mattermost.com/default-privacy-policy/"
	SUPPORT_SETTINGS_DEFAULT_ABOUT_LINK            = "https://about.mattermost.com/default-about/"
	SUPPORT_SETTINGS_DEFAULT_HELP_LINK             = "https://about.mattermost.com/default-help/"
	SUPPORT_SETTINGS_DEFAULT_REPORT_A_PROBLEM_LINK = "https://about.mattermost.com/default-report-a-problem/"
	SUPPORT_SETTINGS_DEFAULT_SUPPORT_EMAIL         = "feedback@mattermost.com"

	LDAP_SETTINGS_DEFAULT_FIRST_NAME_ATTRIBUTE = ""
	LDAP_SETTINGS_DEFAULT_LAST_NAME_ATTRIBUTE  = ""
	LDAP_SETTINGS_DEFAULT_EMAIL_ATTRIBUTE      = ""
	LDAP_SETTINGS_DEFAULT_USERNAME_ATTRIBUTE   = ""
	LDAP_SETTINGS_DEFAULT_NICKNAME_ATTRIBUTE   = ""
	LDAP_SETTINGS_DEFAULT_ID_ATTRIBUTE         = ""
	LDAP_SETTINGS_DEFAULT_POSITION_ATTRIBUTE   = ""
	LDAP_SETTINGS_DEFAULT_LOGIN_FIELD_NAME     = ""

	SAML_SETTINGS_DEFAULT_FIRST_NAME_ATTRIBUTE = ""
	SAML_SETTINGS_DEFAULT_LAST_NAME_ATTRIBUTE  = ""
	SAML_SETTINGS_DEFAULT_EMAIL_ATTRIBUTE      = ""
	SAML_SETTINGS_DEFAULT_USERNAME_ATTRIBUTE   = ""
	SAML_SETTINGS_DEFAULT_NICKNAME_ATTRIBUTE   = ""
	SAML_SETTINGS_DEFAULT_LOCALE_ATTRIBUTE     = ""
	SAML_SETTINGS_DEFAULT_POSITION_ATTRIBUTE   = ""

	NATIVEAPP_SETTINGS_DEFAULT_APP_DOWNLOAD_LINK         = "https://about.mattermost.com/downloads/"
	NATIVEAPP_SETTINGS_DEFAULT_ANDROID_APP_DOWNLOAD_LINK = "https://about.mattermost.com/mattermost-android-app/"
	NATIVEAPP_SETTINGS_DEFAULT_IOS_APP_DOWNLOAD_LINK     = "https://about.mattermost.com/mattermost-ios-app/"

	WEBRTC_SETTINGS_DEFAULT_STUN_URI = ""
	WEBRTC_SETTINGS_DEFAULT_TURN_URI = ""

	ANALYTICS_SETTINGS_DEFAULT_MAX_USERS_FOR_STATISTICS = 2500
)
View Source 
const (
	USER_AUTH_SERVICE_LDAP = "ldap"
	LDAP_SYNC_TASK_NAME    = "LDAP Syncronization"
)
View Source 
const (
	EXPIRED_LICENSE_ERROR = "api.license.add_license.expired.app_error"
	INVALID_LICENSE_ERROR = "api.license.add_license.invalid.app_error"
)
View Source 
const (
	OAUTH_ACTION_SIGNUP       = "signup"
	OAUTH_ACTION_LOGIN        = "login"
	OAUTH_ACTION_EMAIL_TO_SSO = "email_to_sso"
	OAUTH_ACTION_SSO_TO_EMAIL = "sso_to_email"
)
View Source 
const (
	PASSWORD_RECOVERY_CODE_SIZE  = 128
	PASSWORD_RECOVER_EXPIRY_TIME = 1000 * 60 * 60 // 1 hour
)
View Source 
const (
	POST_SYSTEM_MESSAGE_PREFIX = "system_"
	POST_DEFAULT               = ""
	POST_SLACK_ATTACHMENT      = "slack_attachment"
	POST_SYSTEM_GENERIC        = "system_generic"
	POST_JOIN_LEAVE            = "system_join_leave" // Deprecated, use POST_JOIN_CHANNEL or POST_LEAVE_CHANNEL instead
	POST_JOIN_CHANNEL          = "system_join_channel"
	POST_LEAVE_CHANNEL         = "system_leave_channel"
	POST_ADD_REMOVE            = "system_add_remove" // Deprecated, use POST_ADD_TO_CHANNEL or POST_REMOVE_FROM_CHANNEL instead
	POST_ADD_TO_CHANNEL        = "system_add_to_channel"
	POST_REMOVE_FROM_CHANNEL   = "system_remove_from_channel"
	POST_HEADER_CHANGE         = "system_header_change"
	POST_DISPLAYNAME_CHANGE    = "system_displayname_change"
	POST_PURPOSE_CHANGE        = "system_purpose_change"
	POST_CHANNEL_DELETED       = "system_channel_deleted"
	POST_EPHEMERAL             = "system_ephemeral"
	POST_FILEIDS_MAX_RUNES     = 150
	POST_FILENAMES_MAX_RUNES   = 4000
	POST_HASHTAGS_MAX_RUNES    = 1000
	POST_MESSAGE_MAX_RUNES     = 4000
	POST_PROPS_MAX_RUNES       = 8000
)
View Source 
const (
	PREFERENCE_CATEGORY_DIRECT_CHANNEL_SHOW = "direct_channel_show"
	PREFERENCE_CATEGORY_TUTORIAL_STEPS      = "tutorial_step"
	PREFERENCE_CATEGORY_ADVANCED_SETTINGS   = "advanced_settings"
	PREFERENCE_CATEGORY_FLAGGED_POST        = "flagged_post"

	PREFERENCE_CATEGORY_DISPLAY_SETTINGS   = "display_settings"
	PREFERENCE_NAME_COLLAPSE_SETTING       = "collapse_previews"
	PREFERENCE_NAME_DISPLAY_NAME_FORMAT    = "name_format"
	PREFERENCE_VALUE_DISPLAY_NAME_NICKNAME = "nickname_full_name"
	PREFERENCE_VALUE_DISPLAY_NAME_FULL     = "full_name"
	PREFERENCE_VALUE_DISPLAY_NAME_USERNAME = "username"
	PREFERENCE_DEFAULT_DISPLAY_NAME_FORMAT = PREFERENCE_VALUE_DISPLAY_NAME_USERNAME

	PREFERENCE_CATEGORY_THEME = "theme"

	PREFERENCE_CATEGORY_AUTHORIZED_OAUTH_APP = "oauth_app"

	PREFERENCE_CATEGORY_LAST     = "last"
	PREFERENCE_NAME_LAST_CHANNEL = "channel"
	PREFERENCE_NAME_LAST_TEAM    = "team"

	PREFERENCE_CATEGORY_NOTIFICATIONS = "notifications"
	PREFERENCE_NAME_EMAIL_INTERVAL    = "email_interval"
	PREFERENCE_DEFAULT_EMAIL_INTERVAL = "30" // default to match the interval of the "immediate" setting (ie 30 seconds)
)
View Source 
const (
	PUSH_NOTIFY_APPLE                = "apple"
	PUSH_NOTIFY_ANDROID              = "android"
	PUSH_NOTIFY_APPLE_REACT_NATIVE   = "apple_rn"
	PUSH_NOTIFY_ANDROID_REACT_NATIVE = "android_rn"

	PUSH_TYPE_MESSAGE = "message"
	PUSH_TYPE_CLEAR   = "clear"

	CATEGORY_DM = "DIRECT_MESSAGE"

	MHPNS = "https://push.mattermost.com"
)
View Source 
const (
	PUSH_STATUS           = "status"
	PUSH_STATUS_OK        = "OK"
	PUSH_STATUS_FAIL      = "FAIL"
	PUSH_STATUS_REMOVE    = "REMOVE"
	PUSH_STATUS_ERROR_MSG = "error"
)
View Source 
const (
	USER_AUTH_SERVICE_SAML      = "saml"
	USER_AUTH_SERVICE_SAML_TEXT = "With SAML"
	SAML_IDP_CERTIFICATE        = 1
	SAML_PRIVATE_KEY            = 2
	SAML_PUBLIC_CERT            = 3
)
View Source 
const (
	SESSION_COOKIE_TOKEN  = "MMAUTHTOKEN"
	SESSION_CACHE_SIZE    = 35000
	SESSION_PROP_PLATFORM = "platform"
	SESSION_PROP_OS       = "os"
	SESSION_PROP_BROWSER  = "browser"
)
View Source 
const (
	STATUS_OFFLINE         = "offline"
	STATUS_AWAY            = "away"
	STATUS_ONLINE          = "online"
	STATUS_CACHE_SIZE      = SESSION_CACHE_SIZE
	STATUS_CHANNEL_TIMEOUT = 20000  // 20 seconds
	STATUS_MIN_UPDATE_TIME = 120000 // 2 minutes
)
View Source 
const (
	SYSTEM_DIAGNOSTIC_ID        = "DiagnosticId"
	SYSTEM_RAN_UNIT_TESTS       = "RanUnitTests"
	SYSTEM_LAST_SECURITY_TIME   = "LastSecurityTime"
	SYSTEM_ACTIVE_LICENSE_ID    = "ActiveLicenseId"
	SYSTEM_LAST_COMPLIANCE_TIME = "LastComplianceTime"
)
View Source 
const (
	TEAM_OPEN                       = "O"
	TEAM_INVITE                     = "I"
	TEAM_ALLOWED_DOMAINS_MAX_LENGTH = 500
	TEAM_COMPANY_NAME_MAX_LENGTH    = 64
	TEAM_DESCRIPTION_MAX_LENGTH     = 255
	TEAM_DISPLAY_NAME_MAX_RUNES     = 64
	TEAM_EMAIL_MAX_LENGTH           = 128
	TEAM_NAME_MAX_LENGTH            = 64
	TEAM_NAME_MIN_LENGTH            = 2
)
View Source 
const (
	USER_NOTIFY_ALL         = "all"
	USER_NOTIFY_MENTION     = "mention"
	USER_NOTIFY_NONE        = "none"
	DESKTOP_NOTIFY_PROP     = "desktop"
	MARK_UNREAD_NOTIFY_PROP = "mark_unread"
	PUSH_NOTIFY_PROP        = "push"
	EMAIL_NOTIFY_PROP       = "email"

	DEFAULT_LOCALE             = "en"
	USER_AUTH_SERVICE_EMAIL    = "email"
	USER_AUTH_SERVICE_USERNAME = "username"

	USER_EMAIL_MAX_LENGTH     = 128
	USER_NICKNAME_MAX_RUNES   = 64
	USER_POSITION_MAX_RUNES   = 35
	USER_FIRST_NAME_MAX_RUNES = 64
	USER_LAST_NAME_MAX_RUNES  = 64
	USER_AUTH_DATA_MAX_LENGTH = 128
	USER_NAME_MAX_LENGTH      = 64
	USER_NAME_MIN_LENGTH      = 1
)
View Source 
const (
	LOWERCASE_LETTERS = "abcdefghijklmnopqrstuvwxyz"
	UPPERCASE_LETTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
	NUMBERS           = "0123456789"
	SYMBOLS           = " !\"\\#$%&'()*+,-./:;<=>?@[]^_`|~"
)
View Source 
const (
	WEBSOCKET_EVENT_TYPING             = "typing"
	WEBSOCKET_EVENT_POSTED             = "posted"
	WEBSOCKET_EVENT_POST_EDITED        = "post_edited"
	WEBSOCKET_EVENT_POST_DELETED       = "post_deleted"
	WEBSOCKET_EVENT_CHANNEL_DELETED    = "channel_deleted"
	WEBSOCKET_EVENT_CHANNEL_CREATED    = "channel_created"
	WEBSOCKET_EVENT_DIRECT_ADDED       = "direct_added"
	WEBSOCKET_EVENT_GROUP_ADDED        = "group_added"
	WEBSOCKET_EVENT_NEW_USER           = "new_user"
	WEBSOCKET_EVENT_LEAVE_TEAM         = "leave_team"
	WEBSOCKET_EVENT_UPDATE_TEAM        = "update_team"
	WEBSOCKET_EVENT_USER_ADDED         = "user_added"
	WEBSOCKET_EVENT_USER_UPDATED       = "user_updated"
	WEBSOCKET_EVENT_USER_REMOVED       = "user_removed"
	WEBSOCKET_EVENT_PREFERENCE_CHANGED = "preference_changed"
	WEBSOCKET_EVENT_EPHEMERAL_MESSAGE  = "ephemeral_message"
	WEBSOCKET_EVENT_STATUS_CHANGE      = "status_change"
	WEBSOCKET_EVENT_HELLO              = "hello"
	WEBSOCKET_EVENT_WEBRTC             = "webrtc"
	WEBSOCKET_AUTHENTICATION_CHALLENGE = "authentication_challenge"
	WEBSOCKET_EVENT_REACTION_ADDED     = "reaction_added"
	WEBSOCKET_EVENT_REACTION_REMOVED   = "reaction_removed"
)
View Source 
const (
	DEFAULT_WEBHOOK_USERNAME = "webhook"
)
View Source 
const (
	MaxImageSize = 6048 * 4032 // 24 megapixels, roughly 36MB as a raw image
)
View Source 
const (
	SOCKET_MAX_MESSAGE_SIZE_KB = 8 * 1024 // 8KB
)
View Source 
const (
	USER_AUTH_SERVICE_GITLAB = "gitlab"
)

Variables

View Source 
var (
	IMAGE_EXTENSIONS = [5]string{".jpg", ".jpeg", ".gif", ".bmp", ".png"}
	IMAGE_MIME_TYPES = map[string]string{".jpg": "image/jpeg", ".jpeg": "image/jpeg", ".gif": "image/gif", ".bmp": "image/bmp", ".png": "image/png", ".tiff": "image/tiff"}
)
View Source 
var BuildDate string
View Source 
var BuildEnterpriseReady string
View Source 
var BuildHash string
View Source 
var BuildHashEnterprise string
View Source 
var BuildNumber string
View Source 
var BuiltInRoles map[string]*Role
View Source 
var CurrentVersion string = versions[0]
View Source 
var PartialUrlRegex = regexp.MustCompile(`/([A-Za-z0-9]{26})/([A-Za-z0-9]{26})/((?:[A-Za-z0-9]{26})?.+(?:\.[A-Za-z0-9]{3,})?)`)
View Source 
var SplitRunes = map[rune]bool{',': true, ' ': true, '.': true, '!': true, '?': true, ':': true, ';': true, '\n': true, '<': true, '>': true, '(': true, ')': true, '{': true, '}': true, '[': true, ']': true, '+': true, '/': true, '\\': true, '^': true, '#': true, '$': true, '&': true}
View Source 
var UrlRegex = regexp.MustCompile(`^((?:[a-z]+:\/\/)?(?:(?:[a-z0-9\-]+\.)+(?:[a-z]{2}|aero|arpa|biz|com|coop|edu|gov|info|int|jobs|mil|museum|name|nato|net|org|pro|travel|local|internal))(:[0-9]{1,5})?(?:\/[a-z0-9_\-\.~]+)*(\/([a-z0-9_\-\.]*)(?:\?[a-z0-9+_~\-\.%=&amp;]*)?)?(?:#[a-zA-Z0-9!$&'()*+.=-_~:@/?]*)?)(?:\s+|$)$`)

Functions

func ArrayFromInterface added in v3.5.0 

func ArrayFromInterface(data interface{}) []string

func ArrayFromJson 

func ArrayFromJson(data io.Reader) []string

func ArrayToJson 

func ArrayToJson(objmap []string) string

func CheckStatusOK added in v3.7.0 

func CheckStatusOK(r *http.Response) bool

CheckStatusOK is a convenience function for checking the standard OK response from the web service.

func CleanTeamName 

func CleanTeamName(s string) string

func CleanUsername 

func CleanUsername(s string) string

func ClearMentionTags 

func ClearMentionTags(post string) string

func ClusterInfosToJson added in v3.3.0 

func ClusterInfosToJson(objmap []*ClusterInfo) string

func CommandListToJson 

func CommandListToJson(l []*Command) string

func ComparePassword 

func ComparePassword(hash string, password string) bool

ComparePassword compares the hash

func CompliancePostHeader 

func CompliancePostHeader() []string

func EmojiListToJson added in v3.2.0 

func EmojiListToJson(emojiList []*Emoji) string

func Etag 

func Etag(parts ...interface{}) string

func FileInfosToJson added in v3.5.0 

func FileInfosToJson(infos []*FileInfo) string

func GetAllTasks added in v3.1.0 

func GetAllTasks() *map[string]*ScheduledTask

func GetDMNameFromIds 

func GetDMNameFromIds(userId1, userId2 string) string

func GetEtagForFileInfos added in v3.5.0 

func GetEtagForFileInfos(infos []*FileInfo) string

func GetGroupDisplayNameFromUsers added in v3.7.0 

func GetGroupDisplayNameFromUsers(users []*User, truncate bool) string

func GetGroupNameFromUserIds added in v3.7.0 

func GetGroupNameFromUserIds(userIds []string) string

func GetImageMimeType 

func GetImageMimeType(ext string) string

func GetInfoForBytes 

func GetInfoForBytes(name string, data []byte) (*FileInfo, *AppError)

func GetMillis 

func GetMillis() int64

GetMillis is a convience method to get milliseconds since epoch.

func GetPreviousVersion 

func GetPreviousVersion(version string) string

func HashPassword 

func HashPassword(password string) string

HashPassword generates a hash using the bcrypt.GenerateFromPassword

func HashSha256 added in v3.7.5 

func HashSha256(text string) string

func IncomingWebhookListToJson 

func IncomingWebhookListToJson(l []*IncomingWebhook) string

func InitalizePermissions added in v3.5.0 

func InitalizePermissions()

func InitalizeRoles added in v3.5.0 

func InitalizeRoles()

func IsChannelMarkUnreadLevelValid 

func IsChannelMarkUnreadLevelValid(markUnreadLevel string) bool

func IsChannelNotifyLevelValid 

func IsChannelNotifyLevelValid(notifyLevel string) bool

func IsCurrentVersion 

func IsCurrentVersion(versionToCheck string) bool

func IsFileExtImage 

func IsFileExtImage(ext string) bool

func IsInRole 

func IsInRole(userRoles string, inRole string) bool

Make sure you acually want to use this function. In context.go there are functions to check permissions This function should not be used to check permissions.

func IsLower 

func IsLower(s string) bool

func IsOfficalBuild 

func IsOfficalBuild() bool

func IsPreviousVersionsSupported 

func IsPreviousVersionsSupported(versionToCheck string) bool

func IsReservedTeamName 

func IsReservedTeamName(s string) bool
func IsSafeLink(link *string) bool

func IsSendEmailValid added in v3.7.0 

func IsSendEmailValid(sendEmail string) bool

func IsValidAlphaNum 

func IsValidAlphaNum(s string, allowUnderscores bool) bool

func IsValidChannelIdentifier 

func IsValidChannelIdentifier(s string) bool

func IsValidEmail 

func IsValidEmail(email string) bool

func IsValidHttpUrl 

func IsValidHttpUrl(rawUrl string) bool

func IsValidHttpsUrl 

func IsValidHttpsUrl(rawUrl string) bool

func IsValidTeamName 

func IsValidTeamName(s string) bool

func IsValidTurnOrStunServer added in v3.5.0 

func IsValidTurnOrStunServer(rawUri string) bool

func IsValidUserRoles 

func IsValidUserRoles(userRoles string) bool

func IsValidUsername 

func IsValidUsername(s string) bool

func IsValidWebsocketUrl added in v3.5.0 

func IsValidWebsocketUrl(rawUrl string) bool

func MapFromJson 

func MapFromJson(data io.Reader) map[string]string

MapFromJson will decode the key/value pair map

func MapToJson 

func MapToJson(objmap map[string]string) string

MapToJson converts a map to a json string

func NewId 

func NewId() string

NewId is a globally unique identifier. It is a [A-Z0-9] string 26 characters long. It is a UUID version 4 Guid that is zbased32 encoded with the padding stripped off.

func NewRandomString 

func NewRandomString(length int) string

func NewWebSocketClient added in v3.3.0 

func NewWebSocketClient(url, authToken string) (*WebSocketClient, *AppError)

NewWebSocketClient constructs a new WebSocket client with convienence methods for talking to the server.

func OAuthAppListToJson added in v3.3.0 

func OAuthAppListToJson(l []*OAuthApp) string

func OAuthAppMapFromJson 

func OAuthAppMapFromJson(data io.Reader) map[string]*OAuthApp

func OAuthAppMapToJson 

func OAuthAppMapToJson(a map[string]*OAuthApp) string

func OutgoingWebhookListToJson 

func OutgoingWebhookListToJson(l []*OutgoingWebhook) string

func ParseHashtags 

func ParseHashtags(text string) (string, string)

func ReactionsToJson added in v3.6.0 

func ReactionsToJson(o []*Reaction) string

func RoleIdsToString added in v3.5.0 

func RoleIdsToString(roles []string) string

func SessionsToJson 

func SessionsToJson(o []*Session) string

func SplitVersion 

func SplitVersion(version string) (int64, int64, int64)

func StatusMapToInterfaceMap added in v3.6.0 

func StatusMapToInterfaceMap(statusMap map[string]*Status) map[string]interface{}

func StringFromJson 

func StringFromJson(data io.Reader) string

func StringInterfaceFromJson 

func StringInterfaceFromJson(data io.Reader) map[string]interface{}

func StringInterfaceToJson 

func StringInterfaceToJson(objmap map[string]interface{}) string

func StringToJson 

func StringToJson(s string) string

func TeamListToJson added in v3.7.0 

func TeamListToJson(t []*Team) string

func TeamMapFromJson 

func TeamMapFromJson(data io.Reader) map[string]*Team

func TeamMapToJson 

func TeamMapToJson(u map[string]*Team) string

func TeamMembersToJson 

func TeamMembersToJson(o []*TeamMember) string

func TeamsUnreadToJson added in v3.6.0 

func TeamsUnreadToJson(o []*TeamUnread) string

func UserListToJson added in v3.5.0 

func UserListToJson(u []*User) string

func UserMapFromJson 

func UserMapFromJson(data io.Reader) map[string]*User

func UserMapToJson 

func UserMapToJson(u map[string]*User) string

Types

type AccessData 

type AccessData struct {
	ClientId     string `json:"client_id"`
	UserId       string `json:"user_id"`
	Token        string `json:"token"`
	RefreshToken string `json:"refresh_token"`
	RedirectUri  string `json:"redirect_uri"`
	ExpiresAt    int64  `json:"expires_at"`
}

func AccessDataFromJson 

func AccessDataFromJson(data io.Reader) *AccessData

func (*AccessData) IsExpired added in v3.3.0 

func (me *AccessData) IsExpired() bool

func (*AccessData) IsValid 

func (ad *AccessData) IsValid() *AppError

IsValid validates the AccessData and returns an error if it isn't configured correctly.

func (*AccessData) ToJson 

func (ad *AccessData) ToJson() string

type AccessResponse 

type AccessResponse struct {
	AccessToken  string `json:"access_token"`
	TokenType    string `json:"token_type"`
	ExpiresIn    int32  `json:"expires_in"`
	Scope        string `json:"scope"`
	RefreshToken string `json:"refresh_token"`
}

func AccessResponseFromJson 

func AccessResponseFromJson(data io.Reader) *AccessResponse

func (*AccessResponse) ToJson 

func (ar *AccessResponse) ToJson() string

type AnalyticsRow 

type AnalyticsRow struct {
	Name  string  `json:"name"`
	Value float64 `json:"value"`
}

func AnalyticsRowFromJson 

func AnalyticsRowFromJson(data io.Reader) *AnalyticsRow

func (*AnalyticsRow) ToJson 

func (me *AnalyticsRow) ToJson() string

type AnalyticsRows 

type AnalyticsRows []*AnalyticsRow

func AnalyticsRowsFromJson 

func AnalyticsRowsFromJson(data io.Reader) AnalyticsRows

func (AnalyticsRows) ToJson 

func (me AnalyticsRows) ToJson() string

type AnalyticsSettings added in v3.6.0 

type AnalyticsSettings struct {
	MaxUsersForStatistics *int
}

type AppError 

type AppError struct {
	Id            string `json:"id"`
	Message       string `json:"message"`               // Message to be display to the end user without debugging information
	DetailedError string `json:"detailed_error"`        // Internal error string to help the developer
	RequestId     string `json:"request_id,omitempty"`  // The RequestId that's also set in the header
	StatusCode    int    `json:"status_code,omitempty"` // The http status code
	Where         string `json:"-"`                     // The function where it happened in the form of Struct.Func
	IsOAuth       bool   `json:"is_oauth,omitempty"`    // Whether the error is OAuth specific
	// contains filtered or unexported fields
}

func AppErrorFromJson 

func AppErrorFromJson(data io.Reader) *AppError

AppErrorFromJson will decode the input and return an AppError

func NewAppError added in v3.7.0 

func NewAppError(where string, id string, params map[string]interface{}, details string, status int) *AppError

func NewLocAppError 

func NewLocAppError(where string, id string, params map[string]interface{}, details string) *AppError

func (*AppError) Error 

func (er *AppError) Error() string

func (*AppError) SystemMessage 

func (er *AppError) SystemMessage(T goi18n.TranslateFunc) string

func (*AppError) ToJson 

func (er *AppError) ToJson() string

func (*AppError) Translate 

func (er *AppError) Translate(T goi18n.TranslateFunc)

type Audit 

type Audit struct {
	Id        string `json:"id"`
	CreateAt  int64  `json:"create_at"`
	UserId    string `json:"user_id"`
	Action    string `json:"action"`
	ExtraInfo string `json:"extra_info"`
	IpAddress string `json:"ip_address"`
	SessionId string `json:"session_id"`
}

func AuditFromJson 

func AuditFromJson(data io.Reader) *Audit

func (*Audit) ToJson 

func (o *Audit) ToJson() string

type Audits 

type Audits []Audit

func AuditsFromJson 

func AuditsFromJson(data io.Reader) Audits

func (Audits) Etag 

func (o Audits) Etag() string

func (Audits) ToJson 

func (o Audits) ToJson() string

type AuthData 

type AuthData struct {
	ClientId    string `json:"client_id"`
	UserId      string `json:"user_id"`
	Code        string `json:"code"`
	ExpiresIn   int32  `json:"expires_in"`
	CreateAt    int64  `json:"create_at"`
	RedirectUri string `json:"redirect_uri"`
	State       string `json:"state"`
	Scope       string `json:"scope"`
}

func AuthDataFromJson 

func AuthDataFromJson(data io.Reader) *AuthData

func (*AuthData) IsExpired 

func (ad *AuthData) IsExpired() bool

func (*AuthData) IsValid 

func (ad *AuthData) IsValid() *AppError

IsValid validates the AuthData and returns an error if it isn't configured correctly.

func (*AuthData) PreSave 

func (ad *AuthData) PreSave()

func (*AuthData) ToJson 

func (ad *AuthData) ToJson() string

type Channel 

type Channel struct {
	Id            string `json:"id"`
	CreateAt      int64  `json:"create_at"`
	UpdateAt      int64  `json:"update_at"`
	DeleteAt      int64  `json:"delete_at"`
	TeamId        string `json:"team_id"`
	Type          string `json:"type"`
	DisplayName   string `json:"display_name"`
	Name          string `json:"name"`
	Header        string `json:"header"`
	Purpose       string `json:"purpose"`
	LastPostAt    int64  `json:"last_post_at"`
	TotalMsgCount int64  `json:"total_msg_count"`
	ExtraUpdateAt int64  `json:"extra_update_at"`
	CreatorId     string `json:"creator_id"`
}

func ChannelFromJson 

func ChannelFromJson(data io.Reader) *Channel

func (*Channel) Etag 

func (o *Channel) Etag() string

func (*Channel) ExtraUpdated 

func (o *Channel) ExtraUpdated()

func (*Channel) IsGroupOrDirect added in v3.7.0 

func (o *Channel) IsGroupOrDirect() bool

func (*Channel) IsValid 

func (o *Channel) IsValid() *AppError

func (*Channel) PreSave 

func (o *Channel) PreSave()

func (*Channel) PreUpdate 

func (o *Channel) PreUpdate()

func (*Channel) StatsEtag added in v3.5.0 

func (o *Channel) StatsEtag() string

func (*Channel) ToJson 

func (o *Channel) ToJson() string

type ChannelCounts 

type ChannelCounts struct {
	Counts      map[string]int64 `json:"counts"`
	UpdateTimes map[string]int64 `json:"update_times"`
}

func ChannelCountsFromJson 

func ChannelCountsFromJson(data io.Reader) *ChannelCounts

func (*ChannelCounts) Etag 

func (o *ChannelCounts) Etag() string

func (*ChannelCounts) ToJson 

func (o *ChannelCounts) ToJson() string

type ChannelData 

type ChannelData struct {
	Channel *Channel       `json:"channel"`
	Member  *ChannelMember `json:"member"`
}

func ChannelDataFromJson 

func ChannelDataFromJson(data io.Reader) *ChannelData

func (*ChannelData) Etag 

func (o *ChannelData) Etag() string

func (*ChannelData) ToJson 

func (o *ChannelData) ToJson() string

type ChannelList 

type ChannelList []*Channel

func ChannelListFromJson 

func ChannelListFromJson(data io.Reader) *ChannelList

func (*ChannelList) Etag 

func (o *ChannelList) Etag() string

func (*ChannelList) ToJson 

func (o *ChannelList) ToJson() string

type ChannelMember 

type ChannelMember struct {
	ChannelId    string    `json:"channel_id"`
	UserId       string    `json:"user_id"`
	Roles        string    `json:"roles"`
	LastViewedAt int64     `json:"last_viewed_at"`
	MsgCount     int64     `json:"msg_count"`
	MentionCount int64     `json:"mention_count"`
	NotifyProps  StringMap `json:"notify_props"`
	LastUpdateAt int64     `json:"last_update_at"`
}

func ChannelMemberFromJson 

func ChannelMemberFromJson(data io.Reader) *ChannelMember

func (*ChannelMember) GetRoles added in v3.5.0 

func (o *ChannelMember) GetRoles() []string

func (*ChannelMember) IsValid 

func (o *ChannelMember) IsValid() *AppError

func (*ChannelMember) PreSave 

func (o *ChannelMember) PreSave()

func (*ChannelMember) PreUpdate 

func (o *ChannelMember) PreUpdate()

func (*ChannelMember) ToJson 

func (o *ChannelMember) ToJson() string

type ChannelMembers added in v3.5.0 

type ChannelMembers []ChannelMember

func ChannelMembersFromJson added in v3.5.0 

func ChannelMembersFromJson(data io.Reader) *ChannelMembers

func (*ChannelMembers) ToJson added in v3.5.0 

func (o *ChannelMembers) ToJson() string

type ChannelSearch added in v3.6.0 

type ChannelSearch struct {
	Term string `json:"term"`
}

func ChannelSearchFromJson added in v3.6.0 

func ChannelSearchFromJson(data io.Reader) *ChannelSearch

ChannelSearchFromJson will decode the input and return a Channel

func (*ChannelSearch) ToJson added in v3.6.0 

func (c *ChannelSearch) ToJson() string

ToJson convert a Channel to a json string

type ChannelStats added in v3.5.0 

type ChannelStats struct {
	ChannelId   string `json:"channel_id"`
	MemberCount int64  `json:"member_count"`
}

func ChannelStatsFromJson added in v3.5.0 

func ChannelStatsFromJson(data io.Reader) *ChannelStats

func (*ChannelStats) ToJson added in v3.5.0 

func (o *ChannelStats) ToJson() string

type ChannelUnread added in v3.6.0 

type ChannelUnread struct {
	TeamId        string
	TotalMsgCount int64
	MsgCount      int64
	MentionCount  int64
	NotifyProps   StringMap
}

type ChannelView added in v3.6.0 

type ChannelView struct {
	ChannelId     string `json:"channel_id"`
	PrevChannelId string `json:"prev_channel_id"`
}

func ChannelViewFromJson added in v3.6.0 

func ChannelViewFromJson(data io.Reader) *ChannelView

func (*ChannelView) ToJson added in v3.6.0 

func (o *ChannelView) ToJson() string

type Client 

type Client struct {
	Url           string       // The location of the server like "http://localhost:8065"
	ApiUrl        string       // The api location of the server like "http://localhost:8065/api/v3"
	HttpClient    *http.Client // The http client
	AuthToken     string
	AuthType      string
	TeamId        string
	RequestId     string
	Etag          string
	ServerVersion string
}

func NewClient 

func NewClient(url string) *Client

NewClient constructs a new client with convienence methods for talking to the server.

func (*Client) AddChannelMember 

func (c *Client) AddChannelMember(id, user_id string) (*Result, *AppError)

func (*Client) AddUserToTeam 

func (c *Client) AddUserToTeam(teamId string, userId string) (*Result, *AppError)

Adds a user directly to the team without sending an invite. The teamId and userId are required. You must be a valid member of the team and/or have the correct role to add new users to the team. Returns a map of user_id=userId if successful, otherwise returns an AppError.

func (*Client) AddUserToTeamFromInvite 

func (c *Client) AddUserToTeamFromInvite(hash, dataToHash, inviteId string) (*Result, *AppError)

AddUserToTeamFromInvite adds a user to a team based off data provided in an invite link. Either hash and dataToHash are required or inviteId is required.

func (*Client) AdminResetMfa 

func (c *Client) AdminResetMfa(userId string) (*Result, *AppError)

func (*Client) AdminResetPassword 

func (c *Client) AdminResetPassword(userId, newPassword string) (*Result, *AppError)

func (*Client) AllowOAuth 

func (c *Client) AllowOAuth(rspType, clientId, redirect, scope, state string) (*Result, *AppError)

AllowOAuth allows a new session by an OAuth2 App. On success it returns the url to be redirected back to the app which initiated the oauth2 flow. Must be authenticated as a user.

func (*Client) AttachDeviceId 

func (c *Client) AttachDeviceId(deviceId string) (*Result, *AppError)

func (*Client) AutocompleteChannels added in v3.6.0 

func (c *Client) AutocompleteChannels(term string) (*Result, *AppError)

AutocompleteChannels will return a list of open channels that match the provided string. Must be authenticated.

func (*Client) AutocompleteUsers added in v3.6.0 

func (c *Client) AutocompleteUsers(term string) (*Result, *AppError)

AutocompleteUsers returns a list for autocompletion of users on the system that match the provided term, matching against username, full name and nickname. Must be authenticated.

func (*Client) AutocompleteUsersInChannel added in v3.5.0 

func (c *Client) AutocompleteUsersInChannel(term string, channelId string) (*Result, *AppError)

AutocompleteUsersInChannel returns two lists for autocompletion of users in a channel. The first list "in_channel", specifies users in the channel. The second list "out_of_channel" specifies users outside of the channel. Term, the string to search against, is required, channel id is also required. Must be authenticated.

func (*Client) AutocompleteUsersInTeam added in v3.5.0 

func (c *Client) AutocompleteUsersInTeam(term string) (*Result, *AppError)

AutocompleteUsersInTeam returns a list for autocompletion of users in a team. The list "in_team" specifies the users in the team that match the provided term, matching against username, full name and nickname. Must be authenticated.

func (*Client) CheckMfa 

func (c *Client) CheckMfa(loginId string) (*Result, *AppError)

CheckMfa returns a map with key "mfa_required" with the string value "true" or "false", indicating whether MFA is required to log the user in, based on a provided login id (username, email or some sort of SSO identifier based on configuration).

func (*Client) CheckStatusOK added in v3.1.0 

func (c *Client) CheckStatusOK(r *http.Response) bool

CheckStatusOK is a convenience function for checking the return of Web Service call that return the a map of status=OK.

func (*Client) ClearOAuthToken 

func (c *Client) ClearOAuthToken()

func (*Client) ClearTeamId 

func (c *Client) ClearTeamId()

func (*Client) Command 

func (c *Client) Command(channelId string, command string) (*Result, *AppError)

func (*Client) CreateChannel 

func (c *Client) CreateChannel(channel *Channel) (*Result, *AppError)

func (*Client) CreateCommand 

func (c *Client) CreateCommand(cmd *Command) (*Result, *AppError)

func (*Client) CreateDirectChannel 

func (c *Client) CreateDirectChannel(userId string) (*Result, *AppError)

func (*Client) CreateEmoji added in v3.2.0 

func (c *Client) CreateEmoji(emoji *Emoji, image []byte, filename string) (*Emoji, *AppError)

CreateEmoji will save an emoji to the server if the current user has permission to do so. If successful, the provided emoji will be returned with its Id field filled in. Otherwise, an error will be returned.

func (*Client) CreateGroupChannel added in v3.7.0 

func (c *Client) CreateGroupChannel(userIds []string) (*Result, *AppError)

func (*Client) CreateIncomingWebhook 

func (c *Client) CreateIncomingWebhook(hook *IncomingWebhook) (*Result, *AppError)

func (*Client) CreateOutgoingWebhook 

func (c *Client) CreateOutgoingWebhook(hook *OutgoingWebhook) (*Result, *AppError)

func (*Client) CreatePost 

func (c *Client) CreatePost(post *Post) (*Result, *AppError)

func (*Client) CreateTeam 

func (c *Client) CreateTeam(team *Team) (*Result, *AppError)

CreateTeam creates a team based on the provided Team struct. On success it returns the Team struct with the Id, CreateAt and other server-decided fields populated.

func (*Client) CreateUser 

func (c *Client) CreateUser(user *User, hash string) (*Result, *AppError)

CreateUser creates a user in the system based on the provided user struct.

func (*Client) CreateUserFromSignup 

func (c *Client) CreateUserFromSignup(user *User, data string, hash string) (*Result, *AppError)

func (*Client) CreateUserWithInvite 

func (c *Client) CreateUserWithInvite(user *User, hash string, data string, inviteId string) (*Result, *AppError)

CreateUserWithInvite creates a user based on the provided user struct. Either the hash and data strings or the inviteId is required from the invite.

func (*Client) DeleteChannel 

func (c *Client) DeleteChannel(id string) (*Result, *AppError)

func (*Client) DeleteCommand 

func (c *Client) DeleteCommand(data map[string]string) (*Result, *AppError)

func (*Client) DeleteEmoji added in v3.2.0 

func (c *Client) DeleteEmoji(id string) (bool, *AppError)

DeleteEmoji will delete an emoji from the server if the current user has permission to do so. If successful, it will return status=ok. Otherwise, an error will be returned.

func (*Client) DeleteIncomingWebhook 

func (c *Client) DeleteIncomingWebhook(id string) (*Result, *AppError)

func (*Client) DeleteOAuthApp added in v3.3.0 

func (c *Client) DeleteOAuthApp(id string) (*Result, *AppError)

DeleteOAuthApp deletes an OAuth2 app, the app must be deleted by the same user who created it or a System Administrator. On success returs Status OK. Must be authenticated as a user.

func (*Client) DeleteOutgoingWebhook 

func (c *Client) DeleteOutgoingWebhook(id string) (*Result, *AppError)

func (*Client) DeletePost 

func (c *Client) DeletePost(channelId string, postId string) (*Result, *AppError)

func (*Client) DeletePreferences added in v3.3.0 

func (c *Client) DeletePreferences(preferences *Preferences) (bool, *AppError)

DeletePreferences deletes a list of preferences owned by the current user. If successful, it will return status=ok. Otherwise, an error will be returned.

func (*Client) DeleteReaction added in v3.6.0 

func (c *Client) DeleteReaction(channelId string, reaction *Reaction) *AppError

Removes an emoji reaction for a post in the given channel. Returns nil if successful, otherwise returns an AppError.

func (*Client) DoApiGet 

func (c *Client) DoApiGet(url string, data string, etag string) (*http.Response, *AppError)

func (*Client) DoApiPost 

func (c *Client) DoApiPost(url string, data string) (*http.Response, *AppError)

func (*Client) DoPost 

func (c *Client) DoPost(url, data, contentType string) (*http.Response, *AppError)

func (*Client) DownloadComplianceReport 

func (c *Client) DownloadComplianceReport(id string) (*Result, *AppError)

func (*Client) EmailToLDAP 

func (c *Client) EmailToLDAP(m map[string]string) (*Result, *AppError)

func (*Client) EmailToOAuth 

func (c *Client) EmailToOAuth(m map[string]string) (*Result, *AppError)

func (*Client) FindTeamByName 

func (c *Client) FindTeamByName(name string) (*Result, *AppError)

FindTeamByName returns the strings "true" or "false" depending on if a team with the provided name was found.

func (*Client) GenerateMfaSecret added in v3.5.0 

func (c *Client) GenerateMfaSecret() (*Result, *AppError)

GenerateMfaSecret returns a QR code image containing the secret, to be scanned by a multi-factor authentication mobile application. It also returns the secret for manual entry. Must be authenticated.

func (*Client) GetAccessToken 

func (c *Client) GetAccessToken(data url.Values) (*Result, *AppError)

func (*Client) GetAllAudits 

func (c *Client) GetAllAudits() (*Result, *AppError)

func (*Client) GetAllPreferences 

func (c *Client) GetAllPreferences() (*Result, *AppError)

func (*Client) GetAllTeamListings 

func (c *Client) GetAllTeamListings() (*Result, *AppError)

GetAllTeamListings returns a map of all teams that are available to join using team ids as the key. Must be authenticated.

func (*Client) GetAllTeams 

func (c *Client) GetAllTeams() (*Result, *AppError)

GetAllTeams returns a map of all teams using team ids as the key.

func (*Client) GetAudits 

func (c *Client) GetAudits(id string, etag string) (*Result, *AppError)

func (*Client) GetByEmail added in v3.6.0 

func (c *Client) GetByEmail(email string, etag string) (*User, *ResponseMetadata)

getByEmail returns a user based on a provided username string. Must be authenticated.

func (*Client) GetByUsername added in v3.6.0 

func (c *Client) GetByUsername(username string, etag string) (*Result, *AppError)

getByUsername returns a user based on a provided username string. Must be authenticated.

func (*Client) GetChannel 

func (c *Client) GetChannel(id, etag string) (*Result, *AppError)

func (*Client) GetChannelByName added in v3.6.0 

func (c *Client) GetChannelByName(channelName string) (*Result, *AppError)

func (*Client) GetChannelCounts 

func (c *Client) GetChannelCounts(etag string) (*Result, *AppError)

func (*Client) GetChannelMember added in v3.5.0 

func (c *Client) GetChannelMember(channelId string, userId string) (*Result, *AppError)

func (*Client) GetChannelMembersByIds added in v3.6.0 

func (c *Client) GetChannelMembersByIds(channelId string, userIds []string) (*Result, *AppError)

GetChannelMembersByIds will return channel member objects as an array based on the channel id and a list of user ids provided. Must be authenticated.

func (*Client) GetChannelNameRoute 

func (c *Client) GetChannelNameRoute(channelName string) string

func (*Client) GetChannelRoute 

func (c *Client) GetChannelRoute(channelId string) string

func (*Client) GetChannelStats added in v3.5.0 

func (c *Client) GetChannelStats(id string, etag string) (*Result, *AppError)

func (*Client) GetChannels 

func (c *Client) GetChannels(etag string) (*Result, *AppError)

func (*Client) GetClientLicenceConfig 

func (c *Client) GetClientLicenceConfig(etag string) (*Result, *AppError)

func (*Client) GetClientProperties 

func (c *Client) GetClientProperties() (map[string]string, *AppError)

GetClientProperties returns properties needed by the client to show/hide certian features. It returns a map of strings.

func (*Client) GetClusterStatus added in v3.3.0 

func (c *Client) GetClusterStatus() ([]*ClusterInfo, *AppError)

func (*Client) GetComplianceReports 

func (c *Client) GetComplianceReports() (*Result, *AppError)

func (*Client) GetConfig 

func (c *Client) GetConfig() (*Result, *AppError)

func (*Client) GetCustomEmojiImageUrl added in v3.2.0 

func (c *Client) GetCustomEmojiImageUrl(id string) string

GetCustomEmojiImageUrl returns the API route that can be used to get the image used by the given emoji.

func (*Client) GetEmojiRoute added in v3.2.0 

func (c *Client) GetEmojiRoute() string

func (*Client) GetFile 

func (c *Client) GetFile(fileId string) (io.ReadCloser, *AppError)

func (*Client) GetFileInfo 

func (c *Client) GetFileInfo(fileId string) (*FileInfo, *AppError)

func (*Client) GetFileInfosForPost added in v3.5.0 

func (c *Client) GetFileInfosForPost(channelId string, postId string, etag string) ([]*FileInfo, *AppError)

GetFileInfosForPost returns a list of FileInfo objects for a given post id, if successful. Otherwise, it returns an error.

func (*Client) GetFilePreview added in v3.5.0 

func (c *Client) GetFilePreview(fileId string) (io.ReadCloser, *AppError)

func (*Client) GetFileRoute added in v3.5.0 

func (c *Client) GetFileRoute(fileId string) string

func (*Client) GetFileThumbnail added in v3.5.0 

func (c *Client) GetFileThumbnail(fileId string) (io.ReadCloser, *AppError)

func (*Client) GetFlaggedPosts added in v3.3.0 

func (c *Client) GetFlaggedPosts(offset int, limit int) (*Result, *AppError)

GetFlaggedPosts will return a post list of posts that have been flagged by the user. The page is set by the integer parameters offset and limit.

func (*Client) GetGeneralRoute added in v3.1.0 

func (c *Client) GetGeneralRoute() string

func (*Client) GetInitialLoad 

func (c *Client) GetInitialLoad() (*Result, *AppError)

func (*Client) GetLogs 

func (c *Client) GetLogs() (*Result, *AppError)

func (*Client) GetMe 

func (c *Client) GetMe(etag string) (*Result, *AppError)

GetMe returns the current user.

func (*Client) GetMoreChannels 

func (c *Client) GetMoreChannels(etag string) (*Result, *AppError)

SCHEDULED FOR DEPRECATION IN 3.7 - use GetMoreChannelsPage instead

func (*Client) GetMoreChannelsPage added in v3.6.0 

func (c *Client) GetMoreChannelsPage(offset int, limit int) (*Result, *AppError)

GetMoreChannelsPage will return a page of open channels the user is not in based on the provided offset and limit. Must be authenticated.

func (*Client) GetMyChannelMembers added in v3.5.0 

func (c *Client) GetMyChannelMembers() (*Result, *AppError)

func (*Client) GetMyTeam 

func (c *Client) GetMyTeam(etag string) (*Result, *AppError)

func (*Client) GetMyTeamMembers added in v3.6.0 

func (c *Client) GetMyTeamMembers() (*Result, *AppError)

GetMyTeamMembers will return an array with team member objects that the current user is a member of. Must be authenticated.

func (*Client) GetMyTeamsUnread added in v3.6.0 

func (c *Client) GetMyTeamsUnread(teamId string) (*Result, *AppError)

GetMyTeamsUnread will return an array with TeamUnread objects that contain the amount of unread messages and mentions the current user has for the teams it belongs to. An optional team ID can be set to exclude that team from the results. Must be authenticated.

func (*Client) GetOAuthAppInfo added in v3.3.0 

func (c *Client) GetOAuthAppInfo(clientId string) (*Result, *AppError)

GetOAuthAppInfo lookup an OAuth2 App using the client_id. On success it returns a Sanitized OAuth2 App. Must be authenticated as a user.

func (*Client) GetOAuthAppsByUser added in v3.3.0 

func (c *Client) GetOAuthAppsByUser() (*Result, *AppError)

GetOAuthAppsByUser returns the OAuth2 Apps registered by the user. On success it returns a list of OAuth2 Apps from the same user or all the registered apps if the user is a System Administrator. Must be authenticated as a user.

func (*Client) GetOAuthAuthorizedApps added in v3.4.0 

func (c *Client) GetOAuthAuthorizedApps() (*Result, *AppError)

GetOAuthAuthorizedApps returns the OAuth2 Apps authorized by the user. On success it returns a list of sanitized OAuth2 Authorized Apps by the user. 

func (c *Client) GetPermalink(channelId string, postId string, etag string) (*PostList, *ResponseMetadata)

GetPermalink returns a post list, based on the provided channel and post ID.

func (*Client) GetPing added in v3.1.0 

func (c *Client) GetPing() (map[string]string, *AppError)

GetPing returns a map of strings with server time, server version, and node Id. Systems that want to check on health status of the server should check the url /api/v3/ping for a 200 status response.

func (*Client) GetPost 

func (c *Client) GetPost(channelId string, postId string, etag string) (*Result, *AppError)

func (*Client) GetPostById added in v3.6.0 

func (c *Client) GetPostById(postId string, etag string) (*PostList, *ResponseMetadata)

GetPostById returns a post and any posts in the same thread by post id

func (*Client) GetPosts 

func (c *Client) GetPosts(channelId string, offset int, limit int, etag string) (*Result, *AppError)

func (*Client) GetPostsAfter 

func (c *Client) GetPostsAfter(channelId string, postid string, offset int, limit int, etag string) (*Result, *AppError)

func (*Client) GetPostsBefore 

func (c *Client) GetPostsBefore(channelId string, postid string, offset int, limit int, etag string) (*Result, *AppError)

func (*Client) GetPostsSince 

func (c *Client) GetPostsSince(channelId string, time int64) (*Result, *AppError)

func (*Client) GetPreference 

func (c *Client) GetPreference(category string, name string) (*Result, *AppError)

func (*Client) GetPreferenceCategory 

func (c *Client) GetPreferenceCategory(category string) (*Result, *AppError)

func (*Client) GetProfiles 

func (c *Client) GetProfiles(offset int, limit int, etag string) (*Result, *AppError)

GetProfiles returns a map of users using user id as the key. Must be authenticated.

func (*Client) GetProfilesByIds added in v3.5.0 

func (c *Client) GetProfilesByIds(userIds []string) (*Result, *AppError)

GetProfilesByIds returns a map of users based on the user ids provided. Must be authenticated.

func (*Client) GetProfilesInChannel added in v3.5.0 

func (c *Client) GetProfilesInChannel(channelId string, offset int, limit int, etag string) (*Result, *AppError)

GetProfilesInChannel returns a map of users for a channel using user id as the key. Must be authenticated.

func (*Client) GetProfilesInTeam added in v3.5.0 

func (c *Client) GetProfilesInTeam(teamId string, offset int, limit int, etag string) (*Result, *AppError)

GetProfilesInTeam returns a map of users for a team using user id as the key. Must be authenticated.

func (*Client) GetProfilesNotInChannel added in v3.5.0 

func (c *Client) GetProfilesNotInChannel(channelId string, offset int, limit int, etag string) (*Result, *AppError)

GetProfilesNotInChannel returns a map of users not in a channel but on the team using user id as the key. Must be authenticated. 

func (c *Client) GetPublicLink(fileId string) (string, *AppError)

func (*Client) GetRecentlyActiveUsers added in v3.4.0 

func (c *Client) GetRecentlyActiveUsers(teamId string) (*Result, *AppError)

GetRecentlyActiveUsers returns a map of users including lastActivityAt using user id as the key

func (*Client) GetSessions 

func (c *Client) GetSessions(id string) (*Result, *AppError)

func (*Client) GetStatuses 

func (c *Client) GetStatuses() (*Result, *AppError)

GetStatuses returns a map of string statuses using user id as the key

func (*Client) GetStatusesByIds added in v3.5.0 

func (c *Client) GetStatusesByIds(userIds []string) (*Result, *AppError)

GetStatusesByIds returns a map of string statuses using user id as the key, based on the provided user ids

func (*Client) GetSystemAnalytics 

func (c *Client) GetSystemAnalytics(name string) (*Result, *AppError)

func (*Client) GetTeamAnalytics 

func (c *Client) GetTeamAnalytics(teamId, name string) (*Result, *AppError)

func (*Client) GetTeamByName added in v3.6.0 

func (c *Client) GetTeamByName(teamName string) (*Result, *AppError)

GetTeamStats will return a team stats object containing the number of users on the team based on the team id provided. Must be authenticated.

func (*Client) GetTeamId 

func (c *Client) GetTeamId() string

func (*Client) GetTeamMember added in v3.5.0 

func (c *Client) GetTeamMember(teamId string, userId string) (*Result, *AppError)

GetTeamMember will return a team member object based on the team id and user id provided. Must be authenticated.

func (*Client) GetTeamMembers 

func (c *Client) GetTeamMembers(teamId string, offset int, limit int) (*Result, *AppError)

GetTeamMembers will return a page of team member objects as an array paged based on the team id, offset and limit provided. Must be authenticated.

func (*Client) GetTeamMembersByIds added in v3.5.0 

func (c *Client) GetTeamMembersByIds(teamId string, userIds []string) (*Result, *AppError)

GetTeamMembersByIds will return team member objects as an array based on the team id and a list of user ids provided. Must be authenticated.

func (*Client) GetTeamRoute 

func (c *Client) GetTeamRoute() string

func (*Client) GetTeamStats added in v3.5.0 

func (c *Client) GetTeamStats(teamId string) (*Result, *AppError)

GetTeamStats will return a team stats object containing the number of users on the team based on the team id provided. Must be authenticated.

func (*Client) GetUser 

func (c *Client) GetUser(id string, etag string) (*Result, *AppError)

GetUser returns a user based on a provided user id string. Must be authenticated.

func (*Client) GetUserRequiredRoute added in v3.5.0 

func (c *Client) GetUserRequiredRoute(userId string) string

func (*Client) GetWebrtcToken added in v3.5.0 

func (c *Client) GetWebrtcToken() (map[string]string, *AppError)

GetWebrtcToken if Successful returns a map with a valid token, stun server and turn server with credentials to use with the Mattermost WebRTC service, otherwise returns an AppError. Must be authenticated user.

func (*Client) InvalidateAllCaches added in v3.6.0 

func (c *Client) InvalidateAllCaches() (bool, *AppError)

func (*Client) InviteMembers 

func (c *Client) InviteMembers(invites *Invites) (*Result, *AppError)

func (*Client) JoinChannel 

func (c *Client) JoinChannel(id string) (*Result, *AppError)

func (*Client) JoinChannelByName 

func (c *Client) JoinChannelByName(name string) (*Result, *AppError)

func (*Client) LDAPToEmail 

func (c *Client) LDAPToEmail(m map[string]string) (*Result, *AppError)

func (*Client) LdapSyncNow added in v3.2.0 

func (c *Client) LdapSyncNow() (*Result, *AppError)

Initiate immediate synchronization of LDAP users. The synchronization will be performed asynchronously and this function will always return OK unless you don't have permissions. You must be the system administrator to use this function.

func (*Client) LeaveChannel 

func (c *Client) LeaveChannel(id string) (*Result, *AppError)

func (*Client) ListCommands 

func (c *Client) ListCommands() (*Result, *AppError)

func (*Client) ListEmoji added in v3.2.0 

func (c *Client) ListEmoji() ([]*Emoji, *AppError)

ListEmoji returns a list of all user-created emoji for the server.

func (*Client) ListIncomingWebhooks 

func (c *Client) ListIncomingWebhooks() (*Result, *AppError)

func (*Client) ListOutgoingWebhooks 

func (c *Client) ListOutgoingWebhooks() (*Result, *AppError)

func (*Client) ListReactions added in v3.6.0 

func (c *Client) ListReactions(channelId string, postId string) ([]*Reaction, *AppError)

Lists all emoji reactions made for the given post in the given channel. Returns a list of Reactions if successful, otherwise returns an AppError.

func (*Client) ListTeamCommands 

func (c *Client) ListTeamCommands() (*Result, *AppError)

func (*Client) LogClient added in v3.1.0 

func (c *Client) LogClient(message string) (bool, *AppError)

LogClient is a convenience Web Service call so clients can log messages into the server-side logs. For example we typically log javascript error messages into the server-side. It returns true if the logging was successful.

func (*Client) Login 

func (c *Client) Login(loginId string, password string) (*Result, *AppError)

Login authenticates a user by login id, which can be username, email or some sort of SSO identifier based on configuration, and a password.

func (*Client) LoginById 

func (c *Client) LoginById(id string, password string) (*Result, *AppError)

LoginById authenticates a user by user id and password.

func (*Client) LoginByLdap 

func (c *Client) LoginByLdap(loginId string, password string) (*Result, *AppError)

LoginByLdap authenticates a user by LDAP id and password.

func (*Client) LoginWithDevice 

func (c *Client) LoginWithDevice(loginId string, password string, deviceId string) (*Result, *AppError)

LoginWithDevice authenticates a user by login id (username, email or some sort of SSO identifier based on configuration), password and attaches a device id to the session.

func (*Client) Logout 

func (c *Client) Logout() (*Result, *AppError)

Logout terminates the current user's session.

func (*Client) MockSession 

func (c *Client) MockSession(sessionToken string)

func (*Client) Must 

func (c *Client) Must(result *Result, err *AppError) *Result

Must is a convenience function used for testing.

func (*Client) MustGeneric added in v3.2.0 

func (c *Client) MustGeneric(result interface{}, err *AppError) interface{}

MustGeneric is a convenience function used for testing.

func (*Client) OAuthDeauthorizeApp added in v3.4.0 

func (c *Client) OAuthDeauthorizeApp(clientId string) *AppError

OAuthDeauthorizeApp deauthorize a user an OAuth 2.0 app. On success it returns status OK or an AppError on fail.

func (*Client) OAuthToEmail 

func (c *Client) OAuthToEmail(m map[string]string) (*Result, *AppError)

func (*Client) PostToWebhook 

func (c *Client) PostToWebhook(id, payload string) (*Result, *AppError)

func (*Client) RecycleDatabaseConnection added in v3.1.0 

func (c *Client) RecycleDatabaseConnection() (bool, *AppError)

RecycleDatabaseConnection will attempt to recycle the database connections. You must have the system admin role to call this method. It will return status=OK if it's successfully recycled the connections, otherwise check the returned error.

func (*Client) RegenCommandToken 

func (c *Client) RegenCommandToken(data map[string]string) (*Result, *AppError)

func (*Client) RegenOutgoingWebhookToken 

func (c *Client) RegenOutgoingWebhookToken(id string) (*Result, *AppError)

func (*Client) RegenerateOAuthAppSecret added in v3.4.0 

func (c *Client) RegenerateOAuthAppSecret(clientId string) (*Result, *AppError)

RegenerateOAuthAppSecret generates a new OAuth App Client Secret. On success it returns an OAuth2 App. Must be authenticated as a user and the same user who registered the app or a System Admin.

func (*Client) RegisterApp 

func (c *Client) RegisterApp(app *OAuthApp) (*Result, *AppError)

RegisterApp creates a new OAuth2 app to be used with the OAuth2 Provider. On success it returns the created app. Must be authenticated as a user.

func (*Client) ReloadConfig added in v3.1.0 

func (c *Client) ReloadConfig() (bool, *AppError)

ReloadConfig will reload the config.json file from disk. Properties requiring a server restart will still need a server restart. You must have the system admin role to call this method. It will return status=OK if it's successfully reloaded the config file, otherwise check the returned error.

func (*Client) RemoveCertificateFile added in v3.3.0 

func (c *Client) RemoveCertificateFile(filename string) *AppError

Removes a x509 base64 Certificate or Private Key file used with SAML. filename is required. Returns nil if successful, otherwise returns an AppError

func (*Client) RemoveChannelMember 

func (c *Client) RemoveChannelMember(id, user_id string) (*Result, *AppError)

func (*Client) RemoveUserFromTeam added in v3.2.0 

func (c *Client) RemoveUserFromTeam(teamId string, userId string) (*Result, *AppError)

Removes a user directly from the team. The teamId and userId are required. You must be a valid member of the team and/or have the correct role to remove a user from the team. Returns a map of user_id=userId if successful, otherwise returns an AppError.

func (*Client) ResetPassword 

func (c *Client) ResetPassword(code, newPassword string) (*Result, *AppError)

func (*Client) RevokeSession 

func (c *Client) RevokeSession(sessionAltId string) (*Result, *AppError)

func (*Client) SamlCertificateStatus added in v3.3.0 

func (c *Client) SamlCertificateStatus(filename string) (map[string]interface{}, *AppError)

Checks if the x509 base64 Certificates and Private Key files used with SAML exists on the file system. Returns a map[string]interface{} if successful, otherwise returns an AppError. Must be System Admin authenticated.

func (*Client) SaveComplianceReport 

func (c *Client) SaveComplianceReport(job *Compliance) (*Result, *AppError)

func (*Client) SaveConfig 

func (c *Client) SaveConfig(config *Config) (*Result, *AppError)

func (*Client) SaveReaction added in v3.6.0 

func (c *Client) SaveReaction(channelId string, reaction *Reaction) (*Reaction, *AppError)

Saves an emoji reaction for a post in the given channel. Returns the saved reaction if successful, otherwise returns an AppError.

func (*Client) SearchMoreChannels added in v3.6.0 

func (c *Client) SearchMoreChannels(channelSearch ChannelSearch) (*Result, *AppError)

SearchMoreChannels will return a list of open channels the user is not in, that matches the search criteria provided. Must be authenticated.

func (*Client) SearchPosts 

func (c *Client) SearchPosts(terms string, isOrSearch bool) (*Result, *AppError)

func (*Client) SearchUsers added in v3.5.0 

func (c *Client) SearchUsers(params UserSearch) (*Result, *AppError)

SearchUsers returns a list of users that have a username matching or similar to the search term. Must be authenticated.

func (*Client) SendPasswordReset 

func (c *Client) SendPasswordReset(email string) (*Result, *AppError)

func (*Client) SetActiveChannel added in v3.4.0 

func (c *Client) SetActiveChannel(channelId string) (*Result, *AppError)

SetActiveChannel sets the the channel id the user is currently viewing. The channelId key is required but the value can be blank. Returns standard response. SCHEDULED FOR DEPRECATION IN 3.8 - use ViewChannel instead

func (*Client) SetOAuthToken 

func (c *Client) SetOAuthToken(token string)

func (*Client) SetPreferences 

func (c *Client) SetPreferences(preferences *Preferences) (*Result, *AppError)

func (*Client) SetTeamId 

func (c *Client) SetTeamId(teamId string)

func (*Client) TestEmail 

func (c *Client) TestEmail(config *Config) (*Result, *AppError)

func (*Client) TestLdap added in v3.4.0 

func (c *Client) TestLdap(config *Config) (*Result, *AppError)

TestLdap will run a connection test on the current LDAP settings. It will return the standard OK response if settings work. Otherwise it will return an appropriate error.

func (*Client) UpdateActive 

func (c *Client) UpdateActive(userId string, active bool) (*Result, *AppError)

func (*Client) UpdateChannel 

func (c *Client) UpdateChannel(channel *Channel) (*Result, *AppError)

func (*Client) UpdateChannelHeader 

func (c *Client) UpdateChannelHeader(data map[string]string) (*Result, *AppError)

func (*Client) UpdateChannelPurpose 

func (c *Client) UpdateChannelPurpose(data map[string]string) (*Result, *AppError)

func (*Client) UpdateChannelRoles added in v3.7.0 

func (c *Client) UpdateChannelRoles(channelId string, userId string, roles string) (map[string]string, *ResponseMetadata)

Updates the user's roles in the channel by replacing them with the roles provided.

func (*Client) UpdateCommand added in v3.6.0 

func (c *Client) UpdateCommand(cmd *Command) (*Result, *AppError)

func (*Client) UpdateIncomingWebhook added in v3.7.0 

func (c *Client) UpdateIncomingWebhook(hook *IncomingWebhook) (*Result, *AppError)

func (*Client) UpdateLastViewedAt 

func (c *Client) UpdateLastViewedAt(channelId string, active bool) (*Result, *AppError)

UpdateLastViewedAt will mark a channel as read. The channelId indicates the channel to mark as read. If active is true, push notifications will be cleared if there are unread messages. The default for active is true. SCHEDULED FOR DEPRECATION IN 3.8 - use ViewChannel instead

func (*Client) UpdateMfa 

func (c *Client) UpdateMfa(activate bool, token string) (*Result, *AppError)

UpdateMfa activates multi-factor authenticates for the current user if activate is true and a valid token is provided. If activate is false, then token is not required and multi-factor authentication is disabled for the current user.

func (*Client) UpdateNotifyProps 

func (c *Client) UpdateNotifyProps(data map[string]string) (*Result, *AppError)

func (*Client) UpdateOutgoingWebhook added in v3.7.0 

func (c *Client) UpdateOutgoingWebhook(hook *OutgoingWebhook) (*Result, *AppError)

func (*Client) UpdatePost 

func (c *Client) UpdatePost(post *Post) (*Result, *AppError)

func (*Client) UpdateTeam 

func (c *Client) UpdateTeam(team *Team) (*Result, *AppError)

UpdateTeam updates a team based on the changes in the provided team struct. On success it returns a sanitized version of the updated team. Must be authenticated as a team admin for that team or a system admin.

func (*Client) UpdateTeamRoles added in v3.5.0 

func (c *Client) UpdateTeamRoles(userId string, roles string) (*Result, *AppError)

func (*Client) UpdateUser 

func (c *Client) UpdateUser(user *User) (*Result, *AppError)

func (*Client) UpdateUserNotify 

func (c *Client) UpdateUserNotify(data map[string]string) (*Result, *AppError)

func (*Client) UpdateUserPassword 

func (c *Client) UpdateUserPassword(userId, currentPassword, newPassword string) (*Result, *AppError)

func (*Client) UpdateUserRoles 

func (c *Client) UpdateUserRoles(userId string, roles string) (*Result, *AppError)

func (*Client) UploadCertificateFile added in v3.3.0 

func (c *Client) UploadCertificateFile(data []byte, contentType string) *AppError

Uploads a x509 base64 Certificate or Private Key file to be used with SAML. data byte array is required and needs to be a Multi-Part with 'certificate' as the field name contentType is also required. Returns nil if succesful, otherwise returns an AppError

func (*Client) UploadPostAttachment 

func (c *Client) UploadPostAttachment(data []byte, channelId string, filename string) (*FileUploadResponse, *AppError)

func (*Client) UploadProfileFile 

func (c *Client) UploadProfileFile(data []byte, contentType string) (*Result, *AppError)

func (*Client) ViewChannel added in v3.6.0 

func (c *Client) ViewChannel(params ChannelView) (bool, *ResponseMetadata)

ViewChannel performs all the actions related to viewing a channel. This includes marking the channel and the previous one as read, and marking the channel as being actively viewed. ChannelId is required but may be blank to indicate no channel is being viewed. PrevChannelId is optional, populate to indicate a channel switch occurred.

type Client4 added in v3.7.0 

type Client4 struct {
	Url        string       // The location of the server, for example  "http://localhost:8065"
	ApiUrl     string       // The api location of the server, for example "http://localhost:8065/api/v4"
	HttpClient *http.Client // The http client
	AuthToken  string
	AuthType   string
}

func NewAPIv4Client added in v3.7.0 

func NewAPIv4Client(url string) *Client4

func (*Client4) ClearOAuthToken added in v3.7.0 

func (c *Client4) ClearOAuthToken()

func (*Client4) CreateChannel added in v3.7.0 

func (c *Client4) CreateChannel(channel *Channel) (*Channel, *Response)

CreateChannel creates a channel based on the provided channel struct.

func (*Client4) CreateDirectChannel added in v3.7.0 

func (c *Client4) CreateDirectChannel(userId1, userId2 string) (*Channel, *Response)

CreateDirectChannel creates a direct message channel based on the two user ids provided.

func (*Client4) CreateIncomingWebhook added in v3.7.0 

func (c *Client4) CreateIncomingWebhook(hook *IncomingWebhook) (*IncomingWebhook, *Response)

CreateIncomingWebhook creates an incoming webhook for a channel.

func (*Client4) CreatePost added in v3.7.0 

func (c *Client4) CreatePost(post *Post) (*Post, *Response)

CreatePost creates a post based on the provided post struct.

func (*Client4) CreateTeam added in v3.7.0 

func (c *Client4) CreateTeam(team *Team) (*Team, *Response)

CreateTeam creates a team in the system based on the provided team struct.

func (*Client4) CreateUser added in v3.7.0 

func (c *Client4) CreateUser(user *User) (*User, *Response)

CreateUser creates a user in the system based on the provided user struct.

func (*Client4) DeletePost added in v3.7.0 

func (c *Client4) DeletePost(postId string) (bool, *Response)

DeletePost deletes a post from the provided post id string.

func (*Client4) DeletePreferences added in v3.7.0 

func (c *Client4) DeletePreferences(userId string, preferences *Preferences) (bool, *Response)

DeletePreferences deletes the user's preferences

func (*Client4) DeleteUser added in v3.7.0 

func (c *Client4) DeleteUser(userId string) (bool, *Response)

DeleteUser deactivates a user in the system based on the provided user id string.

func (*Client4) DoApiDelete added in v3.7.0 

func (c *Client4) DoApiDelete(url string) (*http.Response, *AppError)

func (*Client4) DoApiGet added in v3.7.0 

func (c *Client4) DoApiGet(url string, etag string) (*http.Response, *AppError)

func (*Client4) DoApiPost added in v3.7.0 

func (c *Client4) DoApiPost(url string, data string) (*http.Response, *AppError)

func (*Client4) DoApiPut added in v3.7.0 

func (c *Client4) DoApiPut(url string, data string) (*http.Response, *AppError)

func (*Client4) DoApiRequest added in v3.7.0 

func (c *Client4) DoApiRequest(method, url, data, etag string) (*http.Response, *AppError)

func (*Client4) DoUploadFile added in v3.7.0 

func (c *Client4) DoUploadFile(url string, data []byte, contentType string) (*FileUploadResponse, *Response)

func (*Client4) GetAllTeams added in v3.7.0 

func (c *Client4) GetAllTeams(etag string, page int, perPage int) ([]*Team, *Response)

GetAllTeams returns all teams based on permissions.

func (*Client4) GetAudits added in v3.7.0 

func (c *Client4) GetAudits(userId string, page int, perPage int, etag string) (Audits, *Response)

GetAudits returns a list of audit based on the provided user id string.

func (*Client4) GetChannel added in v3.7.0 

func (c *Client4) GetChannel(channelId, etag string) (*Channel, *Response)

GetChannel returns a channel based on the provided channel id string.

func (*Client4) GetChannelByName added in v3.7.0 

func (c *Client4) GetChannelByName(channelName, teamId string, etag string) (*Channel, *Response)

GetChannelByName returns a channel based on the provided channel name and team id strings.

func (*Client4) GetChannelByNameForTeamName added in v3.7.0 

func (c *Client4) GetChannelByNameForTeamName(channelName, teamName string, etag string) (*Channel, *Response)

GetChannelByNameForTeamName returns a channel based on the provided channel name and team name strings.

func (*Client4) GetChannelByNameForTeamNameRoute added in v3.7.0 

func (c *Client4) GetChannelByNameForTeamNameRoute(channelName, teamName string) string

func (*Client4) GetChannelByNameRoute added in v3.7.0 

func (c *Client4) GetChannelByNameRoute(channelName, teamId string) string

func (*Client4) GetChannelMember added in v3.7.0 

func (c *Client4) GetChannelMember(channelId, userId, etag string) (*ChannelMember, *Response)

GetChannelMember gets a channel member.

func (*Client4) GetChannelMemberRoute added in v3.7.0 

func (c *Client4) GetChannelMemberRoute(channelId, userId string) string

func (*Client4) GetChannelMembers added in v3.7.0 

func (c *Client4) GetChannelMembers(channelId string, page, perPage int, etag string) (*ChannelMembers, *Response)

GetChannelMembers gets a page of channel members.

func (*Client4) GetChannelMembersForUser added in v3.7.0 

func (c *Client4) GetChannelMembersForUser(userId, teamId, etag string) (*ChannelMembers, *Response)

GetChannelMembersForUser gets all the channel members for a user on a team.

func (*Client4) GetChannelMembersRoute added in v3.7.0 

func (c *Client4) GetChannelMembersRoute(channelId string) string

func (*Client4) GetChannelRoute added in v3.7.0 

func (c *Client4) GetChannelRoute(channelId string) string

func (*Client4) GetChannelsRoute added in v3.7.0 

func (c *Client4) GetChannelsRoute() string

func (*Client4) GetFile added in v3.7.0 

func (c *Client4) GetFile(fileId string) ([]byte, *Response)

GetFile gets the bytes for a file by id.

func (*Client4) GetFileInfosForPost added in v3.7.0 

func (c *Client4) GetFileInfosForPost(postId string, etag string) ([]*FileInfo, *Response)

GetFileInfosForPost gets all the file info objects attached to a post.

func (*Client4) GetFileRoute added in v3.7.0 

func (c *Client4) GetFileRoute(fileId string) string

func (*Client4) GetFileThumbnail added in v3.7.0 

func (c *Client4) GetFileThumbnail(fileId string) ([]byte, *Response)

GetFileThumbnail gets the bytes for a file by id.

func (*Client4) GetFilesRoute added in v3.7.0 

func (c *Client4) GetFilesRoute() string

func (*Client4) GetIncomingWebhooks added in v3.7.0 

func (c *Client4) GetIncomingWebhooks(page int, perPage int, etag string) ([]*IncomingWebhook, *Response)

GetIncomingWebhooks returns a page of incoming webhooks on the system. Page counting starts at 0.

func (*Client4) GetIncomingWebhooksForTeam added in v3.7.0 

func (c *Client4) GetIncomingWebhooksForTeam(teamId string, page int, perPage int, etag string) ([]*IncomingWebhook, *Response)

GetIncomingWebhooksForTeam returns a page of incoming webhooks for a team. Page counting starts at 0.

func (*Client4) GetIncomingWebhooksRoute added in v3.7.0 

func (c *Client4) GetIncomingWebhooksRoute() string

func (*Client4) GetPing added in v3.7.0 

func (c *Client4) GetPing() (bool, *Response)

GetPing will ping the server and to see if it is up and running.

func (*Client4) GetPost added in v3.7.0 

func (c *Client4) GetPost(postId string, etag string) (*Post, *Response)

GetPost gets a single post.

func (*Client4) GetPostRoute added in v3.7.0 

func (c *Client4) GetPostRoute(postId string) string

func (*Client4) GetPostThread added in v3.7.0 

func (c *Client4) GetPostThread(postId string, etag string) (*PostList, *Response)

GetPostThread gets a post with all the other posts in the same thread.

func (*Client4) GetPostsForChannel added in v3.7.0 

func (c *Client4) GetPostsForChannel(channelId string, page, perPage int, etag string) (*PostList, *Response)

GetPostsForChannel gets a page of posts with an array for ordering for a channel.

func (*Client4) GetPostsRoute added in v3.7.0 

func (c *Client4) GetPostsRoute() string

func (*Client4) GetPreferenceByCategoryAndName added in v3.7.0 

func (c *Client4) GetPreferenceByCategoryAndName(userId string, category string, preferenceName string) (*Preference, *Response)

GetPreferenceByCategoryAndName returns the user's preferences from the provided category and preference name string

func (*Client4) GetPreferences added in v3.7.0 

func (c *Client4) GetPreferences(userId string) (Preferences, *Response)

GetPreferences returns the user's preferences

func (*Client4) GetPreferencesByCategory added in v3.7.0 

func (c *Client4) GetPreferencesByCategory(userId string, category string) (Preferences, *Response)

GetPreferencesByCategory returns the user's preferences from the provided category string

func (*Client4) GetPreferencesRoute added in v3.7.0 

func (c *Client4) GetPreferencesRoute(userId string) string

func (*Client4) GetProfileImage added in v3.7.0 

func (c *Client4) GetProfileImage(userId, etag string) ([]byte, *Response)

GetProfileImage gets user's profile image. Must be logged in or be a system administrator.

func (*Client4) GetSessions added in v3.7.0 

func (c *Client4) GetSessions(userId, etag string) ([]*Session, *Response)

GetSessions returns a list of sessions based on the provided user id string.

func (*Client4) GetSystemRoute added in v3.7.0 

func (c *Client4) GetSystemRoute() string

func (*Client4) GetTeam added in v3.7.0 

func (c *Client4) GetTeam(teamId, etag string) (*Team, *Response)

GetTeam returns a team based on the provided team id string.

func (*Client4) GetTeamByName added in v3.7.0 

func (c *Client4) GetTeamByName(name, etag string) (*Team, *Response)

GetTeamByName returns a team based on the provided team name string.

func (*Client4) GetTeamByNameRoute added in v3.7.0 

func (c *Client4) GetTeamByNameRoute(teamName string) string

func (*Client4) GetTeamMember added in v3.7.0 

func (c *Client4) GetTeamMember(teamId, userId, etag string) (*TeamMember, *Response)

GetTeamMember returns a team member based on the provided team and user id strings.

func (*Client4) GetTeamMemberRoute added in v3.7.0 

func (c *Client4) GetTeamMemberRoute(teamId, userId string) string

func (*Client4) GetTeamMembers added in v3.7.0 

func (c *Client4) GetTeamMembers(teamId string, page int, perPage int, etag string) ([]*TeamMember, *Response)

GetTeamMembers returns team members based on the provided team id string.

func (*Client4) GetTeamMembersRoute added in v3.7.0 

func (c *Client4) GetTeamMembersRoute(teamId string) string

func (*Client4) GetTeamRoute added in v3.7.0 

func (c *Client4) GetTeamRoute(teamId string) string

func (*Client4) GetTeamStats added in v3.7.0 

func (c *Client4) GetTeamStats(teamId, etag string) (*TeamStats, *Response)

GetTeamStats returns a team stats based on the team id string. Must be authenticated.

func (*Client4) GetTeamStatsRoute added in v3.7.0 

func (c *Client4) GetTeamStatsRoute(teamId string) string

func (*Client4) GetTeamsForUser added in v3.7.0 

func (c *Client4) GetTeamsForUser(userId, etag string) ([]*Team, *Response)

GetTeamsForUser returns a list of teams a user is on. Must be logged in as the user or be a system administrator.

func (*Client4) GetTeamsRoute added in v3.7.0 

func (c *Client4) GetTeamsRoute() string

func (*Client4) GetTeamsUnreadForUser added in v3.7.0 

func (c *Client4) GetTeamsUnreadForUser(userId, teamIdToExclude string) ([]*TeamUnread, *Response)

getTeamsUnreadForUser will return an array with TeamUnread objects that contain the amount of unread messages and mentions the current user has for the teams it belongs to. An optional team ID can be set to exclude that team from the results. Must be authenticated.

func (*Client4) GetUser added in v3.7.0 

func (c *Client4) GetUser(userId, etag string) (*User, *Response)

GetUser returns a user based on the provided user id string.

func (*Client4) GetUserByEmail added in v3.7.0 

func (c *Client4) GetUserByEmail(email, etag string) (*User, *Response)

GetUserByEmail returns a user based on the provided user email string.

func (*Client4) GetUserByEmailRoute added in v3.7.0 

func (c *Client4) GetUserByEmailRoute(email string) string

func (*Client4) GetUserByUsername added in v3.7.0 

func (c *Client4) GetUserByUsername(userName, etag string) (*User, *Response)

GetUserByUsername returns a user based on the provided user name string.

func (*Client4) GetUserByUsernameRoute added in v3.7.0 

func (c *Client4) GetUserByUsernameRoute(userName string) string

func (*Client4) GetUserRoute added in v3.7.0 

func (c *Client4) GetUserRoute(userId string) string

func (*Client4) GetUsers added in v3.7.0 

func (c *Client4) GetUsers(page int, perPage int, etag string) ([]*User, *Response)

GetUsers returns a page of users on the system. Page counting starts at 0.

func (*Client4) GetUsersByIds added in v3.7.0 

func (c *Client4) GetUsersByIds(userIds []string) ([]*User, *Response)

GetUsersByIds returns a list of users based on the provided user ids.

func (*Client4) GetUsersInChannel added in v3.7.0 

func (c *Client4) GetUsersInChannel(channelId string, page int, perPage int, etag string) ([]*User, *Response)

GetUsersInChannel returns a page of users on a team. Page counting starts at 0.

func (*Client4) GetUsersInTeam added in v3.7.0 

func (c *Client4) GetUsersInTeam(teamId string, page int, perPage int, etag string) ([]*User, *Response)

GetUsersInTeam returns a page of users on a team. Page counting starts at 0.

func (*Client4) GetUsersNotInChannel added in v3.7.0 

func (c *Client4) GetUsersNotInChannel(teamId, channelId string, page int, perPage int, etag string) ([]*User, *Response)

GetUsersNotInChannel returns a page of users on a team. Page counting starts at 0.

func (*Client4) GetUsersRoute added in v3.7.0 

func (c *Client4) GetUsersRoute() string

func (*Client4) Login added in v3.7.0 

func (c *Client4) Login(loginId string, password string) (*User, *Response)

Login authenticates a user by login id, which can be username, email or some sort of SSO identifier based on server configuration, and a password.

func (*Client4) LoginById added in v3.7.0 

func (c *Client4) LoginById(id string, password string) (*User, *Response)

LoginById authenticates a user by user id and password.

func (*Client4) LoginByLdap added in v3.7.0 

func (c *Client4) LoginByLdap(loginId string, password string) (*User, *Response)

LoginByLdap authenticates a user by LDAP id and password.

func (*Client4) LoginWithDevice added in v3.7.0 

func (c *Client4) LoginWithDevice(loginId string, password string, deviceId string) (*User, *Response)

LoginWithDevice authenticates a user by login id (username, email or some sort of SSO identifier based on configuration), password and attaches a device id to the session.

func (*Client4) Logout added in v3.7.0 

func (c *Client4) Logout() (bool, *Response)

Logout terminates the current user's session.

func (*Client4) PatchUser added in v3.7.0 

func (c *Client4) PatchUser(userId string, patch *UserPatch) (*User, *Response)

PatchUser partially updates a user in the system. Any missing fields are not updated.

func (*Client4) RemoveUserFromChannel added in v3.7.0 

func (c *Client4) RemoveUserFromChannel(channelId, userId string) (bool, *Response)

RemoveUserFromChannel will delete the channel member object for a user, effectively removing the user from a channel.

func (*Client4) ResetPassword added in v3.7.0 

func (c *Client4) ResetPassword(code, newPassword string) (bool, *Response)

ResetPassword uses a recovery code to update reset a user's password.

func (*Client4) RevokeSession added in v3.7.0 

func (c *Client4) RevokeSession(userId, sessionId string) (bool, *Response)

RevokeSession revokes a user session based on the provided user id and session id strings.

func (*Client4) SearchPosts added in v3.7.0 

func (c *Client4) SearchPosts(teamId string, terms string, isOrSearch bool) (*PostList, *Response)

SearchPosts returns any posts with matching terms string.

func (*Client4) SendPasswordResetEmail added in v3.7.0 

func (c *Client4) SendPasswordResetEmail(email string) (bool, *Response)

SendPasswordResetEmail will send a link for password resetting to a user with the provided email.

func (*Client4) SetOAuthToken added in v3.7.0 

func (c *Client4) SetOAuthToken(token string)

func (*Client4) SetProfileImage added in v3.7.0 

func (c *Client4) SetProfileImage(userId string, data []byte) (bool, *Response)

SetProfileImage sets profile image of the user

func (*Client4) UpdateChannelRoles added in v3.7.0 

func (c *Client4) UpdateChannelRoles(channelId, userId, roles string) (bool, *Response)

UpdateChannelRoles will update the roles on a channel for a user.

func (*Client4) UpdatePost added in v3.7.0 

func (c *Client4) UpdatePost(postId string, post *Post) (*Post, *Response)

UpdatePost updates a post based on the provided post struct.

func (*Client4) UpdatePreferences added in v3.7.0 

func (c *Client4) UpdatePreferences(userId string, preferences *Preferences) (bool, *Response)

UpdatePreferences saves the user's preferences

func (*Client4) UpdateTeamMemberRoles added in v3.7.0 

func (c *Client4) UpdateTeamMemberRoles(teamId, userId, newRoles string) (bool, *Response)

UpdateTeamMemberRoles will update the roles on a team for a user

func (*Client4) UpdateUser added in v3.7.0 

func (c *Client4) UpdateUser(user *User) (*User, *Response)

UpdateUser updates a user in the system based on the provided user struct.

func (*Client4) UpdateUserPassword added in v3.7.0 

func (c *Client4) UpdateUserPassword(userId, currentPassword, newPassword string) (bool, *Response)

UpdateUserPassword updates a user's password. Must be logged in as the user or be a system administrator.

func (*Client4) UpdateUserRoles added in v3.7.0 

func (c *Client4) UpdateUserRoles(userId, roles string) (bool, *Response)

UpdateUserRoles updates a user's roles in the system. A user can have "system_user" and "system_admin" roles.

func (*Client4) UploadFile added in v3.7.0 

func (c *Client4) UploadFile(data []byte, channelId string, filename string) (*FileUploadResponse, *Response)

UploadFile will upload a file to a channel, to be later attached to a post.

func (*Client4) VerifyUserEmail added in v3.7.0 

func (c *Client4) VerifyUserEmail(userId, hashId string) (bool, *Response)

Verify user email user id and hash strings.

func (*Client4) ViewChannel added in v3.7.0 

func (c *Client4) ViewChannel(userId string, view *ChannelView) (bool, *Response)

ViewChannel performs a view action for a user. Synonymous with switching channels or marking channels as read by a user.

type ClusterInfo added in v3.3.0 

type ClusterInfo struct {
	Id                 string `json:"id"`
	Version            string `json:"version"`
	ConfigHash         string `json:"config_hash"`
	InterNodeUrl       string `json:"internode_url"`
	Hostname           string `json:"hostname"`
	LastSuccessfulPing int64  `json:"last_ping"`
	IsAlive            bool   `json:"is_alive"`
}

func ClusterInfoFromJson added in v3.3.0 

func ClusterInfoFromJson(data io.Reader) *ClusterInfo

func ClusterInfosFromJson added in v3.3.0 

func ClusterInfosFromJson(data io.Reader) []*ClusterInfo

func (*ClusterInfo) HaveEstablishedInitialContact added in v3.3.0 

func (me *ClusterInfo) HaveEstablishedInitialContact() bool

func (*ClusterInfo) ToJson added in v3.3.0 

func (me *ClusterInfo) ToJson() string

type ClusterSettings added in v3.3.0 

type ClusterSettings struct {
	Enable                 *bool
	InterNodeListenAddress *string
	InterNodeUrls          []string
}

type ClusterStats added in v3.6.0 

type ClusterStats struct {
	Id                        string `json:"id"`
	TotalWebsocketConnections int    `json:"total_websocket_connections"`
	TotalReadDbConnections    int    `json:"total_read_db_connections"`
	TotalMasterDbConnections  int    `json:"total_master_db_connections"`
}

func ClusterStatsFromJson added in v3.6.0 

func ClusterStatsFromJson(data io.Reader) *ClusterStats

func (*ClusterStats) ToJson added in v3.6.0 

func (me *ClusterStats) ToJson() string

type Command 

type Command struct {
	Id               string `json:"id"`
	Token            string `json:"token"`
	CreateAt         int64  `json:"create_at"`
	UpdateAt         int64  `json:"update_at"`
	DeleteAt         int64  `json:"delete_at"`
	CreatorId        string `json:"creator_id"`
	TeamId           string `json:"team_id"`
	Trigger          string `json:"trigger"`
	Method           string `json:"method"`
	Username         string `json:"username"`
	IconURL          string `json:"icon_url"`
	AutoComplete     bool   `json:"auto_complete"`
	AutoCompleteDesc string `json:"auto_complete_desc"`
	AutoCompleteHint string `json:"auto_complete_hint"`
	DisplayName      string `json:"display_name"`
	Description      string `json:"description"`
	URL              string `json:"url"`
}

func CommandFromJson 

func CommandFromJson(data io.Reader) *Command

func CommandListFromJson 

func CommandListFromJson(data io.Reader) []*Command

func (*Command) IsValid 

func (o *Command) IsValid() *AppError

func (*Command) PreSave 

func (o *Command) PreSave()

func (*Command) PreUpdate 

func (o *Command) PreUpdate()

func (*Command) Sanitize 

func (o *Command) Sanitize()

func (*Command) ToJson 

func (o *Command) ToJson() string

type CommandArgs added in v3.6.0 

type CommandArgs struct {
	ChannelId string `json:"channel_id"`
	RootId    string `json:"root_id"`
	ParentId  string `json:"parent_id"`
	Command   string `json:"command"`
}

func CommandArgsFromJson added in v3.6.0 

func CommandArgsFromJson(data io.Reader) *CommandArgs

func (*CommandArgs) ToJson added in v3.6.0 

func (o *CommandArgs) ToJson() string

type CommandResponse 

type CommandResponse struct {
	ResponseType string             `json:"response_type"`
	Text         string             `json:"text"`
	Username     string             `json:"username"`
	IconURL      string             `json:"icon_url"`
	GotoLocation string             `json:"goto_location"`
	Attachments  []*SlackAttachment `json:"attachments"`
}

func CommandResponseFromJson 

func CommandResponseFromJson(data io.Reader) *CommandResponse

func (*CommandResponse) ToJson 

func (o *CommandResponse) ToJson() string

type Compliance 

type Compliance struct {
	Id       string `json:"id"`
	CreateAt int64  `json:"create_at"`
	UserId   string `json:"user_id"`
	Status   string `json:"status"`
	Count    int    `json:"count"`
	Desc     string `json:"desc"`
	Type     string `json:"type"`
	StartAt  int64  `json:"start_at"`
	EndAt    int64  `json:"end_at"`
	Keywords string `json:"keywords"`
	Emails   string `json:"emails"`
}

func ComplianceFromJson 

func ComplianceFromJson(data io.Reader) *Compliance

func (*Compliance) IsValid 

func (me *Compliance) IsValid() *AppError

func (*Compliance) JobName 

func (me *Compliance) JobName() string

func (*Compliance) PreSave 

func (me *Compliance) PreSave()

func (*Compliance) ToJson 

func (o *Compliance) ToJson() string

type CompliancePost 

type CompliancePost struct {

	// From Team
	TeamName        string
	TeamDisplayName string

	// From Channel
	ChannelName        string
	ChannelDisplayName string

	// From User
	UserUsername string
	UserEmail    string
	UserNickname string

	// From Post
	PostId         string
	PostCreateAt   int64
	PostUpdateAt   int64
	PostDeleteAt   int64
	PostRootId     string
	PostParentId   string
	PostOriginalId string
	PostMessage    string
	PostType       string
	PostProps      string
	PostHashtags   string
	PostFileIds    string
}

func (*CompliancePost) Row 

func (me *CompliancePost) Row() []string

type ComplianceSettings 

type ComplianceSettings struct {
	Enable      *bool
	Directory   *string
	EnableDaily *bool
}

type Compliances 

type Compliances []Compliance

func CompliancesFromJson 

func CompliancesFromJson(data io.Reader) Compliances

func (Compliances) ToJson 

func (o Compliances) ToJson() string

type Config 

type Config struct {
	ServiceSettings      ServiceSettings
	TeamSettings         TeamSettings
	SqlSettings          SqlSettings
	LogSettings          LogSettings
	PasswordSettings     PasswordSettings
	FileSettings         FileSettings
	EmailSettings        EmailSettings
	RateLimitSettings    RateLimitSettings
	PrivacySettings      PrivacySettings
	SupportSettings      SupportSettings
	GitLabSettings       SSOSettings
	GoogleSettings       SSOSettings
	Office365Settings    SSOSettings
	LdapSettings         LdapSettings
	ComplianceSettings   ComplianceSettings
	LocalizationSettings LocalizationSettings
	SamlSettings         SamlSettings
	NativeAppSettings    NativeAppSettings
	ClusterSettings      ClusterSettings
	MetricsSettings      MetricsSettings
	AnalyticsSettings    AnalyticsSettings
	WebrtcSettings       WebrtcSettings
}

func ConfigFromJson 

func ConfigFromJson(data io.Reader) *Config

func (*Config) GetSSOService 

func (o *Config) GetSSOService(service string) *SSOSettings

func (*Config) GetSanitizeOptions 

func (o *Config) GetSanitizeOptions() map[string]bool

func (*Config) IsValid 

func (o *Config) IsValid() *AppError

func (*Config) Sanitize 

func (o *Config) Sanitize()

func (*Config) SetDefaults 

func (o *Config) SetDefaults()

func (*Config) ToJson 

func (o *Config) ToJson() string

type Customer 

type Customer struct {
	Id          string `json:"id"`
	Name        string `json:"name"`
	Email       string `json:"email"`
	Company     string `json:"company"`
	PhoneNumber string `json:"phone_number"`
}

type EmailSettings 

type EmailSettings struct {
	EnableSignUpWithEmail    bool
	EnableSignInWithEmail    *bool
	EnableSignInWithUsername *bool
	SendEmailNotifications   bool
	RequireEmailVerification bool
	FeedbackName             string
	FeedbackEmail            string
	FeedbackOrganization     *string
	SMTPUsername             string
	SMTPPassword             string
	SMTPServer               string
	SMTPPort                 string
	ConnectionSecurity       string
	InviteSalt               string
	PasswordResetSalt        string
	SendPushNotifications    *bool
	PushNotificationServer   *string
	PushNotificationContents *string
	EnableEmailBatching      *bool
	EmailBatchingBufferSize  *int
	EmailBatchingInterval    *int
}

type Emoji added in v3.2.0 

type Emoji struct {
	Id        string `json:"id"`
	CreateAt  int64  `json:"create_at"`
	UpdateAt  int64  `json:"update_at"`
	DeleteAt  int64  `json:"delete_at"`
	CreatorId string `json:"creator_id"`
	Name      string `json:"name"`
}

func EmojiFromJson added in v3.2.0 

func EmojiFromJson(data io.Reader) *Emoji

func EmojiListFromJson added in v3.2.0 

func EmojiListFromJson(data io.Reader) []*Emoji

func (*Emoji) IsValid added in v3.2.0 

func (emoji *Emoji) IsValid() *AppError

func (*Emoji) PreSave added in v3.2.0 

func (emoji *Emoji) PreSave()

func (*Emoji) PreUpdate added in v3.2.0 

func (emoji *Emoji) PreUpdate()

func (*Emoji) ToJson added in v3.2.0 

func (emoji *Emoji) ToJson() string

type EncryptStringMap 

type EncryptStringMap map[string]string

type Features 

type Features struct {
	Users                *int  `json:"users"`
	LDAP                 *bool `json:"ldap"`
	MFA                  *bool `json:"mfa"`
	GoogleOAuth          *bool `json:"google_oauth"`
	Office365OAuth       *bool `json:"office365_oauth"`
	Compliance           *bool `json:"compliance"`
	Cluster              *bool `json:"cluster"`
	Metrics              *bool `json:"metrics"`
	CustomBrand          *bool `json:"custom_brand"`
	MHPNS                *bool `json:"mhpns"`
	SAML                 *bool `json:"saml"`
	PasswordRequirements *bool `json:"password_requirements"`
	// after we enabled more features for webrtc we'll need to control them with this
	FutureFeatures *bool `json:"future_features"`
}

func (*Features) SetDefaults 

func (f *Features) SetDefaults()

func (*Features) ToMap added in v3.4.0 

func (f *Features) ToMap() map[string]interface{}

type FileInfo 

type FileInfo struct {
	Id              string `json:"id"`
	CreatorId       string `json:"user_id"`
	PostId          string `json:"post_id,omitempty"`
	CreateAt        int64  `json:"create_at"`
	UpdateAt        int64  `json:"update_at"`
	DeleteAt        int64  `json:"delete_at"`
	Path            string `json:"-"` // not sent back to the client
	ThumbnailPath   string `json:"-"` // not sent back to the client
	PreviewPath     string `json:"-"` // not sent back to the client
	Name            string `json:"name"`
	Extension       string `json:"extension"`
	Size            int64  `json:"size"`
	MimeType        string `json:"mime_type"`
	Width           int    `json:"width,omitempty"`
	Height          int    `json:"height,omitempty"`
	HasPreviewImage bool   `json:"has_preview_image,omitempty"`
}

func FileInfoFromJson 

func FileInfoFromJson(data io.Reader) *FileInfo

func FileInfosFromJson added in v3.5.0 

func FileInfosFromJson(data io.Reader) []*FileInfo

func (*FileInfo) IsImage added in v3.5.0 

func (o *FileInfo) IsImage() bool

func (*FileInfo) IsValid added in v3.5.0 

func (o *FileInfo) IsValid() *AppError

func (*FileInfo) PreSave added in v3.5.0 

func (o *FileInfo) PreSave()

func (*FileInfo) ToJson 

func (info *FileInfo) ToJson() string

type FileSettings 

type FileSettings struct {
	MaxFileSize             *int64
	DriverName              string
	Directory               string
	EnablePublicLink        bool
	PublicLinkSalt          *string
	ThumbnailWidth          int
	ThumbnailHeight         int
	PreviewWidth            int
	PreviewHeight           int
	ProfileWidth            int
	ProfileHeight           int
	InitialFont             string
	AmazonS3AccessKeyId     string
	AmazonS3SecretAccessKey string
	AmazonS3Bucket          string
	AmazonS3Region          string
	AmazonS3Endpoint        string
	AmazonS3SSL             *bool
}

type FileUploadResponse 

type FileUploadResponse struct {
	FileInfos []*FileInfo `json:"file_infos"`
	ClientIds []string    `json:"client_ids"`
}

func FileUploadResponseFromJson 

func FileUploadResponseFromJson(data io.Reader) *FileUploadResponse

func (*FileUploadResponse) ToJson 

func (o *FileUploadResponse) ToJson() string

type GatewayResponse added in v3.5.0 

type GatewayResponse struct {
	Status string `json:"janus"`
}

func GatewayResponseFromJson added in v3.5.0 

func GatewayResponseFromJson(data io.Reader) *GatewayResponse

type IncomingWebhook 

type IncomingWebhook struct {
	Id          string `json:"id"`
	CreateAt    int64  `json:"create_at"`
	UpdateAt    int64  `json:"update_at"`
	DeleteAt    int64  `json:"delete_at"`
	UserId      string `json:"user_id"`
	ChannelId   string `json:"channel_id"`
	TeamId      string `json:"team_id"`
	DisplayName string `json:"display_name"`
	Description string `json:"description"`
}

func IncomingWebhookFromJson 

func IncomingWebhookFromJson(data io.Reader) *IncomingWebhook

func IncomingWebhookListFromJson 

func IncomingWebhookListFromJson(data io.Reader) []*IncomingWebhook

func (*IncomingWebhook) IsValid 

func (o *IncomingWebhook) IsValid() *AppError

func (*IncomingWebhook) PreSave 

func (o *IncomingWebhook) PreSave()

func (*IncomingWebhook) PreUpdate 

func (o *IncomingWebhook) PreUpdate()

func (*IncomingWebhook) ToJson 

func (o *IncomingWebhook) ToJson() string

type IncomingWebhookRequest 

type IncomingWebhookRequest struct {
	Text        string             `json:"text"`
	Username    string             `json:"username"`
	IconURL     string             `json:"icon_url"`
	ChannelName string             `json:"channel"`
	Props       StringInterface    `json:"props"`
	Attachments []*SlackAttachment `json:"attachments"`
	Type        string             `json:"type"`
}

func IncomingWebhookRequestFromJson 

func IncomingWebhookRequestFromJson(data io.Reader) *IncomingWebhookRequest

type InitialLoad 

type InitialLoad struct {
	User        *User             `json:"user"`
	TeamMembers []*TeamMember     `json:"team_members"`
	Teams       []*Team           `json:"teams"`
	Preferences Preferences       `json:"preferences"`
	ClientCfg   map[string]string `json:"client_cfg"`
	LicenseCfg  map[string]string `json:"license_cfg"`
	NoAccounts  bool              `json:"no_accounts"`
}

func InitialLoadFromJson 

func InitialLoadFromJson(data io.Reader) *InitialLoad

func (*InitialLoad) ToJson 

func (me *InitialLoad) ToJson() string

type Invites 

type Invites struct {
	Invites []map[string]string `json:"invites"`
}

func InvitesFromJson 

func InvitesFromJson(data io.Reader) *Invites

func (*Invites) ToEmailList added in v3.7.0 

func (o *Invites) ToEmailList() []string

func (*Invites) ToJson 

func (o *Invites) ToJson() string

type LdapSettings 

type LdapSettings struct {
	// Basic
	Enable             *bool
	LdapServer         *string
	LdapPort           *int
	ConnectionSecurity *string
	BaseDN             *string
	BindUsername       *string
	BindPassword       *string

	// Filtering
	UserFilter *string

	// User Mapping
	FirstNameAttribute *string
	LastNameAttribute  *string
	EmailAttribute     *string
	UsernameAttribute  *string
	NicknameAttribute  *string
	IdAttribute        *string
	PositionAttribute  *string

	// Syncronization
	SyncIntervalMinutes *int

	// Advanced
	SkipCertificateVerification *bool
	QueryTimeout                *int
	MaxPageSize                 *int

	// Customization
	LoginFieldName *string
}

type License 

type License struct {
	Id        string    `json:"id"`
	IssuedAt  int64     `json:"issued_at"`
	StartsAt  int64     `json:"starts_at"`
	ExpiresAt int64     `json:"expires_at"`
	Customer  *Customer `json:"customer"`
	Features  *Features `json:"features"`
}

func LicenseFromJson 

func LicenseFromJson(data io.Reader) *License

func (*License) IsExpired 

func (l *License) IsExpired() bool

func (*License) IsStarted 

func (l *License) IsStarted() bool

func (*License) ToJson 

func (l *License) ToJson() string

type LicenseRecord 

type LicenseRecord struct {
	Id       string `json:"id"`
	CreateAt int64  `json:"create_at"`
	Bytes    string `json:"-"`
}

func (*LicenseRecord) IsValid 

func (lr *LicenseRecord) IsValid() *AppError

func (*LicenseRecord) PreSave 

func (lr *LicenseRecord) PreSave()

type LocalizationSettings added in v3.1.0 

type LocalizationSettings struct {
	DefaultServerLocale *string
	DefaultClientLocale *string
	AvailableLocales    *string
}

type LogSettings 

type LogSettings struct {
	EnableConsole          bool
	ConsoleLevel           string
	EnableFile             bool
	FileLevel              string
	FileFormat             string
	FileLocation           string
	EnableWebhookDebugging bool
	EnableDiagnostics      *bool
}

type MetricsSettings added in v3.6.0 

type MetricsSettings struct {
	Enable           *bool
	BlockProfileRate *int
	ListenAddress    *string
}

type NativeAppSettings added in v3.3.0 

type NativeAppSettings struct {
	AppDownloadLink        *string
	AndroidAppDownloadLink *string
	IosAppDownloadLink     *string
}

type OAuthApp 

type OAuthApp struct {
	Id           string      `json:"id"`
	CreatorId    string      `json:"creator_id"`
	CreateAt     int64       `json:"create_at"`
	UpdateAt     int64       `json:"update_at"`
	ClientSecret string      `json:"client_secret"`
	Name         string      `json:"name"`
	Description  string      `json:"description"`
	IconURL      string      `json:"icon_url"`
	CallbackUrls StringArray `json:"callback_urls"`
	Homepage     string      `json:"homepage"`
	IsTrusted    bool        `json:"is_trusted"`
}

func OAuthAppFromJson 

func OAuthAppFromJson(data io.Reader) *OAuthApp

OAuthAppFromJson will decode the input and return a User

func OAuthAppListFromJson added in v3.3.0 

func OAuthAppListFromJson(data io.Reader) []*OAuthApp

func (*OAuthApp) Etag 

func (a *OAuthApp) Etag() string

Generate a valid strong etag so the browser can cache the results

func (*OAuthApp) IsValid 

func (a *OAuthApp) IsValid() *AppError

IsValid validates the app and returns an error if it isn't configured correctly.

func (*OAuthApp) IsValidRedirectURL 

func (a *OAuthApp) IsValidRedirectURL(url string) bool

func (*OAuthApp) PreSave 

func (a *OAuthApp) PreSave()

PreSave will set the Id and ClientSecret if missing. It will also fill in the CreateAt, UpdateAt times. It should be run before saving the app to the db.

func (*OAuthApp) PreUpdate 

func (a *OAuthApp) PreUpdate()

PreUpdate should be run before updating the app in the db.

func (*OAuthApp) Sanitize 

func (a *OAuthApp) Sanitize()

Remove any private data from the app object

func (*OAuthApp) ToJson 

func (a *OAuthApp) ToJson() string

ToJson convert a User to a json string

type OutgoingWebhook 

type OutgoingWebhook struct {
	Id           string      `json:"id"`
	Token        string      `json:"token"`
	CreateAt     int64       `json:"create_at"`
	UpdateAt     int64       `json:"update_at"`
	DeleteAt     int64       `json:"delete_at"`
	CreatorId    string      `json:"creator_id"`
	ChannelId    string      `json:"channel_id"`
	TeamId       string      `json:"team_id"`
	TriggerWords StringArray `json:"trigger_words"`
	TriggerWhen  int         `json:"trigger_when"`
	CallbackURLs StringArray `json:"callback_urls"`
	DisplayName  string      `json:"display_name"`
	Description  string      `json:"description"`
	ContentType  string      `json:"content_type"`
}

func OutgoingWebhookFromJson 

func OutgoingWebhookFromJson(data io.Reader) *OutgoingWebhook

func OutgoingWebhookListFromJson 

func OutgoingWebhookListFromJson(data io.Reader) []*OutgoingWebhook

func (*OutgoingWebhook) HasTriggerWord 

func (o *OutgoingWebhook) HasTriggerWord(word string) bool

func (*OutgoingWebhook) IsValid 

func (o *OutgoingWebhook) IsValid() *AppError

func (*OutgoingWebhook) PreSave 

func (o *OutgoingWebhook) PreSave()

func (*OutgoingWebhook) PreUpdate 

func (o *OutgoingWebhook) PreUpdate()

func (*OutgoingWebhook) ToJson 

func (o *OutgoingWebhook) ToJson() string

func (*OutgoingWebhook) TriggerWordStartsWith added in v3.3.0 

func (o *OutgoingWebhook) TriggerWordStartsWith(word string) bool

type OutgoingWebhookPayload added in v3.1.0 

type OutgoingWebhookPayload struct {
	Token       string `json:"token"`
	TeamId      string `json:"team_id"`
	TeamDomain  string `json:"team_domain"`
	ChannelId   string `json:"channel_id"`
	ChannelName string `json:"channel_name"`
	Timestamp   int64  `json:"timestamp"`
	UserId      string `json:"user_id"`
	UserName    string `json:"user_name"`
	PostId      string `json:"post_id"`
	Text        string `json:"text"`
	TriggerWord string `json:"trigger_word"`
}

func (*OutgoingWebhookPayload) ToFormValues added in v3.1.0 

func (o *OutgoingWebhookPayload) ToFormValues() string

func (*OutgoingWebhookPayload) ToJSON added in v3.1.0 

func (o *OutgoingWebhookPayload) ToJSON() string

type PasswordRecovery 

type PasswordRecovery struct {
	UserId   string
	Code     string
	CreateAt int64
}

func (*PasswordRecovery) IsValid 

func (p *PasswordRecovery) IsValid() *AppError

func (*PasswordRecovery) PreSave 

func (p *PasswordRecovery) PreSave()

type PasswordSettings added in v3.2.0 

type PasswordSettings struct {
	MinimumLength *int
	Lowercase     *bool
	Number        *bool
	Uppercase     *bool
	Symbol        *bool
}

type Permission added in v3.5.0 

type Permission struct {
	Id          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
}
var PERMISSION_ADD_USER_TO_TEAM *Permission
var PERMISSION_ASSIGN_SYSTEM_ADMIN_ROLE *Permission
var PERMISSION_CREATE_DIRECT_CHANNEL *Permission
var PERMISSION_CREATE_GROUP_CHANNEL *Permission
var PERMISSION_CREATE_POST *Permission
var PERMISSION_CREATE_PRIVATE_CHANNEL *Permission
var PERMISSION_CREATE_PUBLIC_CHANNEL *Permission
var PERMISSION_CREATE_TEAM *Permission
var PERMISSION_DELETE_OTHERS_POSTS *Permission
var PERMISSION_DELETE_POST *Permission
var PERMISSION_DELETE_PRIVATE_CHANNEL *Permission
var PERMISSION_DELETE_PUBLIC_CHANNEL *Permission
var PERMISSION_EDIT_OTHERS_POSTS *Permission
var PERMISSION_EDIT_OTHER_USERS *Permission
var PERMISSION_EDIT_POST *Permission
var PERMISSION_GET_PUBLIC_LINK *Permission
var PERMISSION_IMPORT_TEAM *Permission
var PERMISSION_INVITE_USER *Permission
var PERMISSION_JOIN_PUBLIC_CHANNELS *Permission
var PERMISSION_LIST_TEAM_CHANNELS *Permission
var PERMISSION_MANAGE_CHANNEL_ROLES *Permission
var PERMISSION_MANAGE_OAUTH *Permission
var PERMISSION_MANAGE_OTHERS_SLASH_COMMANDS *Permission
var PERMISSION_MANAGE_OTHERS_WEBHOOKS *Permission
var PERMISSION_MANAGE_PRIVATE_CHANNEL_MEMBERS *Permission
var PERMISSION_MANAGE_PRIVATE_CHANNEL_PROPERTIES *Permission
var PERMISSION_MANAGE_PUBLIC_CHANNEL_MEMBERS *Permission
var PERMISSION_MANAGE_PUBLIC_CHANNEL_PROPERTIES *Permission
var PERMISSION_MANAGE_ROLES *Permission
var PERMISSION_MANAGE_SLASH_COMMANDS *Permission
var PERMISSION_MANAGE_SYSTEM *Permission

General permission that encompases all system admin functions in the future this could be broken up to allow access to some admin functions but not others 

var PERMISSION_MANAGE_SYSTEM_WIDE_OAUTH *Permission
var PERMISSION_MANAGE_TEAM *Permission
var PERMISSION_MANAGE_TEAM_ROLES *Permission
var PERMISSION_MANAGE_WEBHOOKS *Permission
var PERMISSION_PERMANENT_DELETE_USER *Permission
var PERMISSION_READ_CHANNEL *Permission
var PERMISSION_REMOVE_USER_FROM_TEAM *Permission
var PERMISSION_UPLOAD_FILE *Permission
var PERMISSION_USE_SLASH_COMMANDS *Permission
var PERMISSION_VIEW_TEAM *Permission

type Post 

type Post struct {
	Id            string          `json:"id"`
	CreateAt      int64           `json:"create_at"`
	UpdateAt      int64           `json:"update_at"`
	EditAt        int64           `json:"edit_at"`
	DeleteAt      int64           `json:"delete_at"`
	UserId        string          `json:"user_id"`
	ChannelId     string          `json:"channel_id"`
	RootId        string          `json:"root_id"`
	ParentId      string          `json:"parent_id"`
	OriginalId    string          `json:"original_id"`
	Message       string          `json:"message"`
	Type          string          `json:"type"`
	Props         StringInterface `json:"props"`
	Hashtags      string          `json:"hashtags"`
	Filenames     StringArray     `json:"filenames,omitempty"` // Deprecated, do not use this field any more
	FileIds       StringArray     `json:"file_ids,omitempty"`
	PendingPostId string          `json:"pending_post_id" db:"-"`
	HasReactions  bool            `json:"has_reactions,omitempty"`
}

func PostFromJson 

func PostFromJson(data io.Reader) *Post

func (*Post) AddProp 

func (o *Post) AddProp(key string, value interface{})

func (*Post) Etag 

func (o *Post) Etag() string

func (*Post) IsSystemMessage 

func (o *Post) IsSystemMessage() bool

func (*Post) IsValid 

func (o *Post) IsValid() *AppError

func (*Post) MakeNonNil 

func (o *Post) MakeNonNil()

func (*Post) PreSave 

func (o *Post) PreSave()

func (*Post) ToJson 

func (o *Post) ToJson() string

type PostList 

type PostList struct {
	Order []string         `json:"order"`
	Posts map[string]*Post `json:"posts"`
}

func NewPostList added in v3.7.0 

func NewPostList() *PostList

func PostListFromJson 

func PostListFromJson(data io.Reader) *PostList

func (*PostList) AddOrder 

func (o *PostList) AddOrder(id string)

func (*PostList) AddPost 

func (o *PostList) AddPost(post *Post)

func (*PostList) Etag 

func (o *PostList) Etag() string

func (*PostList) Extend 

func (o *PostList) Extend(other *PostList)

func (*PostList) IsChannelId 

func (o *PostList) IsChannelId(channelId string) bool

func (*PostList) MakeNonNil 

func (o *PostList) MakeNonNil()

func (*PostList) ToJson 

func (o *PostList) ToJson() string

type Preference 

type Preference struct {
	UserId   string `json:"user_id"`
	Category string `json:"category"`
	Name     string `json:"name"`
	Value    string `json:"value"`
}

func PreferenceFromJson 

func PreferenceFromJson(data io.Reader) *Preference

func (*Preference) IsValid 

func (o *Preference) IsValid() *AppError

func (*Preference) PreUpdate added in v3.3.0 

func (o *Preference) PreUpdate()

func (*Preference) ToJson 

func (o *Preference) ToJson() string

type Preferences 

type Preferences []Preference

func PreferencesFromJson 

func PreferencesFromJson(data io.Reader) (Preferences, error)

func (*Preferences) ToJson 

func (o *Preferences) ToJson() string

type PrivacySettings 

type PrivacySettings struct {
	ShowEmailAddress bool
	ShowFullName     bool
}

type PushNotification 

type PushNotification struct {
	Platform         string `json:"platform"`
	ServerId         string `json:"server_id"`
	DeviceId         string `json:"device_id"`
	Category         string `json:"category"`
	Sound            string `json:"sound"`
	Message          string `json:"message"`
	Badge            int    `json:"badge"`
	ContentAvailable int    `json:"cont_ava"`
	TeamId           string `json:"team_id"`
	ChannelId        string `json:"channel_id"`
	ChannelName      string `json:"channel_name"`
	Type             string `json:"type"`
}

func PushNotificationFromJson 

func PushNotificationFromJson(data io.Reader) *PushNotification

func (*PushNotification) SetDeviceIdAndPlatform added in v3.4.0 

func (me *PushNotification) SetDeviceIdAndPlatform(deviceId string)

func (*PushNotification) ToJson 

func (me *PushNotification) ToJson() string

type PushResponse added in v3.7.0 

type PushResponse map[string]string

func NewErrorPushResponse added in v3.7.0 

func NewErrorPushResponse(message string) PushResponse

func NewOkPushResponse added in v3.7.0 

func NewOkPushResponse() PushResponse

func NewRemovePushResponse added in v3.7.0 

func NewRemovePushResponse() PushResponse

func PushResponseFromJson added in v3.7.0 

func PushResponseFromJson(data io.Reader) PushResponse

func (*PushResponse) ToJson added in v3.7.0 

func (me *PushResponse) ToJson() string

type RateLimitSettings 

type RateLimitSettings struct {
	Enable           *bool
	PerSec           int
	MaxBurst         *int
	MemoryStoreSize  int
	VaryByRemoteAddr bool
	VaryByHeader     string
}

type Reaction added in v3.6.0 

type Reaction struct {
	UserId    string `json:"user_id"`
	PostId    string `json:"post_id"`
	EmojiName string `json:"emoji_name"`
	CreateAt  int64  `json:"create_at"`
}

func ReactionFromJson added in v3.6.0 

func ReactionFromJson(data io.Reader) *Reaction

func ReactionsFromJson added in v3.6.0 

func ReactionsFromJson(data io.Reader) []*Reaction

func (*Reaction) IsValid added in v3.6.0 

func (o *Reaction) IsValid() *AppError

func (*Reaction) PreSave added in v3.6.0 

func (o *Reaction) PreSave()

func (*Reaction) ToJson added in v3.6.0 

func (o *Reaction) ToJson() string

type Response added in v3.7.0 

type Response struct {
	StatusCode    int
	Error         *AppError
	RequestId     string
	Etag          string
	ServerVersion string
}

func BuildResponse added in v3.7.0 

func BuildResponse(r *http.Response) *Response

type ResponseMetadata added in v3.6.0 

type ResponseMetadata struct {
	StatusCode int
	Error      *AppError
	RequestId  string
	Etag       string
}

type Result 

type Result struct {
	RequestId string
	Etag      string
	Data      interface{}
}

type Role added in v3.5.0 

type Role struct {
	Id          string   `json:"id"`
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Permissions []string `json:"permissions"`
}
var ROLE_CHANNEL_ADMIN *Role
var ROLE_CHANNEL_GUEST *Role
var ROLE_CHANNEL_USER *Role
var ROLE_SYSTEM_ADMIN *Role
var ROLE_SYSTEM_USER *Role
var ROLE_TEAM_ADMIN *Role
var ROLE_TEAM_USER *Role

type SSOSettings 

type SSOSettings struct {
	Enable          bool
	Secret          string
	Id              string
	Scope           string
	AuthEndpoint    string
	TokenEndpoint   string
	UserApiEndpoint string
}

type SamlAuthRequest added in v3.2.0 

type SamlAuthRequest struct {
	Base64AuthRequest string
	URL               string
	RelayState        string
}

type SamlSettings added in v3.2.0 

type SamlSettings struct {
	// Basic
	Enable  *bool
	Verify  *bool
	Encrypt *bool

	IdpUrl                      *string
	IdpDescriptorUrl            *string
	AssertionConsumerServiceURL *string

	IdpCertificateFile    *string
	PublicCertificateFile *string
	PrivateKeyFile        *string

	// User Mapping
	FirstNameAttribute *string
	LastNameAttribute  *string
	EmailAttribute     *string
	UsernameAttribute  *string
	NicknameAttribute  *string
	LocaleAttribute    *string
	PositionAttribute  *string

	LoginButtonText *string
}

type ScheduledTask added in v3.1.0 

type ScheduledTask struct {
	Name      string        `json:"name"`
	Interval  time.Duration `json:"interval"`
	Recurring bool          `json:"recurring"`
	// contains filtered or unexported fields
}

func CreateRecurringTask added in v3.1.0 

func CreateRecurringTask(name string, function TaskFunc, interval time.Duration) *ScheduledTask

func CreateTask added in v3.1.0 

func CreateTask(name string, function TaskFunc, timeToExecution time.Duration) *ScheduledTask

func GetTaskByName added in v3.2.0 

func GetTaskByName(name string) *ScheduledTask

func (*ScheduledTask) Cancel added in v3.1.0 

func (task *ScheduledTask) Cancel()

func (*ScheduledTask) Execute added in v3.3.0 

func (task *ScheduledTask) Execute()

Executes the task immediatly. A recurring task will be run regularally after interval.

func (*ScheduledTask) String added in v3.1.0 

func (task *ScheduledTask) String() string

type SearchParams 

type SearchParams struct {
	Terms      string
	IsHashtag  bool
	InChannels []string
	FromUsers  []string
	OrTerms    bool
}

func ParseSearchParams 

func ParseSearchParams(text string) []*SearchParams

type SecurityBulletin 

type SecurityBulletin struct {
	Id               string `json:"id"`
	AppliesToVersion string `json:"applies_to_version"`
}

func SecurityBulletinFromJson 

func SecurityBulletinFromJson(data io.Reader) *SecurityBulletin

func (*SecurityBulletin) ToJson 

func (me *SecurityBulletin) ToJson() string

type SecurityBulletins 

type SecurityBulletins []SecurityBulletin

func SecurityBulletinsFromJson 

func SecurityBulletinsFromJson(data io.Reader) SecurityBulletins

func (SecurityBulletins) ToJson 

func (me SecurityBulletins) ToJson() string

type ServiceSettings 

type ServiceSettings struct {
	SiteURL                                  *string
	ListenAddress                            string
	ConnectionSecurity                       *string
	TLSCertFile                              *string
	TLSKeyFile                               *string
	UseLetsEncrypt                           *bool
	LetsEncryptCertificateCacheFile          *string
	Forward80To443                           *bool
	ReadTimeout                              *int
	WriteTimeout                             *int
	MaximumLoginAttempts                     int
	GoogleDeveloperKey                       string
	EnableOAuthServiceProvider               bool
	EnableIncomingWebhooks                   bool
	EnableOutgoingWebhooks                   bool
	EnableCommands                           *bool
	EnableOnlyAdminIntegrations              *bool
	EnablePostUsernameOverride               bool
	EnablePostIconOverride                   bool
	EnableLinkPreviews                       *bool
	EnableTesting                            bool
	EnableDeveloper                          *bool
	EnableSecurityFixAlert                   *bool
	EnableInsecureOutgoingConnections        *bool
	EnableMultifactorAuthentication          *bool
	EnforceMultifactorAuthentication         *bool
	AllowCorsFrom                            *string
	SessionLengthWebInDays                   *int
	SessionLengthMobileInDays                *int
	SessionLengthSSOInDays                   *int
	SessionCacheInMinutes                    *int
	WebsocketSecurePort                      *int
	WebsocketPort                            *int
	WebserverMode                            *string
	EnableCustomEmoji                        *bool
	RestrictCustomEmojiCreation              *string
	RestrictPostDelete                       *string
	AllowEditPost                            *string
	PostEditTimeLimit                        *int
	TimeBetweenUserTypingUpdatesMilliseconds *int64
	EnableUserTypingMessages                 *bool
	ClusterLogTimeoutMilliseconds            *int
}

type Session 

type Session struct {
	Id             string        `json:"id"`
	Token          string        `json:"token"`
	CreateAt       int64         `json:"create_at"`
	ExpiresAt      int64         `json:"expires_at"`
	LastActivityAt int64         `json:"last_activity_at"`
	UserId         string        `json:"user_id"`
	DeviceId       string        `json:"device_id"`
	Roles          string        `json:"roles"`
	IsOAuth        bool          `json:"is_oauth"`
	Props          StringMap     `json:"props"`
	TeamMembers    []*TeamMember `json:"team_members" db:"-"`
}

func SessionFromJson 

func SessionFromJson(data io.Reader) *Session

func SessionsFromJson 

func SessionsFromJson(data io.Reader) []*Session

func (*Session) AddProp 

func (me *Session) AddProp(key string, value string)

func (*Session) GetTeamByTeamId 

func (me *Session) GetTeamByTeamId(teamId string) *TeamMember

func (*Session) GetUserRoles added in v3.5.0 

func (me *Session) GetUserRoles() []string

func (*Session) IsExpired 

func (me *Session) IsExpired() bool

func (*Session) IsMobileApp added in v3.4.0 

func (me *Session) IsMobileApp() bool

func (*Session) PreSave 

func (me *Session) PreSave()

func (*Session) Sanitize 

func (me *Session) Sanitize()

func (*Session) SetExpireInDays 

func (me *Session) SetExpireInDays(days int)

func (*Session) ToJson 

func (me *Session) ToJson() string

type SlackAttachment added in v3.7.0 

type SlackAttachment struct {
	Id         int64                   `json:"id"`
	Fallback   string                  `json:"fallback"`
	Color      string                  `json:"color"`
	Pretext    string                  `json:"pretext"`
	AuthorName string                  `json:"author_name"`
	AuthorLink string                  `json:"author_link"`
	AuthorIcon string                  `json:"author_icon"`
	Title      string                  `json:"title"`
	TitleLink  string                  `json:"title_link"`
	Text       string                  `json:"text"`
	Fields     []*SlackAttachmentField `json:"fields"`
	ImageURL   string                  `json:"image_url"`
	ThumbURL   string                  `json:"thumb_url"`
	Footer     string                  `json:"footer"`
	FooterIcon string                  `json:"footer_icon"`
	Timestamp  interface{}             `json:"ts"` // This is either a string or an int64
}

type SlackAttachmentField added in v3.7.0 

type SlackAttachmentField struct {
	Title string      `json:"title"`
	Value interface{} `json:"value"`
	Short bool        `json:"short"`
}

type SqlSettings 

type SqlSettings struct {
	DriverName         string
	DataSource         string
	DataSourceReplicas []string
	MaxIdleConns       int
	MaxOpenConns       int
	Trace              bool
	AtRestEncryptKey   string
}

type Status added in v3.3.0 

type Status struct {
	UserId         string `json:"user_id"`
	Status         string `json:"status"`
	Manual         bool   `json:"manual"`
	LastActivityAt int64  `json:"last_activity_at"`
	ActiveChannel  string `json:"active_channel" db:"-"`
}

func StatusFromJson added in v3.3.0 

func StatusFromJson(data io.Reader) *Status

func (*Status) ToJson added in v3.3.0 

func (o *Status) ToJson() string

type StringArray 

type StringArray []string

type StringInterface 

type StringInterface map[string]interface{}

type StringMap 

type StringMap map[string]string

func GetDefaultChannelNotifyProps 

func GetDefaultChannelNotifyProps() StringMap

type SuggestCommand 

type SuggestCommand struct {
	Suggestion  string `json:"suggestion"`
	Description string `json:"description"`
}

func SuggestCommandFromJson 

func SuggestCommandFromJson(data io.Reader) *SuggestCommand

func (*SuggestCommand) ToJson 

func (o *SuggestCommand) ToJson() string

type SupportSettings 

type SupportSettings struct {
	TermsOfServiceLink *string
	PrivacyPolicyLink  *string
	AboutLink          *string
	HelpLink           *string
	ReportAProblemLink *string
	SupportEmail       *string
}

type System 

type System struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

func SystemFromJson 

func SystemFromJson(data io.Reader) *System

func (*System) ToJson 

func (o *System) ToJson() string

type TaskFunc added in v3.1.0 

type TaskFunc func()

type Team 

type Team struct {
	Id              string `json:"id"`
	CreateAt        int64  `json:"create_at"`
	UpdateAt        int64  `json:"update_at"`
	DeleteAt        int64  `json:"delete_at"`
	DisplayName     string `json:"display_name"`
	Name            string `json:"name"`
	Description     string `json:"description"`
	Email           string `json:"email"`
	Type            string `json:"type"`
	CompanyName     string `json:"company_name"`
	AllowedDomains  string `json:"allowed_domains"`
	InviteId        string `json:"invite_id"`
	AllowOpenInvite bool   `json:"allow_open_invite"`
}

func TeamFromJson 

func TeamFromJson(data io.Reader) *Team

func TeamListFromJson added in v3.7.0 

func TeamListFromJson(data io.Reader) []*Team

func (*Team) Etag 

func (o *Team) Etag() string

func (*Team) IsValid 

func (o *Team) IsValid() *AppError

func (*Team) PreSave 

func (o *Team) PreSave()

func (*Team) PreUpdate 

func (o *Team) PreUpdate()

func (*Team) Sanitize 

func (o *Team) Sanitize()

func (*Team) SanitizeForNotLoggedIn 

func (o *Team) SanitizeForNotLoggedIn()

func (*Team) ToJson 

func (o *Team) ToJson() string

type TeamMember 

type TeamMember struct {
	TeamId   string `json:"team_id"`
	UserId   string `json:"user_id"`
	Roles    string `json:"roles"`
	DeleteAt int64  `json:"delete_at"`
}

func TeamMemberFromJson 

func TeamMemberFromJson(data io.Reader) *TeamMember

func TeamMembersFromJson 

func TeamMembersFromJson(data io.Reader) []*TeamMember

func (*TeamMember) GetRoles added in v3.5.0 

func (o *TeamMember) GetRoles() []string

func (*TeamMember) IsValid 

func (o *TeamMember) IsValid() *AppError

func (*TeamMember) PreUpdate added in v3.5.0 

func (o *TeamMember) PreUpdate()

func (*TeamMember) ToJson 

func (o *TeamMember) ToJson() string

type TeamSettings 

type TeamSettings struct {
	SiteName                         string
	MaxUsersPerTeam                  int
	EnableTeamCreation               bool
	EnableUserCreation               bool
	EnableOpenServer                 *bool
	RestrictCreationToDomains        string
	EnableCustomBrand                *bool
	CustomBrandText                  *string
	CustomDescriptionText            *string
	RestrictDirectMessage            *string
	RestrictTeamInvite               *string
	RestrictPublicChannelManagement  *string
	RestrictPrivateChannelManagement *string
	RestrictPublicChannelCreation    *string
	RestrictPrivateChannelCreation   *string
	RestrictPublicChannelDeletion    *string
	RestrictPrivateChannelDeletion   *string
	UserStatusAwayTimeout            *int64
	MaxChannelsPerTeam               *int64
	MaxNotificationsPerChannel       *int64
}

type TeamStats added in v3.5.0 

type TeamStats struct {
	TeamId            string `json:"team_id"`
	TotalMemberCount  int64  `json:"total_member_count"`
	ActiveMemberCount int64  `json:"active_member_count"`
}

func TeamStatsFromJson added in v3.5.0 

func TeamStatsFromJson(data io.Reader) *TeamStats

func (*TeamStats) ToJson added in v3.5.0 

func (o *TeamStats) ToJson() string

type TeamUnread added in v3.6.0 

type TeamUnread struct {
	TeamId       string `json:"team_id"`
	MsgCount     int64  `json:"msg_count"`
	MentionCount int64  `json:"mention_count"`
}

func TeamsUnreadFromJson added in v3.6.0 

func TeamsUnreadFromJson(data io.Reader) []*TeamUnread

type User 

type User struct {
	Id                 string    `json:"id"`
	CreateAt           int64     `json:"create_at,omitempty"`
	UpdateAt           int64     `json:"update_at,omitempty"`
	DeleteAt           int64     `json:"delete_at"`
	Username           string    `json:"username"`
	Password           string    `json:"password,omitempty"`
	AuthData           *string   `json:"auth_data,omitempty"`
	AuthService        string    `json:"auth_service"`
	Email              string    `json:"email"`
	EmailVerified      bool      `json:"email_verified,omitempty"`
	Nickname           string    `json:"nickname"`
	FirstName          string    `json:"first_name"`
	LastName           string    `json:"last_name"`
	Position           string    `json:"position"`
	Roles              string    `json:"roles"`
	AllowMarketing     bool      `json:"allow_marketing,omitempty"`
	Props              StringMap `json:"props,omitempty"`
	NotifyProps        StringMap `json:"notify_props,omitempty"`
	LastPasswordUpdate int64     `json:"last_password_update,omitempty"`
	LastPictureUpdate  int64     `json:"last_picture_update,omitempty"`
	FailedAttempts     int       `json:"failed_attempts,omitempty"`
	Locale             string    `json:"locale"`
	MfaActive          bool      `json:"mfa_active,omitempty"`
	MfaSecret          string    `json:"mfa_secret,omitempty"`
	LastActivityAt     int64     `db:"-" json:"last_activity_at,omitempty"`
}

func UserFromJson 

func UserFromJson(data io.Reader) *User

UserFromJson will decode the input and return a User

func UserListFromJson added in v3.5.0 

func UserListFromJson(data io.Reader) []*User

func (*User) AddNotifyProp 

func (u *User) AddNotifyProp(key string, value string)

func (*User) AddProp 

func (u *User) AddProp(key string, value string)

func (*User) ClearNonProfileFields 

func (u *User) ClearNonProfileFields()

func (*User) Etag 

func (u *User) Etag(showFullName, showEmail bool) string

Generate a valid strong etag so the browser can cache the results

func (*User) GetDisplayName 

func (u *User) GetDisplayName() string

func (*User) GetDisplayNameForPreference added in v3.4.0 

func (u *User) GetDisplayNameForPreference(nameFormat string) string

func (*User) GetFullName 

func (u *User) GetFullName() string

func (*User) GetRawRoles added in v3.5.0 

func (u *User) GetRawRoles() string

func (*User) GetRoles added in v3.5.0 

func (u *User) GetRoles() []string

func (*User) IsInRole 

func (u *User) IsInRole(inRole string) bool

Make sure you acually want to use this function. In context.go there are functions to check permissions This function should not be used to check permissions.

func (*User) IsLDAPUser 

func (u *User) IsLDAPUser() bool

func (*User) IsOAuthUser 

func (u *User) IsOAuthUser() bool

func (*User) IsSSOUser added in v3.7.0 

func (u *User) IsSSOUser() bool

func (*User) IsValid 

func (u *User) IsValid() *AppError

IsValid validates the user and returns an error if it isn't configured correctly.

func (*User) MakeNonNil 

func (u *User) MakeNonNil()

func (*User) Patch added in v3.7.0 

func (u *User) Patch(patch *UserPatch)

func (*User) PreSave 

func (u *User) PreSave()

PreSave will set the Id and Username if missing. It will also fill in the CreateAt, UpdateAt times. It will also hash the password. It should be run before saving the user to the db.

func (*User) PreUpdate 

func (u *User) PreUpdate()

PreUpdate should be run before updating the user in the db.

func (*User) Sanitize 

func (u *User) Sanitize(options map[string]bool)

Remove any private data from the user object

func (*User) SanitizeProfile added in v3.4.0 

func (u *User) SanitizeProfile(options map[string]bool)

func (*User) SetDefaultNotifications 

func (u *User) SetDefaultNotifications()

func (*User) ToJson 

func (u *User) ToJson() string

ToJson convert a User to a json string

func (*User) UpdateMentionKeysFromUsername 

func (user *User) UpdateMentionKeysFromUsername(oldUsername string)

type UserAutocompleteInChannel added in v3.5.0 

type UserAutocompleteInChannel struct {
	InChannel    []*User `json:"in_channel"`
	OutOfChannel []*User `json:"out_of_channel"`
}

func UserAutocompleteInChannelFromJson added in v3.5.0 

func UserAutocompleteInChannelFromJson(data io.Reader) *UserAutocompleteInChannel

func (*UserAutocompleteInChannel) ToJson added in v3.5.0 

func (o *UserAutocompleteInChannel) ToJson() string

type UserAutocompleteInTeam added in v3.5.0 

type UserAutocompleteInTeam struct {
	InTeam []*User `json:"in_team"`
}

func UserAutocompleteInTeamFromJson added in v3.5.0 

func UserAutocompleteInTeamFromJson(data io.Reader) *UserAutocompleteInTeam

func (*UserAutocompleteInTeam) ToJson added in v3.5.0 

func (o *UserAutocompleteInTeam) ToJson() string

type UserPatch added in v3.7.0 

type UserPatch struct {
	Username    *string    `json:"username"`
	Nickname    *string    `json:"nickname"`
	FirstName   *string    `json:"first_name"`
	LastName    *string    `json:"last_name"`
	Position    *string    `json:"position"`
	Email       *string    `json:"email"`
	Props       *StringMap `json:"props,omitempty"`
	NotifyProps *StringMap `json:"notify_props,omitempty"`
	Locale      *string    `json:"locale"`
}

func UserPatchFromJson added in v3.7.0 

func UserPatchFromJson(data io.Reader) *UserPatch

func (*UserPatch) ToJson added in v3.7.0 

func (u *UserPatch) ToJson() string

type UserSearch added in v3.5.0 

type UserSearch struct {
	Term           string `json:"term"`
	TeamId         string `json:"team_id"`
	InChannelId    string `json:"in_channel_id"`
	NotInChannelId string `json:"not_in_channel_id"`
	AllowInactive  bool   `json:"allow_inactive"`
}

func UserSearchFromJson added in v3.5.0 

func UserSearchFromJson(data io.Reader) *UserSearch

UserSearchFromJson will decode the input and return a User

func (*UserSearch) ToJson added in v3.5.0 

func (u *UserSearch) ToJson() string

ToJson convert a User to a json string

type WebSocketClient added in v3.3.0 

type WebSocketClient struct {
	Url             string          // The location of the server like "ws://localhost:8065"
	ApiUrl          string          // The api location of the server like "ws://localhost:8065/api/v3"
	Conn            *websocket.Conn // The WebSocket connection
	AuthToken       string          // The token used to open the WebSocket
	Sequence        int64           // The ever-incrementing sequence attached to each WebSocket action
	EventChannel    chan *WebSocketEvent
	ResponseChannel chan *WebSocketResponse
	ListenError     *AppError
}

func (*WebSocketClient) Close added in v3.3.0 

func (wsc *WebSocketClient) Close()

func (*WebSocketClient) Connect added in v3.3.0 

func (wsc *WebSocketClient) Connect() *AppError

func (*WebSocketClient) GetStatuses added in v3.3.0 

func (wsc *WebSocketClient) GetStatuses()

GetStatuses will return a map of string statuses using user id as the key

func (*WebSocketClient) GetStatusesByIds added in v3.5.0 

func (wsc *WebSocketClient) GetStatusesByIds(userIds []string)

GetStatusesByIds will fetch certain user statuses based on ids and return a map of string statuses using user id as the key

func (*WebSocketClient) Listen added in v3.3.0 

func (wsc *WebSocketClient) Listen()

func (*WebSocketClient) SendMessage added in v3.3.0 

func (wsc *WebSocketClient) SendMessage(action string, data map[string]interface{})

func (*WebSocketClient) UserTyping added in v3.3.0 

func (wsc *WebSocketClient) UserTyping(channelId, parentId string)

UserTyping will push a user_typing event out to all connected users who are in the specified channel

type WebSocketEvent added in v3.3.0 

type WebSocketEvent struct {
	Event          string                 `json:"event"`
	Data           map[string]interface{} `json:"data"`
	Broadcast      *WebsocketBroadcast    `json:"broadcast"`
	PreComputeJson []byte                 `json:"-"`
}

func NewWebSocketEvent added in v3.3.0 

func NewWebSocketEvent(event, teamId, channelId, userId string, omitUsers map[string]bool) *WebSocketEvent

func WebSocketEventFromJson added in v3.3.0 

func WebSocketEventFromJson(data io.Reader) *WebSocketEvent

func (*WebSocketEvent) Add added in v3.3.0 

func (m *WebSocketEvent) Add(key string, value interface{})

func (*WebSocketEvent) DoPreComputeJson added in v3.5.0 

func (o *WebSocketEvent) DoPreComputeJson()

func (*WebSocketEvent) EventType added in v3.6.0 

func (o *WebSocketEvent) EventType() string

func (*WebSocketEvent) GetPreComputeJson added in v3.5.0 

func (o *WebSocketEvent) GetPreComputeJson() []byte

func (*WebSocketEvent) IsValid added in v3.3.0 

func (o *WebSocketEvent) IsValid() bool

func (*WebSocketEvent) ToJson added in v3.3.0 

func (o *WebSocketEvent) ToJson() string

type WebSocketMessage added in v3.3.0 

type WebSocketMessage interface {
	ToJson() string
	IsValid() bool
	DoPreComputeJson()
	GetPreComputeJson() []byte
	EventType() string
}

type WebSocketRequest added in v3.3.0 

type WebSocketRequest struct {
	// Client-provided fields
	Seq    int64                  `json:"seq"`
	Action string                 `json:"action"`
	Data   map[string]interface{} `json:"data"`

	// Server-provided fields
	Session Session              `json:"-"`
	T       goi18n.TranslateFunc `json:"-"`
	Locale  string               `json:"-"`
}

func WebSocketRequestFromJson added in v3.3.0 

func WebSocketRequestFromJson(data io.Reader) *WebSocketRequest

func (*WebSocketRequest) ToJson added in v3.3.0 

func (o *WebSocketRequest) ToJson() string

type WebSocketResponse added in v3.3.0 

type WebSocketResponse struct {
	Status         string                 `json:"status"`
	SeqReply       int64                  `json:"seq_reply,omitempty"`
	Data           map[string]interface{} `json:"data,omitempty"`
	Error          *AppError              `json:"error,omitempty"`
	PreComputeJson []byte                 `json:"-"`
}

func NewWebSocketError added in v3.3.0 

func NewWebSocketError(seqReply int64, err *AppError) *WebSocketResponse

func NewWebSocketResponse added in v3.3.0 

func NewWebSocketResponse(status string, seqReply int64, data map[string]interface{}) *WebSocketResponse

func WebSocketResponseFromJson added in v3.3.0 

func WebSocketResponseFromJson(data io.Reader) *WebSocketResponse

func (*WebSocketResponse) Add added in v3.3.0 

func (m *WebSocketResponse) Add(key string, value interface{})

func (*WebSocketResponse) DoPreComputeJson added in v3.5.0 

func (o *WebSocketResponse) DoPreComputeJson()

func (*WebSocketResponse) EventType added in v3.6.0 

func (o *WebSocketResponse) EventType() string

func (*WebSocketResponse) GetPreComputeJson added in v3.5.0 

func (o *WebSocketResponse) GetPreComputeJson() []byte

func (*WebSocketResponse) IsValid added in v3.3.0 

func (o *WebSocketResponse) IsValid() bool

func (*WebSocketResponse) ToJson added in v3.3.0 

func (o *WebSocketResponse) ToJson() string

type WebrtcSettings added in v3.5.0 

type WebrtcSettings struct {
	Enable              *bool
	GatewayWebsocketUrl *string
	GatewayAdminUrl     *string
	GatewayAdminSecret  *string
	StunURI             *string
	TurnURI             *string
	TurnUsername        *string
	TurnSharedKey       *string
}

type WebsocketBroadcast added in v3.5.0 

type WebsocketBroadcast struct {
	OmitUsers map[string]bool `json:"omit_users"` // broadcast is omitted for users listed here
	UserId    string          `json:"user_id"`    // broadcast only occurs for this user
	ChannelId string          `json:"channel_id"` // broadcast only occurs for users in this channel
	TeamId    string          `json:"team_id"`    // broadcast only occurs for users in this team
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.