platform: github.com/mattermost/platform/model Index | Files | Directories

package model

import "github.com/mattermost/platform/model"

Index

Package Files

access.go analytics_row.go audit.go audits.go authorize.go builtin.go bundle_info.go channel.go channel_count.go channel_data.go channel_list.go channel_member.go channel_member_history.go channel_member_history_result.go channel_mentions.go channel_search.go channel_stats.go channel_view.go client4.go cluster_discovery.go cluster_info.go cluster_message.go cluster_stats.go command.go command_args.go command_response.go command_webhook.go compliance.go compliance_post.go config.go data_retention_policy.go emoji.go emoji_data.go emoji_search.go file.go file_info.go gitlab.go incoming_webhook.go initial_load.go job.go ldap.go license.go manifest.go message_export.go mfa_secret.go migration.go oauth.go outgoing_webhook.go permission.go plugin_key_value.go plugin_status.go plugins_response.go post.go post_list.go post_search_results.go preference.go preferences.go push_notification.go push_response.go reaction.go role.go saml.go scheduled_task.go scheme.go search_params.go security_bulletin.go session.go slack_attachment.go status.go suggest_command.go switch_request.go system.go team.go team_member.go team_search.go team_stats.go terms_of_service.go timezone.go token.go user.go user_access_token.go user_access_token_search.go user_autocomplete.go user_search.go users_stats.go utils.go version.go webrtc.go websocket_client.go websocket_message.go websocket_request.go

Constants

const (
    ACCESS_TOKEN_GRANT_TYPE  = "authorization_code"
    ACCESS_TOKEN_TYPE        = "bearer"
    REFRESH_TOKEN_GRANT_TYPE = "refresh_token"
)
const (
    AUTHCODE_EXPIRE_TIME   = 60 * 10 // 10 minutes
    AUTHCODE_RESPONSE_TYPE = "code"
    IMPLICIT_RESPONSE_TYPE = "token"
    DEFAULT_SCOPE          = "user"
)
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_NAME_UI_MAX_LENGTH     = 22
    CHANNEL_HEADER_MAX_RUNES       = 1024
    CHANNEL_PURPOSE_MAX_RUNES      = 250
    CHANNEL_CACHE_SIZE             = 25000
)
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"
)
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 = "client"

    API_URL_SUFFIX_V1 = "/api/v1"
    API_URL_SUFFIX_V4 = "/api/v4"
    API_URL_SUFFIX    = API_URL_SUFFIX_V4
)
const (
    CDS_OFFLINE_AFTER_MILLIS = 1000 * 60 * 30 // 30 minutes
    CDS_TYPE_APP             = "mattermost_app"
)
const (
    CLUSTER_EVENT_PUBLISH                                           = "publish"
    CLUSTER_EVENT_UPDATE_STATUS                                     = "update_status"
    CLUSTER_EVENT_INVALIDATE_ALL_CACHES                             = "inv_all_caches"
    CLUSTER_EVENT_INVALIDATE_CACHE_FOR_REACTIONS                    = "inv_reactions"
    CLUSTER_EVENT_INVALIDATE_CACHE_FOR_WEBHOOK                      = "inv_webhook"
    CLUSTER_EVENT_INVALIDATE_CACHE_FOR_CHANNEL_POSTS                = "inv_channel_posts"
    CLUSTER_EVENT_INVALIDATE_CACHE_FOR_CHANNEL_MEMBERS_NOTIFY_PROPS = "inv_channel_members_notify_props"
    CLUSTER_EVENT_INVALIDATE_CACHE_FOR_CHANNEL_MEMBERS              = "inv_channel_members"
    CLUSTER_EVENT_INVALIDATE_CACHE_FOR_CHANNEL_BY_NAME              = "inv_channel_name"
    CLUSTER_EVENT_INVALIDATE_CACHE_FOR_CHANNEL                      = "inv_channel"
    CLUSTER_EVENT_INVALIDATE_CACHE_FOR_USER                         = "inv_user"
    CLUSTER_EVENT_CLEAR_SESSION_CACHE_FOR_USER                      = "clear_session_user"
    CLUSTER_EVENT_INVALIDATE_CACHE_FOR_ROLES                        = "inv_roles"
    CLUSTER_EVENT_INVALIDATE_CACHE_FOR_SCHEMES                      = "inv_schemes"

    CLUSTER_SEND_BEST_EFFORT = "best_effort"
    CLUSTER_SEND_RELIABLE    = "reliable"
)
const (
    COMMAND_METHOD_POST = "P"
    COMMAND_METHOD_GET  = "G"
    MIN_TRIGGER_LENGTH  = 1
    MAX_TRIGGER_LENGTH  = 128
)
const (
    COMMAND_RESPONSE_TYPE_IN_CHANNEL = "in_channel"
    COMMAND_RESPONSE_TYPE_EPHEMERAL  = "ephemeral"
)
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"
)
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_SQLITE   = "sqlite3"
    DATABASE_DRIVER_MYSQL    = "mysql"
    DATABASE_DRIVER_POSTGRES = "postgres"

    MINIO_ACCESS_KEY = "minioaccesskey"
    MINIO_SECRET_KEY = "miniosecretkey"
    MINIO_BUCKET     = "mattermost-test"

    PASSWORD_MAXIMUM_LENGTH = 64
    PASSWORD_MINIMUM_LENGTH = 5

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

    GENERIC_NO_CHANNEL_NOTIFICATION = "generic_no_channel"
    GENERIC_NOTIFICATION            = "generic"
    FULL_NOTIFICATION               = "full"

    DIRECT_MESSAGE_ANY  = "any"
    DIRECT_MESSAGE_TEAM = "team"

    SHOW_USERNAME          = "username"
    SHOW_NICKNAME_FULLNAME = "nickname_full_name"
    SHOW_FULLNAME          = "full_name"

    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"

    GROUP_UNREAD_CHANNELS_DISABLED    = "disabled"
    GROUP_UNREAD_CHANNELS_DEFAULT_ON  = "default_on"
    GROUP_UNREAD_CHANNELS_DEFAULT_OFF = "default_off"

    EMAIL_BATCHING_BUFFER_SIZE = 256
    EMAIL_BATCHING_INTERVAL    = 30

    EMAIL_NOTIFICATION_CONTENTS_FULL    = "full"
    EMAIL_NOTIFICATION_CONTENTS_GENERIC = "generic"

    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_MAX_LOGIN_ATTEMPTS = 10
    SERVICE_SETTINGS_DEFAULT_ALLOW_CORS_FROM    = ""
    SERVICE_SETTINGS_DEFAULT_LISTEN_AND_ADDRESS = ":8065"
    SERVICE_SETTINGS_DEFAULT_GFYCAT_API_KEY     = "2_KtH_W5"
    SERVICE_SETTINGS_DEFAULT_GFYCAT_API_SECRET  = "3wLVZPiswc3DnaiaFoLkDvB4X0IV6CpMkj4tf2inJRsBY6-FnkT08zGmppWFgeof"

    TEAM_SETTINGS_DEFAULT_MAX_USERS_PER_TEAM       = 50
    TEAM_SETTINGS_DEFAULT_CUSTOM_BRAND_TEXT        = ""
    TEAM_SETTINGS_DEFAULT_CUSTOM_DESCRIPTION_TEXT  = ""
    TEAM_SETTINGS_DEFAULT_USER_STATUS_AWAY_TIMEOUT = 300

    SQL_SETTINGS_DEFAULT_DATA_SOURCE = "mmuser:mostest@tcp(dockerhost:3306)/mattermost_test?charset=utf8mb4,utf8&readTimeout=30s&writeTimeout=30s"

    FILE_SETTINGS_DEFAULT_DIRECTORY = "./data/"

    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_ID_ATTRIBUTE         = ""
    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

    ANNOUNCEMENT_SETTINGS_DEFAULT_BANNER_COLOR      = "#f2a93b"
    ANNOUNCEMENT_SETTINGS_DEFAULT_BANNER_TEXT_COLOR = "#333333"

    TEAM_SETTINGS_DEFAULT_TEAM_TEXT = "default"

    ELASTICSEARCH_SETTINGS_DEFAULT_CONNECTION_URL                    = ""
    ELASTICSEARCH_SETTINGS_DEFAULT_USERNAME                          = ""
    ELASTICSEARCH_SETTINGS_DEFAULT_PASSWORD                          = ""
    ELASTICSEARCH_SETTINGS_DEFAULT_POST_INDEX_REPLICAS               = 1
    ELASTICSEARCH_SETTINGS_DEFAULT_POST_INDEX_SHARDS                 = 1
    ELASTICSEARCH_SETTINGS_DEFAULT_AGGREGATE_POSTS_AFTER_DAYS        = 365
    ELASTICSEARCH_SETTINGS_DEFAULT_POSTS_AGGREGATOR_JOB_START_TIME   = "03:00"
    ELASTICSEARCH_SETTINGS_DEFAULT_INDEX_PREFIX                      = ""
    ELASTICSEARCH_SETTINGS_DEFAULT_LIVE_INDEXING_BATCH_SIZE          = 1
    ELASTICSEARCH_SETTINGS_DEFAULT_BULK_INDEXING_TIME_WINDOW_SECONDS = 3600
    ELASTICSEARCH_SETTINGS_DEFAULT_REQUEST_TIMEOUT_SECONDS           = 30

    DATA_RETENTION_SETTINGS_DEFAULT_MESSAGE_RETENTION_DAYS  = 365
    DATA_RETENTION_SETTINGS_DEFAULT_FILE_RETENTION_DAYS     = 365
    DATA_RETENTION_SETTINGS_DEFAULT_DELETION_JOB_START_TIME = "02:00"

    PLUGIN_SETTINGS_DEFAULT_DIRECTORY        = "./plugins"
    PLUGIN_SETTINGS_DEFAULT_CLIENT_DIRECTORY = "./client/plugins"

    TIMEZONE_SETTINGS_DEFAULT_SUPPORTED_TIMEZONES_PATH = "timezones.json"

    COMPLIANCE_EXPORT_TYPE_CSV         = "csv"
    COMPLIANCE_EXPORT_TYPE_ACTIANCE    = "actiance"
    COMPLIANCE_EXPORT_TYPE_GLOBALRELAY = "globalrelay"
    GLOBALRELAY_CUSTOMER_TYPE_A9       = "A9"
    GLOBALRELAY_CUSTOMER_TYPE_A10      = "A10"

    CLIENT_SIDE_CERT_CHECK_PRIMARY_AUTH   = "primary"
    CLIENT_SIDE_CERT_CHECK_SECONDARY_AUTH = "secondary"
)
const (
    EMOJI_NAME_MAX_LENGTH = 64
    EMOJI_SORT_BY_NAME    = "name"
)
const (
    JOB_TYPE_DATA_RETENTION                 = "data_retention"
    JOB_TYPE_MESSAGE_EXPORT                 = "message_export"
    JOB_TYPE_ELASTICSEARCH_POST_INDEXING    = "elasticsearch_post_indexing"
    JOB_TYPE_ELASTICSEARCH_POST_AGGREGATION = "elasticsearch_post_aggregation"
    JOB_TYPE_LDAP_SYNC                      = "ldap_sync"
    JOB_TYPE_MIGRATIONS                     = "migrations"
    JOB_TYPE_PLUGINS                        = "plugins"

    JOB_STATUS_PENDING          = "pending"
    JOB_STATUS_IN_PROGRESS      = "in_progress"
    JOB_STATUS_SUCCESS          = "success"
    JOB_STATUS_ERROR            = "error"
    JOB_STATUS_CANCEL_REQUESTED = "cancel_requested"
    JOB_STATUS_CANCELED         = "canceled"
)
const (
    EXPIRED_LICENSE_ERROR = "api.license.add_license.expired.app_error"
    INVALID_LICENSE_ERROR = "api.license.add_license.invalid.app_error"
)
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"
    OAUTH_ACTION_MOBILE       = "mobile"
    OAUTH_ACTION_CLIENT       = "client"
)
const (
    PERMISSION_SCOPE_SYSTEM  = "system_scope"
    PERMISSION_SCOPE_TEAM    = "team_scope"
    PERMISSION_SCOPE_CHANNEL = "channel_scope"
)
const (
    KEY_VALUE_PLUGIN_ID_MAX_RUNES = 190
    KEY_VALUE_KEY_MAX_RUNES       = 50
)
const (
    PluginStateNotRunning          = 0
    PluginStateStarting            = 1 // unused by server
    PluginStateRunning             = 2
    PluginStateFailedToStart       = 3
    PluginStateFailedToStayRunning = 4 // unused by server
    PluginStateStopping            = 5 // unused by server
)
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_JOIN_TEAM              = "system_join_team"
    POST_LEAVE_TEAM             = "system_leave_team"
    POST_AUTO_RESPONDER         = "system_auto_responder"
    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_MOVE_CHANNEL           = "system_move_channel"
    POST_ADD_TO_TEAM            = "system_add_to_team"
    POST_REMOVE_FROM_TEAM       = "system_remove_from_team"
    POST_HEADER_CHANGE          = "system_header_change"
    POST_DISPLAYNAME_CHANGE     = "system_displayname_change"
    POST_CONVERT_CHANNEL        = "system_convert_channel"
    POST_PURPOSE_CHANGE         = "system_purpose_change"
    POST_CHANNEL_DELETED        = "system_channel_deleted"
    POST_EPHEMERAL              = "system_ephemeral"
    POST_CHANGE_CHANNEL_PRIVACY = "system_change_chan_privacy"
    POST_FILEIDS_MAX_RUNES      = 150
    POST_FILENAMES_MAX_RUNES    = 4000
    POST_HASHTAGS_MAX_RUNES     = 1000
    POST_MESSAGE_MAX_RUNES_V1   = 4000
    POST_MESSAGE_MAX_BYTES_V2   = 65535                         // Maximum size of a TEXT column in MySQL
    POST_MESSAGE_MAX_RUNES_V2   = POST_MESSAGE_MAX_BYTES_V2 / 4 // Assume a worst-case representation
    POST_PROPS_MAX_RUNES        = 8000
    POST_PROPS_MAX_USER_RUNES   = POST_PROPS_MAX_RUNES - 400 // Leave some room for system / pre-save modifications
    POST_CUSTOM_TYPE_PREFIX     = "custom_"
    PROPS_ADD_CHANNEL_MEMBER    = "add_channel_member"
    POST_PROPS_ADDED_USER_ID    = "addedUserId"
    POST_PROPS_DELETE_BY        = "deleteBy"
    POST_ACTION_TYPE_BUTTON     = "button"
    POST_ACTION_TYPE_SELECT     = "select"
)
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_FAVORITE_CHANNEL    = "favorite_channel"
    PREFERENCE_CATEGORY_SIDEBAR_SETTINGS    = "sidebar_settings"

    PREFERENCE_CATEGORY_DISPLAY_SETTINGS = "display_settings"
    PREFERENCE_NAME_CHANNEL_DISPLAY_MODE = "channel_display_mode"
    PREFERENCE_NAME_COLLAPSE_SETTING     = "collapse_previews"
    PREFERENCE_NAME_MESSAGE_DISPLAY      = "message_display"
    PREFERENCE_NAME_NAME_FORMAT          = "name_format"
    PREFERENCE_NAME_USE_MILITARY_TIME    = "use_military_time"

    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_EMAIL_INTERVAL_NO_BATCHING_SECONDS = "30"  // the "immediate" setting is actually 30s
    PREFERENCE_EMAIL_INTERVAL_BATCHING_SECONDS    = "900" // fifteen minutes is 900 seconds
    PREFERENCE_EMAIL_INTERVAL_IMMEDIATELY         = "immediately"
    PREFERENCE_EMAIL_INTERVAL_FIFTEEN             = "fifteen"
    PREFERENCE_EMAIL_INTERVAL_FIFTEEN_AS_SECONDS  = "900"
    PREFERENCE_EMAIL_INTERVAL_HOUR                = "hour"
    PREFERENCE_EMAIL_INTERVAL_HOUR_AS_SECONDS     = "3600"
)
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"
    PUSH_MESSAGE_V2   = "v2"

    // The category is set to handle a set of interactive Actions
    // with the push notifications
    CATEGORY_CAN_REPLY = "CAN_REPLY"

    MHPNS = "https://push.mattermost.com"
)
const (
    PUSH_STATUS           = "status"
    PUSH_STATUS_OK        = "OK"
    PUSH_STATUS_FAIL      = "FAIL"
    PUSH_STATUS_REMOVE    = "REMOVE"
    PUSH_STATUS_ERROR_MSG = "error"
)
const (
    SYSTEM_USER_ROLE_ID              = "system_user"
    SYSTEM_ADMIN_ROLE_ID             = "system_admin"
    SYSTEM_POST_ALL_ROLE_ID          = "system_post_all"
    SYSTEM_POST_ALL_PUBLIC_ROLE_ID   = "system_post_all_public"
    SYSTEM_USER_ACCESS_TOKEN_ROLE_ID = "system_user_access_token"

    TEAM_USER_ROLE_ID            = "team_user"
    TEAM_ADMIN_ROLE_ID           = "team_admin"
    TEAM_POST_ALL_ROLE_ID        = "team_post_all"
    TEAM_POST_ALL_PUBLIC_ROLE_ID = "team_post_all_public"

    CHANNEL_USER_ROLE_ID  = "channel_user"
    CHANNEL_ADMIN_ROLE_ID = "channel_admin"

    ROLE_NAME_MAX_LENGTH         = 64
    ROLE_DISPLAY_NAME_MAX_LENGTH = 128
    ROLE_DESCRIPTION_MAX_LENGTH  = 1024
)
const (
    USER_AUTH_SERVICE_SAML      = "saml"
    USER_AUTH_SERVICE_SAML_TEXT = "With SAML"
)
const (
    SCHEME_DISPLAY_NAME_MAX_LENGTH = 128
    SCHEME_NAME_MAX_LENGTH         = 64
    SCHEME_DESCRIPTION_MAX_LENGTH  = 1024
    SCHEME_SCOPE_TEAM              = "team"
    SCHEME_SCOPE_CHANNEL           = "channel"
)
const (
    SESSION_COOKIE_TOKEN              = "MMAUTHTOKEN"
    SESSION_COOKIE_USER               = "MMUSERID"
    SESSION_CACHE_SIZE                = 35000
    SESSION_PROP_PLATFORM             = "platform"
    SESSION_PROP_OS                   = "os"
    SESSION_PROP_BROWSER              = "browser"
    SESSION_PROP_TYPE                 = "type"
    SESSION_PROP_USER_ACCESS_TOKEN_ID = "user_access_token_id"
    SESSION_TYPE_USER_ACCESS_TOKEN    = "UserAccessToken"
    SESSION_ACTIVITY_TIMEOUT          = 1000 * 60 * 5 // 5 minutes
    SESSION_USER_ACCESS_TOKEN_EXPIRY  = 100 * 365     // 100 years
)
const (
    STATUS_OUT_OF_OFFICE   = "ooo"
    STATUS_OFFLINE         = "offline"
    STATUS_AWAY            = "away"
    STATUS_DND             = "dnd"
    STATUS_ONLINE          = "online"
    STATUS_CACHE_SIZE      = SESSION_CACHE_SIZE
    STATUS_CHANNEL_TIMEOUT = 20000  // 20 seconds
    STATUS_MIN_UPDATE_TIME = 120000 // 2 minutes
)
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"
    SYSTEM_ASYMMETRIC_SIGNING_KEY = "AsymmetricSigningKey"
    SYSTEM_INSTALLATION_DATE_KEY  = "InstallationDate"
)
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
)
const (
    TOKEN_SIZE            = 64
    MAX_TOKEN_EXIPRY_TIME = 1000 * 60 * 60 * 24 // 24 hour
    TOKEN_TYPE_OAUTH      = "oauth"
)
const (
    ME                           = "me"
    USER_NOTIFY_ALL              = "all"
    USER_NOTIFY_MENTION          = "mention"
    USER_NOTIFY_NONE             = "none"
    DESKTOP_NOTIFY_PROP          = "desktop"
    DESKTOP_SOUND_NOTIFY_PROP    = "desktop_sound"
    MARK_UNREAD_NOTIFY_PROP      = "mark_unread"
    PUSH_NOTIFY_PROP             = "push"
    PUSH_STATUS_NOTIFY_PROP      = "push_status"
    EMAIL_NOTIFY_PROP            = "email"
    CHANNEL_MENTIONS_NOTIFY_PROP = "channel"
    COMMENTS_NOTIFY_PROP         = "comments"
    MENTION_KEYS_NOTIFY_PROP     = "mention_keys"
    COMMENTS_NOTIFY_NEVER        = "never"
    COMMENTS_NOTIFY_ROOT         = "root"
    COMMENTS_NOTIFY_ANY          = "any"

    DEFAULT_LOCALE          = "en"
    USER_AUTH_SERVICE_EMAIL = "email"

    USER_EMAIL_MAX_LENGTH     = 128
    USER_NICKNAME_MAX_RUNES   = 64
    USER_POSITION_MAX_RUNES   = 128
    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
    USER_PASSWORD_MAX_LENGTH  = 72
)
const (
    LOWERCASE_LETTERS = "abcdefghijklmnopqrstuvwxyz"
    UPPERCASE_LETTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
    NUMBERS           = "0123456789"
    SYMBOLS           = " !\"\\#$%&'()*+,-./:;<=>?@[]^_`|~"
)
const (
    SOCKET_MAX_MESSAGE_SIZE_KB  = 8 * 1024 // 8KB
    PING_TIMEOUT_BUFFER_SECONDS = 5
)
const (
    WEBSOCKET_EVENT_TYPING                  = "typing"
    WEBSOCKET_EVENT_POSTED                  = "posted"
    WEBSOCKET_EVENT_POST_EDITED             = "post_edited"
    WEBSOCKET_EVENT_POST_DELETED            = "post_deleted"
    WEBSOCKET_EVENT_CHANNEL_CONVERTED       = "channel_converted"
    WEBSOCKET_EVENT_CHANNEL_CREATED         = "channel_created"
    WEBSOCKET_EVENT_CHANNEL_DELETED         = "channel_deleted"
    WEBSOCKET_EVENT_CHANNEL_UPDATED         = "channel_updated"
    WEBSOCKET_EVENT_CHANNEL_MEMBER_UPDATED  = "channel_member_updated"
    WEBSOCKET_EVENT_DIRECT_ADDED            = "direct_added"
    WEBSOCKET_EVENT_GROUP_ADDED             = "group_added"
    WEBSOCKET_EVENT_NEW_USER                = "new_user"
    WEBSOCKET_EVENT_ADDED_TO_TEAM           = "added_to_team"
    WEBSOCKET_EVENT_LEAVE_TEAM              = "leave_team"
    WEBSOCKET_EVENT_UPDATE_TEAM             = "update_team"
    WEBSOCKET_EVENT_DELETE_TEAM             = "delete_team"
    WEBSOCKET_EVENT_USER_ADDED              = "user_added"
    WEBSOCKET_EVENT_USER_UPDATED            = "user_updated"
    WEBSOCKET_EVENT_USER_ROLE_UPDATED       = "user_role_updated"
    WEBSOCKET_EVENT_MEMBERROLE_UPDATED      = "memberrole_updated"
    WEBSOCKET_EVENT_USER_REMOVED            = "user_removed"
    WEBSOCKET_EVENT_PREFERENCE_CHANGED      = "preference_changed"
    WEBSOCKET_EVENT_PREFERENCES_CHANGED     = "preferences_changed"
    WEBSOCKET_EVENT_PREFERENCES_DELETED     = "preferences_deleted"
    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"
    WEBSOCKET_EVENT_RESPONSE                = "response"
    WEBSOCKET_EVENT_EMOJI_ADDED             = "emoji_added"
    WEBSOCKET_EVENT_CHANNEL_VIEWED          = "channel_viewed"
    WEBSOCKET_EVENT_PLUGIN_STATUSES_CHANGED = "plugin_statuses_changed"
    WEBSOCKET_EVENT_PLUGIN_ENABLED          = "plugin_enabled"
    WEBSOCKET_EVENT_PLUGIN_DISABLED         = "plugin_disabled"
    WEBSOCKET_EVENT_ROLE_UPDATED            = "role_updated"
    WEBSOCKET_EVENT_LICENSE_CHANGED         = "license_changed"
    WEBSOCKET_EVENT_CONFIG_CHANGED          = "config_changed"
)
const (
    COMMAND_WEBHOOK_LIFETIME = 1000 * 60 * 30
)
const (
    DEFAULT_WEBHOOK_USERNAME = "webhook"
)
const (
    MIGRATION_KEY_ADVANCED_PERMISSIONS_PHASE_2 = "migration_advanced_permissions_phase_2"
)
const (
    MaxImageSize = 6048 * 4032 // 24 megapixels, roughly 36MB as a raw image
)
const OUTGOING_HOOK_RESPONSE_TYPE_COMMENT = "comment"
const TERMS_OF_SERVICE_CACHE_SIZE = 1

we only ever need the latest version of terms of service

const (
    USER_AUTH_SERVICE_GITLAB = "gitlab"
)
const (
    USER_AUTH_SERVICE_LDAP = "ldap"
)

Variables

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"}
)
var ALL_PERMISSIONS []*Permission
var BuildDate string
var BuildEnterpriseReady string
var BuildHash string
var BuildHashEnterprise string
var BuildNumber string
var CurrentVersion string = versions[0]
var DefaultSupportedTimezones = []string{ /* 594 elements not displayed */

}
var SystemEmojis = map[string]string{ /* 2383 elements not displayed */ }

func AppErrorInit Uses

func AppErrorInit(t goi18n.TranslateFunc)

func ArrayFromInterface Uses

func ArrayFromInterface(data interface{}) []string

func ArrayFromJson Uses

func ArrayFromJson(data io.Reader) []string

func ArrayToJson Uses

func ArrayToJson(objmap []string) string

func ChannelMentions Uses

func ChannelMentions(message string) []string

func CheckStatusOK Uses

func CheckStatusOK(r *http.Response) bool

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

func CleanTeamName Uses

func CleanTeamName(s string) string

func CleanUsername Uses

func CleanUsername(s string) string

func ClearMentionTags Uses

func ClearMentionTags(post string) string

func ClusterInfosToJson Uses

func ClusterInfosToJson(objmap []*ClusterInfo) string

func CommandListToJson Uses

func CommandListToJson(l []*Command) string

func ComparePassword Uses

func ComparePassword(hash string, password string) bool

ComparePassword compares the hash

func CompliancePostHeader Uses

func CompliancePostHeader() []string

func CopyStringMap Uses

func CopyStringMap(originalMap map[string]string) map[string]string

func DefaultUserTimezone Uses

func DefaultUserTimezone() map[string]string

func EmojiListToJson Uses

func EmojiListToJson(emojiList []*Emoji) string

func Etag Uses

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

func FileInfosToJson Uses

func FileInfosToJson(infos []*FileInfo) string

func GetDMNameFromIds Uses

func GetDMNameFromIds(userId1, userId2 string) string

func GetEndOfDayMillis Uses

func GetEndOfDayMillis(thisTime time.Time, timeZoneOffset int) int64

GetEndOfDayMillis is a convenience method to get milliseconds since epoch for provided date's end of day

func GetEtagForFileInfos Uses

func GetEtagForFileInfos(infos []*FileInfo) string

func GetGroupDisplayNameFromUsers Uses

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

func GetGroupNameFromUserIds Uses

func GetGroupNameFromUserIds(userIds []string) string

func GetImageMimeType Uses

func GetImageMimeType(ext string) string

func GetInfoForBytes Uses

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

func GetMillis Uses

func GetMillis() int64

GetMillis is a convenience method to get milliseconds since epoch.

func GetMillisForTime Uses

func GetMillisForTime(thisTime time.Time) int64

GetMillisForTime is a convenience method to get milliseconds since epoch for provided Time.

func GetPreferredTimezone Uses

func GetPreferredTimezone(timezone StringMap) string

func GetPreviousVersion Uses

func GetPreviousVersion(version string) string

func GetServerIpAddress Uses

func GetServerIpAddress() string

func GetStartOfDayMillis Uses

func GetStartOfDayMillis(thisTime time.Time, timeZoneOffset int) int64

GetStartOfDayMillis is a convenience method to get milliseconds since epoch for provided date's start of day

func HashPassword Uses

func HashPassword(password string) string

HashPassword generates a hash using the bcrypt.GenerateFromPassword

func IncomingWebhookListToJson Uses

func IncomingWebhookListToJson(l []*IncomingWebhook) string

func IncomingWebhookRequestFromJson Uses

func IncomingWebhookRequestFromJson(data io.Reader) (*IncomingWebhookRequest, *AppError)

func IsChannelMarkUnreadLevelValid Uses

func IsChannelMarkUnreadLevelValid(markUnreadLevel string) bool

func IsChannelNotifyLevelValid Uses

func IsChannelNotifyLevelValid(notifyLevel string) bool

func IsCurrentVersion Uses

func IsCurrentVersion(versionToCheck string) bool

func IsDomainName Uses

func IsDomainName(s string) bool

Copied from https://golang.org/src/net/dnsclient.go#L119

func IsFileExtImage Uses

func IsFileExtImage(ext string) bool

func IsInRole Uses

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 Uses

func IsLower(s string) bool

func IsPreviousVersionsSupported Uses

func IsPreviousVersionsSupported(versionToCheck string) bool

func IsReservedTeamName Uses

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

func IsSendEmailValid Uses

func IsSendEmailValid(sendEmail string) bool

func IsValidAlphaNum Uses

func IsValidAlphaNum(s string) bool

func IsValidAlphaNumHyphenUnderscore Uses

func IsValidAlphaNumHyphenUnderscore(s string, withFormat bool) bool

func IsValidChannelIdentifier Uses

func IsValidChannelIdentifier(s string) bool

func IsValidCommentsNotifyLevel Uses

func IsValidCommentsNotifyLevel(notifyLevel string) bool

func IsValidEmail Uses

func IsValidEmail(email string) bool

func IsValidEmailBatchingInterval Uses

func IsValidEmailBatchingInterval(emailInterval string) bool

func IsValidHttpUrl Uses

func IsValidHttpUrl(rawUrl string) bool

func IsValidId Uses

func IsValidId(value string) bool

func IsValidNumberString Uses

func IsValidNumberString(value string) bool

func IsValidPushStatusNotifyLevel Uses

func IsValidPushStatusNotifyLevel(notifyLevel string) bool

func IsValidRoleName Uses

func IsValidRoleName(roleName string) bool

func IsValidSchemeName Uses

func IsValidSchemeName(name string) bool

func IsValidTeamName Uses

func IsValidTeamName(s string) bool

func IsValidTrueOrFalseString Uses

func IsValidTrueOrFalseString(value string) bool

func IsValidTurnOrStunServer Uses

func IsValidTurnOrStunServer(rawUri string) bool

func IsValidUserNotifyLevel Uses

func IsValidUserNotifyLevel(notifyLevel string) bool

func IsValidUserRoles Uses

func IsValidUserRoles(userRoles string) bool

func IsValidUsername Uses

func IsValidUsername(s string) bool

func IsValidWebsocketUrl Uses

func IsValidWebsocketUrl(rawUrl string) bool

func JobsToJson Uses

func JobsToJson(jobs []*Job) string

func MakeDefaultRoles Uses

func MakeDefaultRoles() map[string]*Role

func ManifestListToJson Uses

func ManifestListToJson(m []*Manifest) string

func MapBoolFromJson Uses

func MapBoolFromJson(data io.Reader) map[string]bool

MapFromJson will decode the key/value pair map

func MapBoolToJson Uses

func MapBoolToJson(objmap map[string]bool) string

MapToJson converts a map to a json string

func MapFromJson Uses

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

MapFromJson will decode the key/value pair map

func MapToJson Uses

func MapToJson(objmap map[string]string) string

MapToJson converts a map to a json string

func NewBool Uses

func NewBool(b bool) *bool

func NewId Uses

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 NewInt Uses

func NewInt(n int) *int

func NewInt64 Uses

func NewInt64(n int64) *int64

func NewRandomString Uses

func NewRandomString(length int) string

func NewString Uses

func NewString(s string) *string

func NewWebSocketClient Uses

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

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

func NewWebSocketClient4 Uses

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

NewWebSocketClient4 constructs a new WebSocket client with convenience methods for talking to the server. Uses the v4 endpoint.

func NewWebSocketClient4WithDialer Uses

func NewWebSocketClient4WithDialer(dialer *websocket.Dialer, url, authToken string) (*WebSocketClient, *AppError)

NewWebSocketClient4WithDialer constructs a new WebSocket client with convenience methods for talking to the server using a custom dialer. Uses the v4 endpoint.

func NewWebSocketClientWithDialer Uses

func NewWebSocketClientWithDialer(dialer *websocket.Dialer, url, authToken string) (*WebSocketClient, *AppError)

NewWebSocketClientWithDialer constructs a new WebSocket client with convenience methods for talking to the server using a custom dialer.

func NormalizeEmail Uses

func NormalizeEmail(email string) string

func NormalizeUsername Uses

func NormalizeUsername(username string) string

func OAuthAppListToJson Uses

func OAuthAppListToJson(l []*OAuthApp) string

func OutgoingWebhookListToJson Uses

func OutgoingWebhookListToJson(l []*OutgoingWebhook) string

func PadDateStringZeros Uses

func PadDateStringZeros(dateString string) string

PadDateStringZeros is a convenience method to pad 2 digit date parts with zeros to meet ISO 8601 format

func ParseHashtags Uses

func ParseHashtags(text string) (string, string)

func ParseSlackAttachment Uses

func ParseSlackAttachment(post *Post, attachments []*SlackAttachment)

This method only parses and processes the attachments, all else should be set in the post which is passed

func ParseSlackLinksToMarkdown Uses

func ParseSlackLinksToMarkdown(text string) string

func PermissionsChangedByPatch Uses

func PermissionsChangedByPatch(role *Role, patch *RolePatch) []string

Returns an array of permissions that are in either role.Permissions or patch.Permissions, but not both.

func ReactionsToJson Uses

func ReactionsToJson(o []*Reaction) string

func RemoveDuplicateStrings Uses

func RemoveDuplicateStrings(in []string) []string

func RewriteImageURLs Uses

func RewriteImageURLs(message string, f func(string) string) string

RewriteImageURLs takes a message and returns a copy that has all of the image URLs replaced according to the function f. For each image URL, f will be invoked, and the resulting markdown will contain the URL returned by that invocation instead.

Image URLs are destination URLs used in inline images or reference definitions that are used anywhere in the input markdown as an image.

func RoleListToJson Uses

func RoleListToJson(r []*Role) string

func SchemeIDFromJson Uses

func SchemeIDFromJson(data io.Reader) *string

func SchemesToJson Uses

func SchemesToJson(schemes []*Scheme) string

func SessionsToJson Uses

func SessionsToJson(o []*Session) string

func SplitVersion Uses

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

func StatusListToJson Uses

func StatusListToJson(u []*Status) string

func StatusMapToInterfaceMap Uses

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

func StringFromJson Uses

func StringFromJson(data io.Reader) string

func StringInterfaceFromJson Uses

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

func StringInterfaceToJson Uses

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

func StringToJson Uses

func StringToJson(s string) string

func TeamListToJson Uses

func TeamListToJson(t []*Team) string

func TeamMapFromJson Uses

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

func TeamMapToJson Uses

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

func TeamMembersToJson Uses

func TeamMembersToJson(o []*TeamMember) string

func TeamsUnreadToJson Uses

func TeamsUnreadToJson(o []*TeamUnread) string

func TimezonesToJson Uses

func TimezonesToJson(timezoneList []string) string

func UserAccessTokenListToJson Uses

func UserAccessTokenListToJson(t []*UserAccessToken) string

func UserListToJson Uses

func UserListToJson(u []*User) string

func UserMapFromJson Uses

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

func UserMapToJson Uses

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

type AccessData Uses

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"`
    Scope        string `json:"scope"`
}

func AccessDataFromJson Uses

func AccessDataFromJson(data io.Reader) *AccessData

func (*AccessData) IsExpired Uses

func (me *AccessData) IsExpired() bool

func (*AccessData) IsValid Uses

func (ad *AccessData) IsValid() *AppError

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

func (*AccessData) ToJson Uses

func (ad *AccessData) ToJson() string

type AccessResponse Uses

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 Uses

func AccessResponseFromJson(data io.Reader) *AccessResponse

func (*AccessResponse) ToJson Uses

func (ar *AccessResponse) ToJson() string

type AnalyticsRow Uses

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

func AnalyticsRowFromJson Uses

func AnalyticsRowFromJson(data io.Reader) *AnalyticsRow

func (*AnalyticsRow) ToJson Uses

func (me *AnalyticsRow) ToJson() string

type AnalyticsRows Uses

type AnalyticsRows []*AnalyticsRow

func AnalyticsRowsFromJson Uses

func AnalyticsRowsFromJson(data io.Reader) AnalyticsRows

func (AnalyticsRows) ToJson Uses

func (me AnalyticsRows) ToJson() string

type AnalyticsSettings Uses

type AnalyticsSettings struct {
    MaxUsersForStatistics *int
}

func (*AnalyticsSettings) SetDefaults Uses

func (s *AnalyticsSettings) SetDefaults()

type AnnouncementSettings Uses

type AnnouncementSettings struct {
    EnableBanner         *bool
    BannerText           *string
    BannerColor          *string
    BannerTextColor      *string
    AllowBannerDismissal *bool
}

func (*AnnouncementSettings) SetDefaults Uses

func (s *AnnouncementSettings) SetDefaults()

type AppError Uses

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 Uses

func AppErrorFromJson(data io.Reader) *AppError

AppErrorFromJson will decode the input and return an AppError

func InvalidTermsOfServiceError Uses

func InvalidTermsOfServiceError(fieldName string, termsOfServiceId string) *AppError

func InvalidUserError Uses

func InvalidUserError(fieldName string, userId string) *AppError

func IsValidEmojiName Uses

func IsValidEmojiName(name string) *AppError

func NewAppError Uses

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

func (*AppError) Error Uses

func (er *AppError) Error() string

func (*AppError) SystemMessage Uses

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

func (*AppError) ToJson Uses

func (er *AppError) ToJson() string

func (*AppError) Translate Uses

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

type Audit Uses

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 Uses

func AuditFromJson(data io.Reader) *Audit

func (*Audit) ToJson Uses

func (o *Audit) ToJson() string

type Audits Uses

type Audits []Audit

func AuditsFromJson Uses

func AuditsFromJson(data io.Reader) Audits

func (Audits) Etag Uses

func (o Audits) Etag() string

func (Audits) ToJson Uses

func (o Audits) ToJson() string

type AuthData Uses

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 Uses

func AuthDataFromJson(data io.Reader) *AuthData

func (*AuthData) IsExpired Uses

func (ad *AuthData) IsExpired() bool

func (*AuthData) IsValid Uses

func (ad *AuthData) IsValid() *AppError

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

func (*AuthData) PreSave Uses

func (ad *AuthData) PreSave()

func (*AuthData) ToJson Uses

func (ad *AuthData) ToJson() string

type AuthorizeRequest Uses

type AuthorizeRequest struct {
    ResponseType string `json:"response_type"`
    ClientId     string `json:"client_id"`
    RedirectUri  string `json:"redirect_uri"`
    Scope        string `json:"scope"`
    State        string `json:"state"`
}

func AuthorizeRequestFromJson Uses

func AuthorizeRequestFromJson(data io.Reader) *AuthorizeRequest

func (*AuthorizeRequest) IsValid Uses

func (ar *AuthorizeRequest) IsValid() *AppError

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

func (*AuthorizeRequest) ToJson Uses

func (ar *AuthorizeRequest) ToJson() string

type BundleInfo Uses

type BundleInfo struct {
    Path string

    Manifest      *Manifest
    ManifestPath  string
    ManifestError error
}

func BundleInfoForPath Uses

func BundleInfoForPath(path string) *BundleInfo

Returns bundle info for the given path. The return value is never nil.

func (*BundleInfo) WrapLogger Uses

func (b *BundleInfo) WrapLogger(logger *mlog.Logger) *mlog.Logger

type Channel Uses

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"`
    SchemeId      *string                `json:"scheme_id"`
    Props         map[string]interface{} `json:"props" db:"-"`
}

func ChannelFromJson Uses

func ChannelFromJson(data io.Reader) *Channel

func ChannelSliceFromJson Uses

func ChannelSliceFromJson(data io.Reader) []*Channel

func (*Channel) AddProp Uses

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

func (*Channel) DeepCopy Uses

func (o *Channel) DeepCopy() *Channel

func (*Channel) Etag Uses

func (o *Channel) Etag() string

func (*Channel) IsGroupOrDirect Uses

func (o *Channel) IsGroupOrDirect() bool

func (*Channel) IsValid Uses

func (o *Channel) IsValid() *AppError

func (*Channel) MakeNonNil Uses

func (o *Channel) MakeNonNil()

func (*Channel) Patch Uses

func (o *Channel) Patch(patch *ChannelPatch)

func (*Channel) PreSave Uses

func (o *Channel) PreSave()

func (*Channel) PreUpdate Uses

func (o *Channel) PreUpdate()

func (*Channel) ToJson Uses

func (o *Channel) ToJson() string

type ChannelCounts Uses

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

func ChannelCountsFromJson Uses

func ChannelCountsFromJson(data io.Reader) *ChannelCounts

func (*ChannelCounts) Etag Uses

func (o *ChannelCounts) Etag() string

func (*ChannelCounts) ToJson Uses

func (o *ChannelCounts) ToJson() string

type ChannelData Uses

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

func ChannelDataFromJson Uses

func ChannelDataFromJson(data io.Reader) *ChannelData

func (*ChannelData) Etag Uses

func (o *ChannelData) Etag() string

func (*ChannelData) ToJson Uses

func (o *ChannelData) ToJson() string

type ChannelForExport Uses

type ChannelForExport struct {
    Channel
    TeamName   string
    SchemeName *string
}

type ChannelList Uses

type ChannelList []*Channel

func ChannelListFromJson Uses

func ChannelListFromJson(data io.Reader) *ChannelList

func (*ChannelList) Etag Uses

func (o *ChannelList) Etag() string

func (*ChannelList) ToJson Uses

func (o *ChannelList) ToJson() string

type ChannelMember Uses

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"`
    SchemeUser    bool      `json:"scheme_user"`
    SchemeAdmin   bool      `json:"scheme_admin"`
    ExplicitRoles string    `json:"explicit_roles"`
}

func ChannelMemberFromJson Uses

func ChannelMemberFromJson(data io.Reader) *ChannelMember

func (*ChannelMember) GetRoles Uses

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

func (*ChannelMember) IsValid Uses

func (o *ChannelMember) IsValid() *AppError

func (*ChannelMember) PreSave Uses

func (o *ChannelMember) PreSave()

func (*ChannelMember) PreUpdate Uses

func (o *ChannelMember) PreUpdate()

func (*ChannelMember) ToJson Uses

func (o *ChannelMember) ToJson() string

type ChannelMemberForExport Uses

type ChannelMemberForExport struct {
    ChannelMember
    ChannelName string
}

type ChannelMemberHistory Uses

type ChannelMemberHistory struct {
    ChannelId string
    UserId    string
    JoinTime  int64
    LeaveTime *int64
}

type ChannelMemberHistoryResult Uses

type ChannelMemberHistoryResult struct {
    ChannelId string
    UserId    string
    JoinTime  int64
    LeaveTime *int64

    // these two fields are never set in the database - when we SELECT, we join on Users to get them
    UserEmail string `db:"Email"`
    Username  string
}

type ChannelMembers Uses

type ChannelMembers []ChannelMember

func ChannelMembersFromJson Uses

func ChannelMembersFromJson(data io.Reader) *ChannelMembers

func (*ChannelMembers) ToJson Uses

func (o *ChannelMembers) ToJson() string

type ChannelPatch Uses

type ChannelPatch struct {
    DisplayName *string `json:"display_name"`
    Name        *string `json:"name"`
    Header      *string `json:"header"`
    Purpose     *string `json:"purpose"`
}

func ChannelPatchFromJson Uses

func ChannelPatchFromJson(data io.Reader) *ChannelPatch

func (*ChannelPatch) ToJson Uses

func (o *ChannelPatch) ToJson() string

type ChannelSearch Uses

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

func ChannelSearchFromJson Uses

func ChannelSearchFromJson(data io.Reader) *ChannelSearch

ChannelSearchFromJson will decode the input and return a Channel

func (*ChannelSearch) ToJson Uses

func (c *ChannelSearch) ToJson() string

ToJson convert a Channel to a json string

type ChannelStats Uses

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

func ChannelStatsFromJson Uses

func ChannelStatsFromJson(data io.Reader) *ChannelStats

func (*ChannelStats) ToJson Uses

func (o *ChannelStats) ToJson() string

type ChannelUnread Uses

type ChannelUnread struct {
    TeamId       string    `json:"team_id"`
    ChannelId    string    `json:"channel_id"`
    MsgCount     int64     `json:"msg_count"`
    MentionCount int64     `json:"mention_count"`
    NotifyProps  StringMap `json:"-"`
}

func ChannelUnreadFromJson Uses

func ChannelUnreadFromJson(data io.Reader) *ChannelUnread

func (*ChannelUnread) ToJson Uses

func (o *ChannelUnread) ToJson() string

type ChannelView Uses

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

func ChannelViewFromJson Uses

func ChannelViewFromJson(data io.Reader) *ChannelView

func (*ChannelView) ToJson Uses

func (o *ChannelView) ToJson() string

type ChannelViewResponse Uses

type ChannelViewResponse struct {
    Status            string           `json:"status"`
    LastViewedAtTimes map[string]int64 `json:"last_viewed_at_times"`
}

func ChannelViewResponseFromJson Uses

func ChannelViewResponseFromJson(data io.Reader) *ChannelViewResponse

func (*ChannelViewResponse) ToJson Uses

func (o *ChannelViewResponse) ToJson() string

type Client4 Uses

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
    HttpHeader map[string]string // Headers to be copied over for each request
}

func NewAPIv4Client Uses

func NewAPIv4Client(url string) *Client4

func (*Client4) AddChannelMember Uses

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

AddChannelMember adds user to channel and return a channel member.

func (*Client4) AddChannelMemberWithRootId Uses

func (c *Client4) AddChannelMemberWithRootId(channelId, userId, postRootId string) (*ChannelMember, *Response)

AddChannelMemberWithRootId adds user to channel and return a channel member. Post add to channel message has the postRootId.

func (*Client4) AddTeamMember Uses

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

AddTeamMember adds user to a team and return a team member.

func (*Client4) AddTeamMemberFromInvite Uses

func (c *Client4) AddTeamMemberFromInvite(token, inviteId string) (*TeamMember, *Response)

AddTeamMemberFromInvite adds a user to a team and return a team member using an invite id or an invite token/data pair.

func (*Client4) AddTeamMembers Uses

func (c *Client4) AddTeamMembers(teamId string, userIds []string) ([]*TeamMember, *Response)

AddTeamMembers adds a number of users to a team and returns the team members.

func (*Client4) AttachDeviceId Uses

func (c *Client4) AttachDeviceId(deviceId string) (bool, *Response)

AttachDeviceId attaches a mobile device ID to the current session.

func (*Client4) AuthorizeOAuthApp Uses

func (c *Client4) AuthorizeOAuthApp(authRequest *AuthorizeRequest) (string, *Response)

AuthorizeOAuthApp will authorize an OAuth 2.0 client application to access a user's account and provide a redirect link to follow.

func (*Client4) AutocompleteChannelsForTeam Uses

func (c *Client4) AutocompleteChannelsForTeam(teamId, name string) (*ChannelList, *Response)

AutocompleteChannelsForTeam will return an ordered list of channels autocomplete suggestions

func (*Client4) AutocompleteChannelsForTeamForSearch Uses

func (c *Client4) AutocompleteChannelsForTeamForSearch(teamId, name string) (*ChannelList, *Response)

AutocompleteChannelsForTeamForSearch will return an ordered list of your channels autocomplete suggestions

func (*Client4) AutocompleteEmoji Uses

func (c *Client4) AutocompleteEmoji(name string, etag string) ([]*Emoji, *Response)

AutocompleteEmoji returns a list of emoji starting with or matching name.

func (*Client4) AutocompleteUsers Uses

func (c *Client4) AutocompleteUsers(username string, etag string) (*UserAutocomplete, *Response)

AutocompleteUsers returns the users in the system based on search term.

func (*Client4) AutocompleteUsersInChannel Uses

func (c *Client4) AutocompleteUsersInChannel(teamId string, channelId string, username string, etag string) (*UserAutocomplete, *Response)

AutocompleteUsersInChannel returns the users in a channel based on search term.

func (*Client4) AutocompleteUsersInTeam Uses

func (c *Client4) AutocompleteUsersInTeam(teamId string, username string, etag string) (*UserAutocomplete, *Response)

AutocompleteUsersInTeam returns the users on a team based on search term.

func (*Client4) CancelJob Uses

func (c *Client4) CancelJob(jobId string) (bool, *Response)

CancelJob requests the cancellation of the job with the provided Id.

func (*Client4) CheckUserMfa Uses

func (c *Client4) CheckUserMfa(loginId string) (bool, *Response)

CheckUserMfa checks whether a user has MFA active on their account or not based on the provided login id.

func (*Client4) ClearOAuthToken Uses

func (c *Client4) ClearOAuthToken()

func (*Client4) ConvertChannelToPrivate Uses

func (c *Client4) ConvertChannelToPrivate(channelId string) (*Channel, *Response)

ConvertChannelToPrivate converts public to private channel.

func (*Client4) CreateChannel Uses

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

CreateChannel creates a channel based on the provided channel struct.

func (*Client4) CreateCommand Uses

func (c *Client4) CreateCommand(cmd *Command) (*Command, *Response)

CreateCommand will create a new command if the user have the right permissions.

func (*Client4) CreateComplianceReport Uses

func (c *Client4) CreateComplianceReport(report *Compliance) (*Compliance, *Response)

CreateComplianceReport creates an incoming webhook for a channel.

func (*Client4) CreateDirectChannel Uses

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

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

func (*Client4) CreateEmoji Uses

func (c *Client4) CreateEmoji(emoji *Emoji, image []byte, filename string) (*Emoji, *Response)

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 (*Client4) CreateGroupChannel Uses

func (c *Client4) CreateGroupChannel(userIds []string) (*Channel, *Response)

CreateGroupChannel creates a group message channel based on userIds provided

func (*Client4) CreateIncomingWebhook Uses

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

CreateIncomingWebhook creates an incoming webhook for a channel.

func (*Client4) CreateJob Uses

func (c *Client4) CreateJob(job *Job) (*Job, *Response)

CreateJob creates a job based on the provided job struct.

func (*Client4) CreateOAuthApp Uses

func (c *Client4) CreateOAuthApp(app *OAuthApp) (*OAuthApp, *Response)

CreateOAuthApp will register a new OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.

func (*Client4) CreateOutgoingWebhook Uses

func (c *Client4) CreateOutgoingWebhook(hook *OutgoingWebhook) (*OutgoingWebhook, *Response)

CreateOutgoingWebhook creates an outgoing webhook for a team or channel.

func (*Client4) CreatePost Uses

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

CreatePost creates a post based on the provided post struct.

func (*Client4) CreatePostEphemeral Uses

func (c *Client4) CreatePostEphemeral(post *PostEphemeral) (*Post, *Response)

CreatePostEphemeral creates a ephemeral post based on the provided post struct which is send to the given user id

func (*Client4) CreateScheme Uses

func (c *Client4) CreateScheme(scheme *Scheme) (*Scheme, *Response)

CreateScheme creates a new Scheme.

func (*Client4) CreateTeam Uses

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

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

func (*Client4) CreateTermsOfService Uses

func (c *Client4) CreateTermsOfService(text, userId string) (*TermsOfService, *Response)

func (*Client4) CreateUser Uses

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

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

func (*Client4) CreateUserAccessToken Uses

func (c *Client4) CreateUserAccessToken(userId, description string) (*UserAccessToken, *Response)

CreateUserAccessToken will generate a user access token that can be used in place of a session token to access the REST API. Must have the 'create_user_access_token' permission and if generating for another user, must have the 'edit_other_users' permission. A non-blank description is required.

func (*Client4) CreateUserWithInviteId Uses

func (c *Client4) CreateUserWithInviteId(user *User, inviteId string) (*User, *Response)

CreateUserWithInviteId creates a user in the system based on the provided invited id.

func (*Client4) CreateUserWithToken Uses

func (c *Client4) CreateUserWithToken(user *User, tokenId string) (*User, *Response)

CreateUserWithToken creates a user in the system based on the provided tokenId.

func (*Client4) DatabaseRecycle Uses

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

DatabaseRecycle will recycle the connections. Discard current connection and get new one.

func (*Client4) DeauthorizeOAuthApp Uses

func (c *Client4) DeauthorizeOAuthApp(appId string) (bool, *Response)

DeauthorizeOAuthApp will deauthorize an OAuth 2.0 client application from accessing a user's account.

func (*Client4) DeleteChannel Uses

func (c *Client4) DeleteChannel(channelId string) (bool, *Response)

DeleteChannel deletes channel based on the provided channel id string.

func (*Client4) DeleteCommand Uses

func (c *Client4) DeleteCommand(commandId string) (bool, *Response)

DeleteCommand deletes a command based on the provided command id string

func (*Client4) DeleteEmoji Uses

func (c *Client4) DeleteEmoji(emojiId string) (bool, *Response)

DeleteEmoji delete an custom emoji on the provided emoji id string.

func (*Client4) DeleteIncomingWebhook Uses

func (c *Client4) DeleteIncomingWebhook(hookID string) (bool, *Response)

DeleteIncomingWebhook deletes and Incoming Webhook given the hook ID

func (*Client4) DeleteOAuthApp Uses

func (c *Client4) DeleteOAuthApp(appId string) (bool, *Response)

DeleteOAuthApp deletes a registered OAuth 2.0 client application.

func (*Client4) DeleteOutgoingWebhook Uses

func (c *Client4) DeleteOutgoingWebhook(hookId string) (bool, *Response)

DeleteOutgoingWebhook delete the outgoing webhook on the system requested by Hook Id.

func (*Client4) DeletePost Uses

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

DeletePost deletes a post from the provided post id string.

func (*Client4) DeletePreferences Uses

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

DeletePreferences deletes the user's preferences.

func (*Client4) DeleteReaction Uses

func (c *Client4) DeleteReaction(reaction *Reaction) (bool, *Response)

DeleteReaction deletes reaction of a user in a post.

func (*Client4) DeleteSamlIdpCertificate Uses

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

DeleteSamlIdpCertificate deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.

func (*Client4) DeleteSamlPrivateCertificate Uses

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

DeleteSamlPrivateCertificate deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.

func (*Client4) DeleteSamlPublicCertificate Uses

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

DeleteSamlPublicCertificate deletes the SAML IDP certificate from the server and updates the config to not use it and disable SAML.

func (*Client4) DeleteScheme Uses

func (c *Client4) DeleteScheme(id string) (bool, *Response)

DeleteScheme deletes a single scheme by ID.

func (*Client4) DeleteUser Uses

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

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

func (*Client4) DisablePlugin Uses

func (c *Client4) DisablePlugin(id string) (bool, *Response)

DeactivatePlugin will deactivate an active plugin. WARNING: PLUGINS ARE STILL EXPERIMENTAL. THIS FUNCTION IS SUBJECT TO CHANGE.

func (*Client4) DisableUserAccessToken Uses

func (c *Client4) DisableUserAccessToken(tokenId string) (bool, *Response)

DisableUserAccessToken will disable a user access token by id. Must have the 'revoke_user_access_token' permission and if disabling for another user, must have the 'edit_other_users' permission.

func (*Client4) DoApiDelete Uses

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

func (*Client4) DoApiGet Uses

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

func (*Client4) DoApiPost Uses

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

func (*Client4) DoApiPut Uses

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

func (*Client4) DoApiRequest Uses

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

func (*Client4) DoEmojiUploadFile Uses

func (c *Client4) DoEmojiUploadFile(url string, data []byte, contentType string) (*Emoji, *Response)

func (*Client4) DoPostAction Uses

func (c *Client4) DoPostAction(postId, actionId string) (bool, *Response)

DoPostAction performs a post action.

func (*Client4) DoUploadFile Uses

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

func (*Client4) DoUploadImportTeam Uses

func (c *Client4) DoUploadImportTeam(url string, data []byte, contentType string) (map[string]string, *Response)

func (*Client4) DownloadComplianceReport Uses

func (c *Client4) DownloadComplianceReport(reportId string) ([]byte, *Response)

DownloadComplianceReport returns a full compliance report as a file.

func (*Client4) DownloadFile Uses

func (c *Client4) DownloadFile(fileId string, download bool) ([]byte, *Response)

DownloadFile gets the bytes for a file by id, optionally adding headers to force the browser to download it

func (*Client4) DownloadFilePreview Uses

func (c *Client4) DownloadFilePreview(fileId string, download bool) ([]byte, *Response)

DownloadFilePreview gets the bytes for a file by id.

func (*Client4) DownloadFileThumbnail Uses

func (c *Client4) DownloadFileThumbnail(fileId string, download bool) ([]byte, *Response)

DownloadFileThumbnail gets the bytes for a file by id, optionally adding headers to force the browser to download it.

func (*Client4) EnablePlugin Uses

func (c *Client4) EnablePlugin(id string) (bool, *Response)

ActivatePlugin will activate an plugin installed. WARNING: PLUGINS ARE STILL EXPERIMENTAL. THIS FUNCTION IS SUBJECT TO CHANGE.

func (*Client4) EnableUserAccessToken Uses

func (c *Client4) EnableUserAccessToken(tokenId string) (bool, *Response)

EnableUserAccessToken will enable a user access token by id. Must have the 'create_user_access_token' permission and if enabling for another user, must have the 'edit_other_users' permission.

func (*Client4) ExecuteCommand Uses

func (c *Client4) ExecuteCommand(channelId, command string) (*CommandResponse, *Response)

ExecuteCommand executes a given slash command.

func (*Client4) ExecuteCommandWithTeam Uses

func (c *Client4) ExecuteCommandWithTeam(channelId, teamId, command string) (*CommandResponse, *Response)

ExecuteCommand executes a given slash command against the specified team Use this when executing slash commands in a DM/GM, since the team id cannot be inferred in that case

func (*Client4) GenerateMfaSecret Uses

func (c *Client4) GenerateMfaSecret(userId string) (*MfaSecret, *Response)

GenerateMfaSecret will generate a new MFA secret for a user and return it as a string and as a base64 encoded image QR code.

func (*Client4) GetAllTeams Uses

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

GetAllTeams returns all teams based on permissions.

func (*Client4) GetAnalyticsOld Uses

func (c *Client4) GetAnalyticsOld(name, teamId string) (AnalyticsRows, *Response)

GetAnalyticsOld will retrieve analytics using the old format. New format is not available but the "/analytics" endpoint is reserved for it. The "name" argument is optional and defaults to "standard". The "teamId" argument is optional and will limit results to a specific team.

func (*Client4) GetAnalyticsRoute Uses

func (c *Client4) GetAnalyticsRoute() string

func (*Client4) GetAudits Uses

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

GetAudits returns a list of audits for the whole system.

func (*Client4) GetAuthorizedOAuthAppsForUser Uses

func (c *Client4) GetAuthorizedOAuthAppsForUser(userId string, page, perPage int) ([]*OAuthApp, *Response)

GetAuthorizedOAuthAppsForUser gets a page of OAuth 2.0 client applications the user has authorized to use access their account.

func (*Client4) GetBrandImage Uses

func (c *Client4) GetBrandImage() ([]byte, *Response)

GetBrandImage retrieves the previously uploaded brand image.

func (*Client4) GetBrandRoute Uses

func (c *Client4) GetBrandRoute() string

func (*Client4) GetCacheRoute Uses

func (c *Client4) GetCacheRoute() string

func (*Client4) GetChannel Uses

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

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

func (*Client4) GetChannelByName Uses

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 Uses

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) GetChannelByNameForTeamNameIncludeDeleted Uses

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

func (*Client4) GetChannelByNameForTeamNameRoute Uses

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

func (*Client4) GetChannelByNameIncludeDeleted Uses

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

func (*Client4) GetChannelByNameRoute Uses

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

func (*Client4) GetChannelMember Uses

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

GetChannelMember gets a channel member.

func (*Client4) GetChannelMemberRoute Uses

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

func (*Client4) GetChannelMembers Uses

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

GetChannelMembers gets a page of channel members.

func (*Client4) GetChannelMembersByIds Uses

func (c *Client4) GetChannelMembersByIds(channelId string, userIds []string) (*ChannelMembers, *Response)

GetChannelMembersByIds gets the channel members in a channel for a list of user ids.

func (*Client4) GetChannelMembersForUser Uses

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 Uses

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

func (*Client4) GetChannelMembersTimezones Uses

func (c *Client4) GetChannelMembersTimezones(channelId string) ([]string, *Response)

GetChannelMembersTimezones gets a list of timezones for a channel.

func (*Client4) GetChannelRoute Uses

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

func (*Client4) GetChannelSchemeRoute Uses

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

func (*Client4) GetChannelStats Uses

func (c *Client4) GetChannelStats(channelId string, etag string) (*ChannelStats, *Response)

GetChannelStats returns statistics for a channel.

func (*Client4) GetChannelUnread Uses

func (c *Client4) GetChannelUnread(channelId, userId string) (*ChannelUnread, *Response)

GetChannelUnread will return a ChannelUnread object that contains the number of unread messages and mentions for a user.

func (*Client4) GetChannelsForScheme Uses

func (c *Client4) GetChannelsForScheme(schemeId string, page int, perPage int) (ChannelList, *Response)

Get the channels using this scheme, sorted alphabetically by display name.

func (*Client4) GetChannelsForTeamForUser Uses

func (c *Client4) GetChannelsForTeamForUser(teamId, userId, etag string) ([]*Channel, *Response)

GetChannelsForTeamForUser returns a list channels of on a team for a user.

func (*Client4) GetChannelsForTeamRoute Uses

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

func (*Client4) GetChannelsRoute Uses

func (c *Client4) GetChannelsRoute() string

func (*Client4) GetClusterRoute Uses

func (c *Client4) GetClusterRoute() string

func (*Client4) GetClusterStatus Uses

func (c *Client4) GetClusterStatus() ([]*ClusterInfo, *Response)

GetClusterStatus returns the status of all the configured cluster nodes.

func (*Client4) GetCommandRoute Uses

func (c *Client4) GetCommandRoute(commandId string) string

func (*Client4) GetCommandsRoute Uses

func (c *Client4) GetCommandsRoute() string

func (*Client4) GetComplianceReport Uses

func (c *Client4) GetComplianceReport(reportId string) (*Compliance, *Response)

GetComplianceReport returns a compliance report.

func (*Client4) GetComplianceReportRoute Uses

func (c *Client4) GetComplianceReportRoute(reportId string) string

func (*Client4) GetComplianceReports Uses

func (c *Client4) GetComplianceReports(page, perPage int) (Compliances, *Response)

GetComplianceReports returns list of compliance reports.

func (*Client4) GetComplianceReportsRoute Uses

func (c *Client4) GetComplianceReportsRoute() string

func (*Client4) GetConfig Uses

func (c *Client4) GetConfig() (*Config, *Response)

GetConfig will retrieve the server config with some sanitized items.

func (*Client4) GetConfigRoute Uses

func (c *Client4) GetConfigRoute() string

func (*Client4) GetDataRetentionPolicy Uses

func (c *Client4) GetDataRetentionPolicy() (*DataRetentionPolicy, *Response)

GetDataRetentionPolicy will get the current server data retention policy details.

func (*Client4) GetDataRetentionRoute Uses

func (c *Client4) GetDataRetentionRoute() string

func (*Client4) GetDatabaseRoute Uses

func (c *Client4) GetDatabaseRoute() string

func (*Client4) GetDefaultProfileImage Uses

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

GetDefaultProfileImage gets the default user's profile image. Must be logged in.

func (*Client4) GetDeletedChannelsForTeam Uses

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

GetDeletedChannelsForTeam returns a list of public channels based on the provided team id string.

func (*Client4) GetElasticsearchRoute Uses

func (c *Client4) GetElasticsearchRoute() string

func (*Client4) GetEmoji Uses

func (c *Client4) GetEmoji(emojiId string) (*Emoji, *Response)

GetEmoji returns a custom emoji based on the emojiId string.

func (*Client4) GetEmojiByName Uses

func (c *Client4) GetEmojiByName(name string) (*Emoji, *Response)

GetEmojiByName returns a custom emoji based on the name string.

func (*Client4) GetEmojiByNameRoute Uses

func (c *Client4) GetEmojiByNameRoute(name string) string

func (*Client4) GetEmojiImage Uses

func (c *Client4) GetEmojiImage(emojiId string) ([]byte, *Response)

GetEmojiImage returns the emoji image.

func (*Client4) GetEmojiList Uses

func (c *Client4) GetEmojiList(page, perPage int) ([]*Emoji, *Response)

GetEmojiList returns a page of custom emoji on the system.

func (*Client4) GetEmojiRoute Uses

func (c *Client4) GetEmojiRoute(emojiId string) string

func (*Client4) GetEmojisRoute Uses

func (c *Client4) GetEmojisRoute() string

func (*Client4) GetEnvironmentConfig Uses

func (c *Client4) GetEnvironmentConfig() (map[string]interface{}, *Response)

GetEnvironmentConfig will retrieve a map mirroring the server configuration where fields are set to true if the corresponding config setting is set through an environment variable. Settings that haven't been set through environment variables will be missing from the map.

func (*Client4) GetFile Uses

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

GetFile gets the bytes for a file by id.

func (*Client4) GetFileInfo Uses

func (c *Client4) GetFileInfo(fileId string) (*FileInfo, *Response)

GetFileInfo gets all the file info objects.

func (*Client4) GetFileInfosForPost Uses

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

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

func (c *Client4) GetFileLink(fileId string) (string, *Response)

GetFileLink gets the public link of a file by id.

func (*Client4) GetFilePreview Uses

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

GetFilePreview gets the bytes for a file by id.

func (*Client4) GetFileRoute Uses

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

func (*Client4) GetFileThumbnail Uses

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

GetFileThumbnail gets the bytes for a file by id.

func (*Client4) GetFilesRoute Uses

func (c *Client4) GetFilesRoute() string

func (*Client4) GetFlaggedPostsForUser Uses

func (c *Client4) GetFlaggedPostsForUser(userId string, page int, perPage int) (*PostList, *Response)

GetFlaggedPostsForUser returns flagged posts of a user based on user id string.

func (*Client4) GetFlaggedPostsForUserInChannel Uses

func (c *Client4) GetFlaggedPostsForUserInChannel(userId string, channelId string, page int, perPage int) (*PostList, *Response)

GetFlaggedPostsForUserInChannel returns flagged posts in channel of a user based on user id string.

func (*Client4) GetFlaggedPostsForUserInTeam Uses

func (c *Client4) GetFlaggedPostsForUserInTeam(userId string, teamId string, page int, perPage int) (*PostList, *Response)

GetFlaggedPostsForUserInTeam returns flagged posts in team of a user based on user id string.

func (*Client4) GetIncomingWebhook Uses

func (c *Client4) GetIncomingWebhook(hookID string, etag string) (*IncomingWebhook, *Response)

GetIncomingWebhook returns an Incoming webhook given the hook ID

func (*Client4) GetIncomingWebhookRoute Uses

func (c *Client4) GetIncomingWebhookRoute(hookID string) string

func (*Client4) GetIncomingWebhooks Uses

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 Uses

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 Uses

func (c *Client4) GetIncomingWebhooksRoute() string

func (*Client4) GetJob Uses

func (c *Client4) GetJob(id string) (*Job, *Response)

GetJob gets a single job.

func (*Client4) GetJobs Uses

func (c *Client4) GetJobs(page int, perPage int) ([]*Job, *Response)

Get all jobs, sorted with the job that was created most recently first.

func (*Client4) GetJobsByType Uses

func (c *Client4) GetJobsByType(jobType string, page int, perPage int) ([]*Job, *Response)

GetJobsByType gets all jobs of a given type, sorted with the job that was created most recently first.

func (*Client4) GetJobsRoute Uses

func (c *Client4) GetJobsRoute() string

func (*Client4) GetLdapRoute Uses

func (c *Client4) GetLdapRoute() string

func (*Client4) GetLicenseRoute Uses

func (c *Client4) GetLicenseRoute() string

func (*Client4) GetLogs Uses

func (c *Client4) GetLogs(page, perPage int) ([]string, *Response)

GetLogs page of logs as a string array.

func (*Client4) GetMe Uses

func (c *Client4) GetMe(etag string) (*User, *Response)

GetMe returns the logged in user.

func (*Client4) GetNewUsersInTeam Uses

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

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

func (*Client4) GetOAuthAccessToken Uses

func (c *Client4) GetOAuthAccessToken(data url.Values) (*AccessResponse, *Response)

GetOAuthAccessToken is a test helper function for the OAuth access token endpoint.

func (*Client4) GetOAuthApp Uses

func (c *Client4) GetOAuthApp(appId string) (*OAuthApp, *Response)

GetOAuthApp gets a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.

func (*Client4) GetOAuthAppInfo Uses

func (c *Client4) GetOAuthAppInfo(appId string) (*OAuthApp, *Response)

GetOAuthAppInfo gets a sanitized version of a registered OAuth 2.0 client application with Mattermost acting as an OAuth 2.0 service provider.

func (*Client4) GetOAuthAppRoute Uses

func (c *Client4) GetOAuthAppRoute(appId string) string

func (*Client4) GetOAuthApps Uses

func (c *Client4) GetOAuthApps(page, perPage int) ([]*OAuthApp, *Response)

GetOAuthApps gets a page of registered OAuth 2.0 client applications with Mattermost acting as an OAuth 2.0 service provider.

func (*Client4) GetOAuthAppsRoute Uses

func (c *Client4) GetOAuthAppsRoute() string

func (*Client4) GetOldClientConfig Uses

func (c *Client4) GetOldClientConfig(etag string) (map[string]string, *Response)

GetOldClientConfig will retrieve the parts of the server configuration needed by the client, formatted in the old format.

func (*Client4) GetOldClientLicense Uses

func (c *Client4) GetOldClientLicense(etag string) (map[string]string, *Response)

GetOldClientLicense will retrieve the parts of the server license needed by the client, formatted in the old format.

func (*Client4) GetOpenGraphRoute Uses

func (c *Client4) GetOpenGraphRoute() string

func (*Client4) GetOutgoingWebhook Uses

func (c *Client4) GetOutgoingWebhook(hookId string) (*OutgoingWebhook, *Response)

GetOutgoingWebhook outgoing webhooks on the system requested by Hook Id.

func (*Client4) GetOutgoingWebhookRoute Uses

func (c *Client4) GetOutgoingWebhookRoute(hookID string) string

func (*Client4) GetOutgoingWebhooks Uses

func (c *Client4) GetOutgoingWebhooks(page int, perPage int, etag string) ([]*OutgoingWebhook, *Response)

GetOutgoingWebhooks returns a page of outgoing webhooks on the system. Page counting starts at 0.

func (*Client4) GetOutgoingWebhooksForChannel Uses

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

GetOutgoingWebhooksForChannel returns a page of outgoing webhooks for a channel. Page counting starts at 0.

func (*Client4) GetOutgoingWebhooksForTeam Uses

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

GetOutgoingWebhooksForTeam returns a page of outgoing webhooks for a team. Page counting starts at 0.

func (*Client4) GetOutgoingWebhooksRoute Uses

func (c *Client4) GetOutgoingWebhooksRoute() string

func (*Client4) GetPing Uses

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

GetPing will return ok if the running goRoutines are below the threshold and unhealthy for above.

func (*Client4) GetPinnedPosts Uses

func (c *Client4) GetPinnedPosts(channelId string, etag string) (*PostList, *Response)

GetPinnedPosts gets a list of pinned posts.

func (*Client4) GetPluginRoute Uses

func (c *Client4) GetPluginRoute(pluginId string) string

func (*Client4) GetPluginStatuses Uses

func (c *Client4) GetPluginStatuses() (PluginStatuses, *Response)

GetPluginStatuses will return the plugins installed on any server in the cluster, for reporting to the administrator via the system console. WARNING: PLUGINS ARE STILL EXPERIMENTAL. THIS FUNCTION IS SUBJECT TO CHANGE.

func (*Client4) GetPlugins Uses

func (c *Client4) GetPlugins() (*PluginsResponse, *Response)

GetPlugins will return a list of plugin manifests for currently active plugins. WARNING: PLUGINS ARE STILL EXPERIMENTAL. THIS FUNCTION IS SUBJECT TO CHANGE.

func (*Client4) GetPluginsRoute Uses

func (c *Client4) GetPluginsRoute() string

func (*Client4) GetPost Uses

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

GetPost gets a single post.

func (*Client4) GetPostRoute Uses

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

func (*Client4) GetPostThread Uses

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) GetPostsAfter Uses

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

GetPostsAfter gets a page of posts that were posted after the post provided.

func (*Client4) GetPostsBefore Uses

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

GetPostsBefore gets a page of posts that were posted before the post provided.

func (*Client4) GetPostsEphemeralRoute Uses

func (c *Client4) GetPostsEphemeralRoute() string

func (*Client4) GetPostsForChannel Uses

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 Uses

func (c *Client4) GetPostsRoute() string

func (*Client4) GetPostsSince Uses

func (c *Client4) GetPostsSince(channelId string, time int64) (*PostList, *Response)

GetPostsSince gets posts created after a specified time as Unix time in milliseconds.

func (*Client4) GetPreferenceByCategoryAndName Uses

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 Uses

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

GetPreferences returns the user's preferences.

func (*Client4) GetPreferencesByCategory Uses

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

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

func (*Client4) GetPreferencesRoute Uses

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

func (*Client4) GetProfileImage Uses

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

GetProfileImage gets user's profile image. Must be logged in.

func (*Client4) GetPublicChannelsByIdsForTeam Uses

func (c *Client4) GetPublicChannelsByIdsForTeam(teamId string, channelIds []string) ([]*Channel, *Response)

GetPublicChannelsByIdsForTeam returns a list of public channels based on provided team id string

func (*Client4) GetPublicChannelsForTeam Uses

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

GetPublicChannelsForTeam returns a list of public channels based on the provided team id string.

func (*Client4) GetReactions Uses

func (c *Client4) GetReactions(postId string) ([]*Reaction, *Response)

GetReactions returns a list of reactions to a post.

func (*Client4) GetReactionsRoute Uses

func (c *Client4) GetReactionsRoute() string

func (*Client4) GetRecentlyActiveUsersInTeam Uses

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

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

func (*Client4) GetRedirectLocation Uses

func (c *Client4) GetRedirectLocation(urlParam, etag string) (string, *Response)

GetRedirectLocation retrieves the value of the 'Location' header of an HTTP response for a given URL.

func (*Client4) GetRedirectLocationRoute Uses

func (c *Client4) GetRedirectLocationRoute() string

func (*Client4) GetRegisterTermsOfServiceRoute Uses

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

func (*Client4) GetRole Uses

func (c *Client4) GetRole(id string) (*Role, *Response)

GetRole gets a single role by ID.

func (*Client4) GetRoleByName Uses

func (c *Client4) GetRoleByName(name string) (*Role, *Response)

GetRoleByName gets a single role by Name.

func (*Client4) GetRolesByNames Uses

func (c *Client4) GetRolesByNames(roleNames []string) ([]*Role, *Response)

GetRolesByNames returns a list of roles based on the provided role names.

func (*Client4) GetRolesRoute Uses

func (c *Client4) GetRolesRoute() string

func (*Client4) GetSamlCertificateStatus Uses

func (c *Client4) GetSamlCertificateStatus() (*SamlCertificateStatus, *Response)

GetSamlCertificateStatus returns metadata for the SAML configuration.

func (*Client4) GetSamlMetadata Uses

func (c *Client4) GetSamlMetadata() (string, *Response)

GetSamlMetadata returns metadata for the SAML configuration.

func (*Client4) GetSamlRoute Uses

func (c *Client4) GetSamlRoute() string

func (*Client4) GetScheme Uses

func (c *Client4) GetScheme(id string) (*Scheme, *Response)

GetScheme gets a single scheme by ID.

func (*Client4) GetSchemeRoute Uses

func (c *Client4) GetSchemeRoute(id string) string

func (*Client4) GetSchemes Uses

func (c *Client4) GetSchemes(scope string, page int, perPage int) ([]*Scheme, *Response)

Get all schemes, sorted with the most recently created first, optionally filtered by scope.

func (*Client4) GetSchemesRoute Uses

func (c *Client4) GetSchemesRoute() string

func (*Client4) GetSessions Uses

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

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

func (*Client4) GetSortedEmojiList Uses

func (c *Client4) GetSortedEmojiList(page, perPage int, sort string) ([]*Emoji, *Response)

GetSortedEmojiList returns a page of custom emoji on the system sorted based on the sort parameter, blank for no sorting and "name" to sort by emoji names.

func (*Client4) GetSupportedTimezone Uses

func (c *Client4) GetSupportedTimezone() (SupportedTimezones, *Response)

GetSupportedTimezone returns a page of supported timezones on the system.

func (*Client4) GetSystemRoute Uses

func (c *Client4) GetSystemRoute() string

func (*Client4) GetTeam Uses

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

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

func (*Client4) GetTeamAutoCompleteCommandsRoute Uses

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

func (*Client4) GetTeamByName Uses

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

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

func (*Client4) GetTeamByNameRoute Uses

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

func (*Client4) GetTeamIcon Uses

func (c *Client4) GetTeamIcon(teamId, etag string) ([]byte, *Response)

GetTeamIcon gets the team icon of the team

func (*Client4) GetTeamImportRoute Uses

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

func (*Client4) GetTeamInviteInfo Uses

func (c *Client4) GetTeamInviteInfo(inviteId string) (*Team, *Response)

GetTeamInviteInfo returns a team object from an invite id containing sanitized information.

func (*Client4) GetTeamMember Uses

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 Uses

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

func (*Client4) GetTeamMembers Uses

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) GetTeamMembersByIds Uses

func (c *Client4) GetTeamMembersByIds(teamId string, userIds []string) ([]*TeamMember, *Response)

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

func (*Client4) GetTeamMembersForUser Uses

func (c *Client4) GetTeamMembersForUser(userId string, etag string) ([]*TeamMember, *Response)

GetTeamMembersForUser returns the team members for a user.

func (*Client4) GetTeamMembersRoute Uses

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

func (*Client4) GetTeamRoute Uses

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

func (*Client4) GetTeamSchemeRoute Uses

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

func (*Client4) GetTeamStats Uses

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 Uses

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

func (*Client4) GetTeamUnread Uses

func (c *Client4) GetTeamUnread(teamId, userId string) (*TeamUnread, *Response)

GetTeamUnread will return a TeamUnread object that contains the amount of unread messages and mentions the user has for the specified team. Must be authenticated.

func (*Client4) GetTeamsForScheme Uses

func (c *Client4) GetTeamsForScheme(schemeId string, page int, perPage int) ([]*Team, *Response)

Get the teams using this scheme, sorted alphabetically by display name.

func (*Client4) GetTeamsForUser Uses

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 Uses

func (c *Client4) GetTeamsRoute() string

func (*Client4) GetTeamsUnreadForUser Uses

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) GetTermsOfService Uses

func (c *Client4) GetTermsOfService(etag string) (*TermsOfService, *Response)

func (*Client4) GetTermsOfServiceRoute Uses

func (c *Client4) GetTermsOfServiceRoute() string

func (*Client4) GetTestEmailRoute Uses

func (c *Client4) GetTestEmailRoute() string

func (*Client4) GetTestS3Route Uses

func (c *Client4) GetTestS3Route() string

func (*Client4) GetTimezonesRoute Uses

func (c *Client4) GetTimezonesRoute() string

func (*Client4) GetTotalUsersStats Uses

func (c *Client4) GetTotalUsersStats(etag string) (*UsersStats, *Response)

GetTotalUsersStats returns a total system user stats. Must be authenticated.

func (*Client4) GetTotalUsersStatsRoute Uses

func (c *Client4) GetTotalUsersStatsRoute() string

func (*Client4) GetUser Uses

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

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

func (*Client4) GetUserAccessToken Uses

func (c *Client4) GetUserAccessToken(tokenId string) (*UserAccessToken, *Response)

GetUserAccessToken will get a user access tokens' id, description, is_active and the user_id of the user it is for. The actual token will not be returned. Must have the 'read_user_access_token' permission and if getting for another user, must have the 'edit_other_users' permission.

func (*Client4) GetUserAccessTokenRoute Uses

func (c *Client4) GetUserAccessTokenRoute(tokenId string) string

func (*Client4) GetUserAccessTokens Uses

func (c *Client4) GetUserAccessTokens(page int, perPage int) ([]*UserAccessToken, *Response)

GetUserAccessTokens will get a page of access tokens' id, description, is_active and the user_id in the system. The actual token will not be returned. Must have the 'manage_system' permission.

func (*Client4) GetUserAccessTokensForUser Uses

func (c *Client4) GetUserAccessTokensForUser(userId string, page, perPage int) ([]*UserAccessToken, *Response)

GetUserAccessTokensForUser will get a paged list of user access tokens showing id, description and user_id for each. The actual tokens will not be returned. Must have the 'read_user_access_token' permission and if getting for another user, must have the 'edit_other_users' permission.

func (*Client4) GetUserAccessTokensRoute Uses

func (c *Client4) GetUserAccessTokensRoute() string

func (*Client4) GetUserAudits Uses

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

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

func (*Client4) GetUserByEmail Uses

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

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

func (*Client4) GetUserByEmailRoute Uses

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

func (*Client4) GetUserByUsername Uses

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

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

func (*Client4) GetUserByUsernameRoute Uses

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

func (*Client4) GetUserRoute Uses

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

func (*Client4) GetUserStatus Uses

func (c *Client4) GetUserStatus(userId, etag string) (*Status, *Response)

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

func (*Client4) GetUserStatusRoute Uses

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

func (*Client4) GetUserStatusesRoute Uses

func (c *Client4) GetUserStatusesRoute() string

func (*Client4) GetUsers Uses

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 Uses

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

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

func (*Client4) GetUsersByUsernames Uses

func (c *Client4) GetUsersByUsernames(usernames []string) ([]*User, *Response)

GetUsersByUsernames returns a list of users based on the provided usernames.

func (*Client4) GetUsersInChannel Uses

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

GetUsersInChannel returns a page of users in a channel. Page counting starts at 0.

func (*Client4) GetUsersInChannelByStatus Uses

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

GetUsersInChannelStatus returns a page of users in a channel. Page counting starts at 0. Sorted by Status

func (*Client4) GetUsersInTeam Uses

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 Uses

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

GetUsersNotInChannel returns a page of users not in a channel. Page counting starts at 0.

func (*Client4) GetUsersNotInTeam Uses

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

GetUsersNotInTeam returns a page of users who are not in a team. Page counting starts at 0.

func (*Client4) GetUsersRoute Uses

func (c *Client4) GetUsersRoute() string

func (*Client4) GetUsersStatusesByIds Uses

func (c *Client4) GetUsersStatusesByIds(userIds []string) ([]*Status, *Response)

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

func (*Client4) GetUsersWithoutTeam Uses

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

GetUsersWithoutTeam returns a page of users on the system that aren't on any teams. Page counting starts at 0.

func (*Client4) GetWebappPlugins Uses

func (c *Client4) GetWebappPlugins() ([]*Manifest, *Response)

GetWebappPlugins will return a list of plugins that the webapp should download. WARNING: PLUGINS ARE STILL EXPERIMENTAL. THIS FUNCTION IS SUBJECT TO CHANGE.

func (*Client4) GetWebrtcToken Uses

func (c *Client4) GetWebrtcToken() (*WebrtcInfoResponse, *Response)

GetWebrtcToken returns a valid token, stun server and turn server with credentials to use with the Mattermost WebRTC service.

func (*Client4) ImportTeam Uses

func (c *Client4) ImportTeam(data []byte, filesize int, importFrom, filename, teamId string) (map[string]string, *Response)

ImportTeam will import an exported team from other app into a existing team.

func (*Client4) InvalidateCaches Uses

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

InvalidateCaches will purge the cache and can affect the performance while is cleaning.

func (*Client4) InviteUsersToTeam Uses

func (c *Client4) InviteUsersToTeam(teamId string, userEmails []string) (bool, *Response)

InviteUsersToTeam invite users by email to the team.

func (*Client4) ListAutocompleteCommands Uses

func (c *Client4) ListAutocompleteCommands(teamId string) ([]*Command, *Response)

ListCommands will retrieve a list of commands available in the team.

func (*Client4) ListCommands Uses

func (c *Client4) ListCommands(teamId string, customOnly bool) ([]*Command, *Response)

ListCommands will retrieve a list of commands available in the team.

func (*Client4) Login Uses

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 Uses

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

LoginById authenticates a user by user id and password.

func (*Client4) LoginByLdap Uses

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

LoginByLdap authenticates a user by LDAP id and password.

func (*Client4) LoginWithDevice Uses

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 Uses

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

Logout terminates the current user's session.

func (*Client4) MockSession Uses

func (c *Client4) MockSession(sessionToken string)

func (*Client4) Must Uses

func (c *Client4) Must(result interface{}, resp *Response) interface{}

Must is a convenience function used for testing.

func (*Client4) OpenGraph Uses

func (c *Client4) OpenGraph(url string) (map[string]string, *Response)

OpenGraph return the open graph metadata for a particular url if the site have the metadata

func (*Client4) PatchChannel Uses

func (c *Client4) PatchChannel(channelId string, patch *ChannelPatch) (*Channel, *Response)

PatchChannel partially updates a channel. Any missing fields are not updated.

func (*Client4) PatchPost Uses

func (c *Client4) PatchPost(postId string, patch *PostPatch) (*Post, *Response)

PatchPost partially updates a post. Any missing fields are not updated.

func (*Client4) PatchRole Uses

func (c *Client4) PatchRole(roleId string, patch *RolePatch) (*Role, *Response)

PatchRole partially updates a role in the system. Any missing fields are not updated.

func (*Client4) PatchScheme Uses

func (c *Client4) PatchScheme(id string, patch *SchemePatch) (*Scheme, *Response)

PatchScheme partially updates a scheme in the system. Any missing fields are not updated.

func (*Client4) PatchTeam Uses

func (c *Client4) PatchTeam(teamId string, patch *TeamPatch) (*Team, *Response)

PatchTeam partially updates a team. Any missing fields are not updated.

func (*Client4) PatchUser Uses

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) PermanentDeleteTeam Uses

func (c *Client4) PermanentDeleteTeam(teamId string) (bool, *Response)

PermanentDeleteTeam deletes the team, should only be used when needed for compliance and the like

func (*Client4) PinPost Uses

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

PinPost pin a post based on provided post id string.

func (*Client4) PostLog Uses

func (c *Client4) PostLog(message map[string]string) (map[string]string, *Response)

PostLog 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 the log message if the logging was successful.

func (*Client4) PurgeElasticsearchIndexes Uses

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

PurgeElasticsearchIndexes immediately deletes all Elasticsearch indexes.

func (*Client4) RegenCommandToken Uses

func (c *Client4) RegenCommandToken(commandId string) (string, *Response)

RegenCommandToken will create a new token if the user have the right permissions.

func (*Client4) RegenOutgoingHookToken Uses

func (c *Client4) RegenOutgoingHookToken(hookId string) (*OutgoingWebhook, *Response)

RegenOutgoingHookToken regenerate the outgoing webhook token.

func (*Client4) RegenerateOAuthAppSecret Uses

func (c *Client4) RegenerateOAuthAppSecret(appId string) (*OAuthApp, *Response)

RegenerateOAuthAppSecret regenerates the client secret for a registered OAuth 2.0 client application.

func (*Client4) RegisteTermsOfServiceAction Uses

func (c *Client4) RegisteTermsOfServiceAction(userId, termsOfServiceId string, accepted bool) (*bool, *Response)

func (*Client4) ReloadConfig Uses

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

ReloadConfig will reload the server configuration.

func (*Client4) RemoveLicenseFile Uses

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

RemoveLicenseFile will remove the server license it exists. Note that this will disable all enterprise features.

func (*Client4) RemovePlugin Uses

func (c *Client4) RemovePlugin(id string) (bool, *Response)

RemovePlugin will deactivate and delete a plugin. WARNING: PLUGINS ARE STILL EXPERIMENTAL. THIS FUNCTION IS SUBJECT TO CHANGE.

func (*Client4) RemoveTeamIcon Uses

func (c *Client4) RemoveTeamIcon(teamId string) (bool, *Response)

RemoveTeamIcon updates LastTeamIconUpdate to 0 which indicates team icon is removed.

func (*Client4) RemoveTeamMember Uses

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

RemoveTeamMember will remove a user from a team.

func (*Client4) RemoveUserFromChannel Uses

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 Uses

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

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

func (*Client4) RestoreChannel Uses

func (c *Client4) RestoreChannel(channelId string) (*Channel, *Response)

RestoreChannel restores a previously deleted channel. Any missing fields are not updated.

func (*Client4) RevokeAllSessions Uses

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

RevokeAllSessions revokes all sessions for the provided user id string.

func (*Client4) RevokeSession Uses

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) RevokeUserAccessToken Uses

func (c *Client4) RevokeUserAccessToken(tokenId string) (bool, *Response)

RevokeUserAccessToken will revoke a user access token by id. Must have the 'revoke_user_access_token' permission and if revoking for another user, must have the 'edit_other_users' permission.

func (*Client4) SaveReaction Uses

func (c *Client4) SaveReaction(reaction *Reaction) (*Reaction, *Response)

SaveReaction saves an emoji reaction for a post. Returns the saved reaction if successful, otherwise an error will be returned.

func (*Client4) SearchChannels Uses

func (c *Client4) SearchChannels(teamId string, search *ChannelSearch) ([]*Channel, *Response)

SearchChannels returns the channels on a team matching the provided search term.

func (*Client4) SearchEmoji Uses

func (c *Client4) SearchEmoji(search *EmojiSearch) ([]*Emoji, *Response)

SearchEmoji returns a list of emoji matching some search criteria.

func (*Client4) SearchPosts Uses

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

SearchPosts returns any posts with matching terms string.

func (*Client4) SearchPostsWithMatches Uses

func (c *Client4) SearchPostsWithMatches(teamId string, terms string, isOrSearch bool) (*PostSearchResults, *Response)

SearchPosts returns any posts with matching terms string, including .

func (*Client4) SearchPostsWithParams Uses

func (c *Client4) SearchPostsWithParams(teamId string, params *SearchParameter) (*PostList, *Response)

SearchPosts returns any posts with matching terms string.

func (*Client4) SearchTeams Uses

func (c *Client4) SearchTeams(search *TeamSearch) ([]*Team, *Response)

SearchTeams returns teams matching the provided search term.

func (*Client4) SearchUserAccessTokens Uses

func (c *Client4) SearchUserAccessTokens(search *UserAccessTokenSearch) ([]*UserAccessToken, *Response)

SearchUserAccessTokens returns user access tokens matching the provided search term.

func (*Client4) SearchUsers Uses

func (c *Client4) SearchUsers(search *UserSearch) ([]*User, *Response)

SearchUsers returns a list of users based on some search criteria.

func (*Client4) SendPasswordResetEmail Uses

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) SendVerificationEmail Uses

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

SendVerificationEmail will send an email to the user with the provided email address, if that user exists. The email will contain a link that can be used to verify the user's email address.

func (*Client4) SetDefaultProfileImage Uses

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

SetDefaultProfileImage resets the profile image to a default generated one

func (*Client4) SetOAuthToken Uses

func (c *Client4) SetOAuthToken(token string)

func (*Client4) SetProfileImage Uses

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

SetProfileImage sets profile image of the user

func (*Client4) SetTeamIcon Uses

func (c *Client4) SetTeamIcon(teamId string, data []byte) (bool, *Response)

SetTeamIcon sets team icon of the team

func (*Client4) SoftDeleteTeam Uses

func (c *Client4) SoftDeleteTeam(teamId string) (bool, *Response)

SoftDeleteTeam deletes the team softly (archive only, not permanent delete).

func (*Client4) SwitchAccountType Uses

func (c *Client4) SwitchAccountType(switchRequest *SwitchRequest) (string, *Response)

SwitchAccountType changes a user's login type from one type to another.

func (*Client4) SyncLdap Uses

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

SyncLdap will force a sync with the configured LDAP server.

func (*Client4) TeamExists Uses

func (c *Client4) TeamExists(name, etag string) (bool, *Response)

TeamExists returns true or false if the team exist or not.

func (*Client4) TestElasticsearch Uses

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

TestElasticsearch will attempt to connect to the configured Elasticsearch server and return OK if configured correctly.

func (*Client4) TestEmail Uses

func (c *Client4) TestEmail(config *Config) (bool, *Response)

TestEmail will attempt to connect to the configured SMTP server.

func (*Client4) TestLdap Uses

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

TestLdap will attempt to connect to the configured LDAP server and return OK if configured correctly.

func (*Client4) TestS3Connection Uses

func (c *Client4) TestS3Connection(config *Config) (bool, *Response)

TestS3Connection will attempt to connect to the AWS S3.

func (*Client4) UnpinPost Uses

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

UnpinPost unpin a post based on provided post id string.

func (*Client4) UpdateChannel Uses

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

UpdateChannel update a channel based on the provided channel struct.

func (*Client4) UpdateChannelMemberSchemeRoles Uses

func (c *Client4) UpdateChannelMemberSchemeRoles(channelId string, userId string, schemeRoles *SchemeRoles) (bool, *Response)

UpdateChannelMemberSchemeRoles will update the scheme-derived roles on a channel for a user.

func (*Client4) UpdateChannelNotifyProps Uses

func (c *Client4) UpdateChannelNotifyProps(channelId, userId string, props map[string]string) (bool, *Response)

UpdateChannelNotifyProps will update the notification properties on a channel for a user.

func (*Client4) UpdateChannelRoles Uses

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

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

func (*Client4) UpdateChannelScheme Uses

func (c *Client4) UpdateChannelScheme(channelId, schemeId string) (bool, *Response)

UpdateChannelScheme will update a channel's scheme.

func (*Client4) UpdateCommand Uses

func (c *Client4) UpdateCommand(cmd *Command) (*Command, *Response)

UpdateCommand updates a command based on the provided Command struct

func (*Client4) UpdateConfig Uses

func (c *Client4) UpdateConfig(config *Config) (*Config, *Response)

UpdateConfig will update the server configuration.

func (*Client4) UpdateIncomingWebhook Uses

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

UpdateIncomingWebhook updates an incoming webhook for a channel.

func (*Client4) UpdateOAuthApp Uses

func (c *Client4) UpdateOAuthApp(app *OAuthApp) (*OAuthApp, *Response)

UpdateOAuthApp

func (*Client4) UpdateOutgoingWebhook Uses

func (c *Client4) UpdateOutgoingWebhook(hook *OutgoingWebhook) (*OutgoingWebhook, *Response)

UpdateOutgoingWebhook creates an outgoing webhook for a team or channel.

func (*Client4) UpdatePost Uses

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

UpdatePost updates a post based on the provided post struct.

func (*Client4) UpdatePreferences Uses

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

UpdatePreferences saves the user's preferences.

func (*Client4) UpdateTeam Uses

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

UpdateTeam will update a team.

func (*Client4) UpdateTeamMemberRoles Uses

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

UpdateTeamMemberRoles will update the roles on a team for a user.

func (*Client4) UpdateTeamMemberSchemeRoles Uses

func (c *Client4) UpdateTeamMemberSchemeRoles(teamId string, userId string, schemeRoles *SchemeRoles) (bool, *Response)

UpdateTeamMemberSchemeRoles will update the scheme-derived roles on a team for a user.

func (*Client4) UpdateTeamScheme Uses

func (c *Client4) UpdateTeamScheme(teamId, schemeId string) (bool, *Response)

UpdateTeamScheme will update a team's scheme.

func (*Client4) UpdateUser Uses

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

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

func (*Client4) UpdateUserActive Uses

func (c *Client4) UpdateUserActive(userId string, active bool) (bool, *Response)

UpdateUserActive updates status of a user whether active or not.

func (*Client4) UpdateUserAuth Uses

func (c *Client4) UpdateUserAuth(userId string, userAuth *UserAuth) (*UserAuth, *Response)

UpdateUserAuth updates a user AuthData (uthData, authService and password) in the system.

func (*Client4) UpdateUserMfa Uses

func (c *Client4) UpdateUserMfa(userId, code string, activate bool) (bool, *Response)

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

func (*Client4) UpdateUserPassword Uses

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 Uses

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) UpdateUserStatus Uses

func (c *Client4) UpdateUserStatus(userId string, userStatus *Status) (*Status, *Response)

UpdateUserStatus sets a user's status based on the provided user id string.

func (*Client4) UploadBrandImage Uses

func (c *Client4) UploadBrandImage(data []byte) (bool, *Response)

UploadBrandImage sets the brand image for the system.

func (*Client4) UploadFile Uses

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

UploadFile will upload a file to a channel using a multipart request, to be later attached to a post. This method is functionally equivalent to Client4.UploadFileAsRequestBody.

func (*Client4) UploadFileAsRequestBody Uses

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

UploadFileAsRequestBody will upload a file to a channel as the body of a request, to be later attached to a post. This method is functionally equivalent to Client4.UploadFile.

func (*Client4) UploadLicenseFile Uses

func (c *Client4) UploadLicenseFile(data []byte) (bool, *Response)

UploadLicenseFile will add a license file to the system.

func (*Client4) UploadPlugin Uses

func (c *Client4) UploadPlugin(file io.Reader) (*Manifest, *Response)

UploadPlugin takes an io.Reader stream pointing to the contents of a .tar.gz plugin. WARNING: PLUGINS ARE STILL EXPERIMENTAL. THIS FUNCTION IS SUBJECT TO CHANGE.

func (*Client4) UploadSamlIdpCertificate Uses

func (c *Client4) UploadSamlIdpCertificate(data []byte, filename string) (bool, *Response)

UploadSamlIdpCertificate will upload an IDP certificate for SAML and set the config to use it.

func (*Client4) UploadSamlPrivateCertificate Uses

func (c *Client4) UploadSamlPrivateCertificate(data []byte, filename string) (bool, *Response)

UploadSamlPrivateCertificate will upload a private key for SAML and set the config to use it.

func (*Client4) UploadSamlPublicCertificate Uses

func (c *Client4) UploadSamlPublicCertificate(data []byte, filename string) (bool, *Response)

UploadSamlPublicCertificate will upload a public certificate for SAML and set the config to use it.

func (*Client4) VerifyUserEmail Uses

func (c *Client4) VerifyUserEmail(token string) (bool, *Response)

VerifyUserEmail will verify a user's email using the supplied token.

func (*Client4) ViewChannel Uses

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

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

type ClientRequirements Uses

type ClientRequirements struct {
    AndroidLatestVersion string
    AndroidMinVersion    string
    DesktopLatestVersion string
    DesktopMinVersion    string
    IosLatestVersion     string
    IosMinVersion        string
}

type ClusterDiscovery Uses

type ClusterDiscovery struct {
    Id          string `json:"id"`
    Type        string `json:"type"`
    ClusterName string `json:"cluster_name"`
    Hostname    string `json:"hostname"`
    GossipPort  int32  `json:"gossip_port"`
    Port        int32  `json:"port"`
    CreateAt    int64  `json:"create_at"`
    LastPingAt  int64  `json:"last_ping_at"`
}

func ClusterDiscoveryFromJson Uses

func ClusterDiscoveryFromJson(data io.Reader) *ClusterDiscovery

func FilterClusterDiscovery Uses

func FilterClusterDiscovery(vs []*ClusterDiscovery, f func(*ClusterDiscovery) bool) []*ClusterDiscovery

func (*ClusterDiscovery) AutoFillHostname Uses

func (o *ClusterDiscovery) AutoFillHostname()

func (*ClusterDiscovery) AutoFillIpAddress Uses

func (o *ClusterDiscovery) AutoFillIpAddress()

func (*ClusterDiscovery) IsEqual Uses

func (o *ClusterDiscovery) IsEqual(in *ClusterDiscovery) bool

func (*ClusterDiscovery) IsValid Uses

func (o *ClusterDiscovery) IsValid() *AppError

func (*ClusterDiscovery) PreSave Uses

func (o *ClusterDiscovery) PreSave()

func (*ClusterDiscovery) ToJson Uses

func (o *ClusterDiscovery) ToJson() string

type ClusterInfo Uses

type ClusterInfo struct {
    Id         string `json:"id"`
    Version    string `json:"version"`
    ConfigHash string `json:"config_hash"`
    IpAddress  string `json:"ipaddress"`
    Hostname   string `json:"hostname"`
}

func ClusterInfoFromJson Uses

func ClusterInfoFromJson(data io.Reader) *ClusterInfo

func ClusterInfosFromJson Uses

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

func (*ClusterInfo) ToJson Uses

func (me *ClusterInfo) ToJson() string

type ClusterMessage Uses

type ClusterMessage struct {
    Event            string            `json:"event"`
    SendType         string            `json:"-"`
    WaitForAllToSend bool              `json:"-"`
    Data             string            `json:"data,omitempty"`
    Props            map[string]string `json:"props,omitempty"`
}

func ClusterMessageFromJson Uses

func ClusterMessageFromJson(data io.Reader) *ClusterMessage

func (*ClusterMessage) ToJson Uses

func (o *ClusterMessage) ToJson() string

type ClusterSettings Uses

type ClusterSettings struct {
    Enable                      *bool
    ClusterName                 *string
    OverrideHostname            *string
    UseIpAddress                *bool
    UseExperimentalGossip       *bool
    ReadOnlyConfig              *bool
    GossipPort                  *int
    StreamingPort               *int
    MaxIdleConns                *int
    MaxIdleConnsPerHost         *int
    IdleConnTimeoutMilliseconds *int
}

func (*ClusterSettings) SetDefaults Uses

func (s *ClusterSettings) SetDefaults()

type ClusterStats Uses

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 Uses

func ClusterStatsFromJson(data io.Reader) *ClusterStats

func (*ClusterStats) ToJson Uses

func (me *ClusterStats) ToJson() string

type Command Uses

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 Uses

func CommandFromJson(data io.Reader) *Command

func CommandListFromJson Uses

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

func (*Command) IsValid Uses

func (o *Command) IsValid() *AppError

func (*Command) PreSave Uses

func (o *Command) PreSave()

func (*Command) PreUpdate Uses

func (o *Command) PreUpdate()

func (*Command) Sanitize Uses

func (o *Command) Sanitize()

func (*Command) ToJson Uses

func (o *Command) ToJson() string

type CommandArgs Uses

type CommandArgs struct {
    UserId    string               `json:"user_id"`
    ChannelId string               `json:"channel_id"`
    TeamId    string               `json:"team_id"`
    RootId    string               `json:"root_id"`
    ParentId  string               `json:"parent_id"`
    Command   string               `json:"command"`
    SiteURL   string               `json:"-"`
    T         goi18n.TranslateFunc `json:"-"`
    Session   Session              `json:"-"`
}

func CommandArgsFromJson Uses

func CommandArgsFromJson(data io.Reader) *CommandArgs

func (*CommandArgs) ToJson Uses

func (o *CommandArgs) ToJson() string

type CommandResponse Uses

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

func CommandResponseFromHTTPBody Uses

func CommandResponseFromHTTPBody(contentType string, body io.Reader) (*CommandResponse, error)

func CommandResponseFromJson Uses

func CommandResponseFromJson(data io.Reader) (*CommandResponse, error)

func CommandResponseFromPlainText Uses

func CommandResponseFromPlainText(text string) *CommandResponse

func (*CommandResponse) ToJson Uses

func (o *CommandResponse) ToJson() string

type CommandWebhook Uses

type CommandWebhook struct {
    Id        string
    CreateAt  int64
    CommandId string
    UserId    string
    ChannelId string
    RootId    string
    ParentId  string
    UseCount  int
}

func (*CommandWebhook) IsValid Uses

func (o *CommandWebhook) IsValid() *AppError

func (*CommandWebhook) PreSave Uses

func (o *CommandWebhook) PreSave()

type Compliance Uses

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 Uses

func ComplianceFromJson(data io.Reader) *Compliance

func (*Compliance) IsValid Uses

func (me *Compliance) IsValid() *AppError

func (*Compliance) JobName Uses

func (me *Compliance) JobName() string

func (*Compliance) PreSave Uses

func (me *Compliance) PreSave()

func (*Compliance) ToJson Uses

func (o *Compliance) ToJson() string

type CompliancePost Uses

type CompliancePost struct {

    // From Team
    TeamName        string
    TeamDisplayName string

    // From Channel
    ChannelName        string
    ChannelDisplayName string
    ChannelType        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 Uses

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

type ComplianceSettings Uses

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

func (*ComplianceSettings) SetDefaults Uses

func (s *ComplianceSettings) SetDefaults()

type Compliances Uses

type Compliances []Compliance

func CompliancesFromJson Uses

func CompliancesFromJson(data io.Reader) Compliances

func (Compliances) ToJson Uses

func (o Compliances) ToJson() string

type Config Uses

type Config struct {
    ServiceSettings       ServiceSettings
    TeamSettings          TeamSettings
    ClientRequirements    ClientRequirements
    SqlSettings           SqlSettings
    LogSettings           LogSettings
    PasswordSettings      PasswordSettings
    FileSettings          FileSettings
    EmailSettings         EmailSettings
    ExtensionSettings     ExtensionSettings
    RateLimitSettings     RateLimitSettings
    PrivacySettings       PrivacySettings
    SupportSettings       SupportSettings
    AnnouncementSettings  AnnouncementSettings
    ThemeSettings         ThemeSettings
    GitLabSettings        SSOSettings
    GoogleSettings        SSOSettings
    Office365Settings     SSOSettings
    LdapSettings          LdapSettings
    ComplianceSettings    ComplianceSettings
    LocalizationSettings  LocalizationSettings
    SamlSettings          SamlSettings
    NativeAppSettings     NativeAppSettings
    ClusterSettings       ClusterSettings
    MetricsSettings       MetricsSettings
    ExperimentalSettings  ExperimentalSettings
    AnalyticsSettings     AnalyticsSettings
    WebrtcSettings        WebrtcSettings
    ElasticsearchSettings ElasticsearchSettings
    DataRetentionSettings DataRetentionSettings
    MessageExportSettings MessageExportSettings
    JobSettings           JobSettings
    PluginSettings        PluginSettings
    DisplaySettings       DisplaySettings
    TimezoneSettings      TimezoneSettings
}

func ConfigFromJson Uses

func ConfigFromJson(data io.Reader) *Config

func (*Config) Clone Uses

func (o *Config) Clone() *Config

func (*Config) GetSSOService Uses

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

func (*Config) GetSanitizeOptions Uses

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

func (*Config) IsValid Uses

func (o *Config) IsValid() *AppError

func (*Config) Sanitize Uses

func (o *Config) Sanitize()

func (*Config) SetDefaults Uses

func (o *Config) SetDefaults()

func (*Config) ToJson Uses

func (o *Config) ToJson() string

type ConfigFunc Uses

type ConfigFunc func() *Config

type Customer Uses

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 DataRetentionPolicy Uses

type DataRetentionPolicy struct {
    MessageDeletionEnabled bool  `json:"message_deletion_enabled"`
    FileDeletionEnabled    bool  `json:"file_deletion_enabled"`
    MessageRetentionCutoff int64 `json:"message_retention_cutoff"`
    FileRetentionCutoff    int64 `json:"file_retention_cutoff"`
}

func DataRetentionPolicyFromJson Uses

func DataRetentionPolicyFromJson(data io.Reader) *DataRetentionPolicy

func (*DataRetentionPolicy) ToJson Uses

func (me *DataRetentionPolicy) ToJson() string

type DataRetentionSettings Uses

type DataRetentionSettings struct {
    EnableMessageDeletion *bool
    EnableFileDeletion    *bool
    MessageRetentionDays  *int
    FileRetentionDays     *int
    DeletionJobStartTime  *string
}

func (*DataRetentionSettings) SetDefaults Uses

func (s *DataRetentionSettings) SetDefaults()

type DisplaySettings Uses

type DisplaySettings struct {
    CustomUrlSchemes     *[]string
    ExperimentalTimezone *bool
}

func (*DisplaySettings) SetDefaults Uses

func (s *DisplaySettings) SetDefaults()

type DoPostActionRequest Uses

type DoPostActionRequest struct {
    SelectedOption string `json:"selected_option"`
}

func DoPostActionRequestFromJson Uses

func DoPostActionRequestFromJson(data io.Reader) *DoPostActionRequest

type ElasticsearchSettings Uses

type ElasticsearchSettings struct {
    ConnectionUrl                 *string
    Username                      *string
    Password                      *string
    EnableIndexing                *bool
    EnableSearching               *bool
    Sniff                         *bool
    PostIndexReplicas             *int
    PostIndexShards               *int
    AggregatePostsAfterDays       *int
    PostsAggregatorJobStartTime   *string
    IndexPrefix                   *string
    LiveIndexingBatchSize         *int
    BulkIndexingTimeWindowSeconds *int
    RequestTimeoutSeconds         *int
}

func (*ElasticsearchSettings) SetDefaults Uses

func (s *ElasticsearchSettings) SetDefaults()

type EmailSettings Uses

type EmailSettings struct {
    EnableSignUpWithEmail             bool
    EnableSignInWithEmail             *bool
    EnableSignInWithUsername          *bool
    SendEmailNotifications            bool
    UseChannelInEmailNotifications    *bool
    RequireEmailVerification          bool
    FeedbackName                      string
    FeedbackEmail                     string
    FeedbackOrganization              *string
    EnableSMTPAuth                    *bool
    SMTPUsername                      string
    SMTPPassword                      string
    SMTPServer                        string
    SMTPPort                          string
    ConnectionSecurity                string
    InviteSalt                        string
    SendPushNotifications             *bool
    PushNotificationServer            *string
    PushNotificationContents          *string
    EnableEmailBatching               *bool
    EmailBatchingBufferSize           *int
    EmailBatchingInterval             *int
    EnablePreviewModeBanner           *bool
    SkipServerCertificateVerification *bool
    EmailNotificationContentsType     *string
    LoginButtonColor                  *string
    LoginButtonBorderColor            *string
    LoginButtonTextColor              *string
}

func (*EmailSettings) SetDefaults Uses

func (s *EmailSettings) SetDefaults()

type Emoji Uses

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 Uses

func EmojiFromJson(data io.Reader) *Emoji

func EmojiListFromJson Uses

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

func (*Emoji) IsValid Uses

func (emoji *Emoji) IsValid() *AppError

func (*Emoji) PreSave Uses

func (emoji *Emoji) PreSave()

func (*Emoji) ToJson Uses

func (emoji *Emoji) ToJson() string

type EmojiSearch Uses

type EmojiSearch struct {
    Term       string `json:"term"`
    PrefixOnly bool   `json:"prefix_only"`
}

func EmojiSearchFromJson Uses

func EmojiSearchFromJson(data io.Reader) *EmojiSearch

func (*EmojiSearch) ToJson Uses

func (es *EmojiSearch) ToJson() string

type ExperimentalSettings Uses

type ExperimentalSettings struct {
    ClientSideCertEnable *bool
    ClientSideCertCheck  *string
}

func (*ExperimentalSettings) SetDefaults Uses

func (s *ExperimentalSettings) SetDefaults()

type ExtensionSettings Uses

type ExtensionSettings struct {
    EnableExperimentalExtensions *bool
    AllowedExtensionsIDs         []string
}

func (*ExtensionSettings) SetDefaults Uses

func (s *ExtensionSettings) SetDefaults()

type Features Uses

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"`
    MHPNS                     *bool `json:"mhpns"`
    SAML                      *bool `json:"saml"`
    Elasticsearch             *bool `json:"elastic_search"`
    Announcement              *bool `json:"announcement"`
    ThemeManagement           *bool `json:"theme_management"`
    EmailNotificationContents *bool `json:"email_notification_contents"`
    DataRetention             *bool `json:"data_retention"`
    MessageExport             *bool `json:"message_export"`
    CustomPermissionsSchemes  *bool `json:"custom_permissions_schemes"`
    CustomTermsOfService      *bool `json:"custom_terms_of_service"`

    // after we enabled more features for webrtc we'll need to control them with this
    FutureFeatures *bool `json:"future_features"`
}

func (*Features) SetDefaults Uses

func (f *Features) SetDefaults()

func (*Features) ToMap Uses

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

type FileInfo Uses

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 Uses

func FileInfoFromJson(data io.Reader) *FileInfo

func FileInfosFromJson Uses

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

func (*FileInfo) IsImage Uses

func (o *FileInfo) IsImage() bool

func (*FileInfo) IsValid Uses

func (o *FileInfo) IsValid() *AppError

func (*FileInfo) PreSave Uses

func (o *FileInfo) PreSave()

func (*FileInfo) ToJson Uses

func (info *FileInfo) ToJson() string

type FileSettings Uses

type FileSettings struct {
    EnableFileAttachments   *bool
    EnableMobileUpload      *bool
    EnableMobileDownload    *bool
    MaxFileSize             *int64
    DriverName              *string
    Directory               string
    EnablePublicLink        bool
    PublicLinkSalt          *string
    InitialFont             string
    AmazonS3AccessKeyId     string
    AmazonS3SecretAccessKey string
    AmazonS3Bucket          string
    AmazonS3Region          string
    AmazonS3Endpoint        string
    AmazonS3SSL             *bool
    AmazonS3SignV2          *bool
    AmazonS3SSE             *bool
    AmazonS3Trace           *bool
}

func (*FileSettings) SetDefaults Uses

func (s *FileSettings) SetDefaults()

type FileUploadResponse Uses

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

func FileUploadResponseFromJson Uses

func FileUploadResponseFromJson(data io.Reader) *FileUploadResponse

func (*FileUploadResponse) ToJson Uses

func (o *FileUploadResponse) ToJson() string

type GatewayResponse Uses

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

func GatewayResponseFromJson Uses

func GatewayResponseFromJson(data io.Reader) *GatewayResponse

type GlobalRelayMessageExportSettings Uses

type GlobalRelayMessageExportSettings struct {
    CustomerType *string // must be either A9 or A10, dictates SMTP server url
    SmtpUsername *string
    SmtpPassword *string
    EmailAddress *string // the address to send messages to
}

func (*GlobalRelayMessageExportSettings) SetDefaults Uses

func (s *GlobalRelayMessageExportSettings) SetDefaults()

type IncomingWebhook Uses

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"`
    Username      string `json:"username"`
    IconURL       string `json:"icon_url"`
    ChannelLocked bool   `json:"channel_locked"`
}

func IncomingWebhookFromJson Uses

func IncomingWebhookFromJson(data io.Reader) *IncomingWebhook

func IncomingWebhookListFromJson Uses

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

func (*IncomingWebhook) IsValid Uses

func (o *IncomingWebhook) IsValid() *AppError

func (*IncomingWebhook) PreSave Uses

func (o *IncomingWebhook) PreSave()

func (*IncomingWebhook) PreUpdate Uses

func (o *IncomingWebhook) PreUpdate()

func (*IncomingWebhook) ToJson Uses

func (o *IncomingWebhook) ToJson() string

type IncomingWebhookRequest Uses

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 (*IncomingWebhookRequest) ToJson Uses

func (o *IncomingWebhookRequest) ToJson() string

type InitialLoad Uses

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 Uses

func InitialLoadFromJson(data io.Reader) *InitialLoad

func (*InitialLoad) ToJson Uses

func (me *InitialLoad) ToJson() string

type Invites Uses

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

func InvitesFromJson Uses

func InvitesFromJson(data io.Reader) *Invites

func (*Invites) ToEmailList Uses

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

func (*Invites) ToJson Uses

func (o *Invites) ToJson() string

type Job Uses

type Job struct {
    Id             string            `json:"id"`
    Type           string            `json:"type"`
    Priority       int64             `json:"priority"`
    CreateAt       int64             `json:"create_at"`
    StartAt        int64             `json:"start_at"`
    LastActivityAt int64             `json:"last_activity_at"`
    Status         string            `json:"status"`
    Progress       int64             `json:"progress"`
    Data           map[string]string `json:"data"`
}

func JobFromJson Uses

func JobFromJson(data io.Reader) *Job

func JobsFromJson Uses

func JobsFromJson(data io.Reader) []*Job

func (*Job) DataToJson Uses

func (js *Job) DataToJson() string

func (*Job) IsValid Uses

func (j *Job) IsValid() *AppError

func (*Job) ToJson Uses

func (js *Job) ToJson() string

type JobSettings Uses

type JobSettings struct {
    RunJobs      *bool
    RunScheduler *bool
}

func (*JobSettings) SetDefaults Uses

func (s *JobSettings) SetDefaults()

type LdapSettings Uses

type LdapSettings struct {
    // Basic
    Enable             *bool
    EnableSync         *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
    LoginIdAttribute   *string

    // Synchronization
    SyncIntervalMinutes *int

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

    // Customization
    LoginFieldName *string

    LoginButtonColor       *string
    LoginButtonBorderColor *string
    LoginButtonTextColor   *string
}

func (*LdapSettings) SetDefaults Uses

func (s *LdapSettings) SetDefaults()

type License Uses

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 Uses

func LicenseFromJson(data io.Reader) *License

func NewTestLicense Uses

func NewTestLicense(features ...string) *License

NewTestLicense returns a license that expires in the future and has the given features.

func (*License) IsExpired Uses

func (l *License) IsExpired() bool

func (*License) IsStarted Uses

func (l *License) IsStarted() bool

func (*License) ToJson Uses

func (l *License) ToJson() string

type LicenseRecord Uses

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

func (*LicenseRecord) IsValid Uses

func (lr *LicenseRecord) IsValid() *AppError

func (*LicenseRecord) PreSave Uses

func (lr *LicenseRecord) PreSave()

type LocalizationSettings Uses

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

func (*LocalizationSettings) SetDefaults Uses

func (s *LocalizationSettings) SetDefaults()

type LogSettings Uses

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

func (*LogSettings) SetDefaults Uses

func (s *LogSettings) SetDefaults()

type Manifest Uses

type Manifest struct {
    // The id is a globally unique identifier that represents your plugin. Ids must be at least
    // 3 characters, at most 190 characters and must match ^[a-zA-Z0-9-_\.]+$.
    // Reverse-DNS notation using a name you control is a good option, e.g. "com.mycompany.myplugin".
    Id  string `json:"id" yaml:"id"`

    // The name to be displayed for the plugin.
    Name string `json:"name,omitempty" yaml:"name,omitempty"`

    // A description of what your plugin is and does.
    Description string `json:"description,omitempty" yaml:"description,omitempty"`

    // A version number for your plugin. Semantic versioning is recommended: http://semver.org
    Version string `json:"version" yaml:"version"`

    // Server defines the server-side portion of your plugin.
    Server *ManifestServer `json:"server,omitempty" yaml:"server,omitempty"`

    // Backend is a deprecated flag for defining the server-side portion of your plugin. Going forward, use Server instead.
    Backend *ManifestServer `json:"backend,omitempty" yaml:"backend,omitempty"`

    // If your plugin extends the web app, you'll need to define webapp.
    Webapp *ManifestWebapp `json:"webapp,omitempty" yaml:"webapp,omitempty"`

    // To allow administrators to configure your plugin via the Mattermost system console, you can
    // provide your settings schema.
    SettingsSchema *PluginSettingsSchema `json:"settings_schema,omitempty" yaml:"settings_schema,omitempty"`
}

The plugin manifest defines the metadata required to load and present your plugin. The manifest file should be named plugin.json or plugin.yaml and placed in the top of your plugin bundle.

Example plugin.yaml:

id: com.mycompany.myplugin
name: My Plugin
description: This is my plugin. It does stuff.
server:
    executable: myplugin
settings_schema:
    settings:
        - key: enable_extra_thing
          type: bool
          display_name: Enable Extra Thing
          help_text: When true, an extra thing will be enabled!
          default: false

func FindManifest Uses

func FindManifest(dir string) (manifest *Manifest, path string, err error)

FindManifest will find and parse the manifest in a given directory.

In all cases other than a does-not-exist error, path is set to the path of the manifest file that was found.

Manifests are JSON or YAML files named plugin.json, plugin.yaml, or plugin.yml.

func ManifestFromJson Uses

func ManifestFromJson(data io.Reader) *Manifest

func ManifestListFromJson Uses

func ManifestListFromJson(data io.Reader) []*Manifest

func (*Manifest) ClientManifest Uses

func (m *Manifest) ClientManifest() *Manifest

func (*Manifest) GetExecutableForRuntime Uses

func (m *Manifest) GetExecutableForRuntime(goOs, goArch string) string

GetExecutableForRuntime returns the path to the executable for the given runtime architecture.

If the manifest defines multiple executables, but none match, or if only a single executable is defined, the Executable field will be returned. This method does not guarantee that the resulting binary can actually execute on the given platform.

func (*Manifest) HasClient Uses

func (m *Manifest) HasClient() bool

func (*Manifest) HasServer Uses

func (m *Manifest) HasServer() bool

func (*Manifest) HasWebapp Uses

func (m *Manifest) HasWebapp() bool

func (*Manifest) ToJson Uses

func (m *Manifest) ToJson() string

type ManifestExecutables Uses

type ManifestExecutables struct {
    // LinuxAmd64 is the path to your executable binary for the corresponding platform
    LinuxAmd64 string `json:"linux-amd64,omitempty" yaml:"linux-amd64,omitempty"`
    // DarwinAmd64 is the path to your executable binary for the corresponding platform
    DarwinAmd64 string `json:"darwin-amd64,omitempty" yaml:"darwin-amd64,omitempty"`
    // WindowsAmd64 is the path to your executable binary for the corresponding platform
    // This file must have a ".exe" extension
    WindowsAmd64 string `json:"windows-amd64,omitempty" yaml:"windows-amd64,omitempty"`
}

type ManifestServer Uses

type ManifestServer struct {
    // Executables are the paths to your executable binaries, specifying multiple entry points
    // for different platforms when bundled together in a single plugin.
    Executables *ManifestExecutables `json:"executables,omitempty" yaml:"executables,omitempty"`

    // Executable is the path to your executable binary. This should be relative to the root
    // of your bundle and the location of the manifest file.
    //
    // On Windows, this file must have a ".exe" extension.
    //
    // If your plugin is compiled for multiple platforms, consider bundling them together
    // and using the Executables field instead.
    Executable string `json:"executable" yaml:"executable"`
}

type ManifestWebapp Uses

type ManifestWebapp struct {
    // The path to your webapp bundle. This should be relative to the root of your bundle and the
    // location of the manifest file.
    BundlePath string `json:"bundle_path" yaml:"bundle_path"`

    // BundleHash is the 64-bit FNV-1a hash of the webapp bundle, computed when the plugin is loaded
    BundleHash []byte `json:"-"`
}

type MessageExport Uses

type MessageExport struct {
    TeamId          *string
    TeamName        *string
    TeamDisplayName *string

    ChannelId          *string
    ChannelName        *string
    ChannelDisplayName *string
    ChannelType        *string

    UserId    *string
    UserEmail *string
    Username  *string

    PostId         *string
    PostCreateAt   *int64
    PostMessage    *string
    PostType       *string
    PostRootId     *string
    PostOriginalId *string
    PostFileIds    StringArray
}

type MessageExportSettings Uses

type MessageExportSettings struct {
    EnableExport        *bool
    ExportFormat        *string
    DailyRunTime        *string
    ExportFromTimestamp *int64
    BatchSize           *int

    // formatter-specific settings - these are only expected to be non-nil if ExportFormat is set to the associated format
    GlobalRelaySettings *GlobalRelayMessageExportSettings
}

func (*MessageExportSettings) SetDefaults Uses

func (s *MessageExportSettings) SetDefaults()

type MetricsSettings Uses

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

func (*MetricsSettings) SetDefaults Uses

func (s *MetricsSettings) SetDefaults()

type MfaSecret Uses

type MfaSecret struct {
    Secret string `json:"secret"`
    QRCode string `json:"qr_code"`
}

func MfaSecretFromJson Uses

func MfaSecretFromJson(data io.Reader) *MfaSecret

func (*MfaSecret) ToJson Uses

func (me *MfaSecret) ToJson() string

type NativeAppSettings Uses

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

func (*NativeAppSettings) SetDefaults Uses

func (s *NativeAppSettings) SetDefaults()

type OAuthApp Uses

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 Uses

func OAuthAppFromJson(data io.Reader) *OAuthApp

func OAuthAppListFromJson Uses

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

func (*OAuthApp) Etag Uses

func (a *OAuthApp) Etag() string

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

func (*OAuthApp) IsValid Uses

func (a *OAuthApp) IsValid() *AppError

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

func (*OAuthApp) IsValidRedirectURL Uses

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

func (*OAuthApp) PreSave Uses

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 Uses

func (a *OAuthApp) PreUpdate()

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

func (*OAuthApp) Sanitize Uses

func (a *OAuthApp) Sanitize()

Remove any private data from the app object

func (*OAuthApp) ToJson Uses

func (a *OAuthApp) ToJson() string

type OutgoingWebhook Uses

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"`
    Username     string      `json:"username"`
    IconURL      string      `json:"icon_url"`
}

func OutgoingWebhookFromJson Uses

func OutgoingWebhookFromJson(data io.Reader) *OutgoingWebhook

func OutgoingWebhookListFromJson Uses

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

func (*OutgoingWebhook) GetTriggerWord Uses

func (o *OutgoingWebhook) GetTriggerWord(word string, isExactMatch bool) (triggerWord string)

func (*OutgoingWebhook) IsValid Uses

func (o *OutgoingWebhook) IsValid() *AppError

func (*OutgoingWebhook) PreSave Uses

func (o *OutgoingWebhook) PreSave()

func (*OutgoingWebhook) PreUpdate Uses

func (o *OutgoingWebhook) PreUpdate()

func (*OutgoingWebhook) ToJson Uses

func (o *OutgoingWebhook) ToJson() string

func (*OutgoingWebhook) TriggerWordExactMatch Uses

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

func (*OutgoingWebhook) TriggerWordStartsWith Uses

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

type OutgoingWebhookPayload Uses

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"`
    FileIds     string `json:"file_ids"`
}

func (*OutgoingWebhookPayload) ToFormValues Uses

func (o *OutgoingWebhookPayload) ToFormValues() string

func (*OutgoingWebhookPayload) ToJSON Uses

func (o *OutgoingWebhookPayload) ToJSON() string

type OutgoingWebhookResponse Uses

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

func OutgoingWebhookResponseFromJson Uses

func OutgoingWebhookResponseFromJson(data io.Reader) *OutgoingWebhookResponse

func (*OutgoingWebhookResponse) ToJson Uses

func (o *OutgoingWebhookResponse) ToJson() string

type PasswordSettings Uses

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

func (*PasswordSettings) SetDefaults Uses

func (s *PasswordSettings) SetDefaults()

type Permission Uses

type Permission struct {
    Id          string `json:"id"`
    Name        string `json:"name"`
    Description string `json:"description"`
    Scope       string `json:"scope"`
}
var PERMISSION_ADD_REACTION *Permission
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_POST_EPHEMERAL *Permission
var PERMISSION_CREATE_POST_PUBLIC *Permission
var PERMISSION_CREATE_PRIVATE_CHANNEL *Permission
var PERMISSION_CREATE_PUBLIC_CHANNEL *Permission
var PERMISSION_CREATE_TEAM *Permission
var PERMISSION_CREATE_USER_ACCESS_TOKEN *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_LIST_USERS_WITHOUT_TEAM *Permission
var PERMISSION_MANAGE_CHANNEL_ROLES *Permission
var PERMISSION_MANAGE_EMOJIS *Permission
var PERMISSION_MANAGE_JOBS *Permission
var PERMISSION_MANAGE_OAUTH *Permission
var PERMISSION_MANAGE_OTHERS_EMOJIS *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 encompasses 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_READ_PUBLIC_CHANNEL *Permission
var PERMISSION_READ_USER_ACCESS_TOKEN *Permission
var PERMISSION_REMOVE_OTHERS_REACTIONS *Permission
var PERMISSION_REMOVE_REACTION *Permission
var PERMISSION_REMOVE_USER_FROM_TEAM *Permission
var PERMISSION_REVOKE_USER_ACCESS_TOKEN *Permission
var PERMISSION_UPLOAD_FILE *Permission
var PERMISSION_USE_SLASH_COMMANDS *Permission
var PERMISSION_VIEW_TEAM *Permission

type PluginInfo Uses

type PluginInfo struct {
    Manifest
}

type PluginKeyValue Uses

type PluginKeyValue struct {
    PluginId string `json:"plugin_id"`
    Key      string `json:"key" db:"PKey"`
    Value    []byte `json:"value" db:"PValue"`
    ExpireAt int64  `json:"expire_at"`
}

func (*PluginKeyValue) IsValid Uses

func (kv *PluginKeyValue) IsValid() *AppError

type PluginOption Uses

type PluginOption struct {
    // The display name for the option.
    DisplayName string `json:"display_name" yaml:"display_name"`

    // The string value for the option.
    Value string `json:"value" yaml:"value"`
}

type PluginSetting Uses

type PluginSetting struct {
    // The key that the setting will be assigned to in the configuration file.
    Key string `json:"key" yaml:"key"`

    // The display name for the setting.
    DisplayName string `json:"display_name" yaml:"display_name"`

    // The type of the setting.
    //
    // "bool" will result in a boolean true or false setting.
    //
    // "dropdown" will result in a string setting that allows the user to select from a list of
    // pre-defined options.
    //
    // "generated" will result in a string setting that is set to a random, cryptographically secure
    // string.
    //
    // "radio" will result in a string setting that allows the user to select from a short selection
    // of pre-defined options.
    //
    // "text" will result in a string setting that can be typed in manually.
    //
    // "username" will result in a text setting that will autocomplete to a username.
    Type string `json:"type" yaml:"type"`

    // The help text to display to the user.
    HelpText string `json:"help_text" yaml:"help_text"`

    // The help text to display alongside the "Regenerate" button for settings of the "generated" type.
    RegenerateHelpText string `json:"regenerate_help_text,omitempty" yaml:"regenerate_help_text,omitempty"`

    // The placeholder to display for "text", "generated" and "username" types when blank.
    Placeholder string `json:"placeholder" yaml:"placeholder"`

    // The default value of the setting.
    Default interface{} `json:"default" yaml:"default"`

    // For "radio" or "dropdown" settings, this is the list of pre-defined options that the user can choose
    // from.
    Options []*PluginOption `json:"options,omitempty" yaml:"options,omitempty"`
}

type PluginSettings Uses

type PluginSettings struct {
    Enable          *bool
    EnableUploads   *bool
    Directory       *string
    ClientDirectory *string
    Plugins         map[string]map[string]interface{}
    PluginStates    map[string]*PluginState
}

func (*PluginSettings) SetDefaults Uses

func (s *PluginSettings) SetDefaults()

type PluginSettingsSchema Uses

type PluginSettingsSchema struct {
    // Optional text to display above the settings.
    Header string `json:"header" yaml:"header"`

    // Optional text to display below the settings.
    Footer string `json:"footer" yaml:"footer"`

    // A list of setting definitions.
    Settings []*PluginSetting `json:"settings" yaml:"settings"`
}

type PluginState Uses

type PluginState struct {
    Enable bool
}

type PluginStatus Uses

type PluginStatus struct {
    PluginId    string `json:"plugin_id"`
    ClusterId   string `json:"cluster_id"`
    PluginPath  string `json:"plugin_path"`
    State       int    `json:"state"`
    Name        string `json:"name"`
    Description string `json:"description"`
    Version     string `json:"version"`
}

PluginStatus provides a cluster-aware view of installed plugins.

type PluginStatuses Uses

type PluginStatuses []*PluginStatus

func PluginStatusesFromJson Uses

func PluginStatusesFromJson(data io.Reader) PluginStatuses

func (*PluginStatuses) ToJson Uses

func (m *PluginStatuses) ToJson() string

type PluginsResponse Uses

type PluginsResponse struct {
    Active   []*PluginInfo `json:"active"`
    Inactive []*PluginInfo `json:"inactive"`
}

func PluginsResponseFromJson Uses

func PluginsResponseFromJson(data io.Reader) *PluginsResponse

func (*PluginsResponse) ToJson Uses

func (m *PluginsResponse) ToJson() string

type Post Uses

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"`
    IsPinned   bool   `json:"is_pinned"`
    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"`

    // MessageSource will contain the message as submitted by the user if Message has been modified
    // by Mattermost for presentation (e.g if an image proxy is being used). It should be used to
    // populate edit boxes if present.
    MessageSource string `json:"message_source,omitempty" db:"-"`

    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 Uses

func PostFromJson(data io.Reader) *Post

func (*Post) AddProp Uses

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

func (*Post) Attachments Uses

func (o *Post) Attachments() []*SlackAttachment

func (*Post) ChannelMentions Uses

func (o *Post) ChannelMentions() []string

func (*Post) Etag Uses

func (o *Post) Etag() string

func (*Post) GenerateActionIds Uses

func (o *Post) GenerateActionIds()

func (*Post) GetAction Uses

func (o *Post) GetAction(id string) *PostAction

func (*Post) IsSystemMessage Uses

func (o *Post) IsSystemMessage() bool

func (*Post) IsValid Uses

func (o *Post) IsValid(maxPostSize int) *AppError

func (*Post) MakeNonNil Uses

func (o *Post) MakeNonNil()

func (*Post) Patch Uses

func (p *Post) Patch(patch *PostPatch)

func (*Post) PreCommit Uses

func (o *Post) PreCommit()

func (*Post) PreSave Uses

func (o *Post) PreSave()

func (*Post) SanitizeProps Uses

func (o *Post) SanitizeProps()

func (*Post) StripActionIntegrations Uses

func (o *Post) StripActionIntegrations()

func (*Post) ToJson Uses

func (o *Post) ToJson() string

func (*Post) ToUnsanitizedJson Uses

func (o *Post) ToUnsanitizedJson() string

func (*Post) WithRewrittenImageURLs Uses

func (o *Post) WithRewrittenImageURLs(f func(string) string) *Post

WithRewrittenImageURLs returns a new shallow copy of the post where the message has been rewritten via RewriteImageURLs.

type PostAction Uses

type PostAction struct {
    Id          string                 `json:"id"`
    Name        string                 `json:"name"`
    Type        string                 `json:"type"`
    DataSource  string                 `json:"data_source"`
    Options     []*PostActionOptions   `json:"options"`
    Integration *PostActionIntegration `json:"integration,omitempty"`
}

type PostActionIntegration Uses

type PostActionIntegration struct {
    URL     string          `json:"url,omitempty"`
    Context StringInterface `json:"context,omitempty"`
}

type PostActionIntegrationRequest Uses

type PostActionIntegrationRequest struct {
    UserId     string          `json:"user_id"`
    ChannelId  string          `json:"channel_id"`
    TeamId     string          `json:"team_id"`
    PostId     string          `json:"post_id"`
    Type       string          `json:"type"`
    DataSource string          `json:"data_source"`
    Context    StringInterface `json:"context,omitempty"`
}

func PostActionIntegrationRequesteFromJson Uses

func PostActionIntegrationRequesteFromJson(data io.Reader) *PostActionIntegrationRequest

func (*PostActionIntegrationRequest) ToJson Uses

func (r *PostActionIntegrationRequest) ToJson() string

type PostActionIntegrationResponse Uses

type PostActionIntegrationResponse struct {
    Update        *Post  `json:"update"`
    EphemeralText string `json:"ephemeral_text"`
}

func PostActionIntegrationResponseFromJson Uses

func PostActionIntegrationResponseFromJson(data io.Reader) *PostActionIntegrationResponse

func (*PostActionIntegrationResponse) ToJson Uses

func (r *PostActionIntegrationResponse) ToJson() string

type PostActionOptions Uses

type PostActionOptions struct {
    Text  string `json:"text"`
    Value string `json:"value"`
}

type PostEphemeral Uses

type PostEphemeral struct {
    UserID string `json:"user_id"`
    Post   *Post  `json:"post"`
}

func (*PostEphemeral) ToUnsanitizedJson Uses

func (o *PostEphemeral) ToUnsanitizedJson() string

type PostForExport Uses

type PostForExport struct {
    Post
    TeamName    string
    ChannelName string
    Username    string
    ReplyCount  int
}

type PostForIndexing Uses

type PostForIndexing struct {
    Post
    TeamId         string `json:"team_id"`
    ParentCreateAt *int64 `json:"parent_create_at"`
}

type PostList Uses

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

func NewPostList Uses

func NewPostList() *PostList

func PostListFromJson Uses

func PostListFromJson(data io.Reader) *PostList

func (*PostList) AddOrder Uses

func (o *PostList) AddOrder(id string)

func (*PostList) AddPost Uses

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

func (*PostList) Etag Uses

func (o *PostList) Etag() string

func (*PostList) Extend Uses

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

func (*PostList) IsChannelId Uses

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

func (*PostList) MakeNonNil Uses

func (o *PostList) MakeNonNil()

func (*PostList) SortByCreateAt Uses

func (o *PostList) SortByCreateAt()

func (*PostList) StripActionIntegrations Uses

func (o *PostList) StripActionIntegrations()

func (*PostList) ToJson Uses

func (o *PostList) ToJson() string

func (*PostList) WithRewrittenImageURLs Uses

func (o *PostList) WithRewrittenImageURLs(f func(string) string) *PostList

type PostPatch Uses

type PostPatch struct {
    IsPinned     *bool            `json:"is_pinned"`
    Message      *string          `json:"message"`
    Props        *StringInterface `json:"props"`
    FileIds      *StringArray     `json:"file_ids"`
    HasReactions *bool            `json:"has_reactions"`
}

func PostPatchFromJson Uses

func PostPatchFromJson(data io.Reader) *PostPatch

func (*PostPatch) ToJson Uses

func (o *PostPatch) ToJson() string

func (*PostPatch) WithRewrittenImageURLs Uses

func (o *PostPatch) WithRewrittenImageURLs(f func(string) string) *PostPatch

type PostSearchMatches Uses

type PostSearchMatches map[string][]string

type PostSearchResults Uses

type PostSearchResults struct {
    *PostList
    Matches PostSearchMatches `json:"matches"`
}

func MakePostSearchResults Uses

func MakePostSearchResults(posts *PostList, matches PostSearchMatches) *PostSearchResults

func PostSearchResultsFromJson Uses

func PostSearchResultsFromJson(data io.Reader) *PostSearchResults

func (*PostSearchResults) ToJson Uses

func (o *PostSearchResults) ToJson() string

type Preference Uses

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

func PreferenceFromJson Uses

func PreferenceFromJson(data io.Reader) *Preference

func (*Preference) IsValid Uses

func (o *Preference) IsValid() *AppError

func (*Preference) PreUpdate Uses

func (o *Preference) PreUpdate()

func (*Preference) ToJson Uses

func (o *Preference) ToJson() string

type Preferences Uses

type Preferences []Preference

func PreferencesFromJson Uses

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

func (*Preferences) ToJson Uses

func (o *Preferences) ToJson() string

type PrivacySettings Uses

type PrivacySettings struct {
    ShowEmailAddress bool
    ShowFullName     bool
}

type PushNotification Uses

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"`
    PostId           string `json:"post_id"`
    RootId           string `json:"root_id"`
    ChannelName      string `json:"channel_name"`
    Type             string `json:"type"`
    SenderId         string `json:"sender_id"`
    OverrideUsername string `json:"override_username"`
    OverrideIconUrl  string `json:"override_icon_url"`
    FromWebhook      string `json:"from_webhook"`
    Version          string `json:"version"`
}

func